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