epan/dissectors/packet-sdh.c

   1 /* packet-sdh.c
   2  * Routines for SDH/SONET encapsulation dissection
   3  *
   4  * Wireshark - Network traffic analyzer
   5  * By Gerald Combs <gerald@wireshark.org>
   6  * Copyright 1998 - 2012 Gerald Combs
   7  *
   8  * SPDX-License-Identifier: GPL-2.0-or-later
   9  */
  10
  11 #include "config.h"
  12
  13 #include <epan/packet.h>
  14 #include <epan/prefs.h>
  15 #include <wiretap/wtap.h>
  16
  17 #include "packet-erf.h"
  18
  19
  20 #define COLUMNS 270
  21 #define EXT_HDR_TYPE_RAW_LINK        5
  22
  23 void proto_register_sdh(void);
  24 void proto_reg_handoff_sdh(void);
  25
  26 static int proto_sdh;
  27
  28 static int ett_sdh;
  29
  30 static int hf_sdh_a1;
  31 static int hf_sdh_a2;
  32 static int hf_sdh_j0;
  33 static int hf_sdh_b1;
  34 static int hf_sdh_e1;
  35 static int hf_sdh_f1;
  36 static int hf_sdh_d1;
  37 static int hf_sdh_d2;
  38 static int hf_sdh_d3;
  39 static int hf_sdh_au;
  40 static int hf_sdh_b2;
  41 static int hf_sdh_k1;
  42 static int hf_sdh_k2;
  43 static int hf_sdh_d4;
  44 static int hf_sdh_d5;
  45 static int hf_sdh_d6;
  46 static int hf_sdh_d7;
  47 static int hf_sdh_d8;
  48 static int hf_sdh_d9;
  49 static int hf_sdh_d10;
  50 static int hf_sdh_d11;
  51 static int hf_sdh_d12;
  52 static int hf_sdh_s1;
  53 static int hf_sdh_m1;
  54 static int hf_sdh_e2;
  55 static int hf_sdh_h1;
  56 static int hf_sdh_h2;
  57 static int hf_sdh_j1;
  58
  59 static dissector_handle_t sdh_handle;
  60
  61 static int sdh_data_rate = 1;
  62
  63 static const enum_val_t data_rates[] = {
  64   {"Guess", "Attempt to guess", -1},
  65   {"OC-3",  "OC-3",   1},
  66   {"OC-12", "OC-12",  4},
  67   {"OC-24", "OC-24",  8},
  68   {"OC-48", "OC-48", 16},
  69   {NULL, NULL, -1}
  70 };
  71
  72 static const value_string sdh_s1_vals[] = {
  73   { 0, "Quality unknown" },
  74   { 1, "Reserved" },
  75   { 2, "Rec G.811" },
  76   { 3, "Reserved" },
  77   { 4, "SSU-A" },
  78   { 5, "Reserved" },
  79   { 6, "Reserved" },
  80   { 7, "Reserved" },
  81   { 8, "SSU-B" },
  82   { 9, "Reserved" },
  83   { 10, "Reserved" },
  84   { 11, "SDH Equipment Source" },
  85   { 12, "Reserved" },
  86   { 13, "Reserved" },
  87   { 14, "Reserved" },
  88   { 15, "do not use for sync" },
  89   { 0, NULL }
  90 };
  91
  92 static int
  93 get_sdh_level(tvbuff_t *tvb, packet_info *pinfo)
  94 {
  95   uint64_t *hdr = NULL;
  96
  97   /*data rate has been set in the SDH options*/
  98   if(sdh_data_rate != -1) return sdh_data_rate;
  99
 100   /*ERF specifies data rate*/
 101   hdr = erf_get_ehdr(pinfo, EXT_HDR_TYPE_RAW_LINK, NULL);
 102   if (hdr != NULL){
 103     switch((*hdr & 0xff00) >> 8){
 104       case 1: /*OC-3*/
 105         return 1;
 106       case 2: /*OC-12*/
 107         return 4;
 108       case 3: /*OC-48*/
 109         return 16;
 110       default:  /*drop through and try the next method*/
 111         ;
 112     }
 113   }
 114
 115   /*returns the multiplier for each data level*/
 116   switch(tvb_reported_length(tvb)){
 117     case 2430:  /*OC-3*/
 118       return 1;
 119     case 9720:  /*OC-12*/
 120       return 4;
 121     case 19440: /*OC-24*/
 122       return 8;
 123     case 38880: /*OC-48*/
 124       return 16;
 125   }
 126
 127   return 1;
 128 }
 129
 130
 131 static int
 132 dissect_sdh(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void* data _U_)
 133 {
 134   col_set_str(pinfo->cinfo, COL_PROTOCOL, "SDH");
 135   col_clear(pinfo->cinfo,COL_INFO);
 136
 137   if (tree) {
 138     proto_tree *sdh_tree;
 139     proto_item *sdh_item;
 140
 141     int     level = get_sdh_level(tvb, pinfo);
 142
 143     uint8_t h1;
 144     uint8_t h2;
 145     uint16_t au;
 146     int auoffset;
 147
 148     sdh_item = proto_tree_add_protocol_format(tree, proto_sdh, tvb, 0, -1, "SDH");
 149     sdh_tree = proto_item_add_subtree(sdh_item, ett_sdh);
 150
 151     h1  = tvb_get_uint8(tvb, 0*level+(3*level*COLUMNS));
 152     h2  = tvb_get_uint8(tvb, 3*level+(3*level*COLUMNS));
 153     au  = (h2 | ((0x03 & h1) << 8));
 154
 155     proto_tree_add_item(sdh_tree, hf_sdh_a1, tvb, 0*level, 3*level, ENC_NA);
 156     proto_tree_add_item(sdh_tree, hf_sdh_a2, tvb, 3*level, 3*level, ENC_NA);
 157     proto_tree_add_item(sdh_tree, hf_sdh_j0, tvb, 6*level, 1, ENC_BIG_ENDIAN);
 158     proto_tree_add_item(sdh_tree, hf_sdh_b1, tvb, 0*level+(1*level*COLUMNS), 1, ENC_BIG_ENDIAN);
 159     proto_tree_add_item(sdh_tree, hf_sdh_e1, tvb, 3*level+(1*level*COLUMNS), 1, ENC_BIG_ENDIAN);
 160     proto_tree_add_item(sdh_tree, hf_sdh_f1, tvb, 6*level+(1*level*COLUMNS), 1, ENC_BIG_ENDIAN);
 161     proto_tree_add_item(sdh_tree, hf_sdh_d1, tvb, 0*level+(2*level*COLUMNS), 1, ENC_BIG_ENDIAN);
 162     proto_tree_add_item(sdh_tree, hf_sdh_d2, tvb, 3*level+(2*level*COLUMNS), 1, ENC_BIG_ENDIAN);
 163     proto_tree_add_item(sdh_tree, hf_sdh_d3, tvb, 6*level+(2*level*COLUMNS), 1, ENC_BIG_ENDIAN);
 164     proto_tree_add_item(sdh_tree, hf_sdh_h1, tvb, 0*level+(3*level*COLUMNS), 1, ENC_BIG_ENDIAN);
 165     proto_tree_add_item(sdh_tree, hf_sdh_h2, tvb, 3*level+(3*level*COLUMNS), 1, ENC_BIG_ENDIAN);
 166     proto_tree_add_uint(sdh_tree, hf_sdh_au, tvb, 0*level+(3*level*COLUMNS), 3*level+1, au);
 167     proto_tree_add_item(sdh_tree, hf_sdh_b2, tvb, 0*level+(4*level*COLUMNS), 3*level, ENC_NA);
 168     proto_tree_add_item(sdh_tree, hf_sdh_k1, tvb, 3*level+(4*level*COLUMNS), 1, ENC_BIG_ENDIAN);
 169     proto_tree_add_item(sdh_tree, hf_sdh_k2, tvb, 6*level+(4*level*COLUMNS), 1, ENC_BIG_ENDIAN);
 170     proto_tree_add_item(sdh_tree, hf_sdh_d4, tvb, 0*level+(5*level*COLUMNS), 1, ENC_BIG_ENDIAN);
 171     proto_tree_add_item(sdh_tree, hf_sdh_d5, tvb, 3*level+(5*level*COLUMNS), 1, ENC_BIG_ENDIAN);
 172     proto_tree_add_item(sdh_tree, hf_sdh_d6, tvb, 6*level+(5*level*COLUMNS), 1, ENC_BIG_ENDIAN);
 173     proto_tree_add_item(sdh_tree, hf_sdh_d7, tvb, 0*level+(6*level*COLUMNS), 1, ENC_BIG_ENDIAN);
 174     proto_tree_add_item(sdh_tree, hf_sdh_d8, tvb, 3*level+(6*level*COLUMNS), 1, ENC_BIG_ENDIAN);
 175     proto_tree_add_item(sdh_tree, hf_sdh_d9, tvb, 6*level+(6*level*COLUMNS), 1, ENC_BIG_ENDIAN);
 176     proto_tree_add_item(sdh_tree, hf_sdh_d10, tvb, 0*level+(7*level*COLUMNS), 1, ENC_BIG_ENDIAN);
 177     proto_tree_add_item(sdh_tree, hf_sdh_d11, tvb, 3*level+(7*level*COLUMNS), 1, ENC_BIG_ENDIAN);
 178     proto_tree_add_item(sdh_tree, hf_sdh_d12, tvb, 6*level+(7*level*COLUMNS), 1, ENC_BIG_ENDIAN);
 179     proto_tree_add_item(sdh_tree, hf_sdh_s1, tvb, 0*level+(8*level*COLUMNS), 1, ENC_BIG_ENDIAN);
 180     proto_tree_add_item(sdh_tree, hf_sdh_m1, tvb, 3*level+2+(8*level*COLUMNS), 1, ENC_BIG_ENDIAN);
 181     proto_tree_add_item(sdh_tree, hf_sdh_e2, tvb, 6*level+(8*level*COLUMNS), 1, ENC_BIG_ENDIAN);
 182
 183     /*XXX: POH that au points to may not be in the same frame. Also wrong on pointer justification*/
 184     /*calculate start of SPE by wrapping AU pointer*/
 185     auoffset = (((9 + 3*COLUMNS) /*start after H3*/ + au*3 + 9*(au/87) /*add extra SOH rows to offset*/) * level) % (COLUMNS*9*level);
 186     proto_tree_add_item(sdh_tree, hf_sdh_j1, tvb, auoffset, 1, ENC_BIG_ENDIAN);
 187   }
 188   return tvb_captured_length(tvb);
 189 }
 190
 191 void
 192 proto_register_sdh(void)
 193 {
 194   static hf_register_info hf[] = {
 195     { &hf_sdh_a1,
 196     { "A1", "sdh.a1", FT_BYTES, BASE_NONE, NULL, 0x0, NULL, HFILL }},
 197     { &hf_sdh_a2,
 198     { "A2", "sdh.a2", FT_BYTES, BASE_NONE, NULL, 0x0, NULL, HFILL }},
 199     { &hf_sdh_j0,
 200     { "J0", "sdh.j0", FT_UINT8, BASE_HEX, NULL, 0x0, NULL, HFILL }},
 201     { &hf_sdh_b1,
 202     { "B1", "sdh.b1", FT_UINT8, BASE_HEX, NULL, 0x0, NULL, HFILL }},
 203     { &hf_sdh_e1,
 204     { "E1", "sdh.e1", FT_UINT8, BASE_HEX, NULL, 0x0, NULL, HFILL }},
 205     { &hf_sdh_f1,
 206     { "F1", "sdh.f1", FT_UINT8, BASE_HEX, NULL, 0x0, NULL, HFILL }},
 207     { &hf_sdh_d1,
 208     { "D1", "sdh.d1", FT_UINT8, BASE_HEX, NULL, 0x0, NULL, HFILL }},
 209     { &hf_sdh_d2,
 210     { "D2", "sdh.d2", FT_UINT8, BASE_HEX, NULL, 0x0, NULL, HFILL }},
 211     { &hf_sdh_d3,
 212     { "D3", "sdh.d3", FT_UINT8, BASE_HEX, NULL, 0x0, NULL, HFILL }},
 213     { &hf_sdh_au,
 214     { "AU", "sdh.au", FT_UINT16, BASE_DEC, NULL, 0x0, NULL, HFILL }},
 215     { &hf_sdh_b2,
 216     { "B2", "sdh.b2", FT_BYTES, BASE_NONE, NULL, 0x0, NULL, HFILL }},
 217     { &hf_sdh_k1,
 218     { "K1", "sdh.k1", FT_UINT8, BASE_HEX, NULL, 0x0, NULL, HFILL }},
 219     { &hf_sdh_k2,
 220     { "K2", "sdh.k2", FT_UINT8, BASE_HEX, NULL, 0x0, NULL, HFILL }},
 221     { &hf_sdh_d4,
 222     { "D4", "sdh.d4", FT_UINT8, BASE_HEX, NULL, 0x0, NULL, HFILL }},
 223     { &hf_sdh_d5,
 224     { "D5", "sdh.d5", FT_UINT8, BASE_HEX, NULL, 0x0, NULL, HFILL }},
 225     { &hf_sdh_d6,
 226     { "D6", "sdh.d6", FT_UINT8, BASE_HEX, NULL, 0x0, NULL, HFILL }},
 227     { &hf_sdh_d7,
 228     { "D7", "sdh.d7", FT_UINT8, BASE_HEX, NULL, 0x0, NULL, HFILL }},
 229     { &hf_sdh_d8,
 230     { "D8", "sdh.d8", FT_UINT8, BASE_HEX, NULL, 0x0, NULL, HFILL }},
 231     { &hf_sdh_d9,
 232     { "D9", "sdh.d9", FT_UINT8, BASE_HEX, NULL, 0x0, NULL, HFILL }},
 233     { &hf_sdh_d10,
 234     { "D10", "sdh.d10", FT_UINT8, BASE_HEX, NULL, 0x0, NULL, HFILL }},
 235     { &hf_sdh_d11,
 236     { "D11", "sdh.d11", FT_UINT8, BASE_HEX, NULL, 0x0, NULL, HFILL }},
 237     { &hf_sdh_d12,
 238     { "D12", "sdh.d12", FT_UINT8, BASE_HEX, NULL, 0x0, NULL, HFILL }},
 239     { &hf_sdh_s1,
 240     { "S1", "sdh.s1", FT_UINT8, BASE_HEX, VALS(sdh_s1_vals), 0x0, NULL, HFILL }},
 241     { &hf_sdh_m1,
 242     { "M1", "sdh.m1", FT_UINT8, BASE_DEC, NULL, 0x0, NULL, HFILL }},
 243     { &hf_sdh_e2,
 244     { "E2", "sdh.e2", FT_UINT8, BASE_HEX, NULL, 0x0, NULL, HFILL }},
 245     { &hf_sdh_j1,
 246     { "J1", "sdh.j1", FT_UINT8, BASE_DEC, NULL, 0x0, NULL, HFILL }},
 247     { &hf_sdh_h1,
 248     { "H1", "sdh.h1", FT_UINT8, BASE_HEX, NULL, 0x0, NULL, HFILL }},
 249     { &hf_sdh_h2,
 250     { "H2", "sdh.h2", FT_UINT8, BASE_HEX, NULL, 0x0, NULL, HFILL }},
 251
 252   };
 253   static int *ett[] = {
 254     &ett_sdh,
 255   };
 256
 257   module_t *sdh_module;
 258
 259
 260   proto_sdh = proto_register_protocol("SDH/SONET Protocol", "SDH", "sdh");
 261   proto_register_field_array(proto_sdh, hf, array_length(hf));
 262   proto_register_subtree_array(ett, array_length(ett));
 263
 264   sdh_module = prefs_register_protocol(proto_sdh, NULL);
 265   prefs_register_enum_preference(sdh_module, "data.rate",
 266     "Data rate",
 267     "Data rate",
 268     &sdh_data_rate, data_rates, ENC_BIG_ENDIAN);
 269
 270   sdh_handle = register_dissector("sdh", dissect_sdh, proto_sdh);
 271 }
 272
 273 void
 274 proto_reg_handoff_sdh(void)
 275 {
 276   dissector_add_uint("wtap_encap", WTAP_ENCAP_SDH, sdh_handle);
 277 }
 278
 279 /*
 280  * Editor modelines  -  https://www.wireshark.org/tools/modelines.html
 281  *
 282  * Local Variables:
 283  * c-basic-offset: 2
 284  * tab-width: 8
 285  * indent-tabs-mode: nil
 286  * End:
 287  *
 288  * ex: set shiftwidth=2 tabstop=8 expandtab:
 289  * :indentSize=2:tabSize=8:noTabs=true:
 290  */