main/event.c

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