Multiple revisions 369001-369002
[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 = 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 = 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         ao2_callback(ast_event_cache[event_sub->type].container, OBJ_NODATA,
667                         dump_cache_cb, (void *) event_sub);
668 }
669
670 static struct ast_event *gen_sub_event(struct ast_event_sub *sub)
671 {
672         struct ast_event_ie_val *ie_val;
673         struct ast_event *event;
674
675         event = ast_event_new(AST_EVENT_SUB,
676                 AST_EVENT_IE_UNIQUEID,    AST_EVENT_IE_PLTYPE_UINT, sub->uniqueid,
677                 AST_EVENT_IE_EVENTTYPE,   AST_EVENT_IE_PLTYPE_UINT, sub->type,
678                 AST_EVENT_IE_DESCRIPTION, AST_EVENT_IE_PLTYPE_STR, sub->description,
679                 AST_EVENT_IE_END);
680         if (!event)
681                 return NULL;
682
683         AST_LIST_TRAVERSE(&sub->ie_vals, ie_val, entry) {
684                 switch (ie_val->ie_pltype) {
685                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
686                         break;
687                 case AST_EVENT_IE_PLTYPE_EXISTS:
688                         ast_event_append_ie_uint(&event, AST_EVENT_IE_EXISTS, ie_val->ie_type);
689                         break;
690                 case AST_EVENT_IE_PLTYPE_UINT:
691                         ast_event_append_ie_uint(&event, ie_val->ie_type, ie_val->payload.uint);
692                         break;
693                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
694                         ast_event_append_ie_bitflags(&event, ie_val->ie_type, ie_val->payload.uint);
695                         break;
696                 case AST_EVENT_IE_PLTYPE_STR:
697                         ast_event_append_ie_str(&event, ie_val->ie_type, ie_val->payload.str);
698                         break;
699                 case AST_EVENT_IE_PLTYPE_RAW:
700                         ast_event_append_ie_raw(&event, ie_val->ie_type, ie_val->payload.raw, ie_val->raw_datalen);
701                         break;
702                 }
703                 if (!event)
704                         break;
705         }
706
707         return event;
708 }
709
710 /*! \brief Send AST_EVENT_SUB events to this subscriber of ... subscriber events */
711 void ast_event_report_subs(const struct ast_event_sub *event_sub)
712 {
713         struct ast_event *event;
714         struct ast_event_sub *sub;
715         enum ast_event_type event_type = -1;
716         struct ast_event_ie_val *ie_val;
717
718         if (event_sub->type != AST_EVENT_SUB)
719                 return;
720
721         AST_LIST_TRAVERSE(&event_sub->ie_vals, ie_val, entry) {
722                 if (ie_val->ie_type == AST_EVENT_IE_EVENTTYPE) {
723                         event_type = ie_val->payload.uint;
724                         break;
725                 }
726         }
727
728         if (event_type == -1)
729                 return;
730
731         AST_RWDLLIST_RDLOCK(&ast_event_subs[event_type]);
732         AST_RWDLLIST_TRAVERSE(&ast_event_subs[event_type], sub, entry) {
733                 if (event_sub == sub) {
734                         continue;
735                 }
736
737                 event = gen_sub_event(sub);
738                 if (!event) {
739                         continue;
740                 }
741
742                 event_sub->cb(event, event_sub->userdata);
743
744                 ast_event_destroy(event);
745         }
746         AST_RWDLLIST_UNLOCK(&ast_event_subs[event_type]);
747 }
748
749 struct ast_event_sub *ast_event_subscribe_new(enum ast_event_type type,
750         ast_event_cb_t cb, void *userdata)
751 {
752         struct ast_event_sub *sub;
753
754         if (type < 0 || type >= AST_EVENT_TOTAL) {
755                 ast_log(LOG_ERROR, "%u is an invalid type!\n", type);
756                 return NULL;
757         }
758
759         if (!(sub = ast_calloc(1, sizeof(*sub)))) {
760                 return NULL;
761         }
762
763         sub->type = type;
764         sub->cb = cb;
765         sub->userdata = userdata;
766         sub->uniqueid = ast_atomic_fetchadd_int((int *) &sub_uniqueid, 1);
767
768         return sub;
769 }
770
771 int ast_event_sub_append_ie_uint(struct ast_event_sub *sub,
772         enum ast_event_ie_type ie_type, uint32_t unsigned_int)
773 {
774         struct ast_event_ie_val *ie_val;
775
776         if (ie_type <= 0 || ie_type >= AST_EVENT_IE_TOTAL) {
777                 return -1;
778         }
779
780         if (!(ie_val = ast_calloc(1, sizeof(*ie_val)))) {
781                 return -1;
782         }
783
784         ie_val->ie_type = ie_type;
785         ie_val->payload.uint = unsigned_int;
786         ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_UINT;
787
788         AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
789
790         return 0;
791 }
792
793 int ast_event_sub_append_ie_bitflags(struct ast_event_sub *sub,
794         enum ast_event_ie_type ie_type, uint32_t flags)
795 {
796         struct ast_event_ie_val *ie_val;
797
798         if (ie_type <= 0 || ie_type >= AST_EVENT_IE_TOTAL) {
799                 return -1;
800         }
801
802         if (!(ie_val = ast_calloc(1, sizeof(*ie_val)))) {
803                 return -1;
804         }
805
806         ie_val->ie_type = ie_type;
807         ie_val->payload.uint = flags;
808         ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_BITFLAGS;
809
810         AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
811
812         return 0;
813 }
814
815 int ast_event_sub_append_ie_exists(struct ast_event_sub *sub,
816         enum ast_event_ie_type ie_type)
817 {
818         struct ast_event_ie_val *ie_val;
819
820         if (ie_type <= 0 || ie_type >= AST_EVENT_IE_TOTAL) {
821                 return -1;
822         }
823
824         if (!(ie_val = ast_calloc(1, sizeof(*ie_val)))) {
825                 return -1;
826         }
827
828         ie_val->ie_type = ie_type;
829         ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_EXISTS;
830
831         AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
832
833         return 0;
834 }
835
836 int ast_event_sub_append_ie_str(struct ast_event_sub *sub,
837         enum ast_event_ie_type ie_type, const char *str)
838 {
839         struct ast_event_ie_val *ie_val;
840
841         if (ie_type <= 0 || ie_type >= AST_EVENT_IE_TOTAL) {
842                 return -1;
843         }
844
845         if (!(ie_val = ast_calloc(1, sizeof(*ie_val)))) {
846                 return -1;
847         }
848
849         ie_val->ie_type = ie_type;
850         ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_STR;
851
852         if (!(ie_val->payload.str = ast_strdup(str))) {
853                 ast_free(ie_val);
854                 return -1;
855         }
856
857         if (ie_type == AST_EVENT_IE_DEVICE) {
858                 char *uppertech = ast_strdupa(str);
859                 ast_tech_to_upper(uppertech);
860                 ie_val->payload.hash = ast_str_hash(uppertech);
861         } else {
862                 ie_val->payload.hash = ast_str_hash(str);
863         }
864
865         AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
866
867         return 0;
868 }
869
870 int ast_event_sub_append_ie_raw(struct ast_event_sub *sub,
871         enum ast_event_ie_type ie_type, void *data, size_t raw_datalen)
872 {
873         struct ast_event_ie_val *ie_val;
874
875         if (ie_type <= 0 || ie_type >= AST_EVENT_IE_TOTAL) {
876                 return -1;
877         }
878
879         if (!(ie_val = ast_calloc(1, sizeof(*ie_val)))) {
880                 return -1;
881         }
882
883         ie_val->ie_type = ie_type;
884         ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_RAW;
885         ie_val->raw_datalen = raw_datalen;
886
887         if (!(ie_val->payload.raw = ast_malloc(raw_datalen))) {
888                 ast_free(ie_val);
889                 return -1;
890         }
891
892         memcpy(ie_val->payload.raw, data, raw_datalen);
893
894         AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
895
896         return 0;
897 }
898
899 int ast_event_sub_activate(struct ast_event_sub *sub)
900 {
901         if (ast_event_check_subscriber(AST_EVENT_SUB,
902                 AST_EVENT_IE_EVENTTYPE, AST_EVENT_IE_PLTYPE_UINT, sub->type,
903                 AST_EVENT_IE_END) != AST_EVENT_SUB_NONE) {
904                 struct ast_event *event;
905
906                 event = gen_sub_event(sub);
907                 if (event && ast_event_queue(event)) {
908                         ast_event_destroy(event);
909                 }
910         }
911
912         AST_RWDLLIST_WRLOCK(&ast_event_subs[sub->type]);
913         AST_RWDLLIST_INSERT_TAIL(&ast_event_subs[sub->type], sub, entry);
914         AST_RWDLLIST_UNLOCK(&ast_event_subs[sub->type]);
915
916         return 0;
917 }
918
919 struct ast_event_sub *ast_event_subscribe(enum ast_event_type type, ast_event_cb_t cb,
920         const char *description, void *userdata, ...)
921 {
922         va_list ap;
923         enum ast_event_ie_type ie_type;
924         struct ast_event_sub *sub;
925
926         if (!(sub = ast_event_subscribe_new(type, cb, userdata))) {
927                 return NULL;
928         }
929
930         ast_copy_string(sub->description, description, sizeof(sub->description));
931
932         va_start(ap, userdata);
933         for (ie_type = va_arg(ap, enum ast_event_ie_type);
934                 ie_type != AST_EVENT_IE_END;
935                 ie_type = va_arg(ap, enum ast_event_ie_type))
936         {
937                 enum ast_event_ie_pltype ie_pltype;
938
939                 ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
940
941                 switch (ie_pltype) {
942                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
943                         break;
944                 case AST_EVENT_IE_PLTYPE_UINT:
945                 {
946                         uint32_t unsigned_int = va_arg(ap, uint32_t);
947                         ast_event_sub_append_ie_uint(sub, ie_type, unsigned_int);
948                         break;
949                 }
950                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
951                 {
952                         uint32_t unsigned_int = va_arg(ap, uint32_t);
953                         ast_event_sub_append_ie_bitflags(sub, ie_type, unsigned_int);
954                         break;
955                 }
956                 case AST_EVENT_IE_PLTYPE_STR:
957                 {
958                         const char *str = va_arg(ap, const char *);
959                         ast_event_sub_append_ie_str(sub, ie_type, str);
960                         break;
961                 }
962                 case AST_EVENT_IE_PLTYPE_RAW:
963                 {
964                         void *data = va_arg(ap, void *);
965                         size_t data_len = va_arg(ap, size_t);
966                         ast_event_sub_append_ie_raw(sub, ie_type, data, data_len);
967                         break;
968                 }
969                 case AST_EVENT_IE_PLTYPE_EXISTS:
970                         ast_event_sub_append_ie_exists(sub, ie_type);
971                         break;
972                 }
973         }
974         va_end(ap);
975
976         ast_event_sub_activate(sub);
977
978         return sub;
979 }
980
981 void ast_event_sub_destroy(struct ast_event_sub *sub)
982 {
983         struct ast_event_ie_val *ie_val;
984
985         while ((ie_val = AST_LIST_REMOVE_HEAD(&sub->ie_vals, entry))) {
986                 ast_event_ie_val_destroy(ie_val);
987         }
988
989         ast_free(sub);
990 }
991
992 const char *ast_event_subscriber_get_description(struct ast_event_sub *sub)
993 {
994         return sub ? sub->description : NULL;
995 }
996
997 struct ast_event_sub *ast_event_unsubscribe(struct ast_event_sub *sub)
998 {
999         struct ast_event *event;
1000
1001         AST_RWDLLIST_WRLOCK(&ast_event_subs[sub->type]);
1002         AST_DLLIST_REMOVE(&ast_event_subs[sub->type], sub, entry);
1003         AST_RWDLLIST_UNLOCK(&ast_event_subs[sub->type]);
1004
1005         if (ast_event_check_subscriber(AST_EVENT_UNSUB,
1006                 AST_EVENT_IE_EVENTTYPE, AST_EVENT_IE_PLTYPE_UINT, sub->type,
1007                 AST_EVENT_IE_END) != AST_EVENT_SUB_NONE) {
1008
1009                 event = ast_event_new(AST_EVENT_UNSUB,
1010                         AST_EVENT_IE_UNIQUEID,    AST_EVENT_IE_PLTYPE_UINT, sub->uniqueid,
1011                         AST_EVENT_IE_EVENTTYPE,   AST_EVENT_IE_PLTYPE_UINT, sub->type,
1012                         AST_EVENT_IE_DESCRIPTION, AST_EVENT_IE_PLTYPE_STR, sub->description,
1013                         AST_EVENT_IE_END);
1014                 if (event && ast_event_queue(event)) {
1015                         ast_event_destroy(event);
1016                 }
1017         }
1018
1019         ast_event_sub_destroy(sub);
1020
1021         return NULL;
1022 }
1023
1024 int ast_event_iterator_init(struct ast_event_iterator *iterator, const struct ast_event *event)
1025 {
1026         int res = 0;
1027
1028         iterator->event_len = ast_event_get_size(event);
1029         iterator->event = event;
1030         if (iterator->event_len >= sizeof(*event) + sizeof(struct ast_event_ie)) {
1031                 iterator->ie = (struct ast_event_ie *) ( ((char *) event) + sizeof(*event) );
1032         } else {
1033                 iterator->ie = NULL;
1034                 res = -1;
1035         }
1036
1037         return res;
1038 }
1039
1040 int ast_event_iterator_next(struct ast_event_iterator *iterator)
1041 {
1042         iterator->ie = (struct ast_event_ie *) ( ((char *) iterator->ie) + sizeof(*iterator->ie) + ntohs(iterator->ie->ie_payload_len));
1043         return ((iterator->event_len <= (((char *) iterator->ie) - ((char *) iterator->event))) ? -1 : 0);
1044 }
1045
1046 enum ast_event_ie_type ast_event_iterator_get_ie_type(struct ast_event_iterator *iterator)
1047 {
1048         return ntohs(iterator->ie->ie_type);
1049 }
1050
1051 uint32_t ast_event_iterator_get_ie_uint(struct ast_event_iterator *iterator)
1052 {
1053         return ntohl(get_unaligned_uint32(iterator->ie->ie_payload));
1054 }
1055
1056 uint32_t ast_event_iterator_get_ie_bitflags(struct ast_event_iterator *iterator)
1057 {
1058         return ntohl(get_unaligned_uint32(iterator->ie->ie_payload));
1059 }
1060
1061 const char *ast_event_iterator_get_ie_str(struct ast_event_iterator *iterator)
1062 {
1063         const struct ast_event_ie_str_payload *str_payload;
1064
1065         str_payload = (struct ast_event_ie_str_payload *) iterator->ie->ie_payload;
1066
1067         return str_payload ? str_payload->str : NULL;
1068 }
1069
1070 void *ast_event_iterator_get_ie_raw(struct ast_event_iterator *iterator)
1071 {
1072         return iterator->ie->ie_payload;
1073 }
1074
1075 uint16_t ast_event_iterator_get_ie_raw_payload_len(struct ast_event_iterator *iterator)
1076 {
1077         return ntohs(iterator->ie->ie_payload_len);
1078 }
1079
1080 enum ast_event_type ast_event_get_type(const struct ast_event *event)
1081 {
1082         return ntohs(event->type);
1083 }
1084
1085 uint32_t ast_event_get_ie_uint(const struct ast_event *event, enum ast_event_ie_type ie_type)
1086 {
1087         const uint32_t *ie_val;
1088
1089         ie_val = ast_event_get_ie_raw(event, ie_type);
1090
1091         return ie_val ? ntohl(get_unaligned_uint32(ie_val)) : 0;
1092 }
1093
1094 uint32_t ast_event_get_ie_bitflags(const struct ast_event *event, enum ast_event_ie_type ie_type)
1095 {
1096         const uint32_t *ie_val;
1097
1098         ie_val = ast_event_get_ie_raw(event, ie_type);
1099
1100         return ie_val ? ntohl(get_unaligned_uint32(ie_val)) : 0;
1101 }
1102
1103 uint32_t ast_event_get_ie_str_hash(const struct ast_event *event, enum ast_event_ie_type ie_type)
1104 {
1105         const struct ast_event_ie_str_payload *str_payload;
1106
1107         str_payload = ast_event_get_ie_raw(event, ie_type);
1108
1109         return str_payload ? str_payload->hash : 0;
1110 }
1111
1112 const char *ast_event_get_ie_str(const struct ast_event *event, enum ast_event_ie_type ie_type)
1113 {
1114         const struct ast_event_ie_str_payload *str_payload;
1115
1116         str_payload = ast_event_get_ie_raw(event, ie_type);
1117
1118         return str_payload ? str_payload->str : NULL;
1119 }
1120
1121 const void *ast_event_get_ie_raw(const struct ast_event *event, enum ast_event_ie_type ie_type)
1122 {
1123         struct ast_event_iterator iterator;
1124         int res;
1125
1126         for (res = ast_event_iterator_init(&iterator, event); !res; res = ast_event_iterator_next(&iterator)) {
1127                 if (ast_event_iterator_get_ie_type(&iterator) == ie_type) {
1128                         return ast_event_iterator_get_ie_raw(&iterator);
1129                 }
1130         }
1131
1132         return NULL;
1133 }
1134
1135 uint16_t ast_event_get_ie_raw_payload_len(const struct ast_event *event, enum ast_event_ie_type ie_type)
1136 {
1137         struct ast_event_iterator iterator;
1138         int res;
1139
1140         for (res = ast_event_iterator_init(&iterator, event); !res; res = ast_event_iterator_next(&iterator)) {
1141                 if (ast_event_iterator_get_ie_type(&iterator) == ie_type) {
1142                         return ast_event_iterator_get_ie_raw_payload_len(&iterator);
1143                 }
1144         }
1145
1146         return 0;
1147 }
1148
1149 int ast_event_append_ie_str(struct ast_event **event, enum ast_event_ie_type ie_type,
1150         const char *str)
1151 {
1152         struct ast_event_ie_str_payload *str_payload;
1153         size_t payload_len;
1154
1155         payload_len = sizeof(*str_payload) + strlen(str);
1156         str_payload = alloca(payload_len);
1157
1158         strcpy(str_payload->str, str);
1159         if (ie_type == AST_EVENT_IE_DEVICE) {
1160                 char *uppertech = ast_strdupa(str);
1161                 ast_tech_to_upper(uppertech);
1162                 str_payload->hash = ast_str_hash(uppertech);
1163         } else {
1164                 str_payload->hash = ast_str_hash(str);
1165         }
1166
1167         return ast_event_append_ie_raw(event, ie_type, str_payload, payload_len);
1168 }
1169
1170 int ast_event_append_ie_uint(struct ast_event **event, enum ast_event_ie_type ie_type,
1171         uint32_t data)
1172 {
1173         data = htonl(data);
1174         return ast_event_append_ie_raw(event, ie_type, &data, sizeof(data));
1175 }
1176
1177 int ast_event_append_ie_bitflags(struct ast_event **event, enum ast_event_ie_type ie_type,
1178         uint32_t flags)
1179 {
1180         flags = htonl(flags);
1181         return ast_event_append_ie_raw(event, ie_type, &flags, sizeof(flags));
1182 }
1183
1184 int ast_event_append_ie_raw(struct ast_event **event, enum ast_event_ie_type ie_type,
1185         const void *data, size_t data_len)
1186 {
1187         struct ast_event_ie *ie;
1188         unsigned int extra_len;
1189         uint16_t event_len;
1190
1191         event_len = ntohs((*event)->event_len);
1192         extra_len = sizeof(*ie) + data_len;
1193
1194         if (!(*event = ast_realloc(*event, event_len + extra_len))) {
1195                 return -1;
1196         }
1197
1198         ie = (struct ast_event_ie *) ( ((char *) *event) + event_len );
1199         ie->ie_type = htons(ie_type);
1200         ie->ie_payload_len = htons(data_len);
1201         memcpy(ie->ie_payload, data, data_len);
1202
1203         (*event)->event_len = htons(event_len + extra_len);
1204
1205         return 0;
1206 }
1207
1208 struct ast_event *ast_event_new(enum ast_event_type type, ...)
1209 {
1210         va_list ap;
1211         struct ast_event *event;
1212         enum ast_event_ie_type ie_type;
1213         struct ast_event_ie_val *ie_val;
1214         int has_ie = 0;
1215         AST_LIST_HEAD_NOLOCK_STATIC(ie_vals, ast_event_ie_val);
1216
1217         /* Invalid type */
1218         if (type >= AST_EVENT_TOTAL) {
1219                 ast_log(LOG_WARNING, "Someone tried to create an event of invalid "
1220                         "type '%d'!\n", type);
1221                 return NULL;
1222         }
1223
1224         va_start(ap, type);
1225         for (ie_type = va_arg(ap, enum ast_event_ie_type);
1226                 ie_type != AST_EVENT_IE_END;
1227                 ie_type = va_arg(ap, enum ast_event_ie_type))
1228         {
1229                 struct ast_event_ie_val *ie_value = alloca(sizeof(*ie_value));
1230                 int insert = 0;
1231
1232                 memset(ie_value, 0, sizeof(*ie_value));
1233                 ie_value->ie_type = ie_type;
1234                 ie_value->ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
1235                 switch (ie_value->ie_pltype) {
1236                 case AST_EVENT_IE_PLTYPE_UINT:
1237                         ie_value->payload.uint = va_arg(ap, uint32_t);
1238                         insert = 1;
1239                         break;
1240                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
1241                         ie_value->payload.uint = va_arg(ap, uint32_t);
1242                         insert = 1;
1243                         break;
1244                 case AST_EVENT_IE_PLTYPE_STR:
1245                         ie_value->payload.str = va_arg(ap, const char *);
1246                         insert = 1;
1247                         break;
1248                 case AST_EVENT_IE_PLTYPE_RAW:
1249                 {
1250                         void *data = va_arg(ap, void *);
1251                         size_t datalen = va_arg(ap, size_t);
1252                         ie_value->payload.raw = alloca(datalen);
1253                         memcpy(ie_value->payload.raw, data, datalen);
1254                         ie_value->raw_datalen = datalen;
1255                         insert = 1;
1256                         break;
1257                 }
1258                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
1259                 case AST_EVENT_IE_PLTYPE_EXISTS:
1260                         break;
1261                 }
1262
1263                 if (insert) {
1264                         AST_LIST_INSERT_TAIL(&ie_vals, ie_value, entry);
1265                         has_ie = 1;
1266                 } else {
1267                         ast_log(LOG_WARNING, "Unsupported PLTYPE(%d)\n", ie_value->ie_pltype);
1268                 }
1269         }
1270         va_end(ap);
1271
1272         if (!(event = ast_calloc(1, sizeof(*event)))) {
1273                 return NULL;
1274         }
1275
1276         event->type = htons(type);
1277         event->event_len = htons(sizeof(*event));
1278
1279         AST_LIST_TRAVERSE(&ie_vals, ie_val, entry) {
1280                 switch (ie_val->ie_pltype) {
1281                 case AST_EVENT_IE_PLTYPE_STR:
1282                         ast_event_append_ie_str(&event, ie_val->ie_type, ie_val->payload.str);
1283                         break;
1284                 case AST_EVENT_IE_PLTYPE_UINT:
1285                         ast_event_append_ie_uint(&event, ie_val->ie_type, ie_val->payload.uint);
1286                         break;
1287                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
1288                         ast_event_append_ie_bitflags(&event, ie_val->ie_type, ie_val->payload.uint);
1289                         break;
1290                 case AST_EVENT_IE_PLTYPE_RAW:
1291                         ast_event_append_ie_raw(&event, ie_val->ie_type,
1292                                         ie_val->payload.raw, ie_val->raw_datalen);
1293                         break;
1294                 case AST_EVENT_IE_PLTYPE_EXISTS:
1295                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
1296                         break;
1297                 }
1298
1299                 /* realloc inside one of the append functions failed */
1300                 if (!event) {
1301                         return NULL;
1302                 }
1303         }
1304
1305         if (has_ie && !ast_event_get_ie_raw(event, AST_EVENT_IE_EID)) {
1306                 /* If the event is originating on this server, add the server's
1307                  * entity ID to the event. */
1308                 ast_event_append_eid(&event);
1309         }
1310
1311         return event;
1312 }
1313
1314 int ast_event_append_eid(struct ast_event **event)
1315 {
1316         return ast_event_append_ie_raw(event, AST_EVENT_IE_EID,
1317                         &ast_eid_default, sizeof(ast_eid_default));
1318 }
1319
1320 void ast_event_destroy(struct ast_event *event)
1321 {
1322         ast_free(event);
1323 }
1324
1325 static void ast_event_ref_destroy(void *obj)
1326 {
1327         struct ast_event_ref *event_ref = obj;
1328
1329         ast_event_destroy(event_ref->event);
1330 }
1331
1332 static struct ast_event *ast_event_dup(const struct ast_event *event)
1333 {
1334         struct ast_event *dup_event;
1335         uint16_t event_len;
1336
1337         event_len = ast_event_get_size(event);
1338
1339         if (!(dup_event = ast_calloc(1, event_len))) {
1340                 return NULL;
1341         }
1342
1343         memcpy(dup_event, event, event_len);
1344
1345         return dup_event;
1346 }
1347
1348 struct ast_event *ast_event_get_cached(enum ast_event_type type, ...)
1349 {
1350         va_list ap;
1351         enum ast_event_ie_type ie_type;
1352         struct ast_event *dup_event = NULL;
1353         struct ast_event_ref *cached_event_ref;
1354         struct ast_event *cache_arg_event;
1355         struct ast_event_ref tmp_event_ref = {
1356                 .event = NULL,
1357         };
1358         struct ao2_container *container = NULL;
1359
1360         if (type >= AST_EVENT_TOTAL) {
1361                 ast_log(LOG_ERROR, "%u is an invalid type!\n", type);
1362                 return NULL;
1363         }
1364
1365         if (!(container = ast_event_cache[type].container)) {
1366                 ast_log(LOG_ERROR, "%u is not a cached event type\n", type);
1367                 return NULL;
1368         }
1369
1370         if (!(cache_arg_event = ast_event_new(type, AST_EVENT_IE_END))) {
1371                 return NULL;
1372         }
1373
1374         va_start(ap, type);
1375         for (ie_type = va_arg(ap, enum ast_event_ie_type);
1376                 ie_type != AST_EVENT_IE_END;
1377                 ie_type = va_arg(ap, enum ast_event_ie_type))
1378         {
1379                 enum ast_event_ie_pltype ie_pltype;
1380
1381                 ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
1382
1383                 switch (ie_pltype) {
1384                 case AST_EVENT_IE_PLTYPE_UINT:
1385                         ast_event_append_ie_uint(&cache_arg_event, ie_type, va_arg(ap, uint32_t));
1386                         break;
1387                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
1388                         ast_event_append_ie_bitflags(&cache_arg_event, ie_type, va_arg(ap, uint32_t));
1389                         break;
1390                 case AST_EVENT_IE_PLTYPE_STR:
1391                         ast_event_append_ie_str(&cache_arg_event, ie_type, va_arg(ap, const char *));
1392                         break;
1393                 case AST_EVENT_IE_PLTYPE_RAW:
1394                 {
1395                         void *data = va_arg(ap, void *);
1396                         size_t datalen = va_arg(ap, size_t);
1397                         ast_event_append_ie_raw(&cache_arg_event, ie_type, data, datalen);
1398                         break;
1399                 }
1400                 case AST_EVENT_IE_PLTYPE_EXISTS:
1401                         ast_log(LOG_WARNING, "PLTYPE_EXISTS not supported by this function\n");
1402                         break;
1403                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
1404                         break;
1405                 }
1406         }
1407         va_end(ap);
1408
1409         tmp_event_ref.event = cache_arg_event;
1410
1411         cached_event_ref = ao2_find(container, &tmp_event_ref, OBJ_POINTER);
1412
1413         ast_event_destroy(cache_arg_event);
1414         cache_arg_event = NULL;
1415
1416         if (cached_event_ref) {
1417                 dup_event = ast_event_dup(cached_event_ref->event);
1418                 ao2_ref(cached_event_ref, -1);
1419                 cached_event_ref = NULL;
1420         }
1421
1422         return dup_event;
1423 }
1424
1425 static struct ast_event_ref *alloc_event_ref(void)
1426 {
1427         return ao2_alloc(sizeof(struct ast_event_ref), ast_event_ref_destroy);
1428 }
1429
1430 /*!
1431  * \internal
1432  * \brief Update the given event cache with the new event.
1433  * \since 1.8
1434  *
1435  * \param cache Event cache container to update.
1436  * \param event New event to put in the cache.
1437  *
1438  * \return Nothing
1439  */
1440 static void event_update_cache(struct ao2_container *cache, struct ast_event *event)
1441 {
1442         struct ast_event_ref tmp_event_ref = {
1443                 .event = event,
1444         };
1445         struct ast_event *dup_event;
1446         struct ast_event_ref *event_ref;
1447
1448         /* Hold the cache container lock while it is updated. */
1449         ao2_lock(cache);
1450
1451         /* Remove matches from the cache. */
1452         ao2_callback(cache, OBJ_POINTER | OBJ_UNLINK | OBJ_MULTIPLE | OBJ_NODATA,
1453                 ast_event_cmp, &tmp_event_ref);
1454
1455         /* Save a copy of the event in the cache. */
1456         dup_event = ast_event_dup(event);
1457         if (dup_event) {
1458                 event_ref = alloc_event_ref();
1459                 if (event_ref) {
1460                         event_ref->event = dup_event;
1461                         ao2_link(cache, event_ref);
1462                         ao2_ref(event_ref, -1);
1463                 } else {
1464                         ast_event_destroy(dup_event);
1465                 }
1466         }
1467
1468         ao2_unlock(cache);
1469 }
1470
1471 int ast_event_queue_and_cache(struct ast_event *event)
1472 {
1473         struct ao2_container *container;
1474
1475         container = ast_event_cache[ast_event_get_type(event)].container;
1476         if (!container) {
1477                 ast_log(LOG_WARNING, "cache requested for non-cached event type\n");
1478         } else {
1479                 event_update_cache(container, event);
1480         }
1481
1482         if (ast_event_queue(event)) {
1483                 ast_event_destroy(event);
1484         }
1485         return 0;
1486 }
1487
1488 static int handle_event(void *data)
1489 {
1490         struct ast_event_ref *event_ref = data;
1491         struct ast_event_sub *sub;
1492         const enum ast_event_type event_types[] = {
1493                 ntohs(event_ref->event->type),
1494                 AST_EVENT_ALL
1495         };
1496         int i;
1497
1498         for (i = 0; i < ARRAY_LEN(event_types); i++) {
1499                 AST_RWDLLIST_RDLOCK(&ast_event_subs[event_types[i]]);
1500                 AST_RWDLLIST_TRAVERSE(&ast_event_subs[event_types[i]], sub, entry) {
1501                         struct ast_event_ie_val *ie_val;
1502
1503                         AST_LIST_TRAVERSE(&sub->ie_vals, ie_val, entry) {
1504                                 if (!match_ie_val(event_ref->event, ie_val, NULL)) {
1505                                         /* The current subscription ie did not match an event ie. */
1506                                         break;
1507                                 }
1508                         }
1509                         if (ie_val) {
1510                                 /* The event did not match this subscription. */
1511                                 continue;
1512                         }
1513                         sub->cb(event_ref->event, sub->userdata);
1514                 }
1515                 AST_RWDLLIST_UNLOCK(&ast_event_subs[event_types[i]]);
1516         }
1517
1518         ao2_ref(event_ref, -1);
1519
1520         return 0;
1521 }
1522
1523 int ast_event_queue(struct ast_event *event)
1524 {
1525         struct ast_event_ref *event_ref;
1526         uint16_t host_event_type;
1527         int res;
1528
1529         host_event_type = ntohs(event->type);
1530
1531         /* Invalid type */
1532         if (host_event_type >= AST_EVENT_TOTAL) {
1533                 ast_log(LOG_WARNING, "Someone tried to queue an event of invalid "
1534                         "type '%d'!\n", host_event_type);
1535                 return -1;
1536         }
1537
1538         /* If nobody has subscribed to this event type, throw it away now */
1539         if (ast_event_check_subscriber(host_event_type, AST_EVENT_IE_END)
1540                         == AST_EVENT_SUB_NONE) {
1541                 ast_event_destroy(event);
1542                 return 0;
1543         }
1544
1545         if (!(event_ref = alloc_event_ref())) {
1546                 return -1;
1547         }
1548
1549         event_ref->event = event;
1550
1551         res = ast_taskprocessor_push(event_dispatcher, handle_event, event_ref);
1552         if (res) {
1553                 event_ref->event = NULL;
1554                 ao2_ref(event_ref, -1);
1555         }
1556         return res;
1557 }
1558
1559 static int ast_event_hash_mwi(const void *obj, const int flags)
1560 {
1561         const struct ast_event *event = obj;
1562         const char *mailbox = ast_event_get_ie_str(event, AST_EVENT_IE_MAILBOX);
1563         const char *context = ast_event_get_ie_str(event, AST_EVENT_IE_CONTEXT);
1564
1565         return ast_str_hash_add(context, ast_str_hash(mailbox));
1566 }
1567
1568 /*!
1569  * \internal
1570  * \brief Hash function for AST_EVENT_DEVICE_STATE
1571  *
1572  * \param[in] obj an ast_event
1573  * \param[in] flags unused
1574  *
1575  * \return hash value
1576  */
1577 static int ast_event_hash_devstate(const void *obj, const int flags)
1578 {
1579         const struct ast_event *event = obj;
1580
1581         return ast_str_hash(ast_event_get_ie_str(event, AST_EVENT_IE_DEVICE));
1582 }
1583
1584 /*!
1585  * \internal
1586  * \brief Hash function for AST_EVENT_DEVICE_STATE_CHANGE
1587  *
1588  * \param[in] obj an ast_event
1589  * \param[in] flags unused
1590  *
1591  * \return hash value
1592  */
1593 static int ast_event_hash_devstate_change(const void *obj, const int flags)
1594 {
1595         const struct ast_event *event = obj;
1596
1597         return ast_str_hash(ast_event_get_ie_str(event, AST_EVENT_IE_DEVICE));
1598 }
1599
1600 /*!
1601  * \internal
1602  * \brief Hash function for AST_EVENT_PRESENCE_STATE
1603  *
1604  * \param[in] obj an ast_event
1605  * \param[in] flags unused
1606  *
1607  * \return hash value
1608  */
1609 static int ast_event_hash_presence_state_change(const void *obj, const int flags)
1610 {
1611         const struct ast_event *event = obj;
1612
1613         return ast_str_hash(ast_event_get_ie_str(event, AST_EVENT_IE_PRESENCE_PROVIDER));
1614 }
1615
1616 static int ast_event_hash(const void *obj, const int flags)
1617 {
1618         const struct ast_event_ref *event_ref;
1619         const struct ast_event *event;
1620         ao2_hash_fn *hash_fn;
1621
1622         event_ref = obj;
1623         event = event_ref->event;
1624
1625         if (!(hash_fn = ast_event_cache[ast_event_get_type(event)].hash_fn)) {
1626                 return 0;
1627         }
1628
1629         return hash_fn(event, flags);
1630 }
1631
1632 /*!
1633  * \internal
1634  * \brief Compare two events
1635  *
1636  * \param[in] obj the first event, as an ast_event_ref
1637  * \param[in] arg the second event, as an ast_event_ref
1638  * \param[in] flags unused
1639  *
1640  * \pre Both events must be the same type.
1641  * \pre The event type must be declared as a cached event type in ast_event_cache
1642  *
1643  * \details This function takes two events, and determines if they are considered
1644  * equivalent.  The values of information elements specified in the cache arguments
1645  * for the event type are used to determine if the events are equivalent.
1646  *
1647  * \retval 0 No match
1648  * \retval CMP_MATCH The events are considered equivalent based on the cache arguments
1649  */
1650 static int ast_event_cmp(void *obj, void *arg, int flags)
1651 {
1652         struct ast_event_ref *event_ref, *event_ref2;
1653         struct ast_event *event, *event2;
1654         int res = CMP_MATCH;
1655         int i;
1656         enum ast_event_ie_type *cache_args;
1657
1658         event_ref = obj;
1659         event = event_ref->event;
1660
1661         event_ref2 = arg;
1662         event2 = event_ref2->event;
1663
1664         cache_args = ast_event_cache[ast_event_get_type(event)].cache_args;
1665
1666         for (i = 0; i < ARRAY_LEN(ast_event_cache[0].cache_args) && cache_args[i]; i++) {
1667                 struct ast_event_ie_val ie_val = {
1668                         .ie_pltype = ast_event_get_ie_pltype(cache_args[i]),
1669                         .ie_type = cache_args[i],
1670                 };
1671
1672                 if (!match_ie_val(event, &ie_val, event2)) {
1673                         res = 0;
1674                         break;
1675                 }
1676         }
1677
1678         return res;
1679 }
1680
1681 static void dump_raw_ie(struct ast_event_iterator *i, struct ast_cli_args *a)
1682 {
1683         char eid_buf[32];
1684         enum ast_event_ie_type ie_type;
1685         const char *ie_type_name;
1686
1687         ie_type = ast_event_iterator_get_ie_type(i);
1688         ie_type_name = ast_event_get_ie_type_name(ie_type);
1689
1690         switch (ie_type) {
1691         case AST_EVENT_IE_EID:
1692                 ast_eid_to_str(eid_buf, sizeof(eid_buf), ast_event_iterator_get_ie_raw(i));
1693                 ast_cli(a->fd, "%.30s: %s\n", ie_type_name, eid_buf);
1694                 break;
1695         default:
1696                 ast_cli(a->fd, "%s\n", ie_type_name);
1697                 break;
1698         }
1699 }
1700
1701 static int event_dump_cli(void *obj, void *arg, int flags)
1702 {
1703         const struct ast_event_ref *event_ref = obj;
1704         const struct ast_event *event = event_ref->event;
1705         struct ast_cli_args *a = arg;
1706         struct ast_event_iterator i;
1707
1708         if (ast_event_iterator_init(&i, event)) {
1709                 ast_cli(a->fd, "Failed to initialize event iterator.  :-(\n");
1710                 return 0;
1711         }
1712
1713         ast_cli(a->fd, "Event: %s\n", ast_event_get_type_name(event));
1714
1715         do {
1716                 enum ast_event_ie_type ie_type;
1717                 enum ast_event_ie_pltype ie_pltype;
1718                 const char *ie_type_name;
1719
1720                 ie_type = ast_event_iterator_get_ie_type(&i);
1721                 ie_type_name = ast_event_get_ie_type_name(ie_type);
1722                 ie_pltype = ast_event_get_ie_pltype(ie_type);
1723
1724                 switch (ie_pltype) {
1725                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
1726                 case AST_EVENT_IE_PLTYPE_EXISTS:
1727                         ast_cli(a->fd, "%s\n", ie_type_name);
1728                         break;
1729                 case AST_EVENT_IE_PLTYPE_STR:
1730                         ast_cli(a->fd, "%.30s: %s\n", ie_type_name,
1731                                         ast_event_iterator_get_ie_str(&i));
1732                         break;
1733                 case AST_EVENT_IE_PLTYPE_UINT:
1734                         ast_cli(a->fd, "%.30s: %u\n", ie_type_name,
1735                                         ast_event_iterator_get_ie_uint(&i));
1736                         break;
1737                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
1738                         ast_cli(a->fd, "%.30s: %u\n", ie_type_name,
1739                                         ast_event_iterator_get_ie_bitflags(&i));
1740                         break;
1741                 case AST_EVENT_IE_PLTYPE_RAW:
1742                         dump_raw_ie(&i, a);
1743                         break;
1744                 }
1745         } while (!ast_event_iterator_next(&i));
1746
1747         ast_cli(a->fd, "\n");
1748
1749         return 0;
1750 }
1751
1752 static char *event_dump_cache(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1753 {
1754         enum ast_event_type event_type;
1755         enum ast_event_ie_type *cache_args;
1756         int i;
1757
1758         switch (cmd) {
1759         case CLI_INIT:
1760                 e->command = "event dump cache";
1761                 e->usage =
1762                         "Usage: event dump cache <event type>\n"
1763                         "       Dump all of the cached events for the given event type.\n"
1764                         "       This is primarily intended for debugging.\n";
1765                 return NULL;
1766         case CLI_GENERATE:
1767                 if (a->pos == 3) {
1768                         return ast_cli_complete(a->word, cached_event_types, a->n);
1769                 }
1770                 return NULL;
1771         case CLI_HANDLER:
1772                 break;
1773         }
1774
1775         if (a->argc != e->args + 1) {
1776                 return CLI_SHOWUSAGE;
1777         }
1778
1779         if (ast_event_str_to_event_type(a->argv[e->args], &event_type)) {
1780                 ast_cli(a->fd, "Invalid cached event type: '%s'\n", a->argv[e->args]);
1781                 return CLI_SHOWUSAGE;
1782         }
1783
1784         if (!ast_event_cache[event_type].container) {
1785                 ast_cli(a->fd, "Event type '%s' has no cache.\n", a->argv[e->args]);
1786                 return CLI_SUCCESS;
1787         }
1788
1789         ast_cli(a->fd, "Event Type: %s\n", a->argv[e->args]);
1790         ast_cli(a->fd, "Cache Unique Keys:\n");
1791         cache_args = ast_event_cache[event_type].cache_args;
1792         for (i = 0; i < ARRAY_LEN(ast_event_cache[0].cache_args) && cache_args[i]; i++) {
1793                 ast_cli(a->fd, "--> %s\n", ast_event_get_ie_type_name(cache_args[i]));
1794         }
1795
1796         ast_cli(a->fd, "\n--- Begin Cache Dump ---\n\n");
1797         ao2_callback(ast_event_cache[event_type].container, OBJ_NODATA, event_dump_cli, a);
1798         ast_cli(a->fd, "--- End Cache Dump ---\n\n");
1799
1800         return CLI_SUCCESS;
1801 }
1802
1803 static struct ast_cli_entry event_cli[] = {
1804         AST_CLI_DEFINE(event_dump_cache, "Dump the internal event cache (for debugging)"),
1805 };
1806
1807 int ast_event_init(void)
1808 {
1809         int i;
1810
1811         for (i = 0; i < AST_EVENT_TOTAL; i++) {
1812                 AST_RWDLLIST_HEAD_INIT(&ast_event_subs[i]);
1813         }
1814
1815         for (i = 0; i < AST_EVENT_TOTAL; i++) {
1816                 if (!ast_event_cache[i].hash_fn) {
1817                         /* This event type is not cached. */
1818                         continue;
1819                 }
1820
1821                 if (!(ast_event_cache[i].container = ao2_container_alloc(NUM_CACHE_BUCKETS,
1822                                 ast_event_hash, ast_event_cmp))) {
1823                         return -1;
1824                 }
1825         }
1826
1827         if (!(event_dispatcher = ast_taskprocessor_get("core_event_dispatcher", 0))) {
1828                 return -1;
1829         }
1830
1831         ast_cli_register_multiple(event_cli, ARRAY_LEN(event_cli));
1832
1833         return 0;
1834 }
1835
1836 size_t ast_event_minimum_length(void)
1837 {
1838         return sizeof(struct ast_event);
1839 }