Merge "res_calendar: Specialized calendars depend on symbols of general calendar."
[asterisk/asterisk.git] / main / taskprocessor.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2007-2013, Digium, Inc.
5  *
6  * Dwayne M. Hubbard <dhubbard@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 /*!
20  * \file
21  * \brief Maintain a container of uniquely-named taskprocessor threads that can be shared across modules.
22  *
23  * \author Dwayne Hubbard <dhubbard@digium.com>
24  */
25
26 /*** MODULEINFO
27         <support_level>core</support_level>
28  ***/
29
30 #include "asterisk.h"
31
32 #include "asterisk/_private.h"
33 #include "asterisk/module.h"
34 #include "asterisk/time.h"
35 #include "asterisk/astobj2.h"
36 #include "asterisk/cli.h"
37 #include "asterisk/taskprocessor.h"
38 #include "asterisk/sem.h"
39
40 /*!
41  * \brief tps_task structure is queued to a taskprocessor
42  *
43  * tps_tasks are processed in FIFO order and freed by the taskprocessing
44  * thread after the task handler returns.  The callback function that is assigned
45  * to the execute() function pointer is responsible for releasing datap resources if necessary.
46  */
47 struct tps_task {
48         /*! \brief The execute() task callback function pointer */
49         union {
50                 int (*execute)(void *datap);
51                 int (*execute_local)(struct ast_taskprocessor_local *local);
52         } callback;
53         /*! \brief The data pointer for the task execute() function */
54         void *datap;
55         /*! \brief AST_LIST_ENTRY overhead */
56         AST_LIST_ENTRY(tps_task) list;
57         unsigned int wants_local:1;
58 };
59
60 /*! \brief tps_taskprocessor_stats maintain statistics for a taskprocessor. */
61 struct tps_taskprocessor_stats {
62         /*! \brief This is the maximum number of tasks queued at any one time */
63         unsigned long max_qsize;
64         /*! \brief This is the current number of tasks processed */
65         unsigned long _tasks_processed_count;
66 };
67
68 /*! \brief A ast_taskprocessor structure is a singleton by name */
69 struct ast_taskprocessor {
70         /*! \brief Friendly name of the taskprocessor */
71         const char *name;
72         /*! \brief Taskprocessor statistics */
73         struct tps_taskprocessor_stats *stats;
74         void *local_data;
75         /*! \brief Taskprocessor current queue size */
76         long tps_queue_size;
77         /*! \brief Taskprocessor low water clear alert level */
78         long tps_queue_low;
79         /*! \brief Taskprocessor high water alert trigger level */
80         long tps_queue_high;
81         /*! \brief Taskprocessor queue */
82         AST_LIST_HEAD_NOLOCK(tps_queue, tps_task) tps_queue;
83         struct ast_taskprocessor_listener *listener;
84         /*! Current thread executing the tasks */
85         pthread_t thread;
86         /*! Indicates if the taskprocessor is currently executing a task */
87         unsigned int executing:1;
88         /*! Indicates that a high water warning has been issued on this task processor */
89         unsigned int high_water_warned:1;
90         /*! Indicates that a high water alert is active on this taskprocessor */
91         unsigned int high_water_alert:1;
92         /*! Indicates if the taskprocessor is currently suspended */
93         unsigned int suspended:1;
94 };
95
96 /*!
97  * \brief A listener for taskprocessors
98  *
99  * \since 12.0.0
100  *
101  * When a taskprocessor's state changes, the listener
102  * is notified of the change. This allows for tasks
103  * to be addressed in whatever way is appropriate for
104  * the module using the taskprocessor.
105  */
106 struct ast_taskprocessor_listener {
107         /*! The callbacks the taskprocessor calls into to notify of state changes */
108         const struct ast_taskprocessor_listener_callbacks *callbacks;
109         /*! The taskprocessor that the listener is listening to */
110         struct ast_taskprocessor *tps;
111         /*! Data private to the listener */
112         void *user_data;
113 };
114
115 #ifdef LOW_MEMORY
116 #define TPS_MAX_BUCKETS 61
117 #else
118 /*! \brief Number of buckets in the tps_singletons container. */
119 #define TPS_MAX_BUCKETS 1567
120 #endif
121
122 /*! \brief tps_singletons is the astobj2 container for taskprocessor singletons */
123 static struct ao2_container *tps_singletons;
124
125 /*! \brief CLI <example>taskprocessor ping &lt;blah&gt;</example> operation requires a ping condition */
126 static ast_cond_t cli_ping_cond;
127
128 /*! \brief CLI <example>taskprocessor ping &lt;blah&gt;</example> operation requires a ping condition lock */
129 AST_MUTEX_DEFINE_STATIC(cli_ping_cond_lock);
130
131 /*! \brief The astobj2 hash callback for taskprocessors */
132 static int tps_hash_cb(const void *obj, const int flags);
133 /*! \brief The astobj2 compare callback for taskprocessors */
134 static int tps_cmp_cb(void *obj, void *arg, int flags);
135
136 /*! \brief CLI <example>taskprocessor ping &lt;blah&gt;</example> handler function */
137 static int tps_ping_handler(void *datap);
138
139 static char *cli_tps_ping(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
140 static char *cli_tps_report(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
141
142 static struct ast_cli_entry taskprocessor_clis[] = {
143         AST_CLI_DEFINE(cli_tps_ping, "Ping a named task processor"),
144         AST_CLI_DEFINE(cli_tps_report, "List instantiated task processors and statistics"),
145 };
146
147 struct default_taskprocessor_listener_pvt {
148         pthread_t poll_thread;
149         int dead;
150         struct ast_sem sem;
151 };
152
153 static void default_listener_pvt_destroy(struct default_taskprocessor_listener_pvt *pvt)
154 {
155         ast_assert(pvt->dead);
156         ast_sem_destroy(&pvt->sem);
157         ast_free(pvt);
158 }
159
160 static void default_listener_pvt_dtor(struct ast_taskprocessor_listener *listener)
161 {
162         struct default_taskprocessor_listener_pvt *pvt = listener->user_data;
163
164         default_listener_pvt_destroy(pvt);
165
166         listener->user_data = NULL;
167 }
168
169 /*!
170  * \brief Function that processes tasks in the taskprocessor
171  * \internal
172  */
173 static void *default_tps_processing_function(void *data)
174 {
175         struct ast_taskprocessor_listener *listener = data;
176         struct ast_taskprocessor *tps = listener->tps;
177         struct default_taskprocessor_listener_pvt *pvt = listener->user_data;
178         int sem_value;
179         int res;
180
181         while (!pvt->dead) {
182                 res = ast_sem_wait(&pvt->sem);
183                 if (res != 0 && errno != EINTR) {
184                         ast_log(LOG_ERROR, "ast_sem_wait(): %s\n",
185                                 strerror(errno));
186                         /* Just give up */
187                         break;
188                 }
189                 ast_taskprocessor_execute(tps);
190         }
191
192         /* No posting to a dead taskprocessor! */
193         res = ast_sem_getvalue(&pvt->sem, &sem_value);
194         ast_assert(res == 0 && sem_value == 0);
195
196         /* Free the shutdown reference (see default_listener_shutdown) */
197         ao2_t_ref(listener->tps, -1, "tps-shutdown");
198
199         return NULL;
200 }
201
202 static int default_listener_start(struct ast_taskprocessor_listener *listener)
203 {
204         struct default_taskprocessor_listener_pvt *pvt = listener->user_data;
205
206         if (ast_pthread_create(&pvt->poll_thread, NULL, default_tps_processing_function, listener)) {
207                 return -1;
208         }
209
210         return 0;
211 }
212
213 static void default_task_pushed(struct ast_taskprocessor_listener *listener, int was_empty)
214 {
215         struct default_taskprocessor_listener_pvt *pvt = listener->user_data;
216
217         if (ast_sem_post(&pvt->sem) != 0) {
218                 ast_log(LOG_ERROR, "Failed to notify of enqueued task: %s\n",
219                         strerror(errno));
220         }
221 }
222
223 static int default_listener_die(void *data)
224 {
225         struct default_taskprocessor_listener_pvt *pvt = data;
226         pvt->dead = 1;
227         return 0;
228 }
229
230 static void default_listener_shutdown(struct ast_taskprocessor_listener *listener)
231 {
232         struct default_taskprocessor_listener_pvt *pvt = listener->user_data;
233         int res;
234
235         /* Hold a reference during shutdown */
236         ao2_t_ref(listener->tps, +1, "tps-shutdown");
237
238         ast_taskprocessor_push(listener->tps, default_listener_die, pvt);
239
240         ast_assert(pvt->poll_thread != AST_PTHREADT_NULL);
241
242         if (pthread_equal(pthread_self(), pvt->poll_thread)) {
243                 res = pthread_detach(pvt->poll_thread);
244                 if (res != 0) {
245                         ast_log(LOG_ERROR, "pthread_detach(): %s\n", strerror(errno));
246                 }
247         } else {
248                 res = pthread_join(pvt->poll_thread, NULL);
249                 if (res != 0) {
250                         ast_log(LOG_ERROR, "pthread_join(): %s\n", strerror(errno));
251                 }
252         }
253         pvt->poll_thread = AST_PTHREADT_NULL;
254 }
255
256 static const struct ast_taskprocessor_listener_callbacks default_listener_callbacks = {
257         .start = default_listener_start,
258         .task_pushed = default_task_pushed,
259         .shutdown = default_listener_shutdown,
260         .dtor = default_listener_pvt_dtor,
261 };
262
263 /*!
264  * \internal
265  * \brief Clean up resources on Asterisk shutdown
266  */
267 static void tps_shutdown(void)
268 {
269         ast_cli_unregister_multiple(taskprocessor_clis, ARRAY_LEN(taskprocessor_clis));
270         ao2_t_ref(tps_singletons, -1, "Unref tps_singletons in shutdown");
271         tps_singletons = NULL;
272 }
273
274 /* initialize the taskprocessor container and register CLI operations */
275 int ast_tps_init(void)
276 {
277         if (!(tps_singletons = ao2_container_alloc(TPS_MAX_BUCKETS, tps_hash_cb, tps_cmp_cb))) {
278                 ast_log(LOG_ERROR, "taskprocessor container failed to initialize!\n");
279                 return -1;
280         }
281
282         ast_cond_init(&cli_ping_cond, NULL);
283
284         ast_cli_register_multiple(taskprocessor_clis, ARRAY_LEN(taskprocessor_clis));
285
286         ast_register_cleanup(tps_shutdown);
287
288         return 0;
289 }
290
291 /* allocate resources for the task */
292 static struct tps_task *tps_task_alloc(int (*task_exe)(void *datap), void *datap)
293 {
294         struct tps_task *t;
295         if (!task_exe) {
296                 ast_log(LOG_ERROR, "task_exe is NULL!\n");
297                 return NULL;
298         }
299
300         t = ast_calloc(1, sizeof(*t));
301         if (!t) {
302                 ast_log(LOG_ERROR, "failed to allocate task!\n");
303                 return NULL;
304         }
305
306         t->callback.execute = task_exe;
307         t->datap = datap;
308
309         return t;
310 }
311
312 static struct tps_task *tps_task_alloc_local(int (*task_exe)(struct ast_taskprocessor_local *local), void *datap)
313 {
314         struct tps_task *t;
315         if (!task_exe) {
316                 ast_log(LOG_ERROR, "task_exe is NULL!\n");
317                 return NULL;
318         }
319
320         t = ast_calloc(1, sizeof(*t));
321         if (!t) {
322                 ast_log(LOG_ERROR, "failed to allocate task!\n");
323                 return NULL;
324         }
325
326         t->callback.execute_local = task_exe;
327         t->datap = datap;
328         t->wants_local = 1;
329
330         return t;
331 }
332
333 /* release task resources */
334 static void *tps_task_free(struct tps_task *task)
335 {
336         ast_free(task);
337         return NULL;
338 }
339
340 /* taskprocessor tab completion */
341 static char *tps_taskprocessor_tab_complete(struct ast_cli_args *a)
342 {
343         int tklen;
344         int wordnum = 0;
345         struct ast_taskprocessor *p;
346         char *name = NULL;
347         struct ao2_iterator i;
348
349         if (a->pos != 3)
350                 return NULL;
351
352         tklen = strlen(a->word);
353         i = ao2_iterator_init(tps_singletons, 0);
354         while ((p = ao2_iterator_next(&i))) {
355                 if (!strncasecmp(a->word, p->name, tklen) && ++wordnum > a->n) {
356                         name = ast_strdup(p->name);
357                         ast_taskprocessor_unreference(p);
358                         break;
359                 }
360                 ast_taskprocessor_unreference(p);
361         }
362         ao2_iterator_destroy(&i);
363         return name;
364 }
365
366 /* ping task handling function */
367 static int tps_ping_handler(void *datap)
368 {
369         ast_mutex_lock(&cli_ping_cond_lock);
370         ast_cond_signal(&cli_ping_cond);
371         ast_mutex_unlock(&cli_ping_cond_lock);
372         return 0;
373 }
374
375 /* ping the specified taskprocessor and display the ping time on the CLI */
376 static char *cli_tps_ping(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
377 {
378         struct timeval begin, end, delta;
379         const char *name;
380         struct timeval when;
381         struct timespec ts;
382         struct ast_taskprocessor *tps;
383
384         switch (cmd) {
385         case CLI_INIT:
386                 e->command = "core ping taskprocessor";
387                 e->usage =
388                         "Usage: core ping taskprocessor <taskprocessor>\n"
389                         "       Displays the time required for a task to be processed\n";
390                 return NULL;
391         case CLI_GENERATE:
392                 return tps_taskprocessor_tab_complete(a);
393         }
394
395         if (a->argc != 4)
396                 return CLI_SHOWUSAGE;
397
398         name = a->argv[3];
399         if (!(tps = ast_taskprocessor_get(name, TPS_REF_IF_EXISTS))) {
400                 ast_cli(a->fd, "\nping failed: %s not found\n\n", name);
401                 return CLI_SUCCESS;
402         }
403         ast_cli(a->fd, "\npinging %s ...", name);
404
405         /*
406          * Wait up to 5 seconds for a ping reply.
407          *
408          * On a very busy system it could take awhile to get a
409          * ping response from some taskprocessors.
410          */
411         begin = ast_tvnow();
412         when = ast_tvadd(begin, ast_samp2tv(5000, 1000));
413         ts.tv_sec = when.tv_sec;
414         ts.tv_nsec = when.tv_usec * 1000;
415
416         ast_mutex_lock(&cli_ping_cond_lock);
417         if (ast_taskprocessor_push(tps, tps_ping_handler, 0) < 0) {
418                 ast_mutex_unlock(&cli_ping_cond_lock);
419                 ast_cli(a->fd, "\nping failed: could not push task to %s\n\n", name);
420                 ast_taskprocessor_unreference(tps);
421                 return CLI_FAILURE;
422         }
423         ast_cond_timedwait(&cli_ping_cond, &cli_ping_cond_lock, &ts);
424         ast_mutex_unlock(&cli_ping_cond_lock);
425
426         end = ast_tvnow();
427         delta = ast_tvsub(end, begin);
428         ast_cli(a->fd, "\n\t%24s ping time: %.1ld.%.6ld sec\n\n", name, (long)delta.tv_sec, (long int)delta.tv_usec);
429         ast_taskprocessor_unreference(tps);
430         return CLI_SUCCESS;
431 }
432
433 /*!
434  * \internal
435  * \brief Taskprocessor ao2 container sort function.
436  * \since 13.8.0
437  *
438  * \param obj_left pointer to the (user-defined part) of an object.
439  * \param obj_right pointer to the (user-defined part) of an object.
440  * \param flags flags from ao2_callback()
441  *   OBJ_SEARCH_OBJECT - if set, 'obj_right', is an object.
442  *   OBJ_SEARCH_KEY - if set, 'obj_right', is a search key item that is not an object.
443  *   OBJ_SEARCH_PARTIAL_KEY - if set, 'obj_right', is a partial search key item that is not an object.
444  *
445  * \retval <0 if obj_left < obj_right
446  * \retval =0 if obj_left == obj_right
447  * \retval >0 if obj_left > obj_right
448  */
449 static int tps_sort_cb(const void *obj_left, const void *obj_right, int flags)
450 {
451         const struct ast_taskprocessor *tps_left = obj_left;
452         const struct ast_taskprocessor *tps_right = obj_right;
453         const char *right_key = obj_right;
454         int cmp;
455
456         switch (flags & OBJ_SEARCH_MASK) {
457         default:
458         case OBJ_SEARCH_OBJECT:
459                 right_key = tps_right->name;
460                 /* Fall through */
461         case OBJ_SEARCH_KEY:
462                 cmp = strcasecmp(tps_left->name, right_key);
463                 break;
464         case OBJ_SEARCH_PARTIAL_KEY:
465                 cmp = strncasecmp(tps_left->name, right_key, strlen(right_key));
466                 break;
467         }
468         return cmp;
469 }
470
471 static char *cli_tps_report(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
472 {
473         char name[256];
474         int tcount;
475         unsigned long qsize;
476         unsigned long maxqsize;
477         unsigned long processed;
478         struct ao2_container *sorted_tps;
479         struct ast_taskprocessor *tps;
480         struct ao2_iterator iter;
481 #define FMT_HEADERS             "%-45s %10s %10s %10s %10s %10s\n"
482 #define FMT_FIELDS              "%-45s %10lu %10lu %10lu %10lu %10lu\n"
483
484         switch (cmd) {
485         case CLI_INIT:
486                 e->command = "core show taskprocessors";
487                 e->usage =
488                         "Usage: core show taskprocessors\n"
489                         "       Shows a list of instantiated task processors and their statistics\n";
490                 return NULL;
491         case CLI_GENERATE:
492                 return NULL;
493         }
494
495         if (a->argc != e->args) {
496                 return CLI_SHOWUSAGE;
497         }
498
499         sorted_tps = ao2_container_alloc_rbtree(AO2_ALLOC_OPT_LOCK_NOLOCK, 0, tps_sort_cb,
500                 NULL);
501         if (!sorted_tps
502                 || ao2_container_dup(sorted_tps, tps_singletons, 0)) {
503                 ao2_cleanup(sorted_tps);
504                 return CLI_FAILURE;
505         }
506
507         ast_cli(a->fd, "\n" FMT_HEADERS, "Processor", "Processed", "In Queue", "Max Depth", "Low water", "High water");
508         tcount = 0;
509         iter = ao2_iterator_init(sorted_tps, AO2_ITERATOR_UNLINK);
510         while ((tps = ao2_iterator_next(&iter))) {
511                 ast_copy_string(name, tps->name, sizeof(name));
512                 qsize = tps->tps_queue_size;
513                 if (tps->stats) {
514                         maxqsize = tps->stats->max_qsize;
515                         processed = tps->stats->_tasks_processed_count;
516                 } else {
517                         maxqsize = 0;
518                         processed = 0;
519                 }
520                 ast_cli(a->fd, FMT_FIELDS, name, processed, qsize, maxqsize,
521                         tps->tps_queue_low, tps->tps_queue_high);
522                 ast_taskprocessor_unreference(tps);
523                 ++tcount;
524         }
525         ao2_iterator_destroy(&iter);
526         ast_cli(a->fd, "\n%d taskprocessors\n\n", tcount);
527         ao2_ref(sorted_tps, -1);
528         return CLI_SUCCESS;
529 }
530
531 /* hash callback for astobj2 */
532 static int tps_hash_cb(const void *obj, const int flags)
533 {
534         const struct ast_taskprocessor *tps = obj;
535         const char *name = flags & OBJ_KEY ? obj : tps->name;
536
537         return ast_str_case_hash(name);
538 }
539
540 /* compare callback for astobj2 */
541 static int tps_cmp_cb(void *obj, void *arg, int flags)
542 {
543         struct ast_taskprocessor *lhs = obj, *rhs = arg;
544         const char *rhsname = flags & OBJ_KEY ? arg : rhs->name;
545
546         return !strcasecmp(lhs->name, rhsname) ? CMP_MATCH | CMP_STOP : 0;
547 }
548
549 /*! Count of the number of taskprocessors in high water alert. */
550 static unsigned int tps_alert_count;
551
552 /*! Access protection for tps_alert_count */
553 AST_RWLOCK_DEFINE_STATIC(tps_alert_lock);
554
555 /*!
556  * \internal
557  * \brief Add a delta to tps_alert_count with protection.
558  * \since 13.10.0
559  *
560  * \param tps Taskprocessor updating queue water mark alert trigger.
561  * \param delta The amount to add to tps_alert_count.
562  *
563  * \return Nothing
564  */
565 static void tps_alert_add(struct ast_taskprocessor *tps, int delta)
566 {
567         unsigned int old;
568
569         ast_rwlock_wrlock(&tps_alert_lock);
570         old = tps_alert_count;
571         tps_alert_count += delta;
572         if (DEBUG_ATLEAST(3)
573                 /* and tps_alert_count becomes zero or non-zero */
574                 && !old != !tps_alert_count) {
575                 ast_log(LOG_DEBUG, "Taskprocessor '%s' %s the high water alert.\n",
576                         tps->name, tps_alert_count ? "triggered" : "cleared");
577         }
578         ast_rwlock_unlock(&tps_alert_lock);
579 }
580
581 unsigned int ast_taskprocessor_alert_get(void)
582 {
583         unsigned int count;
584
585         ast_rwlock_rdlock(&tps_alert_lock);
586         count = tps_alert_count;
587         ast_rwlock_unlock(&tps_alert_lock);
588
589         return count;
590 }
591
592 int ast_taskprocessor_alert_set_levels(struct ast_taskprocessor *tps, long low_water, long high_water)
593 {
594         if (!tps || high_water < 0 || high_water < low_water) {
595                 return -1;
596         }
597
598         if (low_water < 0) {
599                 /* Set low water level to 90% of high water level */
600                 low_water = (high_water * 9) / 10;
601         }
602
603         ao2_lock(tps);
604
605         tps->tps_queue_low = low_water;
606         tps->tps_queue_high = high_water;
607
608         if (tps->high_water_alert) {
609                 if (!tps->tps_queue_size || tps->tps_queue_size < low_water) {
610                         /* Update water mark alert immediately */
611                         tps->high_water_alert = 0;
612                         tps_alert_add(tps, -1);
613                 }
614         } else {
615                 if (high_water < tps->tps_queue_size) {
616                         /* Update water mark alert immediately */
617                         tps->high_water_alert = 1;
618                         tps_alert_add(tps, +1);
619                 }
620         }
621
622         ao2_unlock(tps);
623
624         return 0;
625 }
626
627 /* destroy the taskprocessor */
628 static void tps_taskprocessor_dtor(void *tps)
629 {
630         struct ast_taskprocessor *t = tps;
631         struct tps_task *task;
632
633         while ((task = AST_LIST_REMOVE_HEAD(&t->tps_queue, list))) {
634                 tps_task_free(task);
635         }
636         t->tps_queue_size = 0;
637
638         if (t->high_water_alert) {
639                 t->high_water_alert = 0;
640                 tps_alert_add(t, -1);
641         }
642
643         ast_free(t->stats);
644         t->stats = NULL;
645         ast_free((char *) t->name);
646         t->name = NULL;
647         ao2_cleanup(t->listener);
648         t->listener = NULL;
649 }
650
651 /* pop the front task and return it */
652 static struct tps_task *tps_taskprocessor_pop(struct ast_taskprocessor *tps)
653 {
654         struct tps_task *task;
655
656         if ((task = AST_LIST_REMOVE_HEAD(&tps->tps_queue, list))) {
657                 --tps->tps_queue_size;
658                 if (tps->high_water_alert && tps->tps_queue_size <= tps->tps_queue_low) {
659                         tps->high_water_alert = 0;
660                         tps_alert_add(tps, -1);
661                 }
662         }
663         return task;
664 }
665
666 long ast_taskprocessor_size(struct ast_taskprocessor *tps)
667 {
668         return (tps) ? tps->tps_queue_size : -1;
669 }
670
671 /* taskprocessor name accessor */
672 const char *ast_taskprocessor_name(struct ast_taskprocessor *tps)
673 {
674         if (!tps) {
675                 ast_log(LOG_ERROR, "no taskprocessor specified!\n");
676                 return NULL;
677         }
678         return tps->name;
679 }
680
681 static void listener_shutdown(struct ast_taskprocessor_listener *listener)
682 {
683         listener->callbacks->shutdown(listener);
684         ao2_ref(listener->tps, -1);
685 }
686
687 static void taskprocessor_listener_dtor(void *obj)
688 {
689         struct ast_taskprocessor_listener *listener = obj;
690
691         if (listener->callbacks->dtor) {
692                 listener->callbacks->dtor(listener);
693         }
694 }
695
696 struct ast_taskprocessor_listener *ast_taskprocessor_listener_alloc(const struct ast_taskprocessor_listener_callbacks *callbacks, void *user_data)
697 {
698         struct ast_taskprocessor_listener *listener;
699
700         listener = ao2_alloc(sizeof(*listener), taskprocessor_listener_dtor);
701         if (!listener) {
702                 return NULL;
703         }
704         listener->callbacks = callbacks;
705         listener->user_data = user_data;
706
707         return listener;
708 }
709
710 struct ast_taskprocessor *ast_taskprocessor_listener_get_tps(const struct ast_taskprocessor_listener *listener)
711 {
712         ao2_ref(listener->tps, +1);
713         return listener->tps;
714 }
715
716 void *ast_taskprocessor_listener_get_user_data(const struct ast_taskprocessor_listener *listener)
717 {
718         return listener->user_data;
719 }
720
721 static void *default_listener_pvt_alloc(void)
722 {
723         struct default_taskprocessor_listener_pvt *pvt;
724
725         pvt = ast_calloc(1, sizeof(*pvt));
726         if (!pvt) {
727                 return NULL;
728         }
729         pvt->poll_thread = AST_PTHREADT_NULL;
730         if (ast_sem_init(&pvt->sem, 0, 0) != 0) {
731                 ast_log(LOG_ERROR, "ast_sem_init(): %s\n", strerror(errno));
732                 ast_free(pvt);
733                 return NULL;
734         }
735         return pvt;
736 }
737
738 static struct ast_taskprocessor *__allocate_taskprocessor(const char *name, struct ast_taskprocessor_listener *listener)
739 {
740         struct ast_taskprocessor *p;
741
742         p = ao2_alloc(sizeof(*p), tps_taskprocessor_dtor);
743         if (!p) {
744                 ast_log(LOG_WARNING, "failed to create taskprocessor '%s'\n", name);
745                 return NULL;
746         }
747
748         /* Set default congestion water level alert triggers. */
749         p->tps_queue_low = (AST_TASKPROCESSOR_HIGH_WATER_LEVEL * 9) / 10;
750         p->tps_queue_high = AST_TASKPROCESSOR_HIGH_WATER_LEVEL;
751
752         p->stats = ast_calloc(1, sizeof(*p->stats));
753         p->name = ast_strdup(name);
754         if (!p->stats || !p->name) {
755                 ao2_ref(p, -1);
756                 return NULL;
757         }
758
759         ao2_ref(listener, +1);
760         p->listener = listener;
761
762         p->thread = AST_PTHREADT_NULL;
763
764         ao2_ref(p, +1);
765         listener->tps = p;
766
767         if (!(ao2_link(tps_singletons, p))) {
768                 ast_log(LOG_ERROR, "Failed to add taskprocessor '%s' to container\n", p->name);
769                 listener->tps = NULL;
770                 ao2_ref(p, -2);
771                 return NULL;
772         }
773
774         if (p->listener->callbacks->start(p->listener)) {
775                 ast_log(LOG_ERROR, "Unable to start taskprocessor listener for taskprocessor %s\n",
776                         p->name);
777                 ast_taskprocessor_unreference(p);
778                 return NULL;
779         }
780
781         return p;
782 }
783
784 /* Provide a reference to a taskprocessor.  Create the taskprocessor if necessary, but don't
785  * create the taskprocessor if we were told via ast_tps_options to return a reference only
786  * if it already exists */
787 struct ast_taskprocessor *ast_taskprocessor_get(const char *name, enum ast_tps_options create)
788 {
789         struct ast_taskprocessor *p;
790         struct ast_taskprocessor_listener *listener;
791         struct default_taskprocessor_listener_pvt *pvt;
792
793         if (ast_strlen_zero(name)) {
794                 ast_log(LOG_ERROR, "requesting a nameless taskprocessor!!!\n");
795                 return NULL;
796         }
797         p = ao2_find(tps_singletons, name, OBJ_KEY);
798         if (p) {
799                 return p;
800         }
801         if (create & TPS_REF_IF_EXISTS) {
802                 /* calling function does not want a new taskprocessor to be created if it doesn't already exist */
803                 return NULL;
804         }
805         /* Create a new taskprocessor. Start by creating a default listener */
806         pvt = default_listener_pvt_alloc();
807         if (!pvt) {
808                 return NULL;
809         }
810         listener = ast_taskprocessor_listener_alloc(&default_listener_callbacks, pvt);
811         if (!listener) {
812                 default_listener_pvt_destroy(pvt);
813                 return NULL;
814         }
815
816         p = __allocate_taskprocessor(name, listener);
817
818         ao2_ref(listener, -1);
819         return p;
820 }
821
822 struct ast_taskprocessor *ast_taskprocessor_create_with_listener(const char *name, struct ast_taskprocessor_listener *listener)
823 {
824         struct ast_taskprocessor *p = ao2_find(tps_singletons, name, OBJ_KEY);
825
826         if (p) {
827                 ast_taskprocessor_unreference(p);
828                 return NULL;
829         }
830         return __allocate_taskprocessor(name, listener);
831 }
832
833 void ast_taskprocessor_set_local(struct ast_taskprocessor *tps,
834         void *local_data)
835 {
836         SCOPED_AO2LOCK(lock, tps);
837         tps->local_data = local_data;
838 }
839
840 /* decrement the taskprocessor reference count and unlink from the container if necessary */
841 void *ast_taskprocessor_unreference(struct ast_taskprocessor *tps)
842 {
843         if (!tps) {
844                 return NULL;
845         }
846
847         /* To prevent another thread from finding and getting a reference to this
848          * taskprocessor we hold the singletons lock. If we didn't do this then
849          * they may acquire it and find that the listener has been shut down.
850          */
851         ao2_lock(tps_singletons);
852
853         if (ao2_ref(tps, -1) > 3) {
854                 ao2_unlock(tps_singletons);
855                 return NULL;
856         }
857
858         /* If we're down to 3 references, then those must be:
859          * 1. The reference we just got rid of
860          * 2. The container
861          * 3. The listener
862          */
863         ao2_unlink_flags(tps_singletons, tps, OBJ_NOLOCK);
864         ao2_unlock(tps_singletons);
865
866         listener_shutdown(tps->listener);
867         return NULL;
868 }
869
870 /* push the task into the taskprocessor queue */
871 static int taskprocessor_push(struct ast_taskprocessor *tps, struct tps_task *t)
872 {
873         int previous_size;
874         int was_empty;
875
876         if (!tps) {
877                 ast_log(LOG_ERROR, "tps is NULL!\n");
878                 return -1;
879         }
880
881         if (!t) {
882                 ast_log(LOG_ERROR, "t is NULL!\n");
883                 return -1;
884         }
885
886         ao2_lock(tps);
887         AST_LIST_INSERT_TAIL(&tps->tps_queue, t, list);
888         previous_size = tps->tps_queue_size++;
889
890         if (tps->tps_queue_high <= tps->tps_queue_size) {
891                 if (!tps->high_water_alert) {
892                         ast_log(LOG_WARNING, "The '%s' task processor queue reached %ld scheduled tasks%s.\n",
893                                 tps->name, tps->tps_queue_size, tps->high_water_warned ? " again" : "");
894                         tps->high_water_warned = 1;
895                         tps->high_water_alert = 1;
896                         tps_alert_add(tps, +1);
897                 }
898         }
899
900         /* The currently executing task counts as still in queue */
901         was_empty = tps->executing ? 0 : previous_size == 0;
902         ao2_unlock(tps);
903         tps->listener->callbacks->task_pushed(tps->listener, was_empty);
904         return 0;
905 }
906
907 int ast_taskprocessor_push(struct ast_taskprocessor *tps, int (*task_exe)(void *datap), void *datap)
908 {
909         return taskprocessor_push(tps, tps_task_alloc(task_exe, datap));
910 }
911
912 int ast_taskprocessor_push_local(struct ast_taskprocessor *tps, int (*task_exe)(struct ast_taskprocessor_local *datap), void *datap)
913 {
914         return taskprocessor_push(tps, tps_task_alloc_local(task_exe, datap));
915 }
916
917 int ast_taskprocessor_suspend(struct ast_taskprocessor *tps)
918 {
919         if (tps) {
920                 ao2_lock(tps);
921                 tps->suspended = 1;
922                 ao2_unlock(tps);
923                 return 0;
924         }
925         return -1;
926 }
927
928 int ast_taskprocessor_unsuspend(struct ast_taskprocessor *tps)
929 {
930         if (tps) {
931                 ao2_lock(tps);
932                 tps->suspended = 0;
933                 ao2_unlock(tps);
934                 return 0;
935         }
936         return -1;
937 }
938
939 int ast_taskprocessor_is_suspended(struct ast_taskprocessor *tps)
940 {
941         return tps ? tps->suspended : -1;
942 }
943
944 int ast_taskprocessor_execute(struct ast_taskprocessor *tps)
945 {
946         struct ast_taskprocessor_local local;
947         struct tps_task *t;
948         long size;
949
950         ao2_lock(tps);
951         t = tps_taskprocessor_pop(tps);
952         if (!t) {
953                 ao2_unlock(tps);
954                 return 0;
955         }
956
957         tps->thread = pthread_self();
958         tps->executing = 1;
959
960         if (t->wants_local) {
961                 local.local_data = tps->local_data;
962                 local.data = t->datap;
963         }
964         ao2_unlock(tps);
965
966         if (t->wants_local) {
967                 t->callback.execute_local(&local);
968         } else {
969                 t->callback.execute(t->datap);
970         }
971         tps_task_free(t);
972
973         ao2_lock(tps);
974         tps->thread = AST_PTHREADT_NULL;
975         /* We need to check size in the same critical section where we reset the
976          * executing bit. Avoids a race condition where a task is pushed right
977          * after we pop an empty stack.
978          */
979         tps->executing = 0;
980         size = ast_taskprocessor_size(tps);
981
982         /* Update the stats */
983         if (tps->stats) {
984                 ++tps->stats->_tasks_processed_count;
985
986                 /* Include the task we just executed as part of the queue size. */
987                 if (size >= tps->stats->max_qsize) {
988                         tps->stats->max_qsize = size + 1;
989                 }
990         }
991         ao2_unlock(tps);
992
993         /* If we executed a task, check for the transition to empty */
994         if (size == 0 && tps->listener->callbacks->emptied) {
995                 tps->listener->callbacks->emptied(tps->listener);
996         }
997         return size > 0;
998 }
999
1000 int ast_taskprocessor_is_task(struct ast_taskprocessor *tps)
1001 {
1002         int is_task;
1003
1004         ao2_lock(tps);
1005         is_task = pthread_equal(tps->thread, pthread_self());
1006         ao2_unlock(tps);
1007         return is_task;
1008 }
1009
1010 unsigned int ast_taskprocessor_seq_num(void)
1011 {
1012         static int seq_num;
1013
1014         return (unsigned int) ast_atomic_fetchadd_int(&seq_num, +1);
1015 }
1016
1017 void ast_taskprocessor_build_name(char *buf, unsigned int size, const char *format, ...)
1018 {
1019         va_list ap;
1020         int user_size;
1021 #define SEQ_STR_SIZE (1 + 8 + 1)        /* Dash plus 8 hex digits plus null terminator */
1022
1023         ast_assert(buf != NULL);
1024         ast_assert(SEQ_STR_SIZE <= size);
1025
1026         va_start(ap, format);
1027         user_size = vsnprintf(buf, size - (SEQ_STR_SIZE - 1), format, ap);
1028         va_end(ap);
1029         if (user_size < 0) {
1030                 /*
1031                  * Wow!  We got an output error to a memory buffer.
1032                  * Assume no user part of name written.
1033                  */
1034                 user_size = 0;
1035         } else if (size < user_size + SEQ_STR_SIZE) {
1036                 /* Truncate user part of name to make sequence number fit. */
1037                 user_size = size - SEQ_STR_SIZE;
1038         }
1039
1040         /* Append sequence number to end of user name. */
1041         snprintf(buf + user_size, SEQ_STR_SIZE, "-%08x", ast_taskprocessor_seq_num());
1042 }