Kill off red blobs in most of main/*
[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         [AST_EVENT_IE_RECEIVED_CHALLENGE]  = { AST_EVENT_IE_PLTYPE_STR,  "ReceivedChallenge" },
268         [AST_EVENT_IE_RECEIVED_HASH]       = { AST_EVENT_IE_PLTYPE_STR,  "ReceivedHash" },
269         [AST_EVENT_IE_USING_PASSWORD]      = { AST_EVENT_IE_PLTYPE_UINT, "UsingPassword" },
270
271 };
272
273 const char *ast_event_get_type_name(const struct ast_event *event)
274 {
275         enum ast_event_type type;
276
277         type = ast_event_get_type(event);
278
279         if (type < 0 || type >= ARRAY_LEN(event_names)) {
280                 ast_log(LOG_ERROR, "Invalid event type - '%d'\n", type);
281                 return "";
282         }
283
284         return event_names[type];
285 }
286
287 int ast_event_str_to_event_type(const char *str, enum ast_event_type *event_type)
288 {
289         int i;
290
291         for (i = 0; i < ARRAY_LEN(event_names); i++) {
292                 if (ast_strlen_zero(event_names[i]) || strcasecmp(event_names[i], str)) {
293                         continue;
294                 }
295
296                 *event_type = i;
297                 return 0;
298         }
299
300         return -1;
301 }
302
303 const char *ast_event_get_ie_type_name(enum ast_event_ie_type ie_type)
304 {
305         if (ie_type <= 0 || ie_type >= ARRAY_LEN(ie_maps)) {
306                 ast_log(LOG_ERROR, "Invalid IE type - '%d'\n", ie_type);
307                 return "";
308         }
309
310         return ie_maps[ie_type].name;
311 }
312
313 enum ast_event_ie_pltype ast_event_get_ie_pltype(enum ast_event_ie_type ie_type)
314 {
315         if (ie_type <= 0 || ie_type >= ARRAY_LEN(ie_maps)) {
316                 ast_log(LOG_ERROR, "Invalid IE type - '%d'\n", ie_type);
317                 return AST_EVENT_IE_PLTYPE_UNKNOWN;
318         }
319
320         return ie_maps[ie_type].ie_pltype;
321 }
322
323 int ast_event_str_to_ie_type(const char *str, enum ast_event_ie_type *ie_type)
324 {
325         int i;
326
327         for (i = 0; i < ARRAY_LEN(ie_maps); i++) {
328                 if (strcasecmp(ie_maps[i].name, str)) {
329                         continue;
330                 }
331
332                 *ie_type = i;
333                 return 0;
334         }
335
336         return -1;
337 }
338
339 size_t ast_event_get_size(const struct ast_event *event)
340 {
341         size_t res;
342
343         res = ntohs(event->event_len);
344
345         return res;
346 }
347
348 static void ast_event_ie_val_destroy(struct ast_event_ie_val *ie_val)
349 {
350         switch (ie_val->ie_pltype) {
351         case AST_EVENT_IE_PLTYPE_STR:
352                 ast_free((char *) ie_val->payload.str);
353                 break;
354         case AST_EVENT_IE_PLTYPE_RAW:
355                 ast_free(ie_val->payload.raw);
356                 break;
357         case AST_EVENT_IE_PLTYPE_UINT:
358         case AST_EVENT_IE_PLTYPE_BITFLAGS:
359         case AST_EVENT_IE_PLTYPE_EXISTS:
360         case AST_EVENT_IE_PLTYPE_UNKNOWN:
361                 break;
362         }
363
364         ast_free(ie_val);
365 }
366
367 /*! \brief Subscription event check list. */
368 struct ast_ev_check_list {
369         AST_LIST_HEAD_NOLOCK(, ast_event_ie_val) ie_vals;
370 };
371
372 /*!
373  * \internal
374  * \brief Check if a subscription ie_val matches an event.
375  *
376  * \param sub_ie_val Subscripton IE value to check
377  * \param check_ie_vals event list to check against
378  *
379  * \retval 0 not matched
380  * \retval non-zero matched
381  */
382 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)
383 {
384         const struct ast_event_ie_val *event_ie_val;
385         int res = 0;
386
387         AST_LIST_TRAVERSE(&check_ie_vals->ie_vals, event_ie_val, entry) {
388                 if (sub_ie_val->ie_type == event_ie_val->ie_type) {
389                         break;
390                 }
391         }
392         if (!event_ie_val) {
393                 /* We did not find the event ie the subscriber cares about. */
394                 return 0;
395         }
396
397         if (sub_ie_val->ie_pltype != event_ie_val->ie_pltype) {
398                 if (sub_ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_EXISTS) {
399                         /* The subscription only cares that this ie exists. */
400                         return 1;
401                 }
402                 /* Payload types do not match. */
403                 return 0;
404         }
405
406         switch (sub_ie_val->ie_pltype) {
407         case AST_EVENT_IE_PLTYPE_UINT:
408                 res = (sub_ie_val->payload.uint == event_ie_val->payload.uint);
409                 break;
410         case AST_EVENT_IE_PLTYPE_BITFLAGS:
411                 /*
412                  * If the subscriber has requested *any* of the bitflags we are providing,
413                  * then it's a match.
414                  */
415                 res = (sub_ie_val->payload.uint & event_ie_val->payload.uint);
416                 break;
417         case AST_EVENT_IE_PLTYPE_STR:
418         {
419                 const char *substr = sub_ie_val->payload.str;
420                 const char *estr = event_ie_val->payload.str;
421                 if (sub_ie_val->ie_type == AST_EVENT_IE_DEVICE) {
422                         substr = ast_tech_to_upper(ast_strdupa(substr));
423                         estr = ast_tech_to_upper(ast_strdupa(estr));
424                 }
425                 res = !strcmp(substr, estr);
426                 break;
427         }
428         case AST_EVENT_IE_PLTYPE_RAW:
429                 res = (sub_ie_val->raw_datalen == event_ie_val->raw_datalen
430                         && !memcmp(sub_ie_val->payload.raw, event_ie_val->payload.raw,
431                                 sub_ie_val->raw_datalen));
432                 break;
433         case AST_EVENT_IE_PLTYPE_EXISTS:
434                 /* Should never get here since check_ie_vals cannot have this type. */
435                 break;
436         case AST_EVENT_IE_PLTYPE_UNKNOWN:
437                 /*
438                  * Should never be in a subscription event ie val list and
439                  * check_ie_vals cannot have this type either.
440                  */
441                 break;
442         }
443
444         return res;
445 }
446
447 enum ast_event_subscriber_res ast_event_check_subscriber(enum ast_event_type type, ...)
448 {
449         va_list ap;
450         enum ast_event_ie_type ie_type;
451         enum ast_event_subscriber_res res = AST_EVENT_SUB_NONE;
452         struct ast_event_ie_val *ie_val;
453         struct ast_event_sub *sub;
454         struct ast_ev_check_list check_ie_vals = {
455                 .ie_vals = AST_LIST_HEAD_NOLOCK_INIT_VALUE
456         };
457         const enum ast_event_type event_types[] = { type, AST_EVENT_ALL };
458         int i;
459         int want_specific_event;/* TRUE if looking for subscribers wanting specific parameters. */
460
461         if (type >= AST_EVENT_TOTAL) {
462                 ast_log(LOG_ERROR, "%u is an invalid type!\n", type);
463                 return res;
464         }
465
466         want_specific_event = 0;
467         va_start(ap, type);
468         for (ie_type = va_arg(ap, enum ast_event_ie_type);
469                 ie_type != AST_EVENT_IE_END;
470                 ie_type = va_arg(ap, enum ast_event_ie_type))
471         {
472                 struct ast_event_ie_val *ie_value = alloca(sizeof(*ie_value));
473                 int insert = 0;
474
475                 memset(ie_value, 0, sizeof(*ie_value));
476                 ie_value->ie_type = ie_type;
477                 ie_value->ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
478                 switch (ie_value->ie_pltype) {
479                 case AST_EVENT_IE_PLTYPE_UINT:
480                         ie_value->payload.uint = va_arg(ap, uint32_t);
481                         insert = 1;
482                         break;
483                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
484                         ie_value->payload.uint = va_arg(ap, uint32_t);
485                         insert = 1;
486                         break;
487                 case AST_EVENT_IE_PLTYPE_STR:
488                         ie_value->payload.str = va_arg(ap, const char *);
489                         insert = 1;
490                         break;
491                 case AST_EVENT_IE_PLTYPE_RAW:
492                 {
493                         void *data = va_arg(ap, void *);
494                         size_t datalen = va_arg(ap, size_t);
495
496                         ie_value->payload.raw = alloca(datalen);
497                         memcpy(ie_value->payload.raw, data, datalen);
498                         ie_value->raw_datalen = datalen;
499                         insert = 1;
500                         break;
501                 }
502                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
503                 case AST_EVENT_IE_PLTYPE_EXISTS:
504                         /* Unsupported payload type. */
505                         break;
506                 }
507
508                 if (insert) {
509                         want_specific_event = 1;
510                         AST_LIST_INSERT_TAIL(&check_ie_vals.ie_vals, ie_value, entry);
511                 } else {
512                         ast_log(LOG_WARNING, "Unsupported PLTYPE(%d)\n", ie_value->ie_pltype);
513                 }
514         }
515         va_end(ap);
516
517         for (i = 0; i < ARRAY_LEN(event_types); i++) {
518                 AST_RWDLLIST_RDLOCK(&ast_event_subs[event_types[i]]);
519                 if (want_specific_event) {
520                         AST_RWDLLIST_TRAVERSE(&ast_event_subs[event_types[i]], sub, entry) {
521                                 AST_LIST_TRAVERSE(&sub->ie_vals, ie_val, entry) {
522                                         if (!match_sub_ie_val_to_event(ie_val, &check_ie_vals)) {
523                                                 /* The current subscription ie did not match an event ie. */
524                                                 break;
525                                         }
526                                 }
527                                 if (!ie_val) {
528                                         /* Everything matched.  A subscriber is looking for this event. */
529                                         break;
530                                 }
531                         }
532                 } else {
533                         /* Just looking to see if there are ANY subscribers to the event type. */
534                         sub = AST_RWLIST_FIRST(&ast_event_subs[event_types[i]]);
535                 }
536                 AST_RWDLLIST_UNLOCK(&ast_event_subs[event_types[i]]);
537                 if (sub) {
538                         break;
539                 }
540         }
541
542         return sub ? AST_EVENT_SUB_EXISTS : AST_EVENT_SUB_NONE;
543 }
544
545 /*!
546  * \internal
547  * \brief Check if an ie_val matches an event
548  *
549  * \param event event to check against
550  * \param ie_val IE value to check
551  * \param event2 optional event, if specified, the value to compare against will be pulled
552  *        from this event instead of from the ie_val structure.  In this case, only the IE
553  *        type and payload type will be pulled from ie_val.
554  *
555  * \retval 0 not matched
556  * \retval non-zero matched
557  */
558 static int match_ie_val(const struct ast_event *event,
559                 const struct ast_event_ie_val *ie_val, const struct ast_event *event2)
560 {
561         switch (ie_val->ie_pltype) {
562         case AST_EVENT_IE_PLTYPE_UINT:
563         {
564                 uint32_t val = event2 ? ast_event_get_ie_uint(event2, ie_val->ie_type) : ie_val->payload.uint;
565
566                 return (val == ast_event_get_ie_uint(event, ie_val->ie_type)) ? 1 : 0;
567         }
568
569         case AST_EVENT_IE_PLTYPE_BITFLAGS:
570         {
571                 uint32_t flags = event2 ? ast_event_get_ie_uint(event2, ie_val->ie_type) : ie_val->payload.uint;
572
573                 /*
574                  * If the subscriber has requested *any* of the bitflags that this event provides,
575                  * then it's a match.
576                  */
577                 return (flags & ast_event_get_ie_bitflags(event, ie_val->ie_type)) ? 1 : 0;
578         }
579
580         case AST_EVENT_IE_PLTYPE_STR:
581         {
582                 const char *str;
583                 uint32_t hash;
584
585                 hash = event2 ? ast_event_get_ie_str_hash(event2, ie_val->ie_type) : ie_val->payload.hash;
586                 if (hash != ast_event_get_ie_str_hash(event, ie_val->ie_type)) {
587                         return 0;
588                 }
589
590                 str = event2 ? ast_event_get_ie_str(event2, ie_val->ie_type) : ie_val->payload.str;
591                 if (str) {
592                         const char *e1str, *e2str;
593                         e1str = ast_event_get_ie_str(event, ie_val->ie_type);
594                         e2str = str;
595
596                         if (ie_val->ie_type == AST_EVENT_IE_DEVICE) {
597                                 e1str = ast_tech_to_upper(ast_strdupa(e1str));
598                                 e2str = ast_tech_to_upper(ast_strdupa(e2str));
599                         }
600
601                         if (!strcmp(e1str, e2str)) {
602                                 return 1;
603                         }
604                 }
605
606                 return 0;
607         }
608
609         case AST_EVENT_IE_PLTYPE_RAW:
610         {
611                 const void *buf = event2 ? ast_event_get_ie_raw(event2, ie_val->ie_type) : ie_val->payload.raw;
612                 uint16_t ie_payload_len = event2 ? ast_event_get_ie_raw_payload_len(event2, ie_val->ie_type) : ie_val->raw_datalen;
613
614                 return (buf
615                         && ie_payload_len == ast_event_get_ie_raw_payload_len(event, ie_val->ie_type)
616                         && !memcmp(buf, ast_event_get_ie_raw(event, ie_val->ie_type), ie_payload_len)) ? 1 : 0;
617         }
618
619         case AST_EVENT_IE_PLTYPE_EXISTS:
620         {
621                 return ast_event_get_ie_raw(event, ie_val->ie_type) ? 1 : 0;
622         }
623
624         case AST_EVENT_IE_PLTYPE_UNKNOWN:
625                 return 0;
626         }
627
628         return 0;
629 }
630
631 static int dump_cache_cb(void *obj, void *arg, int flags)
632 {
633         const struct ast_event_ref *event_ref = obj;
634         const struct ast_event *event = event_ref->event;
635         const struct ast_event_sub *event_sub = arg;
636         struct ast_event_ie_val *ie_val = NULL;
637
638         AST_LIST_TRAVERSE(&event_sub->ie_vals, ie_val, entry) {
639                 if (!match_ie_val(event, ie_val, NULL)) {
640                         break;
641                 }
642         }
643
644         if (!ie_val) {
645                 /* All parameters were matched on this cache entry, so dump it */
646                 event_sub->cb(event, event_sub->userdata);
647         }
648
649         return 0;
650 }
651
652 /*! \brief Dump the event cache for the subscribed event type */
653 void ast_event_dump_cache(const struct ast_event_sub *event_sub)
654 {
655         ao2_callback(ast_event_cache[event_sub->type].container, OBJ_NODATA,
656                         dump_cache_cb, (void *) event_sub);
657 }
658
659 static struct ast_event *gen_sub_event(struct ast_event_sub *sub)
660 {
661         struct ast_event_ie_val *ie_val;
662         struct ast_event *event;
663
664         event = ast_event_new(AST_EVENT_SUB,
665                 AST_EVENT_IE_UNIQUEID,    AST_EVENT_IE_PLTYPE_UINT, sub->uniqueid,
666                 AST_EVENT_IE_EVENTTYPE,   AST_EVENT_IE_PLTYPE_UINT, sub->type,
667                 AST_EVENT_IE_DESCRIPTION, AST_EVENT_IE_PLTYPE_STR, sub->description,
668                 AST_EVENT_IE_END);
669         if (!event)
670                 return NULL;
671
672         AST_LIST_TRAVERSE(&sub->ie_vals, ie_val, entry) {
673                 switch (ie_val->ie_pltype) {
674                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
675                         break;
676                 case AST_EVENT_IE_PLTYPE_EXISTS:
677                         ast_event_append_ie_uint(&event, AST_EVENT_IE_EXISTS, ie_val->ie_type);
678                         break;
679                 case AST_EVENT_IE_PLTYPE_UINT:
680                         ast_event_append_ie_uint(&event, ie_val->ie_type, ie_val->payload.uint);
681                         break;
682                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
683                         ast_event_append_ie_bitflags(&event, ie_val->ie_type, ie_val->payload.uint);
684                         break;
685                 case AST_EVENT_IE_PLTYPE_STR:
686                         ast_event_append_ie_str(&event, ie_val->ie_type, ie_val->payload.str);
687                         break;
688                 case AST_EVENT_IE_PLTYPE_RAW:
689                         ast_event_append_ie_raw(&event, ie_val->ie_type, ie_val->payload.raw, ie_val->raw_datalen);
690                         break;
691                 }
692                 if (!event)
693                         break;
694         }
695
696         return event;
697 }
698
699 /*! \brief Send AST_EVENT_SUB events to this subscriber of ... subscriber events */
700 void ast_event_report_subs(const struct ast_event_sub *event_sub)
701 {
702         struct ast_event *event;
703         struct ast_event_sub *sub;
704         enum ast_event_type event_type = -1;
705         struct ast_event_ie_val *ie_val;
706
707         if (event_sub->type != AST_EVENT_SUB)
708                 return;
709
710         AST_LIST_TRAVERSE(&event_sub->ie_vals, ie_val, entry) {
711                 if (ie_val->ie_type == AST_EVENT_IE_EVENTTYPE) {
712                         event_type = ie_val->payload.uint;
713                         break;
714                 }
715         }
716
717         if (event_type == -1)
718                 return;
719
720         AST_RWDLLIST_RDLOCK(&ast_event_subs[event_type]);
721         AST_RWDLLIST_TRAVERSE(&ast_event_subs[event_type], sub, entry) {
722                 if (event_sub == sub) {
723                         continue;
724                 }
725
726                 event = gen_sub_event(sub);
727                 if (!event) {
728                         continue;
729                 }
730
731                 event_sub->cb(event, event_sub->userdata);
732
733                 ast_event_destroy(event);
734         }
735         AST_RWDLLIST_UNLOCK(&ast_event_subs[event_type]);
736 }
737
738 struct ast_event_sub *ast_event_subscribe_new(enum ast_event_type type,
739         ast_event_cb_t cb, void *userdata)
740 {
741         struct ast_event_sub *sub;
742
743         if (type < 0 || type >= AST_EVENT_TOTAL) {
744                 ast_log(LOG_ERROR, "%u is an invalid type!\n", type);
745                 return NULL;
746         }
747
748         if (!(sub = ast_calloc(1, sizeof(*sub)))) {
749                 return NULL;
750         }
751
752         sub->type = type;
753         sub->cb = cb;
754         sub->userdata = userdata;
755         sub->uniqueid = ast_atomic_fetchadd_int((int *) &sub_uniqueid, 1);
756
757         return sub;
758 }
759
760 int ast_event_sub_append_ie_uint(struct ast_event_sub *sub,
761         enum ast_event_ie_type ie_type, uint32_t unsigned_int)
762 {
763         struct ast_event_ie_val *ie_val;
764
765         if (ie_type <= 0 || ie_type >= AST_EVENT_IE_TOTAL) {
766                 return -1;
767         }
768
769         if (!(ie_val = ast_calloc(1, sizeof(*ie_val)))) {
770                 return -1;
771         }
772
773         ie_val->ie_type = ie_type;
774         ie_val->payload.uint = unsigned_int;
775         ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_UINT;
776
777         AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
778
779         return 0;
780 }
781
782 int ast_event_sub_append_ie_bitflags(struct ast_event_sub *sub,
783         enum ast_event_ie_type ie_type, uint32_t flags)
784 {
785         struct ast_event_ie_val *ie_val;
786
787         if (ie_type <= 0 || ie_type >= AST_EVENT_IE_TOTAL) {
788                 return -1;
789         }
790
791         if (!(ie_val = ast_calloc(1, sizeof(*ie_val)))) {
792                 return -1;
793         }
794
795         ie_val->ie_type = ie_type;
796         ie_val->payload.uint = flags;
797         ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_BITFLAGS;
798
799         AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
800
801         return 0;
802 }
803
804 int ast_event_sub_append_ie_exists(struct ast_event_sub *sub,
805         enum ast_event_ie_type ie_type)
806 {
807         struct ast_event_ie_val *ie_val;
808
809         if (ie_type <= 0 || ie_type >= AST_EVENT_IE_TOTAL) {
810                 return -1;
811         }
812
813         if (!(ie_val = ast_calloc(1, sizeof(*ie_val)))) {
814                 return -1;
815         }
816
817         ie_val->ie_type = ie_type;
818         ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_EXISTS;
819
820         AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
821
822         return 0;
823 }
824
825 int ast_event_sub_append_ie_str(struct ast_event_sub *sub,
826         enum ast_event_ie_type ie_type, const char *str)
827 {
828         struct ast_event_ie_val *ie_val;
829
830         if (ie_type <= 0 || ie_type >= AST_EVENT_IE_TOTAL) {
831                 return -1;
832         }
833
834         if (!(ie_val = ast_calloc(1, sizeof(*ie_val)))) {
835                 return -1;
836         }
837
838         ie_val->ie_type = ie_type;
839         ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_STR;
840
841         if (!(ie_val->payload.str = ast_strdup(str))) {
842                 ast_free(ie_val);
843                 return -1;
844         }
845
846         if (ie_type == AST_EVENT_IE_DEVICE) {
847                 char *uppertech = ast_strdupa(str);
848                 ast_tech_to_upper(uppertech);
849                 ie_val->payload.hash = ast_str_hash(uppertech);
850         } else {
851                 ie_val->payload.hash = ast_str_hash(str);
852         }
853
854         AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
855
856         return 0;
857 }
858
859 int ast_event_sub_append_ie_raw(struct ast_event_sub *sub,
860         enum ast_event_ie_type ie_type, void *data, size_t raw_datalen)
861 {
862         struct ast_event_ie_val *ie_val;
863
864         if (ie_type <= 0 || ie_type >= AST_EVENT_IE_TOTAL) {
865                 return -1;
866         }
867
868         if (!(ie_val = ast_calloc(1, sizeof(*ie_val)))) {
869                 return -1;
870         }
871
872         ie_val->ie_type = ie_type;
873         ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_RAW;
874         ie_val->raw_datalen = raw_datalen;
875
876         if (!(ie_val->payload.raw = ast_malloc(raw_datalen))) {
877                 ast_free(ie_val);
878                 return -1;
879         }
880
881         memcpy(ie_val->payload.raw, data, raw_datalen);
882
883         AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
884
885         return 0;
886 }
887
888 int ast_event_sub_activate(struct ast_event_sub *sub)
889 {
890         if (ast_event_check_subscriber(AST_EVENT_SUB,
891                 AST_EVENT_IE_EVENTTYPE, AST_EVENT_IE_PLTYPE_UINT, sub->type,
892                 AST_EVENT_IE_END) != AST_EVENT_SUB_NONE) {
893                 struct ast_event *event;
894
895                 event = gen_sub_event(sub);
896                 if (event && ast_event_queue(event)) {
897                         ast_event_destroy(event);
898                 }
899         }
900
901         AST_RWDLLIST_WRLOCK(&ast_event_subs[sub->type]);
902         AST_RWDLLIST_INSERT_TAIL(&ast_event_subs[sub->type], sub, entry);
903         AST_RWDLLIST_UNLOCK(&ast_event_subs[sub->type]);
904
905         return 0;
906 }
907
908 struct ast_event_sub *ast_event_subscribe(enum ast_event_type type, ast_event_cb_t cb,
909         const char *description, void *userdata, ...)
910 {
911         va_list ap;
912         enum ast_event_ie_type ie_type;
913         struct ast_event_sub *sub;
914
915         if (!(sub = ast_event_subscribe_new(type, cb, userdata))) {
916                 return NULL;
917         }
918
919         ast_copy_string(sub->description, description, sizeof(sub->description));
920
921         va_start(ap, userdata);
922         for (ie_type = va_arg(ap, enum ast_event_ie_type);
923                 ie_type != AST_EVENT_IE_END;
924                 ie_type = va_arg(ap, enum ast_event_ie_type))
925         {
926                 enum ast_event_ie_pltype ie_pltype;
927
928                 ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
929
930                 switch (ie_pltype) {
931                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
932                         break;
933                 case AST_EVENT_IE_PLTYPE_UINT:
934                 {
935                         uint32_t unsigned_int = va_arg(ap, uint32_t);
936                         ast_event_sub_append_ie_uint(sub, ie_type, unsigned_int);
937                         break;
938                 }
939                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
940                 {
941                         uint32_t unsigned_int = va_arg(ap, uint32_t);
942                         ast_event_sub_append_ie_bitflags(sub, ie_type, unsigned_int);
943                         break;
944                 }
945                 case AST_EVENT_IE_PLTYPE_STR:
946                 {
947                         const char *str = va_arg(ap, const char *);
948                         ast_event_sub_append_ie_str(sub, ie_type, str);
949                         break;
950                 }
951                 case AST_EVENT_IE_PLTYPE_RAW:
952                 {
953                         void *data = va_arg(ap, void *);
954                         size_t data_len = va_arg(ap, size_t);
955                         ast_event_sub_append_ie_raw(sub, ie_type, data, data_len);
956                         break;
957                 }
958                 case AST_EVENT_IE_PLTYPE_EXISTS:
959                         ast_event_sub_append_ie_exists(sub, ie_type);
960                         break;
961                 }
962         }
963         va_end(ap);
964
965         ast_event_sub_activate(sub);
966
967         return sub;
968 }
969
970 void ast_event_sub_destroy(struct ast_event_sub *sub)
971 {
972         struct ast_event_ie_val *ie_val;
973
974         while ((ie_val = AST_LIST_REMOVE_HEAD(&sub->ie_vals, entry))) {
975                 ast_event_ie_val_destroy(ie_val);
976         }
977
978         ast_free(sub);
979 }
980
981 const char *ast_event_subscriber_get_description(struct ast_event_sub *sub)
982 {
983         return sub ? sub->description : NULL;
984 }
985
986 struct ast_event_sub *ast_event_unsubscribe(struct ast_event_sub *sub)
987 {
988         struct ast_event *event;
989
990         AST_RWDLLIST_WRLOCK(&ast_event_subs[sub->type]);
991         AST_DLLIST_REMOVE(&ast_event_subs[sub->type], sub, entry);
992         AST_RWDLLIST_UNLOCK(&ast_event_subs[sub->type]);
993
994         if (ast_event_check_subscriber(AST_EVENT_UNSUB,
995                 AST_EVENT_IE_EVENTTYPE, AST_EVENT_IE_PLTYPE_UINT, sub->type,
996                 AST_EVENT_IE_END) != AST_EVENT_SUB_NONE) {
997
998                 event = ast_event_new(AST_EVENT_UNSUB,
999                         AST_EVENT_IE_UNIQUEID,    AST_EVENT_IE_PLTYPE_UINT, sub->uniqueid,
1000                         AST_EVENT_IE_EVENTTYPE,   AST_EVENT_IE_PLTYPE_UINT, sub->type,
1001                         AST_EVENT_IE_DESCRIPTION, AST_EVENT_IE_PLTYPE_STR, sub->description,
1002                         AST_EVENT_IE_END);
1003                 if (event && ast_event_queue(event)) {
1004                         ast_event_destroy(event);
1005                 }
1006         }
1007
1008         ast_event_sub_destroy(sub);
1009
1010         return NULL;
1011 }
1012
1013 int ast_event_iterator_init(struct ast_event_iterator *iterator, const struct ast_event *event)
1014 {
1015         int res = 0;
1016
1017         iterator->event_len = ast_event_get_size(event);
1018         iterator->event = event;
1019         if (iterator->event_len >= sizeof(*event) + sizeof(struct ast_event_ie)) {
1020                 iterator->ie = (struct ast_event_ie *) ( ((char *) event) + sizeof(*event) );
1021         } else {
1022                 iterator->ie = NULL;
1023                 res = -1;
1024         }
1025
1026         return res;
1027 }
1028
1029 int ast_event_iterator_next(struct ast_event_iterator *iterator)
1030 {
1031         iterator->ie = (struct ast_event_ie *) ( ((char *) iterator->ie) + sizeof(*iterator->ie) + ntohs(iterator->ie->ie_payload_len));
1032         return ((iterator->event_len <= (((char *) iterator->ie) - ((char *) iterator->event))) ? -1 : 0);
1033 }
1034
1035 enum ast_event_ie_type ast_event_iterator_get_ie_type(struct ast_event_iterator *iterator)
1036 {
1037         return ntohs(iterator->ie->ie_type);
1038 }
1039
1040 uint32_t ast_event_iterator_get_ie_uint(struct ast_event_iterator *iterator)
1041 {
1042         return ntohl(get_unaligned_uint32(iterator->ie->ie_payload));
1043 }
1044
1045 uint32_t ast_event_iterator_get_ie_bitflags(struct ast_event_iterator *iterator)
1046 {
1047         return ntohl(get_unaligned_uint32(iterator->ie->ie_payload));
1048 }
1049
1050 const char *ast_event_iterator_get_ie_str(struct ast_event_iterator *iterator)
1051 {
1052         const struct ast_event_ie_str_payload *str_payload;
1053
1054         str_payload = (struct ast_event_ie_str_payload *) iterator->ie->ie_payload;
1055
1056         return str_payload ? str_payload->str : NULL;
1057 }
1058
1059 void *ast_event_iterator_get_ie_raw(struct ast_event_iterator *iterator)
1060 {
1061         return iterator->ie->ie_payload;
1062 }
1063
1064 uint16_t ast_event_iterator_get_ie_raw_payload_len(struct ast_event_iterator *iterator)
1065 {
1066         return ntohs(iterator->ie->ie_payload_len);
1067 }
1068
1069 enum ast_event_type ast_event_get_type(const struct ast_event *event)
1070 {
1071         return ntohs(event->type);
1072 }
1073
1074 uint32_t ast_event_get_ie_uint(const struct ast_event *event, enum ast_event_ie_type ie_type)
1075 {
1076         const uint32_t *ie_val;
1077
1078         ie_val = ast_event_get_ie_raw(event, ie_type);
1079
1080         return ie_val ? ntohl(get_unaligned_uint32(ie_val)) : 0;
1081 }
1082
1083 uint32_t ast_event_get_ie_bitflags(const struct ast_event *event, enum ast_event_ie_type ie_type)
1084 {
1085         const uint32_t *ie_val;
1086
1087         ie_val = ast_event_get_ie_raw(event, ie_type);
1088
1089         return ie_val ? ntohl(get_unaligned_uint32(ie_val)) : 0;
1090 }
1091
1092 uint32_t ast_event_get_ie_str_hash(const struct ast_event *event, enum ast_event_ie_type ie_type)
1093 {
1094         const struct ast_event_ie_str_payload *str_payload;
1095
1096         str_payload = ast_event_get_ie_raw(event, ie_type);
1097
1098         return str_payload ? str_payload->hash : 0;
1099 }
1100
1101 const char *ast_event_get_ie_str(const struct ast_event *event, enum ast_event_ie_type ie_type)
1102 {
1103         const struct ast_event_ie_str_payload *str_payload;
1104
1105         str_payload = ast_event_get_ie_raw(event, ie_type);
1106
1107         return str_payload ? str_payload->str : NULL;
1108 }
1109
1110 const void *ast_event_get_ie_raw(const struct ast_event *event, enum ast_event_ie_type ie_type)
1111 {
1112         struct ast_event_iterator iterator;
1113         int res;
1114
1115         for (res = ast_event_iterator_init(&iterator, event); !res; res = ast_event_iterator_next(&iterator)) {
1116                 if (ast_event_iterator_get_ie_type(&iterator) == ie_type) {
1117                         return ast_event_iterator_get_ie_raw(&iterator);
1118                 }
1119         }
1120
1121         return NULL;
1122 }
1123
1124 uint16_t ast_event_get_ie_raw_payload_len(const struct ast_event *event, enum ast_event_ie_type ie_type)
1125 {
1126         struct ast_event_iterator iterator;
1127         int res;
1128
1129         for (res = ast_event_iterator_init(&iterator, event); !res; res = ast_event_iterator_next(&iterator)) {
1130                 if (ast_event_iterator_get_ie_type(&iterator) == ie_type) {
1131                         return ast_event_iterator_get_ie_raw_payload_len(&iterator);
1132                 }
1133         }
1134
1135         return 0;
1136 }
1137
1138 int ast_event_append_ie_str(struct ast_event **event, enum ast_event_ie_type ie_type,
1139         const char *str)
1140 {
1141         struct ast_event_ie_str_payload *str_payload;
1142         size_t payload_len;
1143
1144         payload_len = sizeof(*str_payload) + strlen(str);
1145         str_payload = alloca(payload_len);
1146
1147         strcpy(str_payload->str, str);
1148         if (ie_type == AST_EVENT_IE_DEVICE) {
1149                 char *uppertech = ast_strdupa(str);
1150                 ast_tech_to_upper(uppertech);
1151                 str_payload->hash = ast_str_hash(uppertech);
1152         } else {
1153                 str_payload->hash = ast_str_hash(str);
1154         }
1155
1156         return ast_event_append_ie_raw(event, ie_type, str_payload, payload_len);
1157 }
1158
1159 int ast_event_append_ie_uint(struct ast_event **event, enum ast_event_ie_type ie_type,
1160         uint32_t data)
1161 {
1162         data = htonl(data);
1163         return ast_event_append_ie_raw(event, ie_type, &data, sizeof(data));
1164 }
1165
1166 int ast_event_append_ie_bitflags(struct ast_event **event, enum ast_event_ie_type ie_type,
1167         uint32_t flags)
1168 {
1169         flags = htonl(flags);
1170         return ast_event_append_ie_raw(event, ie_type, &flags, sizeof(flags));
1171 }
1172
1173 int ast_event_append_ie_raw(struct ast_event **event, enum ast_event_ie_type ie_type,
1174         const void *data, size_t data_len)
1175 {
1176         struct ast_event_ie *ie;
1177         unsigned int extra_len;
1178         uint16_t event_len;
1179
1180         event_len = ntohs((*event)->event_len);
1181         extra_len = sizeof(*ie) + data_len;
1182
1183         if (!(*event = ast_realloc(*event, event_len + extra_len))) {
1184                 return -1;
1185         }
1186
1187         ie = (struct ast_event_ie *) ( ((char *) *event) + event_len );
1188         ie->ie_type = htons(ie_type);
1189         ie->ie_payload_len = htons(data_len);
1190         memcpy(ie->ie_payload, data, data_len);
1191
1192         (*event)->event_len = htons(event_len + extra_len);
1193
1194         return 0;
1195 }
1196
1197 struct ast_event *ast_event_new(enum ast_event_type type, ...)
1198 {
1199         va_list ap;
1200         struct ast_event *event;
1201         enum ast_event_ie_type ie_type;
1202         struct ast_event_ie_val *ie_val;
1203         int has_ie = 0;
1204         AST_LIST_HEAD_NOLOCK_STATIC(ie_vals, ast_event_ie_val);
1205
1206         /* Invalid type */
1207         if (type >= AST_EVENT_TOTAL) {
1208                 ast_log(LOG_WARNING, "Someone tried to create an event of invalid "
1209                         "type '%d'!\n", type);
1210                 return NULL;
1211         }
1212
1213         va_start(ap, type);
1214         for (ie_type = va_arg(ap, enum ast_event_ie_type);
1215                 ie_type != AST_EVENT_IE_END;
1216                 ie_type = va_arg(ap, enum ast_event_ie_type))
1217         {
1218                 struct ast_event_ie_val *ie_value = alloca(sizeof(*ie_value));
1219                 int insert = 0;
1220
1221                 memset(ie_value, 0, sizeof(*ie_value));
1222                 ie_value->ie_type = ie_type;
1223                 ie_value->ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
1224                 switch (ie_value->ie_pltype) {
1225                 case AST_EVENT_IE_PLTYPE_UINT:
1226                         ie_value->payload.uint = va_arg(ap, uint32_t);
1227                         insert = 1;
1228                         break;
1229                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
1230                         ie_value->payload.uint = va_arg(ap, uint32_t);
1231                         insert = 1;
1232                         break;
1233                 case AST_EVENT_IE_PLTYPE_STR:
1234                         ie_value->payload.str = va_arg(ap, const char *);
1235                         insert = 1;
1236                         break;
1237                 case AST_EVENT_IE_PLTYPE_RAW:
1238                 {
1239                         void *data = va_arg(ap, void *);
1240                         size_t datalen = va_arg(ap, size_t);
1241                         ie_value->payload.raw = alloca(datalen);
1242                         memcpy(ie_value->payload.raw, data, datalen);
1243                         ie_value->raw_datalen = datalen;
1244                         insert = 1;
1245                         break;
1246                 }
1247                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
1248                 case AST_EVENT_IE_PLTYPE_EXISTS:
1249                         break;
1250                 }
1251
1252                 if (insert) {
1253                         AST_LIST_INSERT_TAIL(&ie_vals, ie_value, entry);
1254                         has_ie = 1;
1255                 } else {
1256                         ast_log(LOG_WARNING, "Unsupported PLTYPE(%d)\n", ie_value->ie_pltype);
1257                 }
1258         }
1259         va_end(ap);
1260
1261         if (!(event = ast_calloc(1, sizeof(*event)))) {
1262                 return NULL;
1263         }
1264
1265         event->type = htons(type);
1266         event->event_len = htons(sizeof(*event));
1267
1268         AST_LIST_TRAVERSE(&ie_vals, ie_val, entry) {
1269                 switch (ie_val->ie_pltype) {
1270                 case AST_EVENT_IE_PLTYPE_STR:
1271                         ast_event_append_ie_str(&event, ie_val->ie_type, ie_val->payload.str);
1272                         break;
1273                 case AST_EVENT_IE_PLTYPE_UINT:
1274                         ast_event_append_ie_uint(&event, ie_val->ie_type, ie_val->payload.uint);
1275                         break;
1276                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
1277                         ast_event_append_ie_bitflags(&event, ie_val->ie_type, ie_val->payload.uint);
1278                         break;
1279                 case AST_EVENT_IE_PLTYPE_RAW:
1280                         ast_event_append_ie_raw(&event, ie_val->ie_type,
1281                                         ie_val->payload.raw, ie_val->raw_datalen);
1282                         break;
1283                 case AST_EVENT_IE_PLTYPE_EXISTS:
1284                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
1285                         break;
1286                 }
1287
1288                 if (!event) {
1289                         break;
1290                 }
1291         }
1292
1293         if (has_ie && !ast_event_get_ie_raw(event, AST_EVENT_IE_EID)) {
1294                 /* If the event is originating on this server, add the server's
1295                  * entity ID to the event. */
1296                 ast_event_append_eid(&event);
1297         }
1298
1299         return event;
1300 }
1301
1302 int ast_event_append_eid(struct ast_event **event)
1303 {
1304         return ast_event_append_ie_raw(event, AST_EVENT_IE_EID,
1305                         &ast_eid_default, sizeof(ast_eid_default));
1306 }
1307
1308 void ast_event_destroy(struct ast_event *event)
1309 {
1310         ast_free(event);
1311 }
1312
1313 static void ast_event_ref_destroy(void *obj)
1314 {
1315         struct ast_event_ref *event_ref = obj;
1316
1317         ast_event_destroy(event_ref->event);
1318 }
1319
1320 static struct ast_event *ast_event_dup(const struct ast_event *event)
1321 {
1322         struct ast_event *dup_event;
1323         uint16_t event_len;
1324
1325         event_len = ast_event_get_size(event);
1326
1327         if (!(dup_event = ast_calloc(1, event_len))) {
1328                 return NULL;
1329         }
1330
1331         memcpy(dup_event, event, event_len);
1332
1333         return dup_event;
1334 }
1335
1336 struct ast_event *ast_event_get_cached(enum ast_event_type type, ...)
1337 {
1338         va_list ap;
1339         enum ast_event_ie_type ie_type;
1340         struct ast_event *dup_event = NULL;
1341         struct ast_event_ref *cached_event_ref;
1342         struct ast_event *cache_arg_event;
1343         struct ast_event_ref tmp_event_ref = {
1344                 .event = NULL,
1345         };
1346         struct ao2_container *container = NULL;
1347
1348         if (type >= AST_EVENT_TOTAL) {
1349                 ast_log(LOG_ERROR, "%u is an invalid type!\n", type);
1350                 return NULL;
1351         }
1352
1353         if (!(container = ast_event_cache[type].container)) {
1354                 ast_log(LOG_ERROR, "%u is not a cached event type\n", type);
1355                 return NULL;
1356         }
1357
1358         if (!(cache_arg_event = ast_event_new(type, AST_EVENT_IE_END))) {
1359                 return NULL;
1360         }
1361
1362         va_start(ap, type);
1363         for (ie_type = va_arg(ap, enum ast_event_ie_type);
1364                 ie_type != AST_EVENT_IE_END;
1365                 ie_type = va_arg(ap, enum ast_event_ie_type))
1366         {
1367                 enum ast_event_ie_pltype ie_pltype;
1368
1369                 ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
1370
1371                 switch (ie_pltype) {
1372                 case AST_EVENT_IE_PLTYPE_UINT:
1373                         ast_event_append_ie_uint(&cache_arg_event, ie_type, va_arg(ap, uint32_t));
1374                         break;
1375                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
1376                         ast_event_append_ie_bitflags(&cache_arg_event, ie_type, va_arg(ap, uint32_t));
1377                         break;
1378                 case AST_EVENT_IE_PLTYPE_STR:
1379                         ast_event_append_ie_str(&cache_arg_event, ie_type, va_arg(ap, const char *));
1380                         break;
1381                 case AST_EVENT_IE_PLTYPE_RAW:
1382                 {
1383                         void *data = va_arg(ap, void *);
1384                         size_t datalen = va_arg(ap, size_t);
1385                         ast_event_append_ie_raw(&cache_arg_event, ie_type, data, datalen);
1386                         break;
1387                 }
1388                 case AST_EVENT_IE_PLTYPE_EXISTS:
1389                         ast_log(LOG_WARNING, "PLTYPE_EXISTS not supported by this function\n");
1390                         break;
1391                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
1392                         break;
1393                 }
1394         }
1395         va_end(ap);
1396
1397         tmp_event_ref.event = cache_arg_event;
1398
1399         cached_event_ref = ao2_find(container, &tmp_event_ref, OBJ_POINTER);
1400
1401         ast_event_destroy(cache_arg_event);
1402         cache_arg_event = NULL;
1403
1404         if (cached_event_ref) {
1405                 dup_event = ast_event_dup(cached_event_ref->event);
1406                 ao2_ref(cached_event_ref, -1);
1407                 cached_event_ref = NULL;
1408         }
1409
1410         return dup_event;
1411 }
1412
1413 static struct ast_event_ref *alloc_event_ref(void)
1414 {
1415         return ao2_alloc(sizeof(struct ast_event_ref), ast_event_ref_destroy);
1416 }
1417
1418 /*!
1419  * \internal
1420  * \brief Update the given event cache with the new event.
1421  * \since 1.8
1422  *
1423  * \param cache Event cache container to update.
1424  * \param event New event to put in the cache.
1425  *
1426  * \return Nothing
1427  */
1428 static void event_update_cache(struct ao2_container *cache, struct ast_event *event)
1429 {
1430         struct ast_event_ref tmp_event_ref = {
1431                 .event = event,
1432         };
1433         struct ast_event *dup_event;
1434         struct ast_event_ref *event_ref;
1435
1436         /* Hold the cache container lock while it is updated. */
1437         ao2_lock(cache);
1438
1439         /* Remove matches from the cache. */
1440         ao2_callback(cache, OBJ_POINTER | OBJ_UNLINK | OBJ_MULTIPLE | OBJ_NODATA,
1441                 ast_event_cmp, &tmp_event_ref);
1442
1443         /* Save a copy of the event in the cache. */
1444         dup_event = ast_event_dup(event);
1445         if (dup_event) {
1446                 event_ref = alloc_event_ref();
1447                 if (event_ref) {
1448                         event_ref->event = dup_event;
1449                         ao2_link(cache, event_ref);
1450                         ao2_ref(event_ref, -1);
1451                 } else {
1452                         ast_event_destroy(dup_event);
1453                 }
1454         }
1455
1456         ao2_unlock(cache);
1457 }
1458
1459 int ast_event_queue_and_cache(struct ast_event *event)
1460 {
1461         struct ao2_container *container;
1462
1463         container = ast_event_cache[ast_event_get_type(event)].container;
1464         if (!container) {
1465                 ast_log(LOG_WARNING, "cache requested for non-cached event type\n");
1466         } else {
1467                 event_update_cache(container, event);
1468         }
1469
1470         if (ast_event_queue(event)) {
1471                 ast_event_destroy(event);
1472         }
1473         return 0;
1474 }
1475
1476 static int handle_event(void *data)
1477 {
1478         struct ast_event_ref *event_ref = data;
1479         struct ast_event_sub *sub;
1480         const enum ast_event_type event_types[] = {
1481                 ntohs(event_ref->event->type),
1482                 AST_EVENT_ALL
1483         };
1484         int i;
1485
1486         for (i = 0; i < ARRAY_LEN(event_types); i++) {
1487                 AST_RWDLLIST_RDLOCK(&ast_event_subs[event_types[i]]);
1488                 AST_RWDLLIST_TRAVERSE(&ast_event_subs[event_types[i]], sub, entry) {
1489                         struct ast_event_ie_val *ie_val;
1490
1491                         AST_LIST_TRAVERSE(&sub->ie_vals, ie_val, entry) {
1492                                 if (!match_ie_val(event_ref->event, ie_val, NULL)) {
1493                                         /* The current subscription ie did not match an event ie. */
1494                                         break;
1495                                 }
1496                         }
1497                         if (ie_val) {
1498                                 /* The event did not match this subscription. */
1499                                 continue;
1500                         }
1501                         sub->cb(event_ref->event, sub->userdata);
1502                 }
1503                 AST_RWDLLIST_UNLOCK(&ast_event_subs[event_types[i]]);
1504         }
1505
1506         ao2_ref(event_ref, -1);
1507
1508         return 0;
1509 }
1510
1511 int ast_event_queue(struct ast_event *event)
1512 {
1513         struct ast_event_ref *event_ref;
1514         uint16_t host_event_type;
1515         int res;
1516
1517         host_event_type = ntohs(event->type);
1518
1519         /* Invalid type */
1520         if (host_event_type >= AST_EVENT_TOTAL) {
1521                 ast_log(LOG_WARNING, "Someone tried to queue an event of invalid "
1522                         "type '%d'!\n", host_event_type);
1523                 return -1;
1524         }
1525
1526         /* If nobody has subscribed to this event type, throw it away now */
1527         if (ast_event_check_subscriber(host_event_type, AST_EVENT_IE_END)
1528                         == AST_EVENT_SUB_NONE) {
1529                 ast_event_destroy(event);
1530                 return 0;
1531         }
1532
1533         if (!(event_ref = alloc_event_ref())) {
1534                 return -1;
1535         }
1536
1537         event_ref->event = event;
1538
1539         res = ast_taskprocessor_push(event_dispatcher, handle_event, event_ref);
1540         if (res) {
1541                 event_ref->event = NULL;
1542                 ao2_ref(event_ref, -1);
1543         }
1544         return res;
1545 }
1546
1547 static int ast_event_hash_mwi(const void *obj, const int flags)
1548 {
1549         const struct ast_event *event = obj;
1550         const char *mailbox = ast_event_get_ie_str(event, AST_EVENT_IE_MAILBOX);
1551         const char *context = ast_event_get_ie_str(event, AST_EVENT_IE_CONTEXT);
1552
1553         return ast_str_hash_add(context, ast_str_hash(mailbox));
1554 }
1555
1556 /*!
1557  * \internal
1558  * \brief Hash function for AST_EVENT_DEVICE_STATE
1559  *
1560  * \param[in] obj an ast_event
1561  * \param[in] flags unused
1562  *
1563  * \return hash value
1564  */
1565 static int ast_event_hash_devstate(const void *obj, const int flags)
1566 {
1567         const struct ast_event *event = obj;
1568
1569         return ast_str_hash(ast_event_get_ie_str(event, AST_EVENT_IE_DEVICE));
1570 }
1571
1572 /*!
1573  * \internal
1574  * \brief Hash function for AST_EVENT_DEVICE_STATE_CHANGE
1575  *
1576  * \param[in] obj an ast_event
1577  * \param[in] flags unused
1578  *
1579  * \return hash value
1580  */
1581 static int ast_event_hash_devstate_change(const void *obj, const int flags)
1582 {
1583         const struct ast_event *event = obj;
1584
1585         return ast_str_hash(ast_event_get_ie_str(event, AST_EVENT_IE_DEVICE));
1586 }
1587
1588 static int ast_event_hash(const void *obj, const int flags)
1589 {
1590         const struct ast_event_ref *event_ref;
1591         const struct ast_event *event;
1592         ao2_hash_fn *hash_fn;
1593
1594         event_ref = obj;
1595         event = event_ref->event;
1596
1597         if (!(hash_fn = ast_event_cache[ast_event_get_type(event)].hash_fn)) {
1598                 return 0;
1599         }
1600
1601         return hash_fn(event, flags);
1602 }
1603
1604 /*!
1605  * \internal
1606  * \brief Compare two events
1607  *
1608  * \param[in] obj the first event, as an ast_event_ref
1609  * \param[in] arg the second event, as an ast_event_ref
1610  * \param[in] flags unused
1611  *
1612  * \pre Both events must be the same type.
1613  * \pre The event type must be declared as a cached event type in ast_event_cache
1614  *
1615  * \details This function takes two events, and determines if they are considered
1616  * equivalent.  The values of information elements specified in the cache arguments
1617  * for the event type are used to determine if the events are equivalent.
1618  *
1619  * \retval 0 No match
1620  * \retval CMP_MATCH The events are considered equivalent based on the cache arguments
1621  */
1622 static int ast_event_cmp(void *obj, void *arg, int flags)
1623 {
1624         struct ast_event_ref *event_ref, *event_ref2;
1625         struct ast_event *event, *event2;
1626         int res = CMP_MATCH;
1627         int i;
1628         enum ast_event_ie_type *cache_args;
1629
1630         event_ref = obj;
1631         event = event_ref->event;
1632
1633         event_ref2 = arg;
1634         event2 = event_ref2->event;
1635
1636         cache_args = ast_event_cache[ast_event_get_type(event)].cache_args;
1637
1638         for (i = 0; i < ARRAY_LEN(ast_event_cache[0].cache_args) && cache_args[i]; i++) {
1639                 struct ast_event_ie_val ie_val = {
1640                         .ie_pltype = ast_event_get_ie_pltype(cache_args[i]),
1641                         .ie_type = cache_args[i],
1642                 };
1643
1644                 if (!match_ie_val(event, &ie_val, event2)) {
1645                         res = 0;
1646                         break;
1647                 }
1648         }
1649
1650         return res;
1651 }
1652
1653 static void dump_raw_ie(struct ast_event_iterator *i, struct ast_cli_args *a)
1654 {
1655         char eid_buf[32];
1656         enum ast_event_ie_type ie_type;
1657         const char *ie_type_name;
1658
1659         ie_type = ast_event_iterator_get_ie_type(i);
1660         ie_type_name = ast_event_get_ie_type_name(ie_type);
1661
1662         switch (ie_type) {
1663         case AST_EVENT_IE_EID:
1664                 ast_eid_to_str(eid_buf, sizeof(eid_buf), ast_event_iterator_get_ie_raw(i));
1665                 ast_cli(a->fd, "%.30s: %s\n", ie_type_name, eid_buf);
1666                 break;
1667         default:
1668                 ast_cli(a->fd, "%s\n", ie_type_name);
1669                 break;
1670         }
1671 }
1672
1673 static int event_dump_cli(void *obj, void *arg, int flags)
1674 {
1675         const struct ast_event_ref *event_ref = obj;
1676         const struct ast_event *event = event_ref->event;
1677         struct ast_cli_args *a = arg;
1678         struct ast_event_iterator i;
1679
1680         if (ast_event_iterator_init(&i, event)) {
1681                 ast_cli(a->fd, "Failed to initialize event iterator.  :-(\n");
1682                 return 0;
1683         }
1684
1685         ast_cli(a->fd, "Event: %s\n", ast_event_get_type_name(event));
1686
1687         do {
1688                 enum ast_event_ie_type ie_type;
1689                 enum ast_event_ie_pltype ie_pltype;
1690                 const char *ie_type_name;
1691
1692                 ie_type = ast_event_iterator_get_ie_type(&i);
1693                 ie_type_name = ast_event_get_ie_type_name(ie_type);
1694                 ie_pltype = ast_event_get_ie_pltype(ie_type);
1695
1696                 switch (ie_pltype) {
1697                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
1698                 case AST_EVENT_IE_PLTYPE_EXISTS:
1699                         ast_cli(a->fd, "%s\n", ie_type_name);
1700                         break;
1701                 case AST_EVENT_IE_PLTYPE_STR:
1702                         ast_cli(a->fd, "%.30s: %s\n", ie_type_name,
1703                                         ast_event_iterator_get_ie_str(&i));
1704                         break;
1705                 case AST_EVENT_IE_PLTYPE_UINT:
1706                         ast_cli(a->fd, "%.30s: %u\n", ie_type_name,
1707                                         ast_event_iterator_get_ie_uint(&i));
1708                         break;
1709                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
1710                         ast_cli(a->fd, "%.30s: %u\n", ie_type_name,
1711                                         ast_event_iterator_get_ie_bitflags(&i));
1712                         break;
1713                 case AST_EVENT_IE_PLTYPE_RAW:
1714                         dump_raw_ie(&i, a);
1715                         break;
1716                 }
1717         } while (!ast_event_iterator_next(&i));
1718
1719         ast_cli(a->fd, "\n");
1720
1721         return 0;
1722 }
1723
1724 static char *event_dump_cache(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1725 {
1726         enum ast_event_type event_type;
1727         enum ast_event_ie_type *cache_args;
1728         int i;
1729
1730         switch (cmd) {
1731         case CLI_INIT:
1732                 e->command = "event dump cache";
1733                 e->usage =
1734                         "Usage: event dump cache <event type>\n"
1735                         "       Dump all of the cached events for the given event type.\n"
1736                         "       This is primarily intended for debugging.\n";
1737                 return NULL;
1738         case CLI_GENERATE:
1739                 if (a->pos == 3) {
1740                         return ast_cli_complete(a->word, cached_event_types, a->n);
1741                 }
1742                 return NULL;
1743         case CLI_HANDLER:
1744                 break;
1745         }
1746
1747         if (a->argc != e->args + 1) {
1748                 return CLI_SHOWUSAGE;
1749         }
1750
1751         if (ast_event_str_to_event_type(a->argv[e->args], &event_type)) {
1752                 ast_cli(a->fd, "Invalid cached event type: '%s'\n", a->argv[e->args]);
1753                 return CLI_SHOWUSAGE;
1754         }
1755
1756         if (!ast_event_cache[event_type].container) {
1757                 ast_cli(a->fd, "Event type '%s' has no cache.\n", a->argv[e->args]);
1758                 return CLI_SUCCESS;
1759         }
1760
1761         ast_cli(a->fd, "Event Type: %s\n", a->argv[e->args]);
1762         ast_cli(a->fd, "Cache Unique Keys:\n");
1763         cache_args = ast_event_cache[event_type].cache_args;
1764         for (i = 0; i < ARRAY_LEN(ast_event_cache[0].cache_args) && cache_args[i]; i++) {
1765                 ast_cli(a->fd, "--> %s\n", ast_event_get_ie_type_name(cache_args[i]));
1766         }
1767
1768         ast_cli(a->fd, "\n--- Begin Cache Dump ---\n\n");
1769         ao2_callback(ast_event_cache[event_type].container, OBJ_NODATA, event_dump_cli, a);
1770         ast_cli(a->fd, "--- End Cache Dump ---\n\n");
1771
1772         return CLI_SUCCESS;
1773 }
1774
1775 static struct ast_cli_entry event_cli[] = {
1776         AST_CLI_DEFINE(event_dump_cache, "Dump the internal event cache (for debugging)"),
1777 };
1778
1779 int ast_event_init(void)
1780 {
1781         int i;
1782
1783         for (i = 0; i < AST_EVENT_TOTAL; i++) {
1784                 AST_RWDLLIST_HEAD_INIT(&ast_event_subs[i]);
1785         }
1786
1787         for (i = 0; i < AST_EVENT_TOTAL; i++) {
1788                 if (!ast_event_cache[i].hash_fn) {
1789                         /* This event type is not cached. */
1790                         continue;
1791                 }
1792
1793                 if (!(ast_event_cache[i].container = ao2_container_alloc(NUM_CACHE_BUCKETS,
1794                                 ast_event_hash, ast_event_cmp))) {
1795                         return -1;
1796                 }
1797         }
1798
1799         if (!(event_dispatcher = ast_taskprocessor_get("core_event_dispatcher", 0))) {
1800                 return -1;
1801         }
1802
1803         ast_cli_register_multiple(event_cli, ARRAY_LEN(event_cli));
1804
1805         return 0;
1806 }
1807
1808 size_t ast_event_minimum_length(void)
1809 {
1810         return sizeof(struct ast_event);
1811 }