Add API calls for iterating through an event. This should allow events to have multip...
[asterisk/asterisk.git] / main / event.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2007, Digium, Inc.
5  *
6  * Russell Bryant <russell@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Internal generic event system
22  *
23  * \author Russell Bryant <russell@digium.com>
24  */
25
26 #include "asterisk.h"
27
28 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
29
30 #include <stdlib.h>
31 #include <stdio.h>
32
33 #include "asterisk/event.h"
34 #include "asterisk/linkedlists.h"
35 #include "asterisk/lock.h"
36 #include "asterisk/utils.h"
37
38 /* Only use one thread for now to ensure ordered delivery */
39 #define NUM_EVENT_THREADS 1
40
41 struct ast_event_ie {
42         enum ast_event_ie_type ie_type:16;
43         /*! Total length of the IE payload */
44         uint16_t ie_payload_len;
45         unsigned char ie_payload[0];
46 } __attribute__ ((packed));
47
48 /*!
49  * \brief An event
50  *
51  * \note The format of this structure is important, and can not change, since
52  *       they are sent directly over the network (via IAX2).
53  *
54  */
55 struct ast_event {
56         /*! Event type */
57         enum ast_event_type type:16;
58         /*! Total length of the event */
59         uint16_t event_len:16;
60         /*! The data payload of the event, made up of information elements */
61         unsigned char payload[0];
62 } __attribute__ ((packed));
63
64 struct ast_event_ref {
65         struct ast_event *event;
66         AST_LIST_ENTRY(ast_event_ref) entry;
67 };
68
69 struct ast_event_iterator {
70         uint16_t event_len;
71         const struct ast_event *event;
72         struct ast_event_ie *ie;
73 };
74
75 /*! \brief data shared between event dispatching threads */
76 static struct {
77         ast_cond_t cond;
78         ast_mutex_t lock;
79         AST_LIST_HEAD_NOLOCK(, ast_event_ref) event_q;
80 } event_thread = {
81         .lock = AST_MUTEX_INIT_VALUE,
82 };
83
84 struct ast_event_ie_val {
85         AST_LIST_ENTRY(ast_event_ie_val) entry;
86         enum ast_event_ie_type ie_type;
87         enum ast_event_ie_pltype ie_pltype;
88         union {
89                 uint32_t uint;
90                 const char *str;
91         } payload;
92 };
93
94 /*! \brief Event subscription */
95 struct ast_event_sub {
96         enum ast_event_type type;
97         ast_event_cb_t cb;
98         void *userdata;
99         uint32_t uniqueid;
100         AST_LIST_HEAD_NOLOCK(, ast_event_ie_val) ie_vals;
101         AST_RWLIST_ENTRY(ast_event_sub) entry;
102 };
103
104 static uint32_t sub_uniqueid;
105
106 /*! \brief Event subscriptions
107  * The event subscribers are indexed by which event they are subscribed to */
108 static AST_RWLIST_HEAD(ast_event_sub_list, ast_event_sub) ast_event_subs[AST_EVENT_TOTAL];
109
110 /*! \brief Cached events
111  * The event cache is indexed on the event type.  The purpose of this is 
112  * for events that express some sort of state.  So, when someone first
113  * needs to know this state, it can get the last known state from the cache. */
114 static AST_RWLIST_HEAD(ast_event_ref_list, ast_event_ref) ast_event_cache[AST_EVENT_TOTAL];
115
116 static void ast_event_ie_val_destroy(struct ast_event_ie_val *ie_val)
117 {
118         if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_STR)
119                 ast_free((void *) ie_val->payload.str);
120
121         ast_free(ie_val);
122 }
123
124 enum ast_event_subscriber_res ast_event_check_subscriber(enum ast_event_type type, ...)
125 {
126         va_list ap;
127         enum ast_event_ie_type ie_type;
128         enum ast_event_subscriber_res res = AST_EVENT_SUB_NONE;
129         struct ast_event_ie_val *ie_val, *sub_ie_val;
130         struct ast_event_sub *sub;
131         AST_LIST_HEAD_NOLOCK_STATIC(ie_vals, ast_event_ie_val);
132
133         if (type >= AST_EVENT_TOTAL) {
134                 ast_log(LOG_ERROR, "%u is an invalid type!\n", type);
135                 return res;
136         }
137
138         va_start(ap, type);
139         for (ie_type = va_arg(ap, enum ast_event_type);
140                 ie_type != AST_EVENT_IE_END;
141                 ie_type = va_arg(ap, enum ast_event_type))
142         {
143                 struct ast_event_ie_val *ie_val = alloca(sizeof(*ie_val));
144                 memset(ie_val, 0, sizeof(*ie_val));
145                 ie_val->ie_type = ie_type;
146                 ie_val->ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
147                 if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_UINT)
148                         ie_val->payload.uint = va_arg(ap, uint32_t);
149                 else if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_STR)
150                         ie_val->payload.str = ast_strdupa(va_arg(ap, const char *));
151                 AST_LIST_INSERT_TAIL(&ie_vals, ie_val, entry);
152         }
153         va_end(ap);
154
155         AST_RWLIST_RDLOCK(&ast_event_subs[type]);
156         AST_RWLIST_TRAVERSE(&ast_event_subs[type], sub, entry) {
157                 AST_LIST_TRAVERSE(&ie_vals, ie_val, entry) {
158                         AST_LIST_TRAVERSE(&sub->ie_vals, sub_ie_val, entry) {
159                                 if (sub_ie_val->ie_type == ie_val->ie_type)
160                                         break;
161                         }
162                         if (!sub_ie_val) {
163                                 if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_EXISTS)
164                                         break;
165                                 continue;
166                         }
167                         /* The subscriber doesn't actually care what the value is */
168                         if (sub_ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_EXISTS)
169                                 continue;
170                         if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_UINT &&
171                                 ie_val->payload.uint != sub_ie_val->payload.uint)
172                                 break;
173                         if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_STR &&
174                                 strcmp(ie_val->payload.str, sub_ie_val->payload.str))
175                                 break;
176                 }
177                 if (!ie_val)
178                         break;
179         }
180         AST_RWLIST_UNLOCK(&ast_event_subs[type]);
181
182         if (sub) /* All parameters were matched */
183                 return AST_EVENT_SUB_EXISTS;
184
185         AST_RWLIST_RDLOCK(&ast_event_subs[AST_EVENT_ALL]);
186         if (!AST_LIST_EMPTY(&ast_event_subs[AST_EVENT_ALL]))
187                 res = AST_EVENT_SUB_EXISTS;
188         AST_RWLIST_UNLOCK(&ast_event_subs[AST_EVENT_ALL]);
189
190         return res;
191 }
192
193 /*! \brief Send AST_EVENT_SUB events to this subscriber of ... subscriber events */
194 void ast_event_report_subs(const struct ast_event_sub *event_sub)
195 {
196         struct ast_event *event;
197         struct ast_event_sub *sub;
198         enum ast_event_type event_type = -1;
199         struct ast_event_ie_val *ie_val;
200
201         if (event_sub->type != AST_EVENT_SUB)
202                 return;
203
204         AST_LIST_TRAVERSE(&event_sub->ie_vals, ie_val, entry) {
205                 if (ie_val->ie_type == AST_EVENT_IE_EVENTTYPE) {
206                         event_type = ie_val->payload.uint;
207                         break;
208                 }
209         }
210
211         if (event_type == -1)
212                 return;
213
214         AST_RWLIST_RDLOCK(&ast_event_subs[event_type]);
215         AST_RWLIST_TRAVERSE(&ast_event_subs[event_type], sub, entry) {
216                 if (event_sub == sub)
217                         continue;
218
219                 event = ast_event_new(AST_EVENT_SUB,
220                         AST_EVENT_IE_UNIQUEID,  AST_EVENT_IE_PLTYPE_UINT, sub->uniqueid,
221                         AST_EVENT_IE_EVENTTYPE, AST_EVENT_IE_PLTYPE_UINT, sub->type,
222                         AST_EVENT_IE_END);
223
224                 AST_LIST_TRAVERSE(&sub->ie_vals, ie_val, entry) {
225                         switch (ie_val->ie_pltype) {
226                         case AST_EVENT_IE_PLTYPE_EXISTS:
227                                 ast_event_append_ie_uint(&event, AST_EVENT_IE_EXISTS, ie_val->ie_type);
228                                 break;
229                         case AST_EVENT_IE_PLTYPE_UINT:
230                                 ast_event_append_ie_uint(&event, ie_val->ie_type, ie_val->payload.uint);
231                                 break;
232                         case AST_EVENT_IE_PLTYPE_STR:
233                                 ast_event_append_ie_str(&event, ie_val->ie_type, ie_val->payload.str);
234                                 break;
235                         }
236                         if (!event)
237                                 break;
238                 }
239
240                 if (!event)
241                         continue;
242
243                 event_sub->cb(event, event_sub->userdata);
244
245                 ast_event_destroy(event);
246         }
247         AST_RWLIST_UNLOCK(&ast_event_subs[event_type]);
248 }
249
250 struct ast_event_sub *ast_event_subscribe(enum ast_event_type type, ast_event_cb_t cb, 
251         void *userdata, ...)
252 {
253         va_list ap;
254         enum ast_event_ie_type ie_type;
255         struct ast_event_sub *sub;
256         struct ast_event *event;
257
258         if (type >= AST_EVENT_TOTAL) {
259                 ast_log(LOG_ERROR, "%u is an invalid type!\n", type);
260                 return NULL;
261         }
262
263         if (!(sub = ast_calloc(1, sizeof(*sub))))
264                 return NULL;
265
266         va_start(ap, userdata);
267         for (ie_type = va_arg(ap, enum ast_event_type);
268                 ie_type != AST_EVENT_IE_END;
269                 ie_type = va_arg(ap, enum ast_event_type))
270         {
271                 struct ast_event_ie_val *ie_val;
272                 if (!(ie_val = ast_calloc(1, sizeof(*ie_val))))
273                         continue;
274                 ie_val->ie_type = ie_type;
275                 ie_val->ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
276                 if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_UINT)
277                         ie_val->payload.uint = va_arg(ap, uint32_t);
278                 else if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_STR) {
279                         if (!(ie_val->payload.str = ast_strdup(va_arg(ap, const char *)))) {
280                                 ast_free(ie_val);
281                                 continue;
282                         }
283                 }
284                 AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
285         }
286         va_end(ap);
287
288         sub->type = type;
289         sub->cb = cb;
290         sub->userdata = userdata;
291         sub->uniqueid = ast_atomic_fetchadd_int((int *) &sub_uniqueid, 1);
292
293         if (ast_event_check_subscriber(AST_EVENT_SUB,
294                 AST_EVENT_IE_EVENTTYPE, AST_EVENT_IE_PLTYPE_UINT, type,
295                 AST_EVENT_IE_END) != AST_EVENT_SUB_NONE) {
296                 struct ast_event_ie_val *ie_val;
297
298                 event = ast_event_new(AST_EVENT_SUB,
299                         AST_EVENT_IE_UNIQUEID,  AST_EVENT_IE_PLTYPE_UINT, sub->uniqueid,
300                         AST_EVENT_IE_EVENTTYPE, AST_EVENT_IE_PLTYPE_UINT, sub->type,
301                         AST_EVENT_IE_END);
302
303                 AST_LIST_TRAVERSE(&sub->ie_vals, ie_val, entry) {
304                         switch (ie_val->ie_pltype) {
305                         case AST_EVENT_IE_PLTYPE_EXISTS:
306                                 ast_event_append_ie_uint(&event, AST_EVENT_IE_EXISTS, ie_val->ie_type);
307                                 break;
308                         case AST_EVENT_IE_PLTYPE_UINT:
309                                 ast_event_append_ie_uint(&event, ie_val->ie_type, ie_val->payload.uint);
310                                 break;
311                         case AST_EVENT_IE_PLTYPE_STR:
312                                 ast_event_append_ie_str(&event, ie_val->ie_type, ie_val->payload.str);
313                                 break;
314                         }
315                         if (!event)
316                                 break;
317                 }
318
319                 if (event)
320                         ast_event_queue(event);
321         }
322
323         AST_RWLIST_WRLOCK(&ast_event_subs[type]);
324         AST_RWLIST_INSERT_TAIL(&ast_event_subs[type], sub, entry);
325         AST_RWLIST_UNLOCK(&ast_event_subs[type]);
326
327         return sub;
328 }
329
330 static void ast_event_sub_destroy(struct ast_event_sub *sub)
331 {
332         struct ast_event_ie_val *ie_val;
333
334         while ((ie_val = AST_LIST_REMOVE_HEAD(&sub->ie_vals, entry)))
335                 ast_event_ie_val_destroy(ie_val);
336
337         ast_free(sub);
338 }
339
340 void ast_event_unsubscribe(struct ast_event_sub *sub)
341 {
342         struct ast_event *event;
343
344         AST_RWLIST_WRLOCK(&ast_event_subs[sub->type]);
345         AST_LIST_REMOVE(&ast_event_subs[sub->type], sub, entry);
346         AST_RWLIST_UNLOCK(&ast_event_subs[sub->type]);
347
348         if (ast_event_check_subscriber(AST_EVENT_UNSUB,
349                 AST_EVENT_IE_EVENTTYPE, AST_EVENT_IE_PLTYPE_UINT, sub->type,
350                 AST_EVENT_IE_END) != AST_EVENT_SUB_NONE) {
351                 
352                 event = ast_event_new(AST_EVENT_UNSUB,
353                         AST_EVENT_IE_UNIQUEID,  AST_EVENT_IE_PLTYPE_UINT, sub->uniqueid,
354                         AST_EVENT_IE_EVENTTYPE, AST_EVENT_IE_PLTYPE_UINT, sub->type,
355                         AST_EVENT_IE_END);
356
357                 if (event)
358                         ast_event_queue(event);
359         }
360
361         ast_event_sub_destroy(sub);
362 }
363
364 void ast_event_iterator_init(struct ast_event_iterator *iterator, const struct ast_event *event)
365 {
366         iterator->event_len = ntohs(event->event_len);
367         iterator->event = event;
368         iterator->ie = ((void *) event) + sizeof(*event);
369         return;
370 }
371
372 int ast_event_iterator_next(struct ast_event_iterator *iterator)
373 {
374         iterator->ie = ((void *) iterator->ie) + sizeof(*iterator->ie) + ntohs(iterator->ie->ie_payload_len);
375         return ((iterator->event_len > (((void *) iterator->ie) - ((void *) iterator->event))) ? -1 : 0);
376 }
377
378 enum ast_event_ie_type ast_event_iterator_get_ie_type(struct ast_event_iterator *iterator)
379 {
380         return iterator->ie->ie_type;
381 }
382
383 uint32_t ast_event_iteragor_get_ie_uint(struct ast_event_iterator *iterator)
384 {
385         return ntohl(*iterator->ie->ie_payload);
386 }
387
388 const char *ast_event_iterator_get_ie_str(struct ast_event_iterator *iterator)
389 {
390         return (const char*)iterator->ie->ie_payload;
391 }
392
393 void *ast_event_iterator_get_ie_raw(struct ast_event_iterator *iterator)
394 {
395         return iterator->ie->ie_payload;
396 }
397
398 enum ast_event_type ast_event_get_type(const struct ast_event *event)
399 {
400         return ntohs(event->type);
401 }
402
403 uint32_t ast_event_get_ie_uint(const struct ast_event *event, enum ast_event_ie_type ie_type)
404 {
405         const uint32_t *ie_val;
406
407         ie_val = ast_event_get_ie_raw(event, ie_type);
408
409         return ie_val ? ntohl(*ie_val) : 0;
410 }
411
412 const char *ast_event_get_ie_str(const struct ast_event *event, enum ast_event_ie_type ie_type)
413 {
414         return ast_event_get_ie_raw(event, ie_type);
415 }
416
417 const void *ast_event_get_ie_raw(const struct ast_event *event, enum ast_event_ie_type ie_type)
418 {
419         struct ast_event_iterator iterator;
420
421         for (ast_event_iterator_init(&iterator, event); !ast_event_iterator_next(&iterator); ) {
422                 if (ast_event_iterator_get_ie_type(&iterator) == ie_type)
423                         return ast_event_iterator_get_ie_raw(&iterator);
424         }
425
426         return NULL;
427 }
428
429 int ast_event_append_ie_str(struct ast_event **event, enum ast_event_ie_type ie_type,
430         const char *str)
431 {
432         return ast_event_append_ie_raw(event, ie_type, str, strlen(str) + 1);
433 }
434
435 int ast_event_append_ie_uint(struct ast_event **event, enum ast_event_ie_type ie_type,
436         uint32_t data)
437 {
438         data = htonl(data);
439         return ast_event_append_ie_raw(event, ie_type, &data, sizeof(data));
440 }
441
442 int ast_event_append_ie_raw(struct ast_event **event, enum ast_event_ie_type ie_type,
443         const void *data, size_t data_len)
444 {
445         struct ast_event_ie *ie;
446         unsigned int extra_len;
447         uint16_t event_len;
448
449         event_len = ntohs((*event)->event_len);
450         extra_len = sizeof(*ie) + data_len;
451
452         if (!(*event = ast_realloc(*event, event_len + extra_len)))
453                 return -1;
454
455         ie = ((void *) *event) + event_len;
456         ie->ie_type = htons(ie_type);
457         ie->ie_payload_len = htons(data_len);
458         memcpy(ie->ie_payload, data, data_len);
459
460         (*event)->event_len = htons(event_len + extra_len);
461
462         return 0;
463 }
464
465 struct ast_event *ast_event_new(enum ast_event_type type, ...)
466 {
467         va_list ap;
468         struct ast_event *event;
469         enum ast_event_type ie_type;
470         struct ast_event_ie_val *ie_val;
471         AST_LIST_HEAD_NOLOCK_STATIC(ie_vals, ast_event_ie_val);
472
473         /* Invalid type */
474         if (type >= AST_EVENT_TOTAL) {
475                 ast_log(LOG_WARNING, "Someone tried to create an event of invalid "
476                         "type '%d'!\n", type);
477                 return NULL;
478         }
479
480         va_start(ap, type);
481         for (ie_type = va_arg(ap, enum ast_event_type);
482                 ie_type != AST_EVENT_IE_END;
483                 ie_type = va_arg(ap, enum ast_event_type))
484         {
485                 struct ast_event_ie_val *ie_val = alloca(sizeof(*ie_val));
486                 memset(ie_val, 0, sizeof(*ie_val));
487                 ie_val->ie_type = ie_type;
488                 ie_val->ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
489                 if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_UINT)
490                         ie_val->payload.uint = va_arg(ap, uint32_t);
491                 else if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_STR)
492                         ie_val->payload.str = ast_strdupa(va_arg(ap, const char *));
493                 AST_LIST_INSERT_TAIL(&ie_vals, ie_val, entry);
494         }
495         va_end(ap);
496
497         if (!(event = ast_calloc(1, sizeof(*event))))
498                 return NULL;
499
500         event->type = htons(type);
501         event->event_len = htons(sizeof(*event));
502
503         AST_LIST_TRAVERSE(&ie_vals, ie_val, entry) {
504                 if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_STR)
505                         ast_event_append_ie_str(&event, ie_val->ie_type, ie_val->payload.str);
506                 else if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_UINT)
507                         ast_event_append_ie_uint(&event, ie_val->ie_type, ie_val->payload.uint);
508
509                 if (!event)
510                         break;
511         }
512
513         return event;
514 }
515
516 void ast_event_destroy(struct ast_event *event)
517 {
518         ast_free(event);
519 }
520
521 static void ast_event_ref_destroy(struct ast_event_ref *event_ref)
522 {
523         ast_event_destroy(event_ref->event);
524         ast_free(event_ref);
525 }
526
527 static struct ast_event *ast_event_dup(const struct ast_event *event)
528 {
529         struct ast_event *dup_event;
530         uint16_t event_len;
531
532         event_len = ntohs(event->event_len);
533
534         if (!(dup_event = ast_calloc(1, event_len)))
535                 return NULL;
536         
537         memcpy(dup_event, event, event_len);
538
539         return dup_event;
540 }
541
542 struct ast_event *ast_event_get_cached(enum ast_event_type type, ...)
543 {
544         va_list ap;
545         enum ast_event_ie_type ie_type;
546         struct ast_event *dup_event = NULL;
547         struct ast_event_ref *event_ref;
548         struct cache_arg {
549                 AST_LIST_ENTRY(cache_arg) entry;
550                 enum ast_event_ie_type ie_type;
551                 enum ast_event_ie_pltype ie_pltype;
552                 union {
553                         uint32_t uint;
554                         const char *str;
555                 } payload;
556         } *cache_arg;
557         AST_LIST_HEAD_NOLOCK_STATIC(cache_args, cache_arg);
558
559         if (type >= AST_EVENT_TOTAL) {
560                 ast_log(LOG_ERROR, "%u is an invalid type!\n", type);
561                 return NULL;
562         }
563
564         va_start(ap, type);
565         for (ie_type = va_arg(ap, enum ast_event_type);
566                 ie_type != AST_EVENT_IE_END;
567                 ie_type = va_arg(ap, enum ast_event_type))
568         {
569                 cache_arg = alloca(sizeof(*cache_arg));
570                 memset(cache_arg, 0, sizeof(*cache_arg));
571                 cache_arg->ie_type = ie_type;
572                 cache_arg->ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
573                 if (cache_arg->ie_pltype == AST_EVENT_IE_PLTYPE_UINT)
574                         cache_arg->payload.uint = va_arg(ap, uint32_t);
575                 else if (cache_arg->ie_pltype == AST_EVENT_IE_PLTYPE_STR)
576                         cache_arg->payload.str = ast_strdupa(va_arg(ap, const char *));
577                 AST_LIST_INSERT_TAIL(&cache_args, cache_arg, entry);
578         }
579         va_end(ap);
580
581         if (AST_LIST_EMPTY(&cache_args)) {
582                 ast_log(LOG_ERROR, "Events can not be retrieved from the cache without "
583                         "specifying at least one IE type!\n");
584                 return NULL;
585         }
586
587         AST_RWLIST_RDLOCK(&ast_event_cache[type]);
588         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&ast_event_cache[type], event_ref, entry) {
589                 AST_LIST_TRAVERSE(&cache_args, cache_arg, entry) {
590                         if ( ! ( (cache_arg->ie_pltype == AST_EVENT_IE_PLTYPE_UINT &&
591                            (cache_arg->payload.uint ==
592                             ast_event_get_ie_uint(event_ref->event, cache_arg->ie_type))) ||
593
594                            (cache_arg->ie_pltype == AST_EVENT_IE_PLTYPE_STR &&
595                            (!strcmp(cache_arg->payload.str,
596                              ast_event_get_ie_str(event_ref->event, cache_arg->ie_type)))) ||
597
598                            (cache_arg->ie_pltype == AST_EVENT_IE_PLTYPE_EXISTS &&
599                             ast_event_get_ie_raw(event_ref->event, cache_arg->ie_type)) ) ) 
600                         {
601                                 break;  
602                         }
603                 }
604                 if (!cache_arg) {
605                         /* All parameters were matched on this cache entry, so return it */
606                         dup_event = ast_event_dup(event_ref->event);
607                         break;
608                 }
609         }
610         AST_RWLIST_TRAVERSE_SAFE_END
611         AST_RWLIST_UNLOCK(&ast_event_cache[type]);
612
613         return dup_event;
614 }
615
616 /*! \brief Duplicate an event and add it to the cache
617  * \note This assumes this index in to the cache is locked */
618 static int ast_event_dup_and_cache(const struct ast_event *event)
619 {
620         struct ast_event *dup_event;
621         struct ast_event_ref *event_ref;
622
623         if (!(dup_event = ast_event_dup(event)))
624                 return -1;
625         if (!(event_ref = ast_calloc(1, sizeof(*event_ref))))
626                 return -1;
627         
628         event_ref->event = dup_event;
629
630         AST_LIST_INSERT_TAIL(&ast_event_cache[ntohs(event->type)], event_ref, entry);
631
632         return 0;
633 }
634
635 int ast_event_queue_and_cache(struct ast_event *event, ...)
636 {
637         va_list ap;
638         enum ast_event_type ie_type;
639         uint16_t host_event_type;
640         struct ast_event_ref *event_ref;
641         int res;
642         struct cache_arg {
643                 AST_LIST_ENTRY(cache_arg) entry;
644                 enum ast_event_ie_type ie_type;
645                 enum ast_event_ie_pltype ie_pltype;
646         } *cache_arg;
647         AST_LIST_HEAD_NOLOCK_STATIC(cache_args, cache_arg);
648
649         host_event_type = ntohs(event->type);
650
651         /* Invalid type */
652         if (host_event_type >= AST_EVENT_TOTAL) {
653                 ast_log(LOG_WARNING, "Someone tried to queue an event of invalid "
654                         "type '%d'!\n", host_event_type);
655                 return -1;
656         }
657
658         va_start(ap, event);
659         for (ie_type = va_arg(ap, enum ast_event_type);
660                 ie_type != AST_EVENT_IE_END;
661                 ie_type = va_arg(ap, enum ast_event_type))
662         {
663                 cache_arg = alloca(sizeof(*cache_arg));
664                 memset(cache_arg, 0, sizeof(*cache_arg));
665                 cache_arg->ie_type = ie_type;
666                 cache_arg->ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
667                 AST_LIST_INSERT_TAIL(&cache_args, cache_arg, entry);
668         }
669         va_end(ap);
670
671         if (AST_LIST_EMPTY(&cache_args)) {
672                 ast_log(LOG_ERROR, "Events can not be cached without specifying at "
673                         "least one IE type!\n");
674                 return ast_event_queue(event);
675         }
676  
677         AST_RWLIST_WRLOCK(&ast_event_cache[host_event_type]);
678         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&ast_event_cache[host_event_type], event_ref, entry) {
679                 AST_LIST_TRAVERSE(&cache_args, cache_arg, entry) {
680                         if ( ! ( (cache_arg->ie_pltype == AST_EVENT_IE_PLTYPE_UINT &&
681                            (ast_event_get_ie_uint(event, cache_arg->ie_type) ==
682                             ast_event_get_ie_uint(event_ref->event, cache_arg->ie_type))) ||
683
684                            (cache_arg->ie_pltype == AST_EVENT_IE_PLTYPE_STR &&
685                            (!strcmp(ast_event_get_ie_str(event, cache_arg->ie_type),
686                              ast_event_get_ie_str(event_ref->event, cache_arg->ie_type)))) ||
687
688                            (cache_arg->ie_pltype == AST_EVENT_IE_PLTYPE_EXISTS &&
689                             ast_event_get_ie_raw(event_ref->event, cache_arg->ie_type)) ) )
690                         {
691                                 break;  
692                         }
693                 }
694                 if (!cache_arg) {
695                         /* All parameters were matched on this cache entry, so remove it */
696                         AST_LIST_REMOVE_CURRENT(&ast_event_cache[host_event_type], entry);
697                         ast_event_ref_destroy(event_ref);
698                 }
699         }
700         AST_RWLIST_TRAVERSE_SAFE_END
701         res = ast_event_dup_and_cache(event);
702         AST_RWLIST_UNLOCK(&ast_event_cache[host_event_type]);
703
704         return (ast_event_queue(event) || res) ? -1 : 0;
705 }
706
707 int ast_event_queue(struct ast_event *event)
708 {
709         struct ast_event_ref *event_ref;
710         uint16_t host_event_type;
711
712         host_event_type = ntohs(event->type);
713
714         /* Invalid type */
715         if (host_event_type >= AST_EVENT_TOTAL) {
716                 ast_log(LOG_WARNING, "Someone tried to queue an event of invalid "
717                         "type '%d'!\n", host_event_type);
718                 return -1;
719         }
720
721         /* If nobody has subscribed to this event type, throw it away now */
722         if (ast_event_check_subscriber(host_event_type, AST_EVENT_IE_END) 
723                 == AST_EVENT_SUB_NONE) {
724                 ast_event_destroy(event);
725                 return 0;
726         }
727
728         if (!(event_ref = ast_calloc(1, sizeof(*event_ref))))
729                 return -1;
730
731         event_ref->event = event;
732
733         ast_mutex_lock(&event_thread.lock);
734         AST_LIST_INSERT_TAIL(&event_thread.event_q, event_ref, entry);
735         ast_cond_signal(&event_thread.cond);
736         ast_mutex_unlock(&event_thread.lock);
737
738         return 0;
739 }
740
741 static void *ast_event_dispatcher(void *unused)
742 {
743         for (;;) {
744                 struct ast_event_ref *event_ref;
745                 struct ast_event_sub *sub;
746                 uint16_t host_event_type;
747
748                 ast_mutex_lock(&event_thread.lock);
749                 while (!(event_ref = AST_LIST_REMOVE_HEAD(&event_thread.event_q, entry)))
750                         ast_cond_wait(&event_thread.cond, &event_thread.lock);
751                 ast_mutex_unlock(&event_thread.lock);
752
753                 host_event_type = ntohs(event_ref->event->type);
754
755                 /* Subscribers to this specific event first */
756                 AST_RWLIST_RDLOCK(&ast_event_subs[host_event_type]);
757                 AST_RWLIST_TRAVERSE(&ast_event_subs[host_event_type], sub, entry) {
758                         struct ast_event_ie_val *ie_val;
759                         AST_LIST_TRAVERSE(&sub->ie_vals, ie_val, entry) {
760                                 if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_EXISTS &&
761                                         ast_event_get_ie_raw(event_ref->event, ie_val->ie_type)) {
762                                         continue;
763                                 } else if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_UINT &&
764                                         ast_event_get_ie_uint(event_ref->event, ie_val->ie_type) 
765                                         == ie_val->payload.uint) {
766                                         continue;
767                                 } else if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_STR &&
768                                         !strcmp(ast_event_get_ie_str(event_ref->event, ie_val->ie_type),
769                                                 ie_val->payload.str)) {
770                                         continue;
771                                 }
772                                 break;
773                         }
774                         if (ie_val)
775                                 continue;
776                         sub->cb(event_ref->event, sub->userdata);
777                 }
778                 AST_RWLIST_UNLOCK(&ast_event_subs[host_event_type]);
779
780                 /* Now to subscribers to all event types */
781                 AST_RWLIST_RDLOCK(&ast_event_subs[AST_EVENT_ALL]);
782                 AST_RWLIST_TRAVERSE(&ast_event_subs[AST_EVENT_ALL], sub, entry)
783                         sub->cb(event_ref->event, sub->userdata);
784                 AST_RWLIST_UNLOCK(&ast_event_subs[AST_EVENT_ALL]);
785
786                 ast_event_ref_destroy(event_ref);
787         }
788
789         return NULL;
790 }
791
792 void ast_event_init(void)
793 {
794         int i;
795
796         for (i = 0; i < AST_EVENT_TOTAL; i++)
797                 AST_RWLIST_HEAD_INIT(&ast_event_subs[i]);
798
799         for (i = 0; i < AST_EVENT_TOTAL; i++)
800                 AST_RWLIST_HEAD_INIT(&ast_event_cache[i]);
801
802         ast_cond_init(&event_thread.cond, NULL);
803
804         for (i = 0; i < NUM_EVENT_THREADS; i++) {
805                 pthread_t dont_care;
806                 ast_pthread_create_background(&dont_care, NULL, ast_event_dispatcher, NULL);
807         }
808 }