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