904e70ca44d6b94c9ab4a9689f187257579adf80
[asterisk/asterisk.git] / res / res_pjsip / pjsip_options.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2018, Digium, Inc.
5  *
6  * Joshua Colp <jcolp@digium.com>
7  * Richard Mudgett <rmudgett@digium.com>
8  *
9  * See http://www.asterisk.org for more information about
10  * the Asterisk project. Please do not directly contact
11  * any of the maintainers of this project for assistance;
12  * the project provides a web site, mailing lists and IRC
13  * channels for your use.
14  *
15  * This program is free software, distributed under the terms of
16  * the GNU General Public License Version 2. See the LICENSE file
17  * at the top of the source tree.
18  */
19
20 #include "asterisk.h"
21
22 #include <pjsip.h>
23 #include <pjsip_ua.h>
24 #include <pjlib.h>
25
26 #include "asterisk/res_pjsip.h"
27 #include "asterisk/channel.h"
28 #include "asterisk/pbx.h"
29 #include "asterisk/astobj2.h"
30 #include "asterisk/cli.h"
31 #include "asterisk/time.h"
32 #include "asterisk/test.h"
33 #include "asterisk/statsd.h"
34 #include "include/res_pjsip_private.h"
35 #include "asterisk/taskprocessor.h"
36 #include "asterisk/threadpool.h"
37
38 /*
39  * This implementation for OPTIONS support is based around the idea
40  * that realistically an AOR generally has very few contacts and is
41  * referenced by only a few endpoints. While it is perfectly fine for
42  * use in opposite scenarios it works best in the above case. It is
43  * also not shy to keeping state but it is reactive to outside changes
44  * so it can be updated.
45  *
46  * The lowest level object in here is a contact and its associated
47  * contact status. The result of an OPTIONS request to a contact is
48  * reflected in the contact status. The scheduling of these OPTIONS
49  * request is driven by the AOR. The AOR periodicially (according to
50  * configuration) sends OPTIONS requests out to any contacts
51  * associated with it. Contacts themselves are not individually
52  * scheduled. Contacts can be added or deleted as appropriate with no
53  * requirement to reschedule.
54  *
55  * The next level object up is the AOR itself. The result of a contact
56  * status change is fed into it and the result composited with all
57  * other contacts. This may result in the AOR itself changing state
58  * (it can be either AVAILABLE or UNAVAILABLE).
59  *
60  * The highest level object up is the endpoint state compositor (ESC).
61  * The result of AOR state changes is fed into it and the result
62  * composited with all other referenced AORs. This may result in the
63  * endpoint itself changing state (it can be either ONLINE or
64  * OFFLINE).  If this occurs the permanent endpoint is updated to
65  * reflect it.
66  *
67  * The threading model errs on the side of a world where things are
68  * not constantly changing. That is: A world where AORs and endpoints
69  * are not being constantly added/removed. This more closely mirrors
70  * the usage of the vast majority of people. This scenario can still
71  * be done but it may not be applied immediately.
72  *
73  * Manipulation of which AORs, endpoint state compositors, and
74  * contacts exist is done within a single serializer. This ensures
75  * that no matter the source threads order is preserved and you won't
76  * get into a weird situation where things are referencing other
77  * things that should have already been destroyed.
78  *
79  * Operations which impact the state of an AOR are done within a
80  * serializer that is specific to the AOR. This includes the result of
81  * a contact status change. This change is queued and executed on the
82  * AOR serializer afterwards.
83  *
84  * Operations which impact an endpoint state compositor are protected
85  * by a lock. This is done as the endpoint state compositor usage is
86  * minimal and the overhead of using a serializer and queueing things
87  * is not warranted.
88  *
89  * AORs which do not have a qualify frequency are also kept in here
90  * but do not require the same criteria as qualified AORs to be
91  * considered available. In their case as long as at least 1 contact
92  * is configured on the AOR (or added to it by registration) it is
93  * considered available.
94  */
95
96 #define DEFAULT_LANGUAGE "en"
97 #define DEFAULT_ENCODING "text/plain"
98
99 /*! \brief These are the number of buckets to store AORs in */
100 #ifdef LOW_MEMORY
101 #define AOR_BUCKETS 61
102 #else
103 #define AOR_BUCKETS 1567
104 #endif
105
106 /*! \brief These are the number of contact status buckets */
107 #ifdef LOW_MEMORY
108 #define CONTACT_STATUS_BUCKETS 61
109 #else
110 #define CONTACT_STATUS_BUCKETS 1567
111 #endif
112
113 /*! \brief These are the number of buckets (per AOR) to use to store contacts */
114 #define CONTACT_BUCKETS 13
115
116 /*! \brief These are the number of buckets to store endpoint state compositors */
117 #define ENDPOINT_STATE_COMPOSITOR_BUCKETS 13
118
119 /*! \brief The initial vector size for the endpoint state compositors on an AOR */
120 #define ENDPOINT_STATE_COMPOSITOR_INITIAL_SIZE 1
121
122 /*! \brief These are the number of buckets (per endpoint state compositor) to use to store AOR statuses */
123 #define AOR_STATUS_BUCKETS 3
124
125 /*! \brief Maximum wait time to join the below shutdown group */
126 #define MAX_UNLOAD_TIMEOUT_TIME         10      /* Seconds */
127
128 /*! \brief Shutdown group for options serializers */
129 static struct ast_serializer_shutdown_group *shutdown_group;
130
131 /*!
132  * \brief Structure which contains status information for an AOR feeding an endpoint state compositor
133  */
134 struct sip_options_endpoint_aor_status {
135         /*! \brief The last contributed available status of the named AOR (1 if available, 0 if not available) */
136         char available;
137         /*! \brief The name of the AOR */
138         char name[0];
139 };
140
141 /*!
142  * \brief Structure which contains composites information for endpoint state
143  */
144 struct sip_options_endpoint_state_compositor {
145         /*! \brief The last contributed available status of the AORs feeding this compositor */
146         struct ao2_container *aor_statuses;
147         /*!
148          * \brief Non-zero if the compositor is in normal operation. i.e. Not being setup/reconfigured.
149          *
150          * \details
151          * The aor layer can only update its aor_statuses record when not active.
152          * When active the aor layer can update its aor_statuses record, calculate the new
153          * number of available aors, determine if the endpoint compositor changed state,
154          * and report it.
155          */
156         char active;
157         /*! \brief The name of the endpoint */
158         char name[0];
159 };
160
161 /*!
162  * \brief Structure which contains an AOR and contacts for qualifying purposes
163  */
164 struct sip_options_aor {
165         /*! \brief The scheduler task for this AOR */
166         struct ast_sip_sched_task *sched_task;
167         /*! \brief The serializer for this AOR */
168         struct ast_taskprocessor *serializer;
169         /*! \brief All contacts associated with this AOR */
170         struct ao2_container *contacts;
171         /*!
172          * \brief Only dynamic contacts associated with this AOR
173          * \note Used to speed up applying AOR configuration by
174          * minimizing wild card sorcery access.
175          */
176         struct ao2_container *dynamic_contacts;
177         /*! \brief The endpoint state compositors we are feeding, a reference is held to each */
178         AST_VECTOR(, struct sip_options_endpoint_state_compositor *) compositors;
179         /*! \brief The number of available contacts on this AOR */
180         unsigned int available;
181         /*! \brief Frequency to send OPTIONS requests to AOR contacts. 0 is disabled. */
182         unsigned int qualify_frequency;
183         /*! If true authenticate the qualify challenge response if needed */
184         int authenticate_qualify;
185         /*! \brief Qualify timeout. 0 is diabled. */
186         double qualify_timeout;
187         /*! \brief The name of the AOR */
188         char name[0];
189 };
190
191 /*!
192  * \internal
193  * \brief Container of active SIP AORs for qualifying
194  */
195 static struct ao2_container *sip_options_aors;
196
197 /*!
198  * \internal
199  * \brief Container of contact statuses
200  */
201 static struct ao2_container *sip_options_contact_statuses;
202
203 /*!
204  * \internal
205  * \brief Container of endpoint state compositors
206  */
207 static struct ao2_container *sip_options_endpoint_state_compositors;
208
209 /*!
210  * \internal
211  * \brief Serializer for AOR, endpoint state compositor, and contact existence management
212  */
213 static struct ast_taskprocessor *management_serializer;
214
215 static pj_status_t send_options_response(pjsip_rx_data *rdata, int code)
216 {
217         pjsip_endpoint *endpt = ast_sip_get_pjsip_endpoint();
218         pjsip_dialog *dlg = pjsip_rdata_get_dlg(rdata);
219         pjsip_transaction *trans = pjsip_rdata_get_tsx(rdata);
220         pjsip_tx_data *tdata;
221         const pjsip_hdr *hdr;
222         pj_status_t status;
223
224         /* Make the response object */
225         status = ast_sip_create_response(rdata, code, NULL, &tdata);
226         if (status != PJ_SUCCESS) {
227                 ast_log(LOG_ERROR, "Unable to create response (%d)\n", status);
228                 return status;
229         }
230
231         /* Add appropriate headers */
232         if ((hdr = pjsip_endpt_get_capability(endpt, PJSIP_H_ACCEPT, NULL))) {
233                 pjsip_msg_add_hdr(tdata->msg, (pjsip_hdr*)pjsip_hdr_clone(tdata->pool, hdr));
234         }
235         if ((hdr = pjsip_endpt_get_capability(endpt, PJSIP_H_ALLOW, NULL))) {
236                 pjsip_msg_add_hdr(tdata->msg, (pjsip_hdr*)pjsip_hdr_clone(tdata->pool, hdr));
237         }
238         if ((hdr = pjsip_endpt_get_capability(endpt, PJSIP_H_SUPPORTED, NULL))) {
239                 pjsip_msg_add_hdr(tdata->msg, (pjsip_hdr*)pjsip_hdr_clone(tdata->pool, hdr));
240         }
241
242         /*
243          * XXX TODO: pjsip doesn't care a lot about either of these headers -
244          * while it provides specific methods to create them, they are defined
245          * to be the standard string header creation. We never did add them
246          * in chan_sip, although RFC 3261 says they SHOULD. Hard coded here.
247          */
248         ast_sip_add_header(tdata, "Accept-Encoding", DEFAULT_ENCODING);
249         ast_sip_add_header(tdata, "Accept-Language", DEFAULT_LANGUAGE);
250
251         if (dlg && trans) {
252                 status = pjsip_dlg_send_response(dlg, trans, tdata);
253         } else {
254                 struct ast_sip_endpoint *endpoint;
255
256                 endpoint = ast_pjsip_rdata_get_endpoint(rdata);
257                 status = ast_sip_send_stateful_response(rdata, tdata, endpoint);
258                 ao2_cleanup(endpoint);
259         }
260
261         if (status != PJ_SUCCESS) {
262                 ast_log(LOG_ERROR, "Unable to send response (%d)\n", status);
263         }
264
265         return status;
266 }
267
268 static pj_bool_t options_on_rx_request(pjsip_rx_data *rdata)
269 {
270         RAII_VAR(struct ast_sip_endpoint *, endpoint, NULL, ao2_cleanup);
271         pjsip_uri *ruri;
272         pjsip_sip_uri *sip_ruri;
273         char exten[AST_MAX_EXTENSION];
274
275         if (pjsip_method_cmp(&rdata->msg_info.msg->line.req.method, &pjsip_options_method)) {
276                 return PJ_FALSE;
277         }
278
279         if (!(endpoint = ast_pjsip_rdata_get_endpoint(rdata))) {
280                 return PJ_FALSE;
281         }
282
283         ruri = rdata->msg_info.msg->line.req.uri;
284         if (!PJSIP_URI_SCHEME_IS_SIP(ruri) && !PJSIP_URI_SCHEME_IS_SIPS(ruri)) {
285                 send_options_response(rdata, 416);
286                 return PJ_TRUE;
287         }
288
289         sip_ruri = pjsip_uri_get_uri(ruri);
290         ast_copy_pj_str(exten, &sip_ruri->user, sizeof(exten));
291
292         /*
293          * We may want to match in the dialplan without any user
294          * options getting in the way.
295          */
296         AST_SIP_USER_OPTIONS_TRUNCATE_CHECK(exten);
297
298         if (ast_shutting_down()) {
299                 /*
300                  * Not taking any new calls at this time.
301                  * Likely a server availability OPTIONS poll.
302                  */
303                 send_options_response(rdata, 503);
304         } else if (!ast_strlen_zero(exten)
305                 && !ast_exists_extension(NULL, endpoint->context, exten, 1, NULL)) {
306                 send_options_response(rdata, 404);
307         } else {
308                 send_options_response(rdata, 200);
309         }
310         return PJ_TRUE;
311 }
312
313 static pjsip_module options_module = {
314         .name = {"Options Module", 14},
315         .id = -1,
316         .priority = PJSIP_MOD_PRIORITY_APPLICATION,
317         .on_rx_request = options_on_rx_request,
318 };
319
320 static const char *status_map[] = {
321         [UNAVAILABLE] = "Unreachable",
322         [AVAILABLE] = "Reachable",
323         [UNKNOWN] = "Unknown",
324         [CREATED] = "NonQualified",
325         [REMOVED] = "Removed",
326 };
327
328 static const char *short_status_map[] = {
329         [UNAVAILABLE] = "Unavail",
330         [AVAILABLE] = "Avail",
331         [UNKNOWN] = "Unknown",
332         [CREATED] = "NonQual",
333         [REMOVED] = "Removed",
334 };
335
336 const char *ast_sip_get_contact_status_label(const enum ast_sip_contact_status_type status)
337 {
338         ast_assert(0 <= status && status < ARRAY_LEN(status_map));
339         return status_map[status];
340 }
341
342 const char *ast_sip_get_contact_short_status_label(const enum ast_sip_contact_status_type status)
343 {
344         ast_assert(0 <= status && status < ARRAY_LEN(short_status_map));
345         return short_status_map[status];
346 }
347
348 /*! \brief Destructor for contact statuses */
349 static void sip_contact_status_dtor(void *obj)
350 {
351         struct ast_sip_contact_status *contact_status = obj;
352
353         ast_string_field_free_memory(contact_status);
354 }
355
356 static struct ast_sip_contact_status *sip_contact_status_alloc(const char *name)
357 {
358         struct ast_sip_contact_status *contact_status;
359         size_t size = sizeof(*contact_status) + strlen(name) + 1;
360
361         contact_status = ao2_alloc_options(size, sip_contact_status_dtor,
362                 AO2_ALLOC_OPT_LOCK_NOLOCK);
363         if (!contact_status) {
364                 return NULL;
365         }
366         if (ast_string_field_init(contact_status, 256)) {
367                 ao2_ref(contact_status, -1);
368                 return NULL;
369         }
370         strcpy(contact_status->name, name); /* SAFE */
371         return contact_status;
372 }
373
374 static struct ast_sip_contact_status *sip_contact_status_copy(const struct ast_sip_contact_status *src)
375 {
376         struct ast_sip_contact_status *dst;
377
378         dst = sip_contact_status_alloc(src->name);
379         if (!dst) {
380                 return NULL;
381         }
382
383         if (ast_string_fields_copy(dst, src)) {
384                 ao2_ref(dst, -1);
385                 return NULL;
386         }
387         dst->rtt = src->rtt;
388         dst->status = src->status;
389         dst->last_status = src->last_status;
390         return dst;
391 }
392
393 /*! \brief Hashing function for contact statuses */
394 AO2_STRING_FIELD_HASH_FN(ast_sip_contact_status, name);
395
396 /*! \brief Sort function for contact statuses */
397 AO2_STRING_FIELD_SORT_FN(ast_sip_contact_status, name);
398
399 /*! \brief Comparator function for contact statuses */
400 AO2_STRING_FIELD_CMP_FN(ast_sip_contact_status, name);
401
402 /*! \brief Helper function to allocate a contact statuses container */
403 static struct ao2_container *sip_options_contact_statuses_alloc(void)
404 {
405         /*
406          * Replace duplicate objects so we can update the immutable
407          * contact status objects by simply linking in a new object.
408          */
409         return ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_MUTEX,
410                 AO2_CONTAINER_ALLOC_OPT_DUPS_REPLACE, CONTACT_STATUS_BUCKETS,
411                 ast_sip_contact_status_hash_fn, ast_sip_contact_status_sort_fn,
412                 ast_sip_contact_status_cmp_fn);
413 }
414
415 /*! \brief Function which publishes a contact status update to all interested endpoints */
416 static void sip_options_publish_contact_state(const struct sip_options_aor *aor_options,
417         const struct ast_sip_contact_status *contact_status)
418 {
419         int i;
420
421         for (i = 0; i < AST_VECTOR_SIZE(&aor_options->compositors); ++i) {
422                 const struct sip_options_endpoint_state_compositor *endpoint_state_compositor;
423
424                 endpoint_state_compositor = AST_VECTOR_GET(&aor_options->compositors, i);
425                 ast_sip_persistent_endpoint_publish_contact_state(endpoint_state_compositor->name,
426                         contact_status);
427         }
428 }
429
430 /*!
431  * \brief Task to notify endpoints of a contact status change
432  * \note Run by management_serializer
433  */
434 static int contact_status_publish_update_task(void *obj)
435 {
436         struct ast_sip_contact_status *contact_status = obj;
437         struct sip_options_aor *aor_options;
438
439         aor_options = ao2_find(sip_options_aors, contact_status->aor, OBJ_SEARCH_KEY);
440         if (aor_options) {
441                 sip_options_publish_contact_state(aor_options, contact_status);
442                 ao2_ref(aor_options, -1);
443         }
444         ao2_ref(contact_status, -1);
445
446         return 0;
447 }
448
449 static void sip_options_contact_status_update(struct ast_sip_contact_status *contact_status)
450 {
451         struct ast_taskprocessor *mgmt_serializer = management_serializer;
452
453         if (mgmt_serializer) {
454                 ao2_ref(contact_status, +1);
455                 if (ast_sip_push_task(mgmt_serializer, contact_status_publish_update_task,
456                         contact_status)) {
457                         ao2_ref(contact_status, -1);
458                 }
459         }
460 }
461
462 struct ast_sip_contact_status *ast_res_pjsip_find_or_create_contact_status(const struct ast_sip_contact *contact)
463 {
464         struct ast_sip_contact_status *contact_status;
465         int res;
466
467         /*
468          * At startup a contact status can be retrieved when static contacts
469          * are themselves being setup.  This happens before we are fully setup.
470          * Since we don't actually trigger qualify or anything as a result it
471          * is safe to do so.  They'll just get back a contact status that will
472          * be updated later.  At this time they only care that the contact
473          * status gets created for the static contact anyway.
474          */
475         if (!sip_options_contact_statuses) {
476                 /*
477                  * We haven't been pre-initialized or we are shutting down.
478                  * Neither situation should happen.
479                  */
480                 ast_assert(0);
481                 return NULL;
482         }
483
484         ao2_lock(sip_options_contact_statuses);
485
486         /* If contact status for this contact already exists just return it */
487         contact_status = ao2_find(sip_options_contact_statuses,
488                 ast_sorcery_object_get_id(contact), OBJ_SEARCH_KEY | OBJ_NOLOCK);
489         if (contact_status) {
490                 ao2_unlock(sip_options_contact_statuses);
491                 return contact_status;
492         }
493
494         /* Otherwise we have to create and store a new contact status */
495         contact_status = sip_contact_status_alloc(ast_sorcery_object_get_id(contact));
496         if (!contact_status) {
497                 ao2_unlock(sip_options_contact_statuses);
498                 return NULL;
499         }
500
501         contact_status->rtt = 0;
502         contact_status->status = CREATED;
503         contact_status->last_status = CREATED;
504         res = ast_string_field_set(contact_status, uri, contact->uri);
505         res |= ast_string_field_set(contact_status, aor, contact->aor);
506         if (res) {
507                 ao2_unlock(sip_options_contact_statuses);
508                 ao2_ref(contact_status, -1);
509                 return NULL;
510         }
511
512         ao2_link_flags(sip_options_contact_statuses, contact_status, OBJ_NOLOCK);
513         ao2_unlock(sip_options_contact_statuses);
514
515         ast_statsd_log_string_va("PJSIP.contacts.states.%s", AST_STATSD_GAUGE,
516                 "+1", 1.0, ast_sip_get_contact_status_label(contact_status->status));
517
518         sip_options_contact_status_update(contact_status);
519
520         return contact_status;
521 }
522
523 struct ast_sip_contact_status *ast_sip_get_contact_status(const struct ast_sip_contact *contact)
524 {
525         return ao2_find(sip_options_contact_statuses, ast_sorcery_object_get_id(contact),
526                 OBJ_SEARCH_KEY);
527 }
528
529 /*! \brief Hashing function for OPTIONS AORs */
530 AO2_STRING_FIELD_HASH_FN(sip_options_aor, name);
531
532 /*! \brief Comparator function for SIP OPTIONS AORs */
533 AO2_STRING_FIELD_CMP_FN(sip_options_aor, name);
534
535 /*! \brief Hashing function for endpoint state compositors */
536 AO2_STRING_FIELD_HASH_FN(sip_options_endpoint_state_compositor, name);
537
538 /*! \brief Comparator function for endpoint state compositors */
539 AO2_STRING_FIELD_CMP_FN(sip_options_endpoint_state_compositor, name);
540
541 /*! \brief Structure used to contain information for an OPTIONS callback */
542 struct sip_options_contact_callback_data {
543         /*! \brief The contact we qualified */
544         struct ast_sip_contact *contact;
545         /*! \brief The AOR options */
546         struct sip_options_aor *aor_options;
547         /*! \brief The time at which this OPTIONS attempt was started */
548         struct timeval rtt_start;
549         /*! \brief The new status of the contact */
550         enum ast_sip_contact_status_type status;
551 };
552
553 /*!
554  * \brief Return the current state of an endpoint state compositor
555  * \pre The endpoint_state_compositor lock must be held.
556  */
557 static enum ast_endpoint_state sip_options_get_endpoint_state_compositor_state(
558         const struct sip_options_endpoint_state_compositor *endpoint_state_compositor)
559 {
560         struct ao2_iterator it_aor_statuses;
561         struct sip_options_endpoint_aor_status *aor_status;
562         enum ast_endpoint_state state = AST_ENDPOINT_OFFLINE;
563
564         it_aor_statuses = ao2_iterator_init(endpoint_state_compositor->aor_statuses, 0);
565         for (; (aor_status = ao2_iterator_next(&it_aor_statuses)); ao2_ref(aor_status, -1)) {
566                 if (aor_status->available) {
567                         state = AST_ENDPOINT_ONLINE;
568                         break;
569                 }
570         }
571         ao2_iterator_destroy(&it_aor_statuses);
572
573         return state;
574 }
575
576 /*!
577  * \brief Update the AOR status on an endpoint state compositor
578  * \pre The endpoint_state_compositor lock must be held.
579  */
580 static void sip_options_update_endpoint_state_compositor_aor(struct sip_options_endpoint_state_compositor *endpoint_state_compositor,
581         const char *name, enum ast_sip_contact_status_type status)
582 {
583         struct sip_options_endpoint_aor_status *aor_status;
584         enum ast_endpoint_state endpoint_state;
585
586         aor_status = ao2_find(endpoint_state_compositor->aor_statuses, name,
587                 OBJ_SEARCH_KEY | OBJ_NOLOCK);
588         if (!aor_status) {
589                 /* The AOR status doesn't exist already so we don't need to go any further */
590                 if (status == REMOVED) {
591                         return;
592                 }
593
594                 aor_status = ao2_alloc_options(sizeof(*aor_status) + strlen(name) + 1, NULL,
595                         AO2_ALLOC_OPT_LOCK_NOLOCK);
596                 if (!aor_status) {
597                         return;
598                 }
599
600                 strcpy(aor_status->name, name); /* SAFE */
601                 ao2_link(endpoint_state_compositor->aor_statuses, aor_status);
602         }
603
604         if (status == REMOVED) {
605                 /*
606                  * If the AOR is being removed then remove its AOR status
607                  * from the endpoint compositor.
608                  */
609                 ao2_unlink(endpoint_state_compositor->aor_statuses, aor_status);
610         } else {
611                 aor_status->available = (status == AVAILABLE ? 1 : 0);
612         }
613         ao2_ref(aor_status, -1);
614
615         if (!endpoint_state_compositor->active) {
616                 return;
617         }
618
619         /* If this AOR is available then the endpoint itself has to be online */
620         if (status == AVAILABLE) {
621                 ast_debug(3, "Endpoint state compositor '%s' is online as AOR '%s' is available\n",
622                         endpoint_state_compositor->name, name);
623                 endpoint_state = AST_ENDPOINT_ONLINE;
624         } else {
625                 endpoint_state =
626                         sip_options_get_endpoint_state_compositor_state(endpoint_state_compositor);
627         }
628
629         ast_sip_persistent_endpoint_update_state(endpoint_state_compositor->name,
630                 endpoint_state);
631 }
632
633 /*! \brief Function which notifies endpoint state compositors of a state change of an AOR */
634 static void sip_options_notify_endpoint_state_compositors(struct sip_options_aor *aor_options,
635         enum ast_sip_contact_status_type status)
636 {
637         int i;
638
639         /* Iterate through the associated endpoint state compositors updating them */
640         for (i = 0; i < AST_VECTOR_SIZE(&aor_options->compositors); ++i) {
641                 struct sip_options_endpoint_state_compositor *endpoint_state_compositor;
642
643                 endpoint_state_compositor = AST_VECTOR_GET(&aor_options->compositors, i);
644
645                 ao2_lock(endpoint_state_compositor);
646                 sip_options_update_endpoint_state_compositor_aor(endpoint_state_compositor,
647                         aor_options->name, status);
648                 ao2_unlock(endpoint_state_compositor);
649         }
650
651         if (status == REMOVED) {
652                 AST_VECTOR_RESET(&aor_options->compositors, ao2_cleanup);
653         }
654 }
655
656 /*!
657  * \brief Task to notify an AOR of a contact status change
658  * \note Run by aor_options->serializer
659  */
660 static int sip_options_contact_status_notify_task(void *obj)
661 {
662         struct sip_options_contact_callback_data *contact_callback_data = obj;
663         struct ast_sip_contact *contact;
664         struct ast_sip_contact_status *cs_old;
665         struct ast_sip_contact_status *cs_new;
666
667         /*
668          * Determine if this is a late arriving notification, as it is
669          * possible that we get a callback from PJSIP giving us contact
670          * status but in the mean time said contact has been removed
671          * from the controlling AOR.
672          */
673
674         if (!contact_callback_data->aor_options->qualify_frequency) {
675                 /* Contact qualify response is late */
676                 ao2_ref(contact_callback_data, -1);
677                 return 0;
678         }
679
680         contact = ao2_find(contact_callback_data->aor_options->contacts,
681                 contact_callback_data->contact, OBJ_SEARCH_OBJECT);
682         if (!contact) {
683                 /* Contact qualify response is late */
684                 ao2_ref(contact_callback_data, -1);
685                 return 0;
686         }
687         ao2_ref(contact, -1);
688
689         cs_old = ao2_find(sip_options_contact_statuses,
690                 ast_sorcery_object_get_id(contact_callback_data->contact), OBJ_SEARCH_KEY);
691         if (!cs_old) {
692                 /* Contact qualify response is late */
693                 ao2_ref(contact_callback_data, -1);
694                 return 0;
695         }
696
697         /* Update the contact specific status information */
698         cs_new = sip_contact_status_copy(cs_old);
699         ao2_ref(cs_old, -1);
700         if (!cs_new) {
701                 ao2_ref(contact_callback_data, -1);
702                 return 0;
703         }
704         cs_new->last_status = cs_new->status;
705         cs_new->status = contact_callback_data->status;
706         cs_new->rtt =
707                 cs_new->status == AVAILABLE
708                         ? ast_tvdiff_us(ast_tvnow(), contact_callback_data->rtt_start)
709                         : 0;
710         ao2_link(sip_options_contact_statuses, cs_new);
711
712         /*
713          * If the status has changed then notify the endpoint state compositors
714          * and publish our events.
715          */
716         if (cs_new->last_status != cs_new->status) {
717                 if (cs_new->status == AVAILABLE) {
718                         /* If this is the first available contact then the AOR has become available */
719                         ++contact_callback_data->aor_options->available;
720                         if (contact_callback_data->aor_options->available == 1) {
721                                 sip_options_notify_endpoint_state_compositors(
722                                         contact_callback_data->aor_options, AVAILABLE);
723                         }
724                 } else if (cs_new->last_status == AVAILABLE) {
725                         ast_assert(cs_new->status == UNAVAILABLE);
726
727                         /* If there are no more available contacts then this AOR is unavailable */
728                         --contact_callback_data->aor_options->available;
729                         if (!contact_callback_data->aor_options->available) {
730                                 sip_options_notify_endpoint_state_compositors(
731                                         contact_callback_data->aor_options, UNAVAILABLE);
732                         }
733                 }
734
735                 ast_verb(3, "Contact %s/%s is now %s.  RTT: %.3f msec\n",
736                         cs_new->aor,
737                         cs_new->uri,
738                         ast_sip_get_contact_status_label(cs_new->status),
739                         cs_new->rtt / 1000.0);
740
741                 ast_statsd_log_string_va("PJSIP.contacts.states.%s", AST_STATSD_GAUGE,
742                         "-1", 1.0, ast_sip_get_contact_status_label(cs_new->last_status));
743                 ast_statsd_log_string_va("PJSIP.contacts.states.%s", AST_STATSD_GAUGE,
744                         "+1", 1.0, ast_sip_get_contact_status_label(cs_new->status));
745
746                 sip_options_contact_status_update(cs_new);
747
748                 ast_test_suite_event_notify("AOR_CONTACT_UPDATE",
749                         "Contact: %s\r\n"
750                         "Status: %s",
751                         cs_new->name,
752                         ast_sip_get_contact_status_label(cs_new->status));
753         } else {
754                 ast_debug(3, "Contact %s/%s status didn't change: %s, RTT: %.3f msec\n",
755                         cs_new->aor,
756                         cs_new->uri,
757                         ast_sip_get_contact_status_label(cs_new->status),
758                         cs_new->rtt / 1000.0);
759         }
760
761         ast_statsd_log_full_va("PJSIP.contacts.%s.rtt", AST_STATSD_TIMER,
762                 cs_new->status != AVAILABLE ? -1 : cs_new->rtt / 1000,
763                 1.0,
764                 cs_new->name);
765
766         ast_test_suite_event_notify("AOR_CONTACT_QUALIFY_RESULT",
767                 "Contact: %s\r\n"
768                 "Status: %s\r\n"
769                 "RTT: %" PRId64,
770                 cs_new->name,
771                 ast_sip_get_contact_status_label(cs_new->status),
772                 cs_new->rtt);
773
774         ast_debug(3, "AOR '%s' now has %d available contacts\n",
775                 contact_callback_data->aor_options->name,
776                 contact_callback_data->aor_options->available);
777
778         ao2_ref(cs_new, -1);
779         ao2_ref(contact_callback_data, -1);
780
781         return 0;
782 }
783
784 /*! \brief Callback for when we get a result from a SIP OPTIONS request (a response or a timeout) */
785 static void qualify_contact_cb(void *token, pjsip_event *e)
786 {
787         struct sip_options_contact_callback_data *contact_callback_data = token;
788         enum ast_sip_contact_status_type status;
789
790         switch(e->body.tsx_state.type) {
791         default:
792                 ast_log(LOG_ERROR, "Unexpected PJSIP event %u\n", e->body.tsx_state.type);
793                 /* Fall through */
794         case PJSIP_EVENT_TRANSPORT_ERROR:
795         case PJSIP_EVENT_TIMER:
796                 status = UNAVAILABLE;
797                 break;
798         case PJSIP_EVENT_RX_MSG:
799                 status = AVAILABLE;
800                 break;
801         }
802
803         /* Update the callback data with the new status, this will get handled in the AOR serializer */
804         contact_callback_data->status = status;
805
806         if (ast_sip_push_task(contact_callback_data->aor_options->serializer,
807                 sip_options_contact_status_notify_task, contact_callback_data)) {
808                 ast_log(LOG_NOTICE, "Unable to queue contact status update for '%s' on AOR '%s', state will be incorrect\n",
809                         ast_sorcery_object_get_id(contact_callback_data->contact),
810                         contact_callback_data->aor_options->name);
811                 ao2_ref(contact_callback_data, -1);
812         }
813
814         /* The task inherited our reference so we don't unreference here */
815 }
816
817 /*! \brief Destructor for contact callback data */
818 static void sip_options_contact_callback_data_dtor(void *obj)
819 {
820         struct sip_options_contact_callback_data *contact_callback_data = obj;
821
822         ao2_cleanup(contact_callback_data->contact);
823         ao2_cleanup(contact_callback_data->aor_options);
824 }
825
826 /*! \brief Contact callback data allocator */
827 static struct sip_options_contact_callback_data *sip_options_contact_callback_data_alloc(
828         struct ast_sip_contact *contact, struct sip_options_aor *aor_options)
829 {
830         struct sip_options_contact_callback_data *contact_callback_data;
831
832         contact_callback_data = ao2_alloc_options(sizeof(*contact_callback_data),
833                 sip_options_contact_callback_data_dtor, AO2_ALLOC_OPT_LOCK_NOLOCK);
834         if (!contact_callback_data) {
835                 return NULL;
836         }
837
838         contact_callback_data->contact = ao2_bump(contact);
839         contact_callback_data->aor_options = ao2_bump(aor_options);
840         contact_callback_data->rtt_start = ast_tvnow();
841
842         return contact_callback_data;
843 }
844
845 /*! \brief Send a SIP OPTIONS request for a contact */
846 static int sip_options_qualify_contact(void *obj, void *arg, int flags)
847 {
848         struct ast_sip_contact *contact = obj;
849         struct sip_options_aor *aor_options = arg;
850         RAII_VAR(struct ast_sip_endpoint *, endpoint, NULL, ao2_cleanup);
851         pjsip_tx_data *tdata;
852         struct ast_sip_contact_status *contact_status;
853         struct sip_options_contact_callback_data *contact_callback_data;
854
855         ast_debug(3, "Qualifying contact '%s' on AOR '%s'\n",
856                 ast_sorcery_object_get_id(contact), aor_options->name);
857
858         if (!ast_strlen_zero(contact->endpoint_name)) {
859                 endpoint = ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "endpoint",
860                         contact->endpoint_name);
861         }
862         if (!endpoint && AST_VECTOR_SIZE(&aor_options->compositors)) {
863                 struct sip_options_endpoint_state_compositor *endpoint_state_compositor;
864
865                 endpoint_state_compositor = AST_VECTOR_GET(&aor_options->compositors, 0);
866                 endpoint = ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "endpoint",
867                         endpoint_state_compositor->name);
868         }
869         if (!endpoint) {
870                 ast_debug(3, "Could not find an endpoint to qualify contact '%s' on AOR '%s'\n",
871                         ast_sorcery_object_get_id(contact), aor_options->name);
872                 return 0;
873         }
874
875         if (ast_sip_create_request("OPTIONS", NULL, endpoint, NULL, contact, &tdata)) {
876                 ast_log(LOG_ERROR, "Unable to create request to qualify contact %s on AOR %s\n",
877                         contact->uri, aor_options->name);
878                 return 0;
879         }
880
881         /* If an outbound proxy is specified set it on this request */
882         if (!ast_strlen_zero(contact->outbound_proxy) &&
883                 ast_sip_set_outbound_proxy(tdata, contact->outbound_proxy)) {
884                 ast_log(LOG_ERROR, "Unable to apply outbound proxy on request to qualify contact %s\n",
885                         contact->uri);
886                 pjsip_tx_data_dec_ref(tdata);
887                 return 0;
888         }
889
890         contact_status = ast_res_pjsip_find_or_create_contact_status(contact);
891         if (!contact_status) {
892                 ast_log(LOG_ERROR, "Unable to retrieve contact status information for contact %s on AOR %s\n",
893                         contact->uri, aor_options->name);
894                 pjsip_tx_data_dec_ref(tdata);
895                 return 0;
896         }
897         ao2_ref(contact_status, -1);
898
899         contact_callback_data = sip_options_contact_callback_data_alloc(contact, aor_options);
900         if (!contact_callback_data) {
901                 ast_log(LOG_ERROR, "Unable to create object to contain callback data for contact %s on AOR %s\n",
902                         contact->uri, aor_options->name);
903                 pjsip_tx_data_dec_ref(tdata);
904                 return 0;
905         }
906
907         if (ast_sip_send_out_of_dialog_request(tdata, endpoint,
908                 (int)(aor_options->qualify_timeout * 1000), contact_callback_data,
909                 qualify_contact_cb)) {
910                 ast_log(LOG_ERROR, "Unable to send request to qualify contact %s on AOR %s\n",
911                         contact->uri, aor_options->name);
912                 ao2_ref(contact_callback_data, -1);
913         }
914
915         return 0;
916 }
917
918 /*!
919  * \brief Task to qualify contacts of an AOR
920  * \note Run by aor_options->serializer
921  */
922 static int sip_options_qualify_aor(void *obj)
923 {
924         struct sip_options_aor *aor_options = obj;
925
926         ast_debug(3, "Qualifying all contacts on AOR '%s'\n", aor_options->name);
927
928         /* Attempt to send an OPTIONS request to every contact on this AOR */
929         ao2_callback(aor_options->contacts, OBJ_NODATA, sip_options_qualify_contact,
930                 (struct sip_options_aor *) aor_options);
931
932         /* Always reschedule to the frequency we should go */
933         return aor_options->qualify_frequency * 1000;
934 }
935
936 /*! \brief Forward declaration of this helpful function */
937 static int sip_options_remove_contact(void *obj, void *arg, int flags);
938
939 /*! \brief Destructor function for SIP OPTIONS AORs */
940 static void sip_options_aor_dtor(void *obj)
941 {
942         struct sip_options_aor *aor_options = obj;
943
944         /*
945          * Any contacts are unreachable since the AOR is being destroyed
946          * so remove their contact status
947          */
948         if (aor_options->contacts) {
949                 ao2_callback(aor_options->contacts, OBJ_NODATA | OBJ_UNLINK,
950                         sip_options_remove_contact, aor_options);
951                 ao2_ref(aor_options->contacts, -1);
952         }
953         ao2_cleanup(aor_options->dynamic_contacts);
954
955         ast_taskprocessor_unreference(aor_options->serializer);
956
957         ast_assert(AST_VECTOR_SIZE(&aor_options->compositors) == 0);
958         AST_VECTOR_FREE(&aor_options->compositors);
959 }
960
961 /*! \brief Allocator for AOR OPTIONS */
962 static struct sip_options_aor *sip_options_aor_alloc(struct ast_sip_aor *aor)
963 {
964         struct sip_options_aor *aor_options;
965         char tps_name[AST_TASKPROCESSOR_MAX_NAME + 1];
966
967         aor_options = ao2_alloc_options(sizeof(*aor_options) + strlen(ast_sorcery_object_get_id(aor)) + 1,
968                 sip_options_aor_dtor, AO2_ALLOC_OPT_LOCK_NOLOCK);
969         if (!aor_options) {
970                 return NULL;
971         }
972
973         strcpy(aor_options->name, ast_sorcery_object_get_id(aor)); /* SAFE */
974
975         ast_taskprocessor_build_name(tps_name, sizeof(tps_name), "pjsip/options/%s",
976                 ast_sorcery_object_get_id(aor));
977         aor_options->serializer = ast_sip_create_serializer_group(tps_name,
978                 shutdown_group);
979         if (!aor_options->serializer) {
980                 ao2_ref(aor_options, -1);
981                 return NULL;
982         }
983
984         if (AST_VECTOR_INIT(&aor_options->compositors, ENDPOINT_STATE_COMPOSITOR_INITIAL_SIZE)) {
985                 ao2_ref(aor_options, -1);
986                 return NULL;
987         }
988
989         aor_options->contacts = ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_NOLOCK,
990                 AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT, CONTACT_BUCKETS, ast_sorcery_object_id_hash,
991                 ast_sorcery_object_id_sort, ast_sorcery_object_id_compare);
992         if (!aor_options->contacts) {
993                 ao2_ref(aor_options, -1);
994                 return NULL;
995         }
996
997         aor_options->dynamic_contacts = ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_NOLOCK,
998                 AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT, CONTACT_BUCKETS, ast_sorcery_object_id_hash,
999                 ast_sorcery_object_id_sort, ast_sorcery_object_id_compare);
1000         if (!aor_options->dynamic_contacts) {
1001                 ao2_ref(aor_options, -1);
1002                 return NULL;
1003         }
1004
1005         return aor_options;
1006 }
1007
1008 /*! \brief Remove contact status for a hint */
1009 static void sip_options_remove_contact_status(struct sip_options_aor *aor_options,
1010         struct ast_sip_contact *contact)
1011 {
1012         struct ast_sip_contact_status *cs_new;
1013         struct ast_sip_contact_status *cs_old;
1014
1015         cs_old = ao2_find(sip_options_contact_statuses, ast_sorcery_object_get_id(contact),
1016                 OBJ_SEARCH_KEY | OBJ_UNLINK);
1017         if (!cs_old) {
1018                 ast_debug(3, "Attempted to remove contact status for '%s' but it does not exist\n",
1019                         ast_sorcery_object_get_id(contact));
1020                 return;
1021         }
1022
1023         ast_verb(2, "Contact %s/%s has been deleted\n", contact->aor, contact->uri);
1024
1025         /* Update the contact status to reflect its new state */
1026         cs_new = sip_contact_status_copy(cs_old);
1027         if (!cs_new) {
1028                 /*
1029                  * We'll have to violate the immutable property because we
1030                  * couldn't create a new one to modify and we are deleting
1031                  * the contact status anyway.
1032                  */
1033                 cs_new = cs_old;
1034         } else {
1035                 ao2_ref(cs_old, -1);
1036         }
1037         cs_new->last_status = cs_new->status;
1038         cs_new->status = REMOVED;
1039         cs_new->rtt = 0;
1040
1041         ast_statsd_log_string_va("PJSIP.contacts.states.%s", AST_STATSD_GAUGE,
1042                 "-1", 1.0, ast_sip_get_contact_status_label(cs_new->last_status));
1043         ast_statsd_log_string_va("PJSIP.contacts.states.%s", AST_STATSD_GAUGE,
1044                 "+1", 1.0, ast_sip_get_contact_status_label(cs_new->status));
1045
1046         sip_options_contact_status_update(cs_new);
1047
1048         /*
1049          * The only time we need to update the AOR is if this contact was
1050          * available and qualify is in use, otherwise we can just stop
1051          * early.
1052          */
1053         if (!aor_options->qualify_frequency || cs_new->last_status != AVAILABLE) {
1054                 ao2_ref(cs_new, -1);
1055                 return;
1056         }
1057
1058         --aor_options->available;
1059         if (!aor_options->available) {
1060                 sip_options_notify_endpoint_state_compositors(aor_options, UNAVAILABLE);
1061         }
1062
1063         ast_debug(3, "AOR '%s' now has %d available contacts\n", aor_options->name,
1064                 aor_options->available);
1065
1066         ao2_ref(cs_new, -1);
1067 }
1068
1069 /*! \brief Task data for AOR creation or updating */
1070 struct sip_options_synchronize_aor_task_data {
1071         /*! \brief The AOR options for this AOR */
1072         struct sip_options_aor *aor_options;
1073         /*! \brief The AOR which contains the new configuraton */
1074         struct ast_sip_aor *aor;
1075         /*! \brief Optional container of existing AOR s*/
1076         struct ao2_container *existing;
1077         /*! \brief Whether this AOR is being added */
1078         int added;
1079 };
1080
1081 /*! \brief Callback function to remove a contact and its contact status from an AOR */
1082 static int sip_options_remove_contact(void *obj, void *arg, int flags)
1083 {
1084         struct ast_sip_contact *contact = obj;
1085         struct sip_options_aor *aor_options = arg;
1086
1087         sip_options_remove_contact_status(aor_options, contact);
1088
1089         return CMP_MATCH;
1090 }
1091
1092 /*! \brief Determine an initial time for scheduling AOR qualifying */
1093 static int sip_options_determine_initial_qualify_time(int qualify_frequency)
1094 {
1095         int initial_interval;
1096         int max_time = ast_sip_get_max_initial_qualify_time();
1097
1098         if (max_time && max_time < qualify_frequency) {
1099                 initial_interval = max_time;
1100         } else {
1101                 initial_interval = qualify_frequency;
1102         }
1103
1104         initial_interval = (int)((initial_interval * 1000) * ast_random_double());
1105         return 0 < initial_interval ? initial_interval : 1;
1106 }
1107
1108 /*! \brief Set the contact status for a contact */
1109 static void sip_options_set_contact_status(struct ast_sip_contact_status *contact_status,
1110         enum ast_sip_contact_status_type status)
1111 {
1112         struct ast_sip_contact_status *cs_new;
1113
1114         /* Update the contact specific status information */
1115         cs_new = sip_contact_status_copy(contact_status);
1116         if (!cs_new) {
1117                 return;
1118         }
1119         cs_new->last_status = cs_new->status;
1120         cs_new->status = status;
1121
1122         /*
1123          * We need to always set the RTT to zero because we haven't completed
1124          * an OPTIONS ping so RTT is unknown.  If the OPTIONS ping were still
1125          * running it will be refreshed on the next go round anyway.
1126          */
1127         cs_new->rtt = 0;
1128
1129         ao2_link(sip_options_contact_statuses, cs_new);
1130
1131         if (cs_new->status != cs_new->last_status) {
1132                 ast_verb(3, "Contact %s/%s is now %s.\n",
1133                         cs_new->aor, cs_new->uri,
1134                         ast_sip_get_contact_status_label(cs_new->status));
1135
1136                 ast_statsd_log_string_va("PJSIP.contacts.states.%s", AST_STATSD_GAUGE,
1137                         "-1", 1.0, ast_sip_get_contact_status_label(cs_new->last_status));
1138                 ast_statsd_log_string_va("PJSIP.contacts.states.%s", AST_STATSD_GAUGE,
1139                         "+1", 1.0, ast_sip_get_contact_status_label(cs_new->status));
1140
1141                 sip_options_contact_status_update(cs_new);
1142
1143                 ast_test_suite_event_notify("AOR_CONTACT_UPDATE",
1144                         "Contact: %s\r\n"
1145                         "Status: %s",
1146                         cs_new->name,
1147                         ast_sip_get_contact_status_label(cs_new->status));
1148         }
1149         ao2_ref(cs_new, -1);
1150 }
1151
1152 /*! \brief Transition the contact status to unqualified mode */
1153 static int sip_options_set_contact_status_unqualified(void *obj, void *arg, int flags)
1154 {
1155         struct ast_sip_contact *contact = obj;
1156         struct ast_sip_contact_status *contact_status;
1157
1158         contact_status = ast_res_pjsip_find_or_create_contact_status(contact);
1159         if (!contact_status) {
1160                 return 0;
1161         }
1162
1163         switch (contact_status->status) {
1164         case AVAILABLE:
1165         case UNAVAILABLE:
1166         case UNKNOWN:
1167                 sip_options_set_contact_status(contact_status, CREATED);
1168                 break;
1169         case CREATED:
1170         case REMOVED:
1171                 break;
1172         }
1173
1174         ao2_ref(contact_status, -1);
1175
1176         return 0;
1177 }
1178
1179 /*! \brief Transition the contact status to qualified mode */
1180 static int sip_options_set_contact_status_qualified(void *obj, void *arg, int flags)
1181 {
1182         struct ast_sip_contact *contact = obj;
1183         struct ast_sip_contact_status *contact_status;
1184
1185         contact_status = ast_res_pjsip_find_or_create_contact_status(contact);
1186         if (!contact_status) {
1187                 return 0;
1188         }
1189
1190         switch (contact_status->status) {
1191         case AVAILABLE:
1192                 sip_options_set_contact_status(contact_status, UNAVAILABLE);
1193                 break;
1194         case UNAVAILABLE:
1195         case UNKNOWN:
1196         case CREATED:
1197         case REMOVED:
1198                 break;
1199         }
1200
1201         ao2_ref(contact_status, -1);
1202
1203         return 0;
1204 }
1205
1206 /*! \brief Count AVAILABLE qualified contacts. */
1207 static int sip_options_contact_status_available_count(void *obj, void *arg, int flags)
1208 {
1209         struct ast_sip_contact *contact = obj;
1210         unsigned int *available = arg;
1211         struct ast_sip_contact_status *contact_status;
1212
1213         contact_status = ast_res_pjsip_find_or_create_contact_status(contact);
1214         if (!contact_status) {
1215                 return 0;
1216         }
1217
1218         /* Count qualified available contacts. */
1219         switch (contact_status->status) {
1220         case AVAILABLE:
1221                 ++*available;
1222                 break;
1223         case UNAVAILABLE:
1224         case UNKNOWN:
1225         case CREATED:
1226         case REMOVED:
1227                 break;
1228         }
1229
1230         ao2_ref(contact_status, -1);
1231
1232         return 0;
1233 }
1234
1235 /*!
1236  * \brief Function which applies configuration to an AOR options structure
1237  * \note Run by aor_options->serializer (or management_serializer on aor_options creation)
1238  */
1239 static void sip_options_apply_aor_configuration(struct sip_options_aor *aor_options,
1240         struct ast_sip_aor *aor, int is_new)
1241 {
1242         struct ao2_container *existing_contacts;
1243         struct ast_sip_contact *contact;
1244         struct ao2_iterator iter;
1245
1246         ast_debug(3, "Configuring AOR '%s' with current state of configuration and world\n",
1247                 aor_options->name);
1248
1249         /*
1250          * Permanent contacts, since we receive no notification that they
1251          * are gone, follow the same approach as AORs.  We create a copy
1252          * of the existing container and any reused contacts are removed
1253          * from it.  Any contacts remaining in the container after
1254          * processing no longer exist so we need to remove their state.
1255          */
1256         existing_contacts = ao2_container_clone(aor_options->contacts, 0);
1257         if (!existing_contacts) {
1258                 ast_log(LOG_WARNING, "Synchronization of AOR '%s' failed for qualify, retaining existing state\n",
1259                         aor_options->name);
1260                 return;
1261         }
1262
1263         ao2_callback(aor_options->contacts, OBJ_NODATA | OBJ_UNLINK | OBJ_MULTIPLE,
1264                 NULL, NULL);
1265
1266         /* Process permanent contacts */
1267         if (aor->permanent_contacts) {
1268                 iter = ao2_iterator_init(aor->permanent_contacts, 0);
1269                 for (; (contact = ao2_iterator_next(&iter)); ao2_ref(contact, -1)) {
1270                         ao2_find(existing_contacts, ast_sorcery_object_get_id(contact),
1271                                 OBJ_NODATA | OBJ_UNLINK | OBJ_SEARCH_KEY);
1272                         ao2_link(aor_options->contacts, contact);
1273                 }
1274                 ao2_iterator_destroy(&iter);
1275         }
1276
1277         /*
1278          * If this is newly added we need to see if there are any
1279          * existing dynamic contacts to add.  Ones that are added
1280          * after creation will occur as a result of the contact
1281          * observer creation callback.
1282          */
1283         if (is_new) {
1284                 size_t prefix_len = strlen(ast_sorcery_object_get_id(aor)) + sizeof(";@") - 1;
1285                 char prefix[prefix_len + 1];
1286                 struct ao2_container *contacts;
1287
1288                 sprintf(prefix, "%s;@", ast_sorcery_object_get_id(aor)); /* Safe */
1289                 contacts = ast_sorcery_retrieve_by_prefix(ast_sip_get_sorcery(), "contact",
1290                         prefix, prefix_len);
1291                 if (contacts) {
1292                         ao2_container_dup(aor_options->dynamic_contacts, contacts, 0);
1293                         ao2_ref(contacts, -1);
1294                 }
1295         }
1296
1297         /* Process dynamic contacts */
1298         iter = ao2_iterator_init(aor_options->dynamic_contacts, 0);
1299         for (; (contact = ao2_iterator_next(&iter)); ao2_ref(contact, -1)) {
1300                 ao2_find(existing_contacts, ast_sorcery_object_get_id(contact),
1301                         OBJ_NODATA | OBJ_UNLINK | OBJ_SEARCH_KEY);
1302                 ao2_link(aor_options->contacts, contact);
1303         }
1304         ao2_iterator_destroy(&iter);
1305
1306         /* Any contacts left no longer exist, so raise events and make them disappear */
1307         ao2_callback(existing_contacts, OBJ_NODATA | OBJ_UNLINK,
1308                 sip_options_remove_contact, aor_options);
1309         ao2_ref(existing_contacts, -1);
1310
1311         /*
1312          * Update the available count if we transition between qualified
1313          * and unqualified.  In the qualified case we need to start with
1314          * 0 available as the qualify process will take care of it.  In
1315          * the unqualified case it is based on the number of contacts
1316          * present.
1317          */
1318         if (!aor->qualify_frequency) {
1319                 ao2_callback(aor_options->contacts, OBJ_NODATA,
1320                         sip_options_set_contact_status_unqualified, NULL);
1321                 aor_options->available = ao2_container_count(aor_options->contacts);
1322                 ast_debug(3, "AOR '%s' is unqualified, number of available contacts is therefore '%d'\n",
1323                         aor_options->name, aor_options->available);
1324         } else if (!aor_options->qualify_frequency) {
1325                 ao2_callback(aor_options->contacts, OBJ_NODATA,
1326                         sip_options_set_contact_status_qualified, NULL);
1327                 aor_options->available = 0;
1328                 ast_debug(3, "AOR '%s' has transitioned from unqualified to qualified, reset available contacts to 0\n",
1329                         aor_options->name);
1330         } else {
1331                 /*
1332                 * Count the number of AVAILABLE qualified contacts to ensure
1333                 * the count is in sync with reality.
1334                 */
1335                 aor_options->available = 0;
1336                 ao2_callback(aor_options->contacts, OBJ_NODATA,
1337                         sip_options_contact_status_available_count, &aor_options->available);
1338         }
1339
1340         aor_options->authenticate_qualify = aor->authenticate_qualify;
1341         aor_options->qualify_timeout = aor->qualify_timeout;
1342
1343         /*
1344          * If we need to stop or start the scheduled callback then do so.
1345          * This occurs due to the following:
1346          * 1. The qualify frequency has changed
1347          * 2. Contacts were added when previously there were none
1348          * 3. There are no contacts but previously there were some
1349          */
1350         if (aor_options->qualify_frequency != aor->qualify_frequency
1351                 || (!aor_options->sched_task && ao2_container_count(aor_options->contacts))
1352                 || (aor_options->sched_task && !ao2_container_count(aor_options->contacts))) {
1353                 if (aor_options->sched_task) {
1354                         ast_sip_sched_task_cancel(aor_options->sched_task);
1355                         ao2_ref(aor_options->sched_task, -1);
1356                         aor_options->sched_task = NULL;
1357                 }
1358
1359                 /* If there is still a qualify frequency then schedule this */
1360                 aor_options->qualify_frequency = aor->qualify_frequency;
1361                 if (aor_options->qualify_frequency
1362                         && ao2_container_count(aor_options->contacts)) {
1363                         aor_options->sched_task = ast_sip_schedule_task(aor_options->serializer,
1364                                 sip_options_determine_initial_qualify_time(aor_options->qualify_frequency),
1365                                 sip_options_qualify_aor, ast_taskprocessor_name(aor_options->serializer),
1366                                 aor_options, AST_SIP_SCHED_TASK_VARIABLE | AST_SIP_SCHED_TASK_DATA_AO2);
1367                         if (!aor_options->sched_task) {
1368                                 ast_log(LOG_ERROR, "Unable to schedule qualify for contacts of AOR '%s'\n",
1369                                         aor_options->name);
1370                         }
1371                 }
1372         }
1373
1374         ast_debug(3, "AOR '%s' now has %d available contacts\n", aor_options->name,
1375                 aor_options->available);
1376 }
1377
1378 /*!
1379  * \brief Task to synchronize an AOR with our local state
1380  * \note Run by aor_options->serializer (or management_serializer on aor_options creation)
1381  */
1382 static int sip_options_synchronize_aor_task(void *obj)
1383 {
1384         struct sip_options_synchronize_aor_task_data *task_data = obj;
1385         int i;
1386
1387         ast_debug(3, "Synchronizing AOR '%s' with current state of configuration and world\n",
1388                 task_data->aor_options->name);
1389
1390         sip_options_apply_aor_configuration(task_data->aor_options, task_data->aor,
1391                 task_data->added);
1392
1393         /*
1394          * Endpoint state compositors are removed in this operation but not
1395          * added.  To reduce the amount of work done they are done later.  In
1396          * the mean time things can still qualify and once an endpoint state
1397          * compositor is added to the AOR it will be updated with the current
1398          * state.
1399          */
1400         for (i = 0; i < AST_VECTOR_SIZE(&task_data->aor_options->compositors); ++i) {
1401                 struct sip_options_endpoint_state_compositor *endpoint_state_compositor;
1402
1403                 endpoint_state_compositor = AST_VECTOR_GET(&task_data->aor_options->compositors, i);
1404
1405                 ao2_lock(endpoint_state_compositor);
1406                 endpoint_state_compositor->active = 0;
1407                 sip_options_update_endpoint_state_compositor_aor(endpoint_state_compositor,
1408                         task_data->aor_options->name, REMOVED);
1409                 ao2_unlock(endpoint_state_compositor);
1410         }
1411         AST_VECTOR_RESET(&task_data->aor_options->compositors, ao2_cleanup);
1412
1413         return 0;
1414 }
1415
1416 /*!
1417  * \brief Synchronize an AOR with our local state
1418  * \note Run by management_serializer
1419  */
1420 static int sip_options_synchronize_aor(void *obj, void *arg, int flags)
1421 {
1422         struct sip_options_synchronize_aor_task_data task_data = {
1423                 .aor = obj,
1424                 .existing = arg,
1425         };
1426
1427         task_data.aor_options = ao2_find(sip_options_aors,
1428                 ast_sorcery_object_get_id(task_data.aor), OBJ_SEARCH_KEY);
1429         if (!task_data.aor_options) {
1430                 task_data.aor_options = sip_options_aor_alloc(task_data.aor);
1431                 if (!task_data.aor_options) {
1432                         return 0;
1433                 }
1434
1435                 task_data.added = 1;
1436
1437                 /* Nothing is aware of this AOR yet so we can just update it in this thread */
1438                 sip_options_synchronize_aor_task(&task_data);
1439                 ao2_link(sip_options_aors, task_data.aor_options);
1440         } else {
1441                 /* This AOR already exists so we have to do manipulation in its serializer */
1442                 ast_sip_push_task_wait_serializer(task_data.aor_options->serializer,
1443                         sip_options_synchronize_aor_task, &task_data);
1444         }
1445
1446         ao2_ref(task_data.aor_options, -1);
1447
1448         if (task_data.existing) {
1449                 ao2_find(task_data.existing, ast_sorcery_object_get_id(task_data.aor),
1450                         OBJ_SEARCH_KEY | OBJ_UNLINK | OBJ_NODATA);
1451         }
1452
1453         return 0;
1454 }
1455
1456 /*! \brief Destructor for endpoint state compositors */
1457 static void sip_options_endpoint_state_compositor_dtor(void *obj)
1458 {
1459         struct sip_options_endpoint_state_compositor *endpoint_state_compositor = obj;
1460
1461         ao2_cleanup(endpoint_state_compositor->aor_statuses);
1462 }
1463
1464 /*! \brief Hashing function for endpoint AOR status */
1465 AO2_STRING_FIELD_HASH_FN(sip_options_endpoint_aor_status, name);
1466
1467 /*! \brief Comparator function for endpoint AOR status */
1468 AO2_STRING_FIELD_CMP_FN(sip_options_endpoint_aor_status, name);
1469
1470 /*! \brief Find (or create) an endpoint state compositor */
1471 static struct sip_options_endpoint_state_compositor *sip_options_endpoint_state_compositor_find_or_alloc(const struct ast_sip_endpoint *endpoint)
1472 {
1473         struct sip_options_endpoint_state_compositor *endpoint_state_compositor;
1474
1475         ao2_lock(sip_options_endpoint_state_compositors);
1476         endpoint_state_compositor = ao2_find(sip_options_endpoint_state_compositors,
1477                 ast_sorcery_object_get_id(endpoint), OBJ_SEARCH_KEY | OBJ_NOLOCK);
1478         if (endpoint_state_compositor) {
1479                 ao2_unlock(sip_options_endpoint_state_compositors);
1480                 return endpoint_state_compositor;
1481         }
1482
1483         endpoint_state_compositor = ao2_alloc(sizeof(*endpoint_state_compositor)
1484                 + strlen(ast_sorcery_object_get_id(endpoint)) + 1,
1485                 sip_options_endpoint_state_compositor_dtor);
1486         if (!endpoint_state_compositor) {
1487                 ao2_unlock(sip_options_endpoint_state_compositors);
1488                 return NULL;
1489         }
1490
1491         /*
1492          * NOTE: The endpoint_state_compositor->aor_statuses container is
1493          * externally protected by the endpoint_state_compositor lock.
1494          */
1495         endpoint_state_compositor->aor_statuses = ao2_container_alloc_hash(
1496                 AO2_ALLOC_OPT_LOCK_NOLOCK, 0, AOR_STATUS_BUCKETS,
1497                 sip_options_endpoint_aor_status_hash_fn, NULL,
1498                 sip_options_endpoint_aor_status_cmp_fn);
1499         if (!endpoint_state_compositor->aor_statuses) {
1500                 ao2_unlock(sip_options_endpoint_state_compositors);
1501                 ao2_ref(endpoint_state_compositor, -1);
1502                 return NULL;
1503         }
1504
1505         strcpy(endpoint_state_compositor->name, ast_sorcery_object_get_id(endpoint)); /* SAFE */
1506
1507         ao2_link_flags(sip_options_endpoint_state_compositors, endpoint_state_compositor,
1508                 OBJ_NOLOCK);
1509         ao2_unlock(sip_options_endpoint_state_compositors);
1510
1511         return endpoint_state_compositor;
1512 }
1513
1514 /*! \brief Task details for adding an AOR to an endpoint state compositor */
1515 struct sip_options_endpoint_compositor_task_data {
1516         /*! \brief The AOR options that the endpoint state compositor should be added to */
1517         struct sip_options_aor *aor_options;
1518         /*! \brief The endpoint state compositor */
1519         struct sip_options_endpoint_state_compositor *endpoint_state_compositor;
1520 };
1521
1522 /*!
1523  * \brief Task which adds an AOR to an endpoint state compositor
1524  * \note Run by aor_options->serializer
1525  */
1526 static int sip_options_endpoint_compositor_add_task(void *obj)
1527 {
1528         struct sip_options_endpoint_compositor_task_data *task_data = obj;
1529
1530         ast_debug(3, "Adding endpoint compositor '%s' to AOR '%s'\n",
1531                 task_data->endpoint_state_compositor->name, task_data->aor_options->name);
1532
1533         if (AST_VECTOR_APPEND(&task_data->aor_options->compositors,
1534                 ao2_bump(task_data->endpoint_state_compositor))) {
1535                 /* Failed to add so no need to update the endpoint status.  Nothing changed. */
1536                 ao2_cleanup(task_data->endpoint_state_compositor);
1537                 return 0;
1538         }
1539
1540         ao2_lock(task_data->endpoint_state_compositor);
1541         sip_options_update_endpoint_state_compositor_aor(task_data->endpoint_state_compositor,
1542                 task_data->aor_options->name,
1543                 task_data->aor_options->available ? AVAILABLE : UNAVAILABLE);
1544         ao2_unlock(task_data->endpoint_state_compositor);
1545
1546         return 0;
1547 }
1548
1549 /*!
1550  * \brief Task which adds removes an AOR from an endpoint state compositor
1551  * \note Run by aor_options->serializer
1552  */
1553 static int sip_options_endpoint_compositor_remove_task(void *obj)
1554 {
1555         struct sip_options_endpoint_compositor_task_data *task_data = obj;
1556         int i;
1557
1558         ast_debug(3, "Removing endpoint compositor '%s' from AOR '%s'\n",
1559                 task_data->endpoint_state_compositor->name,
1560                 task_data->aor_options->name);
1561
1562         for (i = 0; i < AST_VECTOR_SIZE(&task_data->aor_options->compositors); ++i) {
1563                 struct sip_options_endpoint_state_compositor *endpoint_state_compositor;
1564
1565                 endpoint_state_compositor = AST_VECTOR_GET(&task_data->aor_options->compositors, i);
1566                 if (endpoint_state_compositor != task_data->endpoint_state_compositor) {
1567                         continue;
1568                 }
1569
1570                 AST_VECTOR_REMOVE(&task_data->aor_options->compositors, i, 0);
1571                 ao2_ref(endpoint_state_compositor, -1);
1572                 break;
1573         }
1574
1575         return 0;
1576 }
1577
1578 /*!
1579  * \brief Synchronize an endpoint with our local state
1580  * \note Run by management_serializer
1581  */
1582 static int sip_options_synchronize_endpoint(void *obj, void *arg, int flags)
1583 {
1584         struct ast_sip_endpoint *endpoint = obj;
1585         struct ast_sip_aor *aor = arg;
1586         char *aors;
1587         char *aor_name;
1588         struct sip_options_endpoint_compositor_task_data task_data = { NULL, };
1589
1590         if (ast_strlen_zero(endpoint->aors)) {
1591                 /* There are no AORs, so really... who the heck knows */
1592                 ast_debug(3, "Endpoint '%s' is not interested in any AORs so not creating endpoint state compositor\n",
1593                         ast_sorcery_object_get_id(endpoint));
1594                 return 0;
1595         }
1596
1597         ast_debug(3, "Synchronizing endpoint '%s' with AORs '%s'\n",
1598                 ast_sorcery_object_get_id(endpoint), endpoint->aors);
1599
1600         aors = ast_strdupa(endpoint->aors);
1601         while ((aor_name = ast_strip(strsep(&aors, ",")))) {
1602                 if (ast_strlen_zero(aor_name)) {
1603                         continue;
1604                 }
1605                 if (aor && strcasecmp(ast_sorcery_object_get_id(aor), aor_name)) {
1606                         ast_debug(3, "Filtered AOR '%s' on endpoint '%s' as we are looking for '%s'\n",
1607                                 aor_name, ast_sorcery_object_get_id(endpoint),
1608                                 ast_sorcery_object_get_id(aor));
1609                         continue;
1610                 }
1611
1612                 task_data.aor_options = ao2_find(sip_options_aors, aor_name, OBJ_SEARCH_KEY);
1613                 if (!task_data.aor_options) {
1614                         /*
1615                          * They have referenced an invalid AOR. If that's all they've
1616                          * done we will set them to offline at the end.
1617                          */
1618                         ast_debug(3, "Endpoint '%s' referenced invalid AOR '%s'\n",
1619                                 ast_sorcery_object_get_id(endpoint), aor_name);
1620                         continue;
1621                 }
1622
1623                 if (!task_data.endpoint_state_compositor) {
1624                         /*
1625                          * We create an endpoint state compositor only after we know
1626                          * for sure we need it.
1627                          */
1628                         task_data.endpoint_state_compositor =
1629                                 sip_options_endpoint_state_compositor_find_or_alloc(endpoint);
1630                         if (!task_data.endpoint_state_compositor) {
1631                                 ast_log(LOG_WARNING,
1632                                         "Could not create endpoint state compositor for '%s', endpoint state will be incorrect\n",
1633                                         ast_sorcery_object_get_id(endpoint));
1634                                 ao2_ref(task_data.aor_options, -1);
1635                                 ast_sip_persistent_endpoint_update_state(ast_sorcery_object_get_id(endpoint),
1636                                         AST_ENDPOINT_OFFLINE);
1637                                 return 0;
1638                         }
1639                 }
1640
1641                 /* We use a synchronous task so that we don't flood the system */
1642                 ast_sip_push_task_wait_serializer(task_data.aor_options->serializer,
1643                         sip_options_endpoint_compositor_add_task, &task_data);
1644
1645                 ao2_ref(task_data.aor_options, -1);
1646
1647                 /*
1648                  * If we filtered on a specific AOR name then the endpoint can
1649                  * only reference it once so break early.
1650                  */
1651                 if (aor) {
1652                         break;
1653                 }
1654         }
1655
1656         if (task_data.endpoint_state_compositor) {
1657                 /*
1658                  * If an endpoint state compositor is present determine the current state
1659                  * of the endpoint and update it.
1660                  */
1661                 ao2_lock(task_data.endpoint_state_compositor);
1662                 task_data.endpoint_state_compositor->active = 1;
1663                 ast_sip_persistent_endpoint_update_state(ast_sorcery_object_get_id(endpoint),
1664                         sip_options_get_endpoint_state_compositor_state(task_data.endpoint_state_compositor));
1665                 ao2_unlock(task_data.endpoint_state_compositor);
1666
1667                 ao2_ref(task_data.endpoint_state_compositor, -1);
1668         } else {
1669                 /* If there is none then they may have referenced an invalid AOR or none at all */
1670                 ast_debug(3, "Endpoint '%s' has no AORs feeding it, setting it to offline state as default\n",
1671                         ast_sorcery_object_get_id(endpoint));
1672                 ast_sip_persistent_endpoint_update_state(ast_sorcery_object_get_id(endpoint),
1673                         AST_ENDPOINT_OFFLINE);
1674         }
1675
1676         return 0;
1677 }
1678
1679 /*!
1680  * \brief Task which removes an AOR from all of the ESCs it is reporting to
1681  * \note Run by aor_options->serializer
1682  */
1683 static int sip_options_aor_remove_task(void *obj)
1684 {
1685         struct sip_options_aor *aor_options = obj;
1686
1687         sip_options_notify_endpoint_state_compositors(aor_options, REMOVED);
1688
1689         if (aor_options->sched_task) {
1690                 ast_sip_sched_task_cancel(aor_options->sched_task);
1691                 ao2_ref(aor_options->sched_task, -1);
1692                 aor_options->sched_task = NULL;
1693         }
1694
1695         return 0;
1696 }
1697
1698 /*!
1699  * \brief Callback which removes any unused AORs that remained after reloading
1700  * \note Run by management_serializer
1701  */
1702 static int sip_options_unused_aor(void *obj, void *arg, int flags)
1703 {
1704         struct sip_options_aor *aor_options = obj;
1705
1706         ast_debug(3, "AOR '%s' is no longer configured, removing it\n", aor_options->name);
1707
1708         ast_sip_push_task_wait_serializer(aor_options->serializer, sip_options_aor_remove_task,
1709                 aor_options);
1710         ao2_unlink(sip_options_aors, aor_options);
1711
1712         return CMP_MATCH;
1713 }
1714
1715 /*!
1716  * \brief Callback function used to unlink and remove event state compositors that have no AORs feeding them
1717  * \note Run by management_serializer
1718  */
1719 static int sip_options_unused_endpoint_state_compositor(void *obj, void *arg, int flags)
1720 {
1721         struct sip_options_endpoint_state_compositor *endpoint_state_compositor = obj;
1722
1723         if (ao2_container_count(endpoint_state_compositor->aor_statuses)) {
1724                 return 0;
1725         }
1726
1727         /* No AORs are feeding this endpoint state compositor */
1728         ast_sip_persistent_endpoint_update_state(endpoint_state_compositor->name,
1729                 AST_ENDPOINT_OFFLINE);
1730
1731         return CMP_MATCH;
1732 }
1733
1734 /*! \brief Structure which contains information required to synchronize */
1735 struct sip_options_synchronize_task_data {
1736         /*! \brief Whether this is a reload or not */
1737         int reload;
1738 };
1739
1740 /*!
1741  * \brief Task to synchronize our local container of AORs and endpoint state compositors with the current configuration
1742  * \note Run by management_serializer
1743  */
1744 static int sip_options_synchronize_task(void *obj)
1745 {
1746         struct sip_options_synchronize_task_data *task_data = obj;
1747         struct ao2_container *existing = NULL;
1748         struct ao2_container *objects;
1749
1750         /*
1751          * When reloading we keep track of the existing AORs so we can
1752          * terminate old ones that are no longer referenced or used.
1753          */
1754         if (task_data->reload) {
1755                 existing = ao2_container_clone(sip_options_aors, 0);
1756                 if (!existing) {
1757                         return 0;
1758                 }
1759         }
1760
1761         objects = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "aor",
1762                 AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
1763         if (objects) {
1764                 /* Go through the returned AORs and synchronize with our local state */
1765                 ao2_callback(objects, OBJ_NODATA, sip_options_synchronize_aor, existing);
1766                 ao2_ref(objects, -1);
1767         }
1768
1769         /*
1770          * Any AORs remaining in existing are no longer referenced by
1771          * the current container of AORs we retrieved, so remove them.
1772          */
1773         if (existing) {
1774                 ao2_callback(existing, OBJ_NODATA | OBJ_MULTIPLE | OBJ_UNLINK,
1775                         sip_options_unused_aor, NULL);
1776                 ao2_ref(existing, -1);
1777         }
1778
1779         objects = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "endpoint",
1780                 AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
1781         if (objects) {
1782                 /* Go through the provided endpoints and update AORs */
1783                 ao2_callback(objects, OBJ_NODATA, sip_options_synchronize_endpoint, NULL);
1784                 ao2_ref(objects, -1);
1785         }
1786
1787         /*
1788          * All endpoint state compositors that don't have any AORs
1789          * feeding them information can be removed.  If they end
1790          * up getting needed later they'll just be recreated.
1791          */
1792         ao2_callback(sip_options_endpoint_state_compositors,
1793                 OBJ_NODATA | OBJ_MULTIPLE | OBJ_UNLINK,
1794                 sip_options_unused_endpoint_state_compositor, NULL);
1795
1796         return 0;
1797 }
1798
1799 /*! \brief Synchronize our local container of AORs and endpoint state compositors with the current configuration */
1800 static void sip_options_synchronize(int reload)
1801 {
1802         struct sip_options_synchronize_task_data task_data = {
1803                 .reload = reload,
1804         };
1805
1806         ast_sip_push_task_wait_serializer(management_serializer, sip_options_synchronize_task,
1807                 &task_data);
1808 }
1809
1810 /*!
1811  * \brief Unlink AORs feeding the endpoint status compositor
1812  * \note Run by management_serializer
1813  */
1814 static void sip_options_endpoint_unlink_aor_feeders(struct ast_sip_endpoint *endpoint,
1815         struct sip_options_endpoint_state_compositor *endpoint_state_compositor)
1816 {
1817         struct ao2_iterator it_aor_statuses;
1818         struct sip_options_endpoint_aor_status *aor_status;
1819         struct sip_options_endpoint_compositor_task_data task_data = {
1820                 .endpoint_state_compositor = endpoint_state_compositor,
1821         };
1822
1823         ao2_lock(endpoint_state_compositor);
1824         endpoint_state_compositor->active = 0;
1825
1826         /* Unlink AOR feeders pointing to endpoint */
1827         it_aor_statuses = ao2_iterator_init(endpoint_state_compositor->aor_statuses, 0);
1828         for (; (aor_status = ao2_iterator_next(&it_aor_statuses)); ao2_ref(aor_status, -1)) {
1829                 task_data.aor_options = ao2_find(sip_options_aors, aor_status->name,
1830                         OBJ_SEARCH_KEY);
1831                 if (!task_data.aor_options) {
1832                         continue;
1833                 }
1834
1835                 ast_debug(3, "Removing endpoint state compositor '%s' from AOR '%s'\n",
1836                         ast_sorcery_object_get_id(endpoint), aor_status->name);
1837                 ao2_unlock(endpoint_state_compositor);
1838                 ast_sip_push_task_wait_serializer(task_data.aor_options->serializer,
1839                         sip_options_endpoint_compositor_remove_task, &task_data);
1840                 ao2_lock(endpoint_state_compositor);
1841                 ao2_ref(task_data.aor_options, -1);
1842         }
1843         ao2_iterator_destroy(&it_aor_statuses);
1844
1845         /*
1846          * We do not need to remove the AOR feeder status memory from the
1847          * aor_statuses container.  The endpoint_state_compositor is about
1848          * to die and do it for us.
1849          */
1850
1851         ao2_unlock(endpoint_state_compositor);
1852 }
1853
1854 /*!
1855  * \brief Task to delete an endpoint from the known universe
1856  * \note Run by management_serializer
1857  */
1858 static int sip_options_endpoint_observer_deleted_task(void *obj)
1859 {
1860         struct ast_sip_endpoint *endpoint = obj;
1861         struct sip_options_endpoint_state_compositor *endpoint_state_compositor;
1862
1863         endpoint_state_compositor = ao2_find(sip_options_endpoint_state_compositors,
1864                 ast_sorcery_object_get_id(endpoint), OBJ_SEARCH_KEY | OBJ_UNLINK);
1865         if (!endpoint_state_compositor) {
1866                 return 0;
1867         }
1868
1869         ast_debug(3, "Endpoint '%s' has been deleted, removing endpoint state compositor from AORs\n",
1870                 ast_sorcery_object_get_id(endpoint));
1871         sip_options_endpoint_unlink_aor_feeders(endpoint, endpoint_state_compositor);
1872         ao2_ref(endpoint_state_compositor, -1);
1873
1874         return 0;
1875 }
1876
1877 /*! \brief Observer callback invoked on endpoint deletion */
1878 static void endpoint_observer_deleted(const void *obj)
1879 {
1880         ast_sip_push_task_wait_serializer(management_serializer,
1881                 sip_options_endpoint_observer_deleted_task, (void *) obj);
1882 }
1883
1884 /*!
1885  * \brief Task to synchronize the endpoint
1886  * \note Run by management_serializer
1887  */
1888 static int sip_options_endpoint_observer_modified_task(void *obj)
1889 {
1890         struct ast_sip_endpoint *endpoint = obj;
1891         struct sip_options_endpoint_state_compositor *endpoint_state_compositor;
1892
1893         ast_debug(3, "Endpoint '%s' has been created or modified, updating state\n",
1894                 ast_sorcery_object_get_id(endpoint));
1895
1896         endpoint_state_compositor = ao2_find(sip_options_endpoint_state_compositors,
1897                 ast_sorcery_object_get_id(endpoint), OBJ_SEARCH_KEY | OBJ_UNLINK);
1898         if (endpoint_state_compositor) {
1899                 /* Unlink the AORs currently feeding the endpoint. */
1900                 sip_options_endpoint_unlink_aor_feeders(endpoint, endpoint_state_compositor);
1901                 ao2_ref(endpoint_state_compositor, -1);
1902         }
1903
1904         /* Connect the AORs that now feed the endpoint. */
1905         sip_options_synchronize_endpoint(endpoint, NULL, 0);
1906         return 0;
1907 }
1908
1909 /*! \brief Observer callback invoked on endpoint creation or modification */
1910 static void endpoint_observer_modified(const void *obj)
1911 {
1912         ast_sip_push_task_wait_serializer(management_serializer,
1913                 sip_options_endpoint_observer_modified_task, (void *)obj);
1914 }
1915
1916 /*! \brief Observer callbacks for endpoints */
1917 static const struct ast_sorcery_observer endpoint_observer_callbacks = {
1918         .created = endpoint_observer_modified,
1919         .updated = endpoint_observer_modified,
1920         .deleted = endpoint_observer_deleted,
1921 };
1922
1923 /*!
1924  * \brief Task to synchronize an AOR with our local state
1925  * \note Run by aor_options->serializer
1926  */
1927 static int sip_options_update_aor_task(void *obj)
1928 {
1929         struct sip_options_synchronize_aor_task_data *task_data = obj;
1930         int available = task_data->aor_options->available;
1931
1932         ast_debug(3, "Individually updating AOR '%s' with current state of configuration and world\n",
1933                 task_data->aor_options->name);
1934
1935         sip_options_apply_aor_configuration(task_data->aor_options, task_data->aor,
1936                 task_data->added);
1937
1938         if (!available && task_data->aor_options->available) {
1939                 ast_debug(3, "After modifying AOR '%s' it has now become available\n",
1940                         task_data->aor_options->name);
1941                 sip_options_notify_endpoint_state_compositors(task_data->aor_options, AVAILABLE);
1942         } else if (available && !task_data->aor_options->available) {
1943                 ast_debug(3, "After modifying AOR '%s' it has become unavailable\n",
1944                         task_data->aor_options->name);
1945                 sip_options_notify_endpoint_state_compositors(task_data->aor_options, UNAVAILABLE);
1946         }
1947
1948         return 0;
1949 }
1950
1951 /*!
1952  * \brief Task to synchronize the AOR
1953  * \note Run by management_serializer
1954  */
1955 static int sip_options_aor_observer_modified_task(void *obj)
1956 {
1957         struct ast_sip_aor *aor = obj;
1958         struct sip_options_aor *aor_options;
1959
1960         aor_options = ao2_find(sip_options_aors, ast_sorcery_object_get_id(aor),
1961                 OBJ_SEARCH_KEY);
1962         if (!aor_options) {
1963                 struct ao2_container *endpoints;
1964
1965                 aor_options = sip_options_aor_alloc(aor);
1966                 if (!aor_options) {
1967                         return 0;
1968                 }
1969
1970                 /*
1971                  * This is a newly added AOR and we need to establish any
1972                  * endpoint state compositors that may reference only the
1973                  * AOR.  If these need to be updated later then they'll
1974                  * be done by modifying the endpoint or issuing a reload.
1975                  */
1976                 sip_options_apply_aor_configuration(aor_options, aor, 1);
1977                 ao2_link(sip_options_aors, aor_options);
1978
1979                 /*
1980                  * Using LIKE doesn't seem to work very well with non-realtime so we
1981                  * fetch everything right now and do a filter on our side.
1982                  */
1983                 endpoints = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(),
1984                         "endpoint", AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
1985                 if (endpoints) {
1986                         ao2_callback(endpoints, OBJ_NODATA, sip_options_synchronize_endpoint, aor);
1987                         ao2_ref(endpoints, -1);
1988                 }
1989         } else {
1990                 struct sip_options_synchronize_aor_task_data task_data = {
1991                         .aor_options = aor_options,
1992                         .aor = aor,
1993                 };
1994
1995                 /*
1996                  * If this AOR was modified we have to do our work in its serializer
1997                  * instead of this thread to ensure that things aren't modified by
1998                  * multiple threads.
1999                  */
2000                 ast_sip_push_task_wait_serializer(aor_options->serializer,
2001                         sip_options_update_aor_task, &task_data);
2002         }
2003
2004         ao2_ref(aor_options, -1);
2005
2006         return 0;
2007 }
2008
2009 /*! \brief Observer callback invoked on AOR creation or modification */
2010 static void aor_observer_modified(const void *obj)
2011 {
2012         ast_sip_push_task_wait_serializer(management_serializer,
2013                 sip_options_aor_observer_modified_task, (void *) obj);
2014 }
2015
2016 /*!
2017  * \brief Task to delete an AOR from the known universe
2018  * \note Run by management_serializer
2019  */
2020 static int sip_options_aor_observer_deleted_task(void *obj)
2021 {
2022         struct ast_sip_aor *aor = obj;
2023         struct sip_options_aor *aor_options;
2024
2025         aor_options = ao2_find(sip_options_aors, ast_sorcery_object_get_id(aor),
2026                 OBJ_SEARCH_KEY | OBJ_UNLINK);
2027         if (!aor_options) {
2028                 return 0;
2029         }
2030
2031         ast_debug(3, "AOR '%s' has been deleted, removing it\n", aor_options->name);
2032
2033         ast_sip_push_task_wait_serializer(aor_options->serializer, sip_options_aor_remove_task,
2034                 aor_options);
2035         ao2_ref(aor_options, -1);
2036
2037         return 0;
2038 }
2039
2040 /*! \brief Observer callback invoked on AOR deletion */
2041 static void aor_observer_deleted(const void *obj)
2042 {
2043         ast_sip_push_task_wait_serializer(management_serializer,
2044                 sip_options_aor_observer_deleted_task, (void *) obj);
2045 }
2046
2047 /*! \brief Observer callbacks for AORs */
2048 static const struct ast_sorcery_observer aor_observer_callbacks = {
2049         .created = aor_observer_modified,
2050         .updated = aor_observer_modified,
2051         .deleted = aor_observer_deleted,
2052 };
2053
2054 /*! \brief Task details for adding an AOR to an endpoint state compositor */
2055 struct sip_options_contact_observer_task_data {
2056         /*! \brief The AOR options that the contact is referring to */
2057         struct sip_options_aor *aor_options;
2058         /*! \brief The contact itself */
2059         struct ast_sip_contact *contact;
2060 };
2061
2062 /*!
2063  * \brief Task which adds a dynamic contact to an AOR
2064  * \note Run by aor_options->serializer
2065  */
2066 static int sip_options_contact_add_task(void *obj)
2067 {
2068         struct sip_options_contact_observer_task_data *task_data = obj;
2069         struct ast_sip_contact_status *contact_status;
2070
2071         ao2_link(task_data->aor_options->dynamic_contacts, task_data->contact);
2072         ao2_link(task_data->aor_options->contacts, task_data->contact);
2073
2074         contact_status = ast_res_pjsip_find_or_create_contact_status(task_data->contact);
2075         ao2_cleanup(contact_status);
2076
2077         if (task_data->aor_options->qualify_frequency) {
2078                 /* If this is the first contact we need to schedule up qualification */
2079                 if (ao2_container_count(task_data->aor_options->contacts) == 1) {
2080                         ast_debug(3, "Starting scheduled callback on AOR '%s' for qualifying as there is now a contact on it\n",
2081                                 task_data->aor_options->name);
2082                         /*
2083                          * We immediately schedule the initial qualify so that we get
2084                          * reachable/unreachable as soon as possible.  Realistically
2085                          * since they pretty much just registered they should be
2086                          * reachable.
2087                          */
2088                         if (task_data->aor_options->sched_task) {
2089                                 ast_sip_sched_task_cancel(task_data->aor_options->sched_task);
2090                                 ao2_ref(task_data->aor_options->sched_task, -1);
2091                                 task_data->aor_options->sched_task = NULL;
2092                         }
2093                         task_data->aor_options->sched_task = ast_sip_schedule_task(
2094                                 task_data->aor_options->serializer, 1, sip_options_qualify_aor,
2095                                 ast_taskprocessor_name(task_data->aor_options->serializer),
2096                                 task_data->aor_options,
2097                                 AST_SIP_SCHED_TASK_VARIABLE | AST_SIP_SCHED_TASK_DATA_AO2);
2098                         if (!task_data->aor_options->sched_task) {
2099                                 ast_log(LOG_ERROR, "Unable to schedule qualify for contacts of AOR '%s'\n",
2100                                         task_data->aor_options->name);
2101                         }
2102                 }
2103         } else {
2104                 /*
2105                  * If this was the first contact added to a non-qualified AOR then
2106                  * it should become available.
2107                  */
2108                 task_data->aor_options->available =
2109                         ao2_container_count(task_data->aor_options->contacts);
2110                 if (task_data->aor_options->available == 1) {
2111                         ast_debug(3, "An unqualified contact has been added to AOR '%s' so it is now available\n",
2112                                 task_data->aor_options->name);
2113                         sip_options_notify_endpoint_state_compositors(task_data->aor_options,
2114                                 AVAILABLE);
2115                 }
2116         }
2117
2118         return 0;
2119 }
2120
2121 /*!
2122  * \brief Task to add a dynamic contact to an AOR in its serializer
2123  * \note Run by management_serializer
2124  */
2125 static int sip_options_contact_add_management_task(void *obj)
2126 {
2127         struct sip_options_contact_observer_task_data task_data;
2128
2129         task_data.contact = obj;
2130         task_data.aor_options = ao2_find(sip_options_aors, task_data.contact->aor,
2131                 OBJ_SEARCH_KEY);
2132         if (!task_data.aor_options) {
2133                 struct ast_sip_aor *aor;
2134
2135                 /*
2136                  * The only reason this would occur is if the AOR was sourced
2137                  * after the last reload happened.  To handle this we fetch the
2138                  * AOR and treat it as if we received notification that it had
2139                  * been created.  This will create the needed AOR feeder
2140                  * compositor and will cause any associated contact statuses and
2141                  * endpoint state compositors to also get created if needed.
2142                  */
2143                 aor = ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "aor",
2144                         task_data.contact->aor);
2145                 if (aor) {
2146                         sip_options_aor_observer_modified_task(aor);
2147                         ao2_ref(aor, -1);
2148                 }
2149                 return 0;
2150         }
2151
2152         ast_sip_push_task_wait_serializer(task_data.aor_options->serializer,
2153                 sip_options_contact_add_task, &task_data);
2154         ao2_ref(task_data.aor_options, -1);
2155
2156         return 0;
2157 }
2158
2159 /*! \brief Observer callback invoked on contact creation */
2160 static void contact_observer_created(const void *obj)
2161 {
2162         ast_sip_push_task_wait_serializer(management_serializer,
2163                 sip_options_contact_add_management_task, (void *) obj);
2164 }
2165
2166 /*!
2167  * \brief Task which updates a dynamic contact to an AOR
2168  * \note Run by aor_options->serializer
2169  */
2170 static int sip_options_contact_update_task(void *obj)
2171 {
2172         struct sip_options_contact_observer_task_data *task_data = obj;
2173         struct ast_sip_contact_status *contact_status;
2174
2175         contact_status = ast_sip_get_contact_status(task_data->contact);
2176         if (contact_status) {
2177                 switch (contact_status->status) {
2178                 case CREATED:
2179                 case UNAVAILABLE:
2180                 case AVAILABLE:
2181                 case UNKNOWN:
2182                         /* Refresh the ContactStatus AMI events. */
2183                         sip_options_contact_status_update(contact_status);
2184                         break;
2185                 case REMOVED:
2186                         break;
2187                 }
2188                 ao2_ref(contact_status, -1);
2189         }
2190
2191         ao2_ref(task_data->contact, -1);
2192         ao2_ref(task_data->aor_options, -1);
2193         ast_free(task_data);
2194         return 0;
2195 }
2196
2197 /*! \brief Observer callback invoked on contact update */
2198 static void contact_observer_updated(const void *obj)
2199 {
2200         struct sip_options_contact_observer_task_data *task_data;
2201
2202         task_data = ast_malloc(sizeof(*task_data));
2203         if (!task_data) {
2204                 return;
2205         }
2206
2207         task_data->contact = (struct ast_sip_contact *) obj;
2208         task_data->aor_options = ao2_find(sip_options_aors, task_data->contact->aor,
2209                 OBJ_SEARCH_KEY);
2210         if (!task_data->aor_options) {
2211                 ast_free(task_data);
2212                 return;
2213         }
2214
2215         ao2_ref(task_data->contact, +1);
2216         if (ast_sip_push_task(task_data->aor_options->serializer,
2217                 sip_options_contact_update_task, task_data)) {
2218                 ao2_ref(task_data->contact, -1);
2219                 ao2_ref(task_data->aor_options, -1);
2220                 ast_free(task_data);
2221         }
2222 }
2223
2224 /*!
2225  * \brief Task which deletes a dynamic contact from an AOR
2226  * \note Run by aor_options->serializer
2227  */
2228 static int sip_options_contact_delete_task(void *obj)
2229 {
2230         struct sip_options_contact_observer_task_data *task_data = obj;
2231
2232         ao2_find(task_data->aor_options->dynamic_contacts, task_data->contact,
2233                 OBJ_NODATA | OBJ_UNLINK | OBJ_SEARCH_OBJECT);
2234         ao2_find(task_data->aor_options->contacts, task_data->contact,
2235                 OBJ_NODATA | OBJ_UNLINK | OBJ_SEARCH_OBJECT);
2236
2237         sip_options_remove_contact_status(task_data->aor_options, task_data->contact);
2238
2239         if (task_data->aor_options->qualify_frequency) {
2240                 /* If this is the last contact then we need to stop the scheduled callback */
2241                 if (!ao2_container_count(task_data->aor_options->contacts)) {
2242                         ast_debug(3, "Terminating scheduled callback on AOR '%s' as there are no contacts to qualify\n",
2243                                 task_data->aor_options->name);
2244                         if (task_data->aor_options->sched_task) {
2245                                 ast_sip_sched_task_cancel(task_data->aor_options->sched_task);
2246                                 ao2_ref(task_data->aor_options->sched_task, -1);
2247                                 task_data->aor_options->sched_task = NULL;
2248                         }
2249                 }
2250         } else {
2251                 task_data->aor_options->available =
2252                         ao2_container_count(task_data->aor_options->contacts);
2253                 if (!task_data->aor_options->available) {
2254                         ast_debug(3, "An unqualified contact has been removed from AOR '%s' leaving no remaining contacts\n",
2255                                 task_data->aor_options->name);
2256                         sip_options_notify_endpoint_state_compositors(task_data->aor_options,
2257                                 UNAVAILABLE);
2258                 }
2259         }
2260
2261         return 0;
2262 }
2263
2264 /*!
2265  * \brief Task to delete a contact from an AOR in its serializer
2266  * \note Run by management_serializer
2267  */
2268 static int sip_options_contact_delete_management_task(void *obj)
2269 {
2270         struct sip_options_contact_observer_task_data task_data;
2271
2272         task_data.contact = obj;
2273         task_data.aor_options = ao2_find(sip_options_aors, task_data.contact->aor,
2274                 OBJ_SEARCH_KEY);
2275         if (!task_data.aor_options) {
2276                 /* For contacts that are deleted we don't really care if there is no AOR locally */
2277                 return 0;
2278         }
2279
2280         ast_sip_push_task_wait_serializer(task_data.aor_options->serializer,
2281                 sip_options_contact_delete_task, &task_data);
2282         ao2_ref(task_data.aor_options, -1);
2283
2284         return 0;
2285 }
2286
2287 /*! \brief Observer callback invoked on contact deletion */
2288 static void contact_observer_deleted(const void *obj)
2289 {
2290         ast_sip_push_task_wait_serializer(management_serializer,
2291                 sip_options_contact_delete_management_task, (void *) obj);
2292 }
2293
2294 /*! \brief Observer callbacks for contacts */
2295 static const struct ast_sorcery_observer contact_observer_callbacks = {
2296         .created = contact_observer_created,
2297         .updated = contact_observer_updated,
2298         .deleted = contact_observer_deleted,
2299 };
2300
2301 static char *cli_qualify(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
2302 {
2303         RAII_VAR(struct ast_sip_endpoint *, endpoint, NULL, ao2_cleanup);
2304         const char *endpoint_name;
2305         char *aors;
2306         char *aor_name;
2307
2308         switch (cmd) {
2309         case CLI_INIT:
2310                 e->command = "pjsip qualify";
2311                 e->usage =
2312                         "Usage: pjsip qualify <endpoint>\n"
2313                         "       Send a SIP OPTIONS request to all contacts on the endpoint.\n";
2314                 return NULL;
2315         case CLI_GENERATE:
2316                 return NULL;
2317         }
2318
2319         if (a->argc != 3) {
2320                 return CLI_SHOWUSAGE;
2321         }
2322
2323         endpoint_name = a->argv[2];
2324
2325         endpoint = ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "endpoint",
2326                 endpoint_name);
2327         if (!endpoint) {
2328                 ast_cli(a->fd, "Unable to retrieve endpoint %s\n", endpoint_name);
2329                 return CLI_FAILURE;
2330         }
2331
2332         if (ast_strlen_zero(endpoint->aors)) {
2333                 ast_cli(a->fd, "No AORs configured for endpoint '%s'\n", endpoint_name);
2334                 return CLI_FAILURE;
2335         }
2336
2337         aors = ast_strdupa(endpoint->aors);
2338         while ((aor_name = ast_strip(strsep(&aors, ",")))) {
2339                 struct sip_options_aor *aor_options;
2340
2341                 aor_options = ao2_find(sip_options_aors, aor_name, OBJ_SEARCH_KEY);
2342                 if (!aor_options) {
2343                         continue;
2344                 }
2345
2346                 ast_cli(a->fd, "Qualifying AOR '%s' on endpoint '%s'\n", aor_name, endpoint_name);
2347                 ast_sip_push_task_wait_serializer(aor_options->serializer, sip_options_qualify_aor,
2348                         aor_options);
2349                 ao2_ref(aor_options, -1);
2350         }
2351
2352         return CLI_SUCCESS;
2353 }
2354
2355 static struct ao2_container *get_all_contacts(void)
2356 {
2357         struct ao2_container *contacts;
2358
2359         contacts = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "contact",
2360                         AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
2361
2362         return contacts;
2363 }
2364
2365 static int sip_contact_to_ami(const struct ast_sip_contact *contact,
2366                            struct ast_str **buf)
2367 {
2368         return ast_sip_sorcery_object_to_ami(contact, buf);
2369 }
2370
2371 static int format_ami_contactlist_handler(void *obj, void *arg, int flags)
2372 {
2373         struct ast_sip_contact *contact = obj;
2374         struct ast_sip_ami *ami = arg;
2375         struct ast_str *buf;
2376         struct ast_sip_contact_status *status;
2377
2378         buf = ast_sip_create_ami_event("ContactList", ami);
2379         if (!buf) {
2380                 return CMP_STOP;
2381         }
2382
2383         if (sip_contact_to_ami(contact, &buf)) {
2384                 ast_free(buf);
2385                 return CMP_STOP;
2386         }
2387
2388         /* Add extra info */
2389         status = ast_sip_get_contact_status(contact);
2390         ast_str_append(&buf, 0, "Status: %s\r\n",
2391                 ast_sip_get_contact_status_label(status ? status->status : UNKNOWN));
2392         if (!status || status->status != AVAILABLE) {
2393                 ast_str_append(&buf, 0, "RoundtripUsec: N/A\r\n");
2394         } else {
2395                 ast_str_append(&buf, 0, "RoundtripUsec: %" PRId64 "\r\n", status->rtt);
2396         }
2397         ao2_cleanup(status);
2398
2399         astman_append(ami->s, "%s\r\n", ast_str_buffer(buf));
2400
2401         ami->count++;
2402
2403         ast_free(buf);
2404
2405         return 0;
2406 }
2407
2408 static int ami_show_contacts(struct mansession *s, const struct message *m)
2409 {
2410         struct ast_sip_ami ami = { .s = s, .m = m, .action_id = astman_get_header(m, "ActionID"), };
2411         struct ao2_container *contacts;
2412
2413         contacts = get_all_contacts();
2414         if (!contacts) {
2415                 astman_send_error(s, m, "Could not get Contacts\n");
2416                 return 0;
2417         }
2418
2419         if (!ao2_container_count(contacts)) {
2420                 astman_send_error(s, m, "No Contacts found\n");
2421                 ao2_ref(contacts, -1);
2422                 return 0;
2423         }
2424
2425         astman_send_listack(s, m, "A listing of Contacts follows, presented as ContactList events",
2426                         "start");
2427
2428         ao2_callback(contacts, OBJ_NODATA, format_ami_contactlist_handler, &ami);
2429
2430         astman_send_list_complete_start(s, m, "ContactListComplete", ami.count);
2431         astman_send_list_complete_end(s);
2432
2433         ao2_ref(contacts, -1);
2434
2435         return 0;
2436 }
2437
2438 static int ami_sip_qualify(struct mansession *s, const struct message *m)
2439 {
2440         const char *endpoint_name = astman_get_header(m, "Endpoint");
2441         RAII_VAR(struct ast_sip_endpoint *, endpoint, NULL, ao2_cleanup);
2442         char *aors;
2443         char *aor_name;
2444
2445         if (ast_strlen_zero(endpoint_name)) {
2446                 astman_send_error(s, m, "Endpoint parameter missing.");
2447                 return 0;
2448         }
2449
2450         endpoint = ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "endpoint",
2451                 endpoint_name);
2452         if (!endpoint) {
2453                 astman_send_error(s, m, "Unable to retrieve endpoint\n");
2454                 return 0;
2455         }
2456
2457         /* send a qualify for all contacts registered with the endpoint */
2458         if (ast_strlen_zero(endpoint->aors)) {
2459                 astman_send_error(s, m, "No AoRs configured for endpoint\n");
2460                 return 0;
2461         }
2462
2463         aors = ast_strdupa(endpoint->aors);
2464         while ((aor_name = ast_strip(strsep(&aors, ",")))) {
2465                 struct sip_options_aor *aor_options;
2466
2467                 aor_options = ao2_find(sip_options_aors, aor_name, OBJ_SEARCH_KEY);
2468                 if (!aor_options) {
2469                         continue;
2470                 }
2471
2472                 ast_sip_push_task_wait_serializer(aor_options->serializer, sip_options_qualify_aor,
2473                         aor_options);
2474                 ao2_ref(aor_options, -1);
2475         }
2476
2477         astman_send_ack(s, m, "Endpoint found, will qualify");
2478         return 0;
2479 }
2480
2481 static struct ast_cli_entry cli_options[] = {
2482         AST_CLI_DEFINE(cli_qualify, "Send an OPTIONS request to a PJSIP endpoint")
2483 };
2484
2485 int ast_sip_format_contact_ami(void *obj, void *arg, int flags)
2486 {
2487         struct ast_sip_contact_wrapper *wrapper = obj;
2488         struct ast_sip_contact *contact = wrapper->contact;
2489         struct ast_sip_ami *ami = arg;
2490         struct ast_sip_contact_status *status;
2491         struct ast_str *buf;
2492         const struct ast_sip_endpoint *endpoint = ami->arg;
2493
2494         buf = ast_sip_create_ami_event("ContactStatusDetail", ami);
2495         if (!buf) {
2496                 return -1;
2497         }
2498
2499         status = ast_sip_get_contact_status(contact);
2500
2501         ast_str_append(&buf, 0, "AOR: %s\r\n", wrapper->aor_id);
2502         ast_str_append(&buf, 0, "URI: %s\r\n", contact->uri);
2503         ast_str_append(&buf, 0, "UserAgent: %s\r\n", contact->user_agent);
2504         ast_str_append(&buf, 0, "RegExpire: %ld\r\n", contact->expiration_time.tv_sec);
2505         if (!ast_strlen_zero(contact->via_addr)) {
2506                 ast_str_append(&buf, 0, "ViaAddress: %s", contact->via_addr);
2507                 if (contact->via_port) {
2508                         ast_str_append(&buf, 0, ":%d", contact->via_port);
2509                 }
2510                 ast_str_append(&buf, 0, "\r\n");
2511         }
2512         if (!ast_strlen_zero(contact->call_id)) {
2513                 ast_str_append(&buf, 0, "CallID: %s\r\n", contact->call_id);
2514         }
2515         ast_str_append(&buf, 0, "Status: %s\r\n",
2516                 ast_sip_get_contact_status_label(status ? status->status : UNKNOWN));
2517         if (!status || status->status != AVAILABLE) {
2518                 ast_str_append(&buf, 0, "RoundtripUsec: N/A\r\n");
2519         } else {
2520                 ast_str_append(&buf, 0, "RoundtripUsec: %" PRId64 "\r\n", status->rtt);
2521         }
2522         ast_str_append(&buf, 0, "EndpointName: %s\r\n",
2523                 endpoint ? ast_sorcery_object_get_id(endpoint) : S_OR(contact->endpoint_name, ""));
2524
2525         ast_str_append(&buf, 0, "ID: %s\r\n", ast_sorcery_object_get_id(contact));
2526         ast_str_append(&buf, 0, "AuthenticateQualify: %d\r\n", contact->authenticate_qualify);
2527         ast_str_append(&buf, 0, "OutboundProxy: %s\r\n", contact->outbound_proxy);
2528         ast_str_append(&buf, 0, "Path: %s\r\n", contact->path);
2529         ast_str_append(&buf, 0, "QualifyFrequency: %u\r\n", contact->qualify_frequency);
2530         ast_str_append(&buf, 0, "QualifyTimeout: %.3f\r\n", contact->qualify_timeout);
2531
2532         astman_append(ami->s, "%s\r\n", ast_str_buffer(buf));
2533         ami->count++;
2534
2535         ast_free(buf);
2536         ao2_cleanup(status);
2537         return 0;
2538 }
2539
2540 static int format_contact_status_for_aor(void *obj, void *arg, int flags)
2541 {
2542         struct ast_sip_aor *aor = obj;
2543
2544         return ast_sip_for_each_contact(aor, ast_sip_format_contact_ami, arg);
2545 }
2546
2547 static int format_ami_contact_status(const struct ast_sip_endpoint *endpoint,
2548                 struct ast_sip_ami *ami)
2549 {
2550         ami->arg = (void *)endpoint;
2551         return ast_sip_for_each_aor(endpoint->aors, format_contact_status_for_aor, ami);
2552 }
2553
2554 static struct ast_sip_endpoint_formatter contact_status_formatter = {
2555         .format_ami = format_ami_contact_status
2556 };
2557
2558 /*!
2559  * \brief Management task to clean up an AOR
2560  * \note Run by aor_options->serializer
2561  */
2562 static int sip_options_cleanup_aor_task(void *obj)
2563 {
2564         struct sip_options_aor *aor_options = obj;
2565
2566         ast_debug(2, "Cleaning up AOR '%s' for shutdown\n", aor_options->name);
2567
2568         aor_options->qualify_frequency = 0;
2569         if (aor_options->sched_task) {
2570                 ast_sip_sched_task_cancel(aor_options->sched_task);
2571                 ao2_ref(aor_options->sched_task, -1);
2572                 aor_options->sched_task = NULL;
2573         }
2574         AST_VECTOR_RESET(&aor_options->compositors, ao2_cleanup);
2575
2576         return 0;
2577 }
2578
2579 /*!
2580  * \brief Management task to clean up the environment
2581  * \note Run by management_serializer
2582  */
2583 static int sip_options_cleanup_task(void *obj)
2584 {
2585         struct ao2_iterator it_aor;
2586         struct sip_options_aor *aor_options;
2587
2588         if (!sip_options_aors) {
2589                 /* Nothing to do */
2590                 return 0;
2591         }
2592
2593         it_aor = ao2_iterator_init(sip_options_aors, AO2_ITERATOR_UNLINK);
2594         for (; (aor_options = ao2_iterator_next(&it_aor)); ao2_ref(aor_options, -1)) {
2595                 ast_sip_push_task_wait_serializer(aor_options->serializer,
2596                         sip_options_cleanup_aor_task, aor_options);
2597         }
2598         ao2_iterator_destroy(&it_aor);
2599
2600         return 0;
2601 }
2602
2603 void ast_res_pjsip_cleanup_options_handling(void)
2604 {
2605         int remaining;
2606         struct ast_taskprocessor *mgmt_serializer;
2607
2608         ast_cli_unregister_multiple(cli_options, ARRAY_LEN(cli_options));
2609         ast_manager_unregister("PJSIPQualify");
2610         ast_manager_unregister("PJSIPShowContacts");
2611         ast_sip_unregister_endpoint_formatter(&contact_status_formatter);
2612
2613         ast_sorcery_observer_remove(ast_sip_get_sorcery(), "contact",
2614                 &contact_observer_callbacks);
2615         ast_sorcery_observer_remove(ast_sip_get_sorcery(), "aor",
2616                 &aor_observer_callbacks);
2617         ast_sorcery_observer_remove(ast_sip_get_sorcery(), "endpoint",
2618                 &endpoint_observer_callbacks);
2619
2620         mgmt_serializer = management_serializer;
2621         management_serializer = NULL;
2622         if (mgmt_serializer) {
2623                 ast_sip_push_task_wait_serializer(mgmt_serializer, sip_options_cleanup_task, NULL);
2624         }
2625
2626         remaining = ast_serializer_shutdown_group_join(shutdown_group,
2627                 MAX_UNLOAD_TIMEOUT_TIME);
2628         if (remaining) {
2629                 ast_log(LOG_WARNING, "Cleanup incomplete. Could not stop %d AORs.\n",
2630                         remaining);
2631         }
2632         ao2_cleanup(shutdown_group);
2633         shutdown_group = NULL;
2634
2635         if (mgmt_serializer) {
2636                 ast_taskprocessor_unreference(mgmt_serializer);
2637         }
2638
2639         ao2_cleanup(sip_options_aors);
2640         sip_options_aors = NULL;
2641         ao2_cleanup(sip_options_contact_statuses);
2642         sip_options_contact_statuses = NULL;
2643         ao2_cleanup(sip_options_endpoint_state_compositors);
2644         sip_options_endpoint_state_compositors = NULL;
2645
2646         pjsip_endpt_unregister_module(ast_sip_get_pjsip_endpoint(), &options_module);
2647 }
2648
2649 /*!
2650  * \brief Management task to finish setting up the environment.
2651  * \note Run by management_serializer
2652  */
2653 static int sip_options_init_task(void *mgmt_serializer)
2654 {
2655         management_serializer = mgmt_serializer;
2656
2657         shutdown_group = ast_serializer_shutdown_group_alloc();
2658         if (!shutdown_group) {
2659                 return -1;
2660         }
2661
2662         if (ast_sorcery_observer_add(ast_sip_get_sorcery(), "endpoint",
2663                 &endpoint_observer_callbacks)) {
2664                 return -1;
2665         }
2666         if (ast_sorcery_observer_add(ast_sip_get_sorcery(), "aor",
2667                 &aor_observer_callbacks)) {
2668                 return -1;
2669         }
2670         if (ast_sorcery_observer_add(ast_sip_get_sorcery(), "contact",
2671                 &contact_observer_callbacks)) {
2672                 return -1;
2673         }
2674
2675         sip_options_synchronize(0);
2676
2677         return 0;
2678 }
2679
2680 int ast_res_pjsip_preinit_options_handling(void)
2681 {
2682         sip_options_contact_statuses = sip_options_contact_statuses_alloc();
2683         return sip_options_contact_statuses ? 0 : -1;
2684 }
2685
2686 int ast_res_pjsip_init_options_handling(int reload)
2687 {
2688         struct ast_taskprocessor *mgmt_serializer;
2689
2690         static const pj_str_t STR_OPTIONS = { "OPTIONS", 7 };
2691
2692         if (reload) {
2693                 sip_options_synchronize(1);
2694                 return 0;
2695         }
2696
2697         if (pjsip_endpt_register_module(ast_sip_get_pjsip_endpoint(), &options_module)
2698                 != PJ_SUCCESS) {
2699                 return -1;
2700         }
2701
2702         if (pjsip_endpt_add_capability(ast_sip_get_pjsip_endpoint(), NULL, PJSIP_H_ALLOW,
2703                 NULL, 1, &STR_OPTIONS) != PJ_SUCCESS) {
2704                 ast_res_pjsip_cleanup_options_handling();
2705                 return -1;
2706         }
2707
2708         sip_options_aors = ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_RWLOCK, 0, AOR_BUCKETS,
2709                 sip_options_aor_hash_fn, NULL, sip_options_aor_cmp_fn);
2710         if (!sip_options_aors) {
2711                 ast_res_pjsip_cleanup_options_handling();
2712                 return -1;
2713         }
2714         sip_options_endpoint_state_compositors =
2715                 ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_RWLOCK, 0,
2716                         ENDPOINT_STATE_COMPOSITOR_BUCKETS,
2717                         sip_options_endpoint_state_compositor_hash_fn, NULL,
2718                         sip_options_endpoint_state_compositor_cmp_fn);
2719         if (!sip_options_endpoint_state_compositors) {
2720                 ast_res_pjsip_cleanup_options_handling();
2721                 return -1;
2722         }
2723
2724         mgmt_serializer = ast_sip_create_serializer("pjsip/options/manage");
2725         if (!mgmt_serializer) {
2726                 ast_res_pjsip_cleanup_options_handling();
2727                 return -1;
2728         }
2729
2730         /*
2731          * Set the water mark levels high because we can get a flood of
2732          * contact status updates from sip_options_synchronize() that
2733          * quickly clears on initial load or reload.
2734          */
2735         ast_taskprocessor_alert_set_levels(mgmt_serializer, -1,
2736                 10 * AST_TASKPROCESSOR_HIGH_WATER_LEVEL);
2737
2738         /*
2739          * We make sure that the environment is completely setup before we allow
2740          * any other threads to post contact_status updates to the
2741          * management_serializer.
2742          */
2743         if (ast_sip_push_task_wait_serializer(mgmt_serializer, sip_options_init_task,
2744                 mgmt_serializer)) {
2745                 /* Set management_serializer in case pushing the task actually failed. */
2746                 management_serializer = mgmt_serializer;
2747                 ast_res_pjsip_cleanup_options_handling();
2748                 return -1;
2749         }
2750
2751         ast_sip_register_endpoint_formatter(&contact_status_formatter);
2752         ast_manager_register_xml("PJSIPQualify", EVENT_FLAG_SYSTEM | EVENT_FLAG_REPORTING,
2753                 ami_sip_qualify);
2754         ast_manager_register_xml("PJSIPShowContacts", EVENT_FLAG_SYSTEM, ami_show_contacts);
2755         ast_cli_register_multiple(cli_options, ARRAY_LEN(cli_options));
2756
2757         return 0;
2758 }