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