Merge the new Channel Event Logging (CEL) subsystem.
[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
32 #include "asterisk/event.h"
33 #include "asterisk/linkedlists.h"
34 #include "asterisk/dlinkedlists.h"
35 #include "asterisk/lock.h"
36 #include "asterisk/utils.h"
37 #include "asterisk/unaligned.h"
38 #include "asterisk/utils.h"
39 #include "asterisk/taskprocessor.h"
40 #include "asterisk/astobj2.h"
41
42 static struct ast_taskprocessor *event_dispatcher;
43
44 /*!
45  * \brief An event information element
46  *
47  * \note The format of this structure is important.  Since these events may
48  *       be sent directly over a network, changing this structure will break
49  *       compatibility with older versions.  However, at this point, this code
50  *       has not made it into a release, so it is still fair game for change.
51  */
52 struct ast_event_ie {
53         enum ast_event_ie_type ie_type:16;
54         /*! Total length of the IE payload */
55         uint16_t ie_payload_len;
56         unsigned char ie_payload[0];
57 } __attribute__((packed));
58
59 /*!
60  * \brief The payload for a string information element
61  */
62 struct ast_event_ie_str_payload {
63         /*! \brief A hash calculated with ast_str_hash(), to speed up comparisons */
64         uint32_t hash;
65         /*! \brief The actual string, null terminated */
66         char str[1];
67 } __attribute__((packed));
68
69 /*!
70  * \brief An event
71  *
72  * An ast_event consists of an event header (this structure), and zero or
73  * more information elements defined by ast_event_ie.
74  *
75  * \note The format of this structure is important.  Since these events may
76  *       be sent directly over a network, changing this structure will break
77  *       compatibility with older versions.  However, at this point, this code
78  *       has not made it into a release, so it is still fair game for change.
79  */
80 struct ast_event {
81         /*! Event type */
82         enum ast_event_type type:16;
83         /*! Total length of the event */
84         uint16_t event_len:16;
85         /*! The data payload of the event, made up of information elements */
86         unsigned char payload[0];
87 } __attribute__((packed));
88
89
90 /*!
91  * \brief A holder for an event
92  *
93  * \details This struct used to have more of a purpose than it does now.
94  * It is used to hold events in the event cache.  It can be completely removed
95  * if one of these two things is done:
96  *  - ast_event gets changed such that it never has to be realloc()d
97  *  - astobj2 is updated so that you can realloc() an astobj2 object
98  */
99 struct ast_event_ref {
100         struct ast_event *event;
101 };
102
103 struct ast_event_ie_val {
104         AST_LIST_ENTRY(ast_event_ie_val) entry;
105         enum ast_event_ie_type ie_type;
106         enum ast_event_ie_pltype ie_pltype;
107         union {
108                 uint32_t uint;
109                 struct {
110                         uint32_t hash;
111                         const char *str;
112                 };
113                 void *raw;
114         } payload;
115         size_t raw_datalen;
116 };
117
118 /*! \brief Event subscription */
119 struct ast_event_sub {
120         enum ast_event_type type;
121         ast_event_cb_t cb;
122         char description[64];
123         void *userdata;
124         uint32_t uniqueid;
125         AST_LIST_HEAD_NOLOCK(, ast_event_ie_val) ie_vals;
126         AST_RWDLLIST_ENTRY(ast_event_sub) entry;
127 };
128
129 static uint32_t sub_uniqueid;
130
131 /*! \brief Event subscriptions
132  * The event subscribers are indexed by which event they are subscribed to */
133 static AST_RWDLLIST_HEAD(ast_event_sub_list, ast_event_sub) ast_event_subs[AST_EVENT_TOTAL];
134
135 static int ast_event_cmp(void *obj, void *arg, int flags);
136 static int ast_event_hash_mwi(const void *obj, const int flags);
137 static int ast_event_hash_devstate(const void *obj, const int flags);
138 static int ast_event_hash_devstate_change(const void *obj, const int flags);
139
140 #ifdef LOW_MEMORY
141 #define NUM_CACHE_BUCKETS 17
142 #else
143 #define NUM_CACHE_BUCKETS 563
144 #endif
145
146 #define MAX_CACHE_ARGS 8
147
148 /*!
149  * \brief Event types that are kept in the cache.
150  */
151 static struct {
152         /*! 
153          * \brief Container of cached events
154          *
155          * \details This gets allocated in ast_event_init() when Asterisk starts
156          * for the event types declared as using the cache.
157          */
158         struct ao2_container *container;
159         /*! \brief Event type specific hash function */
160         ao2_hash_fn *hash_fn;
161         /*!
162          * \brief Information Elements used for caching
163          *
164          * \details This array is the set of information elements that will be unique
165          * among all events in the cache for this event type.  When a new event gets
166          * cached, a previous event with the same values for these information elements
167          * will be replaced.
168          */
169         enum ast_event_ie_type cache_args[MAX_CACHE_ARGS];
170 } ast_event_cache[AST_EVENT_TOTAL] = {
171         [AST_EVENT_MWI] = {
172                 .hash_fn = ast_event_hash_mwi,
173                 .cache_args = { AST_EVENT_IE_MAILBOX, AST_EVENT_IE_CONTEXT },
174         },
175         [AST_EVENT_DEVICE_STATE] = {
176                 .hash_fn = ast_event_hash_devstate,
177                 .cache_args = { AST_EVENT_IE_DEVICE, },
178         },
179         [AST_EVENT_DEVICE_STATE_CHANGE] = {
180                 .hash_fn = ast_event_hash_devstate_change,
181                 .cache_args = { AST_EVENT_IE_DEVICE, AST_EVENT_IE_EID, },
182         },
183 };
184
185 /*!
186  * The index of each entry _must_ match the event type number!
187  */
188 static struct event_name {
189         enum ast_event_type type;
190         const char *name;
191 } event_names[] = {
192         { 0, "" },
193         { AST_EVENT_CUSTOM,              "Custom" },
194         { AST_EVENT_MWI,                 "MWI" },
195         { AST_EVENT_SUB,                 "Subscription" },
196         { AST_EVENT_UNSUB,               "Unsubscription" },
197         { AST_EVENT_DEVICE_STATE,        "DeviceState" },
198         { AST_EVENT_DEVICE_STATE_CHANGE, "DeviceStateChange" },
199         { AST_EVENT_CEL, "CEL" },
200 };
201
202 /*!
203  * The index of each entry _must_ match the event ie number!
204  */
205 static struct ie_map {
206         enum ast_event_ie_type ie_type;
207         enum ast_event_ie_pltype ie_pltype;
208         const char *name;
209 } ie_maps[] = {
210         { 0, 0, "" },
211         { AST_EVENT_IE_NEWMSGS,              AST_EVENT_IE_PLTYPE_UINT, "NewMessages" },
212         { AST_EVENT_IE_OLDMSGS,              AST_EVENT_IE_PLTYPE_UINT, "OldMessages" },
213         { AST_EVENT_IE_MAILBOX,              AST_EVENT_IE_PLTYPE_STR,  "Mailbox" },
214         { AST_EVENT_IE_UNIQUEID,             AST_EVENT_IE_PLTYPE_UINT, "UniqueID" },
215         { AST_EVENT_IE_EVENTTYPE,            AST_EVENT_IE_PLTYPE_UINT, "EventType" },
216         { AST_EVENT_IE_EXISTS,               AST_EVENT_IE_PLTYPE_UINT, "Exists" },
217         { AST_EVENT_IE_DEVICE,               AST_EVENT_IE_PLTYPE_STR,  "Device" },
218         { AST_EVENT_IE_STATE,                AST_EVENT_IE_PLTYPE_UINT, "State" },
219         { AST_EVENT_IE_CONTEXT,              AST_EVENT_IE_PLTYPE_STR,  "Context" },
220         { AST_EVENT_IE_EID,                  AST_EVENT_IE_PLTYPE_RAW,  "EntityID" },
221         { AST_EVENT_IE_CEL_EVENT_TYPE,       AST_EVENT_IE_PLTYPE_UINT,  "CELEventType" },
222         { AST_EVENT_IE_CEL_EVENT_TIME,       AST_EVENT_IE_PLTYPE_UINT,  "CELEventTime" },
223         { AST_EVENT_IE_CEL_EVENT_TIME_USEC,  AST_EVENT_IE_PLTYPE_UINT,  "CELEventTimeUSec" },
224         { AST_EVENT_IE_CEL_USEREVENT_NAME,   AST_EVENT_IE_PLTYPE_UINT,  "CELUserEventName" },
225         { AST_EVENT_IE_CEL_CIDNAME,          AST_EVENT_IE_PLTYPE_STR,  "CELCIDName" },
226         { AST_EVENT_IE_CEL_CIDNUM,           AST_EVENT_IE_PLTYPE_STR,  "CELCIDNum" },
227         { AST_EVENT_IE_CEL_EXTEN,            AST_EVENT_IE_PLTYPE_STR,  "CELExten" },
228         { AST_EVENT_IE_CEL_CONTEXT,          AST_EVENT_IE_PLTYPE_STR,  "CELContext" },
229         { AST_EVENT_IE_CEL_CHANNAME,         AST_EVENT_IE_PLTYPE_STR,  "CELChanName" },
230         { AST_EVENT_IE_CEL_APPNAME,          AST_EVENT_IE_PLTYPE_STR,  "CELAppName" },
231         { AST_EVENT_IE_CEL_APPDATA,          AST_EVENT_IE_PLTYPE_STR,  "CELAppData" },
232         { AST_EVENT_IE_CEL_AMAFLAGS,         AST_EVENT_IE_PLTYPE_STR,  "CELAMAFlags" },
233         { AST_EVENT_IE_CEL_ACCTCODE,         AST_EVENT_IE_PLTYPE_UINT,  "CELAcctCode" },
234         { AST_EVENT_IE_CEL_UNIQUEID,         AST_EVENT_IE_PLTYPE_STR,  "CELUniqueID" },
235         { AST_EVENT_IE_CEL_USERFIELD,        AST_EVENT_IE_PLTYPE_STR,  "CELUserField" },
236         { AST_EVENT_IE_CEL_CIDANI,           AST_EVENT_IE_PLTYPE_STR,  "CELCIDani" },
237         { AST_EVENT_IE_CEL_CIDRDNIS,         AST_EVENT_IE_PLTYPE_STR,  "CELCIDrdnis" },
238         { AST_EVENT_IE_CEL_CIDDNID,          AST_EVENT_IE_PLTYPE_STR,  "CELCIDdnid" },
239         { AST_EVENT_IE_CEL_PEER,             AST_EVENT_IE_PLTYPE_STR,  "CELPeer" },
240         { AST_EVENT_IE_CEL_LINKEDID,         AST_EVENT_IE_PLTYPE_STR,  "CELLinkedID" },
241         { AST_EVENT_IE_CEL_PEERACCT,         AST_EVENT_IE_PLTYPE_STR,  "CELPeerAcct" },
242         { AST_EVENT_IE_CEL_EXTRA,            AST_EVENT_IE_PLTYPE_STR,  "CELExtra" },
243 };
244
245 const char *ast_event_get_type_name(const struct ast_event *event)
246 {
247         enum ast_event_type type;
248
249         type = ast_event_get_type(event);
250
251         if (type >= AST_EVENT_TOTAL || type < 0) {
252                 ast_log(LOG_ERROR, "Invalid event type - '%d'\n", type);
253                 return "";
254         }
255
256         return event_names[type].name;
257 }
258
259 int ast_event_str_to_event_type(const char *str, enum ast_event_type *event_type)
260 {
261         int i;
262
263         for (i = 0; i < ARRAY_LEN(event_names); i++) {
264                 if (strcasecmp(event_names[i].name, str))
265                         continue;
266
267                 *event_type = event_names[i].type;
268                 return 0;
269         }
270
271         return -1;
272 }
273
274 const char *ast_event_get_ie_type_name(enum ast_event_ie_type ie_type)
275 {
276         if (ie_type <= 0 || ie_type > AST_EVENT_IE_MAX) {
277                 ast_log(LOG_ERROR, "Invalid IE type - '%d'\n", ie_type);
278                 return "";
279         }
280
281         if (ie_maps[ie_type].ie_type != ie_type) {
282                 ast_log(LOG_ERROR, "The ie type passed in does not match the ie type defined in the ie table.\n");
283                 return "";
284         }
285
286         return ie_maps[ie_type].name;
287 }
288
289 enum ast_event_ie_pltype ast_event_get_ie_pltype(enum ast_event_ie_type ie_type)
290 {
291         if (ie_type <= 0 || ie_type > AST_EVENT_IE_MAX) {
292                 ast_log(LOG_ERROR, "Invalid IE type - '%d'\n", ie_type);
293                 return AST_EVENT_IE_PLTYPE_UNKNOWN;
294         }
295
296         if (ie_maps[ie_type].ie_type != ie_type) {
297                 ast_log(LOG_ERROR, "The ie type passed in does not match the ie type defined in the ie table.\n");
298                 return AST_EVENT_IE_PLTYPE_UNKNOWN;
299         }
300
301         return ie_maps[ie_type].ie_pltype;
302 }
303
304 int ast_event_str_to_ie_type(const char *str, enum ast_event_ie_type *ie_type)
305 {
306         int i;
307
308         for (i = 0; i < ARRAY_LEN(ie_maps); i++) {
309                 if (strcasecmp(ie_maps[i].name, str))
310                         continue;
311
312                 *ie_type = ie_maps[i].ie_type;
313                 return 0;
314         }
315
316         return -1;
317 }
318
319 size_t ast_event_get_size(const struct ast_event *event)
320 {
321         size_t res;
322
323         res = ntohs(event->event_len);
324
325         return res;
326 }
327
328 static void ast_event_ie_val_destroy(struct ast_event_ie_val *ie_val)
329 {
330         switch (ie_val->ie_pltype) {
331         case AST_EVENT_IE_PLTYPE_STR:
332                 ast_free((char *) ie_val->payload.str);
333                 break;
334         case AST_EVENT_IE_PLTYPE_RAW:
335                 ast_free(ie_val->payload.raw);
336                 break;
337         case AST_EVENT_IE_PLTYPE_UINT:
338         case AST_EVENT_IE_PLTYPE_BITFLAGS:
339         case AST_EVENT_IE_PLTYPE_EXISTS:
340         case AST_EVENT_IE_PLTYPE_UNKNOWN:
341                 break;
342         }
343
344         ast_free(ie_val);
345 }
346
347 enum ast_event_subscriber_res ast_event_check_subscriber(enum ast_event_type type, ...)
348 {
349         va_list ap;
350         enum ast_event_ie_type ie_type;
351         enum ast_event_subscriber_res res = AST_EVENT_SUB_NONE;
352         struct ast_event_ie_val *ie_val, *sub_ie_val;
353         struct ast_event_sub *sub;
354         AST_LIST_HEAD_NOLOCK_STATIC(ie_vals, ast_event_ie_val);
355
356         if (type >= AST_EVENT_TOTAL) {
357                 ast_log(LOG_ERROR, "%u is an invalid type!\n", type);
358                 return res;
359         }
360
361         va_start(ap, type);
362         for (ie_type = va_arg(ap, enum ast_event_type);
363                 ie_type != AST_EVENT_IE_END;
364                 ie_type = va_arg(ap, enum ast_event_type))
365         {
366                 struct ast_event_ie_val *ie_value = alloca(sizeof(*ie_value));
367                 int insert = 1;
368                 memset(ie_value, 0, sizeof(*ie_value));
369                 ie_value->ie_type = ie_type;
370                 ie_value->ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
371                 switch (ie_value->ie_pltype) {
372                 case AST_EVENT_IE_PLTYPE_UINT:
373                         ie_value->payload.uint = va_arg(ap, uint32_t);
374                         break;
375                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
376                         ie_value->payload.uint = va_arg(ap, uint32_t);
377                         break;
378                 case AST_EVENT_IE_PLTYPE_STR:
379                         ie_value->payload.str = va_arg(ap, const char *);
380                         break;
381                 case AST_EVENT_IE_PLTYPE_RAW:
382                 {
383                         void *data = va_arg(ap, void *);
384                         size_t datalen = va_arg(ap, size_t);
385                         ie_value->payload.raw = alloca(datalen);
386                         memcpy(ie_value->payload.raw, data, datalen);
387                         ie_value->raw_datalen = datalen;
388                         break;
389                 }
390                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
391                         insert = 0;
392                 case AST_EVENT_IE_PLTYPE_EXISTS:
393                         break;
394                 }
395
396                 if (insert) {
397                         AST_LIST_INSERT_TAIL(&ie_vals, ie_value, entry);
398                 }
399         }
400         va_end(ap);
401
402         AST_RWDLLIST_RDLOCK(&ast_event_subs[type]);
403         AST_RWDLLIST_TRAVERSE(&ast_event_subs[type], sub, entry) {
404                 AST_LIST_TRAVERSE(&ie_vals, ie_val, entry) {
405                         int break_out = 0;
406
407                         AST_LIST_TRAVERSE(&sub->ie_vals, sub_ie_val, entry) {
408                                 if (sub_ie_val->ie_type == ie_val->ie_type) {
409                                         break;
410                                 }
411                         }
412
413                         if (!sub_ie_val) {
414                                 /* This subscriber doesn't care about this IE, so consider
415                                  * it matched. */
416                                 continue;
417                         }
418
419                         switch (ie_val->ie_pltype) {
420                         case AST_EVENT_IE_PLTYPE_UINT:
421                                 break_out = (ie_val->payload.uint != sub_ie_val->payload.uint);
422                                 break;
423                         case AST_EVENT_IE_PLTYPE_BITFLAGS:
424                                 /* if the subscriber has requested *any* of the bitflags we are providing,
425                                  * then it's a match
426                                  */
427                                 break_out = (ie_val->payload.uint & sub_ie_val->payload.uint);
428                                 break;
429                         case AST_EVENT_IE_PLTYPE_STR:
430                                 break_out = strcmp(ie_val->payload.str, sub_ie_val->payload.str);
431                                 break;
432                         case AST_EVENT_IE_PLTYPE_RAW:
433                                 break_out = memcmp(ie_val->payload.raw,
434                                                 sub_ie_val->payload.raw, ie_val->raw_datalen);
435                                 break;
436                         case AST_EVENT_IE_PLTYPE_EXISTS:
437                                 /* The subscriber doesn't actually care what the value is */
438                                 break_out = 1;
439                                 break;
440                         case AST_EVENT_IE_PLTYPE_UNKNOWN:
441                                 break;
442                         }
443
444                         if (break_out) {
445                                 break;
446                         }
447                 }
448
449                 if (!ie_val) {
450                         /* Everything matched */
451                         break;
452                 }
453         }
454         AST_RWDLLIST_UNLOCK(&ast_event_subs[type]);
455
456         if (sub) {
457                 /* All parameters were matched */
458                 return AST_EVENT_SUB_EXISTS;
459         }
460
461         AST_RWDLLIST_RDLOCK(&ast_event_subs[AST_EVENT_ALL]);
462         if (!AST_DLLIST_EMPTY(&ast_event_subs[AST_EVENT_ALL])) {
463                 res = AST_EVENT_SUB_EXISTS;
464         }
465         AST_RWDLLIST_UNLOCK(&ast_event_subs[AST_EVENT_ALL]);
466
467         return res;
468 }
469
470 static int match_ie_val(const struct ast_event *event,
471                 const struct ast_event_ie_val *ie_val, const struct ast_event *event2)
472 {
473         switch (ie_val->ie_pltype) {
474         case AST_EVENT_IE_PLTYPE_UINT:
475         {
476                 uint32_t val = event2 ? ast_event_get_ie_uint(event2, ie_val->ie_type) : ie_val->payload.uint;
477
478                 return (val == ast_event_get_ie_uint(event, ie_val->ie_type)) ? 1 : 0;
479         }
480
481         case AST_EVENT_IE_PLTYPE_BITFLAGS:
482         {
483                 uint32_t flags = event2 ? ast_event_get_ie_uint(event2, ie_val->ie_type) : ie_val->payload.uint;
484
485                 /* if the subscriber has requested *any* of the bitflags that this event provides,
486                  * then it's a match
487                  */
488                 return (flags & ast_event_get_ie_bitflags(event, ie_val->ie_type)) ? 1 : 0;
489         }
490
491         case AST_EVENT_IE_PLTYPE_STR:
492         {
493                 const char *str;
494                 uint32_t hash;
495
496                 hash = event2 ? ast_event_get_ie_str_hash(event2, ie_val->ie_type) : ie_val->payload.hash;
497                 if (hash != ast_event_get_ie_str_hash(event, ie_val->ie_type)) {
498                         return 0;
499                 }
500
501                 str = event2 ? ast_event_get_ie_str(event2, ie_val->ie_type) : ie_val->payload.str;
502                 if (str && !strcmp(str, ast_event_get_ie_str(event, ie_val->ie_type))) {
503                         return 1;
504                 }
505
506                 return 0;
507         }
508
509         case AST_EVENT_IE_PLTYPE_RAW:
510         {
511                 const void *buf = event2 ? ast_event_get_ie_raw(event2, ie_val->ie_type) : ie_val->payload.raw;
512
513                 return (buf && !memcmp(buf, ast_event_get_ie_raw(event, ie_val->ie_type), ie_val->raw_datalen)) ? 1 : 0;
514         }
515
516         case AST_EVENT_IE_PLTYPE_EXISTS:
517         {
518                 return ast_event_get_ie_raw(event, ie_val->ie_type) ? 1 : 0;
519         }
520
521         case AST_EVENT_IE_PLTYPE_UNKNOWN:
522                 return 0;
523         }
524
525         return 0;
526 }
527
528 static int dump_cache_cb(void *obj, void *arg, int flags)
529 {
530         const struct ast_event_ref *event_ref = obj;
531         const struct ast_event *event = event_ref->event;
532         const struct ast_event_sub *event_sub = arg;
533         struct ast_event_ie_val *ie_val = NULL;
534
535         AST_LIST_TRAVERSE(&event_sub->ie_vals, ie_val, entry) {
536                 if (!match_ie_val(event, ie_val, NULL)) {
537                         break;
538                 }
539         }
540
541         if (!ie_val) {
542                 /* All parameters were matched on this cache entry, so dump it */
543                 event_sub->cb(event, event_sub->userdata);
544         }
545
546         return 0;
547 }
548
549 /*! \brief Dump the event cache for the subscribed event type */
550 void ast_event_dump_cache(const struct ast_event_sub *event_sub)
551 {
552         ao2_callback(ast_event_cache[event_sub->type].container, OBJ_NODATA,
553                         dump_cache_cb, (void *) event_sub);
554 }
555
556 static struct ast_event *gen_sub_event(struct ast_event_sub *sub)
557 {
558         struct ast_event_ie_val *ie_val;
559         struct ast_event *event;
560
561         event = ast_event_new(AST_EVENT_SUB,
562                 AST_EVENT_IE_UNIQUEID,    AST_EVENT_IE_PLTYPE_UINT, sub->uniqueid,
563                 AST_EVENT_IE_EVENTTYPE,   AST_EVENT_IE_PLTYPE_UINT, sub->type,
564                 AST_EVENT_IE_DESCRIPTION, AST_EVENT_IE_PLTYPE_STR, sub->description,
565                 AST_EVENT_IE_END);
566
567         if (!event)
568                 return NULL;
569
570         AST_LIST_TRAVERSE(&sub->ie_vals, ie_val, entry) {
571                 switch (ie_val->ie_pltype) {
572                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
573                         break;
574                 case AST_EVENT_IE_PLTYPE_EXISTS:
575                         ast_event_append_ie_uint(&event, AST_EVENT_IE_EXISTS, ie_val->ie_type);
576                         break;
577                 case AST_EVENT_IE_PLTYPE_UINT:
578                         ast_event_append_ie_uint(&event, ie_val->ie_type, ie_val->payload.uint);
579                         break;
580                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
581                         ast_event_append_ie_bitflags(&event, ie_val->ie_type, ie_val->payload.uint);
582                         break;
583                 case AST_EVENT_IE_PLTYPE_STR:
584                         ast_event_append_ie_str(&event, ie_val->ie_type, ie_val->payload.str);
585                         break;
586                 case AST_EVENT_IE_PLTYPE_RAW:
587                         ast_event_append_ie_raw(&event, ie_val->ie_type, ie_val->payload.raw, ie_val->raw_datalen);
588                         break;
589                 }
590                 if (!event)
591                         break;
592         }
593
594         return event;
595 }
596
597 /*! \brief Send AST_EVENT_SUB events to this subscriber of ... subscriber events */
598 void ast_event_report_subs(const struct ast_event_sub *event_sub)
599 {
600         struct ast_event *event;
601         struct ast_event_sub *sub;
602         enum ast_event_type event_type = -1;
603         struct ast_event_ie_val *ie_val;
604
605         if (event_sub->type != AST_EVENT_SUB)
606                 return;
607
608         AST_LIST_TRAVERSE(&event_sub->ie_vals, ie_val, entry) {
609                 if (ie_val->ie_type == AST_EVENT_IE_EVENTTYPE) {
610                         event_type = ie_val->payload.uint;
611                         break;
612                 }
613         }
614
615         if (event_type == -1)
616                 return;
617
618         AST_RWDLLIST_RDLOCK(&ast_event_subs[event_type]);
619         AST_RWDLLIST_TRAVERSE(&ast_event_subs[event_type], sub, entry) {
620                 if (event_sub == sub) {
621                         continue;
622                 }
623
624                 event = gen_sub_event(sub);
625
626                 if (!event) {
627                         continue;
628                 }
629
630                 event_sub->cb(event, event_sub->userdata);
631
632                 ast_event_destroy(event);
633         }
634         AST_RWDLLIST_UNLOCK(&ast_event_subs[event_type]);
635 }
636
637 struct ast_event_sub *ast_event_subscribe_new(enum ast_event_type type,
638         ast_event_cb_t cb, void *userdata)
639 {
640         struct ast_event_sub *sub;
641
642         if (type < 0 || type >= AST_EVENT_TOTAL) {
643                 ast_log(LOG_ERROR, "%u is an invalid type!\n", type);
644                 return NULL;
645         }
646
647         if (!(sub = ast_calloc(1, sizeof(*sub)))) {
648                 return NULL;
649         }
650
651         sub->type = type;
652         sub->cb = cb;
653         sub->userdata = userdata;
654         sub->uniqueid = ast_atomic_fetchadd_int((int *) &sub_uniqueid, 1);
655
656         return sub;
657 }
658
659 int ast_event_sub_append_ie_uint(struct ast_event_sub *sub,
660         enum ast_event_ie_type ie_type, uint32_t unsigned_int)
661 {
662         struct ast_event_ie_val *ie_val;
663
664         if (ie_type < 0 || ie_type > AST_EVENT_IE_MAX) {
665                 return -1;
666         }
667
668         if (!(ie_val = ast_calloc(1, sizeof(*ie_val)))) {
669                 return -1;
670         }
671
672         ie_val->ie_type = ie_type;
673         ie_val->payload.uint = unsigned_int;
674         ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_UINT;
675
676         AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
677
678         return 0;
679 }
680
681 int ast_event_sub_append_ie_bitflags(struct ast_event_sub *sub,
682         enum ast_event_ie_type ie_type, uint32_t flags)
683 {
684         struct ast_event_ie_val *ie_val;
685
686         if (ie_type < 0 || ie_type > AST_EVENT_IE_MAX)
687                 return -1;
688
689         if (!(ie_val = ast_calloc(1, sizeof(*ie_val))))
690                 return -1;
691
692         ie_val->ie_type = ie_type;
693         ie_val->payload.uint = flags;
694         ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_BITFLAGS;
695
696         AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
697
698         return 0;
699 }
700
701 int ast_event_sub_append_ie_exists(struct ast_event_sub *sub,
702         enum ast_event_ie_type ie_type)
703 {
704         struct ast_event_ie_val *ie_val;
705
706         if (ie_type < 0 || ie_type > AST_EVENT_IE_MAX) {
707                 return -1;
708         }
709
710         if (!(ie_val = ast_calloc(1, sizeof(*ie_val)))) {
711                 return -1;
712         }
713
714         ie_val->ie_type = ie_type;
715         ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_EXISTS;
716
717         AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
718
719         return 0;
720 }
721
722 int ast_event_sub_append_ie_str(struct ast_event_sub *sub,
723         enum ast_event_ie_type ie_type, const char *str)
724 {
725         struct ast_event_ie_val *ie_val;
726
727         if (ie_type < 0 || ie_type > AST_EVENT_IE_MAX) {
728                 return -1;
729         }
730
731         if (!(ie_val = ast_calloc(1, sizeof(*ie_val)))) {
732                 return -1;
733         }
734
735         ie_val->ie_type = ie_type;
736         ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_STR;
737
738         if (!(ie_val->payload.str = ast_strdup(str))) {
739                 ast_free(ie_val);
740                 return -1;
741         }
742
743         ie_val->payload.hash = ast_str_hash(str);
744
745         AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
746
747         return 0;
748 }
749
750 int ast_event_sub_append_ie_raw(struct ast_event_sub *sub,
751         enum ast_event_ie_type ie_type, void *data, size_t raw_datalen)
752 {
753         struct ast_event_ie_val *ie_val;
754
755         if (ie_type < 0 || ie_type > AST_EVENT_IE_MAX) {
756                 return -1;
757         }
758
759         if (!(ie_val = ast_calloc(1, sizeof(*ie_val)))) {
760                 return -1;
761         }
762
763         ie_val->ie_type = ie_type;
764         ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_RAW;
765         ie_val->raw_datalen = raw_datalen;
766
767         if (!(ie_val->payload.raw = ast_malloc(raw_datalen))) {
768                 ast_free(ie_val);
769                 return -1;
770         }
771
772         memcpy(ie_val->payload.raw, data, raw_datalen);
773
774         AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
775
776         return 0;
777 }
778
779 int ast_event_sub_activate(struct ast_event_sub *sub)
780 {
781         if (ast_event_check_subscriber(AST_EVENT_SUB,
782                 AST_EVENT_IE_EVENTTYPE, AST_EVENT_IE_PLTYPE_UINT, sub->type,
783                 AST_EVENT_IE_END) != AST_EVENT_SUB_NONE) {
784                 struct ast_event *event;
785
786                 event = gen_sub_event(sub);
787
788                 if (event) {
789                         ast_event_queue(event);
790                 }
791         }
792
793         AST_RWDLLIST_WRLOCK(&ast_event_subs[sub->type]);
794         AST_RWDLLIST_INSERT_TAIL(&ast_event_subs[sub->type], sub, entry);
795         AST_RWDLLIST_UNLOCK(&ast_event_subs[sub->type]);
796
797         return 0;
798 }
799
800 struct ast_event_sub *ast_event_subscribe(enum ast_event_type type, ast_event_cb_t cb,
801         char *description, void *userdata, ...)
802 {
803         va_list ap;
804         enum ast_event_ie_type ie_type;
805         struct ast_event_sub *sub;
806
807         if (!(sub = ast_event_subscribe_new(type, cb, userdata))) {
808                 return NULL;
809         }
810
811         ast_copy_string(sub->description, description, sizeof(sub->description));
812
813         va_start(ap, userdata);
814         for (ie_type = va_arg(ap, enum ast_event_type);
815                 ie_type != AST_EVENT_IE_END;
816                 ie_type = va_arg(ap, enum ast_event_type))
817         {
818                 enum ast_event_ie_pltype ie_pltype;
819
820                 ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
821
822                 switch (ie_pltype) {
823                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
824                         break;
825                 case AST_EVENT_IE_PLTYPE_UINT:
826                 {
827                         uint32_t unsigned_int = va_arg(ap, uint32_t);
828                         ast_event_sub_append_ie_uint(sub, ie_type, unsigned_int);
829                         break;
830                 }
831                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
832                 {
833                         uint32_t unsigned_int = va_arg(ap, uint32_t);
834                         ast_event_sub_append_ie_bitflags(sub, ie_type, unsigned_int);
835                         break;
836                 }
837                 case AST_EVENT_IE_PLTYPE_STR:
838                 {
839                         const char *str = va_arg(ap, const char *);
840                         ast_event_sub_append_ie_str(sub, ie_type, str);
841                         break;
842                 }
843                 case AST_EVENT_IE_PLTYPE_RAW:
844                 {
845                         void *data = va_arg(ap, void *);
846                         size_t data_len = va_arg(ap, size_t);
847                         ast_event_sub_append_ie_raw(sub, ie_type, data, data_len);
848                         break;
849                 }
850                 case AST_EVENT_IE_PLTYPE_EXISTS:
851                         ast_event_sub_append_ie_exists(sub, ie_type);
852                         break;
853                 }
854         }
855         va_end(ap);
856
857         ast_event_sub_activate(sub);
858
859         return sub;
860 }
861
862 void ast_event_sub_destroy(struct ast_event_sub *sub)
863 {
864         struct ast_event_ie_val *ie_val;
865
866         while ((ie_val = AST_LIST_REMOVE_HEAD(&sub->ie_vals, entry))) {
867                 ast_event_ie_val_destroy(ie_val);
868         }
869
870         ast_free(sub);
871 }
872
873 const char *ast_event_subscriber_get_description(struct ast_event_sub *sub)
874 {
875         return sub ? sub->description : NULL;
876 }
877
878 struct ast_event_sub *ast_event_unsubscribe(struct ast_event_sub *sub)
879 {
880         struct ast_event *event;
881
882         AST_RWDLLIST_WRLOCK(&ast_event_subs[sub->type]);
883         AST_DLLIST_REMOVE(&ast_event_subs[sub->type], sub, entry);
884         AST_RWDLLIST_UNLOCK(&ast_event_subs[sub->type]);
885
886         if (ast_event_check_subscriber(AST_EVENT_UNSUB,
887                 AST_EVENT_IE_EVENTTYPE, AST_EVENT_IE_PLTYPE_UINT, sub->type,
888                 AST_EVENT_IE_END) != AST_EVENT_SUB_NONE) {
889
890                 event = ast_event_new(AST_EVENT_UNSUB,
891                         AST_EVENT_IE_UNIQUEID,    AST_EVENT_IE_PLTYPE_UINT, sub->uniqueid,
892                         AST_EVENT_IE_EVENTTYPE,   AST_EVENT_IE_PLTYPE_UINT, sub->type,
893                         AST_EVENT_IE_DESCRIPTION, AST_EVENT_IE_PLTYPE_STR, sub->description,
894                         AST_EVENT_IE_END);
895
896                 if (event) {
897                         ast_event_queue(event);
898                 }
899         }
900
901         ast_event_sub_destroy(sub);
902
903         return NULL;
904 }
905
906 void ast_event_iterator_init(struct ast_event_iterator *iterator, const struct ast_event *event)
907 {
908         iterator->event_len = ntohs(event->event_len);
909         iterator->event = event;
910         iterator->ie = (struct ast_event_ie *) ( ((char *) event) + sizeof(*event) );
911 }
912
913 int ast_event_iterator_next(struct ast_event_iterator *iterator)
914 {
915         iterator->ie = (struct ast_event_ie *) ( ((char *) iterator->ie) + sizeof(*iterator->ie) + ntohs(iterator->ie->ie_payload_len));
916         return ((iterator->event_len <= (((char *) iterator->ie) - ((char *) iterator->event))) ? -1 : 0);
917 }
918
919 enum ast_event_ie_type ast_event_iterator_get_ie_type(struct ast_event_iterator *iterator)
920 {
921         return ntohs(iterator->ie->ie_type);
922 }
923
924 uint32_t ast_event_iterator_get_ie_uint(struct ast_event_iterator *iterator)
925 {
926         return ntohl(get_unaligned_uint32(iterator->ie->ie_payload));
927 }
928
929 uint32_t ast_event_iterator_get_ie_bitflags(struct ast_event_iterator *iterator)
930 {
931         return ntohl(get_unaligned_uint32(iterator->ie->ie_payload));
932 }
933
934 const char *ast_event_iterator_get_ie_str(struct ast_event_iterator *iterator)
935 {
936         const struct ast_event_ie_str_payload *str_payload;
937
938         str_payload = (struct ast_event_ie_str_payload *) iterator->ie->ie_payload;
939
940         return str_payload->str;
941 }
942
943 void *ast_event_iterator_get_ie_raw(struct ast_event_iterator *iterator)
944 {
945         return iterator->ie->ie_payload;
946 }
947
948 enum ast_event_type ast_event_get_type(const struct ast_event *event)
949 {
950         return ntohs(event->type);
951 }
952
953 uint32_t ast_event_get_ie_uint(const struct ast_event *event, enum ast_event_ie_type ie_type)
954 {
955         const uint32_t *ie_val;
956
957         ie_val = ast_event_get_ie_raw(event, ie_type);
958
959         return ie_val ? ntohl(get_unaligned_uint32(ie_val)) : 0;
960 }
961
962 uint32_t ast_event_get_ie_bitflags(const struct ast_event *event, enum ast_event_ie_type ie_type)
963 {
964         const uint32_t *ie_val;
965
966         ie_val = ast_event_get_ie_raw(event, ie_type);
967
968         return ie_val ? ntohl(get_unaligned_uint32(ie_val)) : 0;
969 }
970
971 uint32_t ast_event_get_ie_str_hash(const struct ast_event *event, enum ast_event_ie_type ie_type)
972 {
973         const struct ast_event_ie_str_payload *str_payload;
974
975         str_payload = ast_event_get_ie_raw(event, ie_type);
976
977         return str_payload->hash;
978 }
979
980 const char *ast_event_get_ie_str(const struct ast_event *event, enum ast_event_ie_type ie_type)
981 {
982         const struct ast_event_ie_str_payload *str_payload;
983
984         str_payload = ast_event_get_ie_raw(event, ie_type);
985
986         return str_payload->str;
987 }
988
989 const void *ast_event_get_ie_raw(const struct ast_event *event, enum ast_event_ie_type ie_type)
990 {
991         struct ast_event_iterator iterator;
992         int res = 0;
993
994         for (ast_event_iterator_init(&iterator, event); !res; res = ast_event_iterator_next(&iterator)) {
995                 if (ast_event_iterator_get_ie_type(&iterator) == ie_type) {
996                         return ast_event_iterator_get_ie_raw(&iterator);
997                 }
998         }
999
1000         return NULL;
1001 }
1002
1003 int ast_event_append_ie_str(struct ast_event **event, enum ast_event_ie_type ie_type,
1004         const char *str)
1005 {
1006         struct ast_event_ie_str_payload *str_payload;
1007         size_t payload_len;
1008
1009         payload_len = sizeof(*str_payload) + strlen(str);
1010         str_payload = alloca(payload_len);
1011
1012         strcpy(str_payload->str, str);
1013         str_payload->hash = ast_str_hash(str);
1014
1015         return ast_event_append_ie_raw(event, ie_type, str_payload, payload_len);
1016 }
1017
1018 int ast_event_append_ie_uint(struct ast_event **event, enum ast_event_ie_type ie_type,
1019         uint32_t data)
1020 {
1021         data = htonl(data);
1022         return ast_event_append_ie_raw(event, ie_type, &data, sizeof(data));
1023 }
1024
1025 int ast_event_append_ie_bitflags(struct ast_event **event, enum ast_event_ie_type ie_type,
1026         uint32_t flags)
1027 {
1028         flags = htonl(flags);
1029         return ast_event_append_ie_raw(event, ie_type, &flags, sizeof(flags));
1030 }
1031
1032 int ast_event_append_ie_raw(struct ast_event **event, enum ast_event_ie_type ie_type,
1033         const void *data, size_t data_len)
1034 {
1035         struct ast_event_ie *ie;
1036         unsigned int extra_len;
1037         uint16_t event_len;
1038
1039         event_len = ntohs((*event)->event_len);
1040         extra_len = sizeof(*ie) + data_len;
1041
1042         if (!(*event = ast_realloc(*event, event_len + extra_len))) {
1043                 return -1;
1044         }
1045
1046         ie = (struct ast_event_ie *) ( ((char *) *event) + event_len );
1047         ie->ie_type = htons(ie_type);
1048         ie->ie_payload_len = htons(data_len);
1049         memcpy(ie->ie_payload, data, data_len);
1050
1051         (*event)->event_len = htons(event_len + extra_len);
1052
1053         return 0;
1054 }
1055
1056 struct ast_event *ast_event_new(enum ast_event_type type, ...)
1057 {
1058         va_list ap;
1059         struct ast_event *event;
1060         enum ast_event_type ie_type;
1061         struct ast_event_ie_val *ie_val;
1062         AST_LIST_HEAD_NOLOCK_STATIC(ie_vals, ast_event_ie_val);
1063
1064         /* Invalid type */
1065         if (type >= AST_EVENT_TOTAL) {
1066                 ast_log(LOG_WARNING, "Someone tried to create an event of invalid "
1067                         "type '%d'!\n", type);
1068                 return NULL;
1069         }
1070
1071         va_start(ap, type);
1072         for (ie_type = va_arg(ap, enum ast_event_type);
1073                 ie_type != AST_EVENT_IE_END;
1074                 ie_type = va_arg(ap, enum ast_event_type))
1075         {
1076                 struct ast_event_ie_val *ie_value = alloca(sizeof(*ie_value));
1077                 int insert = 1;
1078                 memset(ie_value, 0, sizeof(*ie_value));
1079                 ie_value->ie_type = ie_type;
1080                 ie_value->ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
1081                 switch (ie_value->ie_pltype) {
1082                 case AST_EVENT_IE_PLTYPE_UINT:
1083                         ie_value->payload.uint = va_arg(ap, uint32_t);
1084                         break;
1085                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
1086                         ie_value->payload.uint = va_arg(ap, uint32_t);
1087                         break;
1088                 case AST_EVENT_IE_PLTYPE_STR:
1089                         ie_value->payload.str = va_arg(ap, const char *);
1090                         break;
1091                 case AST_EVENT_IE_PLTYPE_RAW:
1092                 {
1093                         void *data = va_arg(ap, void *);
1094                         size_t datalen = va_arg(ap, size_t);
1095                         ie_value->payload.raw = alloca(datalen);
1096                         memcpy(ie_value->payload.raw, data, datalen);
1097                         ie_value->raw_datalen = datalen;
1098                         break;
1099                 }
1100                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
1101                         insert = 0;
1102                         break;
1103                 case AST_EVENT_IE_PLTYPE_EXISTS:
1104                         break;
1105                 }
1106
1107                 if (insert) {
1108                         AST_LIST_INSERT_TAIL(&ie_vals, ie_value, entry);
1109                 }
1110         }
1111         va_end(ap);
1112
1113         if (!(event = ast_calloc(1, sizeof(*event)))) {
1114                 return NULL;
1115         }
1116
1117         event->type = htons(type);
1118         event->event_len = htons(sizeof(*event));
1119
1120         AST_LIST_TRAVERSE(&ie_vals, ie_val, entry) {
1121                 switch (ie_val->ie_pltype) {
1122                 case AST_EVENT_IE_PLTYPE_STR:
1123                         ast_event_append_ie_str(&event, ie_val->ie_type, ie_val->payload.str);
1124                         break;
1125                 case AST_EVENT_IE_PLTYPE_UINT:
1126                         ast_event_append_ie_uint(&event, ie_val->ie_type, ie_val->payload.uint);
1127                         break;
1128                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
1129                         ast_event_append_ie_bitflags(&event, ie_val->ie_type, ie_val->payload.uint);
1130                         break;
1131                 case AST_EVENT_IE_PLTYPE_RAW:
1132                         ast_event_append_ie_raw(&event, ie_val->ie_type,
1133                                         ie_val->payload.raw, ie_val->raw_datalen);
1134                         break;
1135                 case AST_EVENT_IE_PLTYPE_EXISTS:
1136                         ast_log(LOG_WARNING, "PLTYPE_EXISTS unsupported in event_new\n");
1137                         break;
1138                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
1139                         ast_log(LOG_WARNING, "PLTYPE_UNKNOWN passed as an IE type "
1140                                         "for a new event\n");
1141                         break;
1142                 }
1143
1144                 if (!event) {
1145                         break;
1146                 }
1147         }
1148
1149         if (!ast_event_get_ie_raw(event, AST_EVENT_IE_EID)) {
1150                 /* If the event is originating on this server, add the server's
1151                  * entity ID to the event. */
1152                 ast_event_append_ie_raw(&event, AST_EVENT_IE_EID, &ast_eid_default, sizeof(ast_eid_default));
1153         }
1154
1155         return event;
1156 }
1157
1158 void ast_event_destroy(struct ast_event *event)
1159 {
1160         ast_free(event);
1161 }
1162
1163 static void ast_event_ref_destroy(void *obj)
1164 {
1165         struct ast_event_ref *event_ref = obj;
1166
1167         ast_event_destroy(event_ref->event);
1168 }
1169
1170 static struct ast_event *ast_event_dup(const struct ast_event *event)
1171 {
1172         struct ast_event *dup_event;
1173         uint16_t event_len;
1174
1175         event_len = ast_event_get_size(event);
1176
1177         if (!(dup_event = ast_calloc(1, event_len))) {
1178                 return NULL;
1179         }
1180
1181         memcpy(dup_event, event, event_len);
1182
1183         return dup_event;
1184 }
1185
1186 struct ast_event *ast_event_get_cached(enum ast_event_type type, ...)
1187 {
1188         va_list ap;
1189         enum ast_event_ie_type ie_type;
1190         struct ast_event *dup_event = NULL;
1191         struct ast_event_ref *cached_event_ref;
1192         struct ast_event *cache_arg_event;
1193         struct ast_event_ref tmp_event_ref = {
1194                 .event = NULL,
1195         };
1196         struct ao2_container *container = NULL;
1197
1198         if (type >= AST_EVENT_TOTAL) {
1199                 ast_log(LOG_ERROR, "%u is an invalid type!\n", type);
1200                 return NULL;
1201         }
1202
1203         if (!(container = ast_event_cache[type].container)) {
1204                 ast_log(LOG_ERROR, "%u is not a cached event type\n", type);
1205                 return NULL;
1206         }
1207
1208         if (!(cache_arg_event = ast_event_new(type, AST_EVENT_IE_END))) {
1209                 return NULL;
1210         }
1211
1212         va_start(ap, type);
1213         for (ie_type = va_arg(ap, enum ast_event_type);
1214                 ie_type != AST_EVENT_IE_END;
1215                 ie_type = va_arg(ap, enum ast_event_type))
1216         {
1217                 enum ast_event_ie_pltype ie_pltype;
1218
1219                 ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
1220
1221                 switch (ie_pltype) {
1222                 case AST_EVENT_IE_PLTYPE_UINT:
1223                         ast_event_append_ie_uint(&cache_arg_event, ie_type, va_arg(ap, uint32_t));
1224                         break;
1225                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
1226                         ast_event_append_ie_bitflags(&cache_arg_event, ie_type, va_arg(ap, uint32_t));
1227                         break;
1228                 case AST_EVENT_IE_PLTYPE_STR:
1229                         ast_event_append_ie_str(&cache_arg_event, ie_type, va_arg(ap, const char *));
1230                         break;
1231                 case AST_EVENT_IE_PLTYPE_RAW:
1232                 {
1233                         void *data = va_arg(ap, void *);
1234                         size_t datalen = va_arg(ap, size_t);
1235                         ast_event_append_ie_raw(&cache_arg_event, ie_type, data, datalen);
1236                 }
1237                 case AST_EVENT_IE_PLTYPE_EXISTS:
1238                         ast_log(LOG_WARNING, "PLTYPE_EXISTS not supported by this function\n");
1239                         break;
1240                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
1241                         break;
1242                 }
1243         }
1244         va_end(ap);
1245
1246         tmp_event_ref.event = cache_arg_event;
1247
1248         cached_event_ref = ao2_find(container, &tmp_event_ref, OBJ_POINTER);
1249
1250         ast_event_destroy(cache_arg_event);
1251         cache_arg_event = NULL;
1252
1253         if (cached_event_ref) {
1254                 dup_event = ast_event_dup(cached_event_ref->event);
1255                 ao2_ref(cached_event_ref, -1);
1256                 cached_event_ref = NULL;
1257         }
1258
1259         return dup_event;
1260 }
1261
1262 static struct ast_event_ref *alloc_event_ref(void)
1263 {
1264         return ao2_alloc(sizeof(struct ast_event_ref), ast_event_ref_destroy);
1265 }
1266
1267 /*! \brief Duplicate an event and add it to the cache
1268  * \note This assumes this index in to the cache is locked */
1269 static int attribute_unused ast_event_dup_and_cache(const struct ast_event *event)
1270 {
1271         struct ast_event *dup_event;
1272         struct ast_event_ref *event_ref;
1273
1274         if (!(dup_event = ast_event_dup(event))) {
1275                 return -1;
1276         }
1277
1278         if (!(event_ref = alloc_event_ref())) {
1279                 ast_event_destroy(dup_event);
1280                 return -1;
1281         }
1282
1283         event_ref->event = dup_event;
1284
1285         ao2_link(ast_event_cache[ast_event_get_type(event)].container, event_ref);
1286
1287         ao2_ref(event_ref, -1);
1288
1289         return 0;
1290 }
1291
1292 int ast_event_queue_and_cache(struct ast_event *event)
1293 {
1294         struct ao2_container *container;
1295         struct ast_event_ref tmp_event_ref = {
1296                 .event = event,
1297         };
1298
1299         if (!(container = ast_event_cache[ast_event_get_type(event)].container)) {
1300                 ast_log(LOG_WARNING, "cache requested for non-cached event type\n");
1301                 goto queue_event;
1302         }
1303
1304         /* Remove matches from the cache */
1305         ao2_callback(container, OBJ_POINTER | OBJ_UNLINK | OBJ_MULTIPLE | OBJ_NODATA,
1306                         ast_event_cmp, &tmp_event_ref);
1307
1308 queue_event:
1309         return ast_event_queue(event);
1310 }
1311
1312 static int handle_event(void *data)
1313 {
1314         struct ast_event_ref *event_ref = data;
1315         struct ast_event_sub *sub;
1316         uint16_t host_event_type;
1317
1318         host_event_type = ntohs(event_ref->event->type);
1319
1320         /* Subscribers to this specific event first */
1321         AST_RWDLLIST_RDLOCK(&ast_event_subs[host_event_type]);
1322         AST_RWDLLIST_TRAVERSE(&ast_event_subs[host_event_type], sub, entry) {
1323                 struct ast_event_ie_val *ie_val;
1324                 AST_LIST_TRAVERSE(&sub->ie_vals, ie_val, entry) {
1325                         if (!match_ie_val(event_ref->event, ie_val, NULL)) {
1326                                 break;
1327                         }
1328                 }
1329                 if (ie_val) {
1330                         continue;
1331                 }
1332                 sub->cb(event_ref->event, sub->userdata);
1333         }
1334         AST_RWDLLIST_UNLOCK(&ast_event_subs[host_event_type]);
1335
1336         /* Now to subscribers to all event types */
1337         AST_RWDLLIST_RDLOCK(&ast_event_subs[AST_EVENT_ALL]);
1338         AST_RWDLLIST_TRAVERSE(&ast_event_subs[AST_EVENT_ALL], sub, entry) {
1339                 sub->cb(event_ref->event, sub->userdata);
1340         }
1341         AST_RWDLLIST_UNLOCK(&ast_event_subs[AST_EVENT_ALL]);
1342
1343         ao2_ref(event_ref, -1);
1344
1345         return 0;
1346 }
1347
1348 int ast_event_queue(struct ast_event *event)
1349 {
1350         struct ast_event_ref *event_ref;
1351         uint16_t host_event_type;
1352
1353         host_event_type = ntohs(event->type);
1354
1355         /* Invalid type */
1356         if (host_event_type >= AST_EVENT_TOTAL) {
1357                 ast_log(LOG_WARNING, "Someone tried to queue an event of invalid "
1358                         "type '%d'!\n", host_event_type);
1359                 return -1;
1360         }
1361
1362         /* If nobody has subscribed to this event type, throw it away now */
1363         if (ast_event_check_subscriber(host_event_type, AST_EVENT_IE_END)
1364                         == AST_EVENT_SUB_NONE) {
1365                 ast_event_destroy(event);
1366                 ast_log(LOG_NOTICE, "Event destroyed, no subscriber\n");
1367                 return 0;
1368         }
1369
1370         if (!(event_ref = alloc_event_ref())) {
1371                 return -1;
1372         }
1373
1374         event_ref->event = event;
1375
1376         return ast_taskprocessor_push(event_dispatcher, handle_event, event_ref);
1377 }
1378
1379 static int ast_event_hash_mwi(const void *obj, const int flags)
1380 {
1381         const struct ast_event *event = obj;
1382         const char *mailbox = ast_event_get_ie_str(event, AST_EVENT_IE_MAILBOX);
1383         const char *context = ast_event_get_ie_str(event, AST_EVENT_IE_CONTEXT);
1384
1385         return ast_str_hash_add(context, ast_str_hash(mailbox));
1386 }
1387
1388 /*!
1389  * \internal
1390  * \brief Hash function for AST_EVENT_DEVICE_STATE
1391  *
1392  * \param[in] obj an ast_event
1393  * \param[in] flags unused
1394  *
1395  * \return hash value
1396  */
1397 static int ast_event_hash_devstate(const void *obj, const int flags)
1398 {
1399         const struct ast_event *event = obj;
1400
1401         return ast_str_hash(ast_event_get_ie_str(event, AST_EVENT_IE_DEVICE));
1402 }
1403
1404 /*!
1405  * \internal
1406  * \brief Hash function for AST_EVENT_DEVICE_STATE_CHANGE
1407  *
1408  * \param[in] obj an ast_event
1409  * \param[in] flags unused
1410  *
1411  * \return hash value
1412  */
1413 static int ast_event_hash_devstate_change(const void *obj, const int flags)
1414 {
1415         const struct ast_event *event = obj;
1416
1417         return ast_str_hash(ast_event_get_ie_str(event, AST_EVENT_IE_DEVICE));
1418 }
1419
1420 static int ast_event_hash(const void *obj, const int flags)
1421 {
1422         const struct ast_event_ref *event_ref;
1423         const struct ast_event *event;
1424         ao2_hash_fn *hash_fn;
1425
1426         event_ref = obj;
1427         event = event_ref->event;
1428
1429         if (!(hash_fn = ast_event_cache[ast_event_get_type(event)].hash_fn)) {
1430                 return 0;
1431         }
1432
1433         return hash_fn(event, flags);
1434 }
1435
1436 /*!
1437  * \internal
1438  * \brief Compare two events
1439  *
1440  * \param[in] obj the first event, as an ast_event_ref
1441  * \param[in] arg the second event, as an ast_event_ref
1442  * \param[in] flags unused
1443  *
1444  * \pre Both events must be the same type.
1445  * \pre The event type must be declared as a cached event type in ast_event_cache
1446  *
1447  * \details This function takes two events, and determines if they are considered
1448  * equivalent.  The values of information elements specified in the cache arguments
1449  * for the event type are used to determine if the events are equivalent.
1450  *
1451  * \retval 0 No match
1452  * \retval CMP_MATCH The events are considered equivalent based on the cache arguments
1453  */
1454 static int ast_event_cmp(void *obj, void *arg, int flags)
1455 {
1456         struct ast_event_ref *event_ref, *event_ref2;
1457         struct ast_event *event, *event2;
1458         int res = CMP_MATCH;
1459         int i;
1460         enum ast_event_ie_type *cache_args;
1461
1462         event_ref = obj;
1463         event = event_ref->event;
1464
1465         event_ref2 = arg;
1466         event2 = event_ref2->event;
1467
1468         cache_args = ast_event_cache[ast_event_get_type(event)].cache_args;
1469
1470         for (i = 0; i < ARRAY_LEN(ast_event_cache[0].cache_args) && cache_args[i]; i++) {
1471                 struct ast_event_ie_val ie_val = {
1472                         .ie_type = cache_args[i],
1473                 };
1474
1475                 if (!match_ie_val(event, &ie_val, event2)) {
1476                         res = 0;
1477                         break;
1478                 }
1479         }
1480
1481         return res;
1482 }
1483
1484 int ast_event_init(void)
1485 {
1486         int i;
1487
1488         for (i = 0; i < AST_EVENT_TOTAL; i++) {
1489                 AST_RWDLLIST_HEAD_INIT(&ast_event_subs[i]);
1490         }
1491
1492         for (i = 0; i < AST_EVENT_TOTAL; i++) {
1493                 if (!ast_event_cache[i].hash_fn) {
1494                         /* This event type is not cached. */
1495                         continue;
1496                 }
1497
1498                 if (!(ast_event_cache[i].container = ao2_container_alloc(NUM_CACHE_BUCKETS,
1499                                 ast_event_hash, ast_event_cmp))) {
1500                         return -1;
1501                 }
1502         }
1503
1504         if (!(event_dispatcher = ast_taskprocessor_get("core_event_dispatcher", 0))) {
1505                 return -1;
1506         }
1507
1508         return 0;
1509 }