2 * Routines for printing packet analysis trees.
4 * $Id: print.c,v 1.78 2004/04/22 17:03:20 ulfl Exp $
6 * Gilbert Ramirez <gram@alumni.rice.edu>
8 * Ethereal - Network traffic analyzer
9 * By Gerald Combs <gerald@ethereal.com>
10 * Copyright 1998 Gerald Combs
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation; either version 2
15 * of the License, or (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
34 #include <epan/epan.h>
35 #include <epan/epan_dissect.h>
36 #include <epan/tvbuff.h>
37 #include <epan/packet.h>
43 #include "packet-data.h"
44 #include "packet-frame.h"
46 #define PDML_VERSION "0"
47 #define PSML_VERSION "0"
49 static void proto_tree_print_node(proto_node *node, gpointer data);
50 static void proto_tree_print_node_pdml(proto_node *node, gpointer data);
51 static void print_hex_data_buffer(FILE *fh, register const guchar *cp,
52 register guint length, char_enc encoding, gint format);
53 static void ps_clean_string(unsigned char *out, const unsigned char *in,
55 static void print_escaped_xml(FILE *fh, char *unescaped_string);
61 print_dissections_e print_dissections;
62 gboolean print_hex_for_data;
68 static void print_pdml_geninfo(proto_tree *tree, print_data *pdata);
70 FILE *open_print_dest(int to_file, const char *dest)
74 /* Open the file or command for output */
76 fh = fopen(dest, "w");
78 fh = popen(dest, "w");
83 gboolean close_print_dest(int to_file, FILE *fh)
85 /* Close the file or command */
87 return (fclose(fh) == 0);
89 return (pclose(fh) == 0);
94 proto_tree_print(print_args_t *print_args, epan_dissect_t *edt,
100 /* Create the output */
103 data.src_list = edt->pi.data_src;
104 data.encoding = edt->pi.fd->flags.encoding;
105 data.print_dissections = print_args->print_dissections;
106 data.print_hex_for_data = !print_args->print_hex;
107 /* If we're printing the entire packet in hex, don't
108 print uninterpreted data fields in hex as well. */
109 data.format = print_args->format;
112 switch(data.format) {
113 case(PR_FMT_TEXT): /* fall through */
115 proto_tree_children_foreach(edt->tree, proto_tree_print_node, &data);
118 fprintf(fh, "<packet>\n");
120 /* Print a "geninfo" protocol as required by PDML */
121 print_pdml_geninfo(edt->tree, &data);
123 proto_tree_children_foreach(edt->tree, proto_tree_print_node_pdml, &data);
125 fprintf(fh, "</packet>\n\n");
128 /* if this is the first packet, we have to create the PSML structure output */
129 if(edt->pi.fd->num == 1) {
130 fprintf(fh, "<structure>\n");
132 for(i=0; i < edt->pi.cinfo->num_cols; i++) {
133 fprintf(fh, "<section>");
134 print_escaped_xml(fh, edt->pi.cinfo->col_title[i]);
135 fprintf(fh, "</section>\n");
138 fprintf(fh, "</structure>\n\n");
141 fprintf(fh, "<packet>\n");
143 for(i=0; i < edt->pi.cinfo->num_cols; i++) {
144 fprintf(fh, "<section>");
145 print_escaped_xml(fh, edt->pi.cinfo->col_data[i]);
146 fprintf(fh, "</section>\n");
149 fprintf(fh, "</packet>\n\n");
152 g_assert_not_reached();
157 * Find the data source for a specified field, and return a pointer
160 static const guint8 *
161 get_field_data(GSList *src_list, field_info *fi)
166 gint length, tvbuff_length;
168 for (src_le = src_list; src_le != NULL; src_le = src_le->next) {
171 if (fi->ds_tvb == src_tvb) {
175 * XXX - a field can have a length that runs past
176 * the end of the tvbuff. Ideally, that should
177 * be fixed when adding an item to the protocol
178 * tree, but checking the length when doing
179 * that could be expensive. Until we fix that,
180 * we'll do the check here.
183 tvbuff_length = tvb_length_remaining(src_tvb,
185 if (length > tvbuff_length)
186 length = tvbuff_length;
187 return tvb_get_ptr(src_tvb, fi->start, length);
190 g_assert_not_reached();
191 return NULL; /* not found */
194 #define MAX_INDENT 160
196 #define MAX_PS_LINE_LENGTH 256
198 /* Print a tree's data, and any child nodes. */
200 void proto_tree_print_node(proto_node *node, gpointer data)
202 field_info *fi = PITEM_FINFO(node);
203 print_data *pdata = (print_data*) data;
205 gchar label_str[ITEM_LABEL_LENGTH];
208 /* Don't print invisible entries. */
212 /* was a free format label produced? */
214 label_ptr = fi->rep->representation;
216 else { /* no, make a generic label */
217 label_ptr = label_str;
218 proto_item_fill_label(fi, label_str);
221 print_line(pdata->fh, pdata->level, pdata->format, label_ptr);
223 /* If it's uninterpreted data, dump it (unless our caller will
224 be printing the entire packet in hex). */
225 if (fi->hfinfo->id == proto_data && pdata->print_hex_for_data) {
227 * Find the data for this field.
229 pd = get_field_data(pdata->src_list, fi);
230 print_hex_data_buffer(pdata->fh, pd, fi->length,
231 pdata->encoding, pdata->format);
234 /* If we're printing all levels, or if this node is one with a
235 subtree and its subtree is expanded, recurse into the subtree,
237 g_assert(fi->tree_type >= -1 && fi->tree_type < num_tree_types);
238 if (pdata->print_dissections == print_dissections_expanded ||
239 (pdata->print_dissections == print_dissections_as_displayed &&
240 fi->tree_type >= 0 && tree_is_expanded[fi->tree_type])) {
241 if (node->first_child != NULL) {
243 proto_tree_children_foreach(node,
244 proto_tree_print_node, pdata);
250 /* Print a string, escaping out certain characters that need to
251 * escaped out for XML. */
253 print_escaped_xml(FILE *fh, char *unescaped_string)
257 for (p = unescaped_string; *p != '\0'; p++) {
278 print_field_hex_value(print_data *pdata, field_info *fi)
283 /* Find the data for this field. */
284 pd = get_field_data(pdata->src_list, fi);
286 /* Print a simple hex dump */
287 for (i = 0 ; i < fi->length; i++) {
288 fprintf(pdata->fh, "%02x", pd[i]);
293 /* Print a tree's data, and any child nodes, as PDML */
295 proto_tree_print_node_pdml(proto_node *node, gpointer data)
297 field_info *fi = PITEM_FINFO(node);
298 print_data *pdata = (print_data*) data;
300 gchar label_str[ITEM_LABEL_LENGTH];
301 char *dfilter_string;
305 for (i = -1; i < pdata->level; i++) {
306 fputs(" ", pdata->fh);
309 /* Text label. It's printed as a field with no name. */
310 if (fi->hfinfo->id == hf_text_only) {
313 label_ptr = fi->rep->representation;
319 fputs("<field show=\"", pdata->fh);
320 print_escaped_xml(pdata->fh, label_ptr);
322 fprintf(pdata->fh, "\" size=\"%d", fi->length);
323 fprintf(pdata->fh, "\" pos=\"%d", fi->start);
325 fputs("\" value=\"", pdata->fh);
326 print_field_hex_value(pdata, fi);
328 if (node->first_child != NULL) {
329 fputs("\">\n", pdata->fh);
332 fputs("\"/>\n", pdata->fh);
335 /* Uninterpreted data, i.e., the "Data" protocol, is
336 * printed as a field instead of a protocol. */
337 else if (fi->hfinfo->id == proto_data) {
339 fputs("<field name=\"data\" value=\"", pdata->fh);
341 print_field_hex_value(pdata, fi);
343 fputs("\"/>\n", pdata->fh);
346 /* Normal protocols and fields */
348 if (fi->hfinfo->type == FT_PROTOCOL) {
349 fputs("<proto name=\"", pdata->fh);
352 fputs("<field name=\"", pdata->fh);
354 print_escaped_xml(pdata->fh, fi->hfinfo->abbrev);
358 * http://analyzer.polito.it/30alpha/docs/dissectors/PDMLSpec.htm
360 * the show fields contains things in 'human readable' format
361 * showname: contains only the name of the field
362 * show: contains only the data of the field
363 * showdtl: contains additional details of the field data
364 * showmap: contains mappings of the field data (e.g. the hostname to an IP address)
366 * XXX - the showname shouldn't contain the field data itself
367 * (like it's contained in the fi->rep->representation).
368 * Unfortunately, we don't have the field data representation for
369 * all fields, so this isn't currently possible */
370 fputs("\" showname=\"", pdata->fh);
371 print_escaped_xml(pdata->fh, fi->hfinfo->name);
375 fputs("\" showname=\"", pdata->fh);
376 print_escaped_xml(pdata->fh, fi->rep->representation);
379 label_ptr = label_str;
380 proto_item_fill_label(fi, label_str);
381 fputs("\" showname=\"", pdata->fh);
382 print_escaped_xml(pdata->fh, label_ptr);
386 fprintf(pdata->fh, "\" hide=\"yes");
389 fprintf(pdata->fh, "\" size=\"%d", fi->length);
390 fprintf(pdata->fh, "\" pos=\"%d", fi->start);
391 /* fprintf(pdata->fh, "\" id=\"%d", fi->hfinfo->id);*/
393 if (fi->hfinfo->type != FT_PROTOCOL) {
396 /* XXX - this is a hack until we can just call
397 * fvalue_to_string_repr() for *all* FT_* types. */
398 dfilter_string = proto_construct_dfilter_string(fi,
400 if (dfilter_string != NULL) {
401 chop_len = strlen(fi->hfinfo->abbrev) + 4; /* for " == " */
403 /* XXX - Remove double-quotes. Again, once we
404 * can call fvalue_to_string_repr(), we can
405 * ask it not to produce the version for
406 * display-filters, and thus, no
408 if (dfilter_string[strlen(dfilter_string)-1] == '"') {
409 dfilter_string[strlen(dfilter_string)-1] = '\0';
413 fputs("\" show=\"", pdata->fh);
414 print_escaped_xml(pdata->fh, &dfilter_string[chop_len]);
416 if (fi->length > 0) {
417 fputs("\" value=\"", pdata->fh);
418 print_field_hex_value(pdata, fi);
422 if (node->first_child != NULL) {
423 fputs("\">\n", pdata->fh);
425 else if (fi->hfinfo->id == proto_data) {
426 fputs("\">\n", pdata->fh);
429 fputs("\"/>\n", pdata->fh);
433 /* We always print all levels for PDML. Recurse here. */
434 if (node->first_child != NULL) {
436 proto_tree_children_foreach(node,
437 proto_tree_print_node_pdml, pdata);
441 if (node->first_child != NULL) {
442 for (i = -1; i < pdata->level; i++) {
443 fputs(" ", pdata->fh);
445 if (fi->hfinfo->type == FT_PROTOCOL) {
446 fputs("</proto>\n", pdata->fh);
449 fputs("</field>\n", pdata->fh);
454 /* Print info for a 'geninfo' pseudo-protocol. This is required by
455 * the PDML spec. The information is contained in Ethereal's 'frame' protocol,
456 * but we produce a 'geninfo' protocol in the PDML to conform to spec.
457 * The 'frame' protocol follows the 'geninfo' protocol in the PDML. */
459 print_pdml_geninfo(proto_tree *tree, print_data *pdata)
461 guint32 num, len, caplen;
463 GPtrArray *finfo_array;
464 field_info *frame_finfo;
466 /* Get frame protocol's finfo. */
467 finfo_array = proto_find_finfo(tree, proto_frame);
468 if (g_ptr_array_len(finfo_array) < 1) {
471 frame_finfo = finfo_array->pdata[0];
472 g_ptr_array_free(finfo_array, FALSE);
474 /* frame.number --> geninfo.num */
475 finfo_array = proto_find_finfo(tree, hf_frame_number);
476 if (g_ptr_array_len(finfo_array) < 1) {
479 num = fvalue_get_integer(&((field_info*)finfo_array->pdata[0])->value);
480 g_ptr_array_free(finfo_array, FALSE);
482 /* frame.pkt_len --> geninfo.len */
483 finfo_array = proto_find_finfo(tree, hf_frame_packet_len);
484 if (g_ptr_array_len(finfo_array) < 1) {
487 len = fvalue_get_integer(&((field_info*)finfo_array->pdata[0])->value);
488 g_ptr_array_free(finfo_array, FALSE);
490 /* frame.cap_len --> geninfo.caplen */
491 finfo_array = proto_find_finfo(tree, hf_frame_capture_len);
492 if (g_ptr_array_len(finfo_array) < 1) {
495 caplen = fvalue_get_integer(&((field_info*)finfo_array->pdata[0])->value);
496 g_ptr_array_free(finfo_array, FALSE);
498 /* frame.time --> geninfo.timestamp */
499 finfo_array = proto_find_finfo(tree, hf_frame_arrival_time);
500 if (g_ptr_array_len(finfo_array) < 1) {
503 timestamp = fvalue_get(&((field_info*)finfo_array->pdata[0])->value);
504 g_ptr_array_free(finfo_array, FALSE);
506 /* Print geninfo start */
508 " <proto name=\"geninfo\" pos=\"0\" showname=\"General information\" size=\"%u\">\n",
509 frame_finfo->length);
511 /* Print geninfo.num */
513 " <field name=\"num\" pos=\"0\" show=\"%u\" showname=\"Number\" value=\"%x\" size=\"%u\"/>\n",
514 num, num, frame_finfo->length);
516 /* Print geninfo.len */
518 " <field name=\"len\" pos=\"0\" show=\"%u\" showname=\"Packet Length\" value=\"%x\" size=\"%u\"/>\n",
519 len, len, frame_finfo->length);
521 /* Print geninfo.caplen */
523 " <field name=\"caplen\" pos=\"0\" show=\"%u\" showname=\"Captured Length\" value=\"%x\" size=\"%u\"/>\n",
524 caplen, caplen, frame_finfo->length);
526 /* Print geninfo.timestamp */
528 " <field name=\"timestamp\" pos=\"0\" show=\"%s\" showname=\"Captured Time\" value=\"%d.%09d\" size=\"%u\"/>\n",
529 abs_time_to_str(timestamp), (int) timestamp->secs, timestamp->nsecs, frame_finfo->length);
531 /* Print geninfo end */
537 void print_hex_data(FILE *fh, gint format, epan_dissect_t *edt)
539 gboolean multiple_sources;
549 * Set "multiple_sources" iff this frame has more than one
550 * data source; if it does, we need to print the name of
551 * the data source before printing the data from the
554 multiple_sources = (edt->pi.data_src->next != NULL);
556 for (src_le = edt->pi.data_src; src_le != NULL;
557 src_le = src_le->next) {
560 if (multiple_sources) {
562 print_line(fh, 0, format, "");
563 line = g_malloc(strlen(name) + 2); /* <name>:\0 */
566 print_line(fh, 0, format, line);
569 length = tvb_length(tvb);
570 cp = tvb_get_ptr(tvb, 0, length);
571 print_hex_data_buffer(fh, cp, length,
572 edt->pi.fd->flags.encoding, format);
577 * This routine is based on a routine created by Dan Lasley
578 * <DLASLEY@PROMUS.com>.
580 * It was modified for Ethereal by Gilbert Ramirez and others.
583 #define MAX_OFFSET_LEN 8 /* max length of hex offset of bytes */
584 #define BYTES_PER_LINE 16 /* max byte values printed on a line */
585 #define HEX_DUMP_LEN (BYTES_PER_LINE*3)
586 /* max number of characters hex dump takes -
587 2 digits plus trailing blank */
588 #define DATA_DUMP_LEN (HEX_DUMP_LEN + 2 + BYTES_PER_LINE)
589 /* number of characters those bytes take;
590 3 characters per byte of hex dump,
591 2 blanks separating hex from ASCII,
592 1 character per byte of ASCII dump */
593 #define MAX_LINE_LEN (MAX_OFFSET_LEN + 2 + DATA_DUMP_LEN)
594 /* number of characters per line;
595 offset, 2 blanks separating offset
596 from data dump, data dump */
599 print_hex_data_buffer(FILE *fh, register const guchar *cp,
600 register guint length, char_enc encoding, gint format)
602 register unsigned int ad, i, j, k, l;
604 guchar line[MAX_LINE_LEN + 1];
605 unsigned int use_digits;
606 static guchar binhex[16] = {
607 '0', '1', '2', '3', '4', '5', '6', '7',
608 '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};
610 print_line(fh, 0, format, "");
613 * How many of the leading digits of the offset will we supply?
614 * We always supply at least 4 digits, but if the maximum offset
615 * won't fit in 4 digits, we use as many digits as will be needed.
617 if (((length - 1) & 0xF0000000) != 0)
618 use_digits = 8; /* need all 8 digits */
619 else if (((length - 1) & 0x0F000000) != 0)
620 use_digits = 7; /* need 7 digits */
621 else if (((length - 1) & 0x00F00000) != 0)
622 use_digits = 6; /* need 6 digits */
623 else if (((length - 1) & 0x000F0000) != 0)
624 use_digits = 5; /* need 5 digits */
626 use_digits = 4; /* we'll supply 4 digits */
635 * Start of a new line.
642 c = (ad >> (l*4)) & 0xF;
643 line[j++] = binhex[c];
647 memset(line+j, ' ', DATA_DUMP_LEN);
650 * Offset in line of ASCII dump.
652 k = j + HEX_DUMP_LEN + 2;
655 line[j++] = binhex[c>>4];
656 line[j++] = binhex[c&0xf];
658 if (encoding == CHAR_EBCDIC) {
659 c = EBCDIC_to_ASCII1(c);
661 line[k++] = c >= ' ' && c < 0x7f ? c : '.';
663 if ((i & 15) == 0 || i == length) {
665 * We'll be starting a new line, or
666 * we're finished printing this buffer;
667 * dump out the line we've constructed,
668 * and advance the offset.
671 print_line(fh, 0, format, line);
678 void ps_clean_string(unsigned char *out, const unsigned char *in,
684 for (rd = 0, wr = 0 ; wr < outbuf_size; rd++, wr++ ) {
705 /* Some formats need stuff at the beginning of the output */
707 print_preamble(FILE *fh, gint format, gchar *filename)
709 char psbuffer[MAX_PS_LINE_LENGTH]; /* static sized buffer! */
717 print_ps_preamble(fh);
719 fputs("%% Set the font to 10 point\n", fh);
720 fputs("/Courier findfont 10 scalefont setfont\n", fh);
722 fputs("%% the page title\n", fh);
723 ps_clean_string(psbuffer, filename, MAX_PS_LINE_LENGTH);
724 fprintf(fh, "/eth_pagetitle (%s - Ethereal) def\n", psbuffer);
728 fputs("<?xml version=\"1.0\"?>\n", fh);
729 fputs("<pdml version=\"" PDML_VERSION "\" ", fh);
730 fprintf(fh, "creator=\"%s/%s\">\n", PACKAGE, VERSION);
733 fputs("<?xml version=\"1.0\"?>\n", fh);
734 fputs("<psml version=\"" PSML_VERSION "\" ", fh);
735 fprintf(fh, "creator=\"%s/%s\">\n", PACKAGE, VERSION);
738 g_assert_not_reached();
743 print_packet_header(FILE *fh, gint format, guint32 number, gchar *summary) {
744 char psbuffer[MAX_PS_LINE_LENGTH]; /* static sized buffer! */
752 ps_clean_string(psbuffer, summary, MAX_PS_LINE_LENGTH);
753 fprintf(fh, "[/Dest /__frame%u__ /Title (%s) /OUT pdfmark\n", number, psbuffer);
754 fputs("[/View [/XYZ -4 currentpoint matrix currentmatrix matrix defaultmatrix\n", fh);
755 fputs("matrix invertmatrix matrix concatmatrix transform exch pop 20 add null]\n", fh);
756 fprintf(fh, "/Dest /__frame%u__ /DEST pdfmark\n", number);
765 g_assert_not_reached();
770 print_formfeed(FILE *fh, gint format) {
776 fputs("formfeed\n", fh);
785 g_assert_not_reached();
789 /* Some formats need stuff at the end of the output */
791 print_finale(FILE *fh, gint format)
801 fputs("</pdml>\n", fh);
804 fputs("</psml>\n", fh);
807 g_assert_not_reached();
812 print_line(FILE *fh, int indent, gint format, char *line)
814 char space[MAX_INDENT+1];
817 char psbuffer[MAX_PS_LINE_LENGTH]; /* static sized buffer! */
821 /* Prepare the tabs for printing, depending on tree level */
822 num_spaces = indent * 4;
823 if (num_spaces > MAX_INDENT) {
824 num_spaces = MAX_INDENT;
826 for (i = 0; i < num_spaces; i++) {
829 /* The string is NUL-terminated */
830 space[num_spaces] = '\0';
837 ps_clean_string(psbuffer, line, MAX_PS_LINE_LENGTH);
838 fprintf(fh, "%d (%s) putline\n", indent, psbuffer);
847 g_assert_not_reached();