func_frame_trace.c File Reference

Trace internal ast_frames on a channel. More...

#include "asterisk.h"
#include "asterisk/module.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/framehook.h"
#include "asterisk/cli.h"

Include dependency graph for func_frame_trace.c:

Go to the source code of this file.

Data Structures
struct	frame_trace_data

Functions
	AST_MODULE_INFO_STANDARD_EXTENDED (ASTERISK_GPL_KEY, "Frame Trace for internal ast_frame debugging.")
static void	datastore_destroy_cb (void *data)
static int	frame_trace_helper (struct ast_channel *chan, const char *cmd, char *data, const char *value)
static char *	handle_dump_frames (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static void	hook_destroy_cb (void *framedata)
static struct ast_frame *	hook_event_cb (struct ast_channel *chan, struct ast_frame *frame, enum ast_framehook_event event, void *data)
static int	load_module (void)
static void	print_frame (struct ast_frame *frame)
static int	unload_module (void)

Variables
static struct ast_cli_entry	cli_frames []
static const struct ast_datastore_info	frame_trace_datastore
static struct ast_custom_function	frame_trace_function
struct {
const char *   str
enum ast_frame_type   type
}	frametype2str []

Detailed Description

Trace internal ast_frames on a channel.

Author

David Vossel dvoss.nosp@m.el@d.nosp@m.igium.nosp@m..com

Definition in file func_frame_trace.c.

Function Documentation

AST_MODULE_INFO_STANDARD_EXTENDED()

AST_MODULE_INFO_STANDARD_EXTENDED	(	ASTERISK_GPL_KEY	,
		"Frame Trace for internal ast_frame debugging."
	)

datastore_destroy_cb()

static void datastore_destroy_cb ( void *  data )

static

Definition at line 111 of file func_frame_trace.c.

                                             {
    ast_free(data);
}

References ast_free.

frame_trace_helper()

static int frame_trace_helper ( struct ast_channel *  chan, const char *  cmd, char *  data, const char *  value  )

static

Definition at line 156 of file func_frame_trace.c.

{
    struct frame_trace_data *framedata;
    struct ast_datastore *datastore = NULL;
    struct ast_framehook_interface interface = {
        .version = AST_FRAMEHOOK_INTERFACE_VERSION,
        .event_cb = hook_event_cb,
        .destroy_cb = hook_destroy_cb,
    };
    int i = 0;
 
    if (!chan) {
        ast_log(LOG_WARNING, "No channel was provided to %s function.\n", cmd);
        return -1;
    }
 
    if (!(framedata = ast_calloc(1, sizeof(*framedata)))) {
        return 0;
    }
 
    interface.data = framedata;
 
    if (!strcasecmp(data, "black")) {
        framedata->list_type = 1;
    }
    for (i = 0; i < ARRAY_LEN(frametype2str); i++) {
        if (strcasestr(value, frametype2str[i].str)) {
            framedata->values[i] = 1;
        }
    }
 
    ast_channel_lock(chan);
    i = ast_framehook_attach(chan, &interface);
    if (i >= 0) {
        int *id;
        if ((datastore = ast_channel_datastore_find(chan, &frame_trace_datastore, NULL))) {
            id = datastore->data;
            ast_framehook_detach(chan, *id);
            ast_channel_datastore_remove(chan, datastore);
            ast_datastore_free(datastore);
        }
 
        if (!(datastore = ast_datastore_alloc(&frame_trace_datastore, NULL))) {
            ast_framehook_detach(chan, i);
            ast_channel_unlock(chan);
            return 0;
        }
 
        if (!(id = ast_calloc(1, sizeof(int)))) {
            ast_datastore_free(datastore);
            ast_framehook_detach(chan, i);
            ast_channel_unlock(chan);
            return 0;
        }
 
        *id = i; /* Store off the id. The channel is still locked so it is safe to access this ptr. */
        datastore->data = id;
        ast_channel_datastore_add(chan, datastore);
    }
    ast_channel_unlock(chan);
 
    return 0;
}

References ARRAY_LEN, ast_calloc, ast_channel_datastore_add(), ast_channel_datastore_find(), ast_channel_datastore_remove(), ast_channel_lock, ast_channel_unlock, ast_datastore_alloc, ast_datastore_free(), ast_framehook_attach(), ast_framehook_detach(), AST_FRAMEHOOK_INTERFACE_VERSION, ast_log, ast_datastore::data, ast_framehook_interface::data, frame_trace_datastore, frametype2str, hook_destroy_cb(), hook_event_cb(), id, frame_trace_data::list_type, LOG_WARNING, NULL, str, strcasestr(), value, frame_trace_data::values, and ast_framehook_interface::version.

handle_dump_frames()

static char * handle_dump_frames ( struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a  )

static

Definition at line 442 of file func_frame_trace.c.

{
    struct ast_channel *chan;
    struct ast_frame *f;
    int c = 1;
 
    switch (cmd) {
    case CLI_INIT:
        e->command = "channel dump frames";
        e->usage =
            "Usage: channel dump frames <channel>\n"
            "       List all frames queued to a channel.\n";
        return NULL;
    case CLI_GENERATE:
        return ast_complete_channels(a->line, a->word, a->pos, a->n, 3);
    }
 
    if (a->argc != 4) {
        return CLI_SHOWUSAGE;
    }
 
    chan = ast_channel_get_by_name(a->argv[3]);
    if (!chan) {
        ast_cli(a->fd, "%s is not a known channel\n", a->argv[3]);
        return CLI_SUCCESS;
    }
 
    ast_channel_lock(chan);
 
    ast_cli(a->fd, "== Frame list for %s ==\n", ast_channel_name(chan));
    ast_cli(a->fd, "%5s %6s %6s %-15s (%-20s) - %s\n", "#", "Seqno", "Stream", "Frame Type", "Frame Subclass", "Src");
    AST_LIST_TRAVERSE(ast_channel_readq(chan), f, frame_list) {
        char type[64];
        char subclass[64];
        ast_frame_type2str(f->frametype, type, sizeof(type));
        ast_frame_subclass2str(f, subclass, sizeof(subclass), NULL, 0);
        ast_cli(a->fd, "%5d %6d %6d %-15s (%-20s) - %s\n", c++, f->seqno, f->stream_num, type, subclass, S_OR(f->src, ""));
    }
 
    ast_channel_unlock(chan);
    ast_channel_unref(chan);
    return CLI_SUCCESS;
}

References a, ast_channel_get_by_name(), ast_channel_lock, ast_channel_name(), ast_channel_readq(), ast_channel_unlock, ast_channel_unref, ast_cli(), ast_complete_channels(), ast_frame_subclass2str(), ast_frame_type2str(), AST_LIST_TRAVERSE, c, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, ast_frame::frametype, NULL, S_OR, ast_frame::seqno, ast_frame::src, ast_frame::stream_num, ast_frame::subclass, type, and ast_cli_entry::usage.

hook_destroy_cb()

static void hook_destroy_cb ( void *  framedata )

static

Definition at line 120 of file func_frame_trace.c.

{
    ast_free(framedata);
}

References ast_free.

Referenced by frame_trace_helper().

hook_event_cb()

static struct ast_frame * hook_event_cb ( struct ast_channel *  chan, struct ast_frame *  frame, enum ast_framehook_event  event, void *  data  )

static

Definition at line 125 of file func_frame_trace.c.

{
    int i;
    int show_frame = 0;
    struct frame_trace_data *framedata = data;
    if (!frame) {
        return frame;
    }
 
    if ((event != AST_FRAMEHOOK_EVENT_WRITE) && (event != AST_FRAMEHOOK_EVENT_READ)) {
        return frame;
    }
 
    for (i = 0; i < ARRAY_LEN(frametype2str); i++) {
        if (frame->frametype == frametype2str[i].type) {
            if ((framedata->list_type == 0) && (framedata->values[i])) { /* white list */
                show_frame = 1;
            } else if ((framedata->list_type == 1) && (!framedata->values[i])){ /* black list */
                show_frame = 1;
            }
            break;
        }
    }
 
    if (show_frame) {
        ast_verbose("%s on Channel %s\n", event == AST_FRAMEHOOK_EVENT_READ ? "<--Read" : "--> Write", ast_channel_name(chan));
        print_frame(frame);
    }
    return frame;
}

References ARRAY_LEN, ast_channel_name(), AST_FRAMEHOOK_EVENT_READ, AST_FRAMEHOOK_EVENT_WRITE, ast_verbose(), ast_frame::frametype, frametype2str, frame_trace_data::list_type, print_frame(), show_frame(), and frame_trace_data::values.

Referenced by frame_trace_helper().

load_module()

static int load_module ( void  )

static

Definition at line 496 of file func_frame_trace.c.

{
    int res = ast_custom_function_register(&frame_trace_function);
    res |= ast_cli_register_multiple(cli_frames, ARRAY_LEN(cli_frames));
    return res ? AST_MODULE_LOAD_DECLINE : AST_MODULE_LOAD_SUCCESS;
}

References ARRAY_LEN, ast_cli_register_multiple, ast_custom_function_register, AST_MODULE_LOAD_DECLINE, AST_MODULE_LOAD_SUCCESS, cli_frames, and frame_trace_function.

print_frame()

static void print_frame ( struct ast_frame *  frame )

static

Definition at line 220 of file func_frame_trace.c.

{
    switch (frame->frametype) {
    case AST_FRAME_DTMF_END:
        ast_verbose("FrameType: DTMF END\n");
        ast_verbose("Digit: 0x%02X '%c'\n", (unsigned)frame->subclass.integer,
            frame->subclass.integer < ' ' ? ' ' : frame->subclass.integer);
        break;
    case AST_FRAME_VOICE:
        ast_verbose("FrameType: VOICE\n");
        ast_verbose("Codec: %s\n", ast_format_get_name(frame->subclass.format));
        ast_verbose("MS: %ld\n", frame->len);
        ast_verbose("Samples: %d\n", frame->samples);
        ast_verbose("Bytes: %d\n", frame->datalen);
        break;
    case AST_FRAME_VIDEO:
        ast_verbose("FrameType: VIDEO\n");
        ast_verbose("Codec: %s\n", ast_format_get_name(frame->subclass.format));
        ast_verbose("MS: %ld\n", frame->len);
        ast_verbose("Samples: %d\n", frame->samples);
        ast_verbose("Bytes: %d\n", frame->datalen);
        break;
    case AST_FRAME_CONTROL:
        ast_verbose("FrameType: CONTROL\n");
        switch ((enum ast_control_frame_type) frame->subclass.integer) {
        case AST_CONTROL_HANGUP:
            ast_verbose("SubClass: HANGUP\n");
            break;
        case AST_CONTROL_RING:
            ast_verbose("SubClass: RING\n");
            break;
        case AST_CONTROL_RINGING:
            ast_verbose("SubClass: RINGING\n");
            break;
        case AST_CONTROL_ANSWER:
            ast_verbose("SubClass: ANSWER\n");
            break;
        case AST_CONTROL_BUSY:
            ast_verbose("SubClass: BUSY\n");
            break;
        case AST_CONTROL_TAKEOFFHOOK:
            ast_verbose("SubClass: TAKEOFFHOOK\n");
            break;
        case AST_CONTROL_OFFHOOK:
            ast_verbose("SubClass: OFFHOOK\n");
            break;
        case AST_CONTROL_CONGESTION:
            ast_verbose("SubClass: CONGESTION\n");
            break;
        case AST_CONTROL_FLASH:
            ast_verbose("SubClass: FLASH\n");
            break;
        case AST_CONTROL_WINK:
            ast_verbose("SubClass: WINK\n");
            break;
        case AST_CONTROL_OPTION:
            ast_verbose("SubClass: OPTION\n");
            break;
        case AST_CONTROL_RADIO_KEY:
            ast_verbose("SubClass: RADIO KEY\n");
            break;
        case AST_CONTROL_RADIO_UNKEY:
            ast_verbose("SubClass: RADIO UNKEY\n");
            break;
        case AST_CONTROL_PROGRESS:
            ast_verbose("SubClass: PROGRESS\n");
            break;
        case AST_CONTROL_PROCEEDING:
            ast_verbose("SubClass: PROCEEDING\n");
            break;
        case AST_CONTROL_HOLD:
            ast_verbose("SubClass: HOLD\n");
            break;
        case AST_CONTROL_UNHOLD:
            ast_verbose("SubClass: UNHOLD\n");
            break;
        case AST_CONTROL_VIDUPDATE:
            ast_verbose("SubClass: VIDUPDATE\n");
            break;
        case _XXX_AST_CONTROL_T38:
            ast_verbose("SubClass: XXX T38\n");
            break;
        case AST_CONTROL_SRCUPDATE:
            ast_verbose("SubClass: SRCUPDATE\n");
            break;
        case AST_CONTROL_TRANSFER:
            ast_verbose("SubClass: TRANSFER\n");
            break;
        case AST_CONTROL_CONNECTED_LINE:
            ast_verbose("SubClass: CONNECTED LINE\n");
            break;
        case AST_CONTROL_REDIRECTING:
            ast_verbose("SubClass: REDIRECTING\n");
            break;
        case AST_CONTROL_T38_PARAMETERS:
            ast_verbose("SubClass: T38 PARAMETERS\n");
            break;
        case AST_CONTROL_CC:
            ast_verbose("SubClass: CC\n");
            break;
        case AST_CONTROL_SRCCHANGE:
            ast_verbose("SubClass: SRCCHANGE\n");
            break;
        case AST_CONTROL_READ_ACTION:
            ast_verbose("SubClass: READ ACTION\n");
            break;
        case AST_CONTROL_AOC:
            ast_verbose("SubClass: AOC\n");
            break;
        case AST_CONTROL_MCID:
            ast_verbose("SubClass: MCID\n");
            break;
        case AST_CONTROL_INCOMPLETE:
            ast_verbose("SubClass: INCOMPLETE\n");
            break;
        case AST_CONTROL_END_OF_Q:
            ast_verbose("SubClass: END_OF_Q\n");
            break;
        case AST_CONTROL_UPDATE_RTP_PEER:
            ast_verbose("SubClass: UPDATE_RTP_PEER\n");
            break;
        case AST_CONTROL_PVT_CAUSE_CODE:
            ast_verbose("SubClass: PVT_CAUSE_CODE\n");
            break;
        case AST_CONTROL_MASQUERADE_NOTIFY:
            ast_verbose("SubClass: MASQUERADE_NOTIFY\n");
            break;
        case AST_CONTROL_STREAM_TOPOLOGY_REQUEST_CHANGE:
            ast_verbose("SubClass: STREAM_TOPOLOGY_REQUEST_CHANGE\n");
            break;
        case AST_CONTROL_STREAM_TOPOLOGY_CHANGED:
            ast_verbose("SubClass: STREAM_TOPOLOGY_CHANGED\n");
            break;
        case AST_CONTROL_STREAM_TOPOLOGY_SOURCE_CHANGED:
            ast_verbose("SubClass: STREAM_TOPOLOGY_SOURCE_CHANGED\n");
            break;
        case AST_CONTROL_STREAM_STOP:
            ast_verbose("SubClass: STREAM_STOP\n");
            break;
        case AST_CONTROL_STREAM_SUSPEND:
            ast_verbose("SubClass: STREAM_SUSPEND\n");
            break;
        case AST_CONTROL_STREAM_RESTART:
            ast_verbose("SubClass: STREAM_RESTART\n");
            break;
        case AST_CONTROL_STREAM_REVERSE:
            ast_verbose("SubClass: STREAM_REVERSE\n");
            break;
        case AST_CONTROL_STREAM_FORWARD:
            ast_verbose("SubClass: STREAM_FORWARD\n");
            break;
        case AST_CONTROL_RECORD_CANCEL:
            ast_verbose("SubClass: RECORD_CANCEL\n");
            break;
        case AST_CONTROL_RECORD_STOP:
            ast_verbose("SubClass: RECORD_STOP\n");
            break;
        case AST_CONTROL_RECORD_SUSPEND:
            ast_verbose("SubClass: RECORD_SUSPEND\n");
            break;
        case AST_CONTROL_RECORD_MUTE:
            ast_verbose("SubClass: RECORD_MUTE\n");
            break;
        }
 
        if (frame->subclass.integer == -1) {
            ast_verbose("SubClass: %d\n", frame->subclass.integer);
        }
        ast_verbose("Bytes: %d\n", frame->datalen);
        break;
    case AST_FRAME_RTCP:
        ast_verbose("FrameType: RTCP\n");
        break;
    case AST_FRAME_NULL:
        ast_verbose("FrameType: NULL\n");
        break;
    case AST_FRAME_IAX:
        ast_verbose("FrameType: IAX\n");
        break;
    case AST_FRAME_TEXT:
        ast_verbose("FrameType: TXT\n");
        ast_verbose("Text: %.*s\n", frame->datalen, (char*) frame->data.ptr);
        break;
    case AST_FRAME_TEXT_DATA:
        ast_verbose("FrameType: TXT_DATA\n");
        break;
    case AST_FRAME_IMAGE:
        ast_verbose("FrameType: IMAGE\n");
        break;
    case AST_FRAME_HTML:
        ast_verbose("FrameType: HTML\n");
        break;
    case AST_FRAME_CNG:
        ast_verbose("FrameType: CNG\n");
        break;
    case AST_FRAME_MODEM:
        ast_verbose("FrameType: MODEM\n");
        break;
    case AST_FRAME_DTMF_BEGIN:
        ast_verbose("FrameType: DTMF BEGIN\n");
        ast_verbose("Digit: 0x%02X '%c'\n", (unsigned)frame->subclass.integer,
            frame->subclass.integer < ' ' ? ' ' : frame->subclass.integer);
        break;
    case AST_FRAME_BRIDGE_ACTION:
        ast_verbose("FrameType: Bridge\n");
        ast_verbose("SubClass: %d\n", frame->subclass.integer);
        break;
    case AST_FRAME_BRIDGE_ACTION_SYNC:
        ast_verbose("Frametype: Synchronous Bridge\n");
        ast_verbose("Subclass: %d\n", frame->subclass.integer);
        break;
    }
 
    ast_verbose("Src: %s\n", ast_strlen_zero(frame->src) ? "NOT PRESENT" : frame->src);
    ast_verbose("\n");
}

References _XXX_AST_CONTROL_T38, AST_CONTROL_ANSWER, AST_CONTROL_AOC, AST_CONTROL_BUSY, AST_CONTROL_CC, AST_CONTROL_CONGESTION, AST_CONTROL_CONNECTED_LINE, AST_CONTROL_END_OF_Q, AST_CONTROL_FLASH, AST_CONTROL_HANGUP, AST_CONTROL_HOLD, AST_CONTROL_INCOMPLETE, AST_CONTROL_MASQUERADE_NOTIFY, AST_CONTROL_MCID, AST_CONTROL_OFFHOOK, AST_CONTROL_OPTION, AST_CONTROL_PROCEEDING, AST_CONTROL_PROGRESS, AST_CONTROL_PVT_CAUSE_CODE, AST_CONTROL_RADIO_KEY, AST_CONTROL_RADIO_UNKEY, AST_CONTROL_READ_ACTION, AST_CONTROL_RECORD_CANCEL, AST_CONTROL_RECORD_MUTE, AST_CONTROL_RECORD_STOP, AST_CONTROL_RECORD_SUSPEND, AST_CONTROL_REDIRECTING, AST_CONTROL_RING, AST_CONTROL_RINGING, AST_CONTROL_SRCCHANGE, AST_CONTROL_SRCUPDATE, AST_CONTROL_STREAM_FORWARD, AST_CONTROL_STREAM_RESTART, AST_CONTROL_STREAM_REVERSE, AST_CONTROL_STREAM_STOP, AST_CONTROL_STREAM_SUSPEND, AST_CONTROL_STREAM_TOPOLOGY_CHANGED, AST_CONTROL_STREAM_TOPOLOGY_REQUEST_CHANGE, AST_CONTROL_STREAM_TOPOLOGY_SOURCE_CHANGED, AST_CONTROL_T38_PARAMETERS, AST_CONTROL_TAKEOFFHOOK, AST_CONTROL_TRANSFER, AST_CONTROL_UNHOLD, AST_CONTROL_UPDATE_RTP_PEER, AST_CONTROL_VIDUPDATE, AST_CONTROL_WINK, ast_format_get_name(), AST_FRAME_BRIDGE_ACTION, AST_FRAME_BRIDGE_ACTION_SYNC, AST_FRAME_CNG, AST_FRAME_CONTROL, AST_FRAME_DTMF_BEGIN, AST_FRAME_DTMF_END, AST_FRAME_HTML, AST_FRAME_IAX, AST_FRAME_IMAGE, AST_FRAME_MODEM, AST_FRAME_NULL, AST_FRAME_RTCP, AST_FRAME_TEXT, AST_FRAME_TEXT_DATA, AST_FRAME_VIDEO, AST_FRAME_VOICE, ast_strlen_zero(), ast_verbose(), ast_frame::data, ast_frame::datalen, ast_frame_subclass::format, ast_frame::frametype, ast_frame_subclass::integer, ast_frame::len, ast_frame::ptr, ast_frame::samples, ast_frame::src, and ast_frame::subclass.

Referenced by hook_event_cb().

unload_module()

static int unload_module ( void  )

static

Definition at line 490 of file func_frame_trace.c.

{
    ast_cli_unregister_multiple(cli_frames, ARRAY_LEN(cli_frames));
    return ast_custom_function_unregister(&frame_trace_function);
}

References ARRAY_LEN, ast_cli_unregister_multiple(), ast_custom_function_unregister(), cli_frames, and frame_trace_function.

Variable Documentation

cli_frames

struct ast_cli_entry cli_frames[]

static

Initial value:

= {
    { .handler =  handle_dump_frames , .summary =  "Display frames queued on a specific channel" ,}
}

Definition at line 486 of file func_frame_trace.c.

Referenced by load_module(), and unload_module().

frame_trace_datastore

const struct ast_datastore_info frame_trace_datastore

static

Initial value:

= {
    .type = "frametrace",
    .destroy = datastore_destroy_cb
}

Definition at line 115 of file func_frame_trace.c.

Referenced by frame_trace_helper().

frame_trace_function

struct ast_custom_function frame_trace_function

static

Initial value:

= {
    .name = "FRAME_TRACE",
    .write = frame_trace_helper,
}

Definition at line 437 of file func_frame_trace.c.

Referenced by load_module(), and unload_module().

struct { ... } frametype2str[]

Referenced by frame_trace_helper(), and hook_event_cb().

str

const char* str

Definition at line 89 of file func_frame_trace.c.

Referenced by frame_trace_helper().

type

enum ast_frame_type type

Definition at line 88 of file func_frame_trace.c.

Referenced by handle_dump_frames().