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