Holger Hans Peter Freyther | 11b28f9 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 1 | /* SMS queue to continously attempt to deliver SMS */ |
| 2 | /* |
| 3 | * (C) 2010 by Holger Hans Peter Freyther <zecke@selfish.org> |
| 4 | * All Rights Reserved |
| 5 | * |
| 6 | * This program is free software; you can redistribute it and/or modify |
Harald Welte | 9af6ddf | 2011-01-01 15:25:50 +0100 | [diff] [blame] | 7 | * it under the terms of the GNU Affero General Public License as published by |
| 8 | * the Free Software Foundation; either version 3 of the License, or |
Holger Hans Peter Freyther | 11b28f9 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 9 | * (at your option) any later version. |
| 10 | * |
| 11 | * This program is distributed in the hope that it will be useful, |
| 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
Harald Welte | 9af6ddf | 2011-01-01 15:25:50 +0100 | [diff] [blame] | 14 | * GNU Affero General Public License for more details. |
Holger Hans Peter Freyther | 11b28f9 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 15 | * |
Harald Welte | 9af6ddf | 2011-01-01 15:25:50 +0100 | [diff] [blame] | 16 | * You should have received a copy of the GNU Affero General Public License |
| 17 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
Holger Hans Peter Freyther | 11b28f9 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 18 | * |
| 19 | */ |
| 20 | |
| 21 | /** |
| 22 | * The difficulty of such a queue is to send a lot of SMS without |
| 23 | * overloading the paging subsystem and the database and other users |
| 24 | * of the MSC. To make the best use we would need to know the number |
| 25 | * of pending paging requests, then throttle the number of SMS we |
| 26 | * want to send and such. |
| 27 | * We will start with a very simple SMS Queue and then try to speed |
| 28 | * things up by collecting data from other parts of the system. |
| 29 | */ |
| 30 | |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 31 | #include <limits.h> |
| 32 | |
Neels Hofmeyr | 9084396 | 2017-09-04 15:04:35 +0200 | [diff] [blame] | 33 | #include <osmocom/msc/sms_queue.h> |
| 34 | #include <osmocom/msc/chan_alloc.h> |
| 35 | #include <osmocom/msc/db.h> |
| 36 | #include <osmocom/msc/debug.h> |
| 37 | #include <osmocom/msc/gsm_data.h> |
| 38 | #include <osmocom/msc/gsm_04_11.h> |
| 39 | #include <osmocom/msc/gsm_subscriber.h> |
| 40 | #include <osmocom/msc/signal.h> |
| 41 | #include <osmocom/msc/vlr.h> |
Holger Hans Peter Freyther | 11b28f9 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 42 | |
Pablo Neira Ayuso | 136f453 | 2011-03-22 16:47:59 +0100 | [diff] [blame] | 43 | #include <osmocom/core/talloc.h> |
Holger Hans Peter Freyther | 11b28f9 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 44 | |
Holger Hans Peter Freyther | 81c0e25 | 2010-12-25 14:08:00 +0100 | [diff] [blame] | 45 | #include <osmocom/vty/vty.h> |
| 46 | |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 47 | /* |
| 48 | * One pending SMS that we wait for. |
| 49 | */ |
| 50 | struct gsm_sms_pending { |
| 51 | struct llist_head entry; |
| 52 | |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 53 | struct vlr_subscr *vsub; |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 54 | unsigned long long sms_id; |
| 55 | int failed_attempts; |
| 56 | int resend; |
| 57 | }; |
Holger Hans Peter Freyther | 11b28f9 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 58 | |
| 59 | struct gsm_sms_queue { |
Pablo Neira Ayuso | bf540cb | 2011-05-06 12:11:06 +0200 | [diff] [blame] | 60 | struct osmo_timer_list resend_pending; |
| 61 | struct osmo_timer_list push_queue; |
Holger Hans Peter Freyther | 11b28f9 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 62 | struct gsm_network *network; |
Holger Hans Peter Freyther | 7e59c83 | 2010-12-25 14:46:54 +0100 | [diff] [blame] | 63 | int max_fail; |
Holger Hans Peter Freyther | 11b28f9 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 64 | int max_pending; |
| 65 | int pending; |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 66 | |
| 67 | struct llist_head pending_sms; |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 68 | |
| 69 | char last_msisdn[GSM_EXTENSION_LENGTH+1]; |
Holger Hans Peter Freyther | 11b28f9 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 70 | }; |
| 71 | |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 72 | static int sms_subscr_cb(unsigned int, unsigned int, void *, void *); |
| 73 | static int sms_sms_cb(unsigned int, unsigned int, void *, void *); |
| 74 | |
| 75 | static struct gsm_sms_pending *sms_find_pending(struct gsm_sms_queue *smsq, |
| 76 | struct gsm_sms *sms) |
| 77 | { |
| 78 | struct gsm_sms_pending *pending; |
| 79 | |
| 80 | llist_for_each_entry(pending, &smsq->pending_sms, entry) { |
| 81 | if (pending->sms_id == sms->id) |
| 82 | return pending; |
| 83 | } |
| 84 | |
| 85 | return NULL; |
| 86 | } |
| 87 | |
| 88 | static int sms_is_in_pending(struct gsm_sms_queue *smsq, struct gsm_sms *sms) |
| 89 | { |
| 90 | return sms_find_pending(smsq, sms) != NULL; |
| 91 | } |
| 92 | |
Holger Hans Peter Freyther | 074b2b2 | 2011-07-25 00:13:06 +0200 | [diff] [blame] | 93 | static struct gsm_sms_pending *sms_subscriber_find_pending( |
| 94 | struct gsm_sms_queue *smsq, |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 95 | struct vlr_subscr *vsub) |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 96 | { |
| 97 | struct gsm_sms_pending *pending; |
| 98 | |
| 99 | llist_for_each_entry(pending, &smsq->pending_sms, entry) { |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 100 | if (pending->vsub == vsub) |
Holger Hans Peter Freyther | 074b2b2 | 2011-07-25 00:13:06 +0200 | [diff] [blame] | 101 | return pending; |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 102 | } |
| 103 | |
Holger Hans Peter Freyther | 074b2b2 | 2011-07-25 00:13:06 +0200 | [diff] [blame] | 104 | return NULL; |
| 105 | } |
| 106 | |
| 107 | static int sms_subscriber_is_pending(struct gsm_sms_queue *smsq, |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 108 | struct vlr_subscr *vsub) |
Holger Hans Peter Freyther | 074b2b2 | 2011-07-25 00:13:06 +0200 | [diff] [blame] | 109 | { |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 110 | return sms_subscriber_find_pending(smsq, vsub) != NULL; |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 111 | } |
| 112 | |
| 113 | static struct gsm_sms_pending *sms_pending_from(struct gsm_sms_queue *smsq, |
| 114 | struct gsm_sms *sms) |
| 115 | { |
| 116 | struct gsm_sms_pending *pending; |
| 117 | |
| 118 | pending = talloc_zero(smsq, struct gsm_sms_pending); |
| 119 | if (!pending) |
| 120 | return NULL; |
| 121 | |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 122 | pending->vsub = vlr_subscr_get(sms->receiver); |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 123 | pending->sms_id = sms->id; |
| 124 | return pending; |
| 125 | } |
| 126 | |
| 127 | static void sms_pending_free(struct gsm_sms_pending *pending) |
| 128 | { |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 129 | vlr_subscr_put(pending->vsub); |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 130 | llist_del(&pending->entry); |
| 131 | talloc_free(pending); |
| 132 | } |
| 133 | |
| 134 | static void sms_pending_resend(struct gsm_sms_pending *pending) |
| 135 | { |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 136 | struct gsm_network *net = pending->vsub->vlr->user_ctx; |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 137 | struct gsm_sms_queue *smsq; |
Holger Hans Peter Freyther | eff40949 | 2012-11-10 19:46:58 +0100 | [diff] [blame] | 138 | LOGP(DLSMS, LOGL_DEBUG, |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 139 | "Scheduling resend of SMS %llu.\n", pending->sms_id); |
| 140 | |
| 141 | pending->resend = 1; |
| 142 | |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 143 | smsq = net->sms_queue; |
Pablo Neira Ayuso | bf540cb | 2011-05-06 12:11:06 +0200 | [diff] [blame] | 144 | if (osmo_timer_pending(&smsq->resend_pending)) |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 145 | return; |
| 146 | |
Pablo Neira Ayuso | bf540cb | 2011-05-06 12:11:06 +0200 | [diff] [blame] | 147 | osmo_timer_schedule(&smsq->resend_pending, 1, 0); |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 148 | } |
| 149 | |
| 150 | static void sms_pending_failed(struct gsm_sms_pending *pending, int paging_error) |
| 151 | { |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 152 | struct gsm_network *net = pending->vsub->vlr->user_ctx; |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 153 | struct gsm_sms_queue *smsq; |
| 154 | |
Holger Hans Peter Freyther | eff40949 | 2012-11-10 19:46:58 +0100 | [diff] [blame] | 155 | LOGP(DLSMS, LOGL_NOTICE, "Sending SMS %llu failed %d times.\n", |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 156 | pending->sms_id, pending->failed_attempts); |
| 157 | |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 158 | smsq = net->sms_queue; |
Holger Hans Peter Freyther | 7e59c83 | 2010-12-25 14:46:54 +0100 | [diff] [blame] | 159 | if (++pending->failed_attempts < smsq->max_fail) |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 160 | return sms_pending_resend(pending); |
| 161 | |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 162 | sms_pending_free(pending); |
| 163 | smsq->pending -= 1; |
| 164 | sms_queue_trigger(smsq); |
| 165 | } |
| 166 | |
| 167 | /* |
| 168 | * Resend all SMS that are scheduled for a resend. This is done to |
| 169 | * avoid an immediate failure. |
| 170 | */ |
| 171 | static void sms_resend_pending(void *_data) |
| 172 | { |
| 173 | struct gsm_sms_pending *pending, *tmp; |
| 174 | struct gsm_sms_queue *smsq = _data; |
| 175 | |
| 176 | llist_for_each_entry_safe(pending, tmp, &smsq->pending_sms, entry) { |
| 177 | struct gsm_sms *sms; |
| 178 | if (!pending->resend) |
| 179 | continue; |
| 180 | |
| 181 | sms = db_sms_get(smsq->network, pending->sms_id); |
| 182 | |
| 183 | /* the sms is gone? Move to the next */ |
| 184 | if (!sms) { |
| 185 | sms_pending_free(pending); |
| 186 | smsq->pending -= 1; |
| 187 | sms_queue_trigger(smsq); |
| 188 | } else { |
| 189 | pending->resend = 0; |
| 190 | gsm411_send_sms_subscr(sms->receiver, sms); |
| 191 | } |
| 192 | } |
| 193 | } |
| 194 | |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 195 | /* Find the next pending SMS by cycling through the recipients. We could also |
| 196 | * cycle through the pending SMS, but that might cause us to keep trying to |
| 197 | * send SMS to the same few subscribers repeatedly while not servicing other |
| 198 | * subscribers for a long time. By walking the list of recipient MSISDNs, we |
| 199 | * ensure that all subscribers get their fair time to receive SMS. */ |
| 200 | struct gsm_sms *smsq_take_next_sms(struct gsm_network *net, |
| 201 | char *last_msisdn, |
| 202 | size_t last_msisdn_buflen) |
Holger Hans Peter Freyther | f7e2389 | 2010-12-25 17:45:23 +0100 | [diff] [blame] | 203 | { |
| 204 | struct gsm_sms *sms; |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 205 | int wrapped = 0; |
| 206 | int sanity = 100; |
| 207 | char started_with_msisdn[last_msisdn_buflen]; |
Holger Hans Peter Freyther | f7e2389 | 2010-12-25 17:45:23 +0100 | [diff] [blame] | 208 | |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 209 | osmo_strlcpy(started_with_msisdn, last_msisdn, |
| 210 | sizeof(started_with_msisdn)); |
| 211 | |
| 212 | while (wrapped < 2 && (--sanity)) { |
| 213 | /* If we wrapped around and passed the first msisdn, we're |
| 214 | * through the entire SMS DB; end it. */ |
| 215 | if (wrapped && strcmp(last_msisdn, started_with_msisdn) >= 0) |
| 216 | break; |
| 217 | |
| 218 | sms = db_sms_get_next_unsent_rr_msisdn(net, last_msisdn, 9); |
| 219 | if (!sms) { |
| 220 | last_msisdn[0] = '\0'; |
| 221 | wrapped ++; |
| 222 | continue; |
| 223 | } |
| 224 | |
| 225 | /* Whatever happens, next time around service another recipient |
| 226 | */ |
| 227 | osmo_strlcpy(last_msisdn, sms->dst.addr, last_msisdn_buflen); |
| 228 | |
| 229 | /* Is the subscriber attached? If not, go to next SMS */ |
| 230 | if (!sms->receiver || !sms->receiver->lu_complete) |
| 231 | continue; |
| 232 | |
Holger Hans Peter Freyther | f7e2389 | 2010-12-25 17:45:23 +0100 | [diff] [blame] | 233 | return sms; |
| 234 | } |
| 235 | |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 236 | DEBUGP(DLSMS, "SMS queue: no SMS to be sent\n"); |
| 237 | return NULL; |
Holger Hans Peter Freyther | f7e2389 | 2010-12-25 17:45:23 +0100 | [diff] [blame] | 238 | } |
| 239 | |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 240 | /** |
| 241 | * I will submit up to max_pending - pending SMS to the |
| 242 | * subsystem. |
| 243 | */ |
| 244 | static void sms_submit_pending(void *_data) |
| 245 | { |
| 246 | struct gsm_sms_queue *smsq = _data; |
| 247 | int attempts = smsq->max_pending - smsq->pending; |
Holger Hans Peter Freyther | 2038457 | 2010-12-25 19:28:44 +0100 | [diff] [blame] | 248 | int initialized = 0; |
| 249 | unsigned long long first_sub = 0; |
Holger Hans Peter Freyther | 5479fc8 | 2010-12-25 19:32:12 +0100 | [diff] [blame] | 250 | int attempted = 0, rounds = 0; |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 251 | |
Harald Welte | e5d2c60 | 2012-11-13 06:52:42 +0100 | [diff] [blame] | 252 | LOGP(DLSMS, LOGL_DEBUG, "Attempting to send %d SMS\n", attempts); |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 253 | |
Holger Hans Peter Freyther | 2038457 | 2010-12-25 19:28:44 +0100 | [diff] [blame] | 254 | do { |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 255 | struct gsm_sms_pending *pending; |
| 256 | struct gsm_sms *sms; |
| 257 | |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 258 | |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 259 | sms = smsq_take_next_sms(smsq->network, smsq->last_msisdn, |
| 260 | sizeof(smsq->last_msisdn)); |
Neels Hofmeyr | 1e918c3 | 2016-05-09 21:48:53 +0200 | [diff] [blame] | 261 | if (!sms) { |
| 262 | LOGP(DLSMS, LOGL_DEBUG, "Sending SMS done (%d attempted)\n", |
| 263 | attempted); |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 264 | break; |
Neels Hofmeyr | 1e918c3 | 2016-05-09 21:48:53 +0200 | [diff] [blame] | 265 | } |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 266 | |
Holger Hans Peter Freyther | 5479fc8 | 2010-12-25 19:32:12 +0100 | [diff] [blame] | 267 | rounds += 1; |
Neels Hofmeyr | 1e918c3 | 2016-05-09 21:48:53 +0200 | [diff] [blame] | 268 | LOGP(DLSMS, LOGL_DEBUG, "Sending SMS round %d\n", rounds); |
Holger Hans Peter Freyther | 5479fc8 | 2010-12-25 19:32:12 +0100 | [diff] [blame] | 269 | |
Holger Hans Peter Freyther | 2038457 | 2010-12-25 19:28:44 +0100 | [diff] [blame] | 270 | /* |
| 271 | * This code needs to detect a loop. It assumes that no SMS |
| 272 | * will vanish during the time this is executed. We will remember |
| 273 | * the id of the first GSM subscriber we see and then will |
| 274 | * compare this. The Database code should make sure that we will |
| 275 | * see all other subscribers first before seeing this one again. |
| 276 | * |
| 277 | * It is always scary to have an infinite loop like this. |
| 278 | */ |
| 279 | if (!initialized) { |
| 280 | first_sub = sms->receiver->id; |
| 281 | initialized = 1; |
| 282 | } else if (first_sub == sms->receiver->id) { |
Neels Hofmeyr | 1e918c3 | 2016-05-09 21:48:53 +0200 | [diff] [blame] | 283 | LOGP(DLSMS, LOGL_DEBUG, "Sending SMS done (loop) (%d attempted)\n", |
| 284 | attempted); |
Holger Hans Peter Freyther | 2038457 | 2010-12-25 19:28:44 +0100 | [diff] [blame] | 285 | sms_free(sms); |
| 286 | break; |
| 287 | } |
| 288 | |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 289 | /* no need to send a pending sms */ |
| 290 | if (sms_is_in_pending(smsq, sms)) { |
Holger Hans Peter Freyther | eff40949 | 2012-11-10 19:46:58 +0100 | [diff] [blame] | 291 | LOGP(DLSMS, LOGL_DEBUG, |
Holger Hans Peter Freyther | dc53af6 | 2010-12-27 20:12:25 +0100 | [diff] [blame] | 292 | "SMSqueue with pending sms: %llu. Skipping\n", sms->id); |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 293 | sms_free(sms); |
| 294 | continue; |
| 295 | } |
| 296 | |
| 297 | /* no need to send a SMS with the same receiver */ |
| 298 | if (sms_subscriber_is_pending(smsq, sms->receiver)) { |
Holger Hans Peter Freyther | eff40949 | 2012-11-10 19:46:58 +0100 | [diff] [blame] | 299 | LOGP(DLSMS, LOGL_DEBUG, |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 300 | "SMSqueue with pending sub: %llu. Skipping\n", sms->receiver->id); |
| 301 | sms_free(sms); |
| 302 | continue; |
| 303 | } |
| 304 | |
| 305 | pending = sms_pending_from(smsq, sms); |
| 306 | if (!pending) { |
Holger Hans Peter Freyther | eff40949 | 2012-11-10 19:46:58 +0100 | [diff] [blame] | 307 | LOGP(DLSMS, LOGL_ERROR, |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 308 | "Failed to create pending SMS entry.\n"); |
| 309 | sms_free(sms); |
| 310 | continue; |
| 311 | } |
| 312 | |
Holger Hans Peter Freyther | 2038457 | 2010-12-25 19:28:44 +0100 | [diff] [blame] | 313 | attempted += 1; |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 314 | smsq->pending += 1; |
Holger Hans Peter Freyther | 701076e | 2010-12-28 14:25:25 +0100 | [diff] [blame] | 315 | llist_add_tail(&pending->entry, &smsq->pending_sms); |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 316 | gsm411_send_sms_subscr(sms->receiver, sms); |
Holger Hans Peter Freyther | 5479fc8 | 2010-12-25 19:32:12 +0100 | [diff] [blame] | 317 | } while (attempted < attempts && rounds < 1000); |
Holger Hans Peter Freyther | 2038457 | 2010-12-25 19:28:44 +0100 | [diff] [blame] | 318 | |
Holger Hans Peter Freyther | eff40949 | 2012-11-10 19:46:58 +0100 | [diff] [blame] | 319 | LOGP(DLSMS, LOGL_DEBUG, "SMSqueue added %d messages in %d rounds\n", attempted, rounds); |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 320 | } |
| 321 | |
Holger Hans Peter Freyther | 93de8b2 | 2014-02-24 16:13:04 +0100 | [diff] [blame] | 322 | /** |
| 323 | * Send the next SMS or trigger the queue |
| 324 | */ |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 325 | static void sms_send_next(struct vlr_subscr *vsub) |
Holger Hans Peter Freyther | 93de8b2 | 2014-02-24 16:13:04 +0100 | [diff] [blame] | 326 | { |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 327 | struct gsm_network *net = vsub->vlr->user_ctx; |
| 328 | struct gsm_sms_queue *smsq = net->sms_queue; |
Holger Hans Peter Freyther | 93de8b2 | 2014-02-24 16:13:04 +0100 | [diff] [blame] | 329 | struct gsm_sms_pending *pending; |
| 330 | struct gsm_sms *sms; |
| 331 | |
| 332 | /* the subscriber should not be in the queue */ |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 333 | OSMO_ASSERT(!sms_subscriber_is_pending(smsq, vsub)); |
Holger Hans Peter Freyther | 93de8b2 | 2014-02-24 16:13:04 +0100 | [diff] [blame] | 334 | |
| 335 | /* check for more messages for this subscriber */ |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 336 | sms = db_sms_get_unsent_for_subscr(vsub, UINT_MAX); |
Holger Hans Peter Freyther | 93de8b2 | 2014-02-24 16:13:04 +0100 | [diff] [blame] | 337 | if (!sms) |
| 338 | goto no_pending_sms; |
| 339 | |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 340 | /* The sms should not be scheduled right now */ |
Holger Hans Peter Freyther | 93de8b2 | 2014-02-24 16:13:04 +0100 | [diff] [blame] | 341 | OSMO_ASSERT(!sms_is_in_pending(smsq, sms)); |
| 342 | |
| 343 | /* Remember that we deliver this SMS and send it */ |
| 344 | pending = sms_pending_from(smsq, sms); |
| 345 | if (!pending) { |
| 346 | LOGP(DLSMS, LOGL_ERROR, |
| 347 | "Failed to create pending SMS entry.\n"); |
| 348 | sms_free(sms); |
| 349 | goto no_pending_sms; |
| 350 | } |
| 351 | |
| 352 | smsq->pending += 1; |
| 353 | llist_add_tail(&pending->entry, &smsq->pending_sms); |
| 354 | gsm411_send_sms_subscr(sms->receiver, sms); |
| 355 | return; |
| 356 | |
| 357 | no_pending_sms: |
| 358 | /* Try to send the SMS to avoid the queue being stuck */ |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 359 | sms_submit_pending(net->sms_queue); |
Holger Hans Peter Freyther | 93de8b2 | 2014-02-24 16:13:04 +0100 | [diff] [blame] | 360 | } |
| 361 | |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 362 | /* |
| 363 | * Kick off the queue again. |
| 364 | */ |
| 365 | int sms_queue_trigger(struct gsm_sms_queue *smsq) |
| 366 | { |
Neels Hofmeyr | 1e918c3 | 2016-05-09 21:48:53 +0200 | [diff] [blame] | 367 | LOGP(DLSMS, LOGL_DEBUG, "Triggering SMS queue\n"); |
Pablo Neira Ayuso | bf540cb | 2011-05-06 12:11:06 +0200 | [diff] [blame] | 368 | if (osmo_timer_pending(&smsq->push_queue)) |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 369 | return 0; |
| 370 | |
Pablo Neira Ayuso | bf540cb | 2011-05-06 12:11:06 +0200 | [diff] [blame] | 371 | osmo_timer_schedule(&smsq->push_queue, 1, 0); |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 372 | return 0; |
| 373 | } |
Holger Hans Peter Freyther | 11b28f9 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 374 | |
| 375 | int sms_queue_start(struct gsm_network *network, int max_pending) |
| 376 | { |
| 377 | struct gsm_sms_queue *sms = talloc_zero(network, struct gsm_sms_queue); |
| 378 | if (!sms) { |
| 379 | LOGP(DMSC, LOGL_ERROR, "Failed to create the SMS queue.\n"); |
| 380 | return -1; |
| 381 | } |
| 382 | |
Pablo Neira Ayuso | bbc5b99 | 2011-05-06 12:12:31 +0200 | [diff] [blame] | 383 | osmo_signal_register_handler(SS_SUBSCR, sms_subscr_cb, network); |
| 384 | osmo_signal_register_handler(SS_SMS, sms_sms_cb, network); |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 385 | |
Holger Hans Peter Freyther | 11b28f9 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 386 | network->sms_queue = sms; |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 387 | INIT_LLIST_HEAD(&sms->pending_sms); |
Holger Hans Peter Freyther | a37e3bc | 2010-12-25 17:43:03 +0100 | [diff] [blame] | 388 | sms->max_fail = 1; |
Holger Hans Peter Freyther | 11b28f9 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 389 | sms->network = network; |
| 390 | sms->max_pending = max_pending; |
Pablo Neira Ayuso | 5121576 | 2017-05-08 20:57:52 +0200 | [diff] [blame] | 391 | osmo_timer_setup(&sms->push_queue, sms_submit_pending, sms); |
| 392 | osmo_timer_setup(&sms->resend_pending, sms_resend_pending, sms); |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 393 | |
| 394 | sms_submit_pending(sms); |
Holger Hans Peter Freyther | 11b28f9 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 395 | |
| 396 | return 0; |
| 397 | } |
| 398 | |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 399 | static int sub_ready_for_sm(struct gsm_network *net, struct vlr_subscr *vsub) |
Holger Hans Peter Freyther | 11b28f9 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 400 | { |
Holger Hans Peter Freyther | 11b28f9 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 401 | struct gsm_sms *sms; |
Holger Hans Peter Freyther | 074b2b2 | 2011-07-25 00:13:06 +0200 | [diff] [blame] | 402 | struct gsm_sms_pending *pending; |
| 403 | struct gsm_subscriber_connection *conn; |
Holger Hans Peter Freyther | 11b28f9 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 404 | |
Holger Hans Peter Freyther | 074b2b2 | 2011-07-25 00:13:06 +0200 | [diff] [blame] | 405 | /* |
| 406 | * The code used to be very clever and tried to submit |
| 407 | * a SMS during the Location Updating Request. This has |
| 408 | * two issues: |
| 409 | * 1.) The Phone might not be ready yet, e.g. the C155 |
| 410 | * will not respond to the Submit when it is booting. |
| 411 | * 2.) The queue is already trying to submit SMS to the |
| 412 | * user and by not responding to the paging request |
| 413 | * we will set the LAC back to 0. We would have to |
| 414 | * stop the paging and move things over. |
| 415 | * |
| 416 | * We need to be careful in what we try here. |
| 417 | */ |
| 418 | |
| 419 | /* check if we have pending requests */ |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 420 | pending = sms_subscriber_find_pending(net->sms_queue, vsub); |
Holger Hans Peter Freyther | 074b2b2 | 2011-07-25 00:13:06 +0200 | [diff] [blame] | 421 | if (pending) { |
| 422 | LOGP(DMSC, LOGL_NOTICE, |
| 423 | "Pending paging while subscriber %llu attached.\n", |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 424 | vsub->id); |
Holger Hans Peter Freyther | 074b2b2 | 2011-07-25 00:13:06 +0200 | [diff] [blame] | 425 | return 0; |
| 426 | } |
| 427 | |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 428 | conn = connection_for_subscr(vsub); |
Holger Hans Peter Freyther | 11b28f9 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 429 | if (!conn) |
| 430 | return -1; |
Holger Hans Peter Freyther | 074b2b2 | 2011-07-25 00:13:06 +0200 | [diff] [blame] | 431 | |
| 432 | /* Now try to deliver any pending SMS to this sub */ |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 433 | sms = db_sms_get_unsent_for_subscr(vsub, UINT_MAX); |
Holger Hans Peter Freyther | 11b28f9 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 434 | if (!sms) |
| 435 | return -1; |
| 436 | gsm411_send_sms(conn, sms); |
| 437 | return 0; |
| 438 | } |
| 439 | |
| 440 | static int sms_subscr_cb(unsigned int subsys, unsigned int signal, |
| 441 | void *handler_data, void *signal_data) |
| 442 | { |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 443 | struct vlr_subscr *vsub = signal_data; |
Holger Hans Peter Freyther | 11b28f9 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 444 | |
| 445 | if (signal != S_SUBSCR_ATTACHED) |
| 446 | return 0; |
| 447 | |
| 448 | /* this is readyForSM */ |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 449 | return sub_ready_for_sm(handler_data, vsub); |
Holger Hans Peter Freyther | 11b28f9 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 450 | } |
| 451 | |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 452 | static int sms_sms_cb(unsigned int subsys, unsigned int signal, |
| 453 | void *handler_data, void *signal_data) |
Holger Hans Peter Freyther | 11b28f9 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 454 | { |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 455 | struct gsm_network *network = handler_data; |
| 456 | struct sms_signal_data *sig_sms = signal_data; |
| 457 | struct gsm_sms_pending *pending; |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 458 | struct vlr_subscr *vsub; |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 459 | |
| 460 | /* We got a new SMS and maybe should launch the queue again. */ |
| 461 | if (signal == S_SMS_SUBMITTED || signal == S_SMS_SMMA) { |
Holger Hans Peter Freyther | 024dc77 | 2014-02-24 14:29:27 +0100 | [diff] [blame] | 462 | /* TODO: For SMMA we might want to re-use the radio connection. */ |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 463 | sms_queue_trigger(network->sms_queue); |
| 464 | return 0; |
| 465 | } |
| 466 | |
| 467 | if (!sig_sms->sms) |
| 468 | return -1; |
| 469 | |
| 470 | |
| 471 | /* |
| 472 | * Find the entry of our queue. The SMS subsystem will submit |
| 473 | * sms that are not in our control as we just have a channel |
| 474 | * open anyway. |
| 475 | */ |
| 476 | pending = sms_find_pending(network->sms_queue, sig_sms->sms); |
| 477 | if (!pending) |
| 478 | return 0; |
| 479 | |
| 480 | switch (signal) { |
| 481 | case S_SMS_DELIVERED: |
Holger Hans Peter Freyther | 93de8b2 | 2014-02-24 16:13:04 +0100 | [diff] [blame] | 482 | /* Remember the subscriber and clear the pending entry */ |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 483 | network->sms_queue->pending -= 1; |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 484 | vsub = vlr_subscr_get(pending->vsub); |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 485 | sms_pending_free(pending); |
Holger Hans Peter Freyther | 93de8b2 | 2014-02-24 16:13:04 +0100 | [diff] [blame] | 486 | /* Attempt to send another SMS to this subscriber */ |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 487 | sms_send_next(vsub); |
| 488 | vlr_subscr_put(vsub); |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 489 | break; |
| 490 | case S_SMS_MEM_EXCEEDED: |
| 491 | network->sms_queue->pending -= 1; |
| 492 | sms_pending_free(pending); |
| 493 | sms_queue_trigger(network->sms_queue); |
| 494 | break; |
| 495 | case S_SMS_UNKNOWN_ERROR: |
| 496 | /* |
| 497 | * There can be many reasons for this failure. E.g. the paging |
| 498 | * timed out, the subscriber was not paged at all, or there was |
| 499 | * a protocol error. The current strategy is to try sending the |
| 500 | * next SMS for busy/oom and to retransmit when we have paged. |
| 501 | * |
| 502 | * When the paging expires three times we will disable the |
| 503 | * subscriber. If we have some kind of other transmit error we |
| 504 | * should flag the SMS as bad. |
| 505 | */ |
| 506 | switch (sig_sms->paging_result) { |
| 507 | case 0: |
| 508 | /* BAD SMS? */ |
| 509 | db_sms_inc_deliver_attempts(sig_sms->sms); |
| 510 | sms_pending_failed(pending, 0); |
| 511 | break; |
| 512 | case GSM_PAGING_EXPIRED: |
| 513 | sms_pending_failed(pending, 1); |
| 514 | break; |
| 515 | |
| 516 | case GSM_PAGING_OOM: |
| 517 | case GSM_PAGING_BUSY: |
| 518 | network->sms_queue->pending -= 1; |
| 519 | sms_pending_free(pending); |
| 520 | sms_queue_trigger(network->sms_queue); |
| 521 | break; |
| 522 | default: |
Holger Hans Peter Freyther | eff40949 | 2012-11-10 19:46:58 +0100 | [diff] [blame] | 523 | LOGP(DLSMS, LOGL_ERROR, "Unhandled result: %d\n", |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 524 | sig_sms->paging_result); |
| 525 | } |
| 526 | break; |
| 527 | default: |
Holger Hans Peter Freyther | eff40949 | 2012-11-10 19:46:58 +0100 | [diff] [blame] | 528 | LOGP(DLSMS, LOGL_ERROR, "Unhandled result: %d\n", |
Holger Hans Peter Freyther | 1716406 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 529 | sig_sms->paging_result); |
| 530 | } |
| 531 | |
| 532 | return 0; |
Holger Hans Peter Freyther | 11b28f9 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 533 | } |
Holger Hans Peter Freyther | 81c0e25 | 2010-12-25 14:08:00 +0100 | [diff] [blame] | 534 | |
| 535 | /* VTY helper functions */ |
| 536 | int sms_queue_stats(struct gsm_sms_queue *smsq, struct vty *vty) |
| 537 | { |
| 538 | struct gsm_sms_pending *pending; |
| 539 | |
| 540 | vty_out(vty, "SMSqueue with max_pending: %d pending: %d%s", |
| 541 | smsq->max_pending, smsq->pending, VTY_NEWLINE); |
| 542 | |
| 543 | llist_for_each_entry(pending, &smsq->pending_sms, entry) |
Holger Hans Peter Freyther | 583e9ae | 2010-12-27 20:19:48 +0100 | [diff] [blame] | 544 | vty_out(vty, " SMS Pending for Subscriber: %llu SMS: %llu Failed: %d.%s", |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 545 | pending->vsub->id, pending->sms_id, |
Holger Hans Peter Freyther | 583e9ae | 2010-12-27 20:19:48 +0100 | [diff] [blame] | 546 | pending->failed_attempts, VTY_NEWLINE); |
Holger Hans Peter Freyther | 81c0e25 | 2010-12-25 14:08:00 +0100 | [diff] [blame] | 547 | return 0; |
| 548 | } |
Holger Hans Peter Freyther | 3c6f6c2 | 2010-12-25 14:25:12 +0100 | [diff] [blame] | 549 | |
| 550 | int sms_queue_set_max_pending(struct gsm_sms_queue *smsq, int max_pending) |
| 551 | { |
Holger Hans Peter Freyther | eff40949 | 2012-11-10 19:46:58 +0100 | [diff] [blame] | 552 | LOGP(DLSMS, LOGL_NOTICE, "SMSqueue old max: %d new: %d\n", |
Holger Hans Peter Freyther | 3c6f6c2 | 2010-12-25 14:25:12 +0100 | [diff] [blame] | 553 | smsq->max_pending, max_pending); |
| 554 | smsq->max_pending = max_pending; |
| 555 | return 0; |
| 556 | } |
Holger Hans Peter Freyther | 4dcc5e5 | 2010-12-25 14:38:30 +0100 | [diff] [blame] | 557 | |
Holger Hans Peter Freyther | 994dcbb | 2010-12-25 14:50:50 +0100 | [diff] [blame] | 558 | int sms_queue_set_max_failure(struct gsm_sms_queue *smsq, int max_fail) |
| 559 | { |
Holger Hans Peter Freyther | eff40949 | 2012-11-10 19:46:58 +0100 | [diff] [blame] | 560 | LOGP(DLSMS, LOGL_NOTICE, "SMSqueue max failure old: %d new: %d\n", |
Holger Hans Peter Freyther | 994dcbb | 2010-12-25 14:50:50 +0100 | [diff] [blame] | 561 | smsq->max_fail, max_fail); |
| 562 | smsq->max_fail = max_fail; |
| 563 | return 0; |
| 564 | } |
| 565 | |
Holger Hans Peter Freyther | 4dcc5e5 | 2010-12-25 14:38:30 +0100 | [diff] [blame] | 566 | int sms_queue_clear(struct gsm_sms_queue *smsq) |
| 567 | { |
| 568 | struct gsm_sms_pending *pending, *tmp; |
| 569 | |
| 570 | llist_for_each_entry_safe(pending, tmp, &smsq->pending_sms, entry) { |
Holger Hans Peter Freyther | eff40949 | 2012-11-10 19:46:58 +0100 | [diff] [blame] | 571 | LOGP(DLSMS, LOGL_NOTICE, |
Harald Welte | 2483f1b | 2016-06-19 18:06:02 +0200 | [diff] [blame] | 572 | "SMSqueue clearing for sub %llu\n", pending->vsub->id); |
Holger Hans Peter Freyther | 4dcc5e5 | 2010-12-25 14:38:30 +0100 | [diff] [blame] | 573 | sms_pending_free(pending); |
| 574 | } |
| 575 | |
Holger Hans Peter Freyther | 96e9f08 | 2010-12-28 14:09:07 +0100 | [diff] [blame] | 576 | smsq->pending = 0; |
Holger Hans Peter Freyther | 4dcc5e5 | 2010-12-25 14:38:30 +0100 | [diff] [blame] | 577 | return 0; |
| 578 | } |