Wed Jan 8 2020 09:49:47

Asterisk developer's documentation


func_frame_trace.c
Go to the documentation of this file.
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: 419684 $")
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 {
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 
100  int list_type; /* 0 = white, 1 = black */
102 };
103 
104 static void datastore_destroy_cb(void *data) {
105  ast_free(data);
106 }
107 
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", chan->name);
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 = {
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  ast_datastore_free(datastore);
189  }
190 
191  if (!(datastore = ast_datastore_alloc(&frame_trace_datastore, NULL))) {
192  ast_framehook_detach(chan, i);
193  ast_channel_unlock(chan);
194  return 0;
195  }
196 
197  if (!(id = ast_calloc(1, sizeof(int)))) {
198  ast_datastore_free(datastore);
199  ast_framehook_detach(chan, i);
200  ast_channel_unlock(chan);
201  return 0;
202  }
203 
204  *id = i; /* Store off the id. The channel is still locked so it is safe to access this ptr. */
205  datastore->data = id;
206  ast_channel_datastore_add(chan, datastore);
207  }
208  ast_channel_unlock(chan);
209 
210  return 0;
211 }
212 
213 static void print_frame(struct ast_frame *frame)
214 {
215  switch (frame->frametype) {
216  case AST_FRAME_DTMF_END:
217  ast_verbose("FrameType: DTMF END\n");
218  ast_verbose("Digit: %d\n", frame->subclass.integer);
219  break;
220  case AST_FRAME_VOICE:
221  ast_verbose("FrameType: VOICE\n");
222  ast_verbose("Codec: %s\n", ast_getformatname(frame->subclass.codec));
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_getformatname(frame->subclass.codec));
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;
253  ast_verbose("SubClass: TAKEOFFHOOK\n");
254  break;
255  case AST_CONTROL_OFFHOOK:
256  ast_verbose("SubClass: OFFHOOK\n");
257  break;
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;
271  ast_verbose("SubClass: RADIO KEY\n");
272  break;
274  ast_verbose("SubClass: RADIO UNKEY\n");
275  break;
277  ast_verbose("SubClass: PROGRESS\n");
278  break;
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;
289  ast_verbose("SubClass: VIDUPDATE\n");
290  break;
292  ast_verbose("SubClass: XXX T38\n");
293  break;
295  ast_verbose("SubClass: SRCUPDATE\n");
296  break;
298  ast_verbose("SubClass: TRANSFER\n");
299  break;
301  ast_verbose("SubClass: CONNECTED LINE\n");
302  break;
304  ast_verbose("SubClass: REDIRECTING\n");
305  break;
307  ast_verbose("SubClass: T38 PARAMETERS\n");
308  break;
309  case AST_CONTROL_CC:
310  ast_verbose("SubClass: CC\n");
311  break;
313  ast_verbose("SubClass: SRCCHANGE\n");
314  break;
316  ast_verbose("SubClass: READ ACTION\n");
317  break;
318  case AST_CONTROL_AOC:
319  ast_verbose("SubClass: AOC\n");
320  break;
322  ast_verbose("SubClass: INCOMPLETE\n");
323  break;
325  ast_verbose("SubClass: END_OF_Q\n");
326  break;
328  ast_verbose("SubClass: UPDATE_RTP_PEER\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;
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 
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);
382 }
383 
384 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Frame Trace for internal ast_frame debugging.");
385 
const char * type
Definition: datastore.h:32
union ast_frame_subclass subclass
Definition: frame.h:146
#define ast_channel_lock(chan)
Definition: channel.h:2466
Main Channel structure associated with a channel.
Definition: channel.h:742
#define AST_MODULE_INFO_STANDARD(keystr, desc)
Definition: module.h:396
static struct ast_frame * hook_event_cb(struct ast_channel *chan, struct ast_frame *frame, enum ast_framehook_event event, void *data)
static struct ast_custom_function frame_trace_function
Asterisk main include file. File version handling, generic pbx functions.
static void print_frame(struct ast_frame *frame)
#define ARRAY_LEN(a)
Definition: isdn_lib.c:42
static int load_module(void)
static void hook_destroy_cb(void *framedata)
#define LOG_WARNING
Definition: logger.h:144
ast_framehook_event
These are the types of events that the framehook&#39;s event callback can receive.
Definition: framehook.h:151
void ast_verbose(const char *fmt,...)
Definition: logger.c:1568
int ast_framehook_detach(struct ast_channel *chan, int framehook_id)
Detach an framehook from a channel.
Definition: framehook.c:130
Structure for a data store type.
Definition: datastore.h:31
static struct ast_datastore_info frame_trace_datastore
Structure for a data store object.
Definition: datastore.h:54
struct ast_datastore * ast_channel_datastore_find(struct ast_channel *chan, const struct ast_datastore_info *info, const char *uid)
Find a datastore on a channel.
Definition: channel.c:2604
const char * str
Definition: app_jack.c:144
format_t codec
Definition: frame.h:137
int value
Definition: syslog.c:39
int ast_custom_function_unregister(struct ast_custom_function *acf)
Unregister a custom function.
Definition: pbx.c:3814
int ast_datastore_free(struct ast_datastore *datastore)
Free a data store object.
Definition: datastore.c:65
static void show_frame(struct video_desc *env, int out)
Definition: console_gui.c:259
int ast_framehook_attach(struct ast_channel *chan, struct ast_framehook_interface *i)
Attach an framehook onto a channel for frame interception.
Definition: framehook.c:94
static void datastore_destroy_cb(void *data)
General Asterisk PBX channel definitions.
static int frame_trace_helper(struct ast_channel *chan, const char *cmd, char *data, const char *value)
const char * src
Definition: frame.h:158
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition: strings.h:63
Data structure associated with a custom dialplan function.
Definition: pbx.h:95
int datalen
Definition: frame.h:148
Core PBX routines and definitions.
int values[ARRAY_LEN(frametype2str)]
ast_control_frame_type
Internal control frame subtype field values.
Definition: frame.h:319
char * ast_getformatname(format_t format)
Get the name of a format.
Definition: frame.c:578
#define AST_FRAMEHOOK_INTERFACE_VERSION
Definition: framehook.h:202
const ast_string_field name
Definition: channel.h:787
void ast_log(int level, const char *file, int line, const char *function, const char *fmt,...)
Used for sending a log message This is the standard logger function. Probably the only way you will i...
Definition: logger.c:1207
struct ast_datastore * ast_datastore_alloc(const struct ast_datastore_info *info, const char *uid)
Definition: datastore.c:98
#define ast_channel_unlock(chan)
Definition: channel.h:2467
#define ast_free(a)
Definition: astmm.h:97
static const char type[]
Definition: chan_nbs.c:57
ast_frame_type
Frame types.
Definition: frame.h:101
FrameHook Architecture.
void * data
Definition: datastore.h:56
#define ast_calloc(a, b)
Definition: astmm.h:82
Data structure associated with a single frame of data.
Definition: frame.h:142
const char * name
Definition: pbx.h:96
enum queue_result id
Definition: app_queue.c:1090
enum ast_frame_type frametype
Definition: frame.h:144
#define ASTERISK_GPL_KEY
The text the key() function should return.
Definition: module.h:38
static int unload_module(void)
char * strcasestr(const char *, const char *)
static struct @133 frametype2str[]
union ast_frame::@172 data
int ast_channel_datastore_add(struct ast_channel *chan, struct ast_datastore *datastore)
Add a datastore to a channel.
Definition: channel.c:2590
long len
Definition: frame.h:170
int ast_channel_datastore_remove(struct ast_channel *chan, struct ast_datastore *datastore)
Remove a datastore from a channel.
Definition: channel.c:2599
#define ast_custom_function_register(acf)
Register a custom function.
Definition: pbx.h:1164
#define ASTERISK_FILE_VERSION(file, version)
Register/unregister a source code file with the core.
Definition: asterisk.h:180
int samples
Definition: frame.h:150