Fix DEBUG_THREADS when lock is acquired in __constructor__
[asterisk/asterisk.git] / main / event.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2007 - 2008, Digium, Inc.
5  *
6  * Russell Bryant <russell@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Internal generic event system
22  *
23  * \author Russell Bryant <russell@digium.com>
24  */
25
26 /*** MODULEINFO
27         <support_level>core</support_level>
28  ***/
29
30 #include "asterisk.h"
31
32 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
33
34 #include "asterisk/_private.h"
35
36 #include "asterisk/event.h"
37 #include "asterisk/linkedlists.h"
38 #include "asterisk/dlinkedlists.h"
39 #include "asterisk/lock.h"
40 #include "asterisk/utils.h"
41 #include "asterisk/unaligned.h"
42 #include "asterisk/utils.h"
43 #include "asterisk/taskprocessor.h"
44 #include "asterisk/astobj2.h"
45 #include "asterisk/cli.h"
46
47 static int event_append_ie_raw(struct ast_event **event, enum ast_event_ie_type ie_type,
48         const void *data, size_t data_len);
49 static const void *event_get_ie_raw(const struct ast_event *event, enum ast_event_ie_type ie_type);
50
51 /*!
52  * \brief An event information element
53  *
54  * \note The format of this structure is important.  Since these events may
55  *       be sent directly over a network, changing this structure will break
56  *       compatibility with older versions.  However, at this point, this code
57  *       has not made it into a release, so it is still fair game for change.
58  */
59 struct ast_event_ie {
60         enum ast_event_ie_type ie_type:16;
61         /*! Total length of the IE payload */
62         uint16_t ie_payload_len;
63         unsigned char ie_payload[0];
64 } __attribute__((packed));
65
66 /*!
67  * \brief The payload for a string information element
68  */
69 struct ast_event_ie_str_payload {
70         /*! \brief A hash calculated with ast_str_hash(), to speed up comparisons */
71         uint32_t hash;
72         /*! \brief The actual string, null terminated */
73         char str[1];
74 } __attribute__((packed));
75
76 /*!
77  * \brief An event
78  *
79  * An ast_event consists of an event header (this structure), and zero or
80  * more information elements defined by ast_event_ie.
81  *
82  * \note The format of this structure is important.  Since these events may
83  *       be sent directly over a network, changing this structure will break
84  *       compatibility with older versions.  However, at this point, this code
85  *       has not made it into a release, so it is still fair game for change.
86  */
87 struct ast_event {
88         /*! Event type */
89         enum ast_event_type type:16;
90         /*! Total length of the event */
91         uint16_t event_len:16;
92         /*! The data payload of the event, made up of information elements */
93         unsigned char payload[0];
94 } __attribute__((packed));
95
96
97 struct ast_event_ie_val {
98         AST_LIST_ENTRY(ast_event_ie_val) entry;
99         enum ast_event_ie_type ie_type;
100         enum ast_event_ie_pltype ie_pltype;
101         union {
102                 uint32_t uint;
103                 struct {
104                         uint32_t hash;
105                         const char *str;
106                 };
107                 void *raw;
108         } payload;
109         size_t raw_datalen;
110 };
111
112 struct ie_map {
113         enum ast_event_ie_pltype ie_pltype;
114         const char *name;
115 };
116
117 /*!
118  * \brief IE payload types and names
119  */
120 static const struct ie_map ie_maps[AST_EVENT_IE_TOTAL] = {
121         [AST_EVENT_IE_UNIQUEID]            = { AST_EVENT_IE_PLTYPE_UINT, "UniqueID" },
122         [AST_EVENT_IE_EVENTTYPE]           = { AST_EVENT_IE_PLTYPE_UINT, "EventType" },
123         [AST_EVENT_IE_EXISTS]              = { AST_EVENT_IE_PLTYPE_UINT, "Exists" },
124         [AST_EVENT_IE_CONTEXT]             = { AST_EVENT_IE_PLTYPE_STR,  "Context" },
125         [AST_EVENT_IE_CEL_EVENT_TYPE]      = { AST_EVENT_IE_PLTYPE_UINT, "CELEventType" },
126         [AST_EVENT_IE_CEL_EVENT_TIME]      = { AST_EVENT_IE_PLTYPE_UINT, "CELEventTime" },
127         [AST_EVENT_IE_CEL_EVENT_TIME_USEC] = { AST_EVENT_IE_PLTYPE_UINT, "CELEventTimeUSec" },
128         [AST_EVENT_IE_CEL_USEREVENT_NAME]  = { AST_EVENT_IE_PLTYPE_UINT, "CELUserEventName" },
129         [AST_EVENT_IE_CEL_CIDNAME]         = { AST_EVENT_IE_PLTYPE_STR,  "CELCIDName" },
130         [AST_EVENT_IE_CEL_CIDNUM]          = { AST_EVENT_IE_PLTYPE_STR,  "CELCIDNum" },
131         [AST_EVENT_IE_CEL_EXTEN]           = { AST_EVENT_IE_PLTYPE_STR,  "CELExten" },
132         [AST_EVENT_IE_CEL_CONTEXT]         = { AST_EVENT_IE_PLTYPE_STR,  "CELContext" },
133         [AST_EVENT_IE_CEL_CHANNAME]        = { AST_EVENT_IE_PLTYPE_STR,  "CELChanName" },
134         [AST_EVENT_IE_CEL_APPNAME]         = { AST_EVENT_IE_PLTYPE_STR,  "CELAppName" },
135         [AST_EVENT_IE_CEL_APPDATA]         = { AST_EVENT_IE_PLTYPE_STR,  "CELAppData" },
136         [AST_EVENT_IE_CEL_AMAFLAGS]        = { AST_EVENT_IE_PLTYPE_STR,  "CELAMAFlags" },
137         [AST_EVENT_IE_CEL_ACCTCODE]        = { AST_EVENT_IE_PLTYPE_UINT, "CELAcctCode" },
138         [AST_EVENT_IE_CEL_UNIQUEID]        = { AST_EVENT_IE_PLTYPE_STR,  "CELUniqueID" },
139         [AST_EVENT_IE_CEL_USERFIELD]       = { AST_EVENT_IE_PLTYPE_STR,  "CELUserField" },
140         [AST_EVENT_IE_CEL_CIDANI]          = { AST_EVENT_IE_PLTYPE_STR,  "CELCIDani" },
141         [AST_EVENT_IE_CEL_CIDRDNIS]        = { AST_EVENT_IE_PLTYPE_STR,  "CELCIDrdnis" },
142         [AST_EVENT_IE_CEL_CIDDNID]         = { AST_EVENT_IE_PLTYPE_STR,  "CELCIDdnid" },
143         [AST_EVENT_IE_CEL_PEER]            = { AST_EVENT_IE_PLTYPE_STR,  "CELPeer" },
144         [AST_EVENT_IE_CEL_LINKEDID]        = { AST_EVENT_IE_PLTYPE_STR,  "CELLinkedID" },
145         [AST_EVENT_IE_CEL_PEERACCT]        = { AST_EVENT_IE_PLTYPE_STR,  "CELPeerAcct" },
146         [AST_EVENT_IE_CEL_EXTRA]           = { AST_EVENT_IE_PLTYPE_STR,  "CELExtra" },
147         [AST_EVENT_IE_EVENT_VERSION]       = { AST_EVENT_IE_PLTYPE_UINT, "EventVersion" },
148         [AST_EVENT_IE_SERVICE]             = { AST_EVENT_IE_PLTYPE_STR,  "Service" },
149         [AST_EVENT_IE_MODULE]              = { AST_EVENT_IE_PLTYPE_STR,  "Module" },
150         [AST_EVENT_IE_ACCOUNT_ID]          = { AST_EVENT_IE_PLTYPE_STR,  "AccountID" },
151         [AST_EVENT_IE_SESSION_ID]          = { AST_EVENT_IE_PLTYPE_STR,  "SessionID" },
152         [AST_EVENT_IE_SESSION_TV]          = { AST_EVENT_IE_PLTYPE_STR,  "SessionTV" },
153         [AST_EVENT_IE_ACL_NAME]            = { AST_EVENT_IE_PLTYPE_STR,  "ACLName" },
154         [AST_EVENT_IE_LOCAL_ADDR]          = { AST_EVENT_IE_PLTYPE_STR,  "LocalAddress" },
155         [AST_EVENT_IE_REMOTE_ADDR]         = { AST_EVENT_IE_PLTYPE_STR,  "RemoteAddress" },
156         [AST_EVENT_IE_EVENT_TV]            = { AST_EVENT_IE_PLTYPE_STR,  "EventTV" },
157         [AST_EVENT_IE_REQUEST_TYPE]        = { AST_EVENT_IE_PLTYPE_STR,  "RequestType" },
158         [AST_EVENT_IE_REQUEST_PARAMS]      = { AST_EVENT_IE_PLTYPE_STR,  "RequestParams" },
159         [AST_EVENT_IE_AUTH_METHOD]         = { AST_EVENT_IE_PLTYPE_STR,  "AuthMethod" },
160         [AST_EVENT_IE_SEVERITY]            = { AST_EVENT_IE_PLTYPE_STR,  "Severity" },
161         [AST_EVENT_IE_EXPECTED_ADDR]       = { AST_EVENT_IE_PLTYPE_STR,  "ExpectedAddress" },
162         [AST_EVENT_IE_CHALLENGE]           = { AST_EVENT_IE_PLTYPE_STR,  "Challenge" },
163         [AST_EVENT_IE_RESPONSE]            = { AST_EVENT_IE_PLTYPE_STR,  "Response" },
164         [AST_EVENT_IE_EXPECTED_RESPONSE]   = { AST_EVENT_IE_PLTYPE_STR,  "ExpectedResponse" },
165         [AST_EVENT_IE_RECEIVED_CHALLENGE]  = { AST_EVENT_IE_PLTYPE_STR,  "ReceivedChallenge" },
166         [AST_EVENT_IE_RECEIVED_HASH]       = { AST_EVENT_IE_PLTYPE_STR,  "ReceivedHash" },
167         [AST_EVENT_IE_USING_PASSWORD]      = { AST_EVENT_IE_PLTYPE_UINT, "UsingPassword" },
168         [AST_EVENT_IE_ATTEMPTED_TRANSPORT] = { AST_EVENT_IE_PLTYPE_STR,  "AttemptedTransport" },
169 };
170
171 const char *ast_event_get_ie_type_name(enum ast_event_ie_type ie_type)
172 {
173         if (ie_type <= 0 || ie_type >= ARRAY_LEN(ie_maps)) {
174                 ast_log(LOG_ERROR, "Invalid IE type - '%d'\n", ie_type);
175                 return "";
176         }
177
178         return ie_maps[ie_type].name;
179 }
180
181 enum ast_event_ie_pltype ast_event_get_ie_pltype(enum ast_event_ie_type ie_type)
182 {
183         if (ie_type <= 0 || ie_type >= ARRAY_LEN(ie_maps)) {
184                 ast_log(LOG_ERROR, "Invalid IE type - '%d'\n", ie_type);
185                 return AST_EVENT_IE_PLTYPE_UNKNOWN;
186         }
187
188         return ie_maps[ie_type].ie_pltype;
189 }
190
191 size_t ast_event_get_size(const struct ast_event *event)
192 {
193         size_t res;
194
195         res = ntohs(event->event_len);
196
197         return res;
198 }
199
200 /*! \brief Subscription event check list. */
201 struct ast_ev_check_list {
202         AST_LIST_HEAD_NOLOCK(, ast_event_ie_val) ie_vals;
203 };
204
205 int ast_event_iterator_init(struct ast_event_iterator *iterator, const struct ast_event *event)
206 {
207         int res = 0;
208
209         iterator->event_len = ast_event_get_size(event);
210         iterator->event = event;
211         if (iterator->event_len >= sizeof(*event) + sizeof(struct ast_event_ie)) {
212                 iterator->ie = (struct ast_event_ie *) ( ((char *) event) + sizeof(*event) );
213         } else {
214                 iterator->ie = NULL;
215                 res = -1;
216         }
217
218         return res;
219 }
220
221 int ast_event_iterator_next(struct ast_event_iterator *iterator)
222 {
223         iterator->ie = (struct ast_event_ie *) ( ((char *) iterator->ie) + sizeof(*iterator->ie) + ntohs(iterator->ie->ie_payload_len));
224         return ((iterator->event_len <= (((char *) iterator->ie) - ((char *) iterator->event))) ? -1 : 0);
225 }
226
227 enum ast_event_ie_type ast_event_iterator_get_ie_type(struct ast_event_iterator *iterator)
228 {
229         return ntohs(iterator->ie->ie_type);
230 }
231
232 uint32_t ast_event_iterator_get_ie_uint(struct ast_event_iterator *iterator)
233 {
234         return ntohl(get_unaligned_uint32(iterator->ie->ie_payload));
235 }
236
237 const char *ast_event_iterator_get_ie_str(struct ast_event_iterator *iterator)
238 {
239         const struct ast_event_ie_str_payload *str_payload;
240
241         str_payload = (struct ast_event_ie_str_payload *) iterator->ie->ie_payload;
242
243         return str_payload ? str_payload->str : NULL;
244 }
245
246 static void *event_iterator_get_ie_raw(struct ast_event_iterator *iterator)
247 {
248         return iterator->ie->ie_payload;
249 }
250
251 enum ast_event_type ast_event_get_type(const struct ast_event *event)
252 {
253         return ntohs(event->type);
254 }
255
256 uint32_t ast_event_get_ie_uint(const struct ast_event *event, enum ast_event_ie_type ie_type)
257 {
258         const uint32_t *ie_val;
259
260         ie_val = event_get_ie_raw(event, ie_type);
261
262         return ie_val ? ntohl(get_unaligned_uint32(ie_val)) : 0;
263 }
264
265 const char *ast_event_get_ie_str(const struct ast_event *event, enum ast_event_ie_type ie_type)
266 {
267         const struct ast_event_ie_str_payload *str_payload;
268
269         str_payload = event_get_ie_raw(event, ie_type);
270
271         return str_payload ? str_payload->str : NULL;
272 }
273
274 static const void *event_get_ie_raw(const struct ast_event *event, enum ast_event_ie_type ie_type)
275 {
276         struct ast_event_iterator iterator;
277         int res;
278
279         for (res = ast_event_iterator_init(&iterator, event); !res; res = ast_event_iterator_next(&iterator)) {
280                 if (ast_event_iterator_get_ie_type(&iterator) == ie_type) {
281                         return event_iterator_get_ie_raw(&iterator);
282                 }
283         }
284
285         return NULL;
286 }
287
288 int ast_event_append_ie_str(struct ast_event **event, enum ast_event_ie_type ie_type,
289         const char *str)
290 {
291         struct ast_event_ie_str_payload *str_payload;
292         size_t payload_len;
293
294         payload_len = sizeof(*str_payload) + strlen(str);
295         str_payload = ast_alloca(payload_len);
296
297         strcpy(str_payload->str, str);
298         str_payload->hash = ast_str_hash(str);
299
300         return event_append_ie_raw(event, ie_type, str_payload, payload_len);
301 }
302
303 int ast_event_append_ie_uint(struct ast_event **event, enum ast_event_ie_type ie_type,
304         uint32_t data)
305 {
306         data = htonl(data);
307         return event_append_ie_raw(event, ie_type, &data, sizeof(data));
308 }
309
310 static int event_append_ie_raw(struct ast_event **event, enum ast_event_ie_type ie_type,
311         const void *data, size_t data_len)
312 {
313         struct ast_event_ie *ie;
314         unsigned int extra_len;
315         uint16_t event_len;
316
317         event_len = ntohs((*event)->event_len);
318         extra_len = sizeof(*ie) + data_len;
319
320         if (!(*event = ast_realloc(*event, event_len + extra_len))) {
321                 return -1;
322         }
323
324         ie = (struct ast_event_ie *) ( ((char *) *event) + event_len );
325         ie->ie_type = htons(ie_type);
326         ie->ie_payload_len = htons(data_len);
327         memcpy(ie->ie_payload, data, data_len);
328
329         (*event)->event_len = htons(event_len + extra_len);
330
331         return 0;
332 }
333
334 struct ast_event *ast_event_new(enum ast_event_type type, ...)
335 {
336         va_list ap;
337         struct ast_event *event;
338         enum ast_event_ie_type ie_type;
339         struct ast_event_ie_val *ie_val;
340         AST_LIST_HEAD_NOLOCK_STATIC(ie_vals, ast_event_ie_val);
341
342         /* Invalid type */
343         if (type >= AST_EVENT_TOTAL) {
344                 ast_log(LOG_WARNING, "Someone tried to create an event of invalid "
345                         "type '%d'!\n", type);
346                 return NULL;
347         }
348
349         va_start(ap, type);
350         for (ie_type = va_arg(ap, enum ast_event_ie_type);
351                 ie_type != AST_EVENT_IE_END;
352                 ie_type = va_arg(ap, enum ast_event_ie_type))
353         {
354                 struct ast_event_ie_val *ie_value = ast_alloca(sizeof(*ie_value));
355                 int insert = 0;
356
357                 memset(ie_value, 0, sizeof(*ie_value));
358                 ie_value->ie_type = ie_type;
359                 ie_value->ie_pltype = va_arg(ap, enum ast_event_ie_pltype);
360                 switch (ie_value->ie_pltype) {
361                 case AST_EVENT_IE_PLTYPE_UINT:
362                         ie_value->payload.uint = va_arg(ap, uint32_t);
363                         insert = 1;
364                         break;
365                 case AST_EVENT_IE_PLTYPE_STR:
366                         ie_value->payload.str = va_arg(ap, const char *);
367                         insert = 1;
368                         break;
369                 case AST_EVENT_IE_PLTYPE_RAW:
370                 {
371                         void *data = va_arg(ap, void *);
372                         size_t datalen = va_arg(ap, size_t);
373                         ie_value->payload.raw = ast_alloca(datalen);
374                         memcpy(ie_value->payload.raw, data, datalen);
375                         ie_value->raw_datalen = datalen;
376                         insert = 1;
377                         break;
378                 }
379                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
380                         break;
381                 }
382
383                 if (insert) {
384                         AST_LIST_INSERT_TAIL(&ie_vals, ie_value, entry);
385                 } else {
386                         ast_log(LOG_WARNING, "Unsupported PLTYPE(%d)\n", ie_value->ie_pltype);
387                 }
388         }
389         va_end(ap);
390
391         if (!(event = ast_calloc(1, sizeof(*event)))) {
392                 return NULL;
393         }
394
395         event->type = htons(type);
396         event->event_len = htons(sizeof(*event));
397
398         AST_LIST_TRAVERSE(&ie_vals, ie_val, entry) {
399                 switch (ie_val->ie_pltype) {
400                 case AST_EVENT_IE_PLTYPE_STR:
401                         ast_event_append_ie_str(&event, ie_val->ie_type, ie_val->payload.str);
402                         break;
403                 case AST_EVENT_IE_PLTYPE_UINT:
404                         ast_event_append_ie_uint(&event, ie_val->ie_type, ie_val->payload.uint);
405                         break;
406                 case AST_EVENT_IE_PLTYPE_RAW:
407                         event_append_ie_raw(&event, ie_val->ie_type,
408                                         ie_val->payload.raw, ie_val->raw_datalen);
409                         break;
410                 case AST_EVENT_IE_PLTYPE_UNKNOWN:
411                         break;
412                 }
413
414                 /* realloc inside one of the append functions failed */
415                 if (!event) {
416                         return NULL;
417                 }
418         }
419
420         return event;
421 }
422
423 void ast_event_destroy(struct ast_event *event)
424 {
425         ast_free(event);
426 }