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