Putting all event defs and names back for now due to res_corosync dependency
[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 /*** MODULEINFO
27         <support_level>core</support_level>
28  ***/
29
30 #include "asterisk.h"
31
32 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
33
34 #include "asterisk/_private.h"
35
36 #include "asterisk/event.h"
37 #include "asterisk/linkedlists.h"
38 #include "asterisk/dlinkedlists.h"
39 #include "asterisk/lock.h"
40 #include "asterisk/utils.h"
41 #include "asterisk/unaligned.h"
42 #include "asterisk/utils.h"
43 #include "asterisk/taskprocessor.h"
44 #include "asterisk/astobj2.h"
45 #include "asterisk/cli.h"
46
47 static struct ast_taskprocessor *event_dispatcher;
48
49 /*!
50  * \brief An event information element
51  *
52  * \note The format of this structure is important.  Since these events may
53  *       be sent directly over a network, changing this structure will break
54  *       compatibility with older versions.  However, at this point, this code
55  *       has not made it into a release, so it is still fair game for change.
56  */
57 struct ast_event_ie {
58         enum ast_event_ie_type ie_type:16;
59         /*! Total length of the IE payload */
60         uint16_t ie_payload_len;
61         unsigned char ie_payload[0];
62 } __attribute__((packed));
63
64 /*!
65  * \brief The payload for a string information element
66  */
67 struct ast_event_ie_str_payload {
68         /*! \brief A hash calculated with ast_str_hash(), to speed up comparisons */
69         uint32_t hash;
70         /*! \brief The actual string, null terminated */
71         char str[1];
72 } __attribute__((packed));
73
74 /*!
75  * \brief An event
76  *
77  * An ast_event consists of an event header (this structure), and zero or
78  * more information elements defined by ast_event_ie.
79  *
80  * \note The format of this structure is important.  Since these events may
81  *       be sent directly over a network, changing this structure will break
82  *       compatibility with older versions.  However, at this point, this code
83  *       has not made it into a release, so it is still fair game for change.
84  */
85 struct ast_event {
86         /*! Event type */
87         enum ast_event_type type:16;
88         /*! Total length of the event */
89         uint16_t event_len:16;
90         /*! The data payload of the event, made up of information elements */
91         unsigned char payload[0];
92 } __attribute__((packed));
93
94
95 /*!
96  * \brief A holder for an event
97  *
98  * \details This struct used to have more of a purpose than it does now.
99  * It is used to hold events in the event cache.  It can be completely removed
100  * if one of these two things is done:
101  *  - ast_event gets changed such that it never has to be realloc()d
102  *  - astobj2 is updated so that you can realloc() an astobj2 object
103  */
104 struct ast_event_ref {
105         struct ast_event *event;
106         unsigned int cache;
107 };
108
109 struct ast_event_ie_val {
110         AST_LIST_ENTRY(ast_event_ie_val) entry;
111         enum ast_event_ie_type ie_type;
112         enum ast_event_ie_pltype ie_pltype;
113         union {
114                 uint32_t uint;
115                 struct {
116                         uint32_t hash;
117                         const char *str;
118                 };
119                 void *raw;
120         } payload;
121         size_t raw_datalen;
122 };
123
124 /*! \brief Event subscription */
125 struct ast_event_sub {
126         enum ast_event_type type;
127         ast_event_cb_t cb;
128         char description[64];
129         void *userdata;
130         uint32_t uniqueid;
131         AST_LIST_HEAD_NOLOCK(, ast_event_ie_val) ie_vals;
132         AST_RWDLLIST_ENTRY(ast_event_sub) entry;
133 };
134
135 static uint32_t sub_uniqueid;
136
137 /*! \brief Event subscriptions
138  * The event subscribers are indexed by which event they are subscribed to */
139 static AST_RWDLLIST_HEAD(ast_event_sub_list, ast_event_sub) ast_event_subs[AST_EVENT_TOTAL];
140
141 static int ast_event_cmp(void *obj, void *arg, int flags);
142 static int ast_event_hash_mwi(const void *obj, const int flags);
143 static int ast_event_hash_devstate(const void *obj, const int flags);
144 static int ast_event_hash_devstate_change(const void *obj, const int flags);
145 static int ast_event_hash_presence_state_change(const void *obj, const int flags);
146
147 #ifdef LOW_MEMORY
148 #define NUM_CACHE_BUCKETS 17
149 #else
150 #define NUM_CACHE_BUCKETS 563
151 #endif
152
153 #define MAX_CACHE_ARGS 8
154
155 struct cache_events {
156         /*!
157          * \brief Container of cached events
158          *
159          * \details This gets allocated in ast_event_init() when Asterisk starts
160          * for the event types declared as using the cache.
161          */
162         struct ao2_container *container;
163         /*! \brief Event type specific hash function */
164         ao2_hash_fn *hash_fn;
165         /*!
166          * \brief Information Elements used for caching
167          *
168          * \details This array is the set of information elements that will be unique
169          * among all events in the cache for this event type.  When a new event gets
170          * cached, a previous event with the same values for these information elements
171          * will be replaced.
172          */
173         enum ast_event_ie_type cache_args[MAX_CACHE_ARGS];
174 };
175
176 /*!
177  * \brief Event types that are kept in the cache.
178  */
179 static struct cache_events ast_event_cache[AST_EVENT_TOTAL] = {
180         [AST_EVENT_MWI] = {
181                 .hash_fn = ast_event_hash_mwi,
182                 .cache_args = { AST_EVENT_IE_MAILBOX, AST_EVENT_IE_CONTEXT },
183         },
184         [AST_EVENT_DEVICE_STATE] = {
185                 .hash_fn = ast_event_hash_devstate,
186                 .cache_args = { AST_EVENT_IE_DEVICE, },
187         },
188         [AST_EVENT_DEVICE_STATE_CHANGE] = {
189                 .hash_fn = ast_event_hash_devstate_change,
190                 .cache_args = { AST_EVENT_IE_DEVICE, AST_EVENT_IE_EID, },
191         },
192         [AST_EVENT_PRESENCE_STATE] = {
193                 .hash_fn = ast_event_hash_presence_state_change,
194                 .cache_args = { AST_EVENT_IE_PRESENCE_STATE, },
195         },
196 };
197
198 /*!
199  * \brief Names of cached event types, for CLI tab completion
200  *
201  * \note These names must match what is in the event_names array.
202  */
203 static const char * const cached_event_types[] = { "MWI", "DeviceState", "DeviceStateChange", NULL };
204
205 /*!
206  * \brief Event Names
207  */
208 static const char * const event_names[AST_EVENT_TOTAL] = {
209         [AST_EVENT_ALL]                 = "All",
210         [AST_EVENT_CUSTOM]              = "Custom",
211         [AST_EVENT_MWI]                 = "MWI",
212         [AST_EVENT_SUB]                 = "Subscription",
213         [AST_EVENT_UNSUB]               = "Unsubscription",
214         [AST_EVENT_DEVICE_STATE]        = "DeviceState",
215         [AST_EVENT_DEVICE_STATE_CHANGE] = "DeviceStateChange",
216         [AST_EVENT_CEL]                 = "CEL",
217         [AST_EVENT_SECURITY]            = "Security",
218         [AST_EVENT_NETWORK_CHANGE]      = "NetworkChange",
219         [AST_EVENT_PRESENCE_STATE]      = "PresenceState",
220         [AST_EVENT_ACL_CHANGE]          = "ACLChange",
221         [AST_EVENT_PING]                = "Ping",
222 };
223
224 struct ie_map {
225         enum ast_event_ie_pltype ie_pltype;
226         const char *name;
227 };
228
229 /*!
230  * \brief IE payload types and names
231  */
232 static const struct ie_map ie_maps[AST_EVENT_IE_TOTAL] = {
233         [AST_EVENT_IE_NEWMSGS]             = { AST_EVENT_IE_PLTYPE_UINT, "NewMessages" },
234         [AST_EVENT_IE_OLDMSGS]             = { AST_EVENT_IE_PLTYPE_UINT, "OldMessages" },
235         [AST_EVENT_IE_MAILBOX]             = { AST_EVENT_IE_PLTYPE_STR,  "Mailbox" },
236         [AST_EVENT_IE_UNIQUEID]            = { AST_EVENT_IE_PLTYPE_UINT, "UniqueID" },
237         [AST_EVENT_IE_EVENTTYPE]           = { AST_EVENT_IE_PLTYPE_UINT, "EventType" },
238         [AST_EVENT_IE_EXISTS]              = { AST_EVENT_IE_PLTYPE_UINT, "Exists" },
239         [AST_EVENT_IE_DEVICE]              = { AST_EVENT_IE_PLTYPE_STR,  "Device" },
240         [AST_EVENT_IE_STATE]               = { AST_EVENT_IE_PLTYPE_UINT, "State" },
241         [AST_EVENT_IE_CONTEXT]             = { AST_EVENT_IE_PLTYPE_STR,  "Context" },
242         [AST_EVENT_IE_EID]                 = { AST_EVENT_IE_PLTYPE_RAW,  "EntityID" },
243         [AST_EVENT_IE_CEL_EVENT_TYPE]      = { AST_EVENT_IE_PLTYPE_UINT, "CELEventType" },
244         [AST_EVENT_IE_CEL_EVENT_TIME]      = { AST_EVENT_IE_PLTYPE_UINT, "CELEventTime" },
245         [AST_EVENT_IE_CEL_EVENT_TIME_USEC] = { AST_EVENT_IE_PLTYPE_UINT, "CELEventTimeUSec" },
246         [AST_EVENT_IE_CEL_USEREVENT_NAME]  = { AST_EVENT_IE_PLTYPE_UINT, "CELUserEventName" },
247         [AST_EVENT_IE_CEL_CIDNAME]         = { AST_EVENT_IE_PLTYPE_STR,  "CELCIDName" },
248         [AST_EVENT_IE_CEL_CIDNUM]          = { AST_EVENT_IE_PLTYPE_STR,  "CELCIDNum" },
249         [AST_EVENT_IE_CEL_EXTEN]           = { AST_EVENT_IE_PLTYPE_STR,  "CELExten" },
250         [AST_EVENT_IE_CEL_CONTEXT]         = { AST_EVENT_IE_PLTYPE_STR,  "CELContext" },
251         [AST_EVENT_IE_CEL_CHANNAME]        = { AST_EVENT_IE_PLTYPE_STR,  "CELChanName" },
252         [AST_EVENT_IE_CEL_APPNAME]         = { AST_EVENT_IE_PLTYPE_STR,  "CELAppName" },
253         [AST_EVENT_IE_CEL_APPDATA]         = { AST_EVENT_IE_PLTYPE_STR,  "CELAppData" },
254         [AST_EVENT_IE_CEL_AMAFLAGS]        = { AST_EVENT_IE_PLTYPE_STR,  "CELAMAFlags" },
255         [AST_EVENT_IE_CEL_ACCTCODE]        = { AST_EVENT_IE_PLTYPE_UINT, "CELAcctCode" },
256         [AST_EVENT_IE_CEL_UNIQUEID]        = { AST_EVENT_IE_PLTYPE_STR,  "CELUniqueID" },
257         [AST_EVENT_IE_CEL_USERFIELD]       = { AST_EVENT_IE_PLTYPE_STR,  "CELUserField" },
258         [AST_EVENT_IE_CEL_CIDANI]          = { AST_EVENT_IE_PLTYPE_STR,  "CELCIDani" },
259         [AST_EVENT_IE_CEL_CIDRDNIS]        = { AST_EVENT_IE_PLTYPE_STR,  "CELCIDrdnis" },
260         [AST_EVENT_IE_CEL_CIDDNID]         = { AST_EVENT_IE_PLTYPE_STR,  "CELCIDdnid" },
261         [AST_EVENT_IE_CEL_PEER]            = { AST_EVENT_IE_PLTYPE_STR,  "CELPeer" },
262         [AST_EVENT_IE_CEL_LINKEDID]        = { AST_EVENT_IE_PLTYPE_STR,  "CELLinkedID" },
263         [AST_EVENT_IE_CEL_PEERACCT]        = { AST_EVENT_IE_PLTYPE_STR,  "CELPeerAcct" },
264         [AST_EVENT_IE_CEL_EXTRA]           = { AST_EVENT_IE_PLTYPE_STR,  "CELExtra" },
265         [AST_EVENT_IE_SECURITY_EVENT]      = { AST_EVENT_IE_PLTYPE_STR,  "SecurityEvent" },
266         [AST_EVENT_IE_EVENT_VERSION]       = { AST_EVENT_IE_PLTYPE_UINT, "EventVersion" },
267         [AST_EVENT_IE_SERVICE]             = { AST_EVENT_IE_PLTYPE_STR,  "Service" },
268         [AST_EVENT_IE_MODULE]              = { AST_EVENT_IE_PLTYPE_STR,  "Module" },
269         [AST_EVENT_IE_ACCOUNT_ID]          = { AST_EVENT_IE_PLTYPE_STR,  "AccountID" },
270         [AST_EVENT_IE_SESSION_ID]          = { AST_EVENT_IE_PLTYPE_STR,  "SessionID" },
271         [AST_EVENT_IE_SESSION_TV]          = { AST_EVENT_IE_PLTYPE_STR,  "SessionTV" },
272         [AST_EVENT_IE_ACL_NAME]            = { AST_EVENT_IE_PLTYPE_STR,  "ACLName" },
273         [AST_EVENT_IE_LOCAL_ADDR]          = { AST_EVENT_IE_PLTYPE_STR,  "LocalAddress" },
274         [AST_EVENT_IE_REMOTE_ADDR]         = { AST_EVENT_IE_PLTYPE_STR,  "RemoteAddress" },
275         [AST_EVENT_IE_EVENT_TV]            = { AST_EVENT_IE_PLTYPE_STR,  "EventTV" },
276         [AST_EVENT_IE_REQUEST_TYPE]        = { AST_EVENT_IE_PLTYPE_STR,  "RequestType" },
277         [AST_EVENT_IE_REQUEST_PARAMS]      = { AST_EVENT_IE_PLTYPE_STR,  "RequestParams" },
278         [AST_EVENT_IE_AUTH_METHOD]         = { AST_EVENT_IE_PLTYPE_STR,  "AuthMethod" },
279         [AST_EVENT_IE_SEVERITY]            = { AST_EVENT_IE_PLTYPE_STR,  "Severity" },
280         [AST_EVENT_IE_EXPECTED_ADDR]       = { AST_EVENT_IE_PLTYPE_STR,  "ExpectedAddress" },
281         [AST_EVENT_IE_CHALLENGE]           = { AST_EVENT_IE_PLTYPE_STR,  "Challenge" },
282         [AST_EVENT_IE_RESPONSE]            = { AST_EVENT_IE_PLTYPE_STR,  "Response" },
283         [AST_EVENT_IE_EXPECTED_RESPONSE]   = { AST_EVENT_IE_PLTYPE_STR,  "ExpectedResponse" },
284         [AST_EVENT_IE_RECEIVED_CHALLENGE]  = { AST_EVENT_IE_PLTYPE_STR,  "ReceivedChallenge" },
285         [AST_EVENT_IE_RECEIVED_HASH]       = { AST_EVENT_IE_PLTYPE_STR,  "ReceivedHash" },
286         [AST_EVENT_IE_USING_PASSWORD]      = { AST_EVENT_IE_PLTYPE_UINT, "UsingPassword" },
287         [AST_EVENT_IE_ATTEMPTED_TRANSPORT] = { AST_EVENT_IE_PLTYPE_STR,  "AttemptedTransport" },
288         [AST_EVENT_IE_CACHABLE]            = { AST_EVENT_IE_PLTYPE_UINT, "Cachable" },
289         [AST_EVENT_IE_PRESENCE_PROVIDER]   = { AST_EVENT_IE_PLTYPE_STR,  "PresenceProvider" },
290         [AST_EVENT_IE_PRESENCE_STATE]      = { AST_EVENT_IE_PLTYPE_UINT, "PresenceState" },
291         [AST_EVENT_IE_PRESENCE_SUBTYPE]    = { AST_EVENT_IE_PLTYPE_STR,  "PresenceSubtype" },
292         [AST_EVENT_IE_PRESENCE_MESSAGE]    = { AST_EVENT_IE_PLTYPE_STR,  "PresenceMessage" },
293 };
294
295 const char *ast_event_get_type_name(const struct ast_event *event)
296 {
297         enum ast_event_type type;
298
299         type = ast_event_get_type(event);
300
301         if (type < 0 || type >= ARRAY_LEN(event_names)) {
302                 ast_log(LOG_ERROR, "Invalid event type - '%d'\n", type);
303                 return "";
304         }
305
306         return event_names[type];
307 }
308
309 int ast_event_str_to_event_type(const char *str, enum ast_event_type *event_type)
310 {
311         int i;
312
313         for (i = 0; i < ARRAY_LEN(event_names); i++) {
314                 if (ast_strlen_zero(event_names[i]) || strcasecmp(event_names[i], str)) {
315                         continue;
316                 }
317
318                 *event_type = i;
319                 return 0;
320         }
321
322         return -1;
323 }
324
325 const char *ast_event_get_ie_type_name(enum ast_event_ie_type ie_type)
326 {
327         if (ie_type <= 0 || ie_type >= ARRAY_LEN(ie_maps)) {
328                 ast_log(LOG_ERROR, "Invalid IE type - '%d'\n", ie_type);
329                 return "";
330         }
331
332         return ie_maps[ie_type].name;
333 }
334
335 enum ast_event_ie_pltype ast_event_get_ie_pltype(enum ast_event_ie_type ie_type)
336 {
337         if (ie_type <= 0 || ie_type >= ARRAY_LEN(ie_maps)) {
338                 ast_log(LOG_ERROR, "Invalid IE type - '%d'\n", ie_type);
339                 return AST_EVENT_IE_PLTYPE_UNKNOWN;
340         }
341
342         return ie_maps[ie_type].ie_pltype;
343 }
344
345 int ast_event_str_to_ie_type(const char *str, enum ast_event_ie_type *ie_type)
346 {
347         int i;
348
349         for (i = 0; i < ARRAY_LEN(ie_maps); i++) {
350                 if (strcasecmp(ie_maps[i].name, str)) {
351                         continue;
352                 }
353
354                 *ie_type = i;
355                 return 0;
356         }
357
358         return -1;
359 }
360
361 size_t ast_event_get_size(const struct ast_event *event)
362 {
363         size_t res;
364
365         res = ntohs(event->event_len);
366
367         return res;
368 }
369
370 static void ast_event_ie_val_destroy(struct ast_event_ie_val *ie_val)
371 {
372         switch (ie_val->ie_pltype) {
373         case AST_EVENT_IE_PLTYPE_STR:
374                 ast_free((char *) ie_val->payload.str);
375                 break;
376         case AST_EVENT_IE_PLTYPE_RAW:
377                 ast_free(ie_val->payload.raw);
378                 break;
379         case AST_EVENT_IE_PLTYPE_UINT:
380         case AST_EVENT_IE_PLTYPE_BITFLAGS:
381         case AST_EVENT_IE_PLTYPE_EXISTS:
382         case AST_EVENT_IE_PLTYPE_UNKNOWN:
383                 break;
384         }
385
386         ast_free(ie_val);
387 }
388
389 /*! \brief Subscription event check list. */
390 struct ast_ev_check_list {
391         AST_LIST_HEAD_NOLOCK(, ast_event_ie_val) ie_vals;
392 };
393
394 /*!
395  * \internal
396  * \brief Check if a subscription ie_val matches an event.
397  *
398  * \param sub_ie_val Subscripton IE value to check
399  * \param check_ie_vals event list to check against
400  *
401  * \retval 0 not matched
402  * \retval non-zero matched
403  */
404 static int match_sub_ie_val_to_event(const struct ast_event_ie_val *sub_ie_val, const struct ast_ev_check_list *check_ie_vals)
405 {
406         const struct ast_event_ie_val *event_ie_val;
407         int res = 0;
408
409         AST_LIST_TRAVERSE(&check_ie_vals->ie_vals, event_ie_val, entry) {
410                 if (sub_ie_val->ie_type == event_ie_val->ie_type) {
411                         break;
412                 }
413         }
414         if (!event_ie_val) {
415                 /* We did not find the event ie the subscriber cares about. */
416                 return 0;
417         }
418
419         if (sub_ie_val->ie_pltype != event_ie_val->ie_pltype) {
420                 if (sub_ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_EXISTS) {
421                         /* The subscription only cares that this ie exists. */
422                         return 1;
423                 }
424                 /* Payload types do not match. */
425                 return 0;
426         }
427
428         switch (sub_ie_val->ie_pltype) {
429         case AST_EVENT_IE_PLTYPE_UINT:
430                 res = (sub_ie_val->payload.uint == event_ie_val->payload.uint);
431                 break;
432         case AST_EVENT_IE_PLTYPE_BITFLAGS:
433                 /*
434                  * If the subscriber has requested *any* of the bitflags we are providing,
435                  * then it's a match.
436                  */
437                 res = (sub_ie_val->payload.uint & event_ie_val->payload.uint);
438                 break;
439         case AST_EVENT_IE_PLTYPE_STR:
440         {
441                 const char *substr = sub_ie_val->payload.str;
442                 const char *estr = event_ie_val->payload.str;
443                 if (sub_ie_val->ie_type == AST_EVENT_IE_DEVICE) {
444                         substr = ast_tech_to_upper(ast_strdupa(substr));
445                         estr = ast_tech_to_upper(ast_strdupa(estr));
446                 }
447                 res = !strcmp(substr, estr);
448                 break;
449         }
450         case AST_EVENT_IE_PLTYPE_RAW:
451                 res = (sub_ie_val->raw_datalen == event_ie_val->raw_datalen
452                         && !memcmp(sub_ie_val->payload.raw, event_ie_val->payload.raw,
453                                 sub_ie_val->raw_datalen));
454                 break;
455         case AST_EVENT_IE_PLTYPE_EXISTS:
456                 /* Should never get here since check_ie_vals cannot have this type. */
457                 break;
458         case AST_EVENT_IE_PLTYPE_UNKNOWN:
459                 /*
460                  * Should never be in a subscription event ie val list and
461                  * check_ie_vals cannot have this type either.
462                  */
463                 break;
464         }
465
466         return res;
467 }
468
469 enum ast_event_subscriber_res ast_event_check_subscriber(enum ast_event_type type, ...)
470 {
471         va_list ap;
472         enum ast_event_ie_type ie_type;
473         enum ast_event_subscriber_res res = AST_EVENT_SUB_NONE;
474         struct ast_event_ie_val *ie_val;
475         struct ast_event_sub *sub;
476         struct ast_ev_check_list check_ie_vals = {
477                 .ie_vals = AST_LIST_HEAD_NOLOCK_INIT_VALUE
478         };
479         const enum ast_event_type event_types[] = { type, AST_EVENT_ALL };
480         int i;
481         int want_specific_event;/* TRUE if looking for subscribers wanting specific parameters. */
482
483         if (type >= AST_EVENT_TOTAL) {
484                 ast_log(LOG_ERROR, "%u is an invalid type!\n", type);
485                 return res;
486         }
487
488         want_specific_event = 0;
489         va_start(ap, type);
490         for (ie_type = va_arg(ap, enum ast_event_ie_type);
491                 ie_type != AST_EVENT_IE_END;
492                 ie_type = va_arg(ap, enum ast_event_ie_type))
493         {
494                 struct ast_event_ie_val *ie_value = ast_alloca(sizeof(*ie_value));
495                 int insert = 0;
496
497                 memset(ie_value, 0, sizeof(*ie_value));
498                 ie_value->ie_type = ie_type;
499                 ie_value->ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
500                 switch (ie_value->ie_pltype) {
501                 case AST_EVENT_IE_PLTYPE_UINT:
502                         ie_value->payload.uint = va_arg(ap, uint32_t);
503                         insert = 1;
504                         break;
505                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
506                         ie_value->payload.uint = va_arg(ap, uint32_t);
507                         insert = 1;
508                         break;
509                 case AST_EVENT_IE_PLTYPE_STR:
510                         ie_value->payload.str = va_arg(ap, const char *);
511                         insert = 1;
512                         break;
513                 case AST_EVENT_IE_PLTYPE_RAW:
514                 {
515                         void *data = va_arg(ap, void *);
516                         size_t datalen = va_arg(ap, size_t);
517
518                         ie_value->payload.raw = ast_alloca(datalen);
519                         memcpy(ie_value->payload.raw, data, datalen);
520                         ie_value->raw_datalen = datalen;
521                         insert = 1;
522                         break;
523                 }
524                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
525                 case AST_EVENT_IE_PLTYPE_EXISTS:
526                         /* Unsupported payload type. */
527                         break;
528                 }
529
530                 if (insert) {
531                         want_specific_event = 1;
532                         AST_LIST_INSERT_TAIL(&check_ie_vals.ie_vals, ie_value, entry);
533                 } else {
534                         ast_log(LOG_WARNING, "Unsupported PLTYPE(%d)\n", ie_value->ie_pltype);
535                 }
536         }
537         va_end(ap);
538
539         for (i = 0; i < ARRAY_LEN(event_types); i++) {
540                 AST_RWDLLIST_RDLOCK(&ast_event_subs[event_types[i]]);
541                 if (want_specific_event) {
542                         AST_RWDLLIST_TRAVERSE(&ast_event_subs[event_types[i]], sub, entry) {
543                                 AST_LIST_TRAVERSE(&sub->ie_vals, ie_val, entry) {
544                                         if (!match_sub_ie_val_to_event(ie_val, &check_ie_vals)) {
545                                                 /* The current subscription ie did not match an event ie. */
546                                                 break;
547                                         }
548                                 }
549                                 if (!ie_val) {
550                                         /* Everything matched.  A subscriber is looking for this event. */
551                                         break;
552                                 }
553                         }
554                 } else {
555                         /* Just looking to see if there are ANY subscribers to the event type. */
556                         sub = AST_RWLIST_FIRST(&ast_event_subs[event_types[i]]);
557                 }
558                 AST_RWDLLIST_UNLOCK(&ast_event_subs[event_types[i]]);
559                 if (sub) {
560                         break;
561                 }
562         }
563
564         return sub ? AST_EVENT_SUB_EXISTS : AST_EVENT_SUB_NONE;
565 }
566
567 /*!
568  * \internal
569  * \brief Check if an ie_val matches an event
570  *
571  * \param event event to check against
572  * \param ie_val IE value to check
573  * \param event2 optional event, if specified, the value to compare against will be pulled
574  *        from this event instead of from the ie_val structure.  In this case, only the IE
575  *        type and payload type will be pulled from ie_val.
576  *
577  * \retval 0 not matched
578  * \retval non-zero matched
579  */
580 static int match_ie_val(const struct ast_event *event,
581                 const struct ast_event_ie_val *ie_val, const struct ast_event *event2)
582 {
583         switch (ie_val->ie_pltype) {
584         case AST_EVENT_IE_PLTYPE_UINT:
585         {
586                 uint32_t val = event2 ? ast_event_get_ie_uint(event2, ie_val->ie_type) : ie_val->payload.uint;
587
588                 return (val == ast_event_get_ie_uint(event, ie_val->ie_type)) ? 1 : 0;
589         }
590
591         case AST_EVENT_IE_PLTYPE_BITFLAGS:
592         {
593                 uint32_t flags = event2 ? ast_event_get_ie_uint(event2, ie_val->ie_type) : ie_val->payload.uint;
594
595                 /*
596                  * If the subscriber has requested *any* of the bitflags that this event provides,
597                  * then it's a match.
598                  */
599                 return (flags & ast_event_get_ie_bitflags(event, ie_val->ie_type)) ? 1 : 0;
600         }
601
602         case AST_EVENT_IE_PLTYPE_STR:
603         {
604                 const char *str;
605                 uint32_t hash;
606
607                 hash = event2 ? ast_event_get_ie_str_hash(event2, ie_val->ie_type) : ie_val->payload.hash;
608                 if (hash != ast_event_get_ie_str_hash(event, ie_val->ie_type)) {
609                         return 0;
610                 }
611
612                 str = event2 ? ast_event_get_ie_str(event2, ie_val->ie_type) : ie_val->payload.str;
613                 if (str) {
614                         const char *e1str, *e2str;
615                         e1str = ast_event_get_ie_str(event, ie_val->ie_type);
616                         e2str = str;
617
618                         if (ie_val->ie_type == AST_EVENT_IE_DEVICE) {
619                                 e1str = ast_tech_to_upper(ast_strdupa(e1str));
620                                 e2str = ast_tech_to_upper(ast_strdupa(e2str));
621                         }
622
623                         if (!strcmp(e1str, e2str)) {
624                                 return 1;
625                         }
626                 }
627
628                 return 0;
629         }
630
631         case AST_EVENT_IE_PLTYPE_RAW:
632         {
633                 const void *buf = event2 ? ast_event_get_ie_raw(event2, ie_val->ie_type) : ie_val->payload.raw;
634                 uint16_t ie_payload_len = event2 ? ast_event_get_ie_raw_payload_len(event2, ie_val->ie_type) : ie_val->raw_datalen;
635
636                 return (buf
637                         && ie_payload_len == ast_event_get_ie_raw_payload_len(event, ie_val->ie_type)
638                         && !memcmp(buf, ast_event_get_ie_raw(event, ie_val->ie_type), ie_payload_len)) ? 1 : 0;
639         }
640
641         case AST_EVENT_IE_PLTYPE_EXISTS:
642         {
643                 return ast_event_get_ie_raw(event, ie_val->ie_type) ? 1 : 0;
644         }
645
646         case AST_EVENT_IE_PLTYPE_UNKNOWN:
647                 return 0;
648         }
649
650         return 0;
651 }
652
653 static int dump_cache_cb(void *obj, void *arg, int flags)
654 {
655         const struct ast_event_ref *event_ref = obj;
656         const struct ast_event *event = event_ref->event;
657         const struct ast_event_sub *event_sub = arg;
658         struct ast_event_ie_val *ie_val = NULL;
659
660         AST_LIST_TRAVERSE(&event_sub->ie_vals, ie_val, entry) {
661                 if (!match_ie_val(event, ie_val, NULL)) {
662                         break;
663                 }
664         }
665
666         if (!ie_val) {
667                 /* All parameters were matched on this cache entry, so dump it */
668                 event_sub->cb(event, event_sub->userdata);
669         }
670
671         return 0;
672 }
673
674 /*! \brief Dump the event cache for the subscribed event type */
675 void ast_event_dump_cache(const struct ast_event_sub *event_sub)
676 {
677         if (!ast_event_cache[event_sub->type].container) {
678                 return;
679         }
680
681         ao2_callback(ast_event_cache[event_sub->type].container, OBJ_NODATA,
682                         dump_cache_cb, (void *) event_sub);
683 }
684
685 static struct ast_event *gen_sub_event(struct ast_event_sub *sub)
686 {
687         struct ast_event_ie_val *ie_val;
688         struct ast_event *event;
689
690         event = ast_event_new(AST_EVENT_SUB,
691                 AST_EVENT_IE_UNIQUEID,    AST_EVENT_IE_PLTYPE_UINT, sub->uniqueid,
692                 AST_EVENT_IE_EVENTTYPE,   AST_EVENT_IE_PLTYPE_UINT, sub->type,
693                 AST_EVENT_IE_DESCRIPTION, AST_EVENT_IE_PLTYPE_STR, sub->description,
694                 AST_EVENT_IE_END);
695         if (!event)
696                 return NULL;
697
698         AST_LIST_TRAVERSE(&sub->ie_vals, ie_val, entry) {
699                 switch (ie_val->ie_pltype) {
700                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
701                         break;
702                 case AST_EVENT_IE_PLTYPE_EXISTS:
703                         ast_event_append_ie_uint(&event, AST_EVENT_IE_EXISTS, ie_val->ie_type);
704                         break;
705                 case AST_EVENT_IE_PLTYPE_UINT:
706                         ast_event_append_ie_uint(&event, ie_val->ie_type, ie_val->payload.uint);
707                         break;
708                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
709                         ast_event_append_ie_bitflags(&event, ie_val->ie_type, ie_val->payload.uint);
710                         break;
711                 case AST_EVENT_IE_PLTYPE_STR:
712                         ast_event_append_ie_str(&event, ie_val->ie_type, ie_val->payload.str);
713                         break;
714                 case AST_EVENT_IE_PLTYPE_RAW:
715                         ast_event_append_ie_raw(&event, ie_val->ie_type, ie_val->payload.raw, ie_val->raw_datalen);
716                         break;
717                 }
718                 if (!event)
719                         break;
720         }
721
722         return event;
723 }
724
725 /*! \brief Send AST_EVENT_SUB events to this subscriber of ... subscriber events */
726 void ast_event_report_subs(const struct ast_event_sub *event_sub)
727 {
728         struct ast_event *event;
729         struct ast_event_sub *sub;
730         enum ast_event_type event_type = -1;
731         struct ast_event_ie_val *ie_val;
732
733         if (event_sub->type != AST_EVENT_SUB)
734                 return;
735
736         AST_LIST_TRAVERSE(&event_sub->ie_vals, ie_val, entry) {
737                 if (ie_val->ie_type == AST_EVENT_IE_EVENTTYPE) {
738                         event_type = ie_val->payload.uint;
739                         break;
740                 }
741         }
742
743         if (event_type == -1)
744                 return;
745
746         AST_RWDLLIST_RDLOCK(&ast_event_subs[event_type]);
747         AST_RWDLLIST_TRAVERSE(&ast_event_subs[event_type], sub, entry) {
748                 if (event_sub == sub) {
749                         continue;
750                 }
751
752                 event = gen_sub_event(sub);
753                 if (!event) {
754                         continue;
755                 }
756
757                 event_sub->cb(event, event_sub->userdata);
758
759                 ast_event_destroy(event);
760         }
761         AST_RWDLLIST_UNLOCK(&ast_event_subs[event_type]);
762 }
763
764 struct ast_event_sub *ast_event_subscribe_new(enum ast_event_type type,
765         ast_event_cb_t cb, void *userdata)
766 {
767         struct ast_event_sub *sub;
768
769         if (type < 0 || type >= AST_EVENT_TOTAL) {
770                 ast_log(LOG_ERROR, "%u is an invalid type!\n", type);
771                 return NULL;
772         }
773
774         if (!(sub = ast_calloc(1, sizeof(*sub)))) {
775                 return NULL;
776         }
777
778         sub->type = type;
779         sub->cb = cb;
780         sub->userdata = userdata;
781         sub->uniqueid = ast_atomic_fetchadd_int((int *) &sub_uniqueid, 1);
782
783         return sub;
784 }
785
786 int ast_event_sub_append_ie_uint(struct ast_event_sub *sub,
787         enum ast_event_ie_type ie_type, uint32_t unsigned_int)
788 {
789         struct ast_event_ie_val *ie_val;
790
791         if (ie_type <= 0 || ie_type >= AST_EVENT_IE_TOTAL) {
792                 return -1;
793         }
794
795         if (!(ie_val = ast_calloc(1, sizeof(*ie_val)))) {
796                 return -1;
797         }
798
799         ie_val->ie_type = ie_type;
800         ie_val->payload.uint = unsigned_int;
801         ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_UINT;
802
803         AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
804
805         return 0;
806 }
807
808 int ast_event_sub_append_ie_bitflags(struct ast_event_sub *sub,
809         enum ast_event_ie_type ie_type, uint32_t flags)
810 {
811         struct ast_event_ie_val *ie_val;
812
813         if (ie_type <= 0 || ie_type >= AST_EVENT_IE_TOTAL) {
814                 return -1;
815         }
816
817         if (!(ie_val = ast_calloc(1, sizeof(*ie_val)))) {
818                 return -1;
819         }
820
821         ie_val->ie_type = ie_type;
822         ie_val->payload.uint = flags;
823         ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_BITFLAGS;
824
825         AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
826
827         return 0;
828 }
829
830 int ast_event_sub_append_ie_exists(struct ast_event_sub *sub,
831         enum ast_event_ie_type ie_type)
832 {
833         struct ast_event_ie_val *ie_val;
834
835         if (ie_type <= 0 || ie_type >= AST_EVENT_IE_TOTAL) {
836                 return -1;
837         }
838
839         if (!(ie_val = ast_calloc(1, sizeof(*ie_val)))) {
840                 return -1;
841         }
842
843         ie_val->ie_type = ie_type;
844         ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_EXISTS;
845
846         AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
847
848         return 0;
849 }
850
851 int ast_event_sub_append_ie_str(struct ast_event_sub *sub,
852         enum ast_event_ie_type ie_type, const char *str)
853 {
854         struct ast_event_ie_val *ie_val;
855
856         if (ie_type <= 0 || ie_type >= AST_EVENT_IE_TOTAL) {
857                 return -1;
858         }
859
860         if (!(ie_val = ast_calloc(1, sizeof(*ie_val)))) {
861                 return -1;
862         }
863
864         ie_val->ie_type = ie_type;
865         ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_STR;
866
867         if (!(ie_val->payload.str = ast_strdup(str))) {
868                 ast_free(ie_val);
869                 return -1;
870         }
871
872         if (ie_type == AST_EVENT_IE_DEVICE) {
873                 char *uppertech = ast_strdupa(str);
874                 ast_tech_to_upper(uppertech);
875                 ie_val->payload.hash = ast_str_hash(uppertech);
876         } else {
877                 ie_val->payload.hash = ast_str_hash(str);
878         }
879
880         AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
881
882         return 0;
883 }
884
885 int ast_event_sub_append_ie_raw(struct ast_event_sub *sub,
886         enum ast_event_ie_type ie_type, void *data, size_t raw_datalen)
887 {
888         struct ast_event_ie_val *ie_val;
889
890         if (ie_type <= 0 || ie_type >= AST_EVENT_IE_TOTAL) {
891                 return -1;
892         }
893
894         if (!(ie_val = ast_calloc(1, sizeof(*ie_val)))) {
895                 return -1;
896         }
897
898         ie_val->ie_type = ie_type;
899         ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_RAW;
900         ie_val->raw_datalen = raw_datalen;
901
902         if (!(ie_val->payload.raw = ast_malloc(raw_datalen))) {
903                 ast_free(ie_val);
904                 return -1;
905         }
906
907         memcpy(ie_val->payload.raw, data, raw_datalen);
908
909         AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
910
911         return 0;
912 }
913
914 int ast_event_sub_activate(struct ast_event_sub *sub)
915 {
916         if (ast_event_check_subscriber(AST_EVENT_SUB,
917                 AST_EVENT_IE_EVENTTYPE, AST_EVENT_IE_PLTYPE_UINT, sub->type,
918                 AST_EVENT_IE_END) != AST_EVENT_SUB_NONE) {
919                 struct ast_event *event;
920
921                 event = gen_sub_event(sub);
922                 if (event && ast_event_queue(event)) {
923                         ast_event_destroy(event);
924                 }
925         }
926
927         AST_RWDLLIST_WRLOCK(&ast_event_subs[sub->type]);
928         AST_RWDLLIST_INSERT_TAIL(&ast_event_subs[sub->type], sub, entry);
929         AST_RWDLLIST_UNLOCK(&ast_event_subs[sub->type]);
930
931         return 0;
932 }
933
934 struct ast_event_sub *ast_event_subscribe(enum ast_event_type type, ast_event_cb_t cb,
935         const char *description, void *userdata, ...)
936 {
937         va_list ap;
938         enum ast_event_ie_type ie_type;
939         struct ast_event_sub *sub;
940
941         if (!(sub = ast_event_subscribe_new(type, cb, userdata))) {
942                 return NULL;
943         }
944
945         ast_copy_string(sub->description, description, sizeof(sub->description));
946
947         va_start(ap, userdata);
948         for (ie_type = va_arg(ap, enum ast_event_ie_type);
949                 ie_type != AST_EVENT_IE_END;
950                 ie_type = va_arg(ap, enum ast_event_ie_type))
951         {
952                 enum ast_event_ie_pltype ie_pltype;
953
954                 ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
955
956                 switch (ie_pltype) {
957                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
958                         break;
959                 case AST_EVENT_IE_PLTYPE_UINT:
960                 {
961                         uint32_t unsigned_int = va_arg(ap, uint32_t);
962                         ast_event_sub_append_ie_uint(sub, ie_type, unsigned_int);
963                         break;
964                 }
965                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
966                 {
967                         uint32_t unsigned_int = va_arg(ap, uint32_t);
968                         ast_event_sub_append_ie_bitflags(sub, ie_type, unsigned_int);
969                         break;
970                 }
971                 case AST_EVENT_IE_PLTYPE_STR:
972                 {
973                         const char *str = va_arg(ap, const char *);
974                         ast_event_sub_append_ie_str(sub, ie_type, str);
975                         break;
976                 }
977                 case AST_EVENT_IE_PLTYPE_RAW:
978                 {
979                         void *data = va_arg(ap, void *);
980                         size_t data_len = va_arg(ap, size_t);
981                         ast_event_sub_append_ie_raw(sub, ie_type, data, data_len);
982                         break;
983                 }
984                 case AST_EVENT_IE_PLTYPE_EXISTS:
985                         ast_event_sub_append_ie_exists(sub, ie_type);
986                         break;
987                 }
988         }
989         va_end(ap);
990
991         ast_event_sub_activate(sub);
992
993         return sub;
994 }
995
996 void ast_event_sub_destroy(struct ast_event_sub *sub)
997 {
998         struct ast_event_ie_val *ie_val;
999
1000         while ((ie_val = AST_LIST_REMOVE_HEAD(&sub->ie_vals, entry))) {
1001                 ast_event_ie_val_destroy(ie_val);
1002         }
1003
1004         ast_free(sub);
1005 }
1006
1007 const char *ast_event_subscriber_get_description(struct ast_event_sub *sub)
1008 {
1009         return sub ? sub->description : NULL;
1010 }
1011
1012 struct ast_event_sub *ast_event_unsubscribe(struct ast_event_sub *sub)
1013 {
1014         struct ast_event *event;
1015
1016         AST_RWDLLIST_WRLOCK(&ast_event_subs[sub->type]);
1017         AST_DLLIST_REMOVE(&ast_event_subs[sub->type], sub, entry);
1018         AST_RWDLLIST_UNLOCK(&ast_event_subs[sub->type]);
1019
1020         if (ast_event_check_subscriber(AST_EVENT_UNSUB,
1021                 AST_EVENT_IE_EVENTTYPE, AST_EVENT_IE_PLTYPE_UINT, sub->type,
1022                 AST_EVENT_IE_END) != AST_EVENT_SUB_NONE) {
1023
1024                 event = ast_event_new(AST_EVENT_UNSUB,
1025                         AST_EVENT_IE_UNIQUEID,    AST_EVENT_IE_PLTYPE_UINT, sub->uniqueid,
1026                         AST_EVENT_IE_EVENTTYPE,   AST_EVENT_IE_PLTYPE_UINT, sub->type,
1027                         AST_EVENT_IE_DESCRIPTION, AST_EVENT_IE_PLTYPE_STR, sub->description,
1028                         AST_EVENT_IE_END);
1029                 if (event && ast_event_queue(event)) {
1030                         ast_event_destroy(event);
1031                 }
1032         }
1033
1034         ast_event_sub_destroy(sub);
1035
1036         return NULL;
1037 }
1038
1039 int ast_event_iterator_init(struct ast_event_iterator *iterator, const struct ast_event *event)
1040 {
1041         int res = 0;
1042
1043         iterator->event_len = ast_event_get_size(event);
1044         iterator->event = event;
1045         if (iterator->event_len >= sizeof(*event) + sizeof(struct ast_event_ie)) {
1046                 iterator->ie = (struct ast_event_ie *) ( ((char *) event) + sizeof(*event) );
1047         } else {
1048                 iterator->ie = NULL;
1049                 res = -1;
1050         }
1051
1052         return res;
1053 }
1054
1055 int ast_event_iterator_next(struct ast_event_iterator *iterator)
1056 {
1057         iterator->ie = (struct ast_event_ie *) ( ((char *) iterator->ie) + sizeof(*iterator->ie) + ntohs(iterator->ie->ie_payload_len));
1058         return ((iterator->event_len <= (((char *) iterator->ie) - ((char *) iterator->event))) ? -1 : 0);
1059 }
1060
1061 enum ast_event_ie_type ast_event_iterator_get_ie_type(struct ast_event_iterator *iterator)
1062 {
1063         return ntohs(iterator->ie->ie_type);
1064 }
1065
1066 uint32_t ast_event_iterator_get_ie_uint(struct ast_event_iterator *iterator)
1067 {
1068         return ntohl(get_unaligned_uint32(iterator->ie->ie_payload));
1069 }
1070
1071 uint32_t ast_event_iterator_get_ie_bitflags(struct ast_event_iterator *iterator)
1072 {
1073         return ntohl(get_unaligned_uint32(iterator->ie->ie_payload));
1074 }
1075
1076 const char *ast_event_iterator_get_ie_str(struct ast_event_iterator *iterator)
1077 {
1078         const struct ast_event_ie_str_payload *str_payload;
1079
1080         str_payload = (struct ast_event_ie_str_payload *) iterator->ie->ie_payload;
1081
1082         return str_payload ? str_payload->str : NULL;
1083 }
1084
1085 void *ast_event_iterator_get_ie_raw(struct ast_event_iterator *iterator)
1086 {
1087         return iterator->ie->ie_payload;
1088 }
1089
1090 uint16_t ast_event_iterator_get_ie_raw_payload_len(struct ast_event_iterator *iterator)
1091 {
1092         return ntohs(iterator->ie->ie_payload_len);
1093 }
1094
1095 enum ast_event_type ast_event_get_type(const struct ast_event *event)
1096 {
1097         return ntohs(event->type);
1098 }
1099
1100 uint32_t ast_event_get_ie_uint(const struct ast_event *event, enum ast_event_ie_type ie_type)
1101 {
1102         const uint32_t *ie_val;
1103
1104         ie_val = ast_event_get_ie_raw(event, ie_type);
1105
1106         return ie_val ? ntohl(get_unaligned_uint32(ie_val)) : 0;
1107 }
1108
1109 uint32_t ast_event_get_ie_bitflags(const struct ast_event *event, enum ast_event_ie_type ie_type)
1110 {
1111         const uint32_t *ie_val;
1112
1113         ie_val = ast_event_get_ie_raw(event, ie_type);
1114
1115         return ie_val ? ntohl(get_unaligned_uint32(ie_val)) : 0;
1116 }
1117
1118 uint32_t ast_event_get_ie_str_hash(const struct ast_event *event, enum ast_event_ie_type ie_type)
1119 {
1120         const struct ast_event_ie_str_payload *str_payload;
1121
1122         str_payload = ast_event_get_ie_raw(event, ie_type);
1123
1124         return str_payload ? str_payload->hash : 0;
1125 }
1126
1127 const char *ast_event_get_ie_str(const struct ast_event *event, enum ast_event_ie_type ie_type)
1128 {
1129         const struct ast_event_ie_str_payload *str_payload;
1130
1131         str_payload = ast_event_get_ie_raw(event, ie_type);
1132
1133         return str_payload ? str_payload->str : NULL;
1134 }
1135
1136 const void *ast_event_get_ie_raw(const struct ast_event *event, enum ast_event_ie_type ie_type)
1137 {
1138         struct ast_event_iterator iterator;
1139         int res;
1140
1141         for (res = ast_event_iterator_init(&iterator, event); !res; res = ast_event_iterator_next(&iterator)) {
1142                 if (ast_event_iterator_get_ie_type(&iterator) == ie_type) {
1143                         return ast_event_iterator_get_ie_raw(&iterator);
1144                 }
1145         }
1146
1147         return NULL;
1148 }
1149
1150 uint16_t ast_event_get_ie_raw_payload_len(const struct ast_event *event, enum ast_event_ie_type ie_type)
1151 {
1152         struct ast_event_iterator iterator;
1153         int res;
1154
1155         for (res = ast_event_iterator_init(&iterator, event); !res; res = ast_event_iterator_next(&iterator)) {
1156                 if (ast_event_iterator_get_ie_type(&iterator) == ie_type) {
1157                         return ast_event_iterator_get_ie_raw_payload_len(&iterator);
1158                 }
1159         }
1160
1161         return 0;
1162 }
1163
1164 int ast_event_append_ie_str(struct ast_event **event, enum ast_event_ie_type ie_type,
1165         const char *str)
1166 {
1167         struct ast_event_ie_str_payload *str_payload;
1168         size_t payload_len;
1169
1170         payload_len = sizeof(*str_payload) + strlen(str);
1171         str_payload = ast_alloca(payload_len);
1172
1173         strcpy(str_payload->str, str);
1174         if (ie_type == AST_EVENT_IE_DEVICE) {
1175                 char *uppertech = ast_strdupa(str);
1176                 ast_tech_to_upper(uppertech);
1177                 str_payload->hash = ast_str_hash(uppertech);
1178         } else {
1179                 str_payload->hash = ast_str_hash(str);
1180         }
1181
1182         return ast_event_append_ie_raw(event, ie_type, str_payload, payload_len);
1183 }
1184
1185 int ast_event_append_ie_uint(struct ast_event **event, enum ast_event_ie_type ie_type,
1186         uint32_t data)
1187 {
1188         data = htonl(data);
1189         return ast_event_append_ie_raw(event, ie_type, &data, sizeof(data));
1190 }
1191
1192 int ast_event_append_ie_bitflags(struct ast_event **event, enum ast_event_ie_type ie_type,
1193         uint32_t flags)
1194 {
1195         flags = htonl(flags);
1196         return ast_event_append_ie_raw(event, ie_type, &flags, sizeof(flags));
1197 }
1198
1199 int ast_event_append_ie_raw(struct ast_event **event, enum ast_event_ie_type ie_type,
1200         const void *data, size_t data_len)
1201 {
1202         struct ast_event_ie *ie;
1203         unsigned int extra_len;
1204         uint16_t event_len;
1205
1206         event_len = ntohs((*event)->event_len);
1207         extra_len = sizeof(*ie) + data_len;
1208
1209         if (!(*event = ast_realloc(*event, event_len + extra_len))) {
1210                 return -1;
1211         }
1212
1213         ie = (struct ast_event_ie *) ( ((char *) *event) + event_len );
1214         ie->ie_type = htons(ie_type);
1215         ie->ie_payload_len = htons(data_len);
1216         memcpy(ie->ie_payload, data, data_len);
1217
1218         (*event)->event_len = htons(event_len + extra_len);
1219
1220         return 0;
1221 }
1222
1223 struct ast_event *ast_event_new(enum ast_event_type type, ...)
1224 {
1225         va_list ap;
1226         struct ast_event *event;
1227         enum ast_event_ie_type ie_type;
1228         struct ast_event_ie_val *ie_val;
1229         AST_LIST_HEAD_NOLOCK_STATIC(ie_vals, ast_event_ie_val);
1230
1231         /* Invalid type */
1232         if (type >= AST_EVENT_TOTAL) {
1233                 ast_log(LOG_WARNING, "Someone tried to create an event of invalid "
1234                         "type '%d'!\n", type);
1235                 return NULL;
1236         }
1237
1238         va_start(ap, type);
1239         for (ie_type = va_arg(ap, enum ast_event_ie_type);
1240                 ie_type != AST_EVENT_IE_END;
1241                 ie_type = va_arg(ap, enum ast_event_ie_type))
1242         {
1243                 struct ast_event_ie_val *ie_value = ast_alloca(sizeof(*ie_value));
1244                 int insert = 0;
1245
1246                 memset(ie_value, 0, sizeof(*ie_value));
1247                 ie_value->ie_type = ie_type;
1248                 ie_value->ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
1249                 switch (ie_value->ie_pltype) {
1250                 case AST_EVENT_IE_PLTYPE_UINT:
1251                         ie_value->payload.uint = va_arg(ap, uint32_t);
1252                         insert = 1;
1253                         break;
1254                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
1255                         ie_value->payload.uint = va_arg(ap, uint32_t);
1256                         insert = 1;
1257                         break;
1258                 case AST_EVENT_IE_PLTYPE_STR:
1259                         ie_value->payload.str = va_arg(ap, const char *);
1260                         insert = 1;
1261                         break;
1262                 case AST_EVENT_IE_PLTYPE_RAW:
1263                 {
1264                         void *data = va_arg(ap, void *);
1265                         size_t datalen = va_arg(ap, size_t);
1266                         ie_value->payload.raw = ast_alloca(datalen);
1267                         memcpy(ie_value->payload.raw, data, datalen);
1268                         ie_value->raw_datalen = datalen;
1269                         insert = 1;
1270                         break;
1271                 }
1272                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
1273                 case AST_EVENT_IE_PLTYPE_EXISTS:
1274                         break;
1275                 }
1276
1277                 if (insert) {
1278                         AST_LIST_INSERT_TAIL(&ie_vals, ie_value, entry);
1279                 } else {
1280                         ast_log(LOG_WARNING, "Unsupported PLTYPE(%d)\n", ie_value->ie_pltype);
1281                 }
1282         }
1283         va_end(ap);
1284
1285         if (!(event = ast_calloc(1, sizeof(*event)))) {
1286                 return NULL;
1287         }
1288
1289         event->type = htons(type);
1290         event->event_len = htons(sizeof(*event));
1291
1292         AST_LIST_TRAVERSE(&ie_vals, ie_val, entry) {
1293                 switch (ie_val->ie_pltype) {
1294                 case AST_EVENT_IE_PLTYPE_STR:
1295                         ast_event_append_ie_str(&event, ie_val->ie_type, ie_val->payload.str);
1296                         break;
1297                 case AST_EVENT_IE_PLTYPE_UINT:
1298                         ast_event_append_ie_uint(&event, ie_val->ie_type, ie_val->payload.uint);
1299                         break;
1300                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
1301                         ast_event_append_ie_bitflags(&event, ie_val->ie_type, ie_val->payload.uint);
1302                         break;
1303                 case AST_EVENT_IE_PLTYPE_RAW:
1304                         ast_event_append_ie_raw(&event, ie_val->ie_type,
1305                                         ie_val->payload.raw, ie_val->raw_datalen);
1306                         break;
1307                 case AST_EVENT_IE_PLTYPE_EXISTS:
1308                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
1309                         break;
1310                 }
1311
1312                 /* realloc inside one of the append functions failed */
1313                 if (!event) {
1314                         return NULL;
1315                 }
1316         }
1317
1318         if (!ast_event_get_ie_raw(event, AST_EVENT_IE_EID)) {
1319                 /* If the event is originating on this server, add the server's
1320                  * entity ID to the event. */
1321                 ast_event_append_eid(&event);
1322         }
1323
1324         return event;
1325 }
1326
1327 int ast_event_append_eid(struct ast_event **event)
1328 {
1329         return ast_event_append_ie_raw(event, AST_EVENT_IE_EID,
1330                         &ast_eid_default, sizeof(ast_eid_default));
1331 }
1332
1333 void ast_event_destroy(struct ast_event *event)
1334 {
1335         ast_free(event);
1336 }
1337
1338 static void ast_event_ref_destroy(void *obj)
1339 {
1340         struct ast_event_ref *event_ref = obj;
1341
1342         ast_event_destroy(event_ref->event);
1343 }
1344
1345 static struct ast_event *ast_event_dup(const struct ast_event *event)
1346 {
1347         struct ast_event *dup_event;
1348         uint16_t event_len;
1349
1350         event_len = ast_event_get_size(event);
1351
1352         if (!(dup_event = ast_calloc(1, event_len))) {
1353                 return NULL;
1354         }
1355
1356         memcpy(dup_event, event, event_len);
1357
1358         return dup_event;
1359 }
1360
1361 struct ast_event *ast_event_get_cached(enum ast_event_type type, ...)
1362 {
1363         va_list ap;
1364         enum ast_event_ie_type ie_type;
1365         struct ast_event *dup_event = NULL;
1366         struct ast_event_ref *cached_event_ref;
1367         struct ast_event *cache_arg_event;
1368         struct ast_event_ref tmp_event_ref = {
1369                 .event = NULL,
1370         };
1371         struct ao2_container *container = NULL;
1372
1373         if (type >= AST_EVENT_TOTAL) {
1374                 ast_log(LOG_ERROR, "%u is an invalid type!\n", type);
1375                 return NULL;
1376         }
1377
1378         if (!(container = ast_event_cache[type].container)) {
1379                 ast_log(LOG_ERROR, "%u is not a cached event type\n", type);
1380                 return NULL;
1381         }
1382
1383         if (!(cache_arg_event = ast_event_new(type, AST_EVENT_IE_END))) {
1384                 return NULL;
1385         }
1386
1387         va_start(ap, type);
1388         for (ie_type = va_arg(ap, enum ast_event_ie_type);
1389                 ie_type != AST_EVENT_IE_END;
1390                 ie_type = va_arg(ap, enum ast_event_ie_type))
1391         {
1392                 enum ast_event_ie_pltype ie_pltype;
1393
1394                 ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
1395
1396                 switch (ie_pltype) {
1397                 case AST_EVENT_IE_PLTYPE_UINT:
1398                         ast_event_append_ie_uint(&cache_arg_event, ie_type, va_arg(ap, uint32_t));
1399                         break;
1400                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
1401                         ast_event_append_ie_bitflags(&cache_arg_event, ie_type, va_arg(ap, uint32_t));
1402                         break;
1403                 case AST_EVENT_IE_PLTYPE_STR:
1404                         ast_event_append_ie_str(&cache_arg_event, ie_type, va_arg(ap, const char *));
1405                         break;
1406                 case AST_EVENT_IE_PLTYPE_RAW:
1407                 {
1408                         void *data = va_arg(ap, void *);
1409                         size_t datalen = va_arg(ap, size_t);
1410                         ast_event_append_ie_raw(&cache_arg_event, ie_type, data, datalen);
1411                         break;
1412                 }
1413                 case AST_EVENT_IE_PLTYPE_EXISTS:
1414                         ast_log(LOG_WARNING, "PLTYPE_EXISTS not supported by this function\n");
1415                         break;
1416                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
1417                         break;
1418                 }
1419         }
1420         va_end(ap);
1421
1422         tmp_event_ref.event = cache_arg_event;
1423
1424         cached_event_ref = ao2_find(container, &tmp_event_ref, OBJ_POINTER);
1425
1426         ast_event_destroy(cache_arg_event);
1427         cache_arg_event = NULL;
1428
1429         if (cached_event_ref) {
1430                 dup_event = ast_event_dup(cached_event_ref->event);
1431                 ao2_ref(cached_event_ref, -1);
1432                 cached_event_ref = NULL;
1433         }
1434
1435         return dup_event;
1436 }
1437
1438 static struct ast_event_ref *alloc_event_ref(void)
1439 {
1440         return ao2_alloc(sizeof(struct ast_event_ref), ast_event_ref_destroy);
1441 }
1442
1443 /*!
1444  * \internal
1445  * \brief Update the given event cache with the new event.
1446  * \since 1.8
1447  *
1448  * \param cache Event cache container to update.
1449  * \param event New event to put in the cache.
1450  *
1451  * \return Nothing
1452  */
1453 static void event_update_cache(struct ao2_container *cache, struct ast_event *event)
1454 {
1455         struct ast_event_ref tmp_event_ref = {
1456                 .event = event,
1457         };
1458         struct ast_event *dup_event;
1459         struct ast_event_ref *event_ref;
1460
1461         /* Hold the cache container lock while it is updated. */
1462         ao2_lock(cache);
1463
1464         /* Remove matches from the cache. */
1465         ao2_callback(cache, OBJ_POINTER | OBJ_UNLINK | OBJ_MULTIPLE | OBJ_NODATA,
1466                 ast_event_cmp, &tmp_event_ref);
1467
1468         /* Save a copy of the event in the cache. */
1469         dup_event = ast_event_dup(event);
1470         if (dup_event) {
1471                 event_ref = alloc_event_ref();
1472                 if (event_ref) {
1473                         event_ref->event = dup_event;
1474                         ao2_link(cache, event_ref);
1475                         ao2_ref(event_ref, -1);
1476                 } else {
1477                         ast_event_destroy(dup_event);
1478                 }
1479         }
1480
1481         ao2_unlock(cache);
1482 }
1483
1484 static int handle_event(void *data)
1485 {
1486         struct ast_event_ref *event_ref = data;
1487         struct ast_event_sub *sub;
1488         const enum ast_event_type event_types[] = {
1489                 ntohs(event_ref->event->type),
1490                 AST_EVENT_ALL
1491         };
1492         int i;
1493
1494         if (event_ref->cache) {
1495                 struct ao2_container *container;
1496                 container = ast_event_cache[ast_event_get_type(event_ref->event)].container;
1497                 if (!container) {
1498                         ast_log(LOG_WARNING, "cache requested for non-cached event type\n");
1499                 } else {
1500                         event_update_cache(container, event_ref->event);
1501                 }
1502         }
1503
1504         for (i = 0; i < ARRAY_LEN(event_types); i++) {
1505                 AST_RWDLLIST_RDLOCK(&ast_event_subs[event_types[i]]);
1506                 AST_RWDLLIST_TRAVERSE(&ast_event_subs[event_types[i]], sub, entry) {
1507                         struct ast_event_ie_val *ie_val;
1508
1509                         AST_LIST_TRAVERSE(&sub->ie_vals, ie_val, entry) {
1510                                 if (!match_ie_val(event_ref->event, ie_val, NULL)) {
1511                                         /* The current subscription ie did not match an event ie. */
1512                                         break;
1513                                 }
1514                         }
1515                         if (ie_val) {
1516                                 /* The event did not match this subscription. */
1517                                 continue;
1518                         }
1519                         sub->cb(event_ref->event, sub->userdata);
1520                 }
1521                 AST_RWDLLIST_UNLOCK(&ast_event_subs[event_types[i]]);
1522         }
1523
1524         ao2_ref(event_ref, -1);
1525
1526         return 0;
1527 }
1528
1529 static int _ast_event_queue(struct ast_event *event, unsigned int cache)
1530 {
1531         struct ast_event_ref *event_ref;
1532         uint16_t host_event_type;
1533         int res;
1534
1535         host_event_type = ntohs(event->type);
1536
1537         /* Invalid type */
1538         if (host_event_type >= AST_EVENT_TOTAL) {
1539                 ast_log(LOG_WARNING, "Someone tried to queue an event of invalid "
1540                         "type '%d'!\n", host_event_type);
1541                 return -1;
1542         }
1543
1544         /* If nobody has subscribed to this event type, throw it away now */
1545         if (ast_event_check_subscriber(host_event_type, AST_EVENT_IE_END)
1546                         == AST_EVENT_SUB_NONE) {
1547                 ast_event_destroy(event);
1548                 return 0;
1549         }
1550
1551         if (!(event_ref = alloc_event_ref())) {
1552                 return -1;
1553         }
1554
1555         event_ref->event = event;
1556         event_ref->cache = cache;
1557
1558         res = ast_taskprocessor_push(event_dispatcher, handle_event, event_ref);
1559         if (res) {
1560                 event_ref->event = NULL;
1561                 ao2_ref(event_ref, -1);
1562         }
1563         return res;
1564 }
1565
1566 int ast_event_queue(struct ast_event *event)
1567 {
1568         return _ast_event_queue(event, 0);
1569 }
1570
1571 int ast_event_queue_and_cache(struct ast_event *event)
1572 {
1573         return _ast_event_queue(event, 1);
1574 }
1575
1576 static int ast_event_hash_mwi(const void *obj, const int flags)
1577 {
1578         const struct ast_event *event = obj;
1579         const char *mailbox = ast_event_get_ie_str(event, AST_EVENT_IE_MAILBOX);
1580         const char *context = ast_event_get_ie_str(event, AST_EVENT_IE_CONTEXT);
1581
1582         return ast_str_hash_add(context, ast_str_hash(mailbox));
1583 }
1584
1585 /*!
1586  * \internal
1587  * \brief Hash function for AST_EVENT_DEVICE_STATE
1588  *
1589  * \param[in] obj an ast_event
1590  * \param[in] flags unused
1591  *
1592  * \return hash value
1593  */
1594 static int ast_event_hash_devstate(const void *obj, const int flags)
1595 {
1596         const struct ast_event *event = obj;
1597
1598         return ast_str_hash(ast_event_get_ie_str(event, AST_EVENT_IE_DEVICE));
1599 }
1600
1601 /*!
1602  * \internal
1603  * \brief Hash function for AST_EVENT_DEVICE_STATE_CHANGE
1604  *
1605  * \param[in] obj an ast_event
1606  * \param[in] flags unused
1607  *
1608  * \return hash value
1609  */
1610 static int ast_event_hash_devstate_change(const void *obj, const int flags)
1611 {
1612         const struct ast_event *event = obj;
1613
1614         return ast_str_hash(ast_event_get_ie_str(event, AST_EVENT_IE_DEVICE));
1615 }
1616
1617 /*!
1618  * \internal
1619  * \brief Hash function for AST_EVENT_PRESENCE_STATE
1620  *
1621  * \param[in] obj an ast_event
1622  * \param[in] flags unused
1623  *
1624  * \return hash value
1625  */
1626 static int ast_event_hash_presence_state_change(const void *obj, const int flags)
1627 {
1628         const struct ast_event *event = obj;
1629
1630         return ast_str_hash(ast_event_get_ie_str(event, AST_EVENT_IE_PRESENCE_PROVIDER));
1631 }
1632
1633 static int ast_event_hash(const void *obj, const int flags)
1634 {
1635         const struct ast_event_ref *event_ref;
1636         const struct ast_event *event;
1637         ao2_hash_fn *hash_fn;
1638
1639         event_ref = obj;
1640         event = event_ref->event;
1641
1642         if (!(hash_fn = ast_event_cache[ast_event_get_type(event)].hash_fn)) {
1643                 return 0;
1644         }
1645
1646         return hash_fn(event, flags);
1647 }
1648
1649 /*!
1650  * \internal
1651  * \brief Compare two events
1652  *
1653  * \param[in] obj the first event, as an ast_event_ref
1654  * \param[in] arg the second event, as an ast_event_ref
1655  * \param[in] flags unused
1656  *
1657  * \pre Both events must be the same type.
1658  * \pre The event type must be declared as a cached event type in ast_event_cache
1659  *
1660  * \details This function takes two events, and determines if they are considered
1661  * equivalent.  The values of information elements specified in the cache arguments
1662  * for the event type are used to determine if the events are equivalent.
1663  *
1664  * \retval 0 No match
1665  * \retval CMP_MATCH The events are considered equivalent based on the cache arguments
1666  */
1667 static int ast_event_cmp(void *obj, void *arg, int flags)
1668 {
1669         struct ast_event_ref *event_ref, *event_ref2;
1670         struct ast_event *event, *event2;
1671         int res = CMP_MATCH;
1672         int i;
1673         enum ast_event_ie_type *cache_args;
1674
1675         event_ref = obj;
1676         event = event_ref->event;
1677
1678         event_ref2 = arg;
1679         event2 = event_ref2->event;
1680
1681         cache_args = ast_event_cache[ast_event_get_type(event)].cache_args;
1682
1683         for (i = 0; i < ARRAY_LEN(ast_event_cache[0].cache_args) && cache_args[i]; i++) {
1684                 struct ast_event_ie_val ie_val = {
1685                         .ie_pltype = ast_event_get_ie_pltype(cache_args[i]),
1686                         .ie_type = cache_args[i],
1687                 };
1688
1689                 if (!match_ie_val(event, &ie_val, event2)) {
1690                         res = 0;
1691                         break;
1692                 }
1693         }
1694
1695         return res;
1696 }
1697
1698 static void dump_raw_ie(struct ast_event_iterator *i, struct ast_cli_args *a)
1699 {
1700         char eid_buf[32];
1701         enum ast_event_ie_type ie_type;
1702         const char *ie_type_name;
1703
1704         ie_type = ast_event_iterator_get_ie_type(i);
1705         ie_type_name = ast_event_get_ie_type_name(ie_type);
1706
1707         switch (ie_type) {
1708         case AST_EVENT_IE_EID:
1709                 ast_eid_to_str(eid_buf, sizeof(eid_buf), ast_event_iterator_get_ie_raw(i));
1710                 ast_cli(a->fd, "%.30s: %s\n", ie_type_name, eid_buf);
1711                 break;
1712         default:
1713                 ast_cli(a->fd, "%s\n", ie_type_name);
1714                 break;
1715         }
1716 }
1717
1718 static int event_dump_cli(void *obj, void *arg, int flags)
1719 {
1720         const struct ast_event_ref *event_ref = obj;
1721         const struct ast_event *event = event_ref->event;
1722         struct ast_cli_args *a = arg;
1723         struct ast_event_iterator i;
1724
1725         if (ast_event_iterator_init(&i, event)) {
1726                 ast_cli(a->fd, "Failed to initialize event iterator.  :-(\n");
1727                 return 0;
1728         }
1729
1730         ast_cli(a->fd, "Event: %s\n", ast_event_get_type_name(event));
1731
1732         do {
1733                 enum ast_event_ie_type ie_type;
1734                 enum ast_event_ie_pltype ie_pltype;
1735                 const char *ie_type_name;
1736
1737                 ie_type = ast_event_iterator_get_ie_type(&i);
1738                 ie_type_name = ast_event_get_ie_type_name(ie_type);
1739                 ie_pltype = ast_event_get_ie_pltype(ie_type);
1740
1741                 switch (ie_pltype) {
1742                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
1743                 case AST_EVENT_IE_PLTYPE_EXISTS:
1744                         ast_cli(a->fd, "%s\n", ie_type_name);
1745                         break;
1746                 case AST_EVENT_IE_PLTYPE_STR:
1747                         ast_cli(a->fd, "%.30s: %s\n", ie_type_name,
1748                                         ast_event_iterator_get_ie_str(&i));
1749                         break;
1750                 case AST_EVENT_IE_PLTYPE_UINT:
1751                         ast_cli(a->fd, "%.30s: %u\n", ie_type_name,
1752                                         ast_event_iterator_get_ie_uint(&i));
1753                         break;
1754                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
1755                         ast_cli(a->fd, "%.30s: %u\n", ie_type_name,
1756                                         ast_event_iterator_get_ie_bitflags(&i));
1757                         break;
1758                 case AST_EVENT_IE_PLTYPE_RAW:
1759                         dump_raw_ie(&i, a);
1760                         break;
1761                 }
1762         } while (!ast_event_iterator_next(&i));
1763
1764         ast_cli(a->fd, "\n");
1765
1766         return 0;
1767 }
1768
1769 static char *event_dump_cache(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1770 {
1771         enum ast_event_type event_type;
1772         enum ast_event_ie_type *cache_args;
1773         int i;
1774
1775         switch (cmd) {
1776         case CLI_INIT:
1777                 e->command = "event dump cache";
1778                 e->usage =
1779                         "Usage: event dump cache <event type>\n"
1780                         "       Dump all of the cached events for the given event type.\n"
1781                         "       This is primarily intended for debugging.\n";
1782                 return NULL;
1783         case CLI_GENERATE:
1784                 if (a->pos == 3) {
1785                         return ast_cli_complete(a->word, cached_event_types, a->n);
1786                 }
1787                 return NULL;
1788         case CLI_HANDLER:
1789                 break;
1790         }
1791
1792         if (a->argc != e->args + 1) {
1793                 return CLI_SHOWUSAGE;
1794         }
1795
1796         if (ast_event_str_to_event_type(a->argv[e->args], &event_type)) {
1797                 ast_cli(a->fd, "Invalid cached event type: '%s'\n", a->argv[e->args]);
1798                 return CLI_SHOWUSAGE;
1799         }
1800
1801         if (!ast_event_cache[event_type].container) {
1802                 ast_cli(a->fd, "Event type '%s' has no cache.\n", a->argv[e->args]);
1803                 return CLI_SUCCESS;
1804         }
1805
1806         ast_cli(a->fd, "Event Type: %s\n", a->argv[e->args]);
1807         ast_cli(a->fd, "Cache Unique Keys:\n");
1808         cache_args = ast_event_cache[event_type].cache_args;
1809         for (i = 0; i < ARRAY_LEN(ast_event_cache[0].cache_args) && cache_args[i]; i++) {
1810                 ast_cli(a->fd, "--> %s\n", ast_event_get_ie_type_name(cache_args[i]));
1811         }
1812
1813         ast_cli(a->fd, "\n--- Begin Cache Dump ---\n\n");
1814         ao2_callback(ast_event_cache[event_type].container, OBJ_NODATA, event_dump_cli, a);
1815         ast_cli(a->fd, "--- End Cache Dump ---\n\n");
1816
1817         return CLI_SUCCESS;
1818 }
1819
1820 static struct ast_cli_entry event_cli[] = {
1821         AST_CLI_DEFINE(event_dump_cache, "Dump the internal event cache (for debugging)"),
1822 };
1823
1824 /*! \internal \brief Clean up resources on Asterisk shutdown */
1825 static void event_shutdown(void)
1826 {
1827         struct ast_event_sub *sub;
1828         int i;
1829
1830         ast_cli_unregister_multiple(event_cli, ARRAY_LEN(event_cli));
1831
1832         if (event_dispatcher) {
1833                 event_dispatcher = ast_taskprocessor_unreference(event_dispatcher);
1834         }
1835
1836         /* Remove any remaining subscriptions.  Note that we can't just call
1837          * unsubscribe, as it will attempt to lock the subscription list
1838          * as well */
1839         for (i = 0; i < AST_EVENT_TOTAL; i++) {
1840                 AST_RWDLLIST_WRLOCK(&ast_event_subs[i]);
1841                 while ((sub = AST_RWDLLIST_REMOVE_HEAD(&ast_event_subs[i], entry))) {
1842                         ast_event_sub_destroy(sub);
1843                 }
1844                 AST_RWDLLIST_UNLOCK(&ast_event_subs[i]);
1845                 AST_RWDLLIST_HEAD_DESTROY(&ast_event_subs[i]);
1846         }
1847
1848         for (i = 0; i < AST_EVENT_TOTAL; i++) {
1849                 if (!ast_event_cache[i].hash_fn) {
1850                         continue;
1851                 }
1852                 if (ast_event_cache[i].container) {
1853                         ao2_ref(ast_event_cache[i].container, -1);
1854                 }
1855         }
1856 }
1857
1858 int ast_event_init(void)
1859 {
1860         int i;
1861
1862         for (i = 0; i < AST_EVENT_TOTAL; i++) {
1863                 AST_RWDLLIST_HEAD_INIT(&ast_event_subs[i]);
1864         }
1865
1866         for (i = 0; i < AST_EVENT_TOTAL; i++) {
1867                 if (!ast_event_cache[i].hash_fn) {
1868                         /* This event type is not cached. */
1869                         continue;
1870                 }
1871
1872                 if (!(ast_event_cache[i].container = ao2_container_alloc(NUM_CACHE_BUCKETS,
1873                                 ast_event_hash, ast_event_cmp))) {
1874                         goto event_init_cleanup;
1875                 }
1876         }
1877
1878         if (!(event_dispatcher = ast_taskprocessor_get("core_event_dispatcher", 0))) {
1879                 goto event_init_cleanup;
1880         }
1881
1882         ast_cli_register_multiple(event_cli, ARRAY_LEN(event_cli));
1883
1884         ast_register_atexit(event_shutdown);
1885
1886         return 0;
1887
1888 event_init_cleanup:
1889         event_shutdown();
1890         return -1;
1891 }
1892
1893 size_t ast_event_minimum_length(void)
1894 {
1895         return sizeof(struct ast_event);
1896 }