Title update
[asterisk/asterisk.git] / funcs / func_frame_trace.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2010, Digium, Inc.
5  *
6  * David Vossel <dvossel@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 Trace internal ast_frames on a channel.
22  *
23  * \author David Vossel <dvossel@digium.com>
24  *
25  * \ingroup functions
26  */
27
28 /*** MODULEINFO
29         <support_level>extended</support_level>
30  ***/
31
32 #include "asterisk.h"
33
34 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
35
36 #include "asterisk/module.h"
37 #include "asterisk/channel.h"
38 #include "asterisk/pbx.h"
39 #include "asterisk/framehook.h"
40
41 /*** DOCUMENTATION
42         <function name="FRAME_TRACE" language="en_US">
43                 <synopsis>
44                         View internal ast_frames as they are read and written on a channel.
45                 </synopsis>
46                 <syntax>
47                         <parameter name="filter list type" required="true">
48                                 <para>A filter can be applied to the trace to limit what frames are viewed.  This
49                                 filter can either be a <literal>white</literal> or <literal>black</literal> list
50                                 of frame types.  When no filter type is present, <literal>white</literal> is
51                                 used.  If no arguments are provided at all, all frames will be output.
52                                 </para>
53
54                                 <para>Below are the different types of frames that can be filtered.</para>
55                                 <enumlist>
56                                         <enum name = "DTMF_BEGIN" />
57                                         <enum name = "DTMF_END" />
58                                         <enum name = "VOICE" />
59                                         <enum name = "VIDEO" />
60                                         <enum name = "CONTROL" />
61                                         <enum name = "NULL" />
62                                         <enum name = "IAX" />
63                                         <enum name = "TEXT" />
64                                         <enum name = "IMAGE" />
65                                         <enum name = "HTML" />
66                                         <enum name = "CNG" />
67                                         <enum name = "MODEM" />
68                                 </enumlist>
69                         </parameter>
70                 </syntax>
71                 <description>
72                         <para>Examples:</para>
73                         <para>exten => 1,1,Set(FRAME_TRACE(white)=DTMF_BEGIN,DTMF_END); view only DTMF frames. </para>
74                         <para>exten => 1,1,Set(FRAME_TRACE()=DTMF_BEGIN,DTMF_END); view only DTMF frames. </para>
75                         <para>exten => 1,1,Set(FRAME_TRACE(black)=DTMF_BEGIN,DTMF_END); view everything except DTMF frames. </para>
76                 </description>
77         </function>
78  ***/
79
80 static void print_frame(struct ast_frame *frame);
81 static struct {
82         enum ast_frame_type type;
83         const char *str;
84 } frametype2str[] = {
85         { AST_FRAME_DTMF_BEGIN,   "DTMF_BEGIN" },
86         { AST_FRAME_DTMF_END,   "DTMF_END" },
87         { AST_FRAME_VOICE,   "VOICE" },
88         { AST_FRAME_VIDEO,   "VIDEO" },
89         { AST_FRAME_CONTROL,   "CONTROL" },
90         { AST_FRAME_NULL,   "NULL" },
91         { AST_FRAME_IAX,   "IAX" },
92         { AST_FRAME_TEXT,   "TEXT" },
93         { AST_FRAME_IMAGE,   "IMAGE" },
94         { AST_FRAME_HTML,   "HTML" },
95         { AST_FRAME_CNG,   "CNG" },
96         { AST_FRAME_MODEM,   "MODEM" },
97 };
98
99 struct frame_trace_data {
100         int list_type; /* 0 = white, 1 = black */
101         int values[ARRAY_LEN(frametype2str)];
102 };
103
104 static void datastore_destroy_cb(void *data) {
105         ast_free(data);
106 }
107
108 static const struct ast_datastore_info frame_trace_datastore = {
109         .type = "frametrace",
110         .destroy = datastore_destroy_cb
111 };
112
113 static void hook_destroy_cb(void *framedata)
114 {
115         ast_free(framedata);
116 }
117
118 static struct ast_frame *hook_event_cb(struct ast_channel *chan, struct ast_frame *frame, enum ast_framehook_event event, void *data)
119 {
120         int i;
121         int show_frame = 0;
122         struct frame_trace_data *framedata = data;
123         if (!frame) {
124                 return frame;
125         }
126
127         if ((event != AST_FRAMEHOOK_EVENT_WRITE) && (event != AST_FRAMEHOOK_EVENT_READ)) {
128                 return frame;
129         }
130
131         for (i = 0; i < ARRAY_LEN(frametype2str); i++) {
132                 if (frame->frametype == frametype2str[i].type) {
133                         if ((framedata->list_type == 0) && (framedata->values[i])) { /* white list */
134                                 show_frame = 1;
135                         } else if ((framedata->list_type == 1) && (!framedata->values[i])){ /* black list */
136                                 show_frame = 1;
137                         }
138                         break;
139                 }
140         }
141
142         if (show_frame) {
143                 ast_verbose("%s on Channel %s\n", event == AST_FRAMEHOOK_EVENT_READ ? "<--Read" : "--> Write", ast_channel_name(chan));
144                 print_frame(frame);
145         }
146         return frame;
147 }
148
149 static int frame_trace_helper(struct ast_channel *chan, const char *cmd, char *data, const char *value)
150 {
151         struct frame_trace_data *framedata;
152         struct ast_datastore *datastore = NULL;
153         struct ast_framehook_interface interface = {
154                 .version = AST_FRAMEHOOK_INTERFACE_VERSION,
155                 .event_cb = hook_event_cb,
156                 .destroy_cb = hook_destroy_cb,
157         };
158         int i = 0;
159
160         if (!(framedata = ast_calloc(1, sizeof(*framedata)))) {
161                 return 0;
162         }
163
164         interface.data = framedata;
165
166         if (!strcasecmp(data, "black")) {
167                 framedata->list_type = 1;
168         }
169         for (i = 0; i < ARRAY_LEN(frametype2str); i++) {
170                 if (strcasestr(value, frametype2str[i].str)) {
171                         framedata->values[i] = 1;
172                 }
173         }
174
175         ast_channel_lock(chan);
176         i = ast_framehook_attach(chan, &interface);
177         if (i >= 0) {
178                 int *id;
179                 if ((datastore = ast_channel_datastore_find(chan, &frame_trace_datastore, NULL))) {
180                         id = datastore->data;
181                         ast_framehook_detach(chan, *id);
182                         ast_channel_datastore_remove(chan, datastore);
183                 }
184
185                 if (!(datastore = ast_datastore_alloc(&frame_trace_datastore, NULL))) {
186                         ast_framehook_detach(chan, i);
187                         ast_channel_unlock(chan);
188                         return 0;
189                 }
190
191                 if (!(id = ast_calloc(1, sizeof(int)))) {
192                         ast_datastore_free(datastore);
193                         ast_framehook_detach(chan, i);
194                         ast_channel_unlock(chan);
195                         return 0;
196                 }
197
198                 *id = i; /* Store off the id. The channel is still locked so it is safe to access this ptr. */
199                 datastore->data = id;
200                 ast_channel_datastore_add(chan, datastore);
201         }
202         ast_channel_unlock(chan);
203
204         return 0;
205 }
206
207 static void print_frame(struct ast_frame *frame)
208 {
209         switch (frame->frametype) {
210         case AST_FRAME_DTMF_END:
211                 ast_verbose("FrameType: DTMF END\n");
212                 ast_verbose("Digit: %d\n", frame->subclass.integer);
213                 break;
214         case AST_FRAME_VOICE:
215                 ast_verbose("FrameType: VOICE\n");
216                 ast_verbose("Codec: %s\n", ast_getformatname(&frame->subclass.format));
217                 ast_verbose("MS: %ld\n", frame->len);
218                 ast_verbose("Samples: %d\n", frame->samples);
219                 ast_verbose("Bytes: %d\n", frame->datalen);
220                 break;
221         case AST_FRAME_VIDEO:
222                 ast_verbose("FrameType: VIDEO\n");
223                 ast_verbose("Codec: %s\n", ast_getformatname(&frame->subclass.format));
224                 ast_verbose("MS: %ld\n", frame->len);
225                 ast_verbose("Samples: %d\n", frame->samples);
226                 ast_verbose("Bytes: %d\n", frame->datalen);
227                 break;
228         case AST_FRAME_CONTROL:
229                 ast_verbose("FrameType: CONTROL\n");
230                 switch ((enum ast_control_frame_type) frame->subclass.integer) {
231                 case AST_CONTROL_HANGUP:
232                         ast_verbose("SubClass: HANGUP\n");
233                         break;
234                 case AST_CONTROL_RING:
235                         ast_verbose("SubClass: RING\n");
236                         break;
237                 case AST_CONTROL_RINGING:
238                         ast_verbose("SubClass: RINGING\n");
239                         break;
240                 case AST_CONTROL_ANSWER:
241                         ast_verbose("SubClass: ANSWER\n");
242                         break;
243                 case AST_CONTROL_BUSY:
244                         ast_verbose("SubClass: BUSY\n");
245                         break;
246                 case AST_CONTROL_TAKEOFFHOOK:
247                         ast_verbose("SubClass: TAKEOFFHOOK\n");
248                         break;
249                 case AST_CONTROL_OFFHOOK:
250                         ast_verbose("SubClass: OFFHOOK\n");
251                         break;
252                 case AST_CONTROL_CONGESTION:
253                         ast_verbose("SubClass: CONGESTION\n");
254                         break;
255                 case AST_CONTROL_FLASH:
256                         ast_verbose("SubClass: FLASH\n");
257                         break;
258                 case AST_CONTROL_WINK:
259                         ast_verbose("SubClass: WINK\n");
260                         break;
261                 case AST_CONTROL_OPTION:
262                         ast_verbose("SubClass: OPTION\n");
263                         break;
264                 case AST_CONTROL_RADIO_KEY:
265                         ast_verbose("SubClass: RADIO KEY\n");
266                         break;
267                 case AST_CONTROL_RADIO_UNKEY:
268                         ast_verbose("SubClass: RADIO UNKEY\n");
269                         break;
270                 case AST_CONTROL_PROGRESS:
271                         ast_verbose("SubClass: PROGRESS\n");
272                         break;
273                 case AST_CONTROL_PROCEEDING:
274                         ast_verbose("SubClass: PROCEEDING\n");
275                         break;
276                 case AST_CONTROL_HOLD:
277                         ast_verbose("SubClass: HOLD\n");
278                         break;
279                 case AST_CONTROL_UNHOLD:
280                         ast_verbose("SubClass: UNHOLD\n");
281                         break;
282                 case AST_CONTROL_VIDUPDATE:
283                         ast_verbose("SubClass: VIDUPDATE\n");
284                         break;
285                 case _XXX_AST_CONTROL_T38:
286                         ast_verbose("SubClass: XXX T38\n");
287                         break;
288                 case AST_CONTROL_SRCUPDATE:
289                         ast_verbose("SubClass: SRCUPDATE\n");
290                         break;
291                 case AST_CONTROL_TRANSFER:
292                         ast_verbose("SubClass: TRANSFER\n");
293                         break;
294                 case AST_CONTROL_CONNECTED_LINE:
295                         ast_verbose("SubClass: CONNECTED LINE\n");
296                         break;
297                 case AST_CONTROL_REDIRECTING:
298                         ast_verbose("SubClass: REDIRECTING\n");
299                         break;
300                 case AST_CONTROL_T38_PARAMETERS:
301                         ast_verbose("SubClass: T38 PARAMETERS\n");
302                         break;
303                 case AST_CONTROL_CC:
304                         ast_verbose("SubClass: CC\n");
305                         break;
306                 case AST_CONTROL_SRCCHANGE:
307                         ast_verbose("SubClass: SRCCHANGE\n");
308                         break;
309                 case AST_CONTROL_READ_ACTION:
310                         ast_verbose("SubClass: READ ACTION\n");
311                         break;
312                 case AST_CONTROL_AOC:
313                         ast_verbose("SubClass: AOC\n");
314                         break;
315                 case AST_CONTROL_MCID:
316                         ast_verbose("SubClass: MCID\n");
317                         break;
318                 case AST_CONTROL_INCOMPLETE:
319                         ast_verbose("SubClass: INCOMPLETE\n");
320                         break;
321                 case AST_CONTROL_END_OF_Q:
322                         ast_verbose("SubClass: END_OF_Q\n");
323                         break;
324                 case AST_CONTROL_UPDATE_RTP_PEER:
325                         ast_verbose("SubClass: UPDATE_RTP_PEER\n");
326                         break;
327                 case AST_CONTROL_PVT_CAUSE_CODE:
328                         ast_verbose("SubClass: PVT_CAUSE_CODE\n");
329                         break;
330                 }
331                 
332                 if (frame->subclass.integer == -1) {
333                         ast_verbose("SubClass: %d\n", frame->subclass.integer);
334                 }
335                 ast_verbose("Bytes: %d\n", frame->datalen);
336                 break;
337         case AST_FRAME_NULL:
338                 ast_verbose("FrameType: NULL\n");
339                 break;
340         case AST_FRAME_IAX:
341                 ast_verbose("FrameType: IAX\n");
342                 break;
343         case AST_FRAME_TEXT:
344                 ast_verbose("FrameType: TXT\n");
345                 break;
346         case AST_FRAME_IMAGE:
347                 ast_verbose("FrameType: IMAGE\n");
348                 break;
349         case AST_FRAME_HTML:
350                 ast_verbose("FrameType: HTML\n");
351                 break;
352         case AST_FRAME_CNG:
353                 ast_verbose("FrameType: CNG\n");
354                 break;
355         case AST_FRAME_MODEM:
356                 ast_verbose("FrameType: MODEM\n");
357                 break;
358         case AST_FRAME_DTMF_BEGIN:
359                 ast_verbose("FrameType: DTMF BEGIN\n");
360                 ast_verbose("Digit: %d\n", frame->subclass.integer);
361                 break;
362         }
363
364         ast_verbose("Src: %s\n", ast_strlen_zero(frame->src) ? "NOT PRESENT" : frame->src);
365         ast_verbose("\n");
366 }
367
368 static struct ast_custom_function frame_trace_function = {
369         .name = "FRAME_TRACE",
370         .write = frame_trace_helper,
371 };
372
373 static int unload_module(void)
374 {
375         return ast_custom_function_unregister(&frame_trace_function);
376 }
377
378 static int load_module(void)
379 {
380         int res = ast_custom_function_register(&frame_trace_function);
381         return res ? AST_MODULE_LOAD_DECLINE : AST_MODULE_LOAD_SUCCESS;
382 }
383
384 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Frame Trace for internal ast_frame debugging.");
385