main/event.c

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