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