Remove alloc and destroy callbacks from the taskprocessor.
[asterisk/asterisk.git] / main / taskprocessor.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2007-2008, 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_FILE_VERSION(__FILE__, "$Revision$")
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
41 /*!
42  * \brief tps_task structure is queued to a taskprocessor
43  *
44  * tps_tasks are processed in FIFO order and freed by the taskprocessing
45  * thread after the task handler returns.  The callback function that is assigned
46  * to the execute() function pointer is responsible for releasing datap resources if necessary.
47  */
48 struct tps_task {
49         /*! \brief The execute() task callback function pointer */
50         int (*execute)(void *datap);
51         /*! \brief The data pointer for the task execute() function */
52         void *datap;
53         /*! \brief AST_LIST_ENTRY overhead */
54         AST_LIST_ENTRY(tps_task) list;
55 };
56
57 /*! \brief tps_taskprocessor_stats maintain statistics for a taskprocessor. */
58 struct tps_taskprocessor_stats {
59         /*! \brief This is the maximum number of tasks queued at any one time */
60         unsigned long max_qsize;
61         /*! \brief This is the current number of tasks processed */
62         unsigned long _tasks_processed_count;
63 };
64
65 /*! \brief A ast_taskprocessor structure is a singleton by name */
66 struct ast_taskprocessor {
67         /*! \brief Friendly name of the taskprocessor */
68         const char *name;
69         /*! \brief Taskprocessor statistics */
70         struct tps_taskprocessor_stats *stats;
71         /*! \brief Taskprocessor current queue size */
72         long tps_queue_size;
73         /*! \brief Taskprocessor queue */
74         AST_LIST_HEAD_NOLOCK(tps_queue, tps_task) tps_queue;
75         /*! \brief Taskprocessor singleton list entry */
76         AST_LIST_ENTRY(ast_taskprocessor) list;
77         struct ast_taskprocessor_listener *listener;
78         /*! Indicates if the taskprocessor is in the process of shuting down */
79         unsigned int shutting_down:1;
80 };
81 #define TPS_MAX_BUCKETS 7
82 /*! \brief tps_singletons is the astobj2 container for taskprocessor singletons */
83 static struct ao2_container *tps_singletons;
84
85 /*! \brief CLI <example>taskprocessor ping &lt;blah&gt;</example> operation requires a ping condition */
86 static ast_cond_t cli_ping_cond;
87
88 /*! \brief CLI <example>taskprocessor ping &lt;blah&gt;</example> operation requires a ping condition lock */
89 AST_MUTEX_DEFINE_STATIC(cli_ping_cond_lock);
90
91 /*! \brief The astobj2 hash callback for taskprocessors */
92 static int tps_hash_cb(const void *obj, const int flags);
93 /*! \brief The astobj2 compare callback for taskprocessors */
94 static int tps_cmp_cb(void *obj, void *arg, int flags);
95
96 /*! \brief The task processing function executed by a taskprocessor */
97 static void *tps_processing_function(void *data);
98
99 /*! \brief Destroy the taskprocessor when its refcount reaches zero */
100 static void tps_taskprocessor_destroy(void *tps);
101
102 /*! \brief CLI <example>taskprocessor ping &lt;blah&gt;</example> handler function */
103 static int tps_ping_handler(void *datap);
104
105 /*! \brief Remove the front task off the taskprocessor queue */
106 static struct tps_task *tps_taskprocessor_pop(struct ast_taskprocessor *tps);
107
108 /*! \brief Return the size of the taskprocessor queue */
109 static int tps_taskprocessor_depth(struct ast_taskprocessor *tps);
110
111 static char *cli_tps_ping(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
112 static char *cli_tps_report(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
113
114 static struct ast_cli_entry taskprocessor_clis[] = {
115         AST_CLI_DEFINE(cli_tps_ping, "Ping a named task processor"),
116         AST_CLI_DEFINE(cli_tps_report, "List instantiated task processors and statistics"),
117 };
118
119 struct default_taskprocessor_listener_pvt {
120         pthread_t poll_thread;
121         ast_mutex_t lock;
122         ast_cond_t cond;
123         int wake_up;
124         int dead;
125 };
126
127
128 static void default_tps_wake_up(struct default_taskprocessor_listener_pvt *pvt, int should_die)
129 {
130         SCOPED_MUTEX(lock, &pvt->lock);
131         pvt->wake_up = 1;
132         pvt->dead = should_die;
133         ast_cond_signal(&pvt->cond);
134 }
135
136 static int default_tps_idle(struct default_taskprocessor_listener_pvt *pvt)
137 {
138         SCOPED_MUTEX(lock, &pvt->lock);
139         while (!pvt->wake_up) {
140                 ast_cond_wait(&pvt->cond, lock);
141         }
142         pvt->wake_up = 0;
143         return pvt->dead;
144 }
145
146 /*!
147  * \brief Function that processes tasks in the taskprocessor
148  * \internal
149  */
150 static void *tps_processing_function(void *data)
151 {
152         struct ast_taskprocessor_listener *listener = data;
153         struct ast_taskprocessor *tps = listener->tps;
154         struct default_taskprocessor_listener_pvt *pvt = listener->user_data;
155         int dead = 0;
156
157         while (!dead) {
158                 if (!ast_taskprocessor_execute(tps)) {
159                         dead = default_tps_idle(pvt);
160                 }
161         }
162         return NULL;
163 }
164
165 static int default_listener_start(struct ast_taskprocessor_listener *listener)
166 {
167         struct default_taskprocessor_listener_pvt *pvt = listener->user_data;
168
169         if (ast_pthread_create(&pvt->poll_thread, NULL, tps_processing_function, listener)) {
170                 return -1;
171         }
172
173         return 0;
174 }
175
176 static void default_task_pushed(struct ast_taskprocessor_listener *listener, int was_empty)
177 {
178         struct default_taskprocessor_listener_pvt *pvt = listener->user_data;
179
180         if (was_empty) {
181                 default_tps_wake_up(pvt, 0);
182         }
183 }
184
185 static void default_listener_pvt_destroy(struct default_taskprocessor_listener_pvt *pvt)
186 {
187         ast_mutex_destroy(&pvt->lock);
188         ast_cond_destroy(&pvt->cond);
189         ast_free(pvt);
190 }
191
192 static void default_listener_shutdown(struct ast_taskprocessor_listener *listener)
193 {
194         struct default_taskprocessor_listener_pvt *pvt = listener->user_data;
195         default_tps_wake_up(pvt, 1);
196         pthread_join(pvt->poll_thread, NULL);
197         pvt->poll_thread = AST_PTHREADT_NULL;
198         default_listener_pvt_destroy(pvt);
199 }
200
201 static const struct ast_taskprocessor_listener_callbacks default_listener_callbacks = {
202         .start = default_listener_start,
203         .task_pushed = default_task_pushed,
204         .shutdown = default_listener_shutdown,
205 };
206
207 /*!
208  * \internal
209  * \brief Clean up resources on Asterisk shutdown
210  */
211 static void tps_shutdown(void)
212 {
213         ast_cli_unregister_multiple(taskprocessor_clis, ARRAY_LEN(taskprocessor_clis));
214         ao2_t_ref(tps_singletons, -1, "Unref tps_singletons in shutdown");
215         tps_singletons = NULL;
216 }
217
218 /* initialize the taskprocessor container and register CLI operations */
219 int ast_tps_init(void)
220 {
221         if (!(tps_singletons = ao2_container_alloc(TPS_MAX_BUCKETS, tps_hash_cb, tps_cmp_cb))) {
222                 ast_log(LOG_ERROR, "taskprocessor container failed to initialize!\n");
223                 return -1;
224         }
225
226         ast_cond_init(&cli_ping_cond, NULL);
227
228         ast_cli_register_multiple(taskprocessor_clis, ARRAY_LEN(taskprocessor_clis));
229
230         ast_register_atexit(tps_shutdown);
231
232         return 0;
233 }
234
235 /* allocate resources for the task */
236 static struct tps_task *tps_task_alloc(int (*task_exe)(void *datap), void *datap)
237 {
238         struct tps_task *t;
239         if ((t = ast_calloc(1, sizeof(*t)))) {
240                 t->execute = task_exe;
241                 t->datap = datap;
242         }
243         return t;
244 }
245
246 /* release task resources */
247 static void *tps_task_free(struct tps_task *task)
248 {
249         if (task) {
250                 ast_free(task);
251         }
252         return NULL;
253 }
254
255 /* taskprocessor tab completion */
256 static char *tps_taskprocessor_tab_complete(struct ast_taskprocessor *p, struct ast_cli_args *a)
257 {
258         int tklen;
259         int wordnum = 0;
260         char *name = NULL;
261         struct ao2_iterator i;
262
263         if (a->pos != 3)
264                 return NULL;
265
266         tklen = strlen(a->word);
267         i = ao2_iterator_init(tps_singletons, 0);
268         while ((p = ao2_iterator_next(&i))) {
269                 if (!strncasecmp(a->word, p->name, tklen) && ++wordnum > a->n) {
270                         name = ast_strdup(p->name);
271                         ao2_ref(p, -1);
272                         break;
273                 }
274                 ao2_ref(p, -1);
275         }
276         ao2_iterator_destroy(&i);
277         return name;
278 }
279
280 /* ping task handling function */
281 static int tps_ping_handler(void *datap)
282 {
283         ast_mutex_lock(&cli_ping_cond_lock);
284         ast_cond_signal(&cli_ping_cond);
285         ast_mutex_unlock(&cli_ping_cond_lock);
286         return 0;
287 }
288
289 /* ping the specified taskprocessor and display the ping time on the CLI */
290 static char *cli_tps_ping(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
291 {
292         struct timeval begin, end, delta;
293         const char *name;
294         struct timeval when;
295         struct timespec ts;
296         struct ast_taskprocessor *tps = NULL;
297
298         switch (cmd) {
299         case CLI_INIT:
300                 e->command = "core ping taskprocessor";
301                 e->usage =
302                         "Usage: core ping taskprocessor <taskprocessor>\n"
303                         "       Displays the time required for a task to be processed\n";
304                 return NULL;
305         case CLI_GENERATE:
306                 return tps_taskprocessor_tab_complete(tps, a);
307         }
308
309         if (a->argc != 4)
310                 return CLI_SHOWUSAGE;
311
312         name = a->argv[3];
313         if (!(tps = ast_taskprocessor_get(name, TPS_REF_IF_EXISTS))) {
314                 ast_cli(a->fd, "\nping failed: %s not found\n\n", name);
315                 return CLI_SUCCESS;
316         }
317         ast_cli(a->fd, "\npinging %s ...", name);
318         when = ast_tvadd((begin = ast_tvnow()), ast_samp2tv(1000, 1000));
319         ts.tv_sec = when.tv_sec;
320         ts.tv_nsec = when.tv_usec * 1000;
321         ast_mutex_lock(&cli_ping_cond_lock);
322         if (ast_taskprocessor_push(tps, tps_ping_handler, 0) < 0) {
323                 ast_cli(a->fd, "\nping failed: could not push task to %s\n\n", name);
324                 ao2_ref(tps, -1);
325                 return CLI_FAILURE;
326         }
327         ast_cond_timedwait(&cli_ping_cond, &cli_ping_cond_lock, &ts);
328         ast_mutex_unlock(&cli_ping_cond_lock);
329         end = ast_tvnow();
330         delta = ast_tvsub(end, begin);
331         ast_cli(a->fd, "\n\t%24s ping time: %.1ld.%.6ld sec\n\n", name, (long)delta.tv_sec, (long int)delta.tv_usec);
332         ao2_ref(tps, -1);
333         return CLI_SUCCESS;
334 }
335
336 static char *cli_tps_report(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
337 {
338         char name[256];
339         int tcount;
340         unsigned long qsize;
341         unsigned long maxqsize;
342         unsigned long processed;
343         struct ast_taskprocessor *p;
344         struct ao2_iterator i;
345
346         switch (cmd) {
347         case CLI_INIT:
348                 e->command = "core show taskprocessors";
349                 e->usage =
350                         "Usage: core show taskprocessors\n"
351                         "       Shows a list of instantiated task processors and their statistics\n";
352                 return NULL;
353         case CLI_GENERATE:
354                 return NULL;
355         }
356
357         if (a->argc != e->args)
358                 return CLI_SHOWUSAGE;
359
360         ast_cli(a->fd, "\n\t+----- Processor -----+--- Processed ---+- In Queue -+- Max Depth -+");
361         i = ao2_iterator_init(tps_singletons, 0);
362         while ((p = ao2_iterator_next(&i))) {
363                 ast_copy_string(name, p->name, sizeof(name));
364                 qsize = p->tps_queue_size;
365                 maxqsize = p->stats->max_qsize;
366                 processed = p->stats->_tasks_processed_count;
367                 ast_cli(a->fd, "\n%24s   %17ld %12ld %12ld", name, processed, qsize, maxqsize);
368                 ao2_ref(p, -1);
369         }
370         ao2_iterator_destroy(&i);
371         tcount = ao2_container_count(tps_singletons);
372         ast_cli(a->fd, "\n\t+---------------------+-----------------+------------+-------------+\n\t%d taskprocessors\n\n", tcount);
373         return CLI_SUCCESS;
374 }
375
376 /* hash callback for astobj2 */
377 static int tps_hash_cb(const void *obj, const int flags)
378 {
379         const struct ast_taskprocessor *tps = obj;
380         const char *name = flags & OBJ_KEY ? obj : tps->name;
381
382         return ast_str_case_hash(name);
383 }
384
385 /* compare callback for astobj2 */
386 static int tps_cmp_cb(void *obj, void *arg, int flags)
387 {
388         struct ast_taskprocessor *lhs = obj, *rhs = arg;
389         const char *rhsname = flags & OBJ_KEY ? arg : rhs->name;
390
391         return !strcasecmp(lhs->name, rhsname) ? CMP_MATCH | CMP_STOP : 0;
392 }
393
394 /* destroy the taskprocessor */
395 static void tps_taskprocessor_destroy(void *tps)
396 {
397         struct ast_taskprocessor *t = tps;
398         struct tps_task *task;
399
400         if (!tps) {
401                 ast_log(LOG_ERROR, "missing taskprocessor\n");
402                 return;
403         }
404         ast_debug(1, "destroying taskprocessor '%s'\n", t->name);
405         /* free it */
406         if (t->stats) {
407                 ast_free(t->stats);
408                 t->stats = NULL;
409         }
410         ast_free((char *) t->name);
411         if (t->listener) {
412                 /* This code should not be reached since the listener
413                  * should have been destroyed before the taskprocessor could
414                  * be destroyed
415                  */
416                 ao2_ref(t->listener, -1);
417                 t->listener = NULL;
418         }
419         while ((task = AST_LIST_REMOVE_HEAD(&t->tps_queue, list))) {
420                 tps_task_free(task);
421         }
422 }
423
424 /* pop the front task and return it */
425 static struct tps_task *tps_taskprocessor_pop(struct ast_taskprocessor *tps)
426 {
427         struct tps_task *task;
428         SCOPED_AO2LOCK(lock, tps);
429
430         if (tps->shutting_down) {
431                 return NULL;
432         }
433
434         if ((task = AST_LIST_REMOVE_HEAD(&tps->tps_queue, list))) {
435                 tps->tps_queue_size--;
436         }
437         return task;
438 }
439
440 static int tps_taskprocessor_depth(struct ast_taskprocessor *tps)
441 {
442         return (tps) ? tps->tps_queue_size : -1;
443 }
444
445 /* taskprocessor name accessor */
446 const char *ast_taskprocessor_name(struct ast_taskprocessor *tps)
447 {
448         if (!tps) {
449                 ast_log(LOG_ERROR, "no taskprocessor specified!\n");
450                 return NULL;
451         }
452         return tps->name;
453 }
454
455 static void listener_shutdown(struct ast_taskprocessor_listener *listener)
456 {
457         listener->callbacks->shutdown(listener);
458         ao2_ref(listener->tps, -1);
459 }
460
461 struct ast_taskprocessor_listener *ast_taskprocessor_listener_alloc(const struct ast_taskprocessor_listener_callbacks *callbacks, void *user_data)
462 {
463         RAII_VAR(struct ast_taskprocessor_listener *, listener,
464                         ao2_alloc(sizeof(*listener), NULL), ao2_cleanup);
465
466         if (!listener) {
467                 return NULL;
468         }
469         listener->callbacks = callbacks;
470         listener->user_data = user_data;
471
472         ao2_ref(listener, +1);
473         return listener;
474 }
475
476 static void *default_listener_pvt_alloc(void)
477 {
478         struct default_taskprocessor_listener_pvt *pvt;
479
480         pvt = ast_calloc(1, sizeof(*pvt));
481         if (!pvt) {
482                 return NULL;
483         }
484         ast_cond_init(&pvt->cond, NULL);
485         ast_mutex_init(&pvt->lock);
486         pvt->poll_thread = AST_PTHREADT_NULL;
487         return pvt;
488 }
489
490 /* Provide a reference to a taskprocessor.  Create the taskprocessor if necessary, but don't
491  * create the taskprocessor if we were told via ast_tps_options to return a reference only
492  * if it already exists */
493 struct ast_taskprocessor *ast_taskprocessor_get(const char *name, enum ast_tps_options create)
494 {
495         struct ast_taskprocessor *p;
496         struct ast_taskprocessor_listener *listener;
497         struct default_taskprocessor_listener_pvt *pvt;
498
499         if (ast_strlen_zero(name)) {
500                 ast_log(LOG_ERROR, "requesting a nameless taskprocessor!!!\n");
501                 return NULL;
502         }
503         p = ao2_find(tps_singletons, name, OBJ_KEY);
504         if (p) {
505                 return p;
506         }
507         if (create & TPS_REF_IF_EXISTS) {
508                 /* calling function does not want a new taskprocessor to be created if it doesn't already exist */
509                 return NULL;
510         }
511         /* Create a new taskprocessor. Start by creating a default listener */
512         pvt = default_listener_pvt_alloc();
513         if (!pvt) {
514                 return NULL;
515         }
516         listener = ast_taskprocessor_listener_alloc(&default_listener_callbacks, pvt);
517         if (!listener) {
518                 default_listener_pvt_destroy(pvt);
519                 return NULL;
520         }
521
522         p = ast_taskprocessor_create_with_listener(name, listener);
523         if (!p) {
524                 default_listener_pvt_destroy(pvt);
525                 ao2_ref(listener, -1);
526                 return NULL;
527         }
528
529         /* Unref listener here since the taskprocessor has gained a reference to the listener */
530         ao2_ref(listener, -1);
531         return p;
532
533 }
534
535 struct ast_taskprocessor *ast_taskprocessor_create_with_listener(const char *name, struct ast_taskprocessor_listener *listener)
536 {
537         RAII_VAR(struct ast_taskprocessor *, p,
538                         ao2_alloc(sizeof(*p), tps_taskprocessor_destroy),
539                         ao2_cleanup);
540
541         if (!p) {
542                 ast_log(LOG_WARNING, "failed to create taskprocessor '%s'\n", name);
543                 return NULL;
544         }
545
546         if (!(p->stats = ast_calloc(1, sizeof(*p->stats)))) {
547                 ast_log(LOG_WARNING, "failed to create taskprocessor stats for '%s'\n", name);
548                 return NULL;
549         }
550         if (!(p->name = ast_strdup(name))) {
551                 ao2_ref(p, -1);
552                 return NULL;
553         }
554
555         ao2_ref(listener, +1);
556         p->listener = listener;
557
558         ao2_ref(p, +1);
559         listener->tps = p;
560
561         if (!(ao2_link(tps_singletons, p))) {
562                 ast_log(LOG_ERROR, "Failed to add taskprocessor '%s' to container\n", p->name);
563                 return NULL;
564         }
565
566         if (p->listener->callbacks->start(p->listener)) {
567                 ast_log(LOG_ERROR, "Unable to start taskprocessor listener for taskprocessor %s\n", p->name);
568                 ast_taskprocessor_unreference(p);
569                 return NULL;
570         }
571
572         /* RAII_VAR will decrement the refcount at the end of the function.
573          * Since we want to pass back a reference to p, we bump the refcount
574          */
575         ao2_ref(p, +1);
576         return p;
577 }
578
579 /* decrement the taskprocessor reference count and unlink from the container if necessary */
580 void *ast_taskprocessor_unreference(struct ast_taskprocessor *tps)
581 {
582         if (!tps) {
583                 return NULL;
584         }
585
586         if (ao2_ref(tps, -1) > 3) {
587                 return NULL;
588         }
589         /* If we're down to 3 references, then those must be:
590          * 1. The reference we just got rid of
591          * 2. The container
592          * 3. The listener
593          */
594         ao2_unlink(tps_singletons, tps);
595         listener_shutdown(tps->listener);
596         return NULL;
597 }
598
599 /* push the task into the taskprocessor queue */
600 int ast_taskprocessor_push(struct ast_taskprocessor *tps, int (*task_exe)(void *datap), void *datap)
601 {
602         struct tps_task *t;
603         int previous_size;
604
605         if (!tps || !task_exe) {
606                 ast_log(LOG_ERROR, "%s is missing!!\n", (tps) ? "task callback" : "taskprocessor");
607                 return -1;
608         }
609         if (!(t = tps_task_alloc(task_exe, datap))) {
610                 ast_log(LOG_ERROR, "failed to allocate task!  Can't push to '%s'\n", tps->name);
611                 return -1;
612         }
613         ao2_lock(tps);
614         AST_LIST_INSERT_TAIL(&tps->tps_queue, t, list);
615         previous_size = tps->tps_queue_size++;
616         ao2_unlock(tps);
617         tps->listener->callbacks->task_pushed(tps->listener, previous_size ? 0 : 1);
618         return 0;
619 }
620
621 int ast_taskprocessor_execute(struct ast_taskprocessor *tps)
622 {
623         struct tps_task *t;
624         int size;
625
626         if (!(t = tps_taskprocessor_pop(tps))) {
627                 return 0;
628         }
629
630         t->execute(t->datap);
631
632         tps_task_free(t);
633
634         ao2_lock(tps);
635         size = tps_taskprocessor_depth(tps);
636         if (tps->stats) {
637                 tps->stats->_tasks_processed_count++;
638                 if (size > tps->stats->max_qsize) {
639                         tps->stats->max_qsize = size;
640                 }
641         }
642         ao2_unlock(tps);
643
644         if (size == 0 && tps->listener->callbacks->emptied) {
645                 tps->listener->callbacks->emptied(tps->listener);
646                 return 0;
647         }
648         return 1;
649 }