Holger Hans Peter Freyther | 575d2e1 | 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 | 0e3e88e | 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 | 575d2e1 | 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 | 0e3e88e | 2011-01-01 15:25:50 +0100 | [diff] [blame] | 14 | * GNU Affero General Public License for more details. |
Holger Hans Peter Freyther | 575d2e1 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 15 | * |
Harald Welte | 0e3e88e | 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 | 575d2e1 | 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 | |
| 31 | #include <openbsc/sms_queue.h> |
| 32 | #include <openbsc/chan_alloc.h> |
| 33 | #include <openbsc/db.h> |
| 34 | #include <openbsc/debug.h> |
| 35 | #include <openbsc/gsm_data.h> |
| 36 | #include <openbsc/gsm_04_11.h> |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 37 | #include <openbsc/gsm_subscriber.h> |
Holger Hans Peter Freyther | 575d2e1 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 38 | #include <openbsc/signal.h> |
| 39 | |
Pablo Neira Ayuso | dd5fff4 | 2011-03-22 16:47:59 +0100 | [diff] [blame] | 40 | #include <osmocom/core/talloc.h> |
Holger Hans Peter Freyther | 575d2e1 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 41 | |
Holger Hans Peter Freyther | 6ec8098 | 2010-12-25 14:08:00 +0100 | [diff] [blame] | 42 | #include <osmocom/vty/vty.h> |
| 43 | |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 44 | /* |
| 45 | * One pending SMS that we wait for. |
| 46 | */ |
| 47 | struct gsm_sms_pending { |
| 48 | struct llist_head entry; |
| 49 | |
| 50 | struct gsm_subscriber *subscr; |
| 51 | unsigned long long sms_id; |
| 52 | int failed_attempts; |
| 53 | int resend; |
| 54 | }; |
Holger Hans Peter Freyther | 575d2e1 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 55 | |
| 56 | struct gsm_sms_queue { |
Pablo Neira Ayuso | 840ccf6 | 2011-05-06 12:11:06 +0200 | [diff] [blame] | 57 | struct osmo_timer_list resend_pending; |
| 58 | struct osmo_timer_list push_queue; |
Holger Hans Peter Freyther | 575d2e1 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 59 | struct gsm_network *network; |
Holger Hans Peter Freyther | 4334e4e | 2010-12-25 14:46:54 +0100 | [diff] [blame] | 60 | int max_fail; |
Holger Hans Peter Freyther | 575d2e1 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 61 | int max_pending; |
| 62 | int pending; |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 63 | |
| 64 | struct llist_head pending_sms; |
| 65 | unsigned long long last_subscr_id; |
Holger Hans Peter Freyther | 575d2e1 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 66 | }; |
| 67 | |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 68 | static int sms_subscr_cb(unsigned int, unsigned int, void *, void *); |
| 69 | static int sms_sms_cb(unsigned int, unsigned int, void *, void *); |
| 70 | |
| 71 | static struct gsm_sms_pending *sms_find_pending(struct gsm_sms_queue *smsq, |
| 72 | struct gsm_sms *sms) |
| 73 | { |
| 74 | struct gsm_sms_pending *pending; |
| 75 | |
| 76 | llist_for_each_entry(pending, &smsq->pending_sms, entry) { |
| 77 | if (pending->sms_id == sms->id) |
| 78 | return pending; |
| 79 | } |
| 80 | |
| 81 | return NULL; |
| 82 | } |
| 83 | |
| 84 | static int sms_is_in_pending(struct gsm_sms_queue *smsq, struct gsm_sms *sms) |
| 85 | { |
| 86 | return sms_find_pending(smsq, sms) != NULL; |
| 87 | } |
| 88 | |
Holger Hans Peter Freyther | 735a280 | 2011-07-25 00:13:06 +0200 | [diff] [blame] | 89 | static struct gsm_sms_pending *sms_subscriber_find_pending( |
| 90 | struct gsm_sms_queue *smsq, |
| 91 | struct gsm_subscriber *subscr) |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 92 | { |
| 93 | struct gsm_sms_pending *pending; |
| 94 | |
| 95 | llist_for_each_entry(pending, &smsq->pending_sms, entry) { |
| 96 | if (pending->subscr == subscr) |
Holger Hans Peter Freyther | 735a280 | 2011-07-25 00:13:06 +0200 | [diff] [blame] | 97 | return pending; |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 98 | } |
| 99 | |
Holger Hans Peter Freyther | 735a280 | 2011-07-25 00:13:06 +0200 | [diff] [blame] | 100 | return NULL; |
| 101 | } |
| 102 | |
| 103 | static int sms_subscriber_is_pending(struct gsm_sms_queue *smsq, |
| 104 | struct gsm_subscriber *subscr) |
| 105 | { |
| 106 | return sms_subscriber_find_pending(smsq, subscr) != NULL; |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 107 | } |
| 108 | |
| 109 | static struct gsm_sms_pending *sms_pending_from(struct gsm_sms_queue *smsq, |
| 110 | struct gsm_sms *sms) |
| 111 | { |
| 112 | struct gsm_sms_pending *pending; |
| 113 | |
| 114 | pending = talloc_zero(smsq, struct gsm_sms_pending); |
| 115 | if (!pending) |
| 116 | return NULL; |
| 117 | |
| 118 | pending->subscr = subscr_get(sms->receiver); |
| 119 | pending->sms_id = sms->id; |
| 120 | return pending; |
| 121 | } |
| 122 | |
| 123 | static void sms_pending_free(struct gsm_sms_pending *pending) |
| 124 | { |
| 125 | subscr_put(pending->subscr); |
| 126 | llist_del(&pending->entry); |
| 127 | talloc_free(pending); |
| 128 | } |
| 129 | |
| 130 | static void sms_pending_resend(struct gsm_sms_pending *pending) |
| 131 | { |
| 132 | struct gsm_sms_queue *smsq; |
Holger Hans Peter Freyther | d0a34ed | 2012-11-10 19:46:58 +0100 | [diff] [blame] | 133 | LOGP(DLSMS, LOGL_DEBUG, |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 134 | "Scheduling resend of SMS %llu.\n", pending->sms_id); |
| 135 | |
| 136 | pending->resend = 1; |
| 137 | |
Jacob Erlbeck | da8770b | 2014-12-03 09:28:24 +0100 | [diff] [blame] | 138 | smsq = pending->subscr->group->net->sms_queue; |
Pablo Neira Ayuso | 840ccf6 | 2011-05-06 12:11:06 +0200 | [diff] [blame] | 139 | if (osmo_timer_pending(&smsq->resend_pending)) |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 140 | return; |
| 141 | |
Pablo Neira Ayuso | 840ccf6 | 2011-05-06 12:11:06 +0200 | [diff] [blame] | 142 | osmo_timer_schedule(&smsq->resend_pending, 1, 0); |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 143 | } |
| 144 | |
| 145 | static void sms_pending_failed(struct gsm_sms_pending *pending, int paging_error) |
| 146 | { |
| 147 | struct gsm_sms_queue *smsq; |
| 148 | |
Holger Hans Peter Freyther | d0a34ed | 2012-11-10 19:46:58 +0100 | [diff] [blame] | 149 | LOGP(DLSMS, LOGL_NOTICE, "Sending SMS %llu failed %d times.\n", |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 150 | pending->sms_id, pending->failed_attempts); |
| 151 | |
Jacob Erlbeck | da8770b | 2014-12-03 09:28:24 +0100 | [diff] [blame] | 152 | smsq = pending->subscr->group->net->sms_queue; |
Holger Hans Peter Freyther | 4334e4e | 2010-12-25 14:46:54 +0100 | [diff] [blame] | 153 | if (++pending->failed_attempts < smsq->max_fail) |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 154 | return sms_pending_resend(pending); |
| 155 | |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 156 | sms_pending_free(pending); |
| 157 | smsq->pending -= 1; |
| 158 | sms_queue_trigger(smsq); |
| 159 | } |
| 160 | |
| 161 | /* |
| 162 | * Resend all SMS that are scheduled for a resend. This is done to |
| 163 | * avoid an immediate failure. |
| 164 | */ |
| 165 | static void sms_resend_pending(void *_data) |
| 166 | { |
| 167 | struct gsm_sms_pending *pending, *tmp; |
| 168 | struct gsm_sms_queue *smsq = _data; |
| 169 | |
| 170 | llist_for_each_entry_safe(pending, tmp, &smsq->pending_sms, entry) { |
| 171 | struct gsm_sms *sms; |
| 172 | if (!pending->resend) |
| 173 | continue; |
| 174 | |
| 175 | sms = db_sms_get(smsq->network, pending->sms_id); |
| 176 | |
| 177 | /* the sms is gone? Move to the next */ |
| 178 | if (!sms) { |
| 179 | sms_pending_free(pending); |
| 180 | smsq->pending -= 1; |
| 181 | sms_queue_trigger(smsq); |
| 182 | } else { |
| 183 | pending->resend = 0; |
| 184 | gsm411_send_sms_subscr(sms->receiver, sms); |
| 185 | } |
| 186 | } |
| 187 | } |
| 188 | |
Holger Hans Peter Freyther | e41db2a | 2010-12-25 17:45:23 +0100 | [diff] [blame] | 189 | static struct gsm_sms *take_next_sms(struct gsm_sms_queue *smsq) |
| 190 | { |
| 191 | struct gsm_sms *sms; |
| 192 | |
| 193 | sms = db_sms_get_unsent_by_subscr(smsq->network, smsq->last_subscr_id, 10); |
| 194 | if (sms) { |
| 195 | smsq->last_subscr_id = sms->receiver->id + 1; |
| 196 | return sms; |
| 197 | } |
| 198 | |
| 199 | /* need to wrap around */ |
| 200 | smsq->last_subscr_id = 0; |
| 201 | sms = db_sms_get_unsent_by_subscr(smsq->network, |
| 202 | smsq->last_subscr_id, 10); |
| 203 | if (sms) |
| 204 | smsq->last_subscr_id = sms->receiver->id + 1; |
| 205 | return sms; |
| 206 | } |
| 207 | |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 208 | /** |
| 209 | * I will submit up to max_pending - pending SMS to the |
| 210 | * subsystem. |
| 211 | */ |
| 212 | static void sms_submit_pending(void *_data) |
| 213 | { |
| 214 | struct gsm_sms_queue *smsq = _data; |
| 215 | int attempts = smsq->max_pending - smsq->pending; |
Holger Hans Peter Freyther | 3e479cc | 2010-12-25 19:28:44 +0100 | [diff] [blame] | 216 | int initialized = 0; |
| 217 | unsigned long long first_sub = 0; |
Holger Hans Peter Freyther | 8ba6f85 | 2010-12-25 19:32:12 +0100 | [diff] [blame] | 218 | int attempted = 0, rounds = 0; |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 219 | |
Harald Welte | 2caad25 | 2012-11-13 06:52:42 +0100 | [diff] [blame] | 220 | LOGP(DLSMS, LOGL_DEBUG, "Attempting to send %d SMS\n", attempts); |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 221 | |
Holger Hans Peter Freyther | 3e479cc | 2010-12-25 19:28:44 +0100 | [diff] [blame] | 222 | do { |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 223 | struct gsm_sms_pending *pending; |
| 224 | struct gsm_sms *sms; |
| 225 | |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 226 | |
Holger Hans Peter Freyther | e41db2a | 2010-12-25 17:45:23 +0100 | [diff] [blame] | 227 | sms = take_next_sms(smsq); |
Neels Hofmeyr | 69cc0a1 | 2016-05-09 21:48:53 +0200 | [diff] [blame] | 228 | if (!sms) { |
| 229 | LOGP(DLSMS, LOGL_DEBUG, "Sending SMS done (%d attempted)\n", |
| 230 | attempted); |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 231 | break; |
Neels Hofmeyr | 69cc0a1 | 2016-05-09 21:48:53 +0200 | [diff] [blame] | 232 | } |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 233 | |
Holger Hans Peter Freyther | 8ba6f85 | 2010-12-25 19:32:12 +0100 | [diff] [blame] | 234 | rounds += 1; |
Neels Hofmeyr | 69cc0a1 | 2016-05-09 21:48:53 +0200 | [diff] [blame] | 235 | LOGP(DLSMS, LOGL_DEBUG, "Sending SMS round %d\n", rounds); |
Holger Hans Peter Freyther | 8ba6f85 | 2010-12-25 19:32:12 +0100 | [diff] [blame] | 236 | |
Holger Hans Peter Freyther | 3e479cc | 2010-12-25 19:28:44 +0100 | [diff] [blame] | 237 | /* |
| 238 | * This code needs to detect a loop. It assumes that no SMS |
| 239 | * will vanish during the time this is executed. We will remember |
| 240 | * the id of the first GSM subscriber we see and then will |
| 241 | * compare this. The Database code should make sure that we will |
| 242 | * see all other subscribers first before seeing this one again. |
| 243 | * |
| 244 | * It is always scary to have an infinite loop like this. |
| 245 | */ |
| 246 | if (!initialized) { |
| 247 | first_sub = sms->receiver->id; |
| 248 | initialized = 1; |
| 249 | } else if (first_sub == sms->receiver->id) { |
Neels Hofmeyr | 69cc0a1 | 2016-05-09 21:48:53 +0200 | [diff] [blame] | 250 | LOGP(DLSMS, LOGL_DEBUG, "Sending SMS done (loop) (%d attempted)\n", |
| 251 | attempted); |
Holger Hans Peter Freyther | 3e479cc | 2010-12-25 19:28:44 +0100 | [diff] [blame] | 252 | sms_free(sms); |
| 253 | break; |
| 254 | } |
| 255 | |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 256 | /* no need to send a pending sms */ |
| 257 | if (sms_is_in_pending(smsq, sms)) { |
Holger Hans Peter Freyther | d0a34ed | 2012-11-10 19:46:58 +0100 | [diff] [blame] | 258 | LOGP(DLSMS, LOGL_DEBUG, |
Holger Hans Peter Freyther | 487b9aa | 2010-12-27 20:12:25 +0100 | [diff] [blame] | 259 | "SMSqueue with pending sms: %llu. Skipping\n", sms->id); |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 260 | sms_free(sms); |
| 261 | continue; |
| 262 | } |
| 263 | |
| 264 | /* no need to send a SMS with the same receiver */ |
| 265 | if (sms_subscriber_is_pending(smsq, sms->receiver)) { |
Holger Hans Peter Freyther | d0a34ed | 2012-11-10 19:46:58 +0100 | [diff] [blame] | 266 | LOGP(DLSMS, LOGL_DEBUG, |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 267 | "SMSqueue with pending sub: %llu. Skipping\n", sms->receiver->id); |
| 268 | sms_free(sms); |
| 269 | continue; |
| 270 | } |
| 271 | |
| 272 | pending = sms_pending_from(smsq, sms); |
| 273 | if (!pending) { |
Holger Hans Peter Freyther | d0a34ed | 2012-11-10 19:46:58 +0100 | [diff] [blame] | 274 | LOGP(DLSMS, LOGL_ERROR, |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 275 | "Failed to create pending SMS entry.\n"); |
| 276 | sms_free(sms); |
| 277 | continue; |
| 278 | } |
| 279 | |
Holger Hans Peter Freyther | 3e479cc | 2010-12-25 19:28:44 +0100 | [diff] [blame] | 280 | attempted += 1; |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 281 | smsq->pending += 1; |
Holger Hans Peter Freyther | b01ca46 | 2010-12-28 14:25:25 +0100 | [diff] [blame] | 282 | llist_add_tail(&pending->entry, &smsq->pending_sms); |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 283 | gsm411_send_sms_subscr(sms->receiver, sms); |
Holger Hans Peter Freyther | 8ba6f85 | 2010-12-25 19:32:12 +0100 | [diff] [blame] | 284 | } while (attempted < attempts && rounds < 1000); |
Holger Hans Peter Freyther | 3e479cc | 2010-12-25 19:28:44 +0100 | [diff] [blame] | 285 | |
Holger Hans Peter Freyther | d0a34ed | 2012-11-10 19:46:58 +0100 | [diff] [blame] | 286 | LOGP(DLSMS, LOGL_DEBUG, "SMSqueue added %d messages in %d rounds\n", attempted, rounds); |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 287 | } |
| 288 | |
Holger Hans Peter Freyther | e057698 | 2014-02-24 16:13:04 +0100 | [diff] [blame] | 289 | /** |
| 290 | * Send the next SMS or trigger the queue |
| 291 | */ |
| 292 | static void sms_send_next(struct gsm_subscriber *subscr) |
| 293 | { |
Jacob Erlbeck | da8770b | 2014-12-03 09:28:24 +0100 | [diff] [blame] | 294 | struct gsm_sms_queue *smsq = subscr->group->net->sms_queue; |
Holger Hans Peter Freyther | e057698 | 2014-02-24 16:13:04 +0100 | [diff] [blame] | 295 | struct gsm_sms_pending *pending; |
| 296 | struct gsm_sms *sms; |
| 297 | |
| 298 | /* the subscriber should not be in the queue */ |
| 299 | OSMO_ASSERT(!sms_subscriber_is_pending(smsq, subscr)); |
| 300 | |
| 301 | /* check for more messages for this subscriber */ |
| 302 | sms = db_sms_get_unsent_for_subscr(subscr); |
| 303 | if (!sms) |
| 304 | goto no_pending_sms; |
| 305 | |
| 306 | /* No sms should be scheduled right now */ |
| 307 | OSMO_ASSERT(!sms_is_in_pending(smsq, sms)); |
| 308 | |
| 309 | /* Remember that we deliver this SMS and send it */ |
| 310 | pending = sms_pending_from(smsq, sms); |
| 311 | if (!pending) { |
| 312 | LOGP(DLSMS, LOGL_ERROR, |
| 313 | "Failed to create pending SMS entry.\n"); |
| 314 | sms_free(sms); |
| 315 | goto no_pending_sms; |
| 316 | } |
| 317 | |
| 318 | smsq->pending += 1; |
| 319 | llist_add_tail(&pending->entry, &smsq->pending_sms); |
| 320 | gsm411_send_sms_subscr(sms->receiver, sms); |
| 321 | return; |
| 322 | |
| 323 | no_pending_sms: |
| 324 | /* Try to send the SMS to avoid the queue being stuck */ |
Jacob Erlbeck | da8770b | 2014-12-03 09:28:24 +0100 | [diff] [blame] | 325 | sms_submit_pending(subscr->group->net->sms_queue); |
Holger Hans Peter Freyther | e057698 | 2014-02-24 16:13:04 +0100 | [diff] [blame] | 326 | } |
| 327 | |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 328 | /* |
| 329 | * Kick off the queue again. |
| 330 | */ |
| 331 | int sms_queue_trigger(struct gsm_sms_queue *smsq) |
| 332 | { |
Neels Hofmeyr | 69cc0a1 | 2016-05-09 21:48:53 +0200 | [diff] [blame] | 333 | LOGP(DLSMS, LOGL_DEBUG, "Triggering SMS queue\n"); |
Pablo Neira Ayuso | 840ccf6 | 2011-05-06 12:11:06 +0200 | [diff] [blame] | 334 | if (osmo_timer_pending(&smsq->push_queue)) |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 335 | return 0; |
| 336 | |
Pablo Neira Ayuso | 840ccf6 | 2011-05-06 12:11:06 +0200 | [diff] [blame] | 337 | osmo_timer_schedule(&smsq->push_queue, 1, 0); |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 338 | return 0; |
| 339 | } |
Holger Hans Peter Freyther | 575d2e1 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 340 | |
| 341 | int sms_queue_start(struct gsm_network *network, int max_pending) |
| 342 | { |
| 343 | struct gsm_sms_queue *sms = talloc_zero(network, struct gsm_sms_queue); |
| 344 | if (!sms) { |
| 345 | LOGP(DMSC, LOGL_ERROR, "Failed to create the SMS queue.\n"); |
| 346 | return -1; |
| 347 | } |
| 348 | |
Pablo Neira Ayuso | ef717c6 | 2011-05-06 12:12:31 +0200 | [diff] [blame] | 349 | osmo_signal_register_handler(SS_SUBSCR, sms_subscr_cb, network); |
| 350 | osmo_signal_register_handler(SS_SMS, sms_sms_cb, network); |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 351 | |
Holger Hans Peter Freyther | 575d2e1 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 352 | network->sms_queue = sms; |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 353 | INIT_LLIST_HEAD(&sms->pending_sms); |
Holger Hans Peter Freyther | 4871046 | 2010-12-25 17:43:03 +0100 | [diff] [blame] | 354 | sms->max_fail = 1; |
Holger Hans Peter Freyther | 575d2e1 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 355 | sms->network = network; |
| 356 | sms->max_pending = max_pending; |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 357 | sms->push_queue.data = sms; |
| 358 | sms->push_queue.cb = sms_submit_pending; |
| 359 | sms->resend_pending.data = sms; |
| 360 | sms->resend_pending.cb = sms_resend_pending; |
| 361 | |
| 362 | sms_submit_pending(sms); |
Holger Hans Peter Freyther | 575d2e1 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 363 | |
| 364 | return 0; |
| 365 | } |
| 366 | |
Holger Hans Peter Freyther | 735a280 | 2011-07-25 00:13:06 +0200 | [diff] [blame] | 367 | static int sub_ready_for_sm(struct gsm_network *net, struct gsm_subscriber *subscr) |
Holger Hans Peter Freyther | 575d2e1 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 368 | { |
Holger Hans Peter Freyther | 575d2e1 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 369 | struct gsm_sms *sms; |
Holger Hans Peter Freyther | 735a280 | 2011-07-25 00:13:06 +0200 | [diff] [blame] | 370 | struct gsm_sms_pending *pending; |
| 371 | struct gsm_subscriber_connection *conn; |
Holger Hans Peter Freyther | 575d2e1 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 372 | |
Holger Hans Peter Freyther | 735a280 | 2011-07-25 00:13:06 +0200 | [diff] [blame] | 373 | /* |
| 374 | * The code used to be very clever and tried to submit |
| 375 | * a SMS during the Location Updating Request. This has |
| 376 | * two issues: |
| 377 | * 1.) The Phone might not be ready yet, e.g. the C155 |
| 378 | * will not respond to the Submit when it is booting. |
| 379 | * 2.) The queue is already trying to submit SMS to the |
| 380 | * user and by not responding to the paging request |
| 381 | * we will set the LAC back to 0. We would have to |
| 382 | * stop the paging and move things over. |
| 383 | * |
| 384 | * We need to be careful in what we try here. |
| 385 | */ |
| 386 | |
| 387 | /* check if we have pending requests */ |
| 388 | pending = sms_subscriber_find_pending(net->sms_queue, subscr); |
| 389 | if (pending) { |
| 390 | LOGP(DMSC, LOGL_NOTICE, |
| 391 | "Pending paging while subscriber %llu attached.\n", |
| 392 | subscr->id); |
Holger Hans Peter Freyther | 735a280 | 2011-07-25 00:13:06 +0200 | [diff] [blame] | 393 | return 0; |
| 394 | } |
| 395 | |
Holger Hans Peter Freyther | 575d2e1 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 396 | conn = connection_for_subscr(subscr); |
| 397 | if (!conn) |
| 398 | return -1; |
Holger Hans Peter Freyther | 735a280 | 2011-07-25 00:13:06 +0200 | [diff] [blame] | 399 | |
| 400 | /* Now try to deliver any pending SMS to this sub */ |
Holger Hans Peter Freyther | 575d2e1 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 401 | sms = db_sms_get_unsent_for_subscr(subscr); |
| 402 | if (!sms) |
| 403 | return -1; |
| 404 | gsm411_send_sms(conn, sms); |
| 405 | return 0; |
| 406 | } |
| 407 | |
| 408 | static int sms_subscr_cb(unsigned int subsys, unsigned int signal, |
| 409 | void *handler_data, void *signal_data) |
| 410 | { |
| 411 | struct gsm_subscriber *subscr = signal_data; |
| 412 | |
| 413 | if (signal != S_SUBSCR_ATTACHED) |
| 414 | return 0; |
| 415 | |
| 416 | /* this is readyForSM */ |
Holger Hans Peter Freyther | 735a280 | 2011-07-25 00:13:06 +0200 | [diff] [blame] | 417 | return sub_ready_for_sm(handler_data, subscr); |
Holger Hans Peter Freyther | 575d2e1 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 418 | } |
| 419 | |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 420 | static int sms_sms_cb(unsigned int subsys, unsigned int signal, |
| 421 | void *handler_data, void *signal_data) |
Holger Hans Peter Freyther | 575d2e1 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 422 | { |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 423 | struct gsm_network *network = handler_data; |
| 424 | struct sms_signal_data *sig_sms = signal_data; |
| 425 | struct gsm_sms_pending *pending; |
Holger Hans Peter Freyther | e057698 | 2014-02-24 16:13:04 +0100 | [diff] [blame] | 426 | struct gsm_subscriber *subscr; |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 427 | |
| 428 | /* We got a new SMS and maybe should launch the queue again. */ |
| 429 | if (signal == S_SMS_SUBMITTED || signal == S_SMS_SMMA) { |
Holger Hans Peter Freyther | a0cfc32 | 2014-02-24 14:29:27 +0100 | [diff] [blame] | 430 | /* TODO: For SMMA we might want to re-use the radio connection. */ |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 431 | sms_queue_trigger(network->sms_queue); |
| 432 | return 0; |
| 433 | } |
| 434 | |
| 435 | if (!sig_sms->sms) |
| 436 | return -1; |
| 437 | |
| 438 | |
| 439 | /* |
| 440 | * Find the entry of our queue. The SMS subsystem will submit |
| 441 | * sms that are not in our control as we just have a channel |
| 442 | * open anyway. |
| 443 | */ |
| 444 | pending = sms_find_pending(network->sms_queue, sig_sms->sms); |
| 445 | if (!pending) |
| 446 | return 0; |
| 447 | |
| 448 | switch (signal) { |
| 449 | case S_SMS_DELIVERED: |
Holger Hans Peter Freyther | e057698 | 2014-02-24 16:13:04 +0100 | [diff] [blame] | 450 | /* Remember the subscriber and clear the pending entry */ |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 451 | network->sms_queue->pending -= 1; |
Holger Hans Peter Freyther | e057698 | 2014-02-24 16:13:04 +0100 | [diff] [blame] | 452 | subscr = subscr_get(pending->subscr); |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 453 | sms_pending_free(pending); |
Holger Hans Peter Freyther | e057698 | 2014-02-24 16:13:04 +0100 | [diff] [blame] | 454 | /* Attempt to send another SMS to this subscriber */ |
| 455 | sms_send_next(subscr); |
| 456 | subscr_put(subscr); |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 457 | break; |
| 458 | case S_SMS_MEM_EXCEEDED: |
| 459 | network->sms_queue->pending -= 1; |
| 460 | sms_pending_free(pending); |
| 461 | sms_queue_trigger(network->sms_queue); |
| 462 | break; |
| 463 | case S_SMS_UNKNOWN_ERROR: |
| 464 | /* |
| 465 | * There can be many reasons for this failure. E.g. the paging |
| 466 | * timed out, the subscriber was not paged at all, or there was |
| 467 | * a protocol error. The current strategy is to try sending the |
| 468 | * next SMS for busy/oom and to retransmit when we have paged. |
| 469 | * |
| 470 | * When the paging expires three times we will disable the |
| 471 | * subscriber. If we have some kind of other transmit error we |
| 472 | * should flag the SMS as bad. |
| 473 | */ |
| 474 | switch (sig_sms->paging_result) { |
| 475 | case 0: |
| 476 | /* BAD SMS? */ |
| 477 | db_sms_inc_deliver_attempts(sig_sms->sms); |
| 478 | sms_pending_failed(pending, 0); |
| 479 | break; |
| 480 | case GSM_PAGING_EXPIRED: |
| 481 | sms_pending_failed(pending, 1); |
| 482 | break; |
| 483 | |
| 484 | case GSM_PAGING_OOM: |
| 485 | case GSM_PAGING_BUSY: |
| 486 | network->sms_queue->pending -= 1; |
| 487 | sms_pending_free(pending); |
| 488 | sms_queue_trigger(network->sms_queue); |
| 489 | break; |
| 490 | default: |
Holger Hans Peter Freyther | d0a34ed | 2012-11-10 19:46:58 +0100 | [diff] [blame] | 491 | LOGP(DLSMS, LOGL_ERROR, "Unhandled result: %d\n", |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 492 | sig_sms->paging_result); |
| 493 | } |
| 494 | break; |
| 495 | default: |
Holger Hans Peter Freyther | d0a34ed | 2012-11-10 19:46:58 +0100 | [diff] [blame] | 496 | LOGP(DLSMS, LOGL_ERROR, "Unhandled result: %d\n", |
Holger Hans Peter Freyther | 6131833 | 2010-12-24 21:39:55 +0100 | [diff] [blame] | 497 | sig_sms->paging_result); |
| 498 | } |
| 499 | |
| 500 | return 0; |
Holger Hans Peter Freyther | 575d2e1 | 2010-12-24 13:48:27 +0100 | [diff] [blame] | 501 | } |
Holger Hans Peter Freyther | 6ec8098 | 2010-12-25 14:08:00 +0100 | [diff] [blame] | 502 | |
| 503 | /* VTY helper functions */ |
| 504 | int sms_queue_stats(struct gsm_sms_queue *smsq, struct vty *vty) |
| 505 | { |
| 506 | struct gsm_sms_pending *pending; |
| 507 | |
| 508 | vty_out(vty, "SMSqueue with max_pending: %d pending: %d%s", |
| 509 | smsq->max_pending, smsq->pending, VTY_NEWLINE); |
| 510 | |
| 511 | llist_for_each_entry(pending, &smsq->pending_sms, entry) |
Holger Hans Peter Freyther | eed400a | 2010-12-27 20:19:48 +0100 | [diff] [blame] | 512 | vty_out(vty, " SMS Pending for Subscriber: %llu SMS: %llu Failed: %d.%s", |
| 513 | pending->subscr->id, pending->sms_id, |
| 514 | pending->failed_attempts, VTY_NEWLINE); |
Holger Hans Peter Freyther | 6ec8098 | 2010-12-25 14:08:00 +0100 | [diff] [blame] | 515 | return 0; |
| 516 | } |
Holger Hans Peter Freyther | 96b4d35 | 2010-12-25 14:25:12 +0100 | [diff] [blame] | 517 | |
| 518 | int sms_queue_set_max_pending(struct gsm_sms_queue *smsq, int max_pending) |
| 519 | { |
Holger Hans Peter Freyther | d0a34ed | 2012-11-10 19:46:58 +0100 | [diff] [blame] | 520 | LOGP(DLSMS, LOGL_NOTICE, "SMSqueue old max: %d new: %d\n", |
Holger Hans Peter Freyther | 96b4d35 | 2010-12-25 14:25:12 +0100 | [diff] [blame] | 521 | smsq->max_pending, max_pending); |
| 522 | smsq->max_pending = max_pending; |
| 523 | return 0; |
| 524 | } |
Holger Hans Peter Freyther | 416c7de | 2010-12-25 14:38:30 +0100 | [diff] [blame] | 525 | |
Holger Hans Peter Freyther | 70428d9 | 2010-12-25 14:50:50 +0100 | [diff] [blame] | 526 | int sms_queue_set_max_failure(struct gsm_sms_queue *smsq, int max_fail) |
| 527 | { |
Holger Hans Peter Freyther | d0a34ed | 2012-11-10 19:46:58 +0100 | [diff] [blame] | 528 | LOGP(DLSMS, LOGL_NOTICE, "SMSqueue max failure old: %d new: %d\n", |
Holger Hans Peter Freyther | 70428d9 | 2010-12-25 14:50:50 +0100 | [diff] [blame] | 529 | smsq->max_fail, max_fail); |
| 530 | smsq->max_fail = max_fail; |
| 531 | return 0; |
| 532 | } |
| 533 | |
Holger Hans Peter Freyther | 416c7de | 2010-12-25 14:38:30 +0100 | [diff] [blame] | 534 | int sms_queue_clear(struct gsm_sms_queue *smsq) |
| 535 | { |
| 536 | struct gsm_sms_pending *pending, *tmp; |
| 537 | |
| 538 | llist_for_each_entry_safe(pending, tmp, &smsq->pending_sms, entry) { |
Holger Hans Peter Freyther | d0a34ed | 2012-11-10 19:46:58 +0100 | [diff] [blame] | 539 | LOGP(DLSMS, LOGL_NOTICE, |
Holger Hans Peter Freyther | 416c7de | 2010-12-25 14:38:30 +0100 | [diff] [blame] | 540 | "SMSqueue clearing for sub %llu\n", pending->subscr->id); |
| 541 | sms_pending_free(pending); |
| 542 | } |
| 543 | |
Holger Hans Peter Freyther | 7142b28 | 2010-12-28 14:09:07 +0100 | [diff] [blame] | 544 | smsq->pending = 0; |
Holger Hans Peter Freyther | 416c7de | 2010-12-25 14:38:30 +0100 | [diff] [blame] | 545 | return 0; |
| 546 | } |