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