Add an additional sanity check in case an event is passed between
[asterisk/asterisk.git] / main / event.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2007 - 2008, 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/dlinkedlists.h"
34 #include "asterisk/lock.h"
35 #include "asterisk/utils.h"
36 #include "asterisk/unaligned.h"
37 #include "asterisk/utils.h"
38 #include "asterisk/taskprocessor.h"
39
40 struct ast_taskprocessor *event_dispatcher;
41
42 /*!
43  * \brief An event information element
44  *
45  * \note The format of this structure is important.  Since these events may
46  *       be sent directly over a network, changing this structure will break
47  *       compatibility with older versions.  However, at this point, this code
48  *       has not made it into a release, so it is still fair game for change.
49  */
50 struct ast_event_ie {
51         enum ast_event_ie_type ie_type:16;
52         /*! Total length of the IE payload */
53         uint16_t ie_payload_len;
54         unsigned char ie_payload[0];
55 } __attribute__ ((packed));
56
57 /*!
58  * \brief An event
59  *
60  * An ast_event consists of an event header (this structure), and zero or
61  * more information elements defined by ast_event_ie.
62  *
63  * \note The format of this structure is important.  Since these events may
64  *       be sent directly over a network, changing this structure will break
65  *       compatibility with older versions.  However, at this point, this code
66  *       has not made it into a release, so it is still fair game for change.
67  */
68 struct ast_event {
69         /*! Event type */
70         enum ast_event_type type:16;
71         /*! Total length of the event */
72         uint16_t event_len:16;
73         /*! The data payload of the event, made up of information elements */
74         unsigned char payload[0];
75 } __attribute__ ((packed));
76
77 struct ast_event_ref {
78         struct ast_event *event;
79         AST_LIST_ENTRY(ast_event_ref) entry;
80 };
81
82 struct ast_event_ie_val {
83         AST_LIST_ENTRY(ast_event_ie_val) entry;
84         enum ast_event_ie_type ie_type;
85         enum ast_event_ie_pltype ie_pltype;
86         union {
87                 uint32_t uint;
88                 const char *str;
89                 void *raw;
90         } payload;
91         size_t raw_datalen;
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_RWDLLIST_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_RWDLLIST_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 /*!
117  * The index of each entry _must_ match the event type number!
118  */
119 static struct event_name {
120         enum ast_event_type type;
121         const char *name;
122 } event_names[] = {
123         { 0, "" },
124         { AST_EVENT_CUSTOM,              "Custom" },
125         { AST_EVENT_MWI,                 "MWI" },
126         { AST_EVENT_SUB,                 "Subscription" },
127         { AST_EVENT_UNSUB,               "Unsubscription" },
128         { AST_EVENT_DEVICE_STATE,        "DeviceState" },
129         { AST_EVENT_DEVICE_STATE_CHANGE, "DeviceStateChange" },
130 };
131
132 /*!
133  * The index of each entry _must_ match the event ie number!
134  */
135 static struct ie_map {
136         enum ast_event_ie_type ie_type;
137         enum ast_event_ie_pltype ie_pltype;
138         const char *name;
139 } ie_maps[] = {
140         { 0, 0, "" },
141         { AST_EVENT_IE_NEWMSGS,   AST_EVENT_IE_PLTYPE_UINT, "NewMessages" },
142         { AST_EVENT_IE_OLDMSGS,   AST_EVENT_IE_PLTYPE_UINT, "OldMessages" },
143         { AST_EVENT_IE_MAILBOX,   AST_EVENT_IE_PLTYPE_STR,  "Mailbox" },
144         { AST_EVENT_IE_UNIQUEID,  AST_EVENT_IE_PLTYPE_UINT, "UniqueID" },
145         { AST_EVENT_IE_EVENTTYPE, AST_EVENT_IE_PLTYPE_UINT, "EventType" },
146         { AST_EVENT_IE_EXISTS,    AST_EVENT_IE_PLTYPE_UINT, "Exists" },
147         { AST_EVENT_IE_DEVICE,    AST_EVENT_IE_PLTYPE_STR,  "Device" },
148         { AST_EVENT_IE_STATE,     AST_EVENT_IE_PLTYPE_UINT, "State" },
149         { AST_EVENT_IE_CONTEXT,   AST_EVENT_IE_PLTYPE_STR,  "Context" },
150         { AST_EVENT_IE_EID,       AST_EVENT_IE_PLTYPE_RAW,  "EntityID" },
151 };
152
153 const char *ast_event_get_type_name(const struct ast_event *event)
154 {
155         enum ast_event_type type;
156
157         type = ast_event_get_type(event);
158
159         if (type >= AST_EVENT_TOTAL || type < 0) {
160                 ast_log(LOG_ERROR, "Invalid event type - '%d'\n", type);
161                 return "";
162         }
163
164         return event_names[type].name;
165 }
166
167 int ast_event_str_to_event_type(const char *str, enum ast_event_type *event_type)
168 {
169         int i;
170
171         for (i = 0; i < ARRAY_LEN(event_names); i++) {
172                 if (strcasecmp(event_names[i].name, str))
173                         continue;
174
175                 *event_type = event_names[i].type;
176                 return 0;
177         }
178
179         return -1;
180 }
181
182 const char *ast_event_get_ie_type_name(enum ast_event_ie_type ie_type)
183 {
184         if (ie_type <= 0 || ie_type > AST_EVENT_IE_MAX) {
185                 ast_log(LOG_ERROR, "Invalid IE type - '%d'\n", ie_type);
186                 return "";
187         }
188
189         if (ie_maps[ie_type].ie_type != ie_type) {
190                 ast_log(LOG_ERROR, "The ie type passed in does not match the ie type defined in the ie table.\n");
191                 return "";
192         }
193
194         return ie_maps[ie_type].name;
195 }
196
197 enum ast_event_ie_pltype ast_event_get_ie_pltype(enum ast_event_ie_type ie_type)
198 {
199         if (ie_type <= 0 || ie_type > AST_EVENT_IE_MAX) {
200                 ast_log(LOG_ERROR, "Invalid IE type - '%d'\n", ie_type);
201                 return AST_EVENT_IE_PLTYPE_UNKNOWN;
202         }
203
204         if (ie_maps[ie_type].ie_type != ie_type) {
205                 ast_log(LOG_ERROR, "The ie type passed in does not match the ie type defined in the ie table.\n");
206                 return AST_EVENT_IE_PLTYPE_UNKNOWN;
207         }
208
209         return ie_maps[ie_type].ie_pltype;
210 }
211
212 int ast_event_str_to_ie_type(const char *str, enum ast_event_ie_type *ie_type)
213 {
214         int i;
215
216         for (i = 0; i < ARRAY_LEN(ie_maps); i++) {
217                 if (strcasecmp(ie_maps[i].name, str))
218                         continue;
219
220                 *ie_type = ie_maps[i].ie_type;
221                 return 0;
222         }
223
224         return -1;
225 }
226
227 size_t ast_event_get_size(const struct ast_event *event)
228 {
229         size_t res;
230
231         res = ntohs(event->event_len);
232
233         return res;
234 }
235
236 static void ast_event_ie_val_destroy(struct ast_event_ie_val *ie_val)
237 {
238         switch (ie_val->ie_pltype) {
239         case AST_EVENT_IE_PLTYPE_STR:
240         case AST_EVENT_IE_PLTYPE_RAW:
241                 ast_free(ie_val->payload.raw);
242                 break;
243         case AST_EVENT_IE_PLTYPE_UINT:
244         case AST_EVENT_IE_PLTYPE_EXISTS:
245         case AST_EVENT_IE_PLTYPE_UNKNOWN:
246                 break;
247         }
248
249         ast_free(ie_val);
250 }
251
252 enum ast_event_subscriber_res ast_event_check_subscriber(enum ast_event_type type, ...)
253 {
254         va_list ap;
255         enum ast_event_ie_type ie_type;
256         enum ast_event_subscriber_res res = AST_EVENT_SUB_NONE;
257         struct ast_event_ie_val *ie_val, *sub_ie_val;
258         struct ast_event_sub *sub;
259         AST_LIST_HEAD_NOLOCK_STATIC(ie_vals, ast_event_ie_val);
260
261         if (type >= AST_EVENT_TOTAL) {
262                 ast_log(LOG_ERROR, "%u is an invalid type!\n", type);
263                 return res;
264         }
265
266         va_start(ap, type);
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 = alloca(sizeof(*ie_val));
272                 memset(ie_val, 0, sizeof(*ie_val));
273                 ie_val->ie_type = ie_type;
274                 ie_val->ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
275                 if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_UINT)
276                         ie_val->payload.uint = va_arg(ap, uint32_t);
277                 else if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_STR)
278                         ie_val->payload.str = ast_strdupa(va_arg(ap, const char *));
279                 else if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_RAW) {
280                         void *data = va_arg(ap, void *);
281                         size_t datalen = va_arg(ap, size_t);
282                         ie_val->payload.raw = alloca(datalen);
283                         memcpy(ie_val->payload.raw, data, datalen);
284                         ie_val->raw_datalen = datalen;
285                 }
286                 AST_LIST_INSERT_TAIL(&ie_vals, ie_val, entry);
287         }
288         va_end(ap);
289
290         AST_RWDLLIST_RDLOCK(&ast_event_subs[type]);
291         AST_RWDLLIST_TRAVERSE(&ast_event_subs[type], sub, entry) {
292                 AST_LIST_TRAVERSE(&ie_vals, ie_val, entry) {
293                         AST_LIST_TRAVERSE(&sub->ie_vals, sub_ie_val, entry) {
294                                 if (sub_ie_val->ie_type == ie_val->ie_type)
295                                         break;
296                         }
297                         if (!sub_ie_val) {
298                                 if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_EXISTS)
299                                         break;
300                                 continue;
301                         }
302                         /* The subscriber doesn't actually care what the value is */
303                         if (sub_ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_EXISTS)
304                                 continue;
305                         if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_UINT &&
306                                 ie_val->payload.uint != sub_ie_val->payload.uint)
307                                 break;
308                         if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_STR &&
309                                 strcmp(ie_val->payload.str, sub_ie_val->payload.str))
310                                 break;
311                         if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_RAW &&
312                                 memcmp(ie_val->payload.raw, sub_ie_val->payload.raw, ie_val->raw_datalen))
313                                 break;
314                 }
315                 if (!ie_val)
316                         break;
317         }
318         AST_RWDLLIST_UNLOCK(&ast_event_subs[type]);
319
320         if (sub) /* All parameters were matched */
321                 return AST_EVENT_SUB_EXISTS;
322
323         AST_RWDLLIST_RDLOCK(&ast_event_subs[AST_EVENT_ALL]);
324         if (!AST_DLLIST_EMPTY(&ast_event_subs[AST_EVENT_ALL]))
325                 res = AST_EVENT_SUB_EXISTS;
326         AST_RWDLLIST_UNLOCK(&ast_event_subs[AST_EVENT_ALL]);
327
328         return res;
329 }
330
331 static int match_ie_val(struct ast_event *event, struct ast_event_ie_val *ie_val, struct ast_event *event2)
332 {
333         if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_UINT) {
334                 uint32_t val = event2 ? ast_event_get_ie_uint(event2, ie_val->ie_type) : ie_val->payload.uint;
335                 if (val == ast_event_get_ie_uint(event, ie_val->ie_type))
336                         return 1;
337                 return 0;
338         }
339
340         if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_STR) {
341                 const char *str = event2 ? ast_event_get_ie_str(event2, ie_val->ie_type) : ie_val->payload.str;
342                 if (str && !strcmp(str, ast_event_get_ie_str(event, ie_val->ie_type)))
343                         return 1;
344                 return 0;
345         }
346
347         if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_RAW) {
348                 const void *buf = event2 ? ast_event_get_ie_raw(event2, ie_val->ie_type) : ie_val->payload.raw;
349                 if (buf && !memcmp(buf, ast_event_get_ie_raw(event, ie_val->ie_type), ie_val->raw_datalen))
350                         return 1;
351                 return 0;
352         }
353
354         if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_EXISTS) {
355                 if (ast_event_get_ie_raw(event, ie_val->ie_type))
356                         return 1;
357                 return 0;
358         }
359
360         return 0;
361 }
362
363 /*! \brief Dump the event cache for the subscribed event type */
364 void ast_event_dump_cache(const struct ast_event_sub *event_sub)
365 {
366         struct ast_event_ref *event_ref;
367         enum ast_event_type type = event_sub->type;
368
369         AST_RWLIST_RDLOCK(&ast_event_cache[type]);
370         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&ast_event_cache[type], event_ref, entry) {
371                 struct ast_event_ie_val *ie_val;
372                 AST_LIST_TRAVERSE(&event_sub->ie_vals, ie_val, entry) {
373                         if (!match_ie_val(event_ref->event, ie_val, NULL))
374                                 break;
375                 }
376                 if (!ie_val) {
377                         /* All parameters were matched on this cache entry, so dump it */
378                         event_sub->cb(event_ref->event, event_sub->userdata);
379                 }
380         }
381         AST_RWLIST_TRAVERSE_SAFE_END
382         AST_RWLIST_UNLOCK(&ast_event_cache[type]);
383 }
384
385 static struct ast_event *gen_sub_event(struct ast_event_sub *sub)
386 {
387         struct ast_event_ie_val *ie_val;
388         struct ast_event *event;
389
390         event = ast_event_new(AST_EVENT_SUB,
391                 AST_EVENT_IE_UNIQUEID,  AST_EVENT_IE_PLTYPE_UINT, sub->uniqueid,
392                 AST_EVENT_IE_EVENTTYPE, AST_EVENT_IE_PLTYPE_UINT, sub->type,
393                 AST_EVENT_IE_END);
394
395         if (!event)
396                 return NULL;
397
398         AST_LIST_TRAVERSE(&sub->ie_vals, ie_val, entry) {
399                 switch (ie_val->ie_pltype) {
400                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
401                         break;
402                 case AST_EVENT_IE_PLTYPE_EXISTS:
403                         ast_event_append_ie_uint(&event, AST_EVENT_IE_EXISTS, ie_val->ie_type);
404                         break;
405                 case AST_EVENT_IE_PLTYPE_UINT:
406                         ast_event_append_ie_uint(&event, ie_val->ie_type, ie_val->payload.uint);
407                         break;
408                 case AST_EVENT_IE_PLTYPE_STR:
409                         ast_event_append_ie_str(&event, ie_val->ie_type, ie_val->payload.str);
410                         break;
411                 case AST_EVENT_IE_PLTYPE_RAW:
412                         ast_event_append_ie_raw(&event, ie_val->ie_type, ie_val->payload.raw, ie_val->raw_datalen);
413                         break;
414                 }
415                 if (!event)
416                         break;
417         }
418
419         return event;
420 }
421
422 /*! \brief Send AST_EVENT_SUB events to this subscriber of ... subscriber events */
423 void ast_event_report_subs(const struct ast_event_sub *event_sub)
424 {
425         struct ast_event *event;
426         struct ast_event_sub *sub;
427         enum ast_event_type event_type = -1;
428         struct ast_event_ie_val *ie_val;
429
430         if (event_sub->type != AST_EVENT_SUB)
431                 return;
432
433         AST_LIST_TRAVERSE(&event_sub->ie_vals, ie_val, entry) {
434                 if (ie_val->ie_type == AST_EVENT_IE_EVENTTYPE) {
435                         event_type = ie_val->payload.uint;
436                         break;
437                 }
438         }
439
440         if (event_type == -1)
441                 return;
442
443         AST_RWDLLIST_RDLOCK(&ast_event_subs[event_type]);
444         AST_RWDLLIST_TRAVERSE(&ast_event_subs[event_type], sub, entry) {
445                 if (event_sub == sub)
446                         continue;
447
448                 event = gen_sub_event(sub);
449
450                 if (!event)
451                         continue;
452
453                 event_sub->cb(event, event_sub->userdata);
454
455                 ast_event_destroy(event);
456         }
457         AST_RWDLLIST_UNLOCK(&ast_event_subs[event_type]);
458 }
459
460 struct ast_event_sub *ast_event_subscribe_new(enum ast_event_type type, 
461         ast_event_cb_t cb, void *userdata)
462 {
463         struct ast_event_sub *sub;
464
465         if (type < 0 || type >= AST_EVENT_TOTAL) {
466                 ast_log(LOG_ERROR, "%u is an invalid type!\n", type);
467                 return NULL;
468         }
469
470         if (!(sub = ast_calloc(1, sizeof(*sub))))
471                 return NULL;
472
473         sub->type = type;
474         sub->cb = cb;
475         sub->userdata = userdata;
476         sub->uniqueid = ast_atomic_fetchadd_int((int *) &sub_uniqueid, 1);
477
478         return sub;
479 }
480
481 int ast_event_sub_append_ie_uint(struct ast_event_sub *sub,
482         enum ast_event_ie_type ie_type, uint32_t uint)
483 {
484         struct ast_event_ie_val *ie_val;
485
486         if (ie_type < 0 || ie_type > AST_EVENT_IE_MAX)
487                 return -1;
488
489         if (!(ie_val = ast_calloc(1, sizeof(*ie_val))))
490                 return -1;
491
492         ie_val->ie_type = ie_type;
493         ie_val->payload.uint = uint;
494         ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_UINT;
495
496         AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
497
498         return 0;
499 }
500
501 int ast_event_sub_append_ie_exists(struct ast_event_sub *sub,
502         enum ast_event_ie_type ie_type)
503 {
504         struct ast_event_ie_val *ie_val;
505
506         if (ie_type < 0 || ie_type > AST_EVENT_IE_MAX)
507                 return -1;
508
509         if (!(ie_val = ast_calloc(1, sizeof(*ie_val))))
510                 return -1;
511
512         ie_val->ie_type = ie_type;
513         ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_EXISTS;
514
515         AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
516
517         return 0;
518 }
519
520 int ast_event_sub_append_ie_str(struct ast_event_sub *sub,      
521         enum ast_event_ie_type ie_type, const char *str)
522 {
523         struct ast_event_ie_val *ie_val;
524
525         if (ie_type < 0 || ie_type > AST_EVENT_IE_MAX)
526                 return -1;
527
528         if (!(ie_val = ast_calloc(1, sizeof(*ie_val))))
529                 return -1;
530
531         ie_val->ie_type = ie_type;
532         ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_STR;
533
534         if (!(ie_val->payload.str = ast_strdup(str))) {
535                 ast_free(ie_val);
536                 return -1;
537         }
538
539         AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
540
541         return 0;
542 }
543
544 int ast_event_sub_append_ie_raw(struct ast_event_sub *sub,      
545         enum ast_event_ie_type ie_type, void *data, size_t raw_datalen)
546 {
547         struct ast_event_ie_val *ie_val;
548
549         if (ie_type < 0 || ie_type > AST_EVENT_IE_MAX)
550                 return -1;
551
552         if (!(ie_val = ast_calloc(1, sizeof(*ie_val))))
553                 return -1;
554
555         ie_val->ie_type = ie_type;
556         ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_RAW;
557         ie_val->raw_datalen = raw_datalen;
558
559         if (!(ie_val->payload.raw = ast_malloc(raw_datalen))) {
560                 ast_free(ie_val);
561                 return -1;
562         }
563
564         memcpy(ie_val->payload.raw, data, raw_datalen);
565
566         AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
567
568         return 0;
569 }
570
571 int ast_event_sub_activate(struct ast_event_sub *sub)
572 {
573         if (ast_event_check_subscriber(AST_EVENT_SUB,
574                 AST_EVENT_IE_EVENTTYPE, AST_EVENT_IE_PLTYPE_UINT, sub->type,
575                 AST_EVENT_IE_END) != AST_EVENT_SUB_NONE) {
576                 struct ast_event *event;
577
578                 event = gen_sub_event(sub);
579
580                 if (event)
581                         ast_event_queue(event);
582         }
583
584         AST_RWDLLIST_WRLOCK(&ast_event_subs[sub->type]);
585         AST_RWDLLIST_INSERT_TAIL(&ast_event_subs[sub->type], sub, entry);
586         AST_RWDLLIST_UNLOCK(&ast_event_subs[sub->type]);
587
588         return 0;
589 }
590
591 struct ast_event_sub *ast_event_subscribe(enum ast_event_type type, ast_event_cb_t cb, 
592         void *userdata, ...)
593 {
594         va_list ap;
595         enum ast_event_ie_type ie_type;
596         struct ast_event_sub *sub;
597
598         if (!(sub = ast_event_subscribe_new(type, cb, userdata)))
599                 return NULL;
600
601         va_start(ap, userdata);
602         for (ie_type = va_arg(ap, enum ast_event_type);
603                 ie_type != AST_EVENT_IE_END;
604                 ie_type = va_arg(ap, enum ast_event_type))
605         {
606                 enum ast_event_ie_pltype ie_pltype;
607
608                 ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
609
610                 switch (ie_pltype) {
611                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
612                         break;
613                 case AST_EVENT_IE_PLTYPE_UINT:
614                 {
615                         uint32_t uint = va_arg(ap, uint32_t);
616                         ast_event_sub_append_ie_uint(sub, ie_type, uint);
617                         break;
618                 }
619                 case AST_EVENT_IE_PLTYPE_STR:
620                 {
621                         const char *str = va_arg(ap, const char *);
622                         ast_event_sub_append_ie_str(sub, ie_type, str);
623                         break;
624                 }
625                 case AST_EVENT_IE_PLTYPE_RAW:
626                 {
627                         void *data = va_arg(ap, void *);
628                         size_t data_len = va_arg(ap, size_t);
629                         ast_event_sub_append_ie_raw(sub, ie_type, data, data_len);
630                         break;
631                 }
632                 case AST_EVENT_IE_PLTYPE_EXISTS:
633                         ast_event_sub_append_ie_exists(sub, ie_type);
634                         break;
635                 }
636         }
637         va_end(ap);
638
639         ast_event_sub_activate(sub);
640
641         return sub;
642 }
643
644 void ast_event_sub_destroy(struct ast_event_sub *sub)
645 {
646         struct ast_event_ie_val *ie_val;
647
648         while ((ie_val = AST_LIST_REMOVE_HEAD(&sub->ie_vals, entry)))
649                 ast_event_ie_val_destroy(ie_val);
650
651         ast_free(sub);
652 }
653
654 struct ast_event_sub *ast_event_unsubscribe(struct ast_event_sub *sub)
655 {
656         struct ast_event *event;
657
658         AST_RWDLLIST_WRLOCK(&ast_event_subs[sub->type]);
659         AST_DLLIST_REMOVE(&ast_event_subs[sub->type], sub, entry);
660         AST_RWDLLIST_UNLOCK(&ast_event_subs[sub->type]);
661
662         if (ast_event_check_subscriber(AST_EVENT_UNSUB,
663                 AST_EVENT_IE_EVENTTYPE, AST_EVENT_IE_PLTYPE_UINT, sub->type,
664                 AST_EVENT_IE_END) != AST_EVENT_SUB_NONE) {
665                 
666                 event = ast_event_new(AST_EVENT_UNSUB,
667                         AST_EVENT_IE_UNIQUEID,  AST_EVENT_IE_PLTYPE_UINT, sub->uniqueid,
668                         AST_EVENT_IE_EVENTTYPE, AST_EVENT_IE_PLTYPE_UINT, sub->type,
669                         AST_EVENT_IE_END);
670
671                 if (event)
672                         ast_event_queue(event);
673         }
674
675         ast_event_sub_destroy(sub);
676
677         return NULL;
678 }
679
680 void ast_event_iterator_init(struct ast_event_iterator *iterator, const struct ast_event *event)
681 {
682         iterator->event_len = ntohs(event->event_len);
683         iterator->event = event;
684         iterator->ie = (struct ast_event_ie *) ( ((char *) event) + sizeof(*event) );
685         return;
686 }
687
688 int ast_event_iterator_next(struct ast_event_iterator *iterator)
689 {
690         iterator->ie = (struct ast_event_ie *) ( ((char *) iterator->ie) + sizeof(*iterator->ie) + ntohs(iterator->ie->ie_payload_len));
691         return ((iterator->event_len <= (((char *) iterator->ie) - ((char *) iterator->event))) ? -1 : 0);
692 }
693
694 enum ast_event_ie_type ast_event_iterator_get_ie_type(struct ast_event_iterator *iterator)
695 {
696         return ntohs(iterator->ie->ie_type);
697 }
698
699 uint32_t ast_event_iterator_get_ie_uint(struct ast_event_iterator *iterator)
700 {
701         return ntohl(get_unaligned_uint32(iterator->ie->ie_payload));
702 }
703
704 const char *ast_event_iterator_get_ie_str(struct ast_event_iterator *iterator)
705 {
706         return (const char*)iterator->ie->ie_payload;
707 }
708
709 void *ast_event_iterator_get_ie_raw(struct ast_event_iterator *iterator)
710 {
711         return iterator->ie->ie_payload;
712 }
713
714 enum ast_event_type ast_event_get_type(const struct ast_event *event)
715 {
716         return ntohs(event->type);
717 }
718
719 uint32_t ast_event_get_ie_uint(const struct ast_event *event, enum ast_event_ie_type ie_type)
720 {
721         const uint32_t *ie_val;
722
723         ie_val = ast_event_get_ie_raw(event, ie_type);
724
725         return ie_val ? ntohl(get_unaligned_uint32(ie_val)) : 0;
726 }
727
728 const char *ast_event_get_ie_str(const struct ast_event *event, enum ast_event_ie_type ie_type)
729 {
730         return ast_event_get_ie_raw(event, ie_type);
731 }
732
733 const void *ast_event_get_ie_raw(const struct ast_event *event, enum ast_event_ie_type ie_type)
734 {
735         struct ast_event_iterator iterator;
736         int res = 0;
737
738         for (ast_event_iterator_init(&iterator, event); !res; res = ast_event_iterator_next(&iterator)) {
739                 if (ast_event_iterator_get_ie_type(&iterator) == ie_type)
740                         return ast_event_iterator_get_ie_raw(&iterator);
741         }
742
743         return NULL;
744 }
745
746 int ast_event_append_ie_str(struct ast_event **event, enum ast_event_ie_type ie_type,
747         const char *str)
748 {
749         return ast_event_append_ie_raw(event, ie_type, str, strlen(str) + 1);
750 }
751
752 int ast_event_append_ie_uint(struct ast_event **event, enum ast_event_ie_type ie_type,
753         uint32_t data)
754 {
755         data = htonl(data);
756         return ast_event_append_ie_raw(event, ie_type, &data, sizeof(data));
757 }
758
759 int ast_event_append_ie_raw(struct ast_event **event, enum ast_event_ie_type ie_type,
760         const void *data, size_t data_len)
761 {
762         struct ast_event_ie *ie;
763         unsigned int extra_len;
764         uint16_t event_len;
765
766         event_len = ntohs((*event)->event_len);
767         extra_len = sizeof(*ie) + data_len;
768
769         if (!(*event = ast_realloc(*event, event_len + extra_len)))
770                 return -1;
771
772         ie = (struct ast_event_ie *) ( ((char *) *event) + event_len );
773         ie->ie_type = htons(ie_type);
774         ie->ie_payload_len = htons(data_len);
775         memcpy(ie->ie_payload, data, data_len);
776
777         (*event)->event_len = htons(event_len + extra_len);
778
779         return 0;
780 }
781
782 struct ast_event *ast_event_new(enum ast_event_type type, ...)
783 {
784         va_list ap;
785         struct ast_event *event;
786         enum ast_event_type ie_type;
787         struct ast_event_ie_val *ie_val;
788         AST_LIST_HEAD_NOLOCK_STATIC(ie_vals, ast_event_ie_val);
789
790         /* Invalid type */
791         if (type >= AST_EVENT_TOTAL) {
792                 ast_log(LOG_WARNING, "Someone tried to create an event of invalid "
793                         "type '%d'!\n", type);
794                 return NULL;
795         }
796
797         va_start(ap, type);
798         for (ie_type = va_arg(ap, enum ast_event_type);
799                 ie_type != AST_EVENT_IE_END;
800                 ie_type = va_arg(ap, enum ast_event_type))
801         {
802                 struct ast_event_ie_val *ie_val = alloca(sizeof(*ie_val));
803                 memset(ie_val, 0, sizeof(*ie_val));
804                 ie_val->ie_type = ie_type;
805                 ie_val->ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
806                 if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_UINT)
807                         ie_val->payload.uint = va_arg(ap, uint32_t);
808                 else if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_STR)
809                         ie_val->payload.str = ast_strdupa(va_arg(ap, const char *));
810                 else if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_RAW) {
811                         void *data = va_arg(ap, void *);
812                         size_t datalen = va_arg(ap, size_t);
813                         ie_val->payload.raw = alloca(datalen);
814                         memcpy(ie_val->payload.raw, data, datalen);
815                         ie_val->raw_datalen = datalen;
816                 }
817                 AST_LIST_INSERT_TAIL(&ie_vals, ie_val, entry);
818         }
819         va_end(ap);
820
821         if (!(event = ast_calloc(1, sizeof(*event))))
822                 return NULL;
823
824         event->type = htons(type);
825         event->event_len = htons(sizeof(*event));
826
827         AST_LIST_TRAVERSE(&ie_vals, ie_val, entry) {
828                 if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_STR)
829                         ast_event_append_ie_str(&event, ie_val->ie_type, ie_val->payload.str);
830                 else if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_UINT)
831                         ast_event_append_ie_uint(&event, ie_val->ie_type, ie_val->payload.uint);
832                 else if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_RAW)
833                         ast_event_append_ie_raw(&event, ie_val->ie_type, ie_val->payload.raw, ie_val->raw_datalen);
834
835                 if (!event)
836                         break;
837         }
838
839         if (!ast_event_get_ie_raw(event, AST_EVENT_IE_EID)) {
840                 /* If the event is originating on this server, add the server's
841                  * entity ID to the event. */
842                 ast_event_append_ie_raw(&event, AST_EVENT_IE_EID, &g_eid, sizeof(g_eid));
843         }
844
845         return event;
846 }
847
848 void ast_event_destroy(struct ast_event *event)
849 {
850         ast_free(event);
851 }
852
853 static void ast_event_ref_destroy(struct ast_event_ref *event_ref)
854 {
855         ast_event_destroy(event_ref->event);
856         ast_free(event_ref);
857 }
858
859 static struct ast_event *ast_event_dup(const struct ast_event *event)
860 {
861         struct ast_event *dup_event;
862         uint16_t event_len;
863
864         event_len = ast_event_get_size(event);
865
866         if (!(dup_event = ast_calloc(1, event_len)))
867                 return NULL;
868         
869         memcpy(dup_event, event, event_len);
870
871         return dup_event;
872 }
873
874 struct ast_event *ast_event_get_cached(enum ast_event_type type, ...)
875 {
876         va_list ap;
877         enum ast_event_ie_type ie_type;
878         struct ast_event *dup_event = NULL;
879         struct ast_event_ref *event_ref;
880         struct ast_event_ie_val *cache_arg;
881         AST_LIST_HEAD_NOLOCK_STATIC(cache_args, ast_event_ie_val);
882
883         if (type >= AST_EVENT_TOTAL) {
884                 ast_log(LOG_ERROR, "%u is an invalid type!\n", type);
885                 return NULL;
886         }
887
888         va_start(ap, type);
889         for (ie_type = va_arg(ap, enum ast_event_type);
890                 ie_type != AST_EVENT_IE_END;
891                 ie_type = va_arg(ap, enum ast_event_type))
892         {
893                 cache_arg = alloca(sizeof(*cache_arg));
894                 memset(cache_arg, 0, sizeof(*cache_arg));
895                 cache_arg->ie_type = ie_type;
896                 cache_arg->ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
897                 if (cache_arg->ie_pltype == AST_EVENT_IE_PLTYPE_UINT)
898                         cache_arg->payload.uint = va_arg(ap, uint32_t);
899                 else if (cache_arg->ie_pltype == AST_EVENT_IE_PLTYPE_STR)
900                         cache_arg->payload.str = ast_strdupa(va_arg(ap, const char *));
901                 else if (cache_arg->ie_pltype == AST_EVENT_IE_PLTYPE_RAW) {
902                         void *data = va_arg(ap, void *);
903                         size_t datalen = va_arg(ap, size_t);
904                         cache_arg->payload.raw = alloca(datalen);
905                         memcpy(cache_arg->payload.raw, data, datalen);
906                         cache_arg->raw_datalen = datalen;
907                 }
908                 AST_LIST_INSERT_TAIL(&cache_args, cache_arg, entry);
909         }
910         va_end(ap);
911
912         if (AST_LIST_EMPTY(&cache_args)) {
913                 ast_log(LOG_ERROR, "Events can not be retrieved from the cache without "
914                         "specifying at least one IE type!\n");
915                 return NULL;
916         }
917
918         AST_RWLIST_RDLOCK(&ast_event_cache[type]);
919         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&ast_event_cache[type], event_ref, entry) {
920                 AST_LIST_TRAVERSE(&cache_args, cache_arg, entry) {
921                         if (!match_ie_val(event_ref->event, cache_arg, NULL))
922                                 break;  
923                 }
924                 if (!cache_arg) {
925                         /* All parameters were matched on this cache entry, so return it */
926                         dup_event = ast_event_dup(event_ref->event);
927                         break;
928                 }
929         }
930         AST_RWLIST_TRAVERSE_SAFE_END
931         AST_RWLIST_UNLOCK(&ast_event_cache[type]);
932
933         return dup_event;
934 }
935
936 /*! \brief Duplicate an event and add it to the cache
937  * \note This assumes this index in to the cache is locked */
938 static int ast_event_dup_and_cache(const struct ast_event *event)
939 {
940         struct ast_event *dup_event;
941         struct ast_event_ref *event_ref;
942
943         if (!(dup_event = ast_event_dup(event)))
944                 return -1;
945         if (!(event_ref = ast_calloc(1, sizeof(*event_ref))))
946                 return -1;
947         
948         event_ref->event = dup_event;
949
950         AST_LIST_INSERT_TAIL(&ast_event_cache[ntohs(event->type)], event_ref, entry);
951
952         return 0;
953 }
954
955 int ast_event_queue_and_cache(struct ast_event *event, ...)
956 {
957         va_list ap;
958         enum ast_event_type ie_type;
959         uint16_t host_event_type;
960         struct ast_event_ref *event_ref;
961         int res;
962         struct ast_event_ie_val *cache_arg;
963         AST_LIST_HEAD_NOLOCK_STATIC(cache_args, ast_event_ie_val);
964
965         host_event_type = ntohs(event->type);
966
967         /* Invalid type */
968         if (host_event_type >= AST_EVENT_TOTAL) {
969                 ast_log(LOG_WARNING, "Someone tried to queue an event of invalid "
970                         "type '%d'!\n", host_event_type);
971                 return -1;
972         }
973
974         va_start(ap, event);
975         for (ie_type = va_arg(ap, enum ast_event_type);
976                 ie_type != AST_EVENT_IE_END;
977                 ie_type = va_arg(ap, enum ast_event_type))
978         {
979                 cache_arg = alloca(sizeof(*cache_arg));
980                 memset(cache_arg, 0, sizeof(*cache_arg));
981                 cache_arg->ie_type = ie_type;
982                 cache_arg->ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
983                 if (cache_arg->ie_pltype == AST_EVENT_IE_PLTYPE_RAW)
984                         cache_arg->raw_datalen = va_arg(ap, size_t);
985                 AST_LIST_INSERT_TAIL(&cache_args, cache_arg, entry);
986         }
987         va_end(ap);
988
989         if (AST_LIST_EMPTY(&cache_args)) {
990                 ast_log(LOG_ERROR, "Events can not be cached without specifying at "
991                         "least one IE type!\n");
992                 return ast_event_queue(event);
993         }
994  
995         AST_RWLIST_WRLOCK(&ast_event_cache[host_event_type]);
996         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&ast_event_cache[host_event_type], event_ref, entry) {
997                 AST_LIST_TRAVERSE(&cache_args, cache_arg, entry) {
998                         if (!match_ie_val(event_ref->event, cache_arg, event))
999                                 break;  
1000                 }
1001                 if (!cache_arg) {
1002                         /* All parameters were matched on this cache entry, so remove it */
1003                         AST_LIST_REMOVE_CURRENT(entry);
1004                         ast_event_ref_destroy(event_ref);
1005                 }
1006         }
1007         AST_RWLIST_TRAVERSE_SAFE_END;
1008         res = ast_event_dup_and_cache(event);
1009         AST_RWLIST_UNLOCK(&ast_event_cache[host_event_type]);
1010
1011         return (ast_event_queue(event) || res) ? -1 : 0;
1012 }
1013
1014 static int handle_event(void *data)
1015 {
1016         struct ast_event_ref *event_ref = data;
1017         struct ast_event_sub *sub;
1018         uint16_t host_event_type;
1019
1020         host_event_type = ntohs(event_ref->event->type);
1021
1022         /* Subscribers to this specific event first */
1023         AST_RWDLLIST_RDLOCK(&ast_event_subs[host_event_type]);
1024         AST_RWDLLIST_TRAVERSE(&ast_event_subs[host_event_type], sub, entry) {
1025                 struct ast_event_ie_val *ie_val;
1026                 AST_LIST_TRAVERSE(&sub->ie_vals, ie_val, entry) {
1027                         if (!match_ie_val(event_ref->event, ie_val, NULL))
1028                                 break;
1029                 }
1030                 if (ie_val)
1031                         continue;
1032                 sub->cb(event_ref->event, sub->userdata);
1033         }
1034         AST_RWDLLIST_UNLOCK(&ast_event_subs[host_event_type]);
1035
1036         /* Now to subscribers to all event types */
1037         AST_RWDLLIST_RDLOCK(&ast_event_subs[AST_EVENT_ALL]);
1038         AST_RWDLLIST_TRAVERSE(&ast_event_subs[AST_EVENT_ALL], sub, entry)
1039                 sub->cb(event_ref->event, sub->userdata);
1040         AST_RWDLLIST_UNLOCK(&ast_event_subs[AST_EVENT_ALL]);
1041
1042         ast_event_ref_destroy(event_ref);
1043
1044         return 0;
1045 }
1046
1047 int ast_event_queue(struct ast_event *event)
1048 {
1049         struct ast_event_ref *event_ref;
1050         uint16_t host_event_type;
1051
1052         host_event_type = ntohs(event->type);
1053
1054         /* Invalid type */
1055         if (host_event_type >= AST_EVENT_TOTAL) {
1056                 ast_log(LOG_WARNING, "Someone tried to queue an event of invalid "
1057                         "type '%d'!\n", host_event_type);
1058                 return -1;
1059         }
1060
1061         /* If nobody has subscribed to this event type, throw it away now */
1062         if (ast_event_check_subscriber(host_event_type, AST_EVENT_IE_END) 
1063                 == AST_EVENT_SUB_NONE) {
1064                 ast_event_destroy(event);
1065                 return 0;
1066         }
1067
1068         if (!(event_ref = ast_calloc(1, sizeof(*event_ref))))
1069                 return -1;
1070
1071         event_ref->event = event;
1072
1073         return ast_taskprocessor_push(event_dispatcher, handle_event, event_ref);
1074 }
1075
1076 void ast_event_init(void)
1077 {
1078         int i;
1079
1080         for (i = 0; i < AST_EVENT_TOTAL; i++)
1081                 AST_RWDLLIST_HEAD_INIT(&ast_event_subs[i]);
1082
1083         for (i = 0; i < AST_EVENT_TOTAL; i++)
1084                 AST_RWLIST_HEAD_INIT(&ast_event_cache[i]);
1085
1086         event_dispatcher = ast_taskprocessor_get("core_event_dispatcher", 0);
1087 }