sysmocom
/
asterisk
11
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
asterisk/main/event.c

1311 lines
34 KiB
C
Raw Blame History

/*
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 2007 - 2008, Digium, Inc.
*
* Russell Bryant <russell@digium.com>
*
* See http://www.asterisk.org for more information about
* the Asterisk project. Please do not directly contact
* any of the maintainers of this project for assistance;
* the project provides a web site, mailing lists and IRC
* channels for your use.
*
* This program is free software, distributed under the terms of
* the GNU General Public License Version 2. See the LICENSE file
* at the top of the source tree.
*/
/*! \file
*
* \brief Internal generic event system
*
* \author Russell Bryant <russell@digium.com>
*/
#include "asterisk.h"
ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
#include "asterisk/_private.h"
#include "asterisk/event.h"
#include "asterisk/linkedlists.h"
#include "asterisk/dlinkedlists.h"
#include "asterisk/lock.h"
#include "asterisk/utils.h"
#include "asterisk/unaligned.h"
#include "asterisk/utils.h"
#include "asterisk/taskprocessor.h"
#include "asterisk/astobj2.h"
struct ast_taskprocessor *event_dispatcher;
/*!
* \brief An event information element
*
* \note The format of this structure is important. Since these events may
* be sent directly over a network, changing this structure will break
* compatibility with older versions. However, at this point, this code
* has not made it into a release, so it is still fair game for change.
*/
struct ast_event_ie {
enum ast_event_ie_type ie_type:16;
/*! Total length of the IE payload */
uint16_t ie_payload_len;
unsigned char ie_payload[0];
} __attribute__((packed));
/*!
* \brief The payload for a string information element
*/
struct ast_event_ie_str_payload {
/*! \brief A hash calculated with ast_str_hash(), to speed up comparisons */
uint32_t hash;
/*! \brief The actual string, null terminated */
char str[1];
} __attribute__((packed));
/*!
* \brief An event
*
* An ast_event consists of an event header (this structure), and zero or
* more information elements defined by ast_event_ie.
*
* \note The format of this structure is important. Since these events may
* be sent directly over a network, changing this structure will break
* compatibility with older versions. However, at this point, this code
* has not made it into a release, so it is still fair game for change.
*/
struct ast_event {
/*! Event type */
enum ast_event_type type:16;
/*! Total length of the event */
uint16_t event_len:16;
/*! The data payload of the event, made up of information elements */
unsigned char payload[0];
} __attribute__((packed));
/*!
* \brief A holder for an event
*
* \details This struct used to have more of a purpose than it does now.
* It is used to hold events in the event cache. It can be completely removed
* if one of these two things is done:
* - ast_event gets changed such that it never has to be realloc()d
* - astobj2 is updated so that you can realloc() an astobj2 object
*/
struct ast_event_ref {
struct ast_event *event;
};
struct ast_event_ie_val {
AST_LIST_ENTRY(ast_event_ie_val) entry;
enum ast_event_ie_type ie_type;
enum ast_event_ie_pltype ie_pltype;
union {
uint32_t uint;
struct {
uint32_t hash;
const char *str;
};
void *raw;
} payload;
size_t raw_datalen;
};
/*! \brief Event subscription */
struct ast_event_sub {
enum ast_event_type type;
ast_event_cb_t cb;
void *userdata;
uint32_t uniqueid;
AST_LIST_HEAD_NOLOCK(, ast_event_ie_val) ie_vals;
AST_RWDLLIST_ENTRY(ast_event_sub) entry;
};
static uint32_t sub_uniqueid;
/*! \brief Event subscriptions
* The event subscribers are indexed by which event they are subscribed to */
static AST_RWDLLIST_HEAD(ast_event_sub_list, ast_event_sub) ast_event_subs[AST_EVENT_TOTAL];
static int ast_event_cmp(void *obj, void *arg, int flags);
static int ast_event_hash_mwi(const void *obj, const int flags);
static int ast_event_hash_devstate(const void *obj, const int flags);
static int ast_event_hash_devstate_change(const void *obj, const int flags);
#ifdef LOW_MEMORY
#define NUM_CACHE_BUCKETS 17
#else
#define NUM_CACHE_BUCKETS 563
#endif
#define MAX_CACHE_ARGS 8
/*!
* \brief Event types that are kept in the cache.
*/
static struct {
/*!
* \brief Container of cached events
*
* \details This gets allocated in ast_event_init() when Asterisk starts
* for the event types declared as using the cache.
*/
struct ao2_container *container;
/*! \brief Event type specific hash function */
ao2_hash_fn *hash_fn;
/*!
* \brief Information Elements used for caching
*
* \details This array is the set of information elements that will be unique
* among all events in the cache for this event type. When a new event gets
* cached, a previous event with the same values for these information elements
* will be replaced.
*/
enum ast_event_ie_type cache_args[MAX_CACHE_ARGS];
} ast_event_cache[AST_EVENT_TOTAL] = {
[AST_EVENT_MWI] = {
.hash_fn = ast_event_hash_mwi,
.cache_args = { AST_EVENT_IE_MAILBOX, AST_EVENT_IE_CONTEXT },
},
[AST_EVENT_DEVICE_STATE] = {
.hash_fn = ast_event_hash_devstate,
.cache_args = { AST_EVENT_IE_DEVICE, },
},
[AST_EVENT_DEVICE_STATE_CHANGE] = {
.hash_fn = ast_event_hash_devstate_change,
.cache_args = { AST_EVENT_IE_DEVICE, AST_EVENT_IE_EID, },
},
};
/*!
* The index of each entry _must_ match the event type number!
*/
static struct event_name {
enum ast_event_type type;
const char *name;
} event_names[] = {
{ 0, "" },
{ AST_EVENT_CUSTOM, "Custom" },
{ AST_EVENT_MWI, "MWI" },
{ AST_EVENT_SUB, "Subscription" },
{ AST_EVENT_UNSUB, "Unsubscription" },
{ AST_EVENT_DEVICE_STATE, "DeviceState" },
{ AST_EVENT_DEVICE_STATE_CHANGE, "DeviceStateChange" },
};
/*!
* The index of each entry _must_ match the event ie number!
*/
static struct ie_map {
enum ast_event_ie_type ie_type;
enum ast_event_ie_pltype ie_pltype;
const char *name;
} ie_maps[] = {
{ 0, 0, "" },
{ AST_EVENT_IE_NEWMSGS, AST_EVENT_IE_PLTYPE_UINT, "NewMessages" },
{ AST_EVENT_IE_OLDMSGS, AST_EVENT_IE_PLTYPE_UINT, "OldMessages" },
{ AST_EVENT_IE_MAILBOX, AST_EVENT_IE_PLTYPE_STR, "Mailbox" },
{ AST_EVENT_IE_UNIQUEID, AST_EVENT_IE_PLTYPE_UINT, "UniqueID" },
{ AST_EVENT_IE_EVENTTYPE, AST_EVENT_IE_PLTYPE_UINT, "EventType" },
{ AST_EVENT_IE_EXISTS, AST_EVENT_IE_PLTYPE_UINT, "Exists" },
{ AST_EVENT_IE_DEVICE, AST_EVENT_IE_PLTYPE_STR, "Device" },
{ AST_EVENT_IE_STATE, AST_EVENT_IE_PLTYPE_UINT, "State" },
{ AST_EVENT_IE_CONTEXT, AST_EVENT_IE_PLTYPE_STR, "Context" },
{ AST_EVENT_IE_EID, AST_EVENT_IE_PLTYPE_RAW, "EntityID" },
};
const char *ast_event_get_type_name(const struct ast_event *event)
{
enum ast_event_type type;
type = ast_event_get_type(event);
if (type >= AST_EVENT_TOTAL || type < 0) {
ast_log(LOG_ERROR, "Invalid event type - '%d'\n", type);
return "";
}
return event_names[type].name;
}
int ast_event_str_to_event_type(const char *str, enum ast_event_type *event_type)
{
int i;
for (i = 0; i < ARRAY_LEN(event_names); i++) {
if (strcasecmp(event_names[i].name, str))
continue;
*event_type = event_names[i].type;
return 0;
}
return -1;
}
const char *ast_event_get_ie_type_name(enum ast_event_ie_type ie_type)
{
if (ie_type <= 0 || ie_type > AST_EVENT_IE_MAX) {
ast_log(LOG_ERROR, "Invalid IE type - '%d'\n", ie_type);
return "";
}
if (ie_maps[ie_type].ie_type != ie_type) {
ast_log(LOG_ERROR, "The ie type passed in does not match the ie type defined in the ie table.\n");
return "";
}
return ie_maps[ie_type].name;
}
enum ast_event_ie_pltype ast_event_get_ie_pltype(enum ast_event_ie_type ie_type)
{
if (ie_type <= 0 || ie_type > AST_EVENT_IE_MAX) {
ast_log(LOG_ERROR, "Invalid IE type - '%d'\n", ie_type);
return AST_EVENT_IE_PLTYPE_UNKNOWN;
}
if (ie_maps[ie_type].ie_type != ie_type) {
ast_log(LOG_ERROR, "The ie type passed in does not match the ie type defined in the ie table.\n");
return AST_EVENT_IE_PLTYPE_UNKNOWN;
}
return ie_maps[ie_type].ie_pltype;
}
int ast_event_str_to_ie_type(const char *str, enum ast_event_ie_type *ie_type)
{
int i;
for (i = 0; i < ARRAY_LEN(ie_maps); i++) {
if (strcasecmp(ie_maps[i].name, str))
continue;
*ie_type = ie_maps[i].ie_type;
return 0;
}
return -1;
}
size_t ast_event_get_size(const struct ast_event *event)
{
size_t res;
res = ntohs(event->event_len);
return res;
}
static void ast_event_ie_val_destroy(struct ast_event_ie_val *ie_val)
{
switch (ie_val->ie_pltype) {
case AST_EVENT_IE_PLTYPE_STR:
ast_free((char *) ie_val->payload.str);
break;
case AST_EVENT_IE_PLTYPE_RAW:
ast_free(ie_val->payload.raw);
break;
case AST_EVENT_IE_PLTYPE_UINT:
case AST_EVENT_IE_PLTYPE_EXISTS:
case AST_EVENT_IE_PLTYPE_UNKNOWN:
break;
}
ast_free(ie_val);
}
enum ast_event_subscriber_res ast_event_check_subscriber(enum ast_event_type type, ...)
{
va_list ap;
enum ast_event_ie_type ie_type;
enum ast_event_subscriber_res res = AST_EVENT_SUB_NONE;
struct ast_event_ie_val *ie_val, *sub_ie_val;
struct ast_event_sub *sub;
AST_LIST_HEAD_NOLOCK_STATIC(ie_vals, ast_event_ie_val);
if (type >= AST_EVENT_TOTAL) {
ast_log(LOG_ERROR, "%u is an invalid type!\n", type);
return res;
}
va_start(ap, type);
for (ie_type = va_arg(ap, enum ast_event_type);
ie_type != AST_EVENT_IE_END;
ie_type = va_arg(ap, enum ast_event_type))
{
struct ast_event_ie_val *ie_value = alloca(sizeof(*ie_value));
memset(ie_value, 0, sizeof(*ie_value));
ie_value->ie_type = ie_type;
ie_value->ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
if (ie_value->ie_pltype == AST_EVENT_IE_PLTYPE_UINT)
ie_value->payload.uint = va_arg(ap, uint32_t);
else if (ie_value->ie_pltype == AST_EVENT_IE_PLTYPE_STR)
ie_value->payload.str = ast_strdupa(va_arg(ap, const char *));
else if (ie_value->ie_pltype == AST_EVENT_IE_PLTYPE_RAW) {
void *data = va_arg(ap, void *);
size_t datalen = va_arg(ap, size_t);
ie_value->payload.raw = alloca(datalen);
memcpy(ie_value->payload.raw, data, datalen);
ie_value->raw_datalen = datalen;
}
AST_LIST_INSERT_TAIL(&ie_vals, ie_value, entry);
}
va_end(ap);
AST_RWDLLIST_RDLOCK(&ast_event_subs[type]);
AST_RWDLLIST_TRAVERSE(&ast_event_subs[type], sub, entry) {
AST_LIST_TRAVERSE(&ie_vals, ie_val, entry) {
AST_LIST_TRAVERSE(&sub->ie_vals, sub_ie_val, entry) {
if (sub_ie_val->ie_type == ie_val->ie_type)
break;
}
if (!sub_ie_val) {
if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_EXISTS)
break;
continue;
}
/* The subscriber doesn't actually care what the value is */
if (sub_ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_EXISTS)
continue;
if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_UINT &&
ie_val->payload.uint != sub_ie_val->payload.uint)
break;
if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_STR &&
strcmp(ie_val->payload.str, sub_ie_val->payload.str))
break;
if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_RAW &&
memcmp(ie_val->payload.raw, sub_ie_val->payload.raw, ie_val->raw_datalen))
break;
}
if (!ie_val)
break;
}
AST_RWDLLIST_UNLOCK(&ast_event_subs[type]);
if (sub) /* All parameters were matched */
return AST_EVENT_SUB_EXISTS;
AST_RWDLLIST_RDLOCK(&ast_event_subs[AST_EVENT_ALL]);
if (!AST_DLLIST_EMPTY(&ast_event_subs[AST_EVENT_ALL]))
res = AST_EVENT_SUB_EXISTS;
AST_RWDLLIST_UNLOCK(&ast_event_subs[AST_EVENT_ALL]);
return res;
}
static int match_ie_val(const struct ast_event *event,
const struct ast_event_ie_val *ie_val, const struct ast_event *event2)
{
if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_UINT) {
uint32_t val = event2 ? ast_event_get_ie_uint(event2, ie_val->ie_type) : ie_val->payload.uint;
if (val == ast_event_get_ie_uint(event, ie_val->ie_type))
return 1;
return 0;
}
if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_STR) {
const char *str;
uint32_t hash;
hash = event2 ? ast_event_get_ie_str_hash(event2, ie_val->ie_type) : ie_val->payload.hash;
if (hash != ast_event_get_ie_str_hash(event, ie_val->ie_type)) {
return 0;
}
str = event2 ? ast_event_get_ie_str(event2, ie_val->ie_type) : ie_val->payload.str;
if (str && !strcmp(str, ast_event_get_ie_str(event, ie_val->ie_type))) {
return 1;
}
return 0;
}
if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_RAW) {
const void *buf = event2 ? ast_event_get_ie_raw(event2, ie_val->ie_type) : ie_val->payload.raw;
if (buf && !memcmp(buf, ast_event_get_ie_raw(event, ie_val->ie_type), ie_val->raw_datalen))
return 1;
return 0;
}
if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_EXISTS) {
if (ast_event_get_ie_raw(event, ie_val->ie_type))
return 1;
return 0;
}
return 0;
}
static int dump_cache_cb(void *obj, void *arg, int flags)
{
const struct ast_event_ref *event_ref = obj;
const struct ast_event *event = event_ref->event;
const struct ast_event_sub *event_sub = arg;
struct ast_event_ie_val *ie_val = NULL;
AST_LIST_TRAVERSE(&event_sub->ie_vals, ie_val, entry) {
if (!match_ie_val(event, ie_val, NULL)) {
break;
}
}
if (!ie_val) {
/* All parameters were matched on this cache entry, so dump it */
event_sub->cb(event, event_sub->userdata);
}
return 0;
}
/*! \brief Dump the event cache for the subscribed event type */
void ast_event_dump_cache(const struct ast_event_sub *event_sub)
{
ao2_callback(ast_event_cache[event_sub->type].container, OBJ_NODATA,
dump_cache_cb, (void *) event_sub);
}
static struct ast_event *gen_sub_event(struct ast_event_sub *sub)
{
struct ast_event_ie_val *ie_val;
struct ast_event *event;
event = ast_event_new(AST_EVENT_SUB,
AST_EVENT_IE_UNIQUEID, AST_EVENT_IE_PLTYPE_UINT, sub->uniqueid,
AST_EVENT_IE_EVENTTYPE, AST_EVENT_IE_PLTYPE_UINT, sub->type,
AST_EVENT_IE_END);
if (!event)
return NULL;
AST_LIST_TRAVERSE(&sub->ie_vals, ie_val, entry) {
switch (ie_val->ie_pltype) {
case AST_EVENT_IE_PLTYPE_UNKNOWN:
break;
case AST_EVENT_IE_PLTYPE_EXISTS:
ast_event_append_ie_uint(&event, AST_EVENT_IE_EXISTS, ie_val->ie_type);
break;
case AST_EVENT_IE_PLTYPE_UINT:
ast_event_append_ie_uint(&event, ie_val->ie_type, ie_val->payload.uint);
break;
case AST_EVENT_IE_PLTYPE_STR:
ast_event_append_ie_str(&event, ie_val->ie_type, ie_val->payload.str);
break;
case AST_EVENT_IE_PLTYPE_RAW:
ast_event_append_ie_raw(&event, ie_val->ie_type, ie_val->payload.raw, ie_val->raw_datalen);
break;
}
if (!event)
break;
}
return event;
}
/*! \brief Send AST_EVENT_SUB events to this subscriber of ... subscriber events */
void ast_event_report_subs(const struct ast_event_sub *event_sub)
{
struct ast_event *event;
struct ast_event_sub *sub;
enum ast_event_type event_type = -1;
struct ast_event_ie_val *ie_val;
if (event_sub->type != AST_EVENT_SUB)
return;
AST_LIST_TRAVERSE(&event_sub->ie_vals, ie_val, entry) {
if (ie_val->ie_type == AST_EVENT_IE_EVENTTYPE) {
event_type = ie_val->payload.uint;
break;
}
}
if (event_type == -1)
return;
AST_RWDLLIST_RDLOCK(&ast_event_subs[event_type]);
AST_RWDLLIST_TRAVERSE(&ast_event_subs[event_type], sub, entry) {
if (event_sub == sub)
continue;
event = gen_sub_event(sub);
if (!event)
continue;
event_sub->cb(event, event_sub->userdata);
ast_event_destroy(event);
}
AST_RWDLLIST_UNLOCK(&ast_event_subs[event_type]);
}
struct ast_event_sub *ast_event_subscribe_new(enum ast_event_type type,
ast_event_cb_t cb, void *userdata)
{
struct ast_event_sub *sub;
if (type < 0 || type >= AST_EVENT_TOTAL) {
ast_log(LOG_ERROR, "%u is an invalid type!\n", type);
return NULL;
}
if (!(sub = ast_calloc(1, sizeof(*sub))))
return NULL;
sub->type = type;
sub->cb = cb;
sub->userdata = userdata;
sub->uniqueid = ast_atomic_fetchadd_int((int *) &sub_uniqueid, 1);
return sub;
}
int ast_event_sub_append_ie_uint(struct ast_event_sub *sub,
enum ast_event_ie_type ie_type, uint32_t unsigned_int)
{
struct ast_event_ie_val *ie_val;
if (ie_type < 0 || ie_type > AST_EVENT_IE_MAX)
return -1;
if (!(ie_val = ast_calloc(1, sizeof(*ie_val))))
return -1;
ie_val->ie_type = ie_type;
ie_val->payload.uint = unsigned_int;
ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_UINT;
AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
return 0;
}
int ast_event_sub_append_ie_exists(struct ast_event_sub *sub,
enum ast_event_ie_type ie_type)
{
struct ast_event_ie_val *ie_val;
if (ie_type < 0 || ie_type > AST_EVENT_IE_MAX)
return -1;
if (!(ie_val = ast_calloc(1, sizeof(*ie_val))))
return -1;
ie_val->ie_type = ie_type;
ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_EXISTS;
AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
return 0;
}
int ast_event_sub_append_ie_str(struct ast_event_sub *sub,
enum ast_event_ie_type ie_type, const char *str)
{
struct ast_event_ie_val *ie_val;
if (ie_type < 0 || ie_type > AST_EVENT_IE_MAX)
return -1;
if (!(ie_val = ast_calloc(1, sizeof(*ie_val))))
return -1;
ie_val->ie_type = ie_type;
ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_STR;
if (!(ie_val->payload.str = ast_strdup(str))) {
ast_free(ie_val);
return -1;
}
ie_val->payload.hash = ast_str_hash(str);
AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
return 0;
}
int ast_event_sub_append_ie_raw(struct ast_event_sub *sub,
enum ast_event_ie_type ie_type, void *data, size_t raw_datalen)
{
struct ast_event_ie_val *ie_val;
if (ie_type < 0 || ie_type > AST_EVENT_IE_MAX)
return -1;
if (!(ie_val = ast_calloc(1, sizeof(*ie_val))))
return -1;
ie_val->ie_type = ie_type;
ie_val->ie_pltype = AST_EVENT_IE_PLTYPE_RAW;
ie_val->raw_datalen = raw_datalen;
if (!(ie_val->payload.raw = ast_malloc(raw_datalen))) {
ast_free(ie_val);
return -1;
}
memcpy(ie_val->payload.raw, data, raw_datalen);
AST_LIST_INSERT_TAIL(&sub->ie_vals, ie_val, entry);
return 0;
}
int ast_event_sub_activate(struct ast_event_sub *sub)
{
if (ast_event_check_subscriber(AST_EVENT_SUB,
AST_EVENT_IE_EVENTTYPE, AST_EVENT_IE_PLTYPE_UINT, sub->type,
AST_EVENT_IE_END) != AST_EVENT_SUB_NONE) {
struct ast_event *event;
event = gen_sub_event(sub);
if (event)
ast_event_queue(event);
}
AST_RWDLLIST_WRLOCK(&ast_event_subs[sub->type]);
AST_RWDLLIST_INSERT_TAIL(&ast_event_subs[sub->type], sub, entry);
AST_RWDLLIST_UNLOCK(&ast_event_subs[sub->type]);
return 0;
}
struct ast_event_sub *ast_event_subscribe(enum ast_event_type type, ast_event_cb_t cb,
void *userdata, ...)
{
va_list ap;
enum ast_event_ie_type ie_type;
struct ast_event_sub *sub;
if (!(sub = ast_event_subscribe_new(type, cb, userdata)))
return NULL;
va_start(ap, userdata);
for (ie_type = va_arg(ap, enum ast_event_type);
ie_type != AST_EVENT_IE_END;
ie_type = va_arg(ap, enum ast_event_type))
{
enum ast_event_ie_pltype ie_pltype;
ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
switch (ie_pltype) {
case AST_EVENT_IE_PLTYPE_UNKNOWN:
break;
case AST_EVENT_IE_PLTYPE_UINT:
{
uint32_t unsigned_int = va_arg(ap, uint32_t);
ast_event_sub_append_ie_uint(sub, ie_type, unsigned_int);
break;
}
case AST_EVENT_IE_PLTYPE_STR:
{
const char *str = va_arg(ap, const char *);
ast_event_sub_append_ie_str(sub, ie_type, str);
break;
}
case AST_EVENT_IE_PLTYPE_RAW:
{
void *data = va_arg(ap, void *);
size_t data_len = va_arg(ap, size_t);
ast_event_sub_append_ie_raw(sub, ie_type, data, data_len);
break;
}
case AST_EVENT_IE_PLTYPE_EXISTS:
ast_event_sub_append_ie_exists(sub, ie_type);
break;
}
}
va_end(ap);
ast_event_sub_activate(sub);
return sub;
}
void ast_event_sub_destroy(struct ast_event_sub *sub)
{
struct ast_event_ie_val *ie_val;
while ((ie_val = AST_LIST_REMOVE_HEAD(&sub->ie_vals, entry)))
ast_event_ie_val_destroy(ie_val);
ast_free(sub);
}
struct ast_event_sub *ast_event_unsubscribe(struct ast_event_sub *sub)
{
struct ast_event *event;
AST_RWDLLIST_WRLOCK(&ast_event_subs[sub->type]);
AST_DLLIST_REMOVE(&ast_event_subs[sub->type], sub, entry);
AST_RWDLLIST_UNLOCK(&ast_event_subs[sub->type]);
if (ast_event_check_subscriber(AST_EVENT_UNSUB,
AST_EVENT_IE_EVENTTYPE, AST_EVENT_IE_PLTYPE_UINT, sub->type,
AST_EVENT_IE_END) != AST_EVENT_SUB_NONE) {
event = ast_event_new(AST_EVENT_UNSUB,
AST_EVENT_IE_UNIQUEID, AST_EVENT_IE_PLTYPE_UINT, sub->uniqueid,
AST_EVENT_IE_EVENTTYPE, AST_EVENT_IE_PLTYPE_UINT, sub->type,
AST_EVENT_IE_END);
if (event)
ast_event_queue(event);
}
ast_event_sub_destroy(sub);
return NULL;
}
void ast_event_iterator_init(struct ast_event_iterator *iterator, const struct ast_event *event)
{
iterator->event_len = ntohs(event->event_len);
iterator->event = event;
iterator->ie = (struct ast_event_ie *) ( ((char *) event) + sizeof(*event) );
return;
}
int ast_event_iterator_next(struct ast_event_iterator *iterator)
{
iterator->ie = (struct ast_event_ie *) ( ((char *) iterator->ie) + sizeof(*iterator->ie) + ntohs(iterator->ie->ie_payload_len));
return ((iterator->event_len <= (((char *) iterator->ie) - ((char *) iterator->event))) ? -1 : 0);
}
enum ast_event_ie_type ast_event_iterator_get_ie_type(struct ast_event_iterator *iterator)
{
return ntohs(iterator->ie->ie_type);
}
uint32_t ast_event_iterator_get_ie_uint(struct ast_event_iterator *iterator)
{
return ntohl(get_unaligned_uint32(iterator->ie->ie_payload));
}
const char *ast_event_iterator_get_ie_str(struct ast_event_iterator *iterator)
{
const struct ast_event_ie_str_payload *str_payload;
str_payload = (struct ast_event_ie_str_payload *) iterator->ie->ie_payload;
return str_payload->str;
}
void *ast_event_iterator_get_ie_raw(struct ast_event_iterator *iterator)
{
return iterator->ie->ie_payload;
}
enum ast_event_type ast_event_get_type(const struct ast_event *event)
{
return ntohs(event->type);
}
uint32_t ast_event_get_ie_uint(const struct ast_event *event, enum ast_event_ie_type ie_type)
{
const uint32_t *ie_val;
ie_val = ast_event_get_ie_raw(event, ie_type);
return ie_val ? ntohl(get_unaligned_uint32(ie_val)) : 0;
}
uint32_t ast_event_get_ie_str_hash(const struct ast_event *event, enum ast_event_ie_type ie_type)
{
const struct ast_event_ie_str_payload *str_payload;
str_payload = ast_event_get_ie_raw(event, ie_type);
return str_payload->hash;
}
const char *ast_event_get_ie_str(const struct ast_event *event, enum ast_event_ie_type ie_type)
{
const struct ast_event_ie_str_payload *str_payload;
str_payload = ast_event_get_ie_raw(event, ie_type);
return str_payload->str;
}
const void *ast_event_get_ie_raw(const struct ast_event *event, enum ast_event_ie_type ie_type)
{
struct ast_event_iterator iterator;
int res = 0;
for (ast_event_iterator_init(&iterator, event); !res; res = ast_event_iterator_next(&iterator)) {
if (ast_event_iterator_get_ie_type(&iterator) == ie_type)
return ast_event_iterator_get_ie_raw(&iterator);
}
return NULL;
}
int ast_event_append_ie_str(struct ast_event **event, enum ast_event_ie_type ie_type,
const char *str)
{
struct ast_event_ie_str_payload *str_payload;
size_t payload_len;
payload_len = sizeof(*str_payload) + strlen(str);
str_payload = alloca(payload_len);
strcpy(str_payload->str, str);
str_payload->hash = ast_str_hash(str);
return ast_event_append_ie_raw(event, ie_type, str_payload, payload_len);
}
int ast_event_append_ie_uint(struct ast_event **event, enum ast_event_ie_type ie_type,
uint32_t data)
{
data = htonl(data);
return ast_event_append_ie_raw(event, ie_type, &data, sizeof(data));
}
int ast_event_append_ie_raw(struct ast_event **event, enum ast_event_ie_type ie_type,
const void *data, size_t data_len)
{
struct ast_event_ie *ie;
unsigned int extra_len;
uint16_t event_len;
event_len = ntohs((*event)->event_len);
extra_len = sizeof(*ie) + data_len;
if (!(*event = ast_realloc(*event, event_len + extra_len)))
return -1;
ie = (struct ast_event_ie *) ( ((char *) *event) + event_len );
ie->ie_type = htons(ie_type);
ie->ie_payload_len = htons(data_len);
memcpy(ie->ie_payload, data, data_len);
(*event)->event_len = htons(event_len + extra_len);
return 0;
}
struct ast_event *ast_event_new(enum ast_event_type type, ...)
{
va_list ap;
struct ast_event *event;
enum ast_event_type ie_type;
struct ast_event_ie_val *ie_val;
AST_LIST_HEAD_NOLOCK_STATIC(ie_vals, ast_event_ie_val);
/* Invalid type */
if (type >= AST_EVENT_TOTAL) {
ast_log(LOG_WARNING, "Someone tried to create an event of invalid "
"type '%d'!\n", type);
return NULL;
}
va_start(ap, type);
for (ie_type = va_arg(ap, enum ast_event_type);
ie_type != AST_EVENT_IE_END;
ie_type = va_arg(ap, enum ast_event_type))
{
struct ast_event_ie_val *ie_value = alloca(sizeof(*ie_value));
memset(ie_value, 0, sizeof(*ie_value));
ie_value->ie_type = ie_type;
ie_value->ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
if (ie_value->ie_pltype == AST_EVENT_IE_PLTYPE_UINT)
ie_value->payload.uint = va_arg(ap, uint32_t);
else if (ie_value->ie_pltype == AST_EVENT_IE_PLTYPE_STR)
ie_value->payload.str = ast_strdupa(va_arg(ap, const char *));
else if (ie_value->ie_pltype == AST_EVENT_IE_PLTYPE_RAW) {
void *data = va_arg(ap, void *);
size_t datalen = va_arg(ap, size_t);
ie_value->payload.raw = alloca(datalen);
memcpy(ie_value->payload.raw, data, datalen);
ie_value->raw_datalen = datalen;
}
AST_LIST_INSERT_TAIL(&ie_vals, ie_value, entry);
}
va_end(ap);
if (!(event = ast_calloc(1, sizeof(*event))))
return NULL;
event->type = htons(type);
event->event_len = htons(sizeof(*event));
AST_LIST_TRAVERSE(&ie_vals, ie_val, entry) {
if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_STR)
ast_event_append_ie_str(&event, ie_val->ie_type, ie_val->payload.str);
else if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_UINT)
ast_event_append_ie_uint(&event, ie_val->ie_type, ie_val->payload.uint);
else if (ie_val->ie_pltype == AST_EVENT_IE_PLTYPE_RAW)
ast_event_append_ie_raw(&event, ie_val->ie_type, ie_val->payload.raw, ie_val->raw_datalen);
if (!event)
break;
}
if (!ast_event_get_ie_raw(event, AST_EVENT_IE_EID)) {
/* If the event is originating on this server, add the server's
* entity ID to the event. */
ast_event_append_ie_raw(&event, AST_EVENT_IE_EID, &ast_eid_default, sizeof(ast_eid_default));
}
return event;
}
void ast_event_destroy(struct ast_event *event)
{
ast_free(event);
}
static void ast_event_ref_destroy(void *obj)
{
struct ast_event_ref *event_ref = obj;
ast_event_destroy(event_ref->event);
}
static struct ast_event *ast_event_dup(const struct ast_event *event)
{
struct ast_event *dup_event;
uint16_t event_len;
event_len = ast_event_get_size(event);
if (!(dup_event = ast_calloc(1, event_len))) {
return NULL;
}
memcpy(dup_event, event, event_len);
return dup_event;
}
struct ast_event *ast_event_get_cached(enum ast_event_type type, ...)
{
va_list ap;
enum ast_event_ie_type ie_type;
struct ast_event *dup_event = NULL;
struct ast_event_ref *cached_event_ref;
struct ast_event *cache_arg_event;
struct ast_event_ref tmp_event_ref = {
.event = NULL,
};
struct ao2_container *container = NULL;
if (type >= AST_EVENT_TOTAL) {
ast_log(LOG_ERROR, "%u is an invalid type!\n", type);
return NULL;
}
if (!(container = ast_event_cache[type].container)) {
ast_log(LOG_ERROR, "%u is not a cached event type\n", type);
return NULL;
}
if (!(cache_arg_event = ast_event_new(type, AST_EVENT_IE_END))) {
return NULL;
}
va_start(ap, type);
for (ie_type = va_arg(ap, enum ast_event_type);
ie_type != AST_EVENT_IE_END;
ie_type = va_arg(ap, enum ast_event_type))
{
enum ast_event_ie_pltype ie_pltype;
ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
switch (ie_pltype) {
case AST_EVENT_IE_PLTYPE_UINT:
ast_event_append_ie_uint(&cache_arg_event, ie_type, va_arg(ap, uint32_t));
break;
case AST_EVENT_IE_PLTYPE_STR:
ast_event_append_ie_str(&cache_arg_event, ie_type, va_arg(ap, const char *));
break;
case AST_EVENT_IE_PLTYPE_RAW:
{
void *data = va_arg(ap, void *);
size_t datalen = va_arg(ap, size_t);
ast_event_append_ie_raw(&cache_arg_event, ie_type, data, datalen);
}
case AST_EVENT_IE_PLTYPE_EXISTS:
ast_log(LOG_WARNING, "PLTYPE_EXISTS not supported by this function\n");
break;
case AST_EVENT_IE_PLTYPE_UNKNOWN:
break;
}
}
va_end(ap);
tmp_event_ref.event = cache_arg_event;
cached_event_ref = ao2_find(container, &tmp_event_ref, OBJ_POINTER);
ast_event_destroy(cache_arg_event);
cache_arg_event = NULL;
if (cached_event_ref) {
dup_event = ast_event_dup(cached_event_ref->event);
ao2_ref(cached_event_ref, -1);
cached_event_ref = NULL;
}
return dup_event;
}
static struct ast_event_ref *alloc_event_ref(void)
{
return ao2_alloc(sizeof(struct ast_event_ref), ast_event_ref_destroy);
}
/*! \brief Duplicate an event and add it to the cache
* \note This assumes this index in to the cache is locked */
static int attribute_unused ast_event_dup_and_cache(const struct ast_event *event)
{
struct ast_event *dup_event;
struct ast_event_ref *event_ref;
if (!(dup_event = ast_event_dup(event))) {
return -1;
}
if (!(event_ref = alloc_event_ref())) {
ast_event_destroy(dup_event);
return -1;
}
event_ref->event = dup_event;
ao2_link(ast_event_cache[ast_event_get_type(event)].container, event_ref);
ao2_ref(event_ref, -1);
return 0;
}
int ast_event_queue_and_cache(struct ast_event *event)
{
struct ao2_container *container;
struct ast_event_ref tmp_event_ref = {
.event = event,
};
if (!(container = ast_event_cache[ast_event_get_type(event)].container)) {
ast_log(LOG_WARNING, "cache requested for non-cached event type\n");
goto queue_event;
}
/* Remove matches from the cache */
ao2_callback(container, OBJ_POINTER | OBJ_UNLINK | OBJ_MULTIPLE | OBJ_NODATA,
ast_event_cmp, &tmp_event_ref);
queue_event:
return ast_event_queue(event);
}
static int handle_event(void *data)
{
struct ast_event_ref *event_ref = data;
struct ast_event_sub *sub;
uint16_t host_event_type;
host_event_type = ntohs(event_ref->event->type);
/* Subscribers to this specific event first */
AST_RWDLLIST_RDLOCK(&ast_event_subs[host_event_type]);
AST_RWDLLIST_TRAVERSE(&ast_event_subs[host_event_type], sub, entry) {
struct ast_event_ie_val *ie_val;
AST_LIST_TRAVERSE(&sub->ie_vals, ie_val, entry) {
if (!match_ie_val(event_ref->event, ie_val, NULL)) {
break;
}
}
if (ie_val) {
continue;
}
sub->cb(event_ref->event, sub->userdata);
}
AST_RWDLLIST_UNLOCK(&ast_event_subs[host_event_type]);
/* Now to subscribers to all event types */
AST_RWDLLIST_RDLOCK(&ast_event_subs[AST_EVENT_ALL]);
AST_RWDLLIST_TRAVERSE(&ast_event_subs[AST_EVENT_ALL], sub, entry) {
sub->cb(event_ref->event, sub->userdata);
}
AST_RWDLLIST_UNLOCK(&ast_event_subs[AST_EVENT_ALL]);
ao2_ref(event_ref, -1);
return 0;
}
int ast_event_queue(struct ast_event *event)
{
struct ast_event_ref *event_ref;
uint16_t host_event_type;
host_event_type = ntohs(event->type);
/* Invalid type */
if (host_event_type >= AST_EVENT_TOTAL) {
ast_log(LOG_WARNING, "Someone tried to queue an event of invalid "
"type '%d'!\n", host_event_type);
return -1;
}
/* If nobody has subscribed to this event type, throw it away now */
if (ast_event_check_subscriber(host_event_type, AST_EVENT_IE_END)
== AST_EVENT_SUB_NONE) {
ast_event_destroy(event);
return 0;
}
if (!(event_ref = alloc_event_ref())) {
return -1;
}
event_ref->event = event;
return ast_taskprocessor_push(event_dispatcher, handle_event, event_ref);
}
static int ast_event_hash_mwi(const void *obj, const int flags)
{
const struct ast_event *event = obj;
const char *mailbox = ast_event_get_ie_str(event, AST_EVENT_IE_MAILBOX);
const char *context = ast_event_get_ie_str(event, AST_EVENT_IE_CONTEXT);
return ast_str_hash_add(context, ast_str_hash(mailbox));
}
/*!
* \internal
* \brief Hash function for AST_EVENT_DEVICE_STATE
*
* \param[in] obj an ast_event
* \param[in] flags unused
*
* \return hash value
*/
static int ast_event_hash_devstate(const void *obj, const int flags)
{
const struct ast_event *event = obj;
return ast_str_hash(ast_event_get_ie_str(event, AST_EVENT_IE_DEVICE));
}
/*!
* \internal
* \brief Hash function for AST_EVENT_DEVICE_STATE_CHANGE
*
* \param[in] obj an ast_event
* \param[in] flags unused
*
* \return hash value
*/
static int ast_event_hash_devstate_change(const void *obj, const int flags)
{
const struct ast_event *event = obj;
return ast_str_hash(ast_event_get_ie_str(event, AST_EVENT_IE_DEVICE));
}
static int ast_event_hash(const void *obj, const int flags)
{
const struct ast_event_ref *event_ref;
const struct ast_event *event;
ao2_hash_fn *hash_fn;
event_ref = obj;
event = event_ref->event;
if (!(hash_fn = ast_event_cache[ast_event_get_type(event)].hash_fn)) {
return 0;
}
return hash_fn(event, flags);
}
/*!
* \internal
* \brief Compare two events
*
* \param[in] obj the first event, as an ast_event_ref
* \param[in] arg the second event, as an ast_event_ref
* \param[in] flags unused
*
* \pre Both events must be the same type.
* \pre The event type must be declared as a cached event type in ast_event_cache
*
* \details This function takes two events, and determines if they are considered
* equivalent. The values of information elements specified in the cache arguments
* for the event type are used to determine if the events are equivalent.
*
* \retval 0 No match
* \retval CMP_MATCH The events are considered equivalent based on the cache arguments
*/
static int ast_event_cmp(void *obj, void *arg, int flags)
{
struct ast_event_ref *event_ref, *event_ref2;
struct ast_event *event, *event2;
int res = CMP_MATCH;
int i;
enum ast_event_ie_type *cache_args;
event_ref = obj;
event = event_ref->event;
event_ref2 = arg;
event2 = event_ref2->event;
cache_args = ast_event_cache[ast_event_get_type(event)].cache_args;
for (i = 0; i < ARRAY_LEN(ast_event_cache[0].cache_args) && cache_args[i]; i++) {
struct ast_event_ie_val ie_val = {
.ie_type = cache_args[i],
};
if (!match_ie_val(event, &ie_val, event2)) {
res = 0;
break;
}
}
return res;
}
int ast_event_init(void)
{
int i;
for (i = 0; i < AST_EVENT_TOTAL; i++) {
AST_RWDLLIST_HEAD_INIT(&ast_event_subs[i]);
}
for (i = 0; i < AST_EVENT_TOTAL; i++) {
if (!ast_event_cache[i].hash_fn) {
/* This event type is not cached. */
continue;
}
if (!(ast_event_cache[i].container = ao2_container_alloc(NUM_CACHE_BUCKETS,
ast_event_hash, ast_event_cmp))) {
return -1;
}
}
if (!(event_dispatcher = ast_taskprocessor_get("core_event_dispatcher", 0))) {
return -1;
}
return 0;
}
Reference in New Issue View Git Blame Copy Permalink