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