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