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 enum ast_event_subscriber_res ast_event_check_subscriber(enum ast_event_type type, ...)
 354 {
 355         va_list ap;
 356         enum ast_event_ie_type ie_type;
 357         enum ast_event_subscriber_res res = AST_EVENT_SUB_NONE;
 358         struct ast_event_ie_val *ie_val, *sub_ie_val;
 359         struct ast_event_sub *sub;
 360         AST_LIST_HEAD_NOLOCK_STATIC(ie_vals, ast_event_ie_val);
 361
 362         if (type >= AST_EVENT_TOTAL) {
 363                 ast_log(LOG_ERROR, "%u is an invalid type!\n", type);
 364                 return res;
 365         }
 366
 367         va_start(ap, type);
 368         for (ie_type = va_arg(ap, enum ast_event_ie_type);
 369                 ie_type != AST_EVENT_IE_END;
 370                 ie_type = va_arg(ap, enum ast_event_ie_type))
 371         {
 372                 struct ast_event_ie_val *ie_value = alloca(sizeof(*ie_value));
 373                 int insert = 1;
 374                 memset(ie_value, 0, sizeof(*ie_value));
 375                 ie_value->ie_type = ie_type;
 376                 ie_value->ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
 377                 switch (ie_value->ie_pltype) {
 378                 case AST_EVENT_IE_PLTYPE_UINT:
 379                         ie_value->payload.uint = va_arg(ap, uint32_t);
 380                         break;
 381                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
 382                         ie_value->payload.uint = va_arg(ap, uint32_t);
 383                         break;
 384                 case AST_EVENT_IE_PLTYPE_STR:
 385                         ie_value->payload.str = va_arg(ap, const char *);
 386                         break;
 387                 case AST_EVENT_IE_PLTYPE_RAW:
 388                 {
 389                         void *data = va_arg(ap, void *);
 390                         size_t datalen = va_arg(ap, size_t);
 391                         ie_value->payload.raw = alloca(datalen);
 392                         memcpy(ie_value->payload.raw, data, datalen);
 393                         ie_value->raw_datalen = datalen;
 394                         break;
 395                 }
 396                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
 397                         insert = 0;
 398                 case AST_EVENT_IE_PLTYPE_EXISTS:
 399                         break;
 400                 }
 401
 402                 if (insert) {
 403                         AST_LIST_INSERT_TAIL(&ie_vals, ie_value, entry);
 404                 }
 405         }
 406         va_end(ap);
 407
 408         AST_RWDLLIST_RDLOCK(&ast_event_subs[type]);
 409         AST_RWDLLIST_TRAVERSE(&ast_event_subs[type], sub, entry) {
 410                 AST_LIST_TRAVERSE(&ie_vals, ie_val, entry) {
 411                         int break_out = 0;
 412
 413                         AST_LIST_TRAVERSE(&sub->ie_vals, sub_ie_val, entry) {
 414                                 if (sub_ie_val->ie_type == ie_val->ie_type) {
 415                                         break;
 416                                 }
 417                         }
 418
 419                         if (!sub_ie_val) {
 420                                 /* This subscriber doesn't care about this IE, so consider
 421                                  * it matched. */
 422                                 continue;
 423                         }
 424
 425                         switch (ie_val->ie_pltype) {
 426                         case AST_EVENT_IE_PLTYPE_UINT:
 427                                 break_out = (ie_val->payload.uint != sub_ie_val->payload.uint);
 428                                 break;
 429                         case AST_EVENT_IE_PLTYPE_BITFLAGS:
 430                                 /* if the subscriber has requested *any* of the bitflags we are providing,
 431                                  * then it's a match
 432                                  */
 433                                 break_out = (ie_val->payload.uint & sub_ie_val->payload.uint);
 434                                 break;
 435                         case AST_EVENT_IE_PLTYPE_STR:
 436                                 break_out = strcmp(ie_val->payload.str, sub_ie_val->payload.str);
 437                                 break;
 438                         case AST_EVENT_IE_PLTYPE_RAW:
 439                                 break_out = memcmp(ie_val->payload.raw,
 440                                                 sub_ie_val->payload.raw, ie_val->raw_datalen);
 441                                 break;
 442                         case AST_EVENT_IE_PLTYPE_EXISTS:
 443                                 /* The subscriber doesn't actually care what the value is */
 444                                 break_out = 1;
 445                                 break;
 446                         case AST_EVENT_IE_PLTYPE_UNKNOWN:
 447                                 break;
 448                         }
 449
 450                         if (break_out) {
 451                                 break;
 452                         }
 453                 }
 454
 455                 if (!ie_val) {
 456                         /* Everything matched */
 457                         break;
 458                 }
 459         }
 460         AST_RWDLLIST_UNLOCK(&ast_event_subs[type]);
 461
 462         if (sub) {
 463                 /* All parameters were matched */
 464                 return AST_EVENT_SUB_EXISTS;
 465         }
 466
 467         AST_RWDLLIST_RDLOCK(&ast_event_subs[AST_EVENT_ALL]);
 468         if (!AST_DLLIST_EMPTY(&ast_event_subs[AST_EVENT_ALL])) {
 469                 res = AST_EVENT_SUB_EXISTS;
 470         }
 471         AST_RWDLLIST_UNLOCK(&ast_event_subs[AST_EVENT_ALL]);
 472
 473         return res;
 474 }
 475
 476 static int match_ie_val(const struct ast_event *event,
 477                 const struct ast_event_ie_val *ie_val, const struct ast_event *event2)
 478 {
 479         switch (ie_val->ie_pltype) {
 480         case AST_EVENT_IE_PLTYPE_UINT:
 481         {
 482                 uint32_t val = event2 ? ast_event_get_ie_uint(event2, ie_val->ie_type) : ie_val->payload.uint;
 483
 484                 return (val == ast_event_get_ie_uint(event, ie_val->ie_type)) ? 1 : 0;
 485         }
 486
 487         case AST_EVENT_IE_PLTYPE_BITFLAGS:
 488         {
 489                 uint32_t flags = event2 ? ast_event_get_ie_uint(event2, ie_val->ie_type) : ie_val->payload.uint;
 490
 491                 /* if the subscriber has requested *any* of the bitflags that this event provides,
 492                  * then it's a match
 493                  */
 494                 return (flags & ast_event_get_ie_bitflags(event, ie_val->ie_type)) ? 1 : 0;
 495         }
 496
 497         case AST_EVENT_IE_PLTYPE_STR:
 498         {
 499                 const char *str;
 500                 uint32_t hash;
 501
 502                 hash = event2 ? ast_event_get_ie_str_hash(event2, ie_val->ie_type) : ie_val->payload.hash;
 503                 if (hash != ast_event_get_ie_str_hash(event, ie_val->ie_type)) {
 504                         return 0;
 505                 }
 506
 507                 str = event2 ? ast_event_get_ie_str(event2, ie_val->ie_type) : ie_val->payload.str;
 508                 if (str && !strcmp(str, ast_event_get_ie_str(event, ie_val->ie_type))) {
 509                         return 1;
 510                 }
 511
 512                 return 0;
 513         }
 514
 515         case AST_EVENT_IE_PLTYPE_RAW:
 516         {
 517                 const void *buf = event2 ? ast_event_get_ie_raw(event2, ie_val->ie_type) : ie_val->payload.raw;
 518
 519                 return (buf && !memcmp(buf, ast_event_get_ie_raw(event, ie_val->ie_type), ie_val->raw_datalen)) ? 1 : 0;
 520         }
 521
 522         case AST_EVENT_IE_PLTYPE_EXISTS:
 523         {
 524                 return ast_event_get_ie_raw(event, ie_val->ie_type) ? 1 : 0;
 525         }
 526
 527         case AST_EVENT_IE_PLTYPE_UNKNOWN:
 528                 return 0;
 529         }
 530
 531         return 0;
 532 }
 533
 534 static int dump_cache_cb(void *obj, void *arg, int flags)
 535 {
 536         const struct ast_event_ref *event_ref = obj;
 537         const struct ast_event *event = event_ref->event;
 538         const struct ast_event_sub *event_sub = arg;
 539         struct ast_event_ie_val *ie_val = NULL;
 540
 541         AST_LIST_TRAVERSE(&event_sub->ie_vals, ie_val, entry) {
 542                 if (!match_ie_val(event, ie_val, NULL)) {
 543                         break;
 544                 }
 545         }
 546
 547         if (!ie_val) {
 548                 /* All parameters were matched on this cache entry, so dump it */
 549                 event_sub->cb(event, event_sub->userdata);
 550         }
 551
 552         return 0;
 553 }
 554
 555 /*! \brief Dump the event cache for the subscribed event type */
 556 void ast_event_dump_cache(const struct ast_event_sub *event_sub)
 557 {
 558         ao2_callback(ast_event_cache[event_sub->type].container, OBJ_NODATA,
 559                         dump_cache_cb, (void *) event_sub);
 560 }
 561
 562 static struct ast_event *gen_sub_event(struct ast_event_sub *sub)
 563 {
 564         struct ast_event_ie_val *ie_val;
 565         struct ast_event *event;
 566
 567         event = ast_event_new(AST_EVENT_SUB,
 568                 AST_EVENT_IE_UNIQUEID,    AST_EVENT_IE_PLTYPE_UINT, sub->uniqueid,
 569                 AST_EVENT_IE_EVENTTYPE,   AST_EVENT_IE_PLTYPE_UINT, sub->type,
 570                 AST_EVENT_IE_DESCRIPTION, AST_EVENT_IE_PLTYPE_STR, sub->description,
 571                 AST_EVENT_IE_END);
 572
 573         if (!event)
 574                 return NULL;
 575
 576         AST_LIST_TRAVERSE(&sub->ie_vals, ie_val, entry) {
 577                 switch (ie_val->ie_pltype) {
 578                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
 579                         break;
 580                 case AST_EVENT_IE_PLTYPE_EXISTS:
 581                         ast_event_append_ie_uint(&event, AST_EVENT_IE_EXISTS, ie_val->ie_type);
 582                         break;
 583                 case AST_EVENT_IE_PLTYPE_UINT:
 584                         ast_event_append_ie_uint(&event, ie_val->ie_type, ie_val->payload.uint);
 585                         break;
 586                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
 587                         ast_event_append_ie_bitflags(&event, ie_val->ie_type, ie_val->payload.uint);
 588                         break;
 589                 case AST_EVENT_IE_PLTYPE_STR:
 590                         ast_event_append_ie_str(&event, ie_val->ie_type, ie_val->payload.str);
 591                         break;
 592                 case AST_EVENT_IE_PLTYPE_RAW:
 593                         ast_event_append_ie_raw(&event, ie_val->ie_type, ie_val->payload.raw, ie_val->raw_datalen);
 594                         break;
 595                 }
 596                 if (!event)
 597                         break;
 598         }
 599
 600         return event;
 601 }
 602
 603 /*! \brief Send AST_EVENT_SUB events to this subscriber of ... subscriber events */
 604 void ast_event_report_subs(const struct ast_event_sub *event_sub)
 605 {
 606         struct ast_event *event;
 607         struct ast_event_sub *sub;
 608         enum ast_event_type event_type = -1;
 609         struct ast_event_ie_val *ie_val;
 610
 611         if (event_sub->type != AST_EVENT_SUB)
 612                 return;
 613
 614         AST_LIST_TRAVERSE(&event_sub->ie_vals, ie_val, entry) {
 615                 if (ie_val->ie_type == AST_EVENT_IE_EVENTTYPE) {
 616                         event_type = ie_val->payload.uint;
 617                         break;
 618                 }
 619         }
 620
 621         if (event_type == -1)
 622                 return;
 623
 624         AST_RWDLLIST_RDLOCK(&ast_event_subs[event_type]);
 625         AST_RWDLLIST_TRAVERSE(&ast_event_subs[event_type], sub, entry) {
 626                 if (event_sub == sub) {
 627                         continue;
 628                 }
 629
 630                 event = gen_sub_event(sub);
 631
 632                 if (!event) {
 633                         continue;
 634                 }
 635
 636                 event_sub->cb(event, event_sub->userdata);
 637
 638                 ast_event_destroy(event);
 639         }
 640         AST_RWDLLIST_UNLOCK(&ast_event_subs[event_type]);
 641 }
 642
 643 struct ast_event_sub *ast_event_subscribe_new(enum ast_event_type type,
 644         ast_event_cb_t cb, void *userdata)
 645 {
 646         struct ast_event_sub *sub;
 647
 648         if (type < 0 || type >= AST_EVENT_TOTAL) {
 649                 ast_log(LOG_ERROR, "%u is an invalid type!\n", type);
 650                 return NULL;
 651         }
 652
 653         if (!(sub = ast_calloc(1, sizeof(*sub)))) {
 654                 return NULL;
 655         }
 656
 657         sub->type = type;
 658         sub->cb = cb;
 659         sub->userdata = userdata;
 660         sub->uniqueid = ast_atomic_fetchadd_int((int *) &sub_uniqueid, 1);
 661
 662         return sub;
 663 }
 664
 665 int ast_event_sub_append_ie_uint(struct ast_event_sub *sub,
 666         enum ast_event_ie_type ie_type, uint32_t unsigned_int)
 667 {
 668         struct ast_event_ie_val *ie_val;
 669
 670         if (ie_type <= 0 || ie_type >= AST_EVENT_IE_TOTAL) {
 671                 return -1;
 672         }
 673
 674         if (!(ie_val = ast_calloc(1, sizeof(*ie_val)))) {
 675                 return -1;
 676         }
 677
 678         ie_val->ie_type = ie_type;
 679         ie_val->payload.uint = unsigned_int;
 680         ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_UINT;
 681
 682         AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
 683
 684         return 0;
 685 }
 686
 687 int ast_event_sub_append_ie_bitflags(struct ast_event_sub *sub,
 688         enum ast_event_ie_type ie_type, uint32_t flags)
 689 {
 690         struct ast_event_ie_val *ie_val;
 691
 692         if (ie_type <= 0 || ie_type >= AST_EVENT_IE_TOTAL) {
 693                 return -1;
 694         }
 695
 696         if (!(ie_val = ast_calloc(1, sizeof(*ie_val)))) {
 697                 return -1;
 698         }
 699
 700         ie_val->ie_type = ie_type;
 701         ie_val->payload.uint = flags;
 702         ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_BITFLAGS;
 703
 704         AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
 705
 706         return 0;
 707 }
 708
 709 int ast_event_sub_append_ie_exists(struct ast_event_sub *sub,
 710         enum ast_event_ie_type ie_type)
 711 {
 712         struct ast_event_ie_val *ie_val;
 713
 714         if (ie_type <= 0 || ie_type >= AST_EVENT_IE_TOTAL) {
 715                 return -1;
 716         }
 717
 718         if (!(ie_val = ast_calloc(1, sizeof(*ie_val)))) {
 719                 return -1;
 720         }
 721
 722         ie_val->ie_type = ie_type;
 723         ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_EXISTS;
 724
 725         AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
 726
 727         return 0;
 728 }
 729
 730 int ast_event_sub_append_ie_str(struct ast_event_sub *sub,
 731         enum ast_event_ie_type ie_type, const char *str)
 732 {
 733         struct ast_event_ie_val *ie_val;
 734
 735         if (ie_type <= 0 || ie_type >= AST_EVENT_IE_TOTAL) {
 736                 return -1;
 737         }
 738
 739         if (!(ie_val = ast_calloc(1, sizeof(*ie_val)))) {
 740                 return -1;
 741         }
 742
 743         ie_val->ie_type = ie_type;
 744         ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_STR;
 745
 746         if (!(ie_val->payload.str = ast_strdup(str))) {
 747                 ast_free(ie_val);
 748                 return -1;
 749         }
 750
 751         ie_val->payload.hash = ast_str_hash(str);
 752
 753         AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
 754
 755         return 0;
 756 }
 757
 758 int ast_event_sub_append_ie_raw(struct ast_event_sub *sub,
 759         enum ast_event_ie_type ie_type, void *data, size_t raw_datalen)
 760 {
 761         struct ast_event_ie_val *ie_val;
 762
 763         if (ie_type <= 0 || ie_type >= AST_EVENT_IE_TOTAL) {
 764                 return -1;
 765         }
 766
 767         if (!(ie_val = ast_calloc(1, sizeof(*ie_val)))) {
 768                 return -1;
 769         }
 770
 771         ie_val->ie_type = ie_type;
 772         ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_RAW;
 773         ie_val->raw_datalen = raw_datalen;
 774
 775         if (!(ie_val->payload.raw = ast_malloc(raw_datalen))) {
 776                 ast_free(ie_val);
 777                 return -1;
 778         }
 779
 780         memcpy(ie_val->payload.raw, data, raw_datalen);
 781
 782         AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
 783
 784         return 0;
 785 }
 786
 787 int ast_event_sub_activate(struct ast_event_sub *sub)
 788 {
 789         if (ast_event_check_subscriber(AST_EVENT_SUB,
 790                 AST_EVENT_IE_EVENTTYPE, AST_EVENT_IE_PLTYPE_UINT, sub->type,
 791                 AST_EVENT_IE_END) != AST_EVENT_SUB_NONE) {
 792                 struct ast_event *event;
 793
 794                 event = gen_sub_event(sub);
 795
 796                 if (event) {
 797                         ast_event_queue(event);
 798                 }
 799         }
 800
 801         AST_RWDLLIST_WRLOCK(&ast_event_subs[sub->type]);
 802         AST_RWDLLIST_INSERT_TAIL(&ast_event_subs[sub->type], sub, entry);
 803         AST_RWDLLIST_UNLOCK(&ast_event_subs[sub->type]);
 804
 805         return 0;
 806 }
 807
 808 struct ast_event_sub *ast_event_subscribe(enum ast_event_type type, ast_event_cb_t cb,
 809         char *description, void *userdata, ...)
 810 {
 811         va_list ap;
 812         enum ast_event_ie_type ie_type;
 813         struct ast_event_sub *sub;
 814
 815         if (!(sub = ast_event_subscribe_new(type, cb, userdata))) {
 816                 return NULL;
 817         }
 818
 819         ast_copy_string(sub->description, description, sizeof(sub->description));
 820
 821         va_start(ap, userdata);
 822         for (ie_type = va_arg(ap, enum ast_event_ie_type);
 823                 ie_type != AST_EVENT_IE_END;
 824                 ie_type = va_arg(ap, enum ast_event_ie_type))
 825         {
 826                 enum ast_event_ie_pltype ie_pltype;
 827
 828                 ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
 829
 830                 switch (ie_pltype) {
 831                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
 832                         break;
 833                 case AST_EVENT_IE_PLTYPE_UINT:
 834                 {
 835                         uint32_t unsigned_int = va_arg(ap, uint32_t);
 836                         ast_event_sub_append_ie_uint(sub, ie_type, unsigned_int);
 837                         break;
 838                 }
 839                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
 840                 {
 841                         uint32_t unsigned_int = va_arg(ap, uint32_t);
 842                         ast_event_sub_append_ie_bitflags(sub, ie_type, unsigned_int);
 843                         break;
 844                 }
 845                 case AST_EVENT_IE_PLTYPE_STR:
 846                 {
 847                         const char *str = va_arg(ap, const char *);
 848                         ast_event_sub_append_ie_str(sub, ie_type, str);
 849                         break;
 850                 }
 851                 case AST_EVENT_IE_PLTYPE_RAW:
 852                 {
 853                         void *data = va_arg(ap, void *);
 854                         size_t data_len = va_arg(ap, size_t);
 855                         ast_event_sub_append_ie_raw(sub, ie_type, data, data_len);
 856                         break;
 857                 }
 858                 case AST_EVENT_IE_PLTYPE_EXISTS:
 859                         ast_event_sub_append_ie_exists(sub, ie_type);
 860                         break;
 861                 }
 862         }
 863         va_end(ap);
 864
 865         ast_event_sub_activate(sub);
 866
 867         return sub;
 868 }
 869
 870 void ast_event_sub_destroy(struct ast_event_sub *sub)
 871 {
 872         struct ast_event_ie_val *ie_val;
 873
 874         while ((ie_val = AST_LIST_REMOVE_HEAD(&sub->ie_vals, entry))) {
 875                 ast_event_ie_val_destroy(ie_val);
 876         }
 877
 878         ast_free(sub);
 879 }
 880
 881 const char *ast_event_subscriber_get_description(struct ast_event_sub *sub)
 882 {
 883         return sub ? sub->description : NULL;
 884 }
 885
 886 struct ast_event_sub *ast_event_unsubscribe(struct ast_event_sub *sub)
 887 {
 888         struct ast_event *event;
 889
 890         AST_RWDLLIST_WRLOCK(&ast_event_subs[sub->type]);
 891         AST_DLLIST_REMOVE(&ast_event_subs[sub->type], sub, entry);
 892         AST_RWDLLIST_UNLOCK(&ast_event_subs[sub->type]);
 893
 894         if (ast_event_check_subscriber(AST_EVENT_UNSUB,
 895                 AST_EVENT_IE_EVENTTYPE, AST_EVENT_IE_PLTYPE_UINT, sub->type,
 896                 AST_EVENT_IE_END) != AST_EVENT_SUB_NONE) {
 897
 898                 event = ast_event_new(AST_EVENT_UNSUB,
 899                         AST_EVENT_IE_UNIQUEID,    AST_EVENT_IE_PLTYPE_UINT, sub->uniqueid,
 900                         AST_EVENT_IE_EVENTTYPE,   AST_EVENT_IE_PLTYPE_UINT, sub->type,
 901                         AST_EVENT_IE_DESCRIPTION, AST_EVENT_IE_PLTYPE_STR, sub->description,
 902                         AST_EVENT_IE_END);
 903
 904                 if (event) {
 905                         ast_event_queue(event);
 906                 }
 907         }
 908
 909         ast_event_sub_destroy(sub);
 910
 911         return NULL;
 912 }
 913
 914 void ast_event_iterator_init(struct ast_event_iterator *iterator, const struct ast_event *event)
 915 {
 916         iterator->event_len = ntohs(event->event_len);
 917         iterator->event = event;
 918         iterator->ie = (struct ast_event_ie *) ( ((char *) event) + sizeof(*event) );
 919 }
 920
 921 int ast_event_iterator_next(struct ast_event_iterator *iterator)
 922 {
 923         iterator->ie = (struct ast_event_ie *) ( ((char *) iterator->ie) + sizeof(*iterator->ie) + ntohs(iterator->ie->ie_payload_len));
 924         return ((iterator->event_len <= (((char *) iterator->ie) - ((char *) iterator->event))) ? -1 : 0);
 925 }
 926
 927 enum ast_event_ie_type ast_event_iterator_get_ie_type(struct ast_event_iterator *iterator)
 928 {
 929         return ntohs(iterator->ie->ie_type);
 930 }
 931
 932 uint32_t ast_event_iterator_get_ie_uint(struct ast_event_iterator *iterator)
 933 {
 934         return ntohl(get_unaligned_uint32(iterator->ie->ie_payload));
 935 }
 936
 937 uint32_t ast_event_iterator_get_ie_bitflags(struct ast_event_iterator *iterator)
 938 {
 939         return ntohl(get_unaligned_uint32(iterator->ie->ie_payload));
 940 }
 941
 942 const char *ast_event_iterator_get_ie_str(struct ast_event_iterator *iterator)
 943 {
 944         const struct ast_event_ie_str_payload *str_payload;
 945
 946         str_payload = (struct ast_event_ie_str_payload *) iterator->ie->ie_payload;
 947
 948         return str_payload->str;
 949 }
 950
 951 void *ast_event_iterator_get_ie_raw(struct ast_event_iterator *iterator)
 952 {
 953         return iterator->ie->ie_payload;
 954 }
 955
 956 enum ast_event_type ast_event_get_type(const struct ast_event *event)
 957 {
 958         return ntohs(event->type);
 959 }
 960
 961 uint32_t ast_event_get_ie_uint(const struct ast_event *event, enum ast_event_ie_type ie_type)
 962 {
 963         const uint32_t *ie_val;
 964
 965         ie_val = ast_event_get_ie_raw(event, ie_type);
 966
 967         return ie_val ? ntohl(get_unaligned_uint32(ie_val)) : 0;
 968 }
 969
 970 uint32_t ast_event_get_ie_bitflags(const struct ast_event *event, enum ast_event_ie_type ie_type)
 971 {
 972         const uint32_t *ie_val;
 973
 974         ie_val = ast_event_get_ie_raw(event, ie_type);
 975
 976         return ie_val ? ntohl(get_unaligned_uint32(ie_val)) : 0;
 977 }
 978
 979 uint32_t ast_event_get_ie_str_hash(const struct ast_event *event, enum ast_event_ie_type ie_type)
 980 {
 981         const struct ast_event_ie_str_payload *str_payload;
 982
 983         str_payload = ast_event_get_ie_raw(event, ie_type);
 984
 985         return str_payload->hash;
 986 }
 987
 988 const char *ast_event_get_ie_str(const struct ast_event *event, enum ast_event_ie_type ie_type)
 989 {
 990         const struct ast_event_ie_str_payload *str_payload;
 991
 992         str_payload = ast_event_get_ie_raw(event, ie_type);
 993
 994         return str_payload->str;
 995 }
 996
 997 const void *ast_event_get_ie_raw(const struct ast_event *event, enum ast_event_ie_type ie_type)
 998 {
 999         struct ast_event_iterator iterator;
1000         int res = 0;
1001
1002         for (ast_event_iterator_init(&iterator, event); !res; res = ast_event_iterator_next(&iterator)) {
1003                 if (ast_event_iterator_get_ie_type(&iterator) == ie_type) {
1004                         return ast_event_iterator_get_ie_raw(&iterator);
1005                 }
1006         }
1007
1008         return NULL;
1009 }
1010
1011 int ast_event_append_ie_str(struct ast_event **event, enum ast_event_ie_type ie_type,
1012         const char *str)
1013 {
1014         struct ast_event_ie_str_payload *str_payload;
1015         size_t payload_len;
1016
1017         payload_len = sizeof(*str_payload) + strlen(str);
1018         str_payload = alloca(payload_len);
1019
1020         strcpy(str_payload->str, str);
1021         str_payload->hash = ast_str_hash(str);
1022
1023         return ast_event_append_ie_raw(event, ie_type, str_payload, payload_len);
1024 }
1025
1026 int ast_event_append_ie_uint(struct ast_event **event, enum ast_event_ie_type ie_type,
1027         uint32_t data)
1028 {
1029         data = htonl(data);
1030         return ast_event_append_ie_raw(event, ie_type, &data, sizeof(data));
1031 }
1032
1033 int ast_event_append_ie_bitflags(struct ast_event **event, enum ast_event_ie_type ie_type,
1034         uint32_t flags)
1035 {
1036         flags = htonl(flags);
1037         return ast_event_append_ie_raw(event, ie_type, &flags, sizeof(flags));
1038 }
1039
1040 int ast_event_append_ie_raw(struct ast_event **event, enum ast_event_ie_type ie_type,
1041         const void *data, size_t data_len)
1042 {
1043         struct ast_event_ie *ie;
1044         unsigned int extra_len;
1045         uint16_t event_len;
1046
1047         event_len = ntohs((*event)->event_len);
1048         extra_len = sizeof(*ie) + data_len;
1049
1050         if (!(*event = ast_realloc(*event, event_len + extra_len))) {
1051                 return -1;
1052         }
1053
1054         ie = (struct ast_event_ie *) ( ((char *) *event) + event_len );
1055         ie->ie_type = htons(ie_type);
1056         ie->ie_payload_len = htons(data_len);
1057         memcpy(ie->ie_payload, data, data_len);
1058
1059         (*event)->event_len = htons(event_len + extra_len);
1060
1061         return 0;
1062 }
1063
1064 struct ast_event *ast_event_new(enum ast_event_type type, ...)
1065 {
1066         va_list ap;
1067         struct ast_event *event;
1068         enum ast_event_ie_type ie_type;
1069         struct ast_event_ie_val *ie_val;
1070         int has_ie = 0;
1071         AST_LIST_HEAD_NOLOCK_STATIC(ie_vals, ast_event_ie_val);
1072
1073         /* Invalid type */
1074         if (type >= AST_EVENT_TOTAL) {
1075                 ast_log(LOG_WARNING, "Someone tried to create an event of invalid "
1076                         "type '%d'!\n", type);
1077                 return NULL;
1078         }
1079
1080         va_start(ap, type);
1081         for (ie_type = va_arg(ap, enum ast_event_ie_type);
1082                 ie_type != AST_EVENT_IE_END;
1083                 ie_type = va_arg(ap, enum ast_event_ie_type))
1084         {
1085                 struct ast_event_ie_val *ie_value = alloca(sizeof(*ie_value));
1086                 int insert = 1;
1087                 memset(ie_value, 0, sizeof(*ie_value));
1088                 ie_value->ie_type = ie_type;
1089                 ie_value->ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
1090                 switch (ie_value->ie_pltype) {
1091                 case AST_EVENT_IE_PLTYPE_UINT:
1092                         ie_value->payload.uint = va_arg(ap, uint32_t);
1093                         break;
1094                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
1095                         ie_value->payload.uint = va_arg(ap, uint32_t);
1096                         break;
1097                 case AST_EVENT_IE_PLTYPE_STR:
1098                         ie_value->payload.str = va_arg(ap, const char *);
1099                         break;
1100                 case AST_EVENT_IE_PLTYPE_RAW:
1101                 {
1102                         void *data = va_arg(ap, void *);
1103                         size_t datalen = va_arg(ap, size_t);
1104                         ie_value->payload.raw = alloca(datalen);
1105                         memcpy(ie_value->payload.raw, data, datalen);
1106                         ie_value->raw_datalen = datalen;
1107                         break;
1108                 }
1109                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
1110                         insert = 0;
1111                         break;
1112                 case AST_EVENT_IE_PLTYPE_EXISTS:
1113                         break;
1114                 }
1115
1116                 if (insert) {
1117                         AST_LIST_INSERT_TAIL(&ie_vals, ie_value, entry);
1118                         has_ie = 1;
1119                 }
1120         }
1121         va_end(ap);
1122
1123         if (!(event = ast_calloc(1, sizeof(*event)))) {
1124                 return NULL;
1125         }
1126
1127         event->type = htons(type);
1128         event->event_len = htons(sizeof(*event));
1129
1130         AST_LIST_TRAVERSE(&ie_vals, ie_val, entry) {
1131                 switch (ie_val->ie_pltype) {
1132                 case AST_EVENT_IE_PLTYPE_STR:
1133                         ast_event_append_ie_str(&event, ie_val->ie_type, ie_val->payload.str);
1134                         break;
1135                 case AST_EVENT_IE_PLTYPE_UINT:
1136                         ast_event_append_ie_uint(&event, ie_val->ie_type, ie_val->payload.uint);
1137                         break;
1138                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
1139                         ast_event_append_ie_bitflags(&event, ie_val->ie_type, ie_val->payload.uint);
1140                         break;
1141                 case AST_EVENT_IE_PLTYPE_RAW:
1142                         ast_event_append_ie_raw(&event, ie_val->ie_type,
1143                                         ie_val->payload.raw, ie_val->raw_datalen);
1144                         break;
1145                 case AST_EVENT_IE_PLTYPE_EXISTS:
1146                         ast_log(LOG_WARNING, "PLTYPE_EXISTS unsupported in event_new\n");
1147                         break;
1148                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
1149                         ast_log(LOG_WARNING, "PLTYPE_UNKNOWN passed as an IE type "
1150                                         "for a new event\n");
1151                         break;
1152                 }
1153
1154                 if (!event) {
1155                         break;
1156                 }
1157         }
1158
1159         if (has_ie && !ast_event_get_ie_raw(event, AST_EVENT_IE_EID)) {
1160                 /* If the event is originating on this server, add the server's
1161                  * entity ID to the event. */
1162                 ast_event_append_ie_raw(&event, AST_EVENT_IE_EID, &ast_eid_default, sizeof(ast_eid_default));
1163         }
1164
1165         return event;
1166 }
1167
1168 void ast_event_destroy(struct ast_event *event)
1169 {
1170         ast_free(event);
1171 }
1172
1173 static void ast_event_ref_destroy(void *obj)
1174 {
1175         struct ast_event_ref *event_ref = obj;
1176
1177         ast_event_destroy(event_ref->event);
1178 }
1179
1180 static struct ast_event *ast_event_dup(const struct ast_event *event)
1181 {
1182         struct ast_event *dup_event;
1183         uint16_t event_len;
1184
1185         event_len = ast_event_get_size(event);
1186
1187         if (!(dup_event = ast_calloc(1, event_len))) {
1188                 return NULL;
1189         }
1190
1191         memcpy(dup_event, event, event_len);
1192
1193         return dup_event;
1194 }
1195
1196 struct ast_event *ast_event_get_cached(enum ast_event_type type, ...)
1197 {
1198         va_list ap;
1199         enum ast_event_ie_type ie_type;
1200         struct ast_event *dup_event = NULL;
1201         struct ast_event_ref *cached_event_ref;
1202         struct ast_event *cache_arg_event;
1203         struct ast_event_ref tmp_event_ref = {
1204                 .event = NULL,
1205         };
1206         struct ao2_container *container = NULL;
1207
1208         if (type >= AST_EVENT_TOTAL) {
1209                 ast_log(LOG_ERROR, "%u is an invalid type!\n", type);
1210                 return NULL;
1211         }
1212
1213         if (!(container = ast_event_cache[type].container)) {
1214                 ast_log(LOG_ERROR, "%u is not a cached event type\n", type);
1215                 return NULL;
1216         }
1217
1218         if (!(cache_arg_event = ast_event_new(type, AST_EVENT_IE_END))) {
1219                 return NULL;
1220         }
1221
1222         va_start(ap, type);
1223         for (ie_type = va_arg(ap, enum ast_event_ie_type);
1224                 ie_type != AST_EVENT_IE_END;
1225                 ie_type = va_arg(ap, enum ast_event_ie_type))
1226         {
1227                 enum ast_event_ie_pltype ie_pltype;
1228
1229                 ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
1230
1231                 switch (ie_pltype) {
1232                 case AST_EVENT_IE_PLTYPE_UINT:
1233                         ast_event_append_ie_uint(&cache_arg_event, ie_type, va_arg(ap, uint32_t));
1234                         break;
1235                 case AST_EVENT_IE_PLTYPE_BITFLAGS:
1236                         ast_event_append_ie_bitflags(&cache_arg_event, ie_type, va_arg(ap, uint32_t));
1237                         break;
1238                 case AST_EVENT_IE_PLTYPE_STR:
1239                         ast_event_append_ie_str(&cache_arg_event, ie_type, va_arg(ap, const char *));
1240                         break;
1241                 case AST_EVENT_IE_PLTYPE_RAW:
1242                 {
1243                         void *data = va_arg(ap, void *);
1244                         size_t datalen = va_arg(ap, size_t);
1245                         ast_event_append_ie_raw(&cache_arg_event, ie_type, data, datalen);
1246                 }
1247                 case AST_EVENT_IE_PLTYPE_EXISTS:
1248                         ast_log(LOG_WARNING, "PLTYPE_EXISTS not supported by this function\n");
1249                         break;
1250                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
1251                         break;
1252                 }
1253         }
1254         va_end(ap);
1255
1256         tmp_event_ref.event = cache_arg_event;
1257
1258         cached_event_ref = ao2_find(container, &tmp_event_ref, OBJ_POINTER);
1259
1260         ast_event_destroy(cache_arg_event);
1261         cache_arg_event = NULL;
1262
1263         if (cached_event_ref) {
1264                 dup_event = ast_event_dup(cached_event_ref->event);
1265                 ao2_ref(cached_event_ref, -1);
1266                 cached_event_ref = NULL;
1267         }
1268
1269         return dup_event;
1270 }
1271
1272 static struct ast_event_ref *alloc_event_ref(void)
1273 {
1274         return ao2_alloc(sizeof(struct ast_event_ref), ast_event_ref_destroy);
1275 }
1276
1277 /*! \brief Duplicate an event and add it to the cache
1278  * \note This assumes this index in to the cache is locked */
1279 static int ast_event_dup_and_cache(const struct ast_event *event)
1280 {
1281         struct ast_event *dup_event;
1282         struct ast_event_ref *event_ref;
1283
1284         if (!(dup_event = ast_event_dup(event))) {
1285                 return -1;
1286         }
1287
1288         if (!(event_ref = alloc_event_ref())) {
1289                 ast_event_destroy(dup_event);
1290                 return -1;
1291         }
1292
1293         event_ref->event = dup_event;
1294
1295         ao2_link(ast_event_cache[ast_event_get_type(event)].container, event_ref);
1296
1297         ao2_ref(event_ref, -1);
1298
1299         return 0;
1300 }
1301
1302 int ast_event_queue_and_cache(struct ast_event *event)
1303 {
1304         struct ao2_container *container;
1305         struct ast_event_ref tmp_event_ref = {
1306                 .event = event,
1307         };
1308         int res = -1;
1309
1310         if (!(container = ast_event_cache[ast_event_get_type(event)].container)) {
1311                 ast_log(LOG_WARNING, "cache requested for non-cached event type\n");
1312                 goto queue_event;
1313         }
1314
1315         /* Remove matches from the cache */
1316         ao2_callback(container, OBJ_POINTER | OBJ_UNLINK | OBJ_MULTIPLE | OBJ_NODATA,
1317                         ast_event_cmp, &tmp_event_ref);
1318
1319         res = ast_event_dup_and_cache(event);
1320
1321 queue_event:
1322         return ast_event_queue(event) ? -1 : res;
1323 }
1324
1325 static int handle_event(void *data)
1326 {
1327         struct ast_event_ref *event_ref = data;
1328         struct ast_event_sub *sub;
1329         uint16_t host_event_type;
1330
1331         host_event_type = ntohs(event_ref->event->type);
1332
1333         /* Subscribers to this specific event first */
1334         AST_RWDLLIST_RDLOCK(&ast_event_subs[host_event_type]);
1335         AST_RWDLLIST_TRAVERSE(&ast_event_subs[host_event_type], sub, entry) {
1336                 struct ast_event_ie_val *ie_val;
1337                 AST_LIST_TRAVERSE(&sub->ie_vals, ie_val, entry) {
1338                         if (!match_ie_val(event_ref->event, ie_val, NULL)) {
1339                                 break;
1340                         }
1341                 }
1342                 if (ie_val) {
1343                         continue;
1344                 }
1345                 sub->cb(event_ref->event, sub->userdata);
1346         }
1347         AST_RWDLLIST_UNLOCK(&ast_event_subs[host_event_type]);
1348
1349         /* Now to subscribers to all event types */
1350         AST_RWDLLIST_RDLOCK(&ast_event_subs[AST_EVENT_ALL]);
1351         AST_RWDLLIST_TRAVERSE(&ast_event_subs[AST_EVENT_ALL], sub, entry) {
1352                 sub->cb(event_ref->event, sub->userdata);
1353         }
1354         AST_RWDLLIST_UNLOCK(&ast_event_subs[AST_EVENT_ALL]);
1355
1356         ao2_ref(event_ref, -1);
1357
1358         return 0;
1359 }
1360
1361 int ast_event_queue(struct ast_event *event)
1362 {
1363         struct ast_event_ref *event_ref;
1364         uint16_t host_event_type;
1365
1366         host_event_type = ntohs(event->type);
1367
1368         /* Invalid type */
1369         if (host_event_type >= AST_EVENT_TOTAL) {
1370                 ast_log(LOG_WARNING, "Someone tried to queue an event of invalid "
1371                         "type '%d'!\n", host_event_type);
1372                 return -1;
1373         }
1374
1375         /* If nobody has subscribed to this event type, throw it away now */
1376         if (ast_event_check_subscriber(host_event_type, AST_EVENT_IE_END)
1377                         == AST_EVENT_SUB_NONE) {
1378                 ast_event_destroy(event);
1379                 ast_log(LOG_NOTICE, "Event destroyed, no subscriber\n");
1380                 return 0;
1381         }
1382
1383         if (!(event_ref = alloc_event_ref())) {
1384                 return -1;
1385         }
1386
1387         event_ref->event = event;
1388
1389         return ast_taskprocessor_push(event_dispatcher, handle_event, event_ref);
1390 }
1391
1392 static int ast_event_hash_mwi(const void *obj, const int flags)
1393 {
1394         const struct ast_event *event = obj;
1395         const char *mailbox = ast_event_get_ie_str(event, AST_EVENT_IE_MAILBOX);
1396         const char *context = ast_event_get_ie_str(event, AST_EVENT_IE_CONTEXT);
1397
1398         return ast_str_hash_add(context, ast_str_hash(mailbox));
1399 }
1400
1401 /*!
1402  * \internal
1403  * \brief Hash function for AST_EVENT_DEVICE_STATE
1404  *
1405  * \param[in] obj an ast_event
1406  * \param[in] flags unused
1407  *
1408  * \return hash value
1409  */
1410 static int ast_event_hash_devstate(const void *obj, const int flags)
1411 {
1412         const struct ast_event *event = obj;
1413
1414         return ast_str_hash(ast_event_get_ie_str(event, AST_EVENT_IE_DEVICE));
1415 }
1416
1417 /*!
1418  * \internal
1419  * \brief Hash function for AST_EVENT_DEVICE_STATE_CHANGE
1420  *
1421  * \param[in] obj an ast_event
1422  * \param[in] flags unused
1423  *
1424  * \return hash value
1425  */
1426 static int ast_event_hash_devstate_change(const void *obj, const int flags)
1427 {
1428         const struct ast_event *event = obj;
1429
1430         return ast_str_hash(ast_event_get_ie_str(event, AST_EVENT_IE_DEVICE));
1431 }
1432
1433 static int ast_event_hash(const void *obj, const int flags)
1434 {
1435         const struct ast_event_ref *event_ref;
1436         const struct ast_event *event;
1437         ao2_hash_fn *hash_fn;
1438
1439         event_ref = obj;
1440         event = event_ref->event;
1441
1442         if (!(hash_fn = ast_event_cache[ast_event_get_type(event)].hash_fn)) {
1443                 return 0;
1444         }
1445
1446         return hash_fn(event, flags);
1447 }
1448
1449 /*!
1450  * \internal
1451  * \brief Compare two events
1452  *
1453  * \param[in] obj the first event, as an ast_event_ref
1454  * \param[in] arg the second event, as an ast_event_ref
1455  * \param[in] flags unused
1456  *
1457  * \pre Both events must be the same type.
1458  * \pre The event type must be declared as a cached event type in ast_event_cache
1459  *
1460  * \details This function takes two events, and determines if they are considered
1461  * equivalent.  The values of information elements specified in the cache arguments
1462  * for the event type are used to determine if the events are equivalent.
1463  *
1464  * \retval 0 No match
1465  * \retval CMP_MATCH The events are considered equivalent based on the cache arguments
1466  */
1467 static int ast_event_cmp(void *obj, void *arg, int flags)
1468 {
1469         struct ast_event_ref *event_ref, *event_ref2;
1470         struct ast_event *event, *event2;
1471         int res = CMP_MATCH;
1472         int i;
1473         enum ast_event_ie_type *cache_args;
1474
1475         event_ref = obj;
1476         event = event_ref->event;
1477
1478         event_ref2 = arg;
1479         event2 = event_ref2->event;
1480
1481         cache_args = ast_event_cache[ast_event_get_type(event)].cache_args;
1482
1483         for (i = 0; i < ARRAY_LEN(ast_event_cache[0].cache_args) && cache_args[i]; i++) {
1484                 struct ast_event_ie_val ie_val = {
1485                         .ie_pltype = ast_event_get_ie_pltype(cache_args[i]),
1486                         .ie_type = cache_args[i],
1487                 };
1488
1489                 if (!match_ie_val(event, &ie_val, event2)) {
1490                         res = 0;
1491                         break;
1492                 }
1493         }
1494
1495         return res;
1496 }
1497
1498 int ast_event_init(void)
1499 {
1500         int i;
1501
1502         for (i = 0; i < AST_EVENT_TOTAL; i++) {
1503                 AST_RWDLLIST_HEAD_INIT(&ast_event_subs[i]);
1504         }
1505
1506         for (i = 0; i < AST_EVENT_TOTAL; i++) {
1507                 if (!ast_event_cache[i].hash_fn) {
1508                         /* This event type is not cached. */
1509                         continue;
1510                 }
1511
1512                 if (!(ast_event_cache[i].container = ao2_container_alloc(NUM_CACHE_BUCKETS,
1513                                 ast_event_hash, ast_event_cmp))) {
1514                         return -1;
1515                 }
1516         }
1517
1518         if (!(event_dispatcher = ast_taskprocessor_get("core_event_dispatcher", 0))) {
1519                 return -1;
1520         }
1521
1522         return 0;
1523 }