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