epan/dissectors/packet-dis-fields.h

   1 /* packet-dis-fields.h
   2  * Declarations for DIS field parsing.
   3  * Copyright 2005, Scientific Research Corporation
   4  * Initial implementation by Jeremy Ouellette <jouellet@scires.com>
   5  *
   6  * $Id$
   7  *
   8  * Wireshark - Network traffic analyzer
   9  * By Gerald Combs <gerald@wireshark.org>
  10  * Copyright 1998 Gerald Combs
  11  *
  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.
  16  *
  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.
  21  *
  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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  25  */
  26
  27 #ifndef __PACKET_DIS_FIELDPARSERS_H__
  28 #define __PACKET_DIS_FIELDPARSERS_H__
  29
  30 #include <epan/packet.h>
  31
  32 extern int hf_dis_proto_ver;
  33 extern int hf_dis_exercise_id;
  34 extern int hf_dis_pdu_type;
  35 extern int hf_dis_proto_fam;
  36 extern int hf_dis_pdu_length;
  37 extern int hf_dis_entity_id_site;
  38 extern int hf_dis_entity_id_application;
  39 extern int hf_dis_entity_id_entity;
  40 extern int hf_dis_num_art_params;
  41 extern int hf_dis_entityKind;
  42 extern int hf_dis_entityDomain;
  43 extern int hf_dis_category_land;
  44 extern int hf_dis_category_air;
  45 extern int hf_dis_category_surface;
  46 extern int hf_dis_category_subsurface;
  47 extern int hf_dis_category_space;
  48 extern int hf_dis_category_radio;
  49 extern int hf_dis_num_electromagnetic_emission_systems;
  50 extern int hf_dis_emitter_name;
  51 extern int hf_dis_emission_function;
  52 extern int hf_dis_beam_function;
  53 extern int hf_dis_radio_id;
  54 extern int hf_dis_ens;
  55 extern int hf_dis_ens_class;
  56 extern int hf_dis_ens_type;
  57 extern int hf_dis_tdl_type;
  58 extern int hf_dis_sample_rate;
  59 extern int hf_dis_data_length;
  60 extern int hf_dis_num_of_samples;
  61 extern int hf_dis_signal_data;
  62 extern int hf_dis_radio_category;
  63 extern int hf_dis_nomenclature_version;
  64 extern int hf_dis_nomenclature;
  65 extern int hf_dis_radio_transmit_state;
  66 extern int hf_dis_radio_input_source;
  67 extern int hf_dis_antenna_pattern_type;
  68 extern int hf_dis_antenna_pattern_length;
  69 extern int hf_dis_transmit_frequency;
  70 extern int hf_dis_spread_spectrum_usage;
  71 extern int hf_dis_frequency_hopping;
  72 extern int hf_dis_pseudo_noise_modulation;
  73 extern int hf_dis_time_hopping;
  74 extern int hf_dis_modulation_major;
  75 extern int hf_dis_modulation_system;
  76 extern int hf_dis_crypto_system;
  77 extern int hf_dis_crypto_key;
  78 extern int hf_dis_encryption_mode;
  79 extern int hf_dis_key_identifier;
  80 extern int hf_dis_modulation_parameter_length;
  81 extern int hf_dis_mod_param_fh_net_id;
  82 extern int hf_dis_mod_param_fh_set_id;
  83 extern int hf_dis_mod_param_fh_lo_set_id;
  84 extern int hf_dis_mod_param_fh_msg_start;
  85 extern int hf_dis_mod_param_fh_reserved;
  86 extern int hf_dis_mod_param_fh_sync_time_offset;
  87 extern int hf_dis_mod_param_fh_security_key;
  88 extern int hf_dis_mod_param_fh_clear_channel;
  89 extern int hf_dis_mod_param_dump;
  90 extern int hf_dis_mod_param_ts_allocation_mode;
  91 extern int hf_dis_mod_param_transmitter_prim_mode;
  92 extern int hf_dis_mod_param_transmitter_second_mode;
  93 extern int hf_dis_mod_param_sync_state;
  94 extern int hf_dis_mod_param_network_sync_id;
  95 extern int hf_dis_antenna_pattern_parameter_dump;
  96
  97 extern int ett_dis_ens;
  98 extern int ett_dis_crypto_key;
  99
 100
 101
 102 /* enumeration of all field types used for DIS parsing. */
 103 typedef enum
 104 {
 105     /* end marker to indicate the end of a parser sequence */
 106     DIS_FIELDTYPE_END = 0,
 107
 108     /* basic numeric types */
 109     DIS_FIELDTYPE_INT8,
 110     DIS_FIELDTYPE_INT16,
 111     DIS_FIELDTYPE_INT32,
 112     DIS_FIELDTYPE_INT64,
 113     DIS_FIELDTYPE_UINT8,
 114     DIS_FIELDTYPE_UINT16,
 115     DIS_FIELDTYPE_UINT32,
 116     DIS_FIELDTYPE_UINT64,
 117     DIS_FIELDTYPE_FLOAT32,
 118     DIS_FIELDTYPE_FLOAT64,
 119
 120     /* padding */
 121     DIS_FIELDTYPE_PAD8,
 122     DIS_FIELDTYPE_PAD16,
 123     DIS_FIELDTYPE_PAD24,
 124     DIS_FIELDTYPE_PAD32,
 125
 126     /* enumerations */
 127     DIS_FIELDTYPE_ACKNOWLEDGE_FLAG,
 128     DIS_FIELDTYPE_ACTION_ID,
 129     DIS_FIELDTYPE_APPLICATION_GENERAL_STATUS,
 130     DIS_FIELDTYPE_APPLICATION_STATUS_TYPE,
 131     DIS_FIELDTYPE_APPLICATION_TYPE,
 132     DIS_FIELDTYPE_CATEGORY,
 133     DIS_FIELDTYPE_CONTROL_ID,
 134     DIS_FIELDTYPE_DETONATION_RESULT,
 135     DIS_FIELDTYPE_DOMAIN,
 136     DIS_FIELDTYPE_ENTITY_KIND,
 137     DIS_FIELDTYPE_FROZEN_BEHAVIOR,
 138     DIS_FIELDTYPE_PARAMETER_TYPE_DESIGNATOR,
 139     DIS_FIELDTYPE_PDU_TYPE,
 140     DIS_FIELDTYPE_PERSISTENT_OBJECT_TYPE,
 141     DIS_FIELDTYPE_PERSISTENT_OBJECT_CLASS,
 142     DIS_FIELDTYPE_PROTOCOL_FAMILY,
 143     DIS_FIELDTYPE_PROTOCOL_VERSION,
 144     DIS_FIELDTYPE_REASON,
 145     DIS_FIELDTYPE_REQUEST_STATUS,
 146     DIS_FIELDTYPE_REQUIRED_RELIABILITY_SERVICE,
 147     DIS_FIELDTYPE_RESPONSE_FLAG,
 148     DIS_FIELDTYPE_TDL_TYPE,
 149     DIS_FIELDTYPE_RADIO_CATEGORY,
 150     DIS_FIELDTYPE_NOMENCLATURE_VERSION,
 151     DIS_FIELDTYPE_NOMENCLATURE,
 152     DIS_FIELDTYPE_RADIO_TRANSMIT_STATE,
 153     DIS_FIELDTYPE_RADIO_INPUT_SOURCE,
 154     DIS_FIELDTYPE_ANTENNA_PATTERN_TYPE,
 155     DIS_FIELDTYPE_SPREAD_SPECTRUM,
 156     DIS_FIELDTYPE_MODULATION_MAJOR,
 157     DIS_FIELDTYPE_MODULATION_DETAIL,
 158     DIS_FIELDTYPE_MODULATION_SYSTEM,
 159     DIS_FIELDTYPE_CRYPTO_SYSTEM,
 160     DIS_FIELDTYPE_EMITTER_NAME,
 161     DIS_FIELDTYPE_EMISSION_FUNCTION,
 162     DIS_FIELDTYPE_BEAM_FUNCTION,
 163
 164     /* other atomic types */
 165     DIS_FIELDTYPE_PDU_LENGTH,
 166     DIS_FIELDTYPE_EXERCISE_ID,
 167     DIS_FIELDTYPE_SITE,
 168     DIS_FIELDTYPE_APPLICATION,
 169     DIS_FIELDTYPE_ENTITY,
 170     DIS_FIELDTYPE_APPEARANCE,
 171     DIS_FIELDTYPE_ARTIC_PARAM_TYPE,
 172     DIS_FIELDTYPE_CAPABILITIES,
 173     DIS_FIELDTYPE_COUNTRY,
 174     DIS_FIELDTYPE_DATUM_ID,
 175     DIS_FIELDTYPE_DATUM_LENGTH,
 176     DIS_FIELDTYPE_DEAD_RECKONING_PARAMS,
 177     DIS_FIELDTYPE_DEAD_RECKONING_ALGORITHM,
 178     DIS_FIELDTYPE_DEAD_RECKONING_OTHER_PARAMS,
 179     DIS_FIELDTYPE_ENTITY_MARKING,
 180     DIS_FIELDTYPE_EXTRA,
 181     DIS_FIELDTYPE_FIXED_DATUM_VALUE,
 182     DIS_FIELDTYPE_FIXED_LEN_STR,
 183     DIS_FIELDTYPE_FORCE_ID,
 184     DIS_FIELDTYPE_FUSE,
 185     DIS_FIELDTYPE_NUM_FIXED_DATA,
 186     DIS_FIELDTYPE_NUM_VARIABLE_DATA,
 187     DIS_FIELDTYPE_REQUEST_ID,
 188     DIS_FIELDTYPE_SPECIFIC,
 189     DIS_FIELDTYPE_SUBCATEGORY,
 190     DIS_FIELDTYPE_TIME_INTERVAL,
 191     DIS_FIELDTYPE_TIMESTAMP,
 192     DIS_FIELDTYPE_WARHEAD,
 193     DIS_FIELDTYPE_RADIO_ID,
 194     DIS_FIELDTYPE_SAMPLE_RATE,
 195     DIS_FIELDTYPE_DATA_LENGTH,
 196     DIS_FIELDTYPE_NUMBER_OF_SAMPLES,
 197     DIS_FIELDTYPE_NUM_ARTICULATION_PARAMS,
 198     DIS_FIELDTYPE_ANTENNA_PATTERN_LENGTH,
 199     DIS_FIELDTYPE_TRANSMIT_FREQUENCY,
 200     DIS_FIELDTYPE_MODULATION_PARAMETER_LENGTH,
 201     DIS_FIELDTYPE_FH_NETWORK_ID,
 202     DIS_FIELDTYPE_FH_SET_ID,
 203     DIS_FIELDTYPE_LO_SET_ID,
 204     DIS_FIELDTYPE_FH_MSG_START,
 205     DIS_FIELDTYPE_RESERVED,
 206     DIS_FIELDTYPE_FH_SYNC_TIME_OFFSET,
 207     DIS_FIELDTYPE_FH_SECURITY_KEY,
 208     DIS_FIELDTYPE_FH_CLEAR_CHANNEL,
 209     DIS_FIELDTYPE_TS_ALLOCATION_MODE,
 210     DIS_FIELDTYPE_TRANSMITTER_PRIMARY_MODE,
 211     DIS_FIELDTYPE_TRANSMITTER_SECONDARY_MODE,
 212     DIS_FIELDTYPE_JTIDS_SYNC_STATE,
 213     DIS_FIELDTYPE_NETWORK_SYNC_ID,
 214     DIS_FIELDTYPE_NUM_ELECTROMAGNETIC_EMISSION_SYSTEMS,
 215
 216         /* composite types */
 217     DIS_FIELDTYPE_BURST_DESCRIPTOR,
 218     DIS_FIELDTYPE_CLOCK_TIME,
 219     DIS_FIELDTYPE_ENTITY_ID,
 220     DIS_FIELDTYPE_ENTITY_TYPE,
 221     DIS_FIELDTYPE_RADIO_ENTITY_TYPE,
 222     DIS_FIELDTYPE_EVENT_ID,
 223     DIS_FIELDTYPE_LINEAR_VELOCITY,
 224     DIS_FIELDTYPE_LOCATION_ENTITY,
 225     DIS_FIELDTYPE_LOCATION_WORLD,
 226     DIS_FIELDTYPE_ORIENTATION,
 227     DIS_FIELDTYPE_SIMULATION_ADDRESS,
 228     DIS_FIELDTYPE_VARIABLE_DATUM_VALUE,
 229     DIS_FIELDTYPE_VECTOR_32,
 230     DIS_FIELDTYPE_VECTOR_64,
 231     DIS_FIELDTYPE_ENCODING_SCHEME,
 232     DIS_FIELDTYPE_ANTENNA_LOCATION,
 233     DIS_FIELDTYPE_REL_ANTENNA_LOCATON,
 234     DIS_FIELDTYPE_MODULATION_TYPE,
 235     DIS_FIELDTYPE_CRYPTO_KEY_ID,
 236     DIS_FIELDTYPE_MODULATION_PARAMETERS,
 237     DIS_FIELDTYPE_ANTENNA_PATTERN_PARAMETERS,
 238     DIS_FIELDTYPE_MOD_PARAMS_CCTT_SINCGARS,
 239     DIS_FIELDTYPE_MOD_PARAMS_JTIDS_MIDS,
 240     DIS_FIELDTYPE_ELECTROMAGNETIC_EMISSION_SYSTEM_BEAM,
 241     DIS_FIELDTYPE_ELECTROMAGNETIC_EMISSION_SYSTEM,
 242     DIS_FIELDTYPE_EMITTER_SYSTEM,
 243     DIS_FIELDTYPE_FUNDAMENTAL_PARAMETER_DATA,
 244     DIS_FIELDTYPE_TRACK_JAM,
 245
 246     /* arrays */
 247     DIS_FIELDTYPE_FIXED_DATUMS,
 248     DIS_FIELDTYPE_FIXED_DATUM_IDS,
 249     DIS_FIELDTYPE_VARIABLE_DATUMS,
 250     DIS_FIELDTYPE_VARIABLE_DATUM_IDS,
 251     DIS_FIELDTYPE_VARIABLE_PARAMETERS,
 252     DIS_FIELDTYPE_VARIABLE_RECORDS,
 253     DIS_FIELDTYPE_RADIO_DATA
 254
 255 } DIS_FieldType;
 256
 257 /* Struct which contains the data needed to parse a single DIS field.
 258  */
 259 typedef struct DIS_ParserNode_T
 260 {
 261     DIS_FieldType fieldType;
 262     const char *fieldLabel;
 263     int fieldRepeatLen;
 264     int ettVar;
 265     struct DIS_ParserNode_T *children;
 266     guint32 *outputVar;
 267 } DIS_ParserNode;
 268
 269 /* Struct which associates a name with a particular bit combination.
 270  */
 271 typedef struct
 272 {
 273     guint32 value;
 274     const char *label;
 275 } DIS_BitMaskMapping;
 276
 277 /* Struct which specifies all possible bit mappings associated with
 278  * a particular bit mask.
 279  */
 280 typedef struct
 281 {
 282     guint32 maskBits;
 283     guint32 shiftBits;
 284     const char *label;
 285     DIS_BitMaskMapping bitMappings[33];
 286 } DIS_BitMask;
 287
 288 /* Headers */
 289 extern DIS_ParserNode DIS_FIELDS_PDU_HEADER[];
 290 extern DIS_ParserNode DIS_FIELDS_PERSISTENT_OBJECT_HEADER[];
 291
 292 /* Composite types */
 293 extern DIS_ParserNode DIS_FIELDS_BURST_DESCRIPTOR[];
 294 extern DIS_ParserNode DIS_FIELDS_CLOCK_TIME[];
 295 extern DIS_ParserNode DIS_FIELDS_ENTITY_ID[];
 296 extern DIS_ParserNode DIS_FIELDS_ENTITY_TYPE[];
 297 extern DIS_ParserNode DIS_FIELDS_RADIO_ENTITY_TYPE[];
 298 extern DIS_ParserNode DIS_FIELDS_MODULATION_TYPE[];
 299 extern DIS_ParserNode DIS_FIELDS_EVENT_ID[];
 300 extern DIS_ParserNode DIS_FIELDS_ORIENTATION[];
 301 extern DIS_ParserNode DIS_FIELDS_SIMULATION_ADDRESS[];
 302 extern DIS_ParserNode DIS_FIELDS_VECTOR_FLOAT_32[];
 303 extern DIS_ParserNode DIS_FIELDS_VECTOR_FLOAT_64[];
 304 extern DIS_ParserNode DIS_FIELDS_MOD_PARAMS_CCTT_SINCGARS[];
 305 extern DIS_ParserNode DIS_FIELDS_MOD_PARAMS_JTIDS_MIDS[];
 306 extern DIS_ParserNode DIS_FIELDS_EMITTER_SYSTEM[];
 307 extern DIS_ParserNode DIS_FIELDS_FUNDAMENTAL_PARAMETER_DATA[];
 308 extern DIS_ParserNode DIS_FIELDS_TRACK_JAM[];
 309
 310 /* Array records */
 311 extern DIS_ParserNode DIS_FIELDS_FIXED_DATUM[];
 312 extern DIS_ParserNode DIS_FIELDS_VARIABLE_DATUM[];
 313 extern DIS_ParserNode DIS_FIELDS_DATUM_IDS[];
 314 extern DIS_ParserNode DIS_FIELDS_VP_TYPE[];
 315 extern DIS_ParserNode DIS_FIELDS_VR_TYPE[];
 316 extern DIS_ParserNode DIS_FIELDS_VR_ELECTROMAGNETIC_EMISSION_SYSTEM_BEAM[];
 317 extern DIS_ParserNode DIS_FIELDS_VR_ELECTROMAGNETIC_EMISSION_SYSTEM[];
 318
 319 /* Bit fields */
 320 extern DIS_ParserNode DIS_FIELDS_NONE[];
 321 extern DIS_BitMask DIS_APPEARANCE_LANDPLATFORM[];
 322 extern DIS_BitMask DIS_APPEARANCE_LIFEFORM[];
 323
 324 extern void initializeFieldParsers(void);
 325
 326 extern gint parseField_Bytes(tvbuff_t *tvb, proto_tree *tree, gint offset, DIS_ParserNode parserNode, guint numBytes);
 327
 328 extern gint parseField_Bitmask(tvbuff_t *tvb, proto_tree *tree, gint offset, DIS_ParserNode parserNode, guint numBytes);
 329
 330 extern gint parseField_UInt(tvbuff_t *tvb, proto_tree *tree, gint offset, DIS_ParserNode parserNode, guint numBytes);
 331
 332 extern gint parseField_Int(tvbuff_t *tvb, proto_tree *tree, gint offset, DIS_ParserNode parserNode, guint numBytes);
 333
 334 extern gint parseField_Enum(tvbuff_t *tvb, proto_tree *tree, gint offset, DIS_ParserNode parserNode, guint numBytes);
 335
 336 extern gint parseField_Pad(tvbuff_t *tvb, proto_tree *tree, gint offset, DIS_ParserNode parserNode, guint numBytes);
 337
 338 extern gint parseField_Float(tvbuff_t *tvb, proto_tree *tree, gint offset, DIS_ParserNode parserNode);
 339
 340 extern gint parseField_Double(tvbuff_t *tvb, proto_tree *tree, gint offset, DIS_ParserNode parserNode);
 341
 342 extern gint parseField_Timestamp(tvbuff_t *tvb, proto_tree *tree, gint offset, DIS_ParserNode parserNode);
 343
 344 extern gint parseField_VariableParameter(tvbuff_t *tvb, proto_tree *tree, gint offset);
 345
 346 extern gint parseField_VariableRecord(tvbuff_t *tvb, proto_tree *tree, gint offset);
 347
 348 extern gint parseField_ElectromagneticEmissionSystemBeam(tvbuff_t *tvb, proto_tree *tree, gint offset);
 349
 350 extern guint32 disProtocolVersion;
 351 extern guint32 pduType;
 352 extern guint32 protocolFamily;
 353 extern guint32 persistentObjectPduType;
 354 extern guint32 entityKind;
 355 extern guint32 entityDomain;
 356 extern guint32 radioID;
 357 extern guint32 disRadioTransmitState;
 358 extern guint32 encodingScheme;
 359 extern guint32 numSamples;
 360 extern guint32 numFixed;
 361 extern guint32 numVariable;
 362 extern guint32 numBeams;
 363 extern guint32 numTrackJamTargets;
 364 extern guint32 variableDatumLength;
 365 extern guint32 variableRecordLength;
 366 extern guint32 majorModulation;
 367 extern guint32 systemModulation;
 368 extern guint32 modulationParamLength;
 369 extern guint32 disAntennaPattern;
 370
 371
 372 #endif /* packet-dis-fieldparsers.h */