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