Harald Welte | e72cf55 | 2016-04-28 07:18:49 +0200 | [diff] [blame] | 1 | /* (C) 2015 by Harald Welte <laforge@gnumonks.org> |
| 2 | * |
| 3 | * All Rights Reserved |
| 4 | * |
| 5 | * This program is free software; you can redistribute it and/or modify |
| 6 | * it under the terms of the GNU Affero General Public License as published by |
| 7 | * the Free Software Foundation; either version 3 of the License, or |
| 8 | * (at your option) any later version. |
| 9 | * |
| 10 | * This program is distributed in the hope that it will be useful, |
| 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 13 | * GNU Affero General Public License for more details. |
| 14 | * |
| 15 | * You should have received a copy of the GNU Affero General Public License |
| 16 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 17 | * |
| 18 | */ |
| 19 | |
| 20 | #include <osmocom/core/utils.h> |
| 21 | |
Max | 00b3715 | 2017-02-20 11:09:27 +0100 | [diff] [blame] | 22 | #include <stdbool.h> |
Harald Welte | e72cf55 | 2016-04-28 07:18:49 +0200 | [diff] [blame] | 23 | #include <sqlite3.h> |
Neels Hofmeyr | cd83b8a | 2017-10-06 04:20:37 +0200 | [diff] [blame] | 24 | #include <string.h> |
Harald Welte | e72cf55 | 2016-04-28 07:18:49 +0200 | [diff] [blame] | 25 | |
Neels Hofmeyr | 2f75803 | 2019-11-20 00:37:07 +0100 | [diff] [blame] | 26 | #include <osmocom/hlr/logging.h> |
| 27 | #include <osmocom/hlr/db.h> |
Neels Hofmeyr | 7750d2c | 2017-10-24 23:26:27 +0200 | [diff] [blame] | 28 | #include "db_bootstrap.h" |
Harald Welte | e72cf55 | 2016-04-28 07:18:49 +0200 | [diff] [blame] | 29 | |
Stefan Sperling | 638ba8c | 2018-12-04 15:07:29 +0100 | [diff] [blame] | 30 | /* This constant is currently duplicated in sql/hlr.sql and must be kept in sync! */ |
Neels Hofmeyr | 07e1602 | 2019-11-20 02:36:35 +0100 | [diff] [blame] | 31 | #define CURRENT_SCHEMA_VERSION 4 |
Stefan Sperling | 8f3a7cc | 2018-11-27 12:10:45 +0100 | [diff] [blame] | 32 | |
Neels Hofmeyr | 9c2bbc8 | 2017-10-09 17:30:32 +0200 | [diff] [blame] | 33 | #define SEL_COLUMNS \ |
| 34 | "id," \ |
| 35 | "imsi," \ |
| 36 | "msisdn," \ |
Oliver Smith | 81db389 | 2019-01-09 12:03:51 +0100 | [diff] [blame] | 37 | "imei," \ |
Neels Hofmeyr | 9c2bbc8 | 2017-10-09 17:30:32 +0200 | [diff] [blame] | 38 | "vlr_number," \ |
| 39 | "sgsn_number," \ |
| 40 | "sgsn_address," \ |
| 41 | "periodic_lu_tmr," \ |
| 42 | "periodic_rau_tau_tmr," \ |
| 43 | "nam_cs," \ |
| 44 | "nam_ps," \ |
| 45 | "lmsi," \ |
| 46 | "ms_purged_cs," \ |
Stefan Sperling | 638ba8c | 2018-12-04 15:07:29 +0100 | [diff] [blame] | 47 | "ms_purged_ps," \ |
Neels Hofmeyr | 07e1602 | 2019-11-20 02:36:35 +0100 | [diff] [blame] | 48 | "last_lu_seen," \ |
| 49 | "last_lu_seen_ps" \ |
Neels Hofmeyr | 9c2bbc8 | 2017-10-09 17:30:32 +0200 | [diff] [blame] | 50 | |
Harald Welte | e72cf55 | 2016-04-28 07:18:49 +0200 | [diff] [blame] | 51 | static const char *stmt_sql[] = { |
Neels Hofmeyr | 9c2bbc8 | 2017-10-09 17:30:32 +0200 | [diff] [blame] | 52 | [DB_STMT_SEL_BY_IMSI] = "SELECT " SEL_COLUMNS " FROM subscriber WHERE imsi = ?", |
| 53 | [DB_STMT_SEL_BY_MSISDN] = "SELECT " SEL_COLUMNS " FROM subscriber WHERE msisdn = ?", |
| 54 | [DB_STMT_SEL_BY_ID] = "SELECT " SEL_COLUMNS " FROM subscriber WHERE id = ?", |
Oliver Smith | 81db389 | 2019-01-09 12:03:51 +0100 | [diff] [blame] | 55 | [DB_STMT_SEL_BY_IMEI] = "SELECT " SEL_COLUMNS " FROM subscriber WHERE imei = ?", |
Neels Hofmeyr | dd78305 | 2017-10-09 17:36:08 +0200 | [diff] [blame] | 56 | [DB_STMT_UPD_VLR_BY_ID] = "UPDATE subscriber SET vlr_number = $number WHERE id = $subscriber_id", |
| 57 | [DB_STMT_UPD_SGSN_BY_ID] = "UPDATE subscriber SET sgsn_number = $number WHERE id = $subscriber_id", |
Oliver Smith | 81db389 | 2019-01-09 12:03:51 +0100 | [diff] [blame] | 58 | [DB_STMT_UPD_IMEI_BY_IMSI] = "UPDATE subscriber SET imei = $imei WHERE imsi = $imsi", |
Neels Hofmeyr | 0cac0a0 | 2017-10-09 17:47:21 +0200 | [diff] [blame] | 59 | [DB_STMT_AUC_BY_IMSI] = |
| 60 | "SELECT id, algo_id_2g, ki, algo_id_3g, k, op, opc, sqn, ind_bitlen" |
| 61 | " FROM subscriber" |
| 62 | " LEFT JOIN auc_2g ON auc_2g.subscriber_id = subscriber.id" |
| 63 | " LEFT JOIN auc_3g ON auc_3g.subscriber_id = subscriber.id" |
Neels Hofmeyr | c5122f2 | 2017-10-09 23:12:57 +0200 | [diff] [blame] | 64 | " WHERE imsi = $imsi", |
Neels Hofmeyr | 1cbdb70 | 2017-10-09 23:03:57 +0200 | [diff] [blame] | 65 | [DB_STMT_AUC_UPD_SQN] = "UPDATE auc_3g SET sqn = $sqn WHERE subscriber_id = $subscriber_id", |
Neels Hofmeyr | e50121e | 2017-10-09 17:48:51 +0200 | [diff] [blame] | 66 | [DB_STMT_UPD_PURGE_CS_BY_IMSI] = "UPDATE subscriber SET ms_purged_cs = $val WHERE imsi = $imsi", |
| 67 | [DB_STMT_UPD_PURGE_PS_BY_IMSI] = "UPDATE subscriber SET ms_purged_ps = $val WHERE imsi = $imsi", |
Neels Hofmeyr | e8ccd50 | 2017-10-06 04:10:06 +0200 | [diff] [blame] | 68 | [DB_STMT_UPD_NAM_CS_BY_IMSI] = "UPDATE subscriber SET nam_cs = $val WHERE imsi = $imsi", |
| 69 | [DB_STMT_UPD_NAM_PS_BY_IMSI] = "UPDATE subscriber SET nam_ps = $val WHERE imsi = $imsi", |
Oliver Smith | cd2af5e | 2019-03-06 13:17:39 +0100 | [diff] [blame] | 70 | [DB_STMT_SUBSCR_CREATE] = "INSERT INTO subscriber (imsi, nam_cs, nam_ps) VALUES ($imsi, $nam_cs, $nam_ps)", |
Neels Hofmeyr | f7c3e6e | 2017-10-09 17:55:16 +0200 | [diff] [blame] | 71 | [DB_STMT_DEL_BY_ID] = "DELETE FROM subscriber WHERE id = $subscriber_id", |
| 72 | [DB_STMT_SET_MSISDN_BY_IMSI] = "UPDATE subscriber SET msisdn = $msisdn WHERE imsi = $imsi", |
Neels Hofmeyr | a820ea1 | 2018-12-02 19:46:46 +0100 | [diff] [blame] | 73 | [DB_STMT_DELETE_MSISDN_BY_IMSI] = "UPDATE subscriber SET msisdn = NULL WHERE imsi = $imsi", |
Neels Hofmeyr | 1332a17 | 2017-10-10 02:25:00 +0200 | [diff] [blame] | 74 | [DB_STMT_AUC_2G_INSERT] = |
| 75 | "INSERT INTO auc_2g (subscriber_id, algo_id_2g, ki)" |
| 76 | " VALUES($subscriber_id, $algo_id_2g, $ki)", |
| 77 | [DB_STMT_AUC_2G_DELETE] = "DELETE FROM auc_2g WHERE subscriber_id = $subscriber_id", |
| 78 | [DB_STMT_AUC_3G_INSERT] = |
| 79 | "INSERT INTO auc_3g (subscriber_id, algo_id_3g, k, op, opc, ind_bitlen)" |
| 80 | " VALUES($subscriber_id, $algo_id_3g, $k, $op, $opc, $ind_bitlen)", |
| 81 | [DB_STMT_AUC_3G_DELETE] = "DELETE FROM auc_3g WHERE subscriber_id = $subscriber_id", |
Stefan Sperling | 638ba8c | 2018-12-04 15:07:29 +0100 | [diff] [blame] | 82 | [DB_STMT_SET_LAST_LU_SEEN] = "UPDATE subscriber SET last_lu_seen = datetime($val, 'unixepoch') WHERE id = $subscriber_id", |
Neels Hofmeyr | 07e1602 | 2019-11-20 02:36:35 +0100 | [diff] [blame] | 83 | [DB_STMT_SET_LAST_LU_SEEN_PS] = "UPDATE subscriber SET last_lu_seen_ps = datetime($val, 'unixepoch') WHERE id = $subscriber_id", |
Oliver Smith | 6b73fd9 | 2019-03-06 13:49:05 +0100 | [diff] [blame] | 84 | [DB_STMT_EXISTS_BY_IMSI] = "SELECT 1 FROM subscriber WHERE imsi = $imsi", |
Vadim Yanitskiy | c13599d | 2019-03-30 17:03:42 +0700 | [diff] [blame] | 85 | [DB_STMT_EXISTS_BY_MSISDN] = "SELECT 1 FROM subscriber WHERE msisdn = $msisdn", |
Harald Welte | e72cf55 | 2016-04-28 07:18:49 +0200 | [diff] [blame] | 86 | }; |
| 87 | |
| 88 | static void sql3_error_log_cb(void *arg, int err_code, const char *msg) |
| 89 | { |
| 90 | LOGP(DDB, LOGL_ERROR, "(%d) %s\n", err_code, msg); |
| 91 | } |
| 92 | |
| 93 | static void sql3_sql_log_cb(void *arg, sqlite3 *s3, const char *stmt, int type) |
| 94 | { |
| 95 | switch (type) { |
| 96 | case 0: |
| 97 | LOGP(DDB, LOGL_DEBUG, "Opened database\n"); |
| 98 | break; |
| 99 | case 1: |
Max | 58d4a84 | 2017-02-20 11:06:12 +0100 | [diff] [blame] | 100 | LOGP(DDB, LOGL_DEBUG, "%s\n", stmt); |
Harald Welte | e72cf55 | 2016-04-28 07:18:49 +0200 | [diff] [blame] | 101 | break; |
| 102 | case 2: |
| 103 | LOGP(DDB, LOGL_DEBUG, "Closed database\n"); |
| 104 | break; |
| 105 | default: |
| 106 | LOGP(DDB, LOGL_DEBUG, "Unknown %d\n", type); |
| 107 | break; |
| 108 | } |
| 109 | } |
| 110 | |
Max | 00b3715 | 2017-02-20 11:09:27 +0100 | [diff] [blame] | 111 | /* remove bindings and reset statement to be re-executed */ |
Neels Hofmeyr | d7d9697 | 2017-10-06 03:50:30 +0200 | [diff] [blame] | 112 | void db_remove_reset(sqlite3_stmt *stmt) |
Max | 00b3715 | 2017-02-20 11:09:27 +0100 | [diff] [blame] | 113 | { |
Neels Hofmeyr | d7d9697 | 2017-10-06 03:50:30 +0200 | [diff] [blame] | 114 | sqlite3_clear_bindings(stmt); |
Neels Hofmeyr | 4f3841c | 2017-11-07 13:24:44 +0100 | [diff] [blame] | 115 | /* sqlite3_reset() just repeats an error code already evaluated during sqlite3_step(). */ |
| 116 | /* coverity[CHECKED_RETURN] */ |
Neels Hofmeyr | d7d9697 | 2017-10-06 03:50:30 +0200 | [diff] [blame] | 117 | sqlite3_reset(stmt); |
Max | 00b3715 | 2017-02-20 11:09:27 +0100 | [diff] [blame] | 118 | } |
| 119 | |
Neels Hofmeyr | f314459 | 2017-10-06 03:40:52 +0200 | [diff] [blame] | 120 | /** bind text arg and do proper cleanup in case of failure. If param_name is |
| 121 | * NULL, bind to the first parameter (useful for SQL statements that have only |
| 122 | * one parameter). */ |
| 123 | bool db_bind_text(sqlite3_stmt *stmt, const char *param_name, const char *text) |
Max | 00b3715 | 2017-02-20 11:09:27 +0100 | [diff] [blame] | 124 | { |
Neels Hofmeyr | f314459 | 2017-10-06 03:40:52 +0200 | [diff] [blame] | 125 | int rc; |
| 126 | int idx = param_name ? sqlite3_bind_parameter_index(stmt, param_name) : 1; |
| 127 | if (idx < 1) { |
| 128 | LOGP(DDB, LOGL_ERROR, "Error composing SQL, cannot bind parameter '%s'\n", |
| 129 | param_name); |
| 130 | return false; |
| 131 | } |
| 132 | rc = sqlite3_bind_text(stmt, idx, text, -1, SQLITE_STATIC); |
Max | 00b3715 | 2017-02-20 11:09:27 +0100 | [diff] [blame] | 133 | if (rc != SQLITE_OK) { |
Neels Hofmeyr | f314459 | 2017-10-06 03:40:52 +0200 | [diff] [blame] | 134 | LOGP(DDB, LOGL_ERROR, "Error binding text to SQL parameter %s: %d\n", |
| 135 | param_name ? param_name : "#1", rc); |
Max | 00b3715 | 2017-02-20 11:09:27 +0100 | [diff] [blame] | 136 | db_remove_reset(stmt); |
| 137 | return false; |
| 138 | } |
Max | 00b3715 | 2017-02-20 11:09:27 +0100 | [diff] [blame] | 139 | return true; |
| 140 | } |
| 141 | |
Neels Hofmeyr | 28da26e | 2017-10-06 03:44:57 +0200 | [diff] [blame] | 142 | /** bind int arg and do proper cleanup in case of failure. If param_name is |
| 143 | * NULL, bind to the first parameter (useful for SQL statements that have only |
| 144 | * one parameter). */ |
| 145 | bool db_bind_int(sqlite3_stmt *stmt, const char *param_name, int nr) |
| 146 | { |
| 147 | int rc; |
| 148 | int idx = param_name ? sqlite3_bind_parameter_index(stmt, param_name) : 1; |
| 149 | if (idx < 1) { |
| 150 | LOGP(DDB, LOGL_ERROR, "Error composing SQL, cannot bind parameter '%s'\n", |
| 151 | param_name); |
| 152 | return false; |
| 153 | } |
| 154 | rc = sqlite3_bind_int(stmt, idx, nr); |
| 155 | if (rc != SQLITE_OK) { |
| 156 | LOGP(DDB, LOGL_ERROR, "Error binding int64 to SQL parameter %s: %d\n", |
| 157 | param_name ? param_name : "#1", rc); |
| 158 | db_remove_reset(stmt); |
| 159 | return false; |
| 160 | } |
| 161 | return true; |
| 162 | } |
| 163 | |
| 164 | /** bind int64 arg and do proper cleanup in case of failure. If param_name is |
| 165 | * NULL, bind to the first parameter (useful for SQL statements that have only |
| 166 | * one parameter). */ |
| 167 | bool db_bind_int64(sqlite3_stmt *stmt, const char *param_name, int64_t nr) |
| 168 | { |
| 169 | int rc; |
| 170 | int idx = param_name ? sqlite3_bind_parameter_index(stmt, param_name) : 1; |
| 171 | if (idx < 1) { |
| 172 | LOGP(DDB, LOGL_ERROR, "Error composing SQL, cannot bind parameter '%s'\n", |
| 173 | param_name); |
| 174 | return false; |
| 175 | } |
| 176 | rc = sqlite3_bind_int64(stmt, idx, nr); |
| 177 | if (rc != SQLITE_OK) { |
| 178 | LOGP(DDB, LOGL_ERROR, "Error binding int64 to SQL parameter %s: %d\n", |
| 179 | param_name ? param_name : "#1", rc); |
| 180 | db_remove_reset(stmt); |
| 181 | return false; |
| 182 | } |
| 183 | return true; |
| 184 | } |
| 185 | |
Harald Welte | e72cf55 | 2016-04-28 07:18:49 +0200 | [diff] [blame] | 186 | void db_close(struct db_context *dbc) |
| 187 | { |
| 188 | unsigned int i; |
Vadim Yanitskiy | dc17e05 | 2018-07-30 20:14:16 +0700 | [diff] [blame] | 189 | int rc; |
Harald Welte | e72cf55 | 2016-04-28 07:18:49 +0200 | [diff] [blame] | 190 | |
| 191 | for (i = 0; i < ARRAY_SIZE(dbc->stmt); i++) { |
| 192 | /* it is ok to call finalize on NULL */ |
| 193 | sqlite3_finalize(dbc->stmt[i]); |
| 194 | } |
Vadim Yanitskiy | dc17e05 | 2018-07-30 20:14:16 +0700 | [diff] [blame] | 195 | |
| 196 | /* Ask sqlite3 to close DB */ |
| 197 | rc = sqlite3_close(dbc->db); |
| 198 | if (rc != SQLITE_OK) { /* Make sure it's actually closed! */ |
| 199 | LOGP(DDB, LOGL_ERROR, "Couldn't close database: (rc=%d) %s\n", |
| 200 | rc, sqlite3_errmsg(dbc->db)); |
| 201 | } |
| 202 | |
Harald Welte | e72cf55 | 2016-04-28 07:18:49 +0200 | [diff] [blame] | 203 | talloc_free(dbc); |
| 204 | } |
| 205 | |
Neels Hofmeyr | 7f4dd11 | 2019-10-31 21:23:10 +0100 | [diff] [blame] | 206 | static int db_run_statements(struct db_context *dbc, const char **statements, size_t statements_count) |
Neels Hofmeyr | 7750d2c | 2017-10-24 23:26:27 +0200 | [diff] [blame] | 207 | { |
Neels Hofmeyr | 7f4dd11 | 2019-10-31 21:23:10 +0100 | [diff] [blame] | 208 | int rc; |
Neels Hofmeyr | 7750d2c | 2017-10-24 23:26:27 +0200 | [diff] [blame] | 209 | int i; |
Neels Hofmeyr | 7f4dd11 | 2019-10-31 21:23:10 +0100 | [diff] [blame] | 210 | for (i = 0; i < statements_count; i++) { |
| 211 | const char *stmt_str = statements[i]; |
Neels Hofmeyr | 7750d2c | 2017-10-24 23:26:27 +0200 | [diff] [blame] | 212 | sqlite3_stmt *stmt; |
Neels Hofmeyr | 7f4dd11 | 2019-10-31 21:23:10 +0100 | [diff] [blame] | 213 | |
| 214 | rc = sqlite3_prepare_v2(dbc->db, stmt_str, -1, &stmt, NULL); |
Neels Hofmeyr | 7750d2c | 2017-10-24 23:26:27 +0200 | [diff] [blame] | 215 | if (rc != SQLITE_OK) { |
Neels Hofmeyr | 7f4dd11 | 2019-10-31 21:23:10 +0100 | [diff] [blame] | 216 | LOGP(DDB, LOGL_ERROR, "Unable to prepare SQL statement '%s'\n", stmt_str); |
Vadim Yanitskiy | 050eb1d | 2018-07-30 20:48:19 +0700 | [diff] [blame] | 217 | return rc; |
Neels Hofmeyr | 7750d2c | 2017-10-24 23:26:27 +0200 | [diff] [blame] | 218 | } |
Neels Hofmeyr | 7750d2c | 2017-10-24 23:26:27 +0200 | [diff] [blame] | 219 | rc = sqlite3_step(stmt); |
| 220 | db_remove_reset(stmt); |
Vadim Yanitskiy | dc17e05 | 2018-07-30 20:14:16 +0700 | [diff] [blame] | 221 | sqlite3_finalize(stmt); |
Neels Hofmeyr | 7750d2c | 2017-10-24 23:26:27 +0200 | [diff] [blame] | 222 | if (rc != SQLITE_DONE) { |
Neels Hofmeyr | 7f4dd11 | 2019-10-31 21:23:10 +0100 | [diff] [blame] | 223 | LOGP(DDB, LOGL_ERROR, "SQL error: (%d) %s, during stmt '%s'", |
| 224 | rc, sqlite3_errmsg(dbc->db), stmt_str); |
Vadim Yanitskiy | 050eb1d | 2018-07-30 20:48:19 +0700 | [diff] [blame] | 225 | return rc; |
Neels Hofmeyr | 7750d2c | 2017-10-24 23:26:27 +0200 | [diff] [blame] | 226 | } |
| 227 | } |
Neels Hofmeyr | 7f4dd11 | 2019-10-31 21:23:10 +0100 | [diff] [blame] | 228 | return rc; |
| 229 | } |
| 230 | |
| 231 | static int db_bootstrap(struct db_context *dbc) |
| 232 | { |
| 233 | int rc = db_run_statements(dbc, stmt_bootstrap_sql, ARRAY_SIZE(stmt_bootstrap_sql)); |
| 234 | if (rc != SQLITE_DONE) { |
| 235 | LOGP(DDB, LOGL_ERROR, "Cannot bootstrap database\n"); |
| 236 | return rc; |
| 237 | } |
Vadim Yanitskiy | 050eb1d | 2018-07-30 20:48:19 +0700 | [diff] [blame] | 238 | return SQLITE_OK; |
Neels Hofmeyr | 7750d2c | 2017-10-24 23:26:27 +0200 | [diff] [blame] | 239 | } |
| 240 | |
Stefan Sperling | 8f3a7cc | 2018-11-27 12:10:45 +0100 | [diff] [blame] | 241 | /* https://www.sqlite.org/fileformat2.html#storage_of_the_sql_database_schema */ |
| 242 | static bool db_table_exists(struct db_context *dbc, const char *table_name) |
| 243 | { |
| 244 | const char *table_exists_sql = "SELECT name FROM sqlite_master WHERE type='table' AND name=?"; |
| 245 | sqlite3_stmt *stmt; |
| 246 | int rc; |
| 247 | |
| 248 | rc = sqlite3_prepare_v2(dbc->db, table_exists_sql, -1, &stmt, NULL); |
| 249 | if (rc != SQLITE_OK) { |
| 250 | LOGP(DDB, LOGL_ERROR, "Unable to prepare SQL statement '%s'\n", table_exists_sql); |
| 251 | return false; |
| 252 | } |
| 253 | |
| 254 | if (!db_bind_text(stmt, NULL, table_name)) |
| 255 | return false; |
| 256 | |
| 257 | rc = sqlite3_step(stmt); |
| 258 | db_remove_reset(stmt); |
| 259 | sqlite3_finalize(stmt); |
| 260 | return (rc == SQLITE_ROW); |
| 261 | } |
| 262 | |
| 263 | /* Indicate whether the database is initialized with tables for schema version 0. |
| 264 | * We only check for the 'subscriber' table here because Neels said so. */ |
| 265 | static bool db_is_bootstrapped_v0(struct db_context *dbc) |
| 266 | { |
| 267 | if (!db_table_exists(dbc, "subscriber")) { |
| 268 | LOGP(DDB, LOGL_DEBUG, "Table 'subscriber' not found in database '%s'\n", dbc->fname); |
| 269 | return false; |
| 270 | } |
| 271 | |
| 272 | return true; |
| 273 | } |
| 274 | |
Stefan Sperling | 638ba8c | 2018-12-04 15:07:29 +0100 | [diff] [blame] | 275 | static int |
| 276 | db_upgrade_v1(struct db_context *dbc) |
| 277 | { |
Stefan Sperling | 638ba8c | 2018-12-04 15:07:29 +0100 | [diff] [blame] | 278 | int rc; |
Neels Hofmeyr | 7f4dd11 | 2019-10-31 21:23:10 +0100 | [diff] [blame] | 279 | const char *statements[] = { |
| 280 | "ALTER TABLE subscriber ADD COLUMN last_lu_seen TIMESTAMP default NULL", |
| 281 | "PRAGMA user_version = 1", |
| 282 | }; |
Stefan Sperling | 638ba8c | 2018-12-04 15:07:29 +0100 | [diff] [blame] | 283 | |
Neels Hofmeyr | 7f4dd11 | 2019-10-31 21:23:10 +0100 | [diff] [blame] | 284 | rc = db_run_statements(dbc, statements, ARRAY_SIZE(statements)); |
Stefan Sperling | 638ba8c | 2018-12-04 15:07:29 +0100 | [diff] [blame] | 285 | if (rc != SQLITE_DONE) { |
Neels Hofmeyr | 7f4dd11 | 2019-10-31 21:23:10 +0100 | [diff] [blame] | 286 | LOGP(DDB, LOGL_ERROR, "Unable to update HLR database schema to version 1\n"); |
Stefan Sperling | 638ba8c | 2018-12-04 15:07:29 +0100 | [diff] [blame] | 287 | return rc; |
| 288 | } |
Stefan Sperling | 638ba8c | 2018-12-04 15:07:29 +0100 | [diff] [blame] | 289 | return rc; |
| 290 | } |
| 291 | |
Oliver Smith | 81db389 | 2019-01-09 12:03:51 +0100 | [diff] [blame] | 292 | static int db_upgrade_v2(struct db_context *dbc) |
| 293 | { |
Oliver Smith | 81db389 | 2019-01-09 12:03:51 +0100 | [diff] [blame] | 294 | int rc; |
Neels Hofmeyr | 7f4dd11 | 2019-10-31 21:23:10 +0100 | [diff] [blame] | 295 | const char *statements[] = { |
| 296 | "ALTER TABLE subscriber ADD COLUMN imei VARCHAR(14)", |
| 297 | "PRAGMA user_version = 2", |
| 298 | }; |
Oliver Smith | 81db389 | 2019-01-09 12:03:51 +0100 | [diff] [blame] | 299 | |
Neels Hofmeyr | 7f4dd11 | 2019-10-31 21:23:10 +0100 | [diff] [blame] | 300 | rc = db_run_statements(dbc, statements, ARRAY_SIZE(statements)); |
Oliver Smith | 81db389 | 2019-01-09 12:03:51 +0100 | [diff] [blame] | 301 | if (rc != SQLITE_DONE) { |
Neels Hofmeyr | f5459de | 2019-10-31 01:29:59 +0100 | [diff] [blame] | 302 | LOGP(DDB, LOGL_ERROR, "Unable to update HLR database schema to version 2\n"); |
Oliver Smith | 81db389 | 2019-01-09 12:03:51 +0100 | [diff] [blame] | 303 | return rc; |
| 304 | } |
Oliver Smith | 81db389 | 2019-01-09 12:03:51 +0100 | [diff] [blame] | 305 | return rc; |
| 306 | } |
| 307 | |
Neels Hofmeyr | a8045da | 2019-10-31 01:19:44 +0100 | [diff] [blame] | 308 | static int db_upgrade_v3(struct db_context *dbc) |
| 309 | { |
Neels Hofmeyr | a8045da | 2019-10-31 01:19:44 +0100 | [diff] [blame] | 310 | int rc; |
| 311 | |
| 312 | /* A newer SQLite version would allow simply 'ATLER TABLE subscriber RENAME COLUMN hlr_number TO msc_number'. |
| 313 | * This is a really expensive workaround for that in order to cover earlier SQLite versions as well: |
| 314 | * Create a new table with the new column name and copy the data over (https://www.sqlite.org/faq.html#q11). |
| 315 | */ |
| 316 | #define SUBSCR_V3_CREATE \ |
| 317 | "(\n" \ |
| 318 | "-- OsmoHLR's DB scheme is modelled roughly after TS 23.008 version 13.3.0\n" \ |
| 319 | " id INTEGER PRIMARY KEY,\n" \ |
| 320 | " -- Chapter 2.1.1.1\n" \ |
| 321 | " imsi VARCHAR(15) UNIQUE NOT NULL,\n" \ |
| 322 | " -- Chapter 2.1.2\n" \ |
| 323 | " msisdn VARCHAR(15) UNIQUE,\n" \ |
| 324 | " -- Chapter 2.2.3: Most recent / current IMEISV\n" \ |
| 325 | " imeisv VARCHAR,\n" \ |
| 326 | " -- Chapter 2.1.9: Most recent / current IMEI\n" \ |
| 327 | " imei VARCHAR(14),\n" \ |
| 328 | " -- Chapter 2.4.5\n" \ |
| 329 | " vlr_number VARCHAR(15),\n" \ |
| 330 | " -- Chapter 2.4.6\n" \ |
| 331 | " msc_number VARCHAR(15),\n" \ |
| 332 | " -- Chapter 2.4.8.1\n" \ |
| 333 | " sgsn_number VARCHAR(15),\n" \ |
| 334 | " -- Chapter 2.13.10\n" \ |
| 335 | " sgsn_address VARCHAR,\n" \ |
| 336 | " -- Chapter 2.4.8.2\n" \ |
| 337 | " ggsn_number VARCHAR(15),\n" \ |
| 338 | " -- Chapter 2.4.9.2\n" \ |
| 339 | " gmlc_number VARCHAR(15),\n" \ |
| 340 | " -- Chapter 2.4.23\n" \ |
| 341 | " smsc_number VARCHAR(15),\n" \ |
| 342 | " -- Chapter 2.4.24\n" \ |
| 343 | " periodic_lu_tmr INTEGER,\n" \ |
| 344 | " -- Chapter 2.13.115\n" \ |
| 345 | " periodic_rau_tau_tmr INTEGER,\n" \ |
| 346 | " -- Chapter 2.1.1.2: network access mode\n" \ |
| 347 | " nam_cs BOOLEAN NOT NULL DEFAULT 1,\n" \ |
| 348 | " nam_ps BOOLEAN NOT NULL DEFAULT 1,\n" \ |
| 349 | " -- Chapter 2.1.8\n" \ |
| 350 | " lmsi INTEGER,\n" \ |
| 351 | \ |
| 352 | " -- The below purged flags might not even be stored non-volatile,\n" \ |
| 353 | " -- refer to TS 23.012 Chapter 3.6.1.4\n" \ |
| 354 | " -- Chapter 2.7.5\n" \ |
| 355 | " ms_purged_cs BOOLEAN NOT NULL DEFAULT 0,\n" \ |
| 356 | " -- Chapter 2.7.6\n" \ |
| 357 | " ms_purged_ps BOOLEAN NOT NULL DEFAULT 0,\n" \ |
| 358 | \ |
| 359 | " -- Timestamp of last location update seen from subscriber\n" \ |
| 360 | " -- The value is a string which encodes a UTC timestamp in granularity of seconds.\n" \ |
| 361 | " last_lu_seen TIMESTAMP default NULL\n" \ |
| 362 | ")\n" |
| 363 | |
| 364 | #define SUBSCR_V2_COLUMN_NAMES \ |
| 365 | "id," \ |
| 366 | "imsi," \ |
| 367 | "msisdn," \ |
| 368 | "imeisv," \ |
| 369 | "imei," \ |
| 370 | "vlr_number," \ |
| 371 | "hlr_number," \ |
| 372 | "sgsn_number," \ |
| 373 | "sgsn_address," \ |
| 374 | "ggsn_number," \ |
| 375 | "gmlc_number," \ |
| 376 | "smsc_number," \ |
| 377 | "periodic_lu_tmr," \ |
| 378 | "periodic_rau_tau_tmr," \ |
| 379 | "nam_cs," \ |
| 380 | "nam_ps," \ |
| 381 | "lmsi," \ |
| 382 | "ms_purged_cs," \ |
| 383 | "ms_purged_ps," \ |
| 384 | "last_lu_seen" |
| 385 | |
| 386 | #define SUBSCR_V3_COLUMN_NAMES \ |
| 387 | "id," \ |
| 388 | "imsi," \ |
| 389 | "msisdn," \ |
| 390 | "imeisv," \ |
| 391 | "imei," \ |
| 392 | "vlr_number," \ |
| 393 | "msc_number," \ |
| 394 | "sgsn_number," \ |
| 395 | "sgsn_address," \ |
| 396 | "ggsn_number," \ |
| 397 | "gmlc_number," \ |
| 398 | "smsc_number," \ |
| 399 | "periodic_lu_tmr," \ |
| 400 | "periodic_rau_tau_tmr," \ |
| 401 | "nam_cs," \ |
| 402 | "nam_ps," \ |
| 403 | "lmsi," \ |
| 404 | "ms_purged_cs," \ |
| 405 | "ms_purged_ps," \ |
| 406 | "last_lu_seen" |
| 407 | |
| 408 | const char *statements[] = { |
| 409 | "BEGIN TRANSACTION", |
| 410 | "CREATE TEMPORARY TABLE subscriber_backup" SUBSCR_V3_CREATE, |
| 411 | "INSERT INTO subscriber_backup SELECT " SUBSCR_V2_COLUMN_NAMES " FROM subscriber", |
| 412 | "DROP TABLE subscriber", |
| 413 | "CREATE TABLE subscriber" SUBSCR_V3_CREATE, |
| 414 | "INSERT INTO subscriber SELECT " SUBSCR_V3_COLUMN_NAMES " FROM subscriber_backup", |
| 415 | "DROP TABLE subscriber_backup", |
| 416 | "COMMIT", |
| 417 | "PRAGMA user_version = 3", |
| 418 | }; |
| 419 | |
Neels Hofmeyr | 7f4dd11 | 2019-10-31 21:23:10 +0100 | [diff] [blame] | 420 | rc = db_run_statements(dbc, statements, ARRAY_SIZE(statements)); |
| 421 | if (rc != SQLITE_DONE) { |
| 422 | LOGP(DDB, LOGL_ERROR, "Unable to update HLR database schema to version 3\n"); |
| 423 | return rc; |
Neels Hofmeyr | a8045da | 2019-10-31 01:19:44 +0100 | [diff] [blame] | 424 | } |
| 425 | return rc; |
| 426 | } |
| 427 | |
Neels Hofmeyr | 07e1602 | 2019-11-20 02:36:35 +0100 | [diff] [blame] | 428 | static int db_upgrade_v4(struct db_context *dbc) |
| 429 | { |
| 430 | int rc; |
| 431 | const char *statements[] = { |
| 432 | "ALTER TABLE subscriber ADD COLUMN last_lu_seen_ps TIMESTAMP default NULL", |
| 433 | "PRAGMA user_version = 4", |
| 434 | }; |
| 435 | |
| 436 | rc = db_run_statements(dbc, statements, ARRAY_SIZE(statements)); |
| 437 | if (rc != SQLITE_DONE) { |
| 438 | LOGP(DDB, LOGL_ERROR, "Unable to update HLR database schema to version 4\n"); |
| 439 | return rc; |
| 440 | } |
| 441 | return rc; |
| 442 | } |
| 443 | |
Neels Hofmeyr | 981e126 | 2019-11-05 02:00:19 +0100 | [diff] [blame] | 444 | typedef int (*db_upgrade_func_t)(struct db_context *dbc); |
| 445 | static db_upgrade_func_t db_upgrade_path[] = { |
| 446 | db_upgrade_v1, |
| 447 | db_upgrade_v2, |
| 448 | db_upgrade_v3, |
Neels Hofmeyr | 07e1602 | 2019-11-20 02:36:35 +0100 | [diff] [blame] | 449 | db_upgrade_v4, |
Neels Hofmeyr | 981e126 | 2019-11-05 02:00:19 +0100 | [diff] [blame] | 450 | }; |
| 451 | |
Stefan Sperling | 8f3a7cc | 2018-11-27 12:10:45 +0100 | [diff] [blame] | 452 | static int db_get_user_version(struct db_context *dbc) |
| 453 | { |
| 454 | const char *user_version_sql = "PRAGMA user_version"; |
| 455 | sqlite3_stmt *stmt; |
| 456 | int version, rc; |
| 457 | |
| 458 | rc = sqlite3_prepare_v2(dbc->db, user_version_sql, -1, &stmt, NULL); |
| 459 | if (rc != SQLITE_OK) { |
| 460 | LOGP(DDB, LOGL_ERROR, "Unable to prepare SQL statement '%s'\n", user_version_sql); |
| 461 | return -1; |
| 462 | } |
| 463 | rc = sqlite3_step(stmt); |
| 464 | if (rc == SQLITE_ROW) { |
| 465 | version = sqlite3_column_int(stmt, 0); |
| 466 | } else { |
| 467 | LOGP(DDB, LOGL_ERROR, "SQL statement '%s' failed: %d\n", user_version_sql, rc); |
| 468 | version = -1; |
| 469 | } |
| 470 | |
| 471 | db_remove_reset(stmt); |
| 472 | sqlite3_finalize(stmt); |
| 473 | return version; |
| 474 | } |
| 475 | |
| 476 | struct db_context *db_open(void *ctx, const char *fname, bool enable_sqlite_logging, bool allow_upgrade) |
Harald Welte | e72cf55 | 2016-04-28 07:18:49 +0200 | [diff] [blame] | 477 | { |
| 478 | struct db_context *dbc = talloc_zero(ctx, struct db_context); |
| 479 | unsigned int i; |
| 480 | int rc; |
Neels Hofmeyr | cd83b8a | 2017-10-06 04:20:37 +0200 | [diff] [blame] | 481 | bool has_sqlite_config_sqllog = false; |
Stefan Sperling | 8f3a7cc | 2018-11-27 12:10:45 +0100 | [diff] [blame] | 482 | int version; |
Harald Welte | e72cf55 | 2016-04-28 07:18:49 +0200 | [diff] [blame] | 483 | |
Neels Hofmeyr | 7f9491f | 2017-01-30 13:30:47 +0100 | [diff] [blame] | 484 | LOGP(DDB, LOGL_NOTICE, "using database: %s\n", fname); |
Harald Welte | e72cf55 | 2016-04-28 07:18:49 +0200 | [diff] [blame] | 485 | LOGP(DDB, LOGL_INFO, "Compiled against SQLite3 lib version %s\n", SQLITE_VERSION); |
| 486 | LOGP(DDB, LOGL_INFO, "Running with SQLite3 lib version %s\n", sqlite3_libversion()); |
| 487 | |
Vadim Yanitskiy | fbd736e | 2018-07-31 22:40:30 +0700 | [diff] [blame] | 488 | #ifdef SQLITE_USE_TALLOC |
| 489 | /* Configure SQLite3 to use talloc memory allocator */ |
| 490 | rc = db_sqlite3_use_talloc(ctx); |
| 491 | if (rc == SQLITE_OK) { |
| 492 | LOGP(DDB, LOGL_NOTICE, "SQLite3 is configured to use talloc\n"); |
| 493 | } else { |
| 494 | LOGP(DDB, LOGL_ERROR, "Failed to configure SQLite3 " |
| 495 | "to use talloc, using default memory allocator\n"); |
| 496 | } |
| 497 | #endif |
| 498 | |
Harald Welte | e72cf55 | 2016-04-28 07:18:49 +0200 | [diff] [blame] | 499 | dbc->fname = talloc_strdup(dbc, fname); |
| 500 | |
| 501 | for (i = 0; i < 0xfffff; i++) { |
| 502 | const char *o = sqlite3_compileoption_get(i); |
| 503 | if (!o) |
| 504 | break; |
Neels Hofmeyr | e9c0c5b | 2017-10-10 16:52:22 +0200 | [diff] [blame] | 505 | LOGP(DDB, LOGL_DEBUG, "SQLite3 compiled with '%s'\n", o); |
Neels Hofmeyr | cd83b8a | 2017-10-06 04:20:37 +0200 | [diff] [blame] | 506 | if (!strcmp(o, "ENABLE_SQLLOG")) |
| 507 | has_sqlite_config_sqllog = true; |
Harald Welte | e72cf55 | 2016-04-28 07:18:49 +0200 | [diff] [blame] | 508 | } |
| 509 | |
Neels Hofmeyr | d3814b9 | 2017-11-21 12:28:07 +0100 | [diff] [blame] | 510 | if (enable_sqlite_logging) { |
| 511 | rc = sqlite3_config(SQLITE_CONFIG_LOG, sql3_error_log_cb, NULL); |
| 512 | if (rc != SQLITE_OK) |
| 513 | LOGP(DDB, LOGL_NOTICE, "Unable to set SQLite3 error log callback\n"); |
| 514 | } |
Harald Welte | e72cf55 | 2016-04-28 07:18:49 +0200 | [diff] [blame] | 515 | |
Neels Hofmeyr | cd83b8a | 2017-10-06 04:20:37 +0200 | [diff] [blame] | 516 | if (has_sqlite_config_sqllog) { |
| 517 | rc = sqlite3_config(SQLITE_CONFIG_SQLLOG, sql3_sql_log_cb, NULL); |
| 518 | if (rc != SQLITE_OK) |
| 519 | LOGP(DDB, LOGL_NOTICE, "Unable to set SQLite3 SQL log callback\n"); |
| 520 | } else |
| 521 | LOGP(DDB, LOGL_DEBUG, "Not setting SQL log callback:" |
| 522 | " SQLite3 compiled without support for it\n"); |
Harald Welte | e72cf55 | 2016-04-28 07:18:49 +0200 | [diff] [blame] | 523 | |
| 524 | rc = sqlite3_open(dbc->fname, &dbc->db); |
| 525 | if (rc != SQLITE_OK) { |
| 526 | LOGP(DDB, LOGL_ERROR, "Unable to open DB; rc = %d\n", rc); |
| 527 | talloc_free(dbc); |
| 528 | return NULL; |
| 529 | } |
| 530 | |
| 531 | /* enable extended result codes */ |
| 532 | rc = sqlite3_extended_result_codes(dbc->db, 1); |
| 533 | if (rc != SQLITE_OK) |
Neels Hofmeyr | e9c0c5b | 2017-10-10 16:52:22 +0200 | [diff] [blame] | 534 | LOGP(DDB, LOGL_ERROR, "Unable to enable SQLite3 extended result codes\n"); |
Harald Welte | e72cf55 | 2016-04-28 07:18:49 +0200 | [diff] [blame] | 535 | |
Harald Welte | abd1a54 | 2016-05-03 18:50:41 +0200 | [diff] [blame] | 536 | char *err_msg; |
| 537 | rc = sqlite3_exec(dbc->db, "PRAGMA journal_mode=WAL; PRAGMA synchonous = NORMAL;", 0, 0, &err_msg); |
| 538 | if (rc != SQLITE_OK) |
| 539 | LOGP(DDB, LOGL_ERROR, "Unable to set Write-Ahead Logging: %s\n", |
| 540 | err_msg); |
| 541 | |
Stefan Sperling | 8f3a7cc | 2018-11-27 12:10:45 +0100 | [diff] [blame] | 542 | version = db_get_user_version(dbc); |
| 543 | if (version < 0) { |
| 544 | LOGP(DDB, LOGL_ERROR, "Unable to read user version number from database '%s'\n", dbc->fname); |
| 545 | goto out_free; |
| 546 | } |
| 547 | |
| 548 | /* An empty database will always report version zero. */ |
| 549 | if (version == 0 && !db_is_bootstrapped_v0(dbc)) { |
| 550 | LOGP(DDB, LOGL_NOTICE, "Missing database tables detected; Bootstrapping database '%s'\n", dbc->fname); |
| 551 | rc = db_bootstrap(dbc); |
| 552 | if (rc != SQLITE_OK) { |
| 553 | LOGP(DDB, LOGL_ERROR, "Failed to bootstrap DB: (rc=%d) %s\n", |
| 554 | rc, sqlite3_errmsg(dbc->db)); |
| 555 | goto out_free; |
| 556 | } |
Stefan Sperling | 638ba8c | 2018-12-04 15:07:29 +0100 | [diff] [blame] | 557 | version = CURRENT_SCHEMA_VERSION; |
Stefan Sperling | 8f3a7cc | 2018-11-27 12:10:45 +0100 | [diff] [blame] | 558 | } |
| 559 | |
| 560 | LOGP(DDB, LOGL_NOTICE, "Database '%s' has HLR DB schema version %d\n", dbc->fname, version); |
| 561 | |
Neels Hofmeyr | 981e126 | 2019-11-05 02:00:19 +0100 | [diff] [blame] | 562 | for (; allow_upgrade && (version < ARRAY_SIZE(db_upgrade_path)); version++) { |
| 563 | db_upgrade_func_t upgrade_func = db_upgrade_path[version]; |
| 564 | rc = upgrade_func(dbc); |
| 565 | if (rc != SQLITE_DONE) { |
| 566 | LOGP(DDB, LOGL_ERROR, "Failed to upgrade HLR DB schema to version %d: (rc=%d) %s\n", |
| 567 | version+1, rc, sqlite3_errmsg(dbc->db)); |
| 568 | goto out_free; |
Stefan Sperling | 638ba8c | 2018-12-04 15:07:29 +0100 | [diff] [blame] | 569 | } |
| 570 | LOGP(DDB, LOGL_NOTICE, "Database '%s' has been upgraded to HLR DB schema version %d\n", |
Neels Hofmeyr | 981e126 | 2019-11-05 02:00:19 +0100 | [diff] [blame] | 571 | dbc->fname, version+1); |
Stefan Sperling | 8f3a7cc | 2018-11-27 12:10:45 +0100 | [diff] [blame] | 572 | } |
| 573 | |
| 574 | if (version != CURRENT_SCHEMA_VERSION) { |
| 575 | if (version < CURRENT_SCHEMA_VERSION) { |
| 576 | LOGP(DDB, LOGL_NOTICE, "HLR DB schema version %d is outdated\n", version); |
| 577 | if (!allow_upgrade) { |
| 578 | LOGP(DDB, LOGL_ERROR, "Not upgrading HLR database to schema version %d; " |
| 579 | "use the --db-upgrade option to allow HLR database upgrades\n", |
| 580 | CURRENT_SCHEMA_VERSION); |
| 581 | } |
| 582 | } else |
| 583 | LOGP(DDB, LOGL_ERROR, "HLR DB schema version %d is unknown\n", version); |
| 584 | |
Vadim Yanitskiy | 050eb1d | 2018-07-30 20:48:19 +0700 | [diff] [blame] | 585 | goto out_free; |
| 586 | } |
Neels Hofmeyr | 7750d2c | 2017-10-24 23:26:27 +0200 | [diff] [blame] | 587 | |
Harald Welte | e72cf55 | 2016-04-28 07:18:49 +0200 | [diff] [blame] | 588 | /* prepare all SQL statements */ |
| 589 | for (i = 0; i < ARRAY_SIZE(dbc->stmt); i++) { |
| 590 | rc = sqlite3_prepare_v2(dbc->db, stmt_sql[i], -1, |
| 591 | &dbc->stmt[i], NULL); |
| 592 | if (rc != SQLITE_OK) { |
| 593 | LOGP(DDB, LOGL_ERROR, "Unable to prepare SQL statement '%s'\n", stmt_sql[i]); |
| 594 | goto out_free; |
| 595 | } |
| 596 | } |
| 597 | |
| 598 | return dbc; |
| 599 | out_free: |
| 600 | db_close(dbc); |
| 601 | return NULL; |
| 602 | } |