5 /***************************************************************************
6 network_instruments.h - description
8 begin : Wed Oct 29 2003
9 copyright : (C) 2003 by root
10 email : scotte[AT}netinst.com
11 ***************************************************************************/
13 /***************************************************************************
15 * This program is free software; you can redistribute it and/or modify *
16 * it under the terms of the GNU General Public License as published by *
17 * the Free Software Foundation; either version 2 of the License, or *
18 * (at your option) any later version. *
20 ***************************************************************************/
22 #ifndef __NETWORK_INSTRUMENTS_H__
23 #define __NETWORK_INSTRUMENTS_H__
28 int network_instruments_open(wtap *wth, int *err, gchar **err_info);
29 int network_instruments_dump_can_write_encap(int encap);
30 gboolean network_instruments_dump_open(wtap_dumper *wdh, int *err);
33 * In v15 the high_byte was added to allow a larger offset This was done by
34 * reducing the size of observer_version by 1 byte. Since version strings are
35 * only 30 characters the high_byte will always be 0 in previous versions.
37 typedef struct capture_file_header
39 char observer_version[31];
40 guint8 offset_to_first_packet_high_byte; /* allows to extend the offset to the first packet to 256*0x10000 = 16 MB */
41 guint16 offset_to_first_packet;
43 guint8 number_of_information_elements; /* number of TLVs in the header */
44 } capture_file_header;
46 #define CAPTURE_FILE_HEADER_FROM_LE_IN_PLACE(_capture_file_header) \
47 _capture_file_header.offset_to_first_packet = GUINT16_FROM_LE((_capture_file_header).offset_to_first_packet)
49 #define CAPTURE_FILE_HEADER_TO_LE_IN_PLACE(_capture_file_header) \
50 _capture_file_header.offset_to_first_packet = GUINT16_TO_LE((_capture_file_header).offset_to_first_packet)
52 typedef struct tlv_header
55 guint16 length; /* includes the length of the TLV header */
58 #define TLV_HEADER_FROM_LE_IN_PLACE(_tlv_header) \
59 (_tlv_header).type = GUINT16_FROM_LE((_tlv_header).type); \
60 (_tlv_header).length = GUINT16_FROM_LE((_tlv_header).length)
62 #define TLV_HEADER_TO_LE_IN_PLACE(_tlv_header) \
63 (_tlv_header).type = GUINT16_TO_LE((_tlv_header).type); \
64 (_tlv_header).length = GUINT16_TO_LE((_tlv_header).length)
66 typedef struct tlv_time_info {
72 #define TLV_TIME_INFO_FROM_LE_IN_PLACE(_tlv_time_info) \
73 (_tlv_time_info).type = GUINT16_FROM_LE((_tlv_time_info).type); \
74 (_tlv_time_info).length = GUINT16_FROM_LE((_tlv_time_info).length); \
75 (_tlv_time_info).time_format = GUINT32_FROM_LE((_tlv_time_info).time_format)
77 #define TLV_TIME_INFO_TO_LE_IN_PLACE(_tlv_time_info) \
78 (_tlv_time_info).type = GUINT16_TO_LE((_tlv_time_info).type); \
79 (_tlv_time_info).length = GUINT16_TO_LE((_tlv_time_info).length); \
80 (_tlv_time_info).time_format = GUINT32_FROM_LE((_tlv_time_info).time_format)
85 #define INFORMATION_TYPE_ALIAS_LIST 0x01
86 #define INFORMATION_TYPE_COMMENT 0x02 /* ASCII text */
87 #define INFORMATION_TYPE_TIME_INFO 0x04
90 * TVL TIME_INFO values.
92 #define TIME_INFO_LOCAL 0
93 #define TIME_INFO_GMT 1
95 typedef struct packet_entry_header
98 guint32 network_speed;
99 guint16 captured_size;
100 guint16 network_size;
101 guint16 offset_to_frame;
102 guint16 offset_to_next_packet;
105 guint8 number_of_information_elements; /* number of TLVs in the header */
109 guint64 packet_number;
110 guint64 original_packet_number;
111 guint64 nano_seconds_since_2000;
112 } packet_entry_header;
114 #define PACKET_ENTRY_HEADER_FROM_LE_IN_PLACE(_packet_entry_header) \
115 (_packet_entry_header).packet_magic = GUINT32_FROM_LE((_packet_entry_header).packet_magic); \
116 (_packet_entry_header).network_speed = GUINT32_FROM_LE((_packet_entry_header).network_speed); \
117 (_packet_entry_header).captured_size = GUINT16_FROM_LE((_packet_entry_header).captured_size); \
118 (_packet_entry_header).network_size = GUINT16_FROM_LE((_packet_entry_header).network_size); \
119 (_packet_entry_header).offset_to_frame = GUINT16_FROM_LE((_packet_entry_header).offset_to_frame); \
120 (_packet_entry_header).offset_to_next_packet = GUINT16_FROM_LE((_packet_entry_header).offset_to_next_packet); \
121 (_packet_entry_header).errors = GUINT16_FROM_LE((_packet_entry_header).errors); \
122 (_packet_entry_header).reserved = GUINT16_FROM_LE((_packet_entry_header).reserved); \
123 (_packet_entry_header).packet_number = GUINT64_FROM_LE((_packet_entry_header).packet_number); \
124 (_packet_entry_header).original_packet_number = GUINT64_FROM_LE((_packet_entry_header).original_packet_number); \
125 (_packet_entry_header).nano_seconds_since_2000 = GUINT64_FROM_LE((_packet_entry_header).nano_seconds_since_2000)
127 #define PACKET_ENTRY_HEADER_TO_LE_IN_PLACE(_packet_entry_header) \
128 (_packet_entry_header).packet_magic = GUINT32_TO_LE((_packet_entry_header).packet_magic); \
129 (_packet_entry_header).network_speed = GUINT32_TO_LE((_packet_entry_header).network_speed); \
130 (_packet_entry_header).captured_size = GUINT16_TO_LE((_packet_entry_header).captured_size); \
131 (_packet_entry_header).network_size = GUINT16_TO_LE((_packet_entry_header).network_size); \
132 (_packet_entry_header).offset_to_frame = GUINT16_TO_LE((_packet_entry_header).offset_to_frame); \
133 (_packet_entry_header).offset_to_next_packet = GUINT16_TO_LE((_packet_entry_header).offset_to_next_packet); \
134 (_packet_entry_header).errors = GUINT16_TO_LE((_packet_entry_header).errors); \
135 (_packet_entry_header).reserved = GUINT16_TO_LE((_packet_entry_header).reserved); \
136 (_packet_entry_header).packet_number = GUINT64_TO_LE((_packet_entry_header).packet_number); \
137 (_packet_entry_header).original_packet_number = GUINT64_TO_LE((_packet_entry_header).original_packet_number); \
138 (_packet_entry_header).nano_seconds_since_2000 = GUINT64_TO_LE((_packet_entry_header).nano_seconds_since_2000)
141 * Network type values.
143 #define OBSERVER_UNDEFINED 0xFF
144 #define OBSERVER_ETHERNET 0x00
145 #define OBSERVER_TOKENRING 0x01
146 #define OBSERVER_FIBRE_CHANNEL 0x08
149 * Packet type values.
151 #define PACKET_TYPE_DATA_PACKET 0
152 #define PACKET_TYPE_EXPERT_INFORMATION_PACKET 1
155 * The Observer document indicates that the types of expert information
158 * Network Load (markers used by Expert Time Interval and What If
161 * Start/Stop Packet Capture marker frames (with time stamps when
162 * captures start and stop)
164 * Wireless Channel Change (markers showing what channel was being
165 * currently listened to)
167 * That information appears to be contained in TLVs.
173 #define INFORMATION_TYPE_NETWORK_LOAD 0x0100
174 #define INFORMATION_TYPE_CAPTURE_START_STOP 0x0104
177 * Might some of these be broadcast and multicast packet counts?
179 typedef struct tlv_network_load
181 guint32 utilization; /* network utilization, in .1% units */
184 guint32 packets_per_second;
186 guint32 bytes_per_second;
190 typedef struct tlv_capture_start_stop
193 } tlv_capture_start_stop;
195 #define START_STOP_TYPE_STOP 0
196 #define START_STOP_TYPE_START 1