Merge "asterisk.c: When astcanary dies on linux, reset priority on all threads."
[asterisk/asterisk.git] / main / ccss.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2010, Digium, Inc.
5  *
6  * Mark Michelson <mmichelson@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  * \brief Call Completion Supplementary Services implementation
21  * \author Mark Michelson <mmichelson@digium.com>
22  */
23
24 /*! \li \ref ccss.c uses the configuration file \ref ccss.conf
25  * \addtogroup configuration_file Configuration Files
26  */
27
28 /*!
29  * \page ccss.conf ccss.conf
30  * \verbinclude ccss.conf.sample
31  */
32
33 /*** MODULEINFO
34         <support_level>core</support_level>
35  ***/
36
37 #include "asterisk.h"
38
39 ASTERISK_REGISTER_FILE()
40
41 #include "asterisk/astobj2.h"
42 #include "asterisk/strings.h"
43 #include "asterisk/ccss.h"
44 #include "asterisk/channel.h"
45 #include "asterisk/pbx.h"
46 #include "asterisk/utils.h"
47 #include "asterisk/taskprocessor.h"
48 #include "asterisk/devicestate.h"
49 #include "asterisk/module.h"
50 #include "asterisk/app.h"
51 #include "asterisk/cli.h"
52 #include "asterisk/manager.h"
53 #include "asterisk/causes.h"
54 #include "asterisk/stasis_system.h"
55 #include "asterisk/format_cache.h"
56
57 /*** DOCUMENTATION
58         <application name="CallCompletionRequest" language="en_US">
59                 <synopsis>
60                         Request call completion service for previous call
61                 </synopsis>
62                 <syntax />
63                 <description>
64                         <para>Request call completion service for a previously failed
65                         call attempt.</para>
66                         <para>This application sets the following channel variables:</para>
67                         <variablelist>
68                                 <variable name="CC_REQUEST_RESULT">
69                                         <para>This is the returned status of the request.</para>
70                                         <value name="SUCCESS" />
71                                         <value name="FAIL" />
72                                 </variable>
73                                 <variable name="CC_REQUEST_REASON">
74                                         <para>This is the reason the request failed.</para>
75                                         <value name="NO_CORE_INSTANCE" />
76                                         <value name="NOT_GENERIC" />
77                                         <value name="TOO_MANY_REQUESTS" />
78                                         <value name="UNSPECIFIED" />
79                                 </variable>
80                         </variablelist>
81                 </description>
82         </application>
83         <application name="CallCompletionCancel" language="en_US">
84                 <synopsis>
85                         Cancel call completion service
86                 </synopsis>
87                 <syntax />
88                 <description>
89                         <para>Cancel a Call Completion Request.</para>
90                         <para>This application sets the following channel variables:</para>
91                         <variablelist>
92                                 <variable name="CC_CANCEL_RESULT">
93                                         <para>This is the returned status of the cancel.</para>
94                                         <value name="SUCCESS" />
95                                         <value name="FAIL" />
96                                 </variable>
97                                 <variable name="CC_CANCEL_REASON">
98                                         <para>This is the reason the cancel failed.</para>
99                                         <value name="NO_CORE_INSTANCE" />
100                                         <value name="NOT_GENERIC" />
101                                         <value name="UNSPECIFIED" />
102                                 </variable>
103                         </variablelist>
104                 </description>
105         </application>
106  ***/
107
108 /* These are some file-scoped variables. It would be
109  * nice to define them closer to their first usage, but since
110  * they are used in many places throughout the file, defining
111  * them here at the top is easiest.
112  */
113
114 /*!
115  * The ast_sched_context used for all generic CC timeouts
116  */
117 static struct ast_sched_context *cc_sched_context;
118 /*!
119  * Counter used to create core IDs for CC calls. Each new
120  * core ID is created by atomically adding 1 to the core_id_counter
121  */
122 static int core_id_counter;
123 /*!
124  * Taskprocessor from which all CC agent and monitor callbacks
125  * are called.
126  */
127 static struct ast_taskprocessor *cc_core_taskprocessor;
128 /*!
129  * Name printed on all CC log messages.
130  */
131 static const char *CC_LOGGER_LEVEL_NAME = "CC";
132 /*!
133  * Logger level registered by the CC core.
134  */
135 static int cc_logger_level;
136 /*!
137  * Parsed configuration value for cc_max_requests
138  */
139 static unsigned int global_cc_max_requests;
140 /*!
141  * The current number of CC requests in the system
142  */
143 static int cc_request_count;
144
145 static inline void *cc_ref(void *obj, const char *debug)
146 {
147         ao2_t_ref(obj, +1, debug);
148         return obj;
149 }
150
151 static inline void *cc_unref(void *obj, const char *debug)
152 {
153         ao2_t_ref(obj, -1, debug);
154         return NULL;
155 }
156
157 /*!
158  * \since 1.8
159  * \internal
160  * \brief A structure for holding the configuration parameters
161  * relating to CCSS
162  */
163 struct ast_cc_config_params {
164         enum ast_cc_agent_policies cc_agent_policy;
165         enum ast_cc_monitor_policies cc_monitor_policy;
166         unsigned int cc_offer_timer;
167         unsigned int ccnr_available_timer;
168         unsigned int ccbs_available_timer;
169         unsigned int cc_recall_timer;
170         unsigned int cc_max_agents;
171         unsigned int cc_max_monitors;
172         char cc_callback_macro[AST_MAX_EXTENSION];
173         char cc_callback_sub[AST_MAX_EXTENSION];
174         char cc_agent_dialstring[AST_MAX_EXTENSION];
175 };
176
177 /*!
178  * \since 1.8
179  * \brief The states used in the CCSS core state machine
180  *
181  * For more information, see doc/CCSS_architecture.pdf
182  */
183 enum cc_state {
184         /*! Entered when it is determined that CCSS may be used for the call */
185         CC_AVAILABLE,
186         /*! Entered when a CCSS agent has offered CCSS to a caller */
187         CC_CALLER_OFFERED,
188         /*! Entered when a CCSS agent confirms that a caller has
189          * requested CCSS */
190         CC_CALLER_REQUESTED,
191         /*! Entered when a CCSS monitor confirms acknowledgment of an
192          * outbound CCSS request */
193         CC_ACTIVE,
194         /*! Entered when a CCSS monitor alerts the core that the called party
195          * has become available */
196         CC_CALLEE_READY,
197         /*! Entered when a CCSS agent alerts the core that the calling party
198          * may not be recalled because he is unavailable
199          */
200         CC_CALLER_BUSY,
201         /*! Entered when a CCSS agent alerts the core that the calling party
202          * is attempting to recall the called party
203          */
204         CC_RECALLING,
205         /*! Entered when an application alerts the core that the calling party's
206          * recall attempt has had a call progress response indicated
207          */
208         CC_COMPLETE,
209         /*! Entered any time that something goes wrong during the process, thus
210          * resulting in the failure of the attempted CCSS transaction. Note also
211          * that cancellations of CC are treated as failures.
212          */
213         CC_FAILED,
214 };
215
216 /*!
217  * \brief The payload for an AST_CONTROL_CC frame
218  *
219  * \details
220  * This contains all the necessary data regarding
221  * a called device so that the CC core will be able
222  * to allocate the proper monitoring resources.
223  */
224 struct cc_control_payload {
225         /*!
226          * \brief The type of monitor to allocate.
227          *
228          * \details
229          * The type of monitor to allocate. This is a string which corresponds
230          * to a set of monitor callbacks registered. Examples include "generic"
231          * and "SIP"
232          *
233          * \note This really should be an array of characters in case this payload
234          * is sent accross an IAX2 link.  However, this would not make too much sense
235          * given this type may not be recognized by the other end.
236          * Protection may be necessary to prevent it from being transmitted.
237          *
238          * In addition the following other problems are also possible:
239          * 1) Endian issues with the integers/enums stored in the config_params.
240          * 2) Alignment padding issues for the element types.
241          */
242         const char *monitor_type;
243         /*!
244          * \brief Private data allocated by the callee
245          *
246          * \details
247          * All channel drivers that monitor endpoints will need to allocate
248          * data that is not usable by the CC core. In most cases, some or all
249          * of this data is allocated at the time that the channel driver offers
250          * CC to the caller. There are many opportunities for failures to occur
251          * between when a channel driver offers CC and when a monitor is actually
252          * allocated to watch the endpoint. For this reason, the channel driver
253          * must give the core a pointer to the private data that was allocated so
254          * that the core can call back into the channel driver to destroy it if
255          * a failure occurs. If no private data has been allocated at the time that
256          * CC is offered, then it is perfectly acceptable to pass NULL for this
257          * field.
258          */
259         void *private_data;
260         /*!
261          * \brief Service offered by the endpoint
262          *
263          * \details
264          * This indicates the type of call completion service offered by the
265          * endpoint. This data is not crucial to the machinations of the CC core,
266          * but it is helpful for debugging purposes.
267          */
268         enum ast_cc_service_type service;
269         /*!
270          * \brief Configuration parameters used by this endpoint
271          *
272          * \details
273          * Each time an endpoint offers call completion, it must provide its call
274          * completion configuration parameters. This is because settings may be different
275          * depending on the circumstances.
276          */
277         struct ast_cc_config_params config_params;
278         /*!
279          * \brief ID of parent extension
280          *
281          * \details
282          * This is the only datum that the CC core derives on its own and is not
283          * provided by the offerer of CC. This provides the core with information on
284          * which extension monitor is the most immediate parent of this device.
285          */
286         int parent_interface_id;
287         /*!
288          * \brief Name of device to be monitored
289          *
290          * \details
291          * The device name by which this monitored endpoint will be referred in the
292          * CC core. It is highly recommended that this device name is derived by using
293          * the function ast_channel_get_device_name.
294          */
295         char device_name[AST_CHANNEL_NAME];
296         /*!
297          * \brief Recall dialstring
298          *
299          * \details
300          * Certain channel drivers (DAHDI in particular) will require that a special
301          * dialstring be used to indicate that the outgoing call is to interpreted as
302          * a CC recall. If the channel driver has such a requirement, then this is
303          * where that special recall dialstring is placed. If no special dialstring
304          * is to be used, then the channel driver must provide the original dialstring
305          * used to call this endpoint.
306          */
307         char dialstring[AST_CHANNEL_NAME];
308 };
309
310 /*!
311  * \brief The "tree" of interfaces that is dialed.
312  *
313  * \details
314  * Though this is a linked list, it is logically treated
315  * as a tree of monitors. Each monitor has an id and a parent_id
316  * associated with it. The id is a unique ID for that monitor, and
317  * the parent_id is the unique ID of the monitor's parent in the
318  * tree. The tree is structured such that all of a parent's children
319  * will appear after the parent in the tree. However, it cannot be
320  * guaranteed exactly where after the parent the children are.
321  *
322  * The tree is reference counted since several threads may need
323  * to use it, and it may last beyond the lifetime of a single
324  * thread.
325  */
326 AST_LIST_HEAD(cc_monitor_tree, ast_cc_monitor);
327
328 static const int CC_CORE_INSTANCES_BUCKETS = 17;
329 static struct ao2_container *cc_core_instances;
330
331 struct cc_core_instance {
332         /*!
333          * Unique identifier for this instance of the CC core.
334          */
335         int core_id;
336         /*!
337          * The current state for this instance of the CC core.
338          */
339         enum cc_state current_state;
340         /*!
341          * The CC agent in use for this call
342          */
343         struct ast_cc_agent *agent;
344         /*!
345          * Reference to the monitor tree formed during the initial call
346          */
347         struct cc_monitor_tree *monitors;
348 };
349
350 /*!
351  * \internal
352  * \brief Request that the core change states
353  * \param state The state to which we wish to change
354  * \param core_id The unique identifier for this instance of the CCSS core state machine
355  * \param debug Optional message explaining the reason for the state change
356  * \param ap varargs list
357  * \retval 0 State change successfully queued
358  * \retval -1 Unable to queue state change request
359  */
360 static int __attribute__((format(printf, 3, 0))) cc_request_state_change(enum cc_state state, const int core_id, const char *debug, va_list ap);
361
362 /*!
363  * \internal
364  * \brief create a new instance of the CC core and an agent for the calling channel
365  *
366  * This function will check to make sure that the incoming channel
367  * is allowed to request CC by making sure that the incoming channel
368  * has not exceeded its maximum number of allowed agents.
369  *
370  * Should that check pass, the core instance is created, and then the
371  * agent for the channel.
372  *
373  * \param caller_chan The incoming channel for this particular call
374  * \param called_tree A reference to the tree of called devices. The agent
375  * will gain a reference to this tree as well
376  * \param core_id The core_id that this core_instance will assume
377  * \retval NULL Failed to create the core instance either due to memory allocation
378  * errors or due to the agent count for the caller being too high
379  * \retval non-NULL A reference to the newly created cc_core_instance
380  */
381 static struct cc_core_instance *cc_core_init_instance(struct ast_channel *caller_chan,
382                 struct cc_monitor_tree *called_tree, const int core_id, struct cc_control_payload *cc_data);
383
384 static const struct {
385         enum ast_cc_service_type service;
386         const char *service_string;
387 } cc_service_to_string_map[] = {
388         {AST_CC_NONE, "NONE"},
389         {AST_CC_CCBS, "CCBS"},
390         {AST_CC_CCNR, "CCNR"},
391         {AST_CC_CCNL, "CCNL"},
392 };
393
394 static const struct {
395         enum cc_state state;
396         const char *state_string;
397 } cc_state_to_string_map[] = {
398         {CC_AVAILABLE,          "CC is available"},
399         {CC_CALLER_OFFERED,     "CC offered to caller"},
400         {CC_CALLER_REQUESTED,   "CC requested by caller"},
401         {CC_ACTIVE,             "CC accepted by callee"},
402         {CC_CALLEE_READY,       "Callee has become available"},
403         {CC_CALLER_BUSY,        "Callee was ready, but caller is now unavailable"},
404         {CC_RECALLING,          "Caller is attempting to recall"},
405         {CC_COMPLETE,           "Recall complete"},
406         {CC_FAILED,             "CC has failed"},
407 };
408
409 static const char *cc_state_to_string(enum cc_state state)
410 {
411         return cc_state_to_string_map[state].state_string;
412 }
413
414 static const char *cc_service_to_string(enum ast_cc_service_type service)
415 {
416         return cc_service_to_string_map[service].service_string;
417 }
418
419 static int cc_core_instance_hash_fn(const void *obj, const int flags)
420 {
421         const struct cc_core_instance *core_instance = obj;
422         return core_instance->core_id;
423 }
424
425 static int cc_core_instance_cmp_fn(void *obj, void *arg, int flags)
426 {
427         struct cc_core_instance *core_instance1 = obj;
428         struct cc_core_instance *core_instance2 = arg;
429
430         return core_instance1->core_id == core_instance2->core_id ? CMP_MATCH | CMP_STOP : 0;
431 }
432
433 static struct cc_core_instance *find_cc_core_instance(const int core_id)
434 {
435         struct cc_core_instance finder = {.core_id = core_id,};
436
437         return ao2_t_find(cc_core_instances, &finder, OBJ_POINTER, "Finding a core_instance");
438 }
439
440 struct cc_callback_helper {
441         ao2_callback_fn *function;
442         void *args;
443         const char *type;
444 };
445
446 static int cc_agent_callback_helper(void *obj, void *args, int flags)
447 {
448         struct cc_core_instance *core_instance = obj;
449         struct cc_callback_helper *helper = args;
450
451         if (strcmp(core_instance->agent->callbacks->type, helper->type)) {
452                 return 0;
453         }
454
455         return helper->function(core_instance->agent, helper->args, flags);
456 }
457
458 struct ast_cc_agent *ast_cc_agent_callback(int flags, ao2_callback_fn *function, void *args, const char * const type)
459 {
460         struct cc_callback_helper helper = {.function = function, .args = args, .type = type};
461         struct cc_core_instance *core_instance;
462         if ((core_instance = ao2_t_callback(cc_core_instances, flags, cc_agent_callback_helper, &helper,
463                                         "Calling provided agent callback function"))) {
464                 struct ast_cc_agent *agent = cc_ref(core_instance->agent, "An outside entity needs the agent");
465                 cc_unref(core_instance, "agent callback done with the core_instance");
466                 return agent;
467         }
468         return NULL;
469 }
470
471 enum match_flags {
472         /* Only match agents that have not yet
473          * made a CC request
474          */
475         MATCH_NO_REQUEST = (1 << 0),
476         /* Only match agents that have made
477          * a CC request
478          */
479         MATCH_REQUEST = (1 << 1),
480 };
481
482 /* ao2_callbacks for cc_core_instances */
483
484 /*!
485  * \internal
486  * \brief find a core instance based on its agent
487  *
488  * The match flags tell whether we wish to find core instances
489  * that have a monitor or core instances that do not. Core instances
490  * with no monitor are core instances for which a caller has not yet
491  * requested CC. Core instances with a monitor are ones for which the
492  * caller has requested CC.
493  */
494 static int match_agent(void *obj, void *arg, void *data, int flags)
495 {
496         struct cc_core_instance *core_instance = obj;
497         const char *name = arg;
498         unsigned long match_flags = *(unsigned long *)data;
499         int possible_match = 0;
500
501         if ((match_flags & MATCH_NO_REQUEST) && core_instance->current_state < CC_CALLER_REQUESTED) {
502                 possible_match = 1;
503         }
504
505         if ((match_flags & MATCH_REQUEST) && core_instance->current_state >= CC_CALLER_REQUESTED) {
506                 possible_match = 1;
507         }
508
509         if (!possible_match) {
510                 return 0;
511         }
512
513         if (!strcmp(core_instance->agent->device_name, name)) {
514                 return CMP_MATCH | CMP_STOP;
515         }
516         return 0;
517 }
518
519 struct count_agents_cb_data {
520         int count;
521         int core_id_exception;
522 };
523
524 /*!
525  * \internal
526  * \brief Count the number of agents a specific interface is using
527  *
528  * We're only concerned with the number of agents that have requested
529  * CC, so we restrict our search to core instances which have a non-NULL
530  * monitor pointer
531  */
532 static int count_agents_cb(void *obj, void *arg, void *data, int flags)
533 {
534         struct cc_core_instance *core_instance = obj;
535         const char *name = arg;
536         struct count_agents_cb_data *cb_data = data;
537
538         if (cb_data->core_id_exception == core_instance->core_id) {
539                 ast_log_dynamic_level(cc_logger_level, "Found agent with core_id %d but not counting it toward total\n", core_instance->core_id);
540                 return 0;
541         }
542
543         if (core_instance->current_state >= CC_CALLER_REQUESTED && !strcmp(core_instance->agent->device_name, name)) {
544                 cb_data->count++;
545         }
546         return 0;
547 }
548
549 /* default values mapping from cc_state to ast_dev_state */
550
551 #define CC_AVAILABLE_DEVSTATE_DEFAULT        AST_DEVICE_NOT_INUSE
552 #define CC_CALLER_OFFERED_DEVSTATE_DEFAULT   AST_DEVICE_NOT_INUSE
553 #define CC_CALLER_REQUESTED_DEVSTATE_DEFAULT AST_DEVICE_NOT_INUSE
554 #define CC_ACTIVE_DEVSTATE_DEFAULT           AST_DEVICE_INUSE
555 #define CC_CALLEE_READY_DEVSTATE_DEFAULT     AST_DEVICE_RINGING
556 #define CC_CALLER_BUSY_DEVSTATE_DEFAULT      AST_DEVICE_ONHOLD
557 #define CC_RECALLING_DEVSTATE_DEFAULT        AST_DEVICE_RINGING
558 #define CC_COMPLETE_DEVSTATE_DEFAULT         AST_DEVICE_NOT_INUSE
559 #define CC_FAILED_DEVSTATE_DEFAULT           AST_DEVICE_NOT_INUSE
560
561 /*!
562  * \internal
563  * \brief initialization of defaults for CC_STATE to DEVICE_STATE map
564  */
565 static enum ast_device_state cc_state_to_devstate_map[] = {
566         [CC_AVAILABLE] =        CC_AVAILABLE_DEVSTATE_DEFAULT,
567         [CC_CALLER_OFFERED] =   CC_CALLER_OFFERED_DEVSTATE_DEFAULT,
568         [CC_CALLER_REQUESTED] = CC_CALLER_REQUESTED_DEVSTATE_DEFAULT,
569         [CC_ACTIVE] =           CC_ACTIVE_DEVSTATE_DEFAULT,
570         [CC_CALLEE_READY] =     CC_CALLEE_READY_DEVSTATE_DEFAULT,
571         [CC_CALLER_BUSY] =      CC_CALLER_BUSY_DEVSTATE_DEFAULT,
572         [CC_RECALLING] =        CC_RECALLING_DEVSTATE_DEFAULT,
573         [CC_COMPLETE] =         CC_COMPLETE_DEVSTATE_DEFAULT,
574         [CC_FAILED] =           CC_FAILED_DEVSTATE_DEFAULT,
575 };
576
577 /*!
578  * \internal
579  * \brief lookup the ast_device_state mapped to cc_state
580  *
581  * \param state
582  *
583  * \return the correponding DEVICE STATE from the cc_state_to_devstate_map
584  * when passed an internal state.
585  */
586 static enum ast_device_state cc_state_to_devstate(enum cc_state state)
587 {
588         return cc_state_to_devstate_map[state];
589 }
590
591 /*!
592  * \internal
593  * \brief Callback for devicestate providers
594  *
595  * \details
596  * Initialize with ast_devstate_prov_add() and returns the corresponding
597  * DEVICE STATE based on the current CC_STATE state machine if the requested
598  * device is found and is a generic device. Returns the equivalent of
599  * CC_FAILED, which defaults to NOT_INUSE, if no device is found.  NOT_INUSE would
600  * indicate that there is no presence of any pending call back.
601  */
602 static enum ast_device_state ccss_device_state(const char *device_name)
603 {
604         struct cc_core_instance *core_instance;
605         unsigned long match_flags;
606         enum ast_device_state cc_current_state;
607
608         match_flags = MATCH_NO_REQUEST;
609         core_instance = ao2_t_callback_data(cc_core_instances, 0, match_agent,
610                 (char *) device_name, &match_flags,
611                 "Find Core Instance for ccss_device_state reqeust.");
612         if (!core_instance) {
613                 ast_log_dynamic_level(cc_logger_level,
614                         "Couldn't find a core instance for caller %s\n", device_name);
615                 return cc_state_to_devstate(CC_FAILED);
616         }
617
618         ast_log_dynamic_level(cc_logger_level,
619                 "Core %d: Found core_instance for caller %s in state %s\n",
620                 core_instance->core_id, device_name, cc_state_to_string(core_instance->current_state));
621
622         if (strcmp(core_instance->agent->callbacks->type, "generic")) {
623                 ast_log_dynamic_level(cc_logger_level,
624                         "Core %d: Device State is only for generic agent types.\n",
625                         core_instance->core_id);
626                 cc_unref(core_instance, "Unref core_instance since ccss_device_state was called with native agent");
627                 return cc_state_to_devstate(CC_FAILED);
628         }
629         cc_current_state = cc_state_to_devstate(core_instance->current_state);
630         cc_unref(core_instance, "Unref core_instance done with ccss_device_state");
631         return cc_current_state;
632 }
633
634 /*!
635  * \internal
636  * \brief Notify Device State Changes from CC STATE MACHINE
637  *
638  * \details
639  * Any time a state is changed, we call this function to notify the DEVICE STATE
640  * subsystem of the change so that subscribed phones to any corresponding hints that
641  * are using that state are updated.
642  */
643 static void ccss_notify_device_state_change(const char *device, enum cc_state state)
644 {
645         enum ast_device_state devstate;
646
647         devstate = cc_state_to_devstate(state);
648
649         ast_log_dynamic_level(cc_logger_level,
650                 "Notification of CCSS state change to '%s', device state '%s' for device '%s'\n",
651                 cc_state_to_string(state), ast_devstate2str(devstate), device);
652
653         ast_devstate_changed(devstate, AST_DEVSTATE_CACHABLE, "ccss:%s", device);
654 }
655
656 #define CC_OFFER_TIMER_DEFAULT                  20              /* Seconds */
657 #define CCNR_AVAILABLE_TIMER_DEFAULT    7200    /* Seconds */
658 #define CCBS_AVAILABLE_TIMER_DEFAULT    4800    /* Seconds */
659 #define CC_RECALL_TIMER_DEFAULT                 20              /* Seconds */
660 #define CC_MAX_AGENTS_DEFAULT                   5
661 #define CC_MAX_MONITORS_DEFAULT                 5
662 #define GLOBAL_CC_MAX_REQUESTS_DEFAULT  20
663
664 static const struct ast_cc_config_params cc_default_params = {
665         .cc_agent_policy = AST_CC_AGENT_NEVER,
666         .cc_monitor_policy = AST_CC_MONITOR_NEVER,
667         .cc_offer_timer = CC_OFFER_TIMER_DEFAULT,
668         .ccnr_available_timer = CCNR_AVAILABLE_TIMER_DEFAULT,
669         .ccbs_available_timer = CCBS_AVAILABLE_TIMER_DEFAULT,
670         .cc_recall_timer = CC_RECALL_TIMER_DEFAULT,
671         .cc_max_agents = CC_MAX_AGENTS_DEFAULT,
672         .cc_max_monitors = CC_MAX_MONITORS_DEFAULT,
673         .cc_callback_macro = "",
674         .cc_callback_sub = "",
675         .cc_agent_dialstring = "",
676 };
677
678 void ast_cc_default_config_params(struct ast_cc_config_params *params)
679 {
680         *params = cc_default_params;
681 }
682
683 struct ast_cc_config_params *__ast_cc_config_params_init(const char *file, int line, const char *function)
684 {
685         struct ast_cc_config_params *params = __ast_malloc(sizeof(*params), file, line, function);
686
687         if (!params) {
688                 return NULL;
689         }
690
691         ast_cc_default_config_params(params);
692         return params;
693 }
694
695 void ast_cc_config_params_destroy(struct ast_cc_config_params *params)
696 {
697         ast_free(params);
698 }
699
700 static enum ast_cc_agent_policies str_to_agent_policy(const char * const value)
701 {
702         if (!strcasecmp(value, "never")) {
703                 return AST_CC_AGENT_NEVER;
704         } else if (!strcasecmp(value, "native")) {
705                 return AST_CC_AGENT_NATIVE;
706         } else if (!strcasecmp(value, "generic")) {
707                 return AST_CC_AGENT_GENERIC;
708         } else {
709                 ast_log(LOG_WARNING, "%s is an invalid value for cc_agent_policy. Switching to 'never'\n", value);
710                 return AST_CC_AGENT_NEVER;
711         }
712 }
713
714 static enum ast_cc_monitor_policies str_to_monitor_policy(const char * const value)
715 {
716         if (!strcasecmp(value, "never")) {
717                 return AST_CC_MONITOR_NEVER;
718         } else if (!strcasecmp(value, "native")) {
719                 return AST_CC_MONITOR_NATIVE;
720         } else if (!strcasecmp(value, "generic")) {
721                 return AST_CC_MONITOR_GENERIC;
722         } else if (!strcasecmp(value, "always")) {
723                 return AST_CC_MONITOR_ALWAYS;
724         } else {
725                 ast_log(LOG_WARNING, "%s is an invalid value for cc_monitor_policy. Switching to 'never'\n", value);
726                 return AST_CC_MONITOR_NEVER;
727         }
728 }
729
730 static const char *agent_policy_to_str(enum ast_cc_agent_policies policy)
731 {
732         switch (policy) {
733         case AST_CC_AGENT_NEVER:
734                 return "never";
735         case AST_CC_AGENT_NATIVE:
736                 return "native";
737         case AST_CC_AGENT_GENERIC:
738                 return "generic";
739         default:
740                 /* This should never happen... */
741                 return "";
742         }
743 }
744
745 static const char *monitor_policy_to_str(enum ast_cc_monitor_policies policy)
746 {
747         switch (policy) {
748         case AST_CC_MONITOR_NEVER:
749                 return "never";
750         case AST_CC_MONITOR_NATIVE:
751                 return "native";
752         case AST_CC_MONITOR_GENERIC:
753                 return "generic";
754         case AST_CC_MONITOR_ALWAYS:
755                 return "always";
756         default:
757                 /* This should never happen... */
758                 return "";
759         }
760 }
761 int ast_cc_get_param(struct ast_cc_config_params *params, const char * const name,
762                 char *buf, size_t buf_len)
763 {
764         const char *value = NULL;
765
766         if (!strcasecmp(name, "cc_callback_macro")) {
767                 value = ast_get_cc_callback_macro(params);
768         } else if (!strcasecmp(name, "cc_callback_sub")) {
769                 value = ast_get_cc_callback_sub(params);
770         } else if (!strcasecmp(name, "cc_agent_policy")) {
771                 value = agent_policy_to_str(ast_get_cc_agent_policy(params));
772         } else if (!strcasecmp(name, "cc_monitor_policy")) {
773                 value = monitor_policy_to_str(ast_get_cc_monitor_policy(params));
774         } else if (!strcasecmp(name, "cc_agent_dialstring")) {
775                 value = ast_get_cc_agent_dialstring(params);
776         }
777         if (value) {
778                 ast_copy_string(buf, value, buf_len);
779                 return 0;
780         }
781
782         /* The rest of these are all ints of some sort and require some
783          * snprintf-itude
784          */
785
786         if (!strcasecmp(name, "cc_offer_timer")) {
787                 snprintf(buf, buf_len, "%u", ast_get_cc_offer_timer(params));
788         } else if (!strcasecmp(name, "ccnr_available_timer")) {
789                 snprintf(buf, buf_len, "%u", ast_get_ccnr_available_timer(params));
790         } else if (!strcasecmp(name, "ccbs_available_timer")) {
791                 snprintf(buf, buf_len, "%u", ast_get_ccbs_available_timer(params));
792         } else if (!strcasecmp(name, "cc_max_agents")) {
793                 snprintf(buf, buf_len, "%u", ast_get_cc_max_agents(params));
794         } else if (!strcasecmp(name, "cc_max_monitors")) {
795                 snprintf(buf, buf_len, "%u", ast_get_cc_max_monitors(params));
796         } else if (!strcasecmp(name, "cc_recall_timer")) {
797                 snprintf(buf, buf_len, "%u", ast_get_cc_recall_timer(params));
798         } else {
799                 ast_log(LOG_WARNING, "%s is not a valid CC parameter. Ignoring.\n", name);
800                 return -1;
801         }
802
803         return 0;
804 }
805
806 int ast_cc_set_param(struct ast_cc_config_params *params, const char * const name,
807                 const char * const value)
808 {
809         unsigned int value_as_uint;
810         if (!strcasecmp(name, "cc_agent_policy")) {
811                 return ast_set_cc_agent_policy(params, str_to_agent_policy(value));
812         } else if (!strcasecmp(name, "cc_monitor_policy")) {
813                 return ast_set_cc_monitor_policy(params, str_to_monitor_policy(value));
814         } else if (!strcasecmp(name, "cc_agent_dialstring")) {
815                 ast_set_cc_agent_dialstring(params, value);
816         } else if (!strcasecmp(name, "cc_callback_macro")) {
817                 ast_set_cc_callback_macro(params, value);
818                 return 0;
819         } else if (!strcasecmp(name, "cc_callback_sub")) {
820                 ast_set_cc_callback_sub(params, value);
821                 return 0;
822         }
823
824         if (sscanf(value, "%30u", &value_as_uint) != 1) {
825                 return -1;
826         }
827
828         if (!strcasecmp(name, "cc_offer_timer")) {
829                 ast_set_cc_offer_timer(params, value_as_uint);
830         } else if (!strcasecmp(name, "ccnr_available_timer")) {
831                 ast_set_ccnr_available_timer(params, value_as_uint);
832         } else if (!strcasecmp(name, "ccbs_available_timer")) {
833                 ast_set_ccbs_available_timer(params, value_as_uint);
834         } else if (!strcasecmp(name, "cc_max_agents")) {
835                 ast_set_cc_max_agents(params, value_as_uint);
836         } else if (!strcasecmp(name, "cc_max_monitors")) {
837                 ast_set_cc_max_monitors(params, value_as_uint);
838         } else if (!strcasecmp(name, "cc_recall_timer")) {
839                 ast_set_cc_recall_timer(params, value_as_uint);
840         } else {
841                 ast_log(LOG_WARNING, "%s is not a valid CC parameter. Ignoring.\n", name);
842                 return -1;
843         }
844
845         return 0;
846 }
847
848 int ast_cc_is_config_param(const char * const name)
849 {
850         return (!strcasecmp(name, "cc_agent_policy") ||
851                                 !strcasecmp(name, "cc_monitor_policy") ||
852                                 !strcasecmp(name, "cc_offer_timer") ||
853                                 !strcasecmp(name, "ccnr_available_timer") ||
854                                 !strcasecmp(name, "ccbs_available_timer") ||
855                                 !strcasecmp(name, "cc_max_agents") ||
856                                 !strcasecmp(name, "cc_max_monitors") ||
857                                 !strcasecmp(name, "cc_callback_macro") ||
858                                 !strcasecmp(name, "cc_callback_sub") ||
859                                 !strcasecmp(name, "cc_agent_dialstring") ||
860                                 !strcasecmp(name, "cc_recall_timer"));
861 }
862
863 void ast_cc_copy_config_params(struct ast_cc_config_params *dest, const struct ast_cc_config_params *src)
864 {
865         *dest = *src;
866 }
867
868 enum ast_cc_agent_policies ast_get_cc_agent_policy(struct ast_cc_config_params *config)
869 {
870         return config->cc_agent_policy;
871 }
872
873 int ast_set_cc_agent_policy(struct ast_cc_config_params *config, enum ast_cc_agent_policies value)
874 {
875         /* Screw C and its weak type checking for making me have to do this
876          * validation at runtime.
877          */
878         if (value < AST_CC_AGENT_NEVER || value > AST_CC_AGENT_GENERIC) {
879                 return -1;
880         }
881         config->cc_agent_policy = value;
882         return 0;
883 }
884
885 enum ast_cc_monitor_policies ast_get_cc_monitor_policy(struct ast_cc_config_params *config)
886 {
887         return config->cc_monitor_policy;
888 }
889
890 int ast_set_cc_monitor_policy(struct ast_cc_config_params *config, enum ast_cc_monitor_policies value)
891 {
892         /* Screw C and its weak type checking for making me have to do this
893          * validation at runtime.
894          */
895         if (value < AST_CC_MONITOR_NEVER || value > AST_CC_MONITOR_ALWAYS) {
896                 return -1;
897         }
898         config->cc_monitor_policy = value;
899         return 0;
900 }
901
902 unsigned int ast_get_cc_offer_timer(struct ast_cc_config_params *config)
903 {
904         return config->cc_offer_timer;
905 }
906
907 void ast_set_cc_offer_timer(struct ast_cc_config_params *config, unsigned int value)
908 {
909         /* 0 is an unreasonable value for any timer. Stick with the default */
910         if (value == 0) {
911                 ast_log(LOG_WARNING, "0 is an invalid value for cc_offer_timer. Retaining value as %u\n", config->cc_offer_timer);
912                 return;
913         }
914         config->cc_offer_timer = value;
915 }
916
917 unsigned int ast_get_ccnr_available_timer(struct ast_cc_config_params *config)
918 {
919         return config->ccnr_available_timer;
920 }
921
922 void ast_set_ccnr_available_timer(struct ast_cc_config_params *config, unsigned int value)
923 {
924         /* 0 is an unreasonable value for any timer. Stick with the default */
925         if (value == 0) {
926                 ast_log(LOG_WARNING, "0 is an invalid value for ccnr_available_timer. Retaining value as %u\n", config->ccnr_available_timer);
927                 return;
928         }
929         config->ccnr_available_timer = value;
930 }
931
932 unsigned int ast_get_cc_recall_timer(struct ast_cc_config_params *config)
933 {
934         return config->cc_recall_timer;
935 }
936
937 void ast_set_cc_recall_timer(struct ast_cc_config_params *config, unsigned int value)
938 {
939         /* 0 is an unreasonable value for any timer. Stick with the default */
940         if (value == 0) {
941                 ast_log(LOG_WARNING, "0 is an invalid value for ccnr_available_timer. Retaining value as %u\n", config->cc_recall_timer);
942                 return;
943         }
944         config->cc_recall_timer = value;
945 }
946
947 unsigned int ast_get_ccbs_available_timer(struct ast_cc_config_params *config)
948 {
949         return config->ccbs_available_timer;
950 }
951
952 void ast_set_ccbs_available_timer(struct ast_cc_config_params *config, unsigned int value)
953 {
954         /* 0 is an unreasonable value for any timer. Stick with the default */
955         if (value == 0) {
956                 ast_log(LOG_WARNING, "0 is an invalid value for ccbs_available_timer. Retaining value as %u\n", config->ccbs_available_timer);
957                 return;
958         }
959         config->ccbs_available_timer = value;
960 }
961
962 const char *ast_get_cc_agent_dialstring(struct ast_cc_config_params *config)
963 {
964         return config->cc_agent_dialstring;
965 }
966
967 void ast_set_cc_agent_dialstring(struct ast_cc_config_params *config, const char *const value)
968 {
969         if (ast_strlen_zero(value)) {
970                 config->cc_agent_dialstring[0] = '\0';
971         } else {
972                 ast_copy_string(config->cc_agent_dialstring, value, sizeof(config->cc_agent_dialstring));
973         }
974 }
975
976 unsigned int ast_get_cc_max_agents(struct ast_cc_config_params *config)
977 {
978         return config->cc_max_agents;
979 }
980
981 void ast_set_cc_max_agents(struct ast_cc_config_params *config, unsigned int value)
982 {
983         config->cc_max_agents = value;
984 }
985
986 unsigned int ast_get_cc_max_monitors(struct ast_cc_config_params *config)
987 {
988         return config->cc_max_monitors;
989 }
990
991 void ast_set_cc_max_monitors(struct ast_cc_config_params *config, unsigned int value)
992 {
993         config->cc_max_monitors = value;
994 }
995
996 const char *ast_get_cc_callback_macro(struct ast_cc_config_params *config)
997 {
998         return config->cc_callback_macro;
999 }
1000
1001 const char *ast_get_cc_callback_sub(struct ast_cc_config_params *config)
1002 {
1003         return config->cc_callback_sub;
1004 }
1005
1006 void ast_set_cc_callback_macro(struct ast_cc_config_params *config, const char * const value)
1007 {
1008         ast_log(LOG_WARNING, "Usage of cc_callback_macro is deprecated.  Please use cc_callback_sub instead.\n");
1009         if (ast_strlen_zero(value)) {
1010                 config->cc_callback_macro[0] = '\0';
1011         } else {
1012                 ast_copy_string(config->cc_callback_macro, value, sizeof(config->cc_callback_macro));
1013         }
1014 }
1015
1016 void ast_set_cc_callback_sub(struct ast_cc_config_params *config, const char * const value)
1017 {
1018         if (ast_strlen_zero(value)) {
1019                 config->cc_callback_sub[0] = '\0';
1020         } else {
1021                 ast_copy_string(config->cc_callback_sub, value, sizeof(config->cc_callback_sub));
1022         }
1023 }
1024
1025 static int cc_publish(struct stasis_message_type *message_type, int core_id, struct ast_json *extras)
1026 {
1027         RAII_VAR(struct ast_json *, blob, NULL, ast_json_unref);
1028         RAII_VAR(struct ast_json_payload *, payload, NULL, ao2_cleanup);
1029         RAII_VAR(struct stasis_message *, message, NULL, ao2_cleanup);
1030
1031         if (!message_type) {
1032                 return -1;
1033         }
1034
1035         blob = ast_json_pack("{s: i}",
1036                 "core_id", core_id);
1037         if (!blob) {
1038                 return -1;
1039         }
1040
1041         if (extras) {
1042                 ast_json_object_update(blob, extras);
1043         }
1044
1045         if (!(payload = ast_json_payload_create(blob))) {
1046                 return -1;
1047         }
1048
1049         if (!(message = stasis_message_create(message_type, payload))) {
1050                 return -1;
1051         }
1052
1053         stasis_publish(ast_system_topic(), message);
1054
1055         return 0;
1056 }
1057
1058 static void cc_publish_available(int core_id, const char *callee, const char *service)
1059 {
1060         RAII_VAR(struct ast_json *, extras, NULL, ast_json_unref);
1061
1062         extras = ast_json_pack("{s: s, s: s}",
1063                 "callee", callee,
1064                 "service", service);
1065
1066         cc_publish(ast_cc_available_type(), core_id, extras);
1067 }
1068
1069 static void cc_publish_offertimerstart(int core_id, const char *caller, unsigned int expires)
1070 {
1071         RAII_VAR(struct ast_json *, extras, NULL, ast_json_unref);
1072
1073         extras = ast_json_pack("{s: s, s: i}",
1074                 "caller", caller,
1075                 "expires", expires);
1076
1077         cc_publish(ast_cc_offertimerstart_type(), core_id, extras);
1078 }
1079
1080 static void cc_publish_requested(int core_id, const char *caller, const char *callee)
1081 {
1082         RAII_VAR(struct ast_json *, extras, NULL, ast_json_unref);
1083
1084         extras = ast_json_pack("{s: s, s: s}",
1085                 "caller", caller,
1086                 "callee", callee);
1087
1088         cc_publish(ast_cc_requested_type(), core_id, extras);
1089 }
1090
1091 static void cc_publish_requestacknowledged(int core_id, const char *caller)
1092 {
1093         RAII_VAR(struct ast_json *, extras, NULL, ast_json_unref);
1094
1095         extras = ast_json_pack("{s: s}",
1096                 "caller", caller);
1097
1098         cc_publish(ast_cc_requestacknowledged_type(), core_id, extras);
1099 }
1100
1101 static void cc_publish_callerstopmonitoring(int core_id, const char *caller)
1102 {
1103         RAII_VAR(struct ast_json *, extras, NULL, ast_json_unref);
1104
1105         extras = ast_json_pack("{s: s}",
1106                 "caller", caller);
1107
1108         cc_publish(ast_cc_callerstopmonitoring_type(), core_id, extras);
1109 }
1110
1111 static void cc_publish_callerstartmonitoring(int core_id, const char *caller)
1112 {
1113         RAII_VAR(struct ast_json *, extras, NULL, ast_json_unref);
1114
1115         extras = ast_json_pack("{s: s}",
1116                 "caller", caller);
1117
1118         cc_publish(ast_cc_callerstartmonitoring_type(), core_id, extras);
1119 }
1120
1121 static void cc_publish_callerrecalling(int core_id, const char *caller)
1122 {
1123         RAII_VAR(struct ast_json *, extras, NULL, ast_json_unref);
1124
1125         extras = ast_json_pack("{s: s}",
1126                 "caller", caller);
1127
1128         cc_publish(ast_cc_callerrecalling_type(), core_id, extras);
1129 }
1130
1131 static void cc_publish_recallcomplete(int core_id, const char *caller)
1132 {
1133         RAII_VAR(struct ast_json *, extras, NULL, ast_json_unref);
1134
1135         extras = ast_json_pack("{s: s}",
1136                 "caller", caller);
1137
1138         cc_publish(ast_cc_recallcomplete_type(), core_id, extras);
1139 }
1140
1141 static void cc_publish_failure(int core_id, const char *caller, const char *reason)
1142 {
1143         RAII_VAR(struct ast_json *, extras, NULL, ast_json_unref);
1144
1145         extras = ast_json_pack("{s: s, s: s}",
1146                 "caller", caller,
1147                 "reason", reason);
1148
1149         cc_publish(ast_cc_failure_type(), core_id, extras);
1150 }
1151
1152 static void cc_publish_monitorfailed(int core_id, const char *callee)
1153 {
1154         RAII_VAR(struct ast_json *, extras, NULL, ast_json_unref);
1155
1156         extras = ast_json_pack("{s: s}",
1157                 "callee", callee);
1158
1159         cc_publish(ast_cc_monitorfailed_type(), core_id, extras);
1160 }
1161
1162 struct cc_monitor_backend {
1163         AST_LIST_ENTRY(cc_monitor_backend) next;
1164         const struct ast_cc_monitor_callbacks *callbacks;
1165 };
1166
1167 AST_RWLIST_HEAD_STATIC(cc_monitor_backends, cc_monitor_backend);
1168
1169 int ast_cc_monitor_register(const struct ast_cc_monitor_callbacks *callbacks)
1170 {
1171         struct cc_monitor_backend *backend = ast_calloc(1, sizeof(*backend));
1172
1173         if (!backend) {
1174                 return -1;
1175         }
1176
1177         backend->callbacks = callbacks;
1178
1179         AST_RWLIST_WRLOCK(&cc_monitor_backends);
1180         AST_RWLIST_INSERT_TAIL(&cc_monitor_backends, backend, next);
1181         AST_RWLIST_UNLOCK(&cc_monitor_backends);
1182         return 0;
1183 }
1184
1185 static const struct ast_cc_monitor_callbacks *find_monitor_callbacks(const char * const type)
1186 {
1187         struct cc_monitor_backend *backend;
1188         const struct ast_cc_monitor_callbacks *callbacks = NULL;
1189
1190         AST_RWLIST_RDLOCK(&cc_monitor_backends);
1191         AST_RWLIST_TRAVERSE(&cc_monitor_backends, backend, next) {
1192                 if (!strcmp(backend->callbacks->type, type)) {
1193                         ast_log_dynamic_level(cc_logger_level, "Returning monitor backend %s\n", backend->callbacks->type);
1194                         callbacks = backend->callbacks;
1195                         break;
1196                 }
1197         }
1198         AST_RWLIST_UNLOCK(&cc_monitor_backends);
1199         return callbacks;
1200 }
1201
1202 void ast_cc_monitor_unregister(const struct ast_cc_monitor_callbacks *callbacks)
1203 {
1204         struct cc_monitor_backend *backend;
1205         AST_RWLIST_WRLOCK(&cc_monitor_backends);
1206         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&cc_monitor_backends, backend, next) {
1207                 if (backend->callbacks == callbacks) {
1208                         AST_RWLIST_REMOVE_CURRENT(next);
1209                         ast_free(backend);
1210                         break;
1211                 }
1212         }
1213         AST_RWLIST_TRAVERSE_SAFE_END;
1214         AST_RWLIST_UNLOCK(&cc_monitor_backends);
1215 }
1216
1217 struct cc_agent_backend {
1218         AST_LIST_ENTRY(cc_agent_backend) next;
1219         const struct ast_cc_agent_callbacks *callbacks;
1220 };
1221
1222 AST_RWLIST_HEAD_STATIC(cc_agent_backends, cc_agent_backend);
1223
1224 int ast_cc_agent_register(const struct ast_cc_agent_callbacks *callbacks)
1225 {
1226         struct cc_agent_backend *backend = ast_calloc(1, sizeof(*backend));
1227
1228         if (!backend) {
1229                 return -1;
1230         }
1231
1232         backend->callbacks = callbacks;
1233         AST_RWLIST_WRLOCK(&cc_agent_backends);
1234         AST_RWLIST_INSERT_TAIL(&cc_agent_backends, backend, next);
1235         AST_RWLIST_UNLOCK(&cc_agent_backends);
1236         return 0;
1237 }
1238
1239 void ast_cc_agent_unregister(const struct ast_cc_agent_callbacks *callbacks)
1240 {
1241         struct cc_agent_backend *backend;
1242         AST_RWLIST_WRLOCK(&cc_agent_backends);
1243         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&cc_agent_backends, backend, next) {
1244                 if (backend->callbacks == callbacks) {
1245                         AST_RWLIST_REMOVE_CURRENT(next);
1246                         ast_free(backend);
1247                         break;
1248                 }
1249         }
1250         AST_RWLIST_TRAVERSE_SAFE_END;
1251         AST_RWLIST_UNLOCK(&cc_agent_backends);
1252 }
1253
1254 static const struct ast_cc_agent_callbacks *find_agent_callbacks(struct ast_channel *chan)
1255 {
1256         struct cc_agent_backend *backend;
1257         const struct ast_cc_agent_callbacks *callbacks = NULL;
1258         struct ast_cc_config_params *cc_params;
1259         char type[32];
1260
1261         cc_params = ast_channel_get_cc_config_params(chan);
1262         if (!cc_params) {
1263                 return NULL;
1264         }
1265         switch (ast_get_cc_agent_policy(cc_params)) {
1266         case AST_CC_AGENT_GENERIC:
1267                 ast_copy_string(type, "generic", sizeof(type));
1268                 break;
1269         case AST_CC_AGENT_NATIVE:
1270                 ast_channel_get_cc_agent_type(chan, type, sizeof(type));
1271                 break;
1272         default:
1273                 ast_log_dynamic_level(cc_logger_level, "Not returning agent callbacks since this channel is configured not to have a CC agent\n");
1274                 return NULL;
1275         }
1276
1277         AST_RWLIST_RDLOCK(&cc_agent_backends);
1278         AST_RWLIST_TRAVERSE(&cc_agent_backends, backend, next) {
1279                 if (!strcmp(backend->callbacks->type, type)) {
1280                         ast_log_dynamic_level(cc_logger_level, "Returning agent backend %s\n", backend->callbacks->type);
1281                         callbacks = backend->callbacks;
1282                         break;
1283                 }
1284         }
1285         AST_RWLIST_UNLOCK(&cc_agent_backends);
1286         return callbacks;
1287 }
1288
1289 /*!
1290  * \internal
1291  * \brief Determine if the given device state is considered available by generic CCSS.
1292  * \since 1.8
1293  *
1294  * \param state Device state to test.
1295  *
1296  * \return TRUE if the given device state is considered available by generic CCSS.
1297  */
1298 static int cc_generic_is_device_available(enum ast_device_state state)
1299 {
1300         return state == AST_DEVICE_NOT_INUSE || state == AST_DEVICE_UNKNOWN;
1301 }
1302
1303 static int cc_generic_monitor_request_cc(struct ast_cc_monitor *monitor, int *available_timer_id);
1304 static int cc_generic_monitor_suspend(struct ast_cc_monitor *monitor);
1305 static int cc_generic_monitor_unsuspend(struct ast_cc_monitor *monitor);
1306 static int cc_generic_monitor_cancel_available_timer(struct ast_cc_monitor *monitor, int *sched_id);
1307 static void cc_generic_monitor_destructor(void *private_data);
1308
1309 static struct ast_cc_monitor_callbacks generic_monitor_cbs = {
1310         .type = "generic",
1311         .request_cc = cc_generic_monitor_request_cc,
1312         .suspend = cc_generic_monitor_suspend,
1313         .unsuspend = cc_generic_monitor_unsuspend,
1314         .cancel_available_timer = cc_generic_monitor_cancel_available_timer,
1315         .destructor = cc_generic_monitor_destructor,
1316 };
1317
1318 struct ao2_container *generic_monitors;
1319
1320 struct generic_monitor_instance {
1321         int core_id;
1322         int is_suspended;
1323         int monitoring;
1324         AST_LIST_ENTRY(generic_monitor_instance) next;
1325 };
1326
1327 struct generic_monitor_instance_list {
1328         const char *device_name;
1329         enum ast_device_state current_state;
1330         /* If there are multiple instances monitoring the
1331          * same device and one should fail, we need to know
1332          * whether to signal that the device can be recalled.
1333          * The problem is that the device state is not enough
1334          * to check. If a caller has requested CCNR, then the
1335          * fact that the device is available does not indicate
1336          * that the device is ready to be recalled. Instead, as
1337          * soon as one instance of the monitor becomes available
1338          * for a recall, we mark the entire list as being fit
1339          * for recall. If a CCNR request comes in, then we will
1340          * have to mark the list as unfit for recall since this
1341          * is a clear indicator that the person at the monitored
1342          * device has gone away and is actuall not fit to be
1343          * recalled
1344          */
1345         int fit_for_recall;
1346         struct stasis_subscription *sub;
1347         AST_LIST_HEAD_NOLOCK(, generic_monitor_instance) list;
1348 };
1349
1350 /*!
1351  * \brief private data for generic device monitor
1352  */
1353 struct generic_monitor_pvt {
1354         /*!
1355          * We need the device name during destruction so we
1356          * can find the appropriate item to destroy.
1357          */
1358         const char *device_name;
1359         /*!
1360          * We need the core ID for similar reasons. Once we
1361          * find the appropriate item in our ao2_container, we
1362          * need to remove the appropriate cc_monitor from the
1363          * list of monitors.
1364          */
1365         int core_id;
1366 };
1367
1368 static int generic_monitor_hash_fn(const void *obj, const int flags)
1369 {
1370         const struct generic_monitor_instance_list *generic_list = obj;
1371         return ast_str_hash(generic_list->device_name);
1372 }
1373
1374 static int generic_monitor_cmp_fn(void *obj, void *arg, int flags)
1375 {
1376         const struct generic_monitor_instance_list *generic_list1 = obj;
1377         const struct generic_monitor_instance_list *generic_list2 = arg;
1378
1379         return !strcmp(generic_list1->device_name, generic_list2->device_name) ? CMP_MATCH | CMP_STOP : 0;
1380 }
1381
1382 static struct generic_monitor_instance_list *find_generic_monitor_instance_list(const char * const device_name)
1383 {
1384         struct generic_monitor_instance_list finder = {0};
1385         char *uppertech = ast_strdupa(device_name);
1386         ast_tech_to_upper(uppertech);
1387         finder.device_name = uppertech;
1388
1389         return ao2_t_find(generic_monitors, &finder, OBJ_POINTER, "Finding generic monitor instance list");
1390 }
1391
1392 static void generic_monitor_instance_list_destructor(void *obj)
1393 {
1394         struct generic_monitor_instance_list *generic_list = obj;
1395         struct generic_monitor_instance *generic_instance;
1396
1397         generic_list->sub = stasis_unsubscribe(generic_list->sub);
1398         while ((generic_instance = AST_LIST_REMOVE_HEAD(&generic_list->list, next))) {
1399                 ast_free(generic_instance);
1400         }
1401         ast_free((char *)generic_list->device_name);
1402 }
1403
1404 static void generic_monitor_devstate_cb(void *userdata, struct stasis_subscription *sub, struct stasis_message *msg);
1405 static struct generic_monitor_instance_list *create_new_generic_list(struct ast_cc_monitor *monitor)
1406 {
1407         struct generic_monitor_instance_list *generic_list = ao2_t_alloc(sizeof(*generic_list),
1408                         generic_monitor_instance_list_destructor, "allocate generic monitor instance list");
1409         char * device_name;
1410         struct stasis_topic *device_specific_topic;
1411
1412         if (!generic_list) {
1413                 return NULL;
1414         }
1415
1416         if (!(device_name = ast_strdup(monitor->interface->device_name))) {
1417                 cc_unref(generic_list, "Failed to strdup the monitor's device name");
1418                 return NULL;
1419         }
1420         ast_tech_to_upper(device_name);
1421         generic_list->device_name = device_name;
1422
1423         device_specific_topic = ast_device_state_topic(device_name);
1424         if (!device_specific_topic) {
1425                 return NULL;
1426         }
1427
1428         if (!(generic_list->sub = stasis_subscribe(device_specific_topic, generic_monitor_devstate_cb, NULL))) {
1429                 cc_unref(generic_list, "Failed to subscribe to device state");
1430                 return NULL;
1431         }
1432         generic_list->current_state = ast_device_state(monitor->interface->device_name);
1433         ao2_t_link(generic_monitors, generic_list, "linking new generic monitor instance list");
1434         return generic_list;
1435 }
1436
1437 static int generic_monitor_devstate_tp_cb(void *data)
1438 {
1439         RAII_VAR(struct ast_device_state_message *, dev_state, data, ao2_cleanup);
1440         enum ast_device_state new_state = dev_state->state;
1441         enum ast_device_state previous_state;
1442         struct generic_monitor_instance_list *generic_list;
1443         struct generic_monitor_instance *generic_instance;
1444
1445         if (!(generic_list = find_generic_monitor_instance_list(dev_state->device))) {
1446                 /* The most likely cause for this is that we destroyed the monitor in the
1447                  * time between subscribing to its device state and the time this executes.
1448                  * Not really a big deal.
1449                  */
1450                 return 0;
1451         }
1452
1453         if (generic_list->current_state == new_state) {
1454                 /* The device state hasn't actually changed, so we don't really care */
1455                 cc_unref(generic_list, "Kill reference of generic list in devstate taskprocessor callback");
1456                 return 0;
1457         }
1458
1459         previous_state = generic_list->current_state;
1460         generic_list->current_state = new_state;
1461
1462         if (cc_generic_is_device_available(new_state) &&
1463                         (previous_state == AST_DEVICE_INUSE || previous_state == AST_DEVICE_UNAVAILABLE ||
1464                          previous_state == AST_DEVICE_BUSY)) {
1465                 AST_LIST_TRAVERSE(&generic_list->list, generic_instance, next) {
1466                         if (!generic_instance->is_suspended && generic_instance->monitoring) {
1467                                 generic_instance->monitoring = 0;
1468                                 generic_list->fit_for_recall = 1;
1469                                 ast_cc_monitor_callee_available(generic_instance->core_id, "Generic monitored party has become available");
1470                                 break;
1471                         }
1472                 }
1473         }
1474         cc_unref(generic_list, "Kill reference of generic list in devstate taskprocessor callback");
1475         return 0;
1476 }
1477
1478 static void generic_monitor_devstate_cb(void *userdata, struct stasis_subscription *sub, struct stasis_message *msg)
1479 {
1480         /* Wow, it's cool that we've picked up on a state change, but we really want
1481          * the actual work to be done in the core's taskprocessor execution thread
1482          * so that all monitor operations can be serialized. Locks?! We don't need
1483          * no steenkin' locks!
1484          */
1485         struct ast_device_state_message *dev_state;
1486         if (ast_device_state_message_type() != stasis_message_type(msg)) {
1487                 return;
1488         }
1489
1490         dev_state = stasis_message_data(msg);
1491         if (dev_state->eid) {
1492                 /* ignore non-aggregate states */
1493                 return;
1494         }
1495
1496         ao2_t_ref(dev_state, +1, "Bumping dev_state ref for cc_core_taskprocessor");
1497         if (ast_taskprocessor_push(cc_core_taskprocessor, generic_monitor_devstate_tp_cb, dev_state)) {
1498                 ao2_cleanup(dev_state);
1499                 return;
1500         }
1501 }
1502
1503 int ast_cc_available_timer_expire(const void *data)
1504 {
1505         struct ast_cc_monitor *monitor = (struct ast_cc_monitor *) data;
1506         int res;
1507         monitor->available_timer_id = -1;
1508         res = ast_cc_monitor_failed(monitor->core_id, monitor->interface->device_name, "Available timer expired for monitor");
1509         cc_unref(monitor, "Unref reference from scheduler\n");
1510         return res;
1511 }
1512
1513 static int cc_generic_monitor_request_cc(struct ast_cc_monitor *monitor, int *available_timer_id)
1514 {
1515         struct generic_monitor_instance_list *generic_list;
1516         struct generic_monitor_instance *generic_instance;
1517         struct generic_monitor_pvt *gen_mon_pvt;
1518         enum ast_cc_service_type service = monitor->service_offered;
1519         int when;
1520
1521         /* First things first. Native channel drivers will have their private data allocated
1522          * at the time that they tell the core that they can offer CC. Generic is quite a bit
1523          * different, and we wait until this point to allocate our private data.
1524          */
1525         if (!(gen_mon_pvt = ast_calloc(1, sizeof(*gen_mon_pvt)))) {
1526                 return -1;
1527         }
1528
1529         if (!(gen_mon_pvt->device_name = ast_strdup(monitor->interface->device_name))) {
1530                 ast_free(gen_mon_pvt);
1531                 return -1;
1532         }
1533
1534         gen_mon_pvt->core_id = monitor->core_id;
1535
1536         monitor->private_data = gen_mon_pvt;
1537
1538         if (!(generic_list = find_generic_monitor_instance_list(monitor->interface->device_name))) {
1539                 if (!(generic_list = create_new_generic_list(monitor))) {
1540                         return -1;
1541                 }
1542         }
1543
1544         if (!(generic_instance = ast_calloc(1, sizeof(*generic_instance)))) {
1545                 /* The generic monitor destructor will take care of the appropriate
1546                  * deallocations
1547                  */
1548                 cc_unref(generic_list, "Generic monitor instance failed to allocate");
1549                 return -1;
1550         }
1551         generic_instance->core_id = monitor->core_id;
1552         generic_instance->monitoring = 1;
1553         AST_LIST_INSERT_TAIL(&generic_list->list, generic_instance, next);
1554         when = service == AST_CC_CCBS ? ast_get_ccbs_available_timer(monitor->interface->config_params) :
1555                 ast_get_ccnr_available_timer(monitor->interface->config_params);
1556
1557         *available_timer_id = ast_sched_add(cc_sched_context, when * 1000,
1558                         ast_cc_available_timer_expire, cc_ref(monitor, "Give the scheduler a monitor reference"));
1559         if (*available_timer_id == -1) {
1560                 cc_unref(monitor, "Failed to schedule available timer. (monitor)");
1561                 cc_unref(generic_list, "Failed to schedule available timer. (generic_list)");
1562                 return -1;
1563         }
1564         /* If the new instance was created as CCNR, then that means this device is not currently
1565          * fit for recall even if it previously was.
1566          */
1567         if (service == AST_CC_CCNR || service == AST_CC_CCNL) {
1568                 generic_list->fit_for_recall = 0;
1569         }
1570         ast_cc_monitor_request_acked(monitor->core_id, "Generic monitor for %s subscribed to device state.",
1571                         monitor->interface->device_name);
1572         cc_unref(generic_list, "Finished with monitor instance reference in request cc callback");
1573         return 0;
1574 }
1575
1576 static int cc_generic_monitor_suspend(struct ast_cc_monitor *monitor)
1577 {
1578         struct generic_monitor_instance_list *generic_list;
1579         struct generic_monitor_instance *generic_instance;
1580         enum ast_device_state state = ast_device_state(monitor->interface->device_name);
1581
1582         if (!(generic_list = find_generic_monitor_instance_list(monitor->interface->device_name))) {
1583                 return -1;
1584         }
1585
1586         /* First we need to mark this particular monitor as being suspended. */
1587         AST_LIST_TRAVERSE(&generic_list->list, generic_instance, next) {
1588                 if (generic_instance->core_id == monitor->core_id) {
1589                         generic_instance->is_suspended = 1;
1590                         break;
1591                 }
1592         }
1593
1594         /* If the device being suspended is currently in use, then we don't need to
1595          * take any further actions
1596          */
1597         if (!cc_generic_is_device_available(state)) {
1598                 cc_unref(generic_list, "Device is in use. Nothing to do. Unref generic list.");
1599                 return 0;
1600         }
1601
1602         /* If the device is not in use, though, then it may be possible to report the
1603          * device's availability using a different monitor which is monitoring the
1604          * same device
1605          */
1606
1607         AST_LIST_TRAVERSE(&generic_list->list, generic_instance, next) {
1608                 if (!generic_instance->is_suspended) {
1609                         ast_cc_monitor_callee_available(generic_instance->core_id, "Generic monitored party has become available");
1610                         break;
1611                 }
1612         }
1613         cc_unref(generic_list, "Done with generic list in suspend callback");
1614         return 0;
1615 }
1616
1617 static int cc_generic_monitor_unsuspend(struct ast_cc_monitor *monitor)
1618 {
1619         struct generic_monitor_instance *generic_instance;
1620         struct generic_monitor_instance_list *generic_list = find_generic_monitor_instance_list(monitor->interface->device_name);
1621         enum ast_device_state state = ast_device_state(monitor->interface->device_name);
1622
1623         if (!generic_list) {
1624                 return -1;
1625         }
1626         /* If the device is currently available, we can immediately announce
1627          * its availability
1628          */
1629         if (cc_generic_is_device_available(state)) {
1630                 ast_cc_monitor_callee_available(monitor->core_id, "Generic monitored party has become available");
1631         }
1632
1633         /* In addition, we need to mark this generic_monitor_instance as not being suspended anymore */
1634         AST_LIST_TRAVERSE(&generic_list->list, generic_instance, next) {
1635                 if (generic_instance->core_id == monitor->core_id) {
1636                         generic_instance->is_suspended = 0;
1637                         generic_instance->monitoring = 1;
1638                         break;
1639                 }
1640         }
1641         cc_unref(generic_list, "Done with generic list in cc_generic_monitor_unsuspend");
1642         return 0;
1643 }
1644
1645 static int cc_generic_monitor_cancel_available_timer(struct ast_cc_monitor *monitor, int *sched_id)
1646 {
1647         ast_assert(sched_id != NULL);
1648
1649         if (*sched_id == -1) {
1650                 return 0;
1651         }
1652
1653         ast_log_dynamic_level(cc_logger_level, "Core %d: Canceling generic monitor available timer for monitor %s\n",
1654                         monitor->core_id, monitor->interface->device_name);
1655         if (!ast_sched_del(cc_sched_context, *sched_id)) {
1656                 cc_unref(monitor, "Remove scheduler's reference to the monitor");
1657         }
1658         *sched_id = -1;
1659         return 0;
1660 }
1661
1662 static void cc_generic_monitor_destructor(void *private_data)
1663 {
1664         struct generic_monitor_pvt *gen_mon_pvt = private_data;
1665         struct generic_monitor_instance_list *generic_list;
1666         struct generic_monitor_instance *generic_instance;
1667
1668         if (!private_data) {
1669                 /* If the private data is NULL, that means that the monitor hasn't even
1670                  * been created yet, but that the destructor was called. While this sort
1671                  * of behavior is useful for native monitors, with a generic one, there is
1672                  * nothing in particular to do.
1673                  */
1674                 return;
1675         }
1676
1677         ast_log_dynamic_level(cc_logger_level, "Core %d: Destroying generic monitor %s\n",
1678                         gen_mon_pvt->core_id, gen_mon_pvt->device_name);
1679
1680         if (!(generic_list = find_generic_monitor_instance_list(gen_mon_pvt->device_name))) {
1681                 /* If there's no generic list, that means that the monitor is being destroyed
1682                  * before we actually got to request CC. Not a biggie. Same in the situation
1683                  * below if the list traversal should complete without finding an entry.
1684                  */
1685                 ast_free((char *)gen_mon_pvt->device_name);
1686                 ast_free(gen_mon_pvt);
1687                 return;
1688         }
1689
1690         AST_LIST_TRAVERSE_SAFE_BEGIN(&generic_list->list, generic_instance, next) {
1691                 if (generic_instance->core_id == gen_mon_pvt->core_id) {
1692                         AST_LIST_REMOVE_CURRENT(next);
1693                         ast_free(generic_instance);
1694                         break;
1695                 }
1696         }
1697         AST_LIST_TRAVERSE_SAFE_END;
1698
1699         if (AST_LIST_EMPTY(&generic_list->list)) {
1700                 /* No more monitors with this device name exist. Time to unlink this
1701                  * list from the container
1702                  */
1703                 ao2_t_unlink(generic_monitors, generic_list, "Generic list is empty. Unlink it from the container");
1704         } else {
1705                 /* There are still instances for this particular device. The situation
1706                  * may be that we were attempting a CC recall and a failure occurred, perhaps
1707                  * on the agent side. If a failure happens here and the device being monitored
1708                  * is available, then we need to signal on the first unsuspended instance that
1709                  * the device is available for recall.
1710                  */
1711
1712                 /* First things first. We don't even want to consider this action if
1713                  * the device in question isn't available right now.
1714                  */
1715                 if (generic_list->fit_for_recall
1716                         && cc_generic_is_device_available(generic_list->current_state)) {
1717                         AST_LIST_TRAVERSE(&generic_list->list, generic_instance, next) {
1718                                 if (!generic_instance->is_suspended && generic_instance->monitoring) {
1719                                         ast_cc_monitor_callee_available(generic_instance->core_id, "Signaling generic monitor "
1720                                                         "availability due to other instance's failure.");
1721                                         break;
1722                                 }
1723                         }
1724                 }
1725         }
1726         cc_unref(generic_list, "Done with generic list in generic monitor destructor");
1727         ast_free((char *)gen_mon_pvt->device_name);
1728         ast_free(gen_mon_pvt);
1729 }
1730
1731 static void cc_interface_destroy(void *data)
1732 {
1733         struct ast_cc_interface *interface = data;
1734         ast_log_dynamic_level(cc_logger_level, "Destroying cc interface %s\n", interface->device_name);
1735         ast_cc_config_params_destroy(interface->config_params);
1736 }
1737
1738 /*!
1739  * \brief Data regarding an extension monitor's child's dialstrings
1740  *
1741  * \details
1742  * In developing CCSS, we had most aspects of its operation finished,
1743  * but there was one looming problem that we had failed to get right.
1744  * In our design document, we stated that when a CC recall occurs, all
1745  * endpoints that had been dialed originally would be called back.
1746  * Unfortunately, our implementation only allowed for devices which had
1747  * active monitors to inhabit the CC_INTERFACES channel variable, thus
1748  * making the automated recall only call monitored devices.
1749  *
1750  * Devices that were not CC-capable, or devices which failed CC at some
1751  * point during the process would not make it into the CC_INTERFACES
1752  * channel variable. This struct is meant as a remedy for the problem.
1753  */
1754 struct extension_child_dialstring {
1755         /*!
1756          * \brief the original dialstring used to call a particular device
1757          *
1758          * \details
1759          * When someone dials a particular endpoint, the dialstring used in
1760          * the dialplan is copied into this buffer. What's important here is
1761          * that this is the ORIGINAL dialstring, not the dialstring saved on
1762          * a device monitor. The dialstring on a device monitor is what should
1763          * be used when recalling that device. The two dialstrings may not be
1764          * the same.
1765          *
1766          * By keeping a copy of the original dialstring used, we can fall back
1767          * to using it if the device either does not ever offer CC or if the
1768          * device at some point fails for some reason, such as a timer expiration.
1769          */
1770         char original_dialstring[AST_CHANNEL_NAME];
1771         /*!
1772          * \brief The name of the device being dialed
1773          *
1774          * \details
1775          * This serves mainly as a key when searching for a particular dialstring.
1776          * For instance, let's say that we have called device SIP/400\@somepeer. This
1777          * device offers call completion, but then due to some unforeseen circumstance,
1778          * this device backs out and makes CC unavailable. When that happens, we need
1779          * to find the dialstring that corresponds to that device, and we use the
1780          * stored device name as a way to find it.
1781          *
1782          * \note There is one particular case where the device name stored here
1783          * will be empty. This is the case where we fail to request a channel, but we
1784          * still can make use of generic call completion. In such a case, since we never
1785          * were able to request the channel, we can't find what its device name is. In
1786          * this case, however, it is not important because the dialstring is guaranteed
1787          * to be the same both here and in the device monitor.
1788          */
1789         char device_name[AST_CHANNEL_NAME];
1790         /*!
1791          * \brief Is this structure valid for use in CC_INTERFACES?
1792          *
1793          * \details
1794          * When this structure is first created, all information stored here is planned
1795          * to be used, so we set the is_valid flag. However, if a device offers call
1796          * completion, it will potentially have its own dialstring to use for the recall,
1797          * so we find this structure and clear the is_valid flag. By clearing the is_valid
1798          * flag, we won't try to populate the CC_INTERFACES variable with the dialstring
1799          * stored in this struct. Now, if later, the device which had offered CC should fail,
1800          * perhaps due to a timer expiration, then we need to re-set the is_valid flag. This
1801          * way, we still will end up placing a call to the device again, and the dialstring
1802          * used will be the same as was originally used.
1803          */
1804         int is_valid;
1805         AST_LIST_ENTRY(extension_child_dialstring) next;
1806 };
1807
1808 /*!
1809  * \brief Private data for an extension monitor
1810  */
1811 struct extension_monitor_pvt {
1812         AST_LIST_HEAD_NOLOCK(, extension_child_dialstring) child_dialstrings;
1813 };
1814
1815 static void cc_extension_monitor_destructor(void *private_data)
1816 {
1817         struct extension_monitor_pvt *extension_pvt = private_data;
1818         struct extension_child_dialstring *child_dialstring;
1819
1820         /* This shouldn't be possible, but I'm paranoid */
1821         if (!extension_pvt) {
1822                 return;
1823         }
1824
1825         while ((child_dialstring = AST_LIST_REMOVE_HEAD(&extension_pvt->child_dialstrings, next))) {
1826                 ast_free(child_dialstring);
1827         }
1828         ast_free(extension_pvt);
1829 }
1830
1831 static void cc_monitor_destroy(void *data)
1832 {
1833         struct ast_cc_monitor *monitor = data;
1834         /* During the monitor creation process, it is possible for this
1835          * function to be called prior to when callbacks are assigned
1836          * to the monitor. Also, extension monitors do not have callbacks
1837          * assigned to them, so we wouldn't want to segfault when we try
1838          * to destroy one of them.
1839          */
1840         ast_log_dynamic_level(cc_logger_level, "Core %d: Calling destructor for monitor %s\n",
1841                         monitor->core_id, monitor->interface->device_name);
1842         if (monitor->interface->monitor_class == AST_CC_EXTENSION_MONITOR) {
1843                 cc_extension_monitor_destructor(monitor->private_data);
1844         }
1845         if (monitor->callbacks) {
1846                 monitor->callbacks->destructor(monitor->private_data);
1847         }
1848         cc_unref(monitor->interface, "Unreffing tree's reference to interface");
1849         ast_free(monitor->dialstring);
1850 }
1851
1852 static void cc_interface_tree_destroy(void *data)
1853 {
1854         struct cc_monitor_tree *cc_interface_tree = data;
1855         struct ast_cc_monitor *monitor;
1856         while ((monitor = AST_LIST_REMOVE_HEAD(cc_interface_tree, next))) {
1857                 if (monitor->callbacks) {
1858                         monitor->callbacks->cancel_available_timer(monitor, &monitor->available_timer_id);
1859                 }
1860                 cc_unref(monitor, "Destroying all monitors");
1861         }
1862         AST_LIST_HEAD_DESTROY(cc_interface_tree);
1863 }
1864
1865 /*!
1866  * This counter is used for assigning unique ids
1867  * to CC-enabled dialed interfaces.
1868  */
1869 static int dialed_cc_interface_counter;
1870
1871 /*!
1872  * \internal
1873  * \brief data stored in CC datastore
1874  *
1875  * The datastore creates a list of interfaces that were
1876  * dialed, including both extensions and devices. In addition
1877  * to the intrinsic data of the tree, some extra information
1878  * is needed for use by app_dial.
1879  */
1880 struct dialed_cc_interfaces {
1881         /*!
1882          * This value serves a dual-purpose. When dial starts, if the
1883          * dialed_cc_interfaces datastore currently exists on the calling
1884          * channel, then the dial_parent_id will serve as a means of
1885          * letting the new extension cc_monitor we create know
1886          * who his parent is. This value will be the extension
1887          * cc_monitor that dialed the local channel that resulted
1888          * in the new Dial app being called.
1889          *
1890          * In addition, once an extension cc_monitor is created,
1891          * the dial_parent_id will be changed to the id of that newly
1892          * created interface. This way, device interfaces created from
1893          * receiving AST_CONTROL_CC frames can use this field to determine
1894          * who their parent extension interface should be.
1895          */
1896         unsigned int dial_parent_id;
1897         /*!
1898          * Identifier for the potential CC request that may be made
1899          * based on this call. Even though an instance of the core may
1900          * not be made (since the caller may not request CC), we allocate
1901          * a new core_id at the beginning of the call so that recipient
1902          * channel drivers can have the information handy just in case
1903          * the caller does end up requesting CC.
1904          */
1905         int core_id;
1906         /*!
1907          * When a new Dial application is started, and the datastore
1908          * already exists on the channel, we can determine if we
1909          * should be adding any new interface information to tree.
1910          */
1911         char ignore;
1912         /*!
1913          * When it comes time to offer CC to the caller, we only want to offer
1914          * it to the original incoming channel. For nested Dials and outbound
1915          * channels, it is incorrect to attempt such a thing. This flag indicates
1916          * if the channel to which this datastore is attached may be legally
1917          * offered CC when the call is finished.
1918          */
1919         char is_original_caller;
1920         /*!
1921          * Reference-counted "tree" of interfaces.
1922          */
1923         struct cc_monitor_tree *interface_tree;
1924 };
1925
1926 /*!
1927  * \internal
1928  * \brief Destructor function for cc_interfaces datastore
1929  *
1930  * This function will free the actual datastore and drop
1931  * the refcount for the monitor tree by one. In cases
1932  * where CC can actually be used, this unref will not
1933  * result in the destruction of the monitor tree, because
1934  * the CC core will still have a reference.
1935  *
1936  * \param data The dialed_cc_interfaces struct to destroy
1937  */
1938 static void dialed_cc_interfaces_destroy(void *data)
1939 {
1940         struct dialed_cc_interfaces *cc_interfaces = data;
1941         cc_unref(cc_interfaces->interface_tree, "Unref dial's ref to monitor tree");
1942         ast_free(cc_interfaces);
1943 }
1944
1945 /*!
1946  * \internal
1947  * \brief Duplicate callback for cc_interfaces datastore
1948  *
1949  * Integers are copied by value, but the monitor tree
1950  * is done via a shallow copy and a bump of the refcount.
1951  * This way, sub-Dials will be appending interfaces onto
1952  * the same list as this call to Dial.
1953  *
1954  * \param data The old dialed_cc_interfaces we want to copy
1955  * \retval NULL Could not allocate memory for new dialed_cc_interfaces
1956  * \retval non-NULL The new copy of the dialed_cc_interfaces
1957  */
1958 static void *dialed_cc_interfaces_duplicate(void *data)
1959 {
1960         struct dialed_cc_interfaces *old_cc_interfaces = data;
1961         struct dialed_cc_interfaces *new_cc_interfaces = ast_calloc(1, sizeof(*new_cc_interfaces));
1962         if (!new_cc_interfaces) {
1963                 return NULL;
1964         }
1965         new_cc_interfaces->ignore = old_cc_interfaces->ignore;
1966         new_cc_interfaces->dial_parent_id = old_cc_interfaces->dial_parent_id;
1967         new_cc_interfaces->is_original_caller = 0;
1968         cc_ref(old_cc_interfaces->interface_tree, "New ref due to duplication of monitor tree");
1969         new_cc_interfaces->core_id = old_cc_interfaces->core_id;
1970         new_cc_interfaces->interface_tree = old_cc_interfaces->interface_tree;
1971         return new_cc_interfaces;
1972 }
1973
1974 /*!
1975  * \internal
1976  * \brief information regarding the dialed_cc_interfaces datastore
1977  *
1978  * The dialed_cc_interfaces datastore is responsible for keeping track
1979  * of what CC-enabled interfaces have been dialed by the caller. For
1980  * more information regarding the actual structure of the tree, see
1981  * the documentation provided in include/asterisk/ccss.h
1982  */
1983 static const struct ast_datastore_info dialed_cc_interfaces_info = {
1984         .type = "Dial CC Interfaces",
1985         .duplicate = dialed_cc_interfaces_duplicate,
1986         .destroy = dialed_cc_interfaces_destroy,
1987 };
1988
1989 static struct extension_monitor_pvt *extension_monitor_pvt_init(void)
1990 {
1991         struct extension_monitor_pvt *ext_pvt = ast_calloc(1, sizeof(*ext_pvt));
1992         if (!ext_pvt) {
1993                 return NULL;
1994         }
1995         AST_LIST_HEAD_INIT_NOLOCK(&ext_pvt->child_dialstrings);
1996         return ext_pvt;
1997 }
1998
1999 void ast_cc_extension_monitor_add_dialstring(struct ast_channel *incoming, const char * const dialstring, const char * const device_name)
2000 {
2001         struct ast_datastore *cc_datastore;
2002         struct dialed_cc_interfaces *cc_interfaces;
2003         struct ast_cc_monitor *monitor;
2004         struct extension_monitor_pvt *extension_pvt;
2005         struct extension_child_dialstring *child_dialstring;
2006         struct cc_monitor_tree *interface_tree;
2007         int id;
2008
2009         ast_channel_lock(incoming);
2010         if (!(cc_datastore = ast_channel_datastore_find(incoming, &dialed_cc_interfaces_info, NULL))) {
2011                 ast_channel_unlock(incoming);
2012                 return;
2013         }
2014
2015         cc_interfaces = cc_datastore->data;
2016         interface_tree = cc_interfaces->interface_tree;
2017         id = cc_interfaces->dial_parent_id;
2018         ast_channel_unlock(incoming);
2019
2020         AST_LIST_LOCK(interface_tree);
2021         AST_LIST_TRAVERSE(interface_tree, monitor, next) {
2022                 if (monitor->id == id) {
2023                         break;
2024                 }
2025         }
2026
2027         if (!monitor) {
2028                 AST_LIST_UNLOCK(interface_tree);
2029                 return;
2030         }
2031
2032         extension_pvt = monitor->private_data;
2033         if (!(child_dialstring = ast_calloc(1, sizeof(*child_dialstring)))) {
2034                 AST_LIST_UNLOCK(interface_tree);
2035                 return;
2036         }
2037         ast_copy_string(child_dialstring->original_dialstring, dialstring, sizeof(child_dialstring->original_dialstring));
2038         ast_copy_string(child_dialstring->device_name, device_name, sizeof(child_dialstring->device_name));
2039         child_dialstring->is_valid = 1;
2040         AST_LIST_INSERT_TAIL(&extension_pvt->child_dialstrings, child_dialstring, next);
2041         AST_LIST_UNLOCK(interface_tree);
2042 }
2043
2044 static void cc_extension_monitor_change_is_valid(struct cc_core_instance *core_instance, unsigned int parent_id, const char * const device_name, int is_valid)
2045 {
2046         struct ast_cc_monitor *monitor_iter;
2047         struct extension_monitor_pvt *extension_pvt;
2048         struct extension_child_dialstring *child_dialstring;
2049
2050         AST_LIST_TRAVERSE(core_instance->monitors, monitor_iter, next) {
2051                 if (monitor_iter->id == parent_id) {
2052                         break;
2053                 }
2054         }
2055
2056         if (!monitor_iter) {
2057                 return;
2058         }
2059         extension_pvt = monitor_iter->private_data;
2060
2061         AST_LIST_TRAVERSE(&extension_pvt->child_dialstrings, child_dialstring, next) {
2062                 if (!strcmp(child_dialstring->device_name, device_name)) {
2063                         child_dialstring->is_valid = is_valid;
2064                         break;
2065                 }
2066         }
2067 }
2068
2069 /*!
2070  * \internal
2071  * \brief Allocate and initialize an "extension" interface for CC purposes
2072  *
2073  * When app_dial starts, this function is called in order to set up the
2074  * information about the extension in which this Dial is occurring. Any
2075  * devices dialed will have this particular cc_monitor as a parent.
2076  *
2077  * \param exten Extension from which Dial is occurring
2078  * \param context Context to which exten belongs
2079  * \param parent_id What should we set the parent_id of this interface to?
2080  * \retval NULL Memory allocation failure
2081  * \retval non-NULL The newly-created cc_monitor for the extension
2082  */
2083 static struct ast_cc_monitor *cc_extension_monitor_init(const char * const exten, const char * const context, const unsigned int parent_id)
2084 {
2085         struct ast_str *str = ast_str_alloca(2 * AST_MAX_EXTENSION);
2086         struct ast_cc_interface *cc_interface;
2087         struct ast_cc_monitor *monitor;
2088
2089         ast_str_set(&str, 0, "%s@%s", exten, context);
2090
2091         if (!(cc_interface = ao2_t_alloc(sizeof(*cc_interface) + ast_str_strlen(str), cc_interface_destroy,
2092                                         "Allocating new ast_cc_interface"))) {
2093                 return NULL;
2094         }
2095
2096         if (!(monitor = ao2_t_alloc(sizeof(*monitor), cc_monitor_destroy, "Allocating new ast_cc_monitor"))) {
2097                 cc_unref(cc_interface, "failed to allocate the monitor, so unref the interface");
2098                 return NULL;
2099         }
2100
2101         if (!(monitor->private_data = extension_monitor_pvt_init())) {
2102                 cc_unref(monitor, "Failed to initialize extension monitor private data. uref monitor");
2103                 cc_unref(cc_interface, "Failed to initialize extension monitor private data. unref cc_interface");
2104         }
2105
2106         monitor->id = ast_atomic_fetchadd_int(&dialed_cc_interface_counter, +1);
2107         monitor->parent_id = parent_id;
2108         cc_interface->monitor_type = "extension";
2109         cc_interface->monitor_class = AST_CC_EXTENSION_MONITOR;
2110         strcpy(cc_interface->device_name, ast_str_buffer(str));
2111         monitor->interface = cc_interface;
2112         ast_log_dynamic_level(cc_logger_level, "Created an extension cc interface for '%s' with id %u and parent %u\n", cc_interface->device_name, monitor->id, monitor->parent_id);
2113         return monitor;
2114 }
2115
2116 /*!
2117  * \internal
2118  * \brief allocate dialed_cc_interfaces datastore and initialize fields
2119  *
2120  * This function is called when Situation 1 occurs in ast_cc_call_init.
2121  * See that function for more information on what Situation 1 is.
2122  *
2123  * In this particular case, we have to do a lot of memory allocation in order
2124  * to create the datastore, the data for the datastore, the tree of interfaces
2125  * that we'll be adding to, and the initial extension interface for this Dial
2126  * attempt.
2127  *
2128  * \param chan The channel onto which the datastore should be added.
2129  * \retval -1 An error occurred
2130  * \retval 0 Success
2131  */
2132 static int cc_interfaces_datastore_init(struct ast_channel *chan) {
2133         struct dialed_cc_interfaces *interfaces;
2134         struct ast_cc_monitor *monitor;
2135         struct ast_datastore *dial_cc_datastore;
2136
2137         /*XXX This may be a bit controversial. In an attempt to not allocate
2138          * extra resources, I make sure that a future request will be within
2139          * limits. The problem here is that it is reasonable to think that
2140          * even if we're not within the limits at this point, we may be by
2141          * the time the requestor will have made his request. This may be
2142          * deleted at some point.
2143          */
2144         if (!ast_cc_request_is_within_limits()) {
2145                 return 0;
2146         }
2147
2148         if (!(interfaces = ast_calloc(1, sizeof(*interfaces)))) {
2149                 return -1;
2150         }
2151
2152         if (!(monitor = cc_extension_monitor_init(S_OR(ast_channel_macroexten(chan), ast_channel_exten(chan)), S_OR(ast_channel_macrocontext(chan), ast_channel_context(chan)), 0))) {
2153                 ast_free(interfaces);
2154                 return -1;
2155         }
2156
2157         if (!(dial_cc_datastore = ast_datastore_alloc(&dialed_cc_interfaces_info, NULL))) {
2158                 cc_unref(monitor, "Could not allocate the dialed interfaces datastore. Unreffing monitor");
2159                 ast_free(interfaces);
2160                 return -1;
2161         }
2162
2163         if (!(interfaces->interface_tree = ao2_t_alloc(sizeof(*interfaces->interface_tree), cc_interface_tree_destroy,
2164                                         "Allocate monitor tree"))) {
2165                 ast_datastore_free(dial_cc_datastore);
2166                 cc_unref(monitor, "Could not allocate monitor tree on dialed interfaces datastore. Unreffing monitor");
2167                 ast_free(interfaces);
2168                 return -1;
2169         }
2170
2171         /* Finally, all that allocation is done... */
2172         AST_LIST_HEAD_INIT(interfaces->interface_tree);
2173         AST_LIST_INSERT_TAIL(interfaces->interface_tree, monitor, next);
2174         cc_ref(monitor, "List's reference to extension monitor");
2175         dial_cc_datastore->data = interfaces;
2176         dial_cc_datastore->inheritance = DATASTORE_INHERIT_FOREVER;
2177         interfaces->dial_parent_id = monitor->id;
2178         interfaces->core_id = monitor->core_id = ast_atomic_fetchadd_int(&core_id_counter, +1);
2179         interfaces->is_original_caller = 1;
2180         ast_channel_lock(chan);
2181         ast_channel_datastore_add(chan, dial_cc_datastore);
2182         ast_channel_unlock(chan);
2183         cc_unref(monitor, "Unreffing allocation's reference");
2184         return 0;
2185 }
2186
2187 /*!
2188  * \internal
2189  * \brief  Call a monitor's destructor before the monitor has been allocated
2190  * \since 1.8
2191  *
2192  * \param monitor_type The type of monitor callbacks to use when calling the destructor
2193  * \param private_data Data allocated by a channel driver that must be freed
2194  *
2195  * \details
2196  * I'll admit, this is a bit evil.
2197  *
2198  * When a channel driver determines that it can offer a call completion service to
2199  * a caller, it is very likely that the channel driver will need to allocate some
2200  * data so that when the time comes to request CC, the channel driver will have the
2201  * necessary data at hand.
2202  *
2203  * The problem is that there are many places where failures may occur before the monitor
2204  * has been properly allocated and had its callbacks assigned to it. If one of these
2205  * failures should occur, then we still need to let the channel driver know that it
2206  * must destroy the data that it allocated.
2207  *
2208  * \return Nothing
2209  */
2210 static void call_destructor_with_no_monitor(const char * const monitor_type, void *private_data)
2211 {
2212         const struct ast_cc_monitor_callbacks *monitor_callbacks = find_monitor_callbacks(monitor_type);
2213
2214         if (!monitor_callbacks) {
2215                 return;
2216         }
2217
2218         monitor_callbacks->destructor(private_data);
2219 }
2220
2221 /*!
2222  * \internal
2223  * \brief Allocate and intitialize a device cc_monitor
2224  *
2225  * For all intents and purposes, this is the same as
2226  * cc_extension_monitor_init, except that there is only
2227  * a single parameter used for naming the interface.
2228  *
2229  * This function is called when handling AST_CONTROL_CC frames.
2230  * The device has reported that CC is possible, so we add it
2231  * to the interface_tree.
2232  *
2233  * Note that it is not necessarily erroneous to add the same
2234  * device to the tree twice. If the same device is called by
2235  * two different extension during the same call, then
2236  * that is a legitimate situation.
2237  *
2238  * \param device_name The name of the device being added to the tree
2239  * \param dialstring The dialstring used to dial the device being added
2240  * \param parent_id The parent of this new tree node.
2241  * \retval NULL Memory allocation failure
2242  * \retval non-NULL The new ast_cc_interface created.
2243  */
2244 static struct ast_cc_monitor *cc_device_monitor_init(const char * const device_name, const char * const dialstring, const struct cc_control_payload *cc_data, int core_id)
2245 {
2246         struct ast_cc_interface *cc_interface;
2247         struct ast_cc_monitor *monitor;
2248         size_t device_name_len = strlen(device_name);
2249         int parent_id = cc_data->parent_interface_id;
2250
2251         if (!(cc_interface = ao2_t_alloc(sizeof(*cc_interface) + device_name_len, cc_interface_destroy,
2252                                         "Allocating new ast_cc_interface"))) {
2253                 return NULL;
2254         }
2255
2256         if (!(cc_interface->config_params = ast_cc_config_params_init())) {
2257                 cc_unref(cc_interface, "Failed to allocate config params, unref interface");
2258                 return NULL;
2259         }
2260
2261         if (!(monitor = ao2_t_alloc(sizeof(*monitor), cc_monitor_destroy, "Allocating new ast_cc_monitor"))) {
2262                 cc_unref(cc_interface, "Failed to allocate monitor, unref interface");
2263                 return NULL;
2264         }
2265
2266         if (!(monitor->dialstring = ast_strdup(dialstring))) {
2267                 cc_unref(monitor, "Failed to copy dialable name. Unref monitor");
2268                 cc_unref(cc_interface, "Failed to copy dialable name");
2269                 return NULL;
2270         }
2271
2272         if (!(monitor->callbacks = find_monitor_callbacks(cc_data->monitor_type))) {
2273                 cc_unref(monitor, "Failed to find monitor callbacks. Unref monitor");
2274                 cc_unref(cc_interface, "Failed to find monitor callbacks");
2275                 return NULL;
2276         }
2277
2278         strcpy(cc_interface->device_name, device_name);
2279         monitor->id = ast_atomic_fetchadd_int(&dialed_cc_interface_counter, +1);
2280         monitor->parent_id = parent_id;
2281         monitor->core_id = core_id;
2282         monitor->service_offered = cc_data->service;
2283         monitor->private_data = cc_data->private_data;
2284         cc_interface->monitor_type = cc_data->monitor_type;
2285         cc_interface->monitor_class = AST_CC_DEVICE_MONITOR;
2286         monitor->interface = cc_interface;
2287         monitor->available_timer_id = -1;
2288         ast_cc_copy_config_params(cc_interface->config_params, &cc_data->config_params);
2289         ast_log_dynamic_level(cc_logger_level, "Core %d: Created a device cc interface for '%s' with id %u and parent %u\n",
2290                         monitor->core_id, cc_interface->device_name, monitor->id, monitor->parent_id);
2291         return monitor;
2292 }
2293
2294 /*!
2295  * \details
2296  * Unless we are ignoring CC for some reason, we will always
2297  * call this function when we read an AST_CONTROL_CC frame
2298  * from an outbound channel.
2299  *
2300  * This function will call cc_device_monitor_init to
2301  * create the new cc_monitor for the device from which
2302  * we read the frame. In addition, the new device will be added
2303  * to the monitor tree on the dialed_cc_interfaces datastore
2304  * on the inbound channel.
2305  *
2306  * If this is the first AST_CONTROL_CC frame that we have handled
2307  * for this call, then we will also initialize the CC core for
2308  * this call.
2309  */
2310 void ast_handle_cc_control_frame(struct ast_channel *inbound, struct ast_channel *outbound, void *frame_data)
2311 {
2312         char *device_name;
2313         char *dialstring;
2314         struct ast_cc_monitor *monitor;
2315         struct ast_datastore *cc_datastore;
2316         struct dialed_cc_interfaces *cc_interfaces;
2317         struct cc_control_payload *cc_data = frame_data;
2318         struct cc_core_instance *core_instance;
2319
2320         device_name = cc_data->device_name;
2321         dialstring = cc_data->dialstring;
2322
2323         ast_channel_lock(inbound);
2324         if (!(cc_datastore = ast_channel_datastore_find(inbound, &dialed_cc_interfaces_info, NULL))) {
2325                 ast_log(LOG_WARNING, "Unable to retrieve CC datastore while processing CC frame from '%s'. CC services will be unavailable.\n", device_name);
2326                 ast_channel_unlock(inbound);
2327                 call_destructor_with_no_monitor(cc_data->monitor_type, cc_data->private_data);
2328                 return;
2329         }
2330
2331         cc_interfaces = cc_datastore->data;
2332
2333         if (cc_interfaces->ignore) {
2334                 ast_channel_unlock(inbound);
2335                 call_destructor_with_no_monitor(cc_data->monitor_type, cc_data->private_data);
2336                 return;
2337         }
2338
2339         if (!cc_interfaces->is_original_caller) {
2340                 /* If the is_original_caller is not set on the *inbound* channel, then
2341                  * it must be a local channel. As such, we do not want to create a core instance
2342                  * or an agent for the local channel. Instead, we want to pass this along to the
2343                  * other side of the local channel so that the original caller can benefit.
2344                  */
2345                 ast_channel_unlock(inbound);
2346                 ast_indicate_data(inbound, AST_CONTROL_CC, cc_data, sizeof(*cc_data));
2347                 return;
2348         }
2349
2350         core_instance = find_cc_core_instance(cc_interfaces->core_id);
2351         if (!core_instance) {
2352                 core_instance = cc_core_init_instance(inbound, cc_interfaces->interface_tree,
2353                         cc_interfaces->core_id, cc_data);
2354                 if (!core_instance) {
2355                         cc_interfaces->ignore = 1;
2356                         ast_channel_unlock(inbound);
2357                         call_destructor_with_no_monitor(cc_data->monitor_type, cc_data->private_data);
2358                         return;
2359                 }
2360         }
2361
2362         ast_channel_unlock(inbound);
2363
2364         /* Yeah this kind of sucks, but luckily most people
2365          * aren't dialing thousands of interfaces on every call
2366          *
2367          * This traversal helps us to not create duplicate monitors in
2368          * case a device queues multiple CC control frames.
2369          */
2370         AST_LIST_LOCK(cc_interfaces->interface_tree);
2371         AST_LIST_TRAVERSE(cc_interfaces->interface_tree, monitor, next) {
2372                 if (!strcmp(monitor->interface->device_name, device_name)) {
2373                         ast_log_dynamic_level(cc_logger_level, "Core %d: Device %s sent us multiple CC control frames. Ignoring those beyond the first.\n",
2374                                         core_instance->core_id, device_name);
2375                         AST_LIST_UNLOCK(cc_interfaces->interface_tree);
2376                         cc_unref(core_instance, "Returning early from ast_handle_cc_control_frame. Unref core_instance");
2377                         call_destructor_with_no_monitor(cc_data->monitor_type, cc_data->private_data);
2378                         return;
2379                 }
2380         }
2381         AST_LIST_UNLOCK(cc_interfaces->interface_tree);
2382
2383         if (!(monitor = cc_device_monitor_init(device_name, dialstring, cc_data, core_instance->core_id))) {
2384                 ast_log(LOG_WARNING, "Unable to create CC device interface for '%s'. CC services will be unavailable on this interface.\n", device_name);
2385                 cc_unref(core_instance, "Returning early from ast_handle_cc_control_frame. Unref core_instance");
2386                 call_destructor_with_no_monitor(cc_data->monitor_type, cc_data->private_data);
2387                 return;
2388         }
2389
2390         AST_LIST_LOCK(cc_interfaces->interface_tree);
2391         cc_ref(monitor, "monitor tree's reference to the monitor");
2392         AST_LIST_INSERT_TAIL(cc_interfaces->interface_tree, monitor, next);
2393         AST_LIST_UNLOCK(cc_interfaces->interface_tree);
2394
2395         cc_extension_monitor_change_is_valid(core_instance, monitor->parent_id, monitor->interface->device_name, 0);
2396
2397         cc_publish_available(cc_interfaces->core_id, device_name, cc_service_to_string(cc_data->service));
2398
2399         cc_unref(core_instance, "Done with core_instance after handling CC control frame");
2400         cc_unref(monitor, "Unref reference from allocating monitor");
2401 }
2402
2403 int ast_cc_call_init(struct ast_channel *chan, int *ignore_cc)
2404 {
2405         /* There are three situations to deal with here:
2406          *
2407          * 1. The channel does not have a dialed_cc_interfaces datastore on
2408          * it. This means that this is the first time that Dial has
2409          * been called. We need to create/initialize the datastore.
2410          *
2411          * 2. The channel does have a cc_interface datastore on it and
2412          * the "ignore" indicator is 0. This means that a Local channel
2413          * was called by a "parent" dial. We can check the datastore's
2414          * parent field to see who the root of this particular dial tree
2415          * is.
2416          *
2417          * 3. The channel does have a cc_interface datastore on it and
2418          * the "ignore" indicator is 1. This means that a second Dial call
2419          * is being made from an extension. In this case, we do not
2420          * want to make any additions/modifications to the datastore. We
2421          * will instead set a flag to indicate that CCSS is completely
2422          * disabled for this Dial attempt.
2423          */
2424
2425         struct ast_datastore *cc_interfaces_datastore;
2426         struct dialed_cc_interfaces *interfaces;
2427         struct ast_cc_monitor *monitor;
2428         struct ast_cc_config_params *cc_params;
2429
2430         ast_channel_lock(chan);
2431
2432         cc_params = ast_channel_get_cc_config_params(chan);
2433         if (!cc_params) {
2434                 ast_channel_unlock(chan);
2435                 return -1;
2436         }
2437         if (ast_get_cc_agent_policy(cc_params) == AST_CC_AGENT_NEVER) {
2438                 /* We can't offer CC to this caller anyway, so don't bother with CC on this call
2439                  */
2440                 *ignore_cc = 1;
2441                 ast_channel_unlock(chan);
2442                 ast_log_dynamic_level(cc_logger_level, "Agent policy for %s is 'never'. CC not possible\n", ast_channel_name(chan));
2443                 return 0;
2444         }
2445
2446         if (!(cc_interfaces_datastore = ast_channel_datastore_find(chan, &dialed_cc_interfaces_info, NULL))) {
2447                 /* Situation 1 has occurred */
2448                 ast_channel_unlock(chan);
2449                 return cc_interfaces_datastore_init(chan);
2450         }
2451         interfaces = cc_interfaces_datastore->data;
2452         ast_channel_unlock(chan);
2453
2454         if (interfaces->ignore) {
2455                 /* Situation 3 has occurred */
2456                 *ignore_cc = 1;
2457                 ast_log_dynamic_level(cc_logger_level, "Datastore is present with ignore flag set. Ignoring CC offers on this call\n");
2458                 return 0;
2459         }
2460
2461         /* Situation 2 has occurred */
2462         if (!(monitor = cc_extension_monitor_init(S_OR(ast_channel_macroexten(chan), ast_channel_exten(chan)),
2463                         S_OR(ast_channel_macrocontext(chan), ast_channel_context(chan)), interfaces->dial_parent_id))) {
2464                 return -1;
2465         }
2466         monitor->core_id = interfaces->core_id;
2467         AST_LIST_LOCK(interfaces->interface_tree);
2468         cc_ref(monitor, "monitor tree's reference to the monitor");
2469         AST_LIST_INSERT_TAIL(interfaces->interface_tree, monitor, next);
2470         AST_LIST_UNLOCK(interfaces->interface_tree);
2471         interfaces->dial_parent_id = monitor->id;
2472         cc_unref(monitor, "Unref monitor's allocation reference");
2473         return 0;
2474 }
2475
2476 int ast_cc_request_is_within_limits(void)
2477 {
2478         return cc_request_count < global_cc_max_requests;
2479 }
2480
2481 int ast_cc_get_current_core_id(struct ast_channel *chan)
2482 {
2483         struct ast_datastore *datastore;
2484         struct dialed_cc_interfaces *cc_interfaces;
2485         int core_id_return;
2486
2487         ast_channel_lock(chan);
2488         if (!(datastore = ast_channel_datastore_find(chan, &dialed_cc_interfaces_info, NULL))) {
2489                 ast_channel_unlock(chan);
2490                 return -1;
2491         }
2492
2493         cc_interfaces = datastore->data;
2494         core_id_return = cc_interfaces->ignore ? -1 : cc_interfaces->core_id;
2495         ast_channel_unlock(chan);
2496         return core_id_return;
2497
2498 }
2499
2500 static long count_agents(const char * const caller, const int core_id_exception)
2501 {
2502         struct count_agents_cb_data data = {.core_id_exception = core_id_exception,};
2503
2504         ao2_t_callback_data(cc_core_instances, OBJ_NODATA, count_agents_cb, (char *)caller, &data, "Counting agents");
2505         ast_log_dynamic_level(cc_logger_level, "Counted %d agents\n", data.count);
2506         return data.count;
2507 }
2508
2509 static void kill_duplicate_offers(char *caller)
2510 {
2511         unsigned long match_flags = MATCH_NO_REQUEST;
2512         struct ao2_iterator *dups_iter;
2513
2514         /*
2515          * Must remove the ref that was in cc_core_instances outside of
2516          * the container lock to prevent deadlock.
2517          */
2518         dups_iter = ao2_t_callback_data(cc_core_instances, OBJ_MULTIPLE | OBJ_UNLINK,
2519                 match_agent, caller, &match_flags, "Killing duplicate offers");
2520         if (dups_iter) {
2521                 /* Now actually unref any duplicate offers by simply destroying the iterator. */
2522                 ao2_iterator_destroy(dups_iter);
2523         }
2524 }
2525
2526 static void check_callback_sanity(const struct ast_cc_agent_callbacks *callbacks)
2527 {
2528         ast_assert(callbacks->init != NULL);
2529         ast_assert(callbacks->start_offer_timer != NULL);
2530         ast_assert(callbacks->stop_offer_timer != NULL);
2531         ast_assert(callbacks->respond != NULL);
2532         ast_assert(callbacks->status_request != NULL);
2533         ast_assert(callbacks->start_monitoring != NULL);
2534         ast_assert(callbacks->callee_available != NULL);
2535         ast_assert(callbacks->destructor != NULL);
2536 }
2537
2538 static void agent_destroy(void *data)
2539 {
2540         struct ast_cc_agent *agent = data;
2541
2542         if (agent->callbacks) {
2543                 agent->callbacks->destructor(agent);
2544         }
2545         ast_cc_config_params_destroy(agent->cc_params);
2546 }
2547
2548 static struct ast_cc_agent *cc_agent_init(struct ast_channel *caller_chan,
2549                 const char * const caller_name, const int core_id,
2550                 struct cc_monitor_tree *interface_tree)
2551 {
2552         struct ast_cc_agent *agent;
2553         struct ast_cc_config_params *cc_params;
2554
2555         if (!(agent = ao2_t_alloc(sizeof(*agent) + strlen(caller_name), agent_destroy,
2556                                         "Allocating new ast_cc_agent"))) {
2557                 return NULL;
2558         }
2559
2560         agent->core_id = core_id;
2561         strcpy(agent->device_name, caller_name);
2562
2563         cc_params = ast_channel_get_cc_config_params(caller_chan);
2564         if (!cc_params) {
2565                 cc_unref(agent, "Could not get channel config params.");
2566                 return NULL;
2567         }
2568         if (!(agent->cc_params = ast_cc_config_params_init())) {
2569                 cc_unref(agent, "Could not init agent config params.");
2570                 return NULL;
2571         }
2572         ast_cc_copy_config_params(agent->cc_params, cc_params);
2573
2574         if (!(agent->callbacks = find_agent_callbacks(caller_chan))) {
2575                 cc_unref(agent, "Could not find agent callbacks.");
2576                 return NULL;
2577         }
2578         check_callback_sanity(agent->callbacks);
2579
2580         if (agent->callbacks->init(agent, caller_chan)) {
2581                 cc_unref(agent, "Agent init callback failed.");
2582                 return NULL;
2583         }
2584         ast_log_dynamic_level(cc_logger_level, "Core %u: Created an agent for caller %s\n",
2585                         agent->core_id, agent->device_name);
2586         return agent;
2587 }
2588
2589 /* Generic agent callbacks */
2590 static int cc_generic_agent_init(struct ast_cc_agent *agent, struct ast_channel *chan);
2591 static int cc_generic_agent_start_offer_timer(struct ast_cc_agent *agent);
2592 static int cc_generic_agent_stop_offer_timer(struct ast_cc_agent *agent);
2593 static void cc_generic_agent_respond(struct ast_cc_agent *agent, enum ast_cc_agent_response_reason reason);
2594 static int cc_generic_agent_status_request(struct ast_cc_agent *agent);
2595 static int cc_generic_agent_stop_ringing(struct ast_cc_agent *agent);
2596 static int cc_generic_agent_start_monitoring(struct ast_cc_agent *agent);
2597 static int cc_generic_agent_recall(struct ast_cc_agent *agent);
2598 static void cc_generic_agent_destructor(struct ast_cc_agent *agent);
2599
2600 static struct ast_cc_agent_callbacks generic_agent_callbacks = {
2601         .type = "generic",
2602         .init = cc_generic_agent_init,
2603         .start_offer_timer = cc_generic_agent_start_offer_timer,
2604         .stop_offer_timer = cc_generic_agent_stop_offer_timer,
2605         .respond = cc_generic_agent_respond,
2606         .status_request = cc_generic_agent_status_request,
2607         .stop_ringing = cc_generic_agent_stop_ringing,
2608         .start_monitoring = cc_generic_agent_start_monitoring,
2609         .callee_available = cc_generic_agent_recall,
2610         .destructor = cc_generic_agent_destructor,
2611 };
2612
2613 struct cc_generic_agent_pvt {
2614         /*!
2615          * Subscription to device state
2616          *
2617          * Used in the CC_CALLER_BUSY state. The
2618          * generic agent will subscribe to the
2619          * device state of the caller in order to
2620          * determine when we may move on
2621          */
2622         struct stasis_subscription *sub;
2623         /*!
2624          * Scheduler id of offer timer.
2625          */
2626         int offer_timer_id;
2627         /*!
2628          * Caller ID number
2629          *
2630          * When we re-call the caller, we need
2631          * to provide this information to
2632          * ast_request_and_dial so that the
2633          * information will be present in the
2634          * call to the callee
2635          */
2636         char cid_num[AST_CHANNEL_NAME];
2637         /*!
2638          * Caller ID name
2639          *
2640          * See the description of cid_num.
2641          * The same applies here, except this
2642          * is the caller's name.
2643          */
2644         char cid_name[AST_CHANNEL_NAME];
2645         /*!
2646          * Extension dialed
2647          *
2648          * The original extension dialed. This is used
2649          * so that when performing a recall, we can
2650          * call the proper extension.
2651          */
2652         char exten[AST_CHANNEL_NAME];
2653         /*!
2654          * Context dialed
2655          *
2656          * The original context dialed. This is used
2657          * so that when performaing a recall, we can
2658          * call into the proper context
2659          */
2660         char context[AST_CHANNEL_NAME];
2661 };
2662
2663 static int cc_generic_agent_init(struct ast_cc_agent *agent, struct ast_channel *chan)
2664 {
2665         struct cc_generic_agent_pvt *generic_pvt = ast_calloc(1, sizeof(*generic_pvt));
2666
2667         if (!generic_pvt) {
2668                 return -1;
2669         }
2670
2671         generic_pvt->offer_timer_id = -1;
2672         if (ast_channel_caller(chan)->id.number.valid && ast_channel_caller(chan)->id.number.str) {
2673                 ast_copy_string(generic_pvt->cid_num, ast_channel_caller(chan)->id.number.str, sizeof(generic_pvt->cid_num));
2674         }
2675         if (ast_channel_caller(chan)->id.name.valid && ast_channel_caller(chan)->id.name.str) {
2676                 ast_copy_string(generic_pvt->cid_name, ast_channel_caller(chan)->id.name.str, sizeof(generic_pvt->cid_name));
2677         }
2678         ast_copy_string(generic_pvt->exten, S_OR(ast_channel_macroexten(chan), ast_channel_exten(chan)), sizeof(generic_pvt->exten));
2679         ast_copy_string(generic_pvt->context, S_OR(ast_channel_macrocontext(chan), ast_channel_context(chan)), sizeof(generic_pvt->context));
2680         agent->private_data = generic_pvt;
2681         ast_set_flag(agent, AST_CC_AGENT_SKIP_OFFER);
2682         return 0;
2683 }
2684
2685 static int offer_timer_expire(const void *data)
2686 {
2687         struct ast_cc_agent *agent = (struct ast_cc_agent *) data;
2688         struct cc_generic_agent_pvt *agent_pvt = agent->private_data;
2689         ast_log_dynamic_level(cc_logger_level, "Core %u: Queuing change request because offer timer has expired.\n",
2690                         agent->core_id);
2691         agent_pvt->offer_timer_id = -1;
2692         ast_cc_failed(agent->core_id, "Generic agent %s offer timer expired", agent->device_name);
2693         cc_unref(agent, "Remove scheduler's reference to the agent");
2694         return 0;
2695 }
2696
2697 static int cc_generic_agent_start_offer_timer(struct ast_cc_agent *agent)
2698 {
2699         int when;
2700         int sched_id;
2701         struct cc_generic_agent_pvt *generic_pvt = agent->private_data;
2702
2703         ast_assert(cc_sched_context != NULL);
2704         ast_assert(agent->cc_params != NULL);
2705
2706         when = ast_get_cc_offer_timer(agent->cc_params) * 1000;
2707         ast_log_dynamic_level(cc_logger_level, "Core %u: About to schedule offer timer expiration for %d ms\n",
2708                         agent->core_id, when);
2709         if ((sched_id = ast_sched_add(cc_sched_context, when, offer_timer_expire, cc_ref(agent, "Give scheduler an agent ref"))) == -1) {
2710                 return -1;
2711         }
2712         generic_pvt->offer_timer_id = sched_id;
2713         return 0;
2714 }
2715
2716 static int cc_generic_agent_stop_offer_timer(struct ast_cc_agent *agent)
2717 {
2718         struct cc_generic_agent_pvt *generic_pvt = agent->private_data;
2719
2720         if (generic_pvt->offer_timer_id != -1) {
2721                 if (!ast_sched_del(cc_sched_context, generic_pvt->offer_timer_id)) {
2722                         cc_unref(agent, "Remove scheduler's reference to the agent");
2723                 }
2724                 generic_pvt->offer_timer_id = -1;
2725         }
2726         return 0;
2727 }
2728
2729 static void cc_generic_agent_respond(struct ast_cc_agent *agent, enum ast_cc_agent_response_reason reason)
2730 {
2731         /* The generic agent doesn't have to do anything special to
2732          * acknowledge a CC request. Just return.
2733          */
2734         return;
2735 }
2736
2737 static int cc_generic_agent_status_request(struct ast_cc_agent *agent)
2738 {
2739         ast_cc_agent_status_response(agent->core_id, ast_device_state(agent->device_name));
2740         return 0;
2741 }
2742
2743 static int cc_generic_agent_stop_ringing(struct ast_cc_agent *agent)
2744 {
2745         struct ast_channel *recall_chan = ast_channel_get_by_name_prefix(agent->device_name, strlen(agent->device_name));
2746
2747         if (!recall_chan) {
2748                 return 0;
2749         }
2750
2751         ast_softhangup(recall_chan, AST_SOFTHANGUP_EXPLICIT);
2752         return 0;
2753 }
2754
2755 static void generic_agent_devstate_cb(void *userdata, struct stasis_subscription *sub, struct stasis_message *msg)
2756 {
2757         struct ast_cc_agent *agent = userdata;
2758         enum ast_device_state new_state;
2759         struct ast_device_state_message *dev_state;
2760         struct cc_generic_agent_pvt *generic_pvt = agent->private_data;
2761
2762         if (stasis_subscription_final_message(sub, msg)) {
2763                 cc_unref(agent, "Done holding ref for subscription");
2764                 return;
2765         } else if (ast_device_state_message_type() != stasis_message_type(msg)) {
2766                 return;
2767         }
2768
2769         dev_state = stasis_message_data(msg);
2770         if (dev_state->eid) {
2771                 /* ignore non-aggregate states */
2772                 return;
2773         }
2774
2775         new_state = dev_state->state;
2776         if (!cc_generic_is_device_available(new_state)) {
2777                 /* Not interested in this new state of the device.  It is still busy. */
2778                 return;
2779         }
2780
2781         generic_pvt->sub = stasis_unsubscribe(sub);
2782         ast_cc_agent_caller_available(agent->core_id, "%s is no longer busy", agent->device_name);
2783 }
2784
2785 static int cc_generic_agent_start_monitoring(struct ast_cc_agent *agent)
2786 {
2787         struct cc_generic_agent_pvt *generic_pvt = agent->private_data;
2788         struct ast_str *str = ast_str_alloca(128);
2789         struct stasis_topic *device_specific_topic;
2790
2791         ast_assert(generic_pvt->sub == NULL);
2792         ast_str_set(&str, 0, "Agent monitoring %s device state since it is busy\n",
2793                 agent->device_name);
2794
2795         device_specific_topic = ast_device_state_topic(agent->device_name);
2796         if (!device_specific_topic) {
2797                 return -1;
2798         }
2799
2800         if (!(generic_pvt->sub = stasis_subscribe(device_specific_topic, generic_agent_devstate_cb, agent))) {
2801                 return -1;
2802         }
2803         cc_ref(agent, "Ref agent for subscription");
2804         return 0;
2805 }
2806
2807 static void *generic_recall(void *data)
2808 {
2809         struct ast_cc_agent *agent = data;
2810         struct cc_generic_agent_pvt *generic_pvt = agent->private_data;
2811         const char *interface = S_OR(ast_get_cc_agent_dialstring(agent->cc_params), ast_strdupa(agent->device_name));
2812         const char *tech;
2813         char *target;
2814         int reason;
2815         struct ast_channel *chan;
2816         const char *callback_macro = ast_get_cc_callback_macro(agent->cc_params);
2817         const char *callback_sub = ast_get_cc_callback_sub(agent->cc_params);
2818         unsigned int recall_timer = ast_get_cc_recall_timer(agent->cc_params) * 1000;
2819         struct ast_format_cap *tmp_cap = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
2820
2821         if (!tmp_cap) {
2822                 return NULL;
2823         }
2824
2825         tech = interface;
2826         if ((target = strchr(interface, '/'))) {
2827                 *target++ = '\0';
2828         }
2829
2830         ast_format_cap_append(tmp_cap, ast_format_slin, 0);
2831         if (!(chan = ast_request_and_dial(tech, tmp_cap, NULL, NULL, target, recall_timer, &reason, generic_pvt->cid_num, generic_pvt->cid_name))) {
2832                 /* Hmm, no channel. Sucks for you, bud.
2833                  */
2834                 ast_log_dynamic_level(cc_logger_level, "Core %u: Failed to call back %s for reason %d\n",
2835                                 agent->core_id, agent->device_name, reason);
2836                 ast_cc_failed(agent->core_id, "Failed to call back device %s/%s", tech, target);
2837                 ao2_ref(tmp_cap, -1);
2838                 return NULL;
2839         }
2840         ao2_ref(tmp_cap, -1);
2841         
2842         /* We have a channel. It's time now to set up the datastore of recalled CC interfaces.
2843          * This will be a common task for all recall functions. If it were possible, I'd have
2844          * the core do it automatically, but alas I cannot. Instead, I will provide a public
2845          * function to do so.
2846          */
2847         ast_setup_cc_recall_datastore(chan, agent->core_id);
2848         ast_cc_agent_set_interfaces_chanvar(chan);
2849
2850         ast_channel_exten_set(chan, generic_pvt->exten);
2851         ast_channel_context_set(chan, generic_pvt->context);
2852         ast_channel_priority_set(chan, 1);
2853
2854         pbx_builtin_setvar_helper(chan, "CC_EXTEN", generic_pvt->exten);
2855         pbx_builtin_setvar_helper(chan, "CC_CONTEXT", generic_pvt->context);
2856
2857         if (!ast_strlen_zero(callback_macro)) {
2858                 ast_log_dynamic_level(cc_logger_level, "Core %u: There's a callback macro configured for agent %s\n",
2859                                 agent->core_id, agent->device_name);
2860                 if (ast_app_exec_macro(NULL, chan, callback_macro)) {
2861                         ast_cc_failed(agent->core_id, "Callback macro to %s failed. Maybe a hangup?", agent->device_name);
2862                         ast_hangup(chan);
2863                         return NULL;
2864                 }
2865         }
2866
2867         if (!ast_strlen_zero(callback_sub)) {
2868                 ast_log_dynamic_level(cc_logger_level, "Core %u: There's a callback subroutine configured for agent %s\n",
2869                                 agent->core_id, agent->device_name);
2870                 if (ast_app_exec_sub(NULL, chan, callback_sub, 0)) {
2871                         ast_cc_failed(agent->core_id, "Callback subroutine to %s failed. Maybe a hangup?", agent->device_name);
2872                         ast_hangup(chan);
2873                         return NULL;
2874                 }
2875         }
2876         if (ast_pbx_start(chan)) {
2877                 ast_cc_failed(agent->core_id, "PBX failed to start for %s.", agent->device_name);
2878                 ast_hangup(chan);
2879                 return NULL;
2880         }
2881         ast_cc_agent_recalling(agent->core_id, "Generic agent %s is recalling",
2882                 agent->device_name);
2883         return NULL;
2884 }
2885
2886 static int cc_generic_agent_recall(struct ast_cc_agent *agent)
2887 {
2888         pthread_t clotho;
2889         enum ast_device_state current_state = ast_device_state(agent->device_name);
2890
2891         if (!cc_generic_is_device_available(current_state)) {
2892                 /* We can't try to contact the device right now because he's not available
2893                  * Let the core know he's busy.
2894                  */
2895                 ast_cc_agent_caller_busy(agent->core_id, "Generic agent caller %s is busy", agent->device_name);
2896                 return 0;
2897         }
2898         ast_pthread_create_detached_background(&clotho, NULL, generic_recall, agent);
2899         return 0;
2900 }
2901
2902 static void cc_generic_agent_destructor(struct ast_cc_agent *agent)
2903 {
2904         struct cc_generic_agent_pvt *agent_pvt = agent->private_data;
2905
2906         if (!agent_pvt) {
2907                 /* The agent constructor probably failed. */
2908                 return;
2909         }
2910
2911         cc_generic_agent_stop_offer_timer(agent);
2912         if (agent_pvt->sub) {
2913                 agent_pvt->sub = stasis_unsubscribe(agent_pvt->sub);
2914         }
2915
2916         ast_free(agent_pvt);
2917 }
2918
2919 static void cc_core_instance_destructor(void *data)
2920 {
2921         struct cc_core_instance *core_instance = data;
2922         ast_log_dynamic_level(cc_logger_level, "Core %d: Destroying core instance\n", core_instance->core_id);
2923         if (core_instance->agent) {
2924                 cc_unref(core_instance->agent, "Core instance is done with the agent now");
2925         }
2926         if (core_instance->monitors) {
2927                 core_instance->monitors = cc_unref(core_instance->monitors, "Core instance is done with interface list");
2928         }
2929 }
2930
2931 static struct cc_core_instance *cc_core_init_instance(struct ast_channel *caller_chan,
2932                 struct cc_monitor_tree *called_tree, const int core_id, struct cc_control_payload *cc_data)
2933 {
2934         char caller[AST_CHANNEL_NAME];
2935         struct cc_core_instance *core_instance;
2936         struct ast_cc_config_params *cc_params;
2937         long agent_count;
2938         int recall_core_id;
2939
2940         ast_channel_get_device_name(caller_chan, caller, sizeof(caller));
2941         cc_params = ast_channel_get_cc_config_params(caller_chan);
2942         if (!cc_params) {
2943                 ast_log_dynamic_level(cc_logger_level, "Could not get CC parameters for %s\n",
2944                         caller);
2945                 return NULL;
2946         }
2947         /* First, we need to kill off other pending CC offers from caller. If the caller is going
2948          * to request a CC service, it may only be for the latest call he made.
2949          */
2950         if (ast_get_cc_agent_policy(cc_params) == AST_CC_AGENT_GENERIC) {
2951                 kill_duplicate_offers(caller);
2952         }
2953
2954         ast_cc_is_recall(caller_chan, &recall_core_id, NULL);
2955         agent_count = count_agents(caller, recall_core_id);
2956         if (agent_count >= ast_get_cc_max_agents(cc_params)) {
2957                 ast_log_dynamic_level(cc_logger_level, "Caller %s already has the maximum number of agents configured\n", caller);
2958                 return NULL;
2959         }
2960
2961         /* Generic agents can only have a single outstanding CC request per caller. */
2962         if (agent_count > 0 && ast_get_cc_agent_policy(cc_params) == AST_CC_AGENT_GENERIC) {
2963                 ast_log_dynamic_level(cc_logger_level, "Generic agents can only have a single outstanding request\n");
2964                 return NULL;
2965         }
2966
2967         /* Next, we need to create the core instance for this call */
2968         if (!(core_instance = ao2_t_alloc(sizeof(*core_instance), cc_core_instance_destructor, "Creating core instance for CC"))) {
2969                 return NULL;
2970         }
2971
2972         core_instance->core_id = core_id;
2973         if (!(core_instance->agent = cc_agent_init(caller_chan, caller, core_instance->core_id, called_tree))) {
2974                 cc_unref(core_instance, "Couldn't allocate agent, unref core_instance");
2975                 return NULL;
2976         }
2977
2978         core_instance->monitors = cc_ref(called_tree, "Core instance getting ref to monitor tree");
2979
2980         ao2_t_link(cc_core_instances, core_instance, "Link core instance into container");
2981
2982         return core_instance;
2983 }
2984
2985 struct cc_state_change_args {
2986         struct cc_core_instance *core_instance;/*!< Holds reference to core instance. */
2987         enum cc_state state;
2988         int core_id;
2989         char debug[1];
2990 };
2991
2992 static int is_state_change_valid(enum cc_state current_state, const enum cc_state new_state, struct ast_cc_agent *agent)
2993 {
2994         int is_valid = 0;
2995         switch (new_state) {
2996         case CC_AVAILABLE:
2997                 ast_log_dynamic_level(cc_logger_level, "Core %u: Asked to change to state %u? That should never happen.\n",
2998                                 agent->core_id, new_state);
2999                 break;
3000         case CC_CALLER_OFFERED:
3001                 if (current_state == CC_AVAILABLE) {
3002                         is_valid = 1;
3003                 }
3004                 break;
3005         case CC_CALLER_REQUESTED:
3006                 if (current_state == CC_CALLER_OFFERED ||
3007                                 (current_state == CC_AVAILABLE && ast_test_flag(agent, AST_CC_AGENT_SKIP_OFFER))) {
3008                         is_valid = 1;
3009                 }
3010                 break;
3011         case CC_ACTIVE:
3012                 if (current_state == CC_CALLER_REQUESTED || current_state == CC_CALLER_BUSY) {
3013                         is_valid = 1;
3014                 }
3015                 break;
3016         case CC_CALLEE_READY:
3017                 if (current_state == CC_ACTIVE) {
3018                         is_valid = 1;
3019                 }
3020                 break;
3021         case CC_CALLER_BUSY:
3022                 if (current_state == CC_CALLEE_READY) {
3023                         is_valid = 1;
3024                 }
3025                 break;
3026         case CC_RECALLING:
3027                 if (current_state == CC_CALLEE_READY) {
3028                         is_valid = 1;
3029                 }
3030                 break;
3031         case CC_COMPLETE:
3032                 if (current_state == CC_RECALLING) {
3033                         is_valid = 1;
3034                 }
3035                 break;
3036         case CC_FAILED:
3037                 is_valid = 1;
3038                 break;
3039         default:
3040                 ast_log_dynamic_level(cc_logger_level, "Core %u: Asked to change to unknown state %u\n",
3041                                 agent->core_id, new_state);
3042                 break;
3043         }
3044
3045         return is_valid;
3046 }
3047
3048 static int cc_available(struct cc_core_instance *core_instance, struct cc_state_change_args *args, enum cc_state previous_state)
3049 {
3050         /* This should never happen... */
3051         ast_log(LOG_WARNING, "Someone requested to change to CC_AVAILABLE? Ignoring.\n");
3052         return -1;
3053 }
3054
3055 static int cc_caller_offered(struct cc_core_instance *core_instance, struct cc_state_change_args *args, enum cc_state previous_state)
3056 {
3057         if (core_instance->agent->callbacks->start_offer_timer(core_instance->agent)) {
3058                 ast_cc_failed(core_instance->core_id, "Failed to start the offer timer for %s\n",
3059                                 core_instance->agent->device_name);
3060                 return -1;
3061         }
3062         cc_publish_offertimerstart(core_instance->core_id, core_instance->agent->device_name, core_instance->agent->cc_params->cc_offer_timer);
3063         ast_log_dynamic_level(cc_logger_level, "Core %d: Started the offer timer for the agent %s!\n",
3064                         core_instance->core_id, core_instance->agent->device_name);
3065         return 0;
3066 }
3067
3068 /*!
3069  * \brief check if the core instance has any device monitors
3070  *
3071  * In any case where we end up removing a device monitor from the
3072  * list of device monitors, it is important to see what the state
3073  * of the list is afterwards. If we find that we only have extension
3074  * monitors left, then no devices are actually being monitored.
3075  * In such a case, we need to declare that CC has failed for this
3076  * call. This function helps those cases to determine if they should
3077  * declare failure.
3078  *
3079  * \param core_instance The core instance we are checking for the existence
3080  * of device monitors
3081  * \retval 0 No device monitors exist on this core_instance
3082  * \retval 1 There is still at least 1 device monitor remaining
3083  */
3084 static int has_device_monitors(struct cc_core_instance *core_instance)
3085 {
3086         struct ast_cc_monitor *iter;
3087         int res = 0;
3088
3089         AST_LIST_TRAVERSE(core_instance->monitors, iter, next) {
3090                 if (iter->interface->monitor_class == AST_CC_DEVICE_MONITOR) {
3091                         res = 1;
3092                         break;
3093                 }
3094         }
3095
3096         return res;
3097 }
3098
3099 static void request_cc(struct cc_core_instance *core_instance)
3100 {
3101         struct ast_cc_monitor *monitor_iter;
3102         AST_LIST_LOCK(core_instance->monitors);
3103         AST_LIST_TRAVERSE_SAFE_BEGIN(core_instance->monitors, monitor_iter, next) {
3104                 if (monitor_iter->interface->monitor_class == AST_CC_DEVICE_MONITOR) {
3105                         if (monitor_iter->callbacks->request_cc(monitor_iter, &monitor_iter->available_timer_id)) {
3106                                 AST_LIST_REMOVE_CURRENT(next);
3107                                 cc_extension_monitor_change_is_valid(core_instance, monitor_iter->parent_id,
3108                                                 monitor_iter->interface->device_name, 1);
3109                                 cc_unref(monitor_iter, "request_cc failed. Unref list's reference to monitor");
3110                         } else {
3111                                 cc_publish_requested(core_instance->core_id, core_instance->agent->device_name, monitor_iter->interface->device_name);
3112                         }
3113                 }
3114         }
3115         AST_LIST_TRAVERSE_SAFE_END;
3116
3117         if (!has_device_monitors(core_instance)) {
3118                 ast_cc_failed(core_instance->core_id, "All device monitors failed to request CC");
3119         }
3120         AST_LIST_UNLOCK(core_instance->monitors);
3121 }
3122
3123 static int cc_caller_requested(struct cc_core_instance *core_instance, struct cc_state_change_args *args, enum cc_state previous_state)
3124 {
3125         if (!ast_cc_request_is_within_limits()) {
3126                 ast_log(LOG_WARNING, "Cannot request CC since there is no more room for requests\n");
3127                 core_instance->agent->callbacks->respond(core_instance->agent,
3128                         AST_CC_AGENT_RESPONSE_FAILURE_TOO_MANY);
3129                 ast_cc_failed(core_instance->core_id, "Too many requests in the system");
3130                 return -1;
3131         }
3132         core_instance->agent->callbacks->stop_offer_timer(core_instance->agent);
3133         request_cc(core_instance);
3134         return 0;
3135 }
3136
3137 static void unsuspend(struct cc_core_instance *core_instance)
3138 {
3139         struct ast_cc_monitor *monitor_iter;
3140         AST_LIST_LOCK(core_instance->monitors);
3141         AST_LIST_TRAVERSE_SAFE_BEGIN(core_instance->monitors, monitor_iter, next) {
3142                 if (monitor_iter->interface->monitor_class == AST_CC_DEVICE_MONITOR) {
3143                         if (monitor_iter->callbacks->unsuspend(monitor_iter)) {
3144                                 AST_LIST_REMOVE_CURRENT(next);
3145                                 cc_extension_monitor_change_is_valid(core_instance, monitor_iter->parent_id,
3146                                                 monitor_iter->interface->device_name, 1);
3147                                 cc_unref(monitor_iter, "unsuspend failed. Unref list's reference to monitor");
3148                         }
3149                 }
3150         }
3151         AST_LIST_TRAVERSE_SAFE_END;
3152
3153         if (!has_device_monitors(core_instance)) {
3154                 ast_cc_failed(core_instance->core_id, "All device monitors failed to unsuspend CC");
3155         }
3156         AST_LIST_UNLOCK(core_instance->monitors);
3157 }
3158
3159 static int cc_active(struct cc_core_instance *core_instance, struct cc_state_change_args *args, enum cc_state previous_state)
3160 {
3161         /* Either
3162          * 1. Callee accepted CC request, call agent's ack callback.
3163          * 2. Caller became available, call agent's stop_monitoring callback and
3164          *    call monitor's unsuspend callback.
3165          */
3166         if (previous_state == CC_CALLER_REQUESTED) {
3167                 core_instance->agent->callbacks->respond(core_instance->agent,
3168                         AST_CC_AGENT_RESPONSE_SUCCESS);
3169                 cc_publish_requestacknowledged(core_instance->core_id, core_instance->agent->device_name);
3170         } else if (previous_state == CC_CALLER_BUSY) {
3171                 cc_publish_callerstopmonitoring(core_instance->core_id, core_instance->agent->device_name);
3172                 unsuspend(core_instance);
3173         }
3174         /* Not possible for previous_state to be anything else due to the is_state_change_valid check at the beginning */
3175         return 0;
3176 }
3177
3178 static int cc_callee_ready(struct cc_core_instance *core_instance, struct cc_state_change_args *args, enum cc_state previous_state)
3179 {
3180         core_instance->agent->callbacks->callee_available(core_instance->agent);
3181         return 0;
3182 }
3183
3184 static void suspend(struct cc_core_instance *core_instance)
3185 {
3186         struct ast_cc_monitor *monitor_iter;
3187         AST_LIST_LOCK(core_instance->monitors);
3188         AST_LIST_TRAVERSE_SAFE_BEGIN(core_instance->monitors, monitor_iter, next) {
3189                 if (monitor_iter->interface->monitor_class == AST_CC_DEVICE_MONITOR) {
3190                         if (monitor_iter->callbacks->suspend(monitor_iter)) {
3191                                 AST_LIST_REMOVE_CURRENT(next);
3192                                 cc_extension_monitor_change_is_valid(core_instance, monitor_iter->parent_id,
3193                                                 monitor_iter->interface->device_name, 1);
3194                                 cc_unref(monitor_iter, "suspend failed. Unref list's reference to monitor");
3195                         }
3196                 }
3197         }
3198         AST_LIST_TRAVERSE_SAFE_END;
3199
3200         if (!has_device_monitors(core_instance)) {
3201                 ast_cc_failed(core_instance->core_id, "All device monitors failed to suspend CC");
3202         }
3203         AST_LIST_UNLOCK(core_instance->monitors);
3204 }
3205
3206 static int cc_caller_busy(struct cc_core_instance *core_instance, struct cc_state_change_args *args, enum cc_state previous_state)
3207 {
3208         /* Callee was available, but caller was busy, call agent's begin_monitoring callback
3209          * and call monitor's suspend callback.
3210          */
3211         suspend(core_instance);
3212         core_instance->agent->callbacks->start_monitoring(core_instance->agent);
3213         cc_publish_callerstartmonitoring(core_instance->core_id, core_instance->agent->device_name);
3214         return 0;
3215 }
3216
3217 static void cancel_available_timer(struct cc_core_instance *core_instance)
3218 {
3219         struct ast_cc_monitor *monitor_iter;
3220         AST_LIST_LOCK(core_instance->monitors);
3221         AST_LIST_TRAVERSE_SAFE_BEGIN(core_instance->monitors, monitor_iter, next) {
3222                 if (monitor_iter->interface->monitor_class == AST_CC_DEVICE_MONITOR) {
3223                         if (monitor_iter->callbacks->cancel_available_timer(monitor_iter, &monitor_iter->available_timer_id)) {
3224                                 AST_LIST_REMOVE_CURRENT(next);
3225                                 cc_extension_monitor_change_is_valid(core_instance, monitor_iter->parent_id,
3226                                                 monitor_iter->interface->device_name, 1);
3227                                 cc_unref(monitor_iter, "cancel_available_timer failed. Unref list's reference to monitor");
3228                         }
3229                 }
3230         }
3231         AST_LIST_TRAVERSE_SAFE_END;
3232
3233         if (!has_device_monitors(core_instance)) {
3234                 ast_cc_failed(core_instance->core_id, "All device monitors failed to cancel their available timers");
3235         }
3236         AST_LIST_UNLOCK(core_instance->monitors);
3237 }
3238
3239 static int cc_recalling(struct cc_core_instance *core_instance, struct cc_state_change_args *args, enum cc_state previous_state)
3240 {
3241         /* Both caller and callee are available, call agent's recall callback
3242          */
3243         cancel_available_timer(core_instance);
3244         cc_publish_callerrecalling(core_instance->core_id, core_instance->agent->device_name);
3245         return 0;
3246 }
3247
3248 static int cc_complete(struct cc_core_instance *core_instance, struct cc_state_change_args *args, enum cc_state previous_state)
3249 {
3250         /* Recall has made progress, call agent and monitor destructor functions
3251          */
3252         cc_publish_recallcomplete(core_instance->core_id, core_instance->agent->device_name);
3253         ao2_t_unlink(cc_core_instances, core_instance, "Unlink core instance since CC recall has completed");
3254         return 0;
3255 }
3256
3257 static int cc_failed(struct cc_core_instance *core_instance, struct cc_state_change_args *args, enum cc_state previous_state)
3258 {
3259         cc_publish_failure(core_instance->core_id, core_instance->agent->device_name, args->debug);
3260         ao2_t_unlink(cc_core_instances, core_instance, "Unlink core instance since CC failed");
3261         return 0;
3262 }
3263
3264 static int (* const state_change_funcs [])(struct cc_core_instance *, struct cc_state_change_args *, enum cc_state previous_state) = {
3265         [CC_AVAILABLE] = cc_available,
3266         [CC_CALLER_OFFERED] = cc_caller_offered,
3267         [CC_CALLER_REQUESTED] = cc_caller_requested,
3268         [CC_ACTIVE] = cc_active,
3269         [CC_CALLEE_READY] = cc_callee_ready,
3270         [CC_CALLER_BUSY] = cc_caller_busy,
3271         [CC_RECALLING] = cc_recalling,
3272         [CC_COMPLETE] = cc_complete,
3273         [CC_FAILED] = cc_failed,
3274 };
3275
3276 static int cc_do_state_change(void *datap)
3277 {
3278         struct cc_state_change_args *args = datap;
3279         struct cc_core_instance *core_instance;
3280         enum cc_state previous_state;
3281         int res;
3282
3283         ast_log_dynamic_level(cc_logger_level, "Core %d: State change to %u requested. Reason: %s\n",
3284                         args->core_id, args->state, args->debug);
3285
3286         core_instance = args->core_instance;
3287
3288         if (!is_state_change_valid(core_instance->current_state, args->state, core_instance->agent)) {
3289                 ast_log_dynamic_level(cc_logger_level, "Core %d: Invalid state change requested. Cannot go from %s to %s\n",
3290                                 args->core_id, cc_state_to_string(core_instance->current_state), cc_state_to_string(args->state));
3291                 if (args->state == CC_CALLER_REQUESTED) {
3292                         /*
3293                          * For out-of-order requests, we need to let the requester know that
3294                          * we can't handle the request now.
3295                          */
3296                         core_instance->agent->callbacks->respond(core_instance->agent,
3297                                 AST_CC_AGENT_RESPONSE_FAILURE_INVALID);
3298                 }
3299                 ast_free(args);
3300                 cc_unref(core_instance, "Unref core instance from when it was found earlier");
3301                 return -1;
3302         }
3303
3304         /* We can change to the new state now. */
3305         previous_state = core_instance->current_state;
3306         core_instance->current_state = args->state;
3307         res = state_change_funcs[core_instance->current_state](core_instance, args, previous_state);
3308
3309         /* If state change successful then notify any device state watchers of the change */
3310         if (!res && !strcmp(core_instance->agent->callbacks->type, "generic")) {
3311                 ccss_notify_device_state_change(core_instance->agent->device_name, core_instance->current_state);
3312         }
3313
3314         ast_free(args);
3315         cc_unref(core_instance, "Unref since state change has completed"); /* From ao2_find */
3316         return res;
3317 }
3318
3319 static int cc_request_state_change(enum cc_state state, const int core_id, const char *debug, va_list ap)
3320 {
3321         int res;
3322         int debuglen;
3323         char dummy[1];
3324         va_list aq;
3325         struct cc_core_instance *core_instance;
3326         struct cc_state_change_args *args;
3327         /* This initial call to vsnprintf is simply to find what the
3328          * size of the string needs to be
3329          */
3330         va_copy(aq, ap);
3331         /* We add 1 to the result since vsnprintf's return does not
3332          * include the terminating null byte
3333          */
3334         debuglen = vsnprintf(dummy, sizeof(dummy), debug, aq) + 1;
3335         va_end(aq);
3336
3337         if (!(args = ast_calloc(1, sizeof(*args) + debuglen))) {
3338                 return -1;
3339         }
3340
3341         core_instance = find_cc_core_instance(core_id);
3342         if (!core_instance) {
3343                 ast_log_dynamic_level(cc_logger_level, "Core %d: Unable to find core instance.\n",
3344                         core_id);
3345                 ast_free(args);
3346                 return -1;
3347         }
3348
3349         args->core_instance = core_instance;
3350         args->state = state;
3351         args->core_id = core_id;
3352         vsnprintf(args->debug, debuglen, debug, ap);
3353
3354         res = ast_taskprocessor_push(cc_core_taskprocessor, cc_do_state_change, args);
3355         if (res) {
3356                 cc_unref(core_instance, "Unref core instance. ast_taskprocessor_push failed");
3357                 ast_free(args);
3358         }
3359         return res;
3360 }
3361
3362 struct cc_recall_ds_data {
3363         int core_id;
3364         char ignore;
3365         char nested;
3366         struct cc_monitor_tree *interface_tree;
3367 };
3368
3369 static void *cc_recall_ds_duplicate(void *data)
3370 {
3371         struct cc_recall_ds_data *old_data = data;
3372         struct cc_recall_ds_data *new_data = ast_calloc(1, sizeof(*new_data));
3373
3374         if (!new_data) {
3375                 return NULL;
3376         }
3377         new_data->interface_tree = cc_ref(old_data->interface_tree, "Bump refcount of monitor tree for recall datastore duplicate");
3378         new_data->core_id = old_data->core_id;
3379         new_data->nested = 1;
3380         return new_data;
3381 }
3382
3383 static void cc_recall_ds_destroy(void *data)
3384 {
3385         struct cc_recall_ds_data *recall_data = data;
3386         recall_data->interface_tree = cc_unref(recall_data->interface_tree, "Unref recall monitor tree");
3387         ast_free(recall_data);
3388 }