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 (!chan) {
 161                 ast_log(LOG_WARNING, "No channel was provided to %s function.\n", cmd);
 162                 return -1;
 163         }
 164
 165         if (!(framedata = ast_calloc(1, sizeof(*framedata)))) {
 166                 return 0;
 167         }
 168
 169         interface.data = framedata;
 170
 171         if (!strcasecmp(data, "black")) {
 172                 framedata->list_type = 1;
 173         }
 174         for (i = 0; i < ARRAY_LEN(frametype2str); i++) {
 175                 if (strcasestr(value, frametype2str[i].str)) {
 176                         framedata->values[i] = 1;
 177                 }
 178         }
 179
 180         ast_channel_lock(chan);
 181         i = ast_framehook_attach(chan, &interface);
 182         if (i >= 0) {
 183                 int *id;
 184                 if ((datastore = ast_channel_datastore_find(chan, &frame_trace_datastore, NULL))) {
 185                         id = datastore->data;
 186                         ast_framehook_detach(chan, *id);
 187                         ast_channel_datastore_remove(chan, datastore);
 188                 }
 189
 190                 if (!(datastore = ast_datastore_alloc(&frame_trace_datastore, NULL))) {
 191                         ast_framehook_detach(chan, i);
 192                         ast_channel_unlock(chan);
 193                         return 0;
 194                 }
 195
 196                 if (!(id = ast_calloc(1, sizeof(int)))) {
 197                         ast_datastore_free(datastore);
 198                         ast_framehook_detach(chan, i);
 199                         ast_channel_unlock(chan);
 200                         return 0;
 201                 }
 202
 203                 *id = i; /* Store off the id. The channel is still locked so it is safe to access this ptr. */
 204                 datastore->data = id;
 205                 ast_channel_datastore_add(chan, datastore);
 206         }
 207         ast_channel_unlock(chan);
 208
 209         return 0;
 210 }
 211
 212 static void print_frame(struct ast_frame *frame)
 213 {
 214         switch (frame->frametype) {
 215         case AST_FRAME_DTMF_END:
 216                 ast_verbose("FrameType: DTMF END\n");
 217                 ast_verbose("Digit: 0x%02X '%c'\n", (unsigned)frame->subclass.integer,
 218                         frame->subclass.integer < ' ' ? ' ' : frame->subclass.integer);
 219                 break;
 220         case AST_FRAME_VOICE:
 221                 ast_verbose("FrameType: VOICE\n");
 222                 ast_verbose("Codec: %s\n", ast_format_get_name(frame->subclass.format));
 223                 ast_verbose("MS: %ld\n", frame->len);
 224                 ast_verbose("Samples: %d\n", frame->samples);
 225                 ast_verbose("Bytes: %d\n", frame->datalen);
 226                 break;
 227         case AST_FRAME_VIDEO:
 228                 ast_verbose("FrameType: VIDEO\n");
 229                 ast_verbose("Codec: %s\n", ast_format_get_name(frame->subclass.format));
 230                 ast_verbose("MS: %ld\n", frame->len);
 231                 ast_verbose("Samples: %d\n", frame->samples);
 232                 ast_verbose("Bytes: %d\n", frame->datalen);
 233                 break;
 234         case AST_FRAME_CONTROL:
 235                 ast_verbose("FrameType: CONTROL\n");
 236                 switch ((enum ast_control_frame_type) frame->subclass.integer) {
 237                 case AST_CONTROL_HANGUP:
 238                         ast_verbose("SubClass: HANGUP\n");
 239                         break;
 240                 case AST_CONTROL_RING:
 241                         ast_verbose("SubClass: RING\n");
 242                         break;
 243                 case AST_CONTROL_RINGING:
 244                         ast_verbose("SubClass: RINGING\n");
 245                         break;
 246                 case AST_CONTROL_ANSWER:
 247                         ast_verbose("SubClass: ANSWER\n");
 248                         break;
 249                 case AST_CONTROL_BUSY:
 250                         ast_verbose("SubClass: BUSY\n");
 251                         break;
 252                 case AST_CONTROL_TAKEOFFHOOK:
 253                         ast_verbose("SubClass: TAKEOFFHOOK\n");
 254                         break;
 255                 case AST_CONTROL_OFFHOOK:
 256                         ast_verbose("SubClass: OFFHOOK\n");
 257                         break;
 258                 case AST_CONTROL_CONGESTION:
 259                         ast_verbose("SubClass: CONGESTION\n");
 260                         break;
 261                 case AST_CONTROL_FLASH:
 262                         ast_verbose("SubClass: FLASH\n");
 263                         break;
 264                 case AST_CONTROL_WINK:
 265                         ast_verbose("SubClass: WINK\n");
 266                         break;
 267                 case AST_CONTROL_OPTION:
 268                         ast_verbose("SubClass: OPTION\n");
 269                         break;
 270                 case AST_CONTROL_RADIO_KEY:
 271                         ast_verbose("SubClass: RADIO KEY\n");
 272                         break;
 273                 case AST_CONTROL_RADIO_UNKEY:
 274                         ast_verbose("SubClass: RADIO UNKEY\n");
 275                         break;
 276                 case AST_CONTROL_PROGRESS:
 277                         ast_verbose("SubClass: PROGRESS\n");
 278                         break;
 279                 case AST_CONTROL_PROCEEDING:
 280                         ast_verbose("SubClass: PROCEEDING\n");
 281                         break;
 282                 case AST_CONTROL_HOLD:
 283                         ast_verbose("SubClass: HOLD\n");
 284                         break;
 285                 case AST_CONTROL_UNHOLD:
 286                         ast_verbose("SubClass: UNHOLD\n");
 287                         break;
 288                 case AST_CONTROL_VIDUPDATE:
 289                         ast_verbose("SubClass: VIDUPDATE\n");
 290                         break;
 291                 case _XXX_AST_CONTROL_T38:
 292                         ast_verbose("SubClass: XXX T38\n");
 293                         break;
 294                 case AST_CONTROL_SRCUPDATE:
 295                         ast_verbose("SubClass: SRCUPDATE\n");
 296                         break;
 297                 case AST_CONTROL_TRANSFER:
 298                         ast_verbose("SubClass: TRANSFER\n");
 299                         break;
 300                 case AST_CONTROL_CONNECTED_LINE:
 301                         ast_verbose("SubClass: CONNECTED LINE\n");
 302                         break;
 303                 case AST_CONTROL_REDIRECTING:
 304                         ast_verbose("SubClass: REDIRECTING\n");
 305                         break;
 306                 case AST_CONTROL_T38_PARAMETERS:
 307                         ast_verbose("SubClass: T38 PARAMETERS\n");
 308                         break;
 309                 case AST_CONTROL_CC:
 310                         ast_verbose("SubClass: CC\n");
 311                         break;
 312                 case AST_CONTROL_SRCCHANGE:
 313                         ast_verbose("SubClass: SRCCHANGE\n");
 314                         break;
 315                 case AST_CONTROL_READ_ACTION:
 316                         ast_verbose("SubClass: READ ACTION\n");
 317                         break;
 318                 case AST_CONTROL_AOC:
 319                         ast_verbose("SubClass: AOC\n");
 320                         break;
 321                 case AST_CONTROL_MCID:
 322                         ast_verbose("SubClass: MCID\n");
 323                         break;
 324                 case AST_CONTROL_INCOMPLETE:
 325                         ast_verbose("SubClass: INCOMPLETE\n");
 326                         break;
 327                 case AST_CONTROL_END_OF_Q:
 328                         ast_verbose("SubClass: END_OF_Q\n");
 329                         break;
 330                 case AST_CONTROL_UPDATE_RTP_PEER:
 331                         ast_verbose("SubClass: UPDATE_RTP_PEER\n");
 332                         break;
 333                 case AST_CONTROL_PVT_CAUSE_CODE:
 334                         ast_verbose("SubClass: PVT_CAUSE_CODE\n");
 335                         break;
 336                 case AST_CONTROL_STREAM_STOP:
 337                         ast_verbose("SubClass: STREAM_STOP\n");
 338                         break;
 339                 case AST_CONTROL_STREAM_SUSPEND:
 340                         ast_verbose("SubClass: STREAM_SUSPEND\n");
 341                         break;
 342                 case AST_CONTROL_STREAM_RESTART:
 343                         ast_verbose("SubClass: STREAM_RESTART\n");
 344                         break;
 345                 case AST_CONTROL_STREAM_REVERSE:
 346                         ast_verbose("SubClass: STREAM_REVERSE\n");
 347                         break;
 348                 case AST_CONTROL_STREAM_FORWARD:
 349                         ast_verbose("SubClass: STREAM_FORWARD\n");
 350                         break;
 351                 case AST_CONTROL_RECORD_CANCEL:
 352                         ast_verbose("SubClass: RECORD_CANCEL\n");
 353                         break;
 354                 case AST_CONTROL_RECORD_STOP:
 355                         ast_verbose("SubClass: RECORD_STOP\n");
 356                         break;
 357                 case AST_CONTROL_RECORD_SUSPEND:
 358                         ast_verbose("SubClass: RECORD_SUSPEND\n");
 359                         break;
 360                 case AST_CONTROL_RECORD_MUTE:
 361                         ast_verbose("SubClass: RECORD_MUTE\n");
 362                         break;
 363                 }
 364
 365                 if (frame->subclass.integer == -1) {
 366                         ast_verbose("SubClass: %d\n", frame->subclass.integer);
 367                 }
 368                 ast_verbose("Bytes: %d\n", frame->datalen);
 369                 break;
 370         case AST_FRAME_NULL:
 371                 ast_verbose("FrameType: NULL\n");
 372                 break;
 373         case AST_FRAME_IAX:
 374                 ast_verbose("FrameType: IAX\n");
 375                 break;
 376         case AST_FRAME_TEXT:
 377                 ast_verbose("FrameType: TXT\n");
 378                 break;
 379         case AST_FRAME_IMAGE:
 380                 ast_verbose("FrameType: IMAGE\n");
 381                 break;
 382         case AST_FRAME_HTML:
 383                 ast_verbose("FrameType: HTML\n");
 384                 break;
 385         case AST_FRAME_CNG:
 386                 ast_verbose("FrameType: CNG\n");
 387                 break;
 388         case AST_FRAME_MODEM:
 389                 ast_verbose("FrameType: MODEM\n");
 390                 break;
 391         case AST_FRAME_DTMF_BEGIN:
 392                 ast_verbose("FrameType: DTMF BEGIN\n");
 393                 ast_verbose("Digit: 0x%02X '%c'\n", (unsigned)frame->subclass.integer,
 394                         frame->subclass.integer < ' ' ? ' ' : frame->subclass.integer);
 395                 break;
 396         case AST_FRAME_BRIDGE_ACTION:
 397                 ast_verbose("FrameType: Bridge\n");
 398                 ast_verbose("SubClass: %d\n", frame->subclass.integer);
 399                 break;
 400         case AST_FRAME_BRIDGE_ACTION_SYNC:
 401                 ast_verbose("Frametype: Synchronous Bridge\n");
 402                 ast_verbose("Subclass: %d\n", frame->subclass.integer);
 403                 break;
 404         }
 405
 406         ast_verbose("Src: %s\n", ast_strlen_zero(frame->src) ? "NOT PRESENT" : frame->src);
 407         ast_verbose("\n");
 408 }
 409
 410 static struct ast_custom_function frame_trace_function = {
 411         .name = "FRAME_TRACE",
 412         .write = frame_trace_helper,
 413 };
 414
 415 static int unload_module(void)
 416 {
 417         return ast_custom_function_unregister(&frame_trace_function);
 418 }
 419
 420 static int load_module(void)
 421 {
 422         int res = ast_custom_function_register(&frame_trace_function);
 423         return res ? AST_MODULE_LOAD_DECLINE : AST_MODULE_LOAD_SUCCESS;
 424 }
 425
 426 AST_MODULE_INFO_STANDARD_EXTENDED(ASTERISK_GPL_KEY, "Frame Trace for internal ast_frame debugging.");
 427
 428