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