The Tcpdump Group git mirrors - tcpdump/blob - print-aoe.c

   1 /*
   2  * Copyright (c) 2014 The TCPDUMP project
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  15  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  16  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  17  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  18  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  20  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  21  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  22  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  24  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  25  * POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 /* \summary: ATA over Ethernet (AoE) protocol printer */
  29
  30 /* specification:
  31  * https://web.archive.org/web/20161025044402/http://brantleycoilecompany.com/AoEr11.pdf
  32  */
  33
  34 #ifdef HAVE_CONFIG_H
  35 #include <config.h>
  36 #endif
  37
  38 #include "netdissect-stdinc.h"
  39
  40 #include "netdissect.h"
  41 #include "extract.h"
  42 #include "addrtoname.h"
  43
  44
  45 #define AOE_V1 1
  46 #define ATA_SECTOR_SIZE 512
  47
  48 #define AOEV1_CMD_ISSUE_ATA_COMMAND        0
  49 #define AOEV1_CMD_QUERY_CONFIG_INFORMATION 1
  50 #define AOEV1_CMD_MAC_MASK_LIST            2
  51 #define AOEV1_CMD_RESERVE_RELEASE          3
  52
  53 static const struct tok cmdcode_str[] = {
  54         { AOEV1_CMD_ISSUE_ATA_COMMAND,        "Issue ATA Command"        },
  55         { AOEV1_CMD_QUERY_CONFIG_INFORMATION, "Query Config Information" },
  56         { AOEV1_CMD_MAC_MASK_LIST,            "MAC Mask List"            },
  57         { AOEV1_CMD_RESERVE_RELEASE,          "Reserve/Release"          },
  58         { 0, NULL }
  59 };
  60
  61 #define AOEV1_COMMON_HDR_LEN    10U /* up to but w/o Arg                */
  62 #define AOEV1_ISSUE_ARG_LEN     12U /* up to but w/o Data               */
  63 #define AOEV1_QUERY_ARG_LEN      8U /* up to but w/o Config String      */
  64 #define AOEV1_MAC_ARG_LEN        4U /* up to but w/o Directive 0        */
  65 #define AOEV1_RESERVE_ARG_LEN    2U /* up to but w/o Ethernet address 0 */
  66 #define AOEV1_MAX_CONFSTR_LEN 1024U
  67
  68 #define AOEV1_FLAG_R 0x08
  69 #define AOEV1_FLAG_E 0x04
  70
  71 static const struct tok aoev1_flag_str[] = {
  72         { AOEV1_FLAG_R, "Response" },
  73         { AOEV1_FLAG_E, "Error"    },
  74         { 0x02,         "MBZ-0x02" },
  75         { 0x01,         "MBZ-0x01" },
  76         { 0, NULL }
  77 };
  78
  79 static const struct tok aoev1_errcode_str[] = {
  80         { 1, "Unrecognized command code" },
  81         { 2, "Bad argument parameter"    },
  82         { 3, "Device unavailable"        },
  83         { 4, "Config string present"     },
  84         { 5, "Unsupported version"       },
  85         { 6, "Target is reserved"        },
  86         { 0, NULL }
  87 };
  88
  89 #define AOEV1_AFLAG_E 0x40
  90 #define AOEV1_AFLAG_D 0x10
  91 #define AOEV1_AFLAG_A 0x02
  92 #define AOEV1_AFLAG_W 0x01
  93
  94 static const struct tok aoev1_aflag_str[] = {
  95         { 0x08,          "MBZ-0x08" },
  96         { AOEV1_AFLAG_E, "Ext48"    },
  97         { 0x06,          "MBZ-0x06" },
  98         { AOEV1_AFLAG_D, "Device"   },
  99         { 0x04,          "MBZ-0x04" },
 100         { 0x03,          "MBZ-0x03" },
 101         { AOEV1_AFLAG_A, "Async"    },
 102         { AOEV1_AFLAG_W, "Write"    },
 103         { 0, NULL }
 104 };
 105
 106 static const struct tok aoev1_ccmd_str[] = {
 107         { 0, "read config string"        },
 108         { 1, "test config string"        },
 109         { 2, "test config string prefix" },
 110         { 3, "set config string"         },
 111         { 4, "force set config string"   },
 112         { 0, NULL }
 113 };
 114
 115 static const struct tok aoev1_mcmd_str[] = {
 116         { 0, "Read Mac Mask List" },
 117         { 1, "Edit Mac Mask List" },
 118         { 0, NULL }
 119 };
 120
 121 static const struct tok aoev1_merror_str[] = {
 122         { 1, "Unspecified Error"  },
 123         { 2, "Bad DCmd directive" },
 124         { 3, "Mask list full"     },
 125         { 0, NULL }
 126 };
 127
 128 static const struct tok aoev1_dcmd_str[] = {
 129         { 0, "No Directive"                      },
 130         { 1, "Add mac address to mask list"      },
 131         { 2, "Delete mac address from mask list" },
 132         { 0, NULL }
 133 };
 134
 135 static const struct tok aoev1_rcmd_str[] = {
 136         { 0, "Read reserve list"      },
 137         { 1, "Set reserve list"       },
 138         { 2, "Force set reserve list" },
 139         { 0, NULL }
 140 };
 141
 142 static void
 143 aoev1_issue_print(netdissect_options *ndo,
 144                   const u_char *cp, const u_int len)
 145 {
 146         const u_char *ep = ndo->ndo_snapend;
 147
 148         if (len < AOEV1_ISSUE_ARG_LEN)
 149                 goto invalid;
 150         /* AFlags */
 151         ND_TCHECK_1(cp);
 152         ND_PRINT("\n\tAFlags: [%s]",
 153                  bittok2str(aoev1_aflag_str, "none", GET_U_1(cp)));
 154         cp += 1;
 155         /* Err/Feature */
 156         ND_TCHECK_1(cp);
 157         ND_PRINT(", Err/Feature: %u", GET_U_1(cp));
 158         cp += 1;
 159         /* Sector Count (not correlated with the length) */
 160         ND_TCHECK_1(cp);
 161         ND_PRINT(", Sector Count: %u", GET_U_1(cp));
 162         cp += 1;
 163         /* Cmd/Status */
 164         ND_TCHECK_1(cp);
 165         ND_PRINT(", Cmd/Status: %u", GET_U_1(cp));
 166         cp += 1;
 167         /* lba0 */
 168         ND_TCHECK_1(cp);
 169         ND_PRINT("\n\tlba0: %u", GET_U_1(cp));
 170         cp += 1;
 171         /* lba1 */
 172         ND_TCHECK_1(cp);
 173         ND_PRINT(", lba1: %u", GET_U_1(cp));
 174         cp += 1;
 175         /* lba2 */
 176         ND_TCHECK_1(cp);
 177         ND_PRINT(", lba2: %u", GET_U_1(cp));
 178         cp += 1;
 179         /* lba3 */
 180         ND_TCHECK_1(cp);
 181         ND_PRINT(", lba3: %u", GET_U_1(cp));
 182         cp += 1;
 183         /* lba4 */
 184         ND_TCHECK_1(cp);
 185         ND_PRINT(", lba4: %u", GET_U_1(cp));
 186         cp += 1;
 187         /* lba5 */
 188         ND_TCHECK_1(cp);
 189         ND_PRINT(", lba5: %u", GET_U_1(cp));
 190         cp += 1;
 191         /* Reserved */
 192         ND_TCHECK_2(cp);
 193         cp += 2;
 194         /* Data */
 195         if (len > AOEV1_ISSUE_ARG_LEN)
 196                 ND_PRINT("\n\tData: %u bytes", len - AOEV1_ISSUE_ARG_LEN);
 197         return;
 198
 199 invalid:
 200         nd_print_invalid(ndo);
 201         ND_TCHECK_LEN(cp, ep - cp);
 202         return;
 203 trunc:
 204         nd_print_trunc(ndo);
 205 }
 206
 207 static void
 208 aoev1_query_print(netdissect_options *ndo,
 209                   const u_char *cp, const u_int len)
 210 {
 211         const u_char *ep = ndo->ndo_snapend;
 212         uint16_t cslen;
 213
 214         if (len < AOEV1_QUERY_ARG_LEN)
 215                 goto invalid;
 216         /* Buffer Count */
 217         ND_TCHECK_2(cp);
 218         ND_PRINT("\n\tBuffer Count: %u", GET_BE_U_2(cp));
 219         cp += 2;
 220         /* Firmware Version */
 221         ND_TCHECK_2(cp);
 222         ND_PRINT(", Firmware Version: %u", GET_BE_U_2(cp));
 223         cp += 2;
 224         /* Sector Count */
 225         ND_TCHECK_1(cp);
 226         ND_PRINT(", Sector Count: %u", GET_U_1(cp));
 227         cp += 1;
 228         /* AoE/CCmd */
 229         ND_TCHECK_1(cp);
 230         ND_PRINT(", AoE: %u, CCmd: %s", (GET_U_1(cp) & 0xF0) >> 4,
 231                   tok2str(aoev1_ccmd_str, "Unknown (0x02x)", GET_U_1(cp) & 0x0F));
 232         cp += 1;
 233         /* Config String Length */
 234         ND_TCHECK_2(cp);
 235         cslen = GET_BE_U_2(cp);
 236         cp += 2;
 237         if (cslen > AOEV1_MAX_CONFSTR_LEN || AOEV1_QUERY_ARG_LEN + cslen > len)
 238                 goto invalid;
 239         /* Config String */
 240         if (cslen) {
 241                 ND_TCHECK_LEN(cp, cslen);
 242                 ND_PRINT("\n\tConfig String (length %u): ", cslen);
 243                 if (nd_printn(ndo, cp, cslen, ndo->ndo_snapend))
 244                         goto trunc;
 245         }
 246         return;
 247
 248 invalid:
 249         nd_print_invalid(ndo);
 250         ND_TCHECK_LEN(cp, ep - cp);
 251         return;
 252 trunc:
 253         nd_print_trunc(ndo);
 254 }
 255
 256 static void
 257 aoev1_mac_print(netdissect_options *ndo,
 258                 const u_char *cp, const u_int len)
 259 {
 260         const u_char *ep = ndo->ndo_snapend;
 261         uint8_t dircount, i;
 262
 263         if (len < AOEV1_MAC_ARG_LEN)
 264                 goto invalid;
 265         /* Reserved */
 266         ND_TCHECK_1(cp);
 267         cp += 1;
 268         /* MCmd */
 269         ND_TCHECK_1(cp);
 270         ND_PRINT("\n\tMCmd: %s",
 271                  tok2str(aoev1_mcmd_str, "Unknown (0x%02x)", GET_U_1(cp)));
 272         cp += 1;
 273         /* MError */
 274         ND_TCHECK_1(cp);
 275         ND_PRINT(", MError: %s",
 276                  tok2str(aoev1_merror_str, "Unknown (0x%02x)", GET_U_1(cp)));
 277         cp += 1;
 278         /* Dir Count */
 279         ND_TCHECK_1(cp);
 280         dircount = GET_U_1(cp);
 281         cp += 1;
 282         ND_PRINT(", Dir Count: %u", dircount);
 283         if (AOEV1_MAC_ARG_LEN + dircount * 8 > len)
 284                 goto invalid;
 285         /* directives */
 286         for (i = 0; i < dircount; i++) {
 287                 /* Reserved */
 288                 ND_TCHECK_1(cp);
 289                 cp += 1;
 290                 /* DCmd */
 291                 ND_TCHECK_1(cp);
 292                 ND_PRINT("\n\t DCmd: %s",
 293                          tok2str(aoev1_dcmd_str, "Unknown (0x%02x)", GET_U_1(cp)));
 294                 cp += 1;
 295                 /* Ethernet Address */
 296                 ND_TCHECK_LEN(cp, MAC_ADDR_LEN);
 297                 ND_PRINT(", Ethernet Address: %s", GET_ETHERADDR_STRING(cp));
 298                 cp += MAC_ADDR_LEN;
 299         }
 300         return;
 301
 302 invalid:
 303         nd_print_invalid(ndo);
 304         ND_TCHECK_LEN(cp, ep - cp);
 305         return;
 306 trunc:
 307         nd_print_trunc(ndo);
 308 }
 309
 310 static void
 311 aoev1_reserve_print(netdissect_options *ndo,
 312                     const u_char *cp, const u_int len)
 313 {
 314         const u_char *ep = ndo->ndo_snapend;
 315         uint8_t nmacs, i;
 316
 317         if (len < AOEV1_RESERVE_ARG_LEN || (len - AOEV1_RESERVE_ARG_LEN) % MAC_ADDR_LEN)
 318                 goto invalid;
 319         /* RCmd */
 320         ND_TCHECK_1(cp);
 321         ND_PRINT("\n\tRCmd: %s",
 322                  tok2str(aoev1_rcmd_str, "Unknown (0x%02x)", GET_U_1(cp)));
 323         cp += 1;
 324         /* NMacs (correlated with the length) */
 325         ND_TCHECK_1(cp);
 326         nmacs = GET_U_1(cp);
 327         cp += 1;
 328         ND_PRINT(", NMacs: %u", nmacs);
 329         if (AOEV1_RESERVE_ARG_LEN + nmacs * MAC_ADDR_LEN != len)
 330                 goto invalid;
 331         /* addresses */
 332         for (i = 0; i < nmacs; i++) {
 333                 ND_TCHECK_LEN(cp, MAC_ADDR_LEN);
 334                 ND_PRINT("\n\tEthernet Address %u: %s", i, GET_ETHERADDR_STRING(cp));
 335                 cp += MAC_ADDR_LEN;
 336         }
 337         return;
 338
 339 invalid:
 340         nd_print_invalid(ndo);
 341         ND_TCHECK_LEN(cp, ep - cp);
 342         return;
 343 trunc:
 344         nd_print_trunc(ndo);
 345 }
 346
 347 /* cp points to the Ver/Flags octet */
 348 static void
 349 aoev1_print(netdissect_options *ndo,
 350             const u_char *cp, const u_int len)
 351 {
 352         const u_char *ep = ndo->ndo_snapend;
 353         uint8_t flags, command;
 354         void (*cmd_decoder)(netdissect_options *, const u_char *, const u_int);
 355
 356         if (len < AOEV1_COMMON_HDR_LEN)
 357                 goto invalid;
 358         /* Flags */
 359         flags = GET_U_1(cp) & 0x0F;
 360         ND_PRINT(", Flags: [%s]", bittok2str(aoev1_flag_str, "none", flags));
 361         cp += 1;
 362         if (! ndo->ndo_vflag)
 363                 return;
 364         /* Error */
 365         ND_TCHECK_1(cp);
 366         if (flags & AOEV1_FLAG_E)
 367                 ND_PRINT("\n\tError: %s",
 368                          tok2str(aoev1_errcode_str, "Invalid (%u)", GET_U_1(cp)));
 369         cp += 1;
 370         /* Major */
 371         ND_TCHECK_2(cp);
 372         ND_PRINT("\n\tMajor: 0x%04x", GET_BE_U_2(cp));
 373         cp += 2;
 374         /* Minor */
 375         ND_TCHECK_1(cp);
 376         ND_PRINT(", Minor: 0x%02x", GET_U_1(cp));
 377         cp += 1;
 378         /* Command */
 379         ND_TCHECK_1(cp);
 380         command = GET_U_1(cp);
 381         cp += 1;
 382         ND_PRINT(", Command: %s", tok2str(cmdcode_str, "Unknown (0x%02x)", command));
 383         /* Tag */
 384         ND_TCHECK_4(cp);
 385         ND_PRINT(", Tag: 0x%08x", GET_BE_U_4(cp));
 386         cp += 4;
 387         /* Arg */
 388         cmd_decoder =
 389                 command == AOEV1_CMD_ISSUE_ATA_COMMAND        ? aoev1_issue_print :
 390                 command == AOEV1_CMD_QUERY_CONFIG_INFORMATION ? aoev1_query_print :
 391                 command == AOEV1_CMD_MAC_MASK_LIST            ? aoev1_mac_print :
 392                 command == AOEV1_CMD_RESERVE_RELEASE          ? aoev1_reserve_print :
 393                 NULL;
 394         if (cmd_decoder != NULL)
 395                 cmd_decoder(ndo, cp, len - AOEV1_COMMON_HDR_LEN);
 396         return;
 397
 398 invalid:
 399         nd_print_invalid(ndo);
 400         ND_TCHECK_LEN(cp, ep - cp);
 401         return;
 402 trunc:
 403         nd_print_trunc(ndo);
 404 }
 405
 406 void
 407 aoe_print(netdissect_options *ndo,
 408           const u_char *cp, const u_int len)
 409 {
 410         const u_char *ep = ndo->ndo_snapend;
 411         uint8_t ver;
 412
 413         ndo->ndo_protocol = "aoe";
 414         ND_PRINT("AoE length %u", len);
 415
 416         if (len < 1)
 417                 goto invalid;
 418         /* Ver/Flags */
 419         ND_TCHECK_1(cp);
 420         ver = (GET_U_1(cp) & 0xF0) >> 4;
 421         /* Don't advance cp yet: low order 4 bits are version-specific. */
 422         ND_PRINT(", Ver %u", ver);
 423
 424         switch (ver) {
 425                 case AOE_V1:
 426                         aoev1_print(ndo, cp, len);
 427                         break;
 428         }
 429         return;
 430
 431 invalid:
 432         nd_print_invalid(ndo);
 433         ND_TCHECK_LEN(cp, ep - cp);
 434         return;
 435 trunc:
 436         nd_print_trunc(ndo);
 437 }
 438