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