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

   1 /*
   2  * This module implements decoding of OpenFlow protocol version 1.3 (wire
   3  * protocol 0x04). It is based on the implementation conventions explained in
   4  * print-openflow-1.0.c.
   5  *
   6  * [OF13] https://www.opennetworking.org/wp-content/uploads/2014/10/openflow-switch-v1.3.4.pdf
   7  *
   8  * Copyright (c) 2020 The TCPDUMP project
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  24  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  31  * POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 /* \summary: OpenFlow protocol version 1.3 printer */
  35
  36 #ifdef HAVE_CONFIG_H
  37 #include <config.h>
  38 #endif
  39
  40 #include "netdissect-stdinc.h"
  41
  42 #define ND_LONGJMP_FROM_TCHECK
  43 #include "netdissect.h"
  44 #include "extract.h"
  45 #include "openflow.h"
  46
  47 #define OFPT_HELLO                     0U
  48 #define OFPT_ERROR                     1U
  49 #define OFPT_ECHO_REQUEST              2U
  50 #define OFPT_ECHO_REPLY                3U
  51 #define OFPT_EXPERIMENTER              4U
  52 #define OFPT_FEATURES_REQUEST          5U
  53 #define OFPT_FEATURES_REPLY            6U
  54 #define OFPT_GET_CONFIG_REQUEST        7U
  55 #define OFPT_GET_CONFIG_REPLY          8U
  56 #define OFPT_SET_CONFIG                9U
  57 #define OFPT_PACKET_IN                10U
  58 #define OFPT_FLOW_REMOVED             11U
  59 #define OFPT_PORT_STATUS              12U
  60 #define OFPT_PACKET_OUT               13U
  61 #define OFPT_FLOW_MOD                 14U
  62 #define OFPT_GROUP_MOD                15U
  63 #define OFPT_PORT_MOD                 16U
  64 #define OFPT_TABLE_MOD                17U
  65 #define OFPT_MULTIPART_REQUEST        18U
  66 #define OFPT_MULTIPART_REPLY          19U
  67 #define OFPT_BARRIER_REQUEST          20U
  68 #define OFPT_BARRIER_REPLY            21U
  69 #define OFPT_QUEUE_GET_CONFIG_REQUEST 22U
  70 #define OFPT_QUEUE_GET_CONFIG_REPLY   23U
  71 #define OFPT_ROLE_REQUEST             24U
  72 #define OFPT_ROLE_REPLY               25U
  73 #define OFPT_GET_ASYNC_REQUEST        26U
  74 #define OFPT_GET_ASYNC_REPLY          27U
  75 #define OFPT_SET_ASYNC                28U
  76 #define OFPT_METER_MOD                29U
  77 static const struct tok ofpt_str[] = {
  78         { OFPT_HELLO,                    "HELLO"                    },
  79         { OFPT_ERROR,                    "ERROR"                    },
  80         { OFPT_ECHO_REQUEST,             "ECHO_REQUEST"             },
  81         { OFPT_ECHO_REPLY,               "ECHO_REPLY"               },
  82         { OFPT_EXPERIMENTER,             "EXPERIMENTER"             },
  83         { OFPT_FEATURES_REQUEST,         "FEATURES_REQUEST"         },
  84         { OFPT_FEATURES_REPLY,           "FEATURES_REPLY"           },
  85         { OFPT_GET_CONFIG_REQUEST,       "GET_CONFIG_REQUEST"       },
  86         { OFPT_GET_CONFIG_REPLY,         "GET_CONFIG_REPLY"         },
  87         { OFPT_SET_CONFIG,               "SET_CONFIG"               },
  88         { OFPT_PACKET_IN,                "PACKET_IN"                },
  89         { OFPT_FLOW_REMOVED,             "FLOW_REMOVED"             },
  90         { OFPT_PORT_STATUS,              "PORT_STATUS"              },
  91         { OFPT_PACKET_OUT,               "PACKET_OUT"               },
  92         { OFPT_FLOW_MOD,                 "FLOW_MOD"                 },
  93         { OFPT_GROUP_MOD,                "GROUP_MOD"                },
  94         { OFPT_PORT_MOD,                 "PORT_MOD"                 },
  95         { OFPT_TABLE_MOD,                "TABLE_MOD"                },
  96         { OFPT_MULTIPART_REQUEST,        "MULTIPART_REQUEST"        },
  97         { OFPT_MULTIPART_REPLY,          "MULTIPART_REPLY"          },
  98         { OFPT_BARRIER_REQUEST,          "BARRIER_REQUEST"          },
  99         { OFPT_BARRIER_REPLY,            "BARRIER_REPLY"            },
 100         { OFPT_QUEUE_GET_CONFIG_REQUEST, "QUEUE_GET_CONFIG_REQUEST" },
 101         { OFPT_QUEUE_GET_CONFIG_REPLY,   "QUEUE_GET_CONFIG_REPLY"   },
 102         { OFPT_ROLE_REQUEST,             "ROLE_REQUEST"             },
 103         { OFPT_ROLE_REPLY,               "ROLE_REPLY"               },
 104         { OFPT_GET_ASYNC_REQUEST,        "GET_ASYNC_REQUEST"        },
 105         { OFPT_GET_ASYNC_REPLY,          "GET_ASYNC_REPLY"          },
 106         { OFPT_SET_ASYNC,                "SET_ASYNC"                },
 107         { OFPT_METER_MOD,                "METER_MOD"                },
 108         { 0, NULL }
 109 };
 110
 111 #define OFPC_FLOW_STATS   (1U <<0)
 112 #define OFPC_TABLE_STATS  (1U <<1)
 113 #define OFPC_PORT_STATS   (1U <<2)
 114 #define OFPC_GROUP_STATS  (1U <<3)
 115 #define OFPC_IP_REASM     (1U <<5)
 116 #define OFPC_QUEUE_STATS  (1U <<6)
 117 #define OFPC_PORT_BLOCKED (1U <<8)
 118 static const struct tok ofp_capabilities_bm[] = {
 119         { OFPC_FLOW_STATS,   "FLOW_STATS"   },
 120         { OFPC_TABLE_STATS,  "TABLE_STATS"  },
 121         { OFPC_PORT_STATS,   "PORT_STATS"   },
 122         { OFPC_GROUP_STATS,  "GROUP_STATS"  },
 123         { OFPC_IP_REASM,     "IP_REASM"     },
 124         { OFPC_QUEUE_STATS,  "QUEUE_STATS"  },
 125         { OFPC_PORT_BLOCKED, "PORT_BLOCKED" },
 126         { 0, NULL }
 127 };
 128 #define OFPCAP_U (~(OFPC_FLOW_STATS | OFPC_TABLE_STATS | OFPC_PORT_STATS | \
 129                     OFPC_GROUP_STATS | OFPC_IP_REASM | OFPC_QUEUE_STATS | \
 130                     OFPC_PORT_BLOCKED))
 131
 132 #define OFPHET_VERSIONBITMAP 1U
 133 static const struct tok ofphet_str[] = {
 134         { OFPHET_VERSIONBITMAP, "VERSIONBITMAP" },
 135         { 0, NULL }
 136 };
 137
 138 #define OFPP_MAX        0xffffff00U
 139 #define OFPP_IN_PORT    0xfffffff8U
 140 #define OFPP_TABLE      0xfffffff9U
 141 #define OFPP_NORMAL     0xfffffffaU
 142 #define OFPP_FLOOD      0xfffffffbU
 143 #define OFPP_ALL        0xfffffffcU
 144 #define OFPP_CONTROLLER 0xfffffffdU
 145 #define OFPP_LOCAL      0xfffffffeU
 146 #define OFPP_ANY        0xffffffffU
 147 static const struct tok ofpp_str[] = {
 148         { OFPP_MAX,        "MAX"        },
 149         { OFPP_IN_PORT,    "IN_PORT"    },
 150         { OFPP_TABLE,      "TABLE"      },
 151         { OFPP_NORMAL,     "NORMAL"     },
 152         { OFPP_FLOOD,      "FLOOD"      },
 153         { OFPP_ALL,        "ALL"        },
 154         { OFPP_CONTROLLER, "CONTROLLER" },
 155         { OFPP_LOCAL,      "LOCAL"      },
 156         { OFPP_ANY,        "ANY"        },
 157         { 0, NULL }
 158 };
 159
 160 #define OF_BIT_VER_1_0 (1U << (OF_VER_1_0 - 1))
 161 #define OF_BIT_VER_1_1 (1U << (OF_VER_1_1 - 1))
 162 #define OF_BIT_VER_1_2 (1U << (OF_VER_1_2 - 1))
 163 #define OF_BIT_VER_1_3 (1U << (OF_VER_1_3 - 1))
 164 #define OF_BIT_VER_1_4 (1U << (OF_VER_1_4 - 1))
 165 #define OF_BIT_VER_1_5 (1U << (OF_VER_1_5 - 1))
 166 static const struct tok ofverbm_str[] = {
 167         { OF_BIT_VER_1_0, "1.0" },
 168         { OF_BIT_VER_1_1, "1.1" },
 169         { OF_BIT_VER_1_2, "1.2" },
 170         { OF_BIT_VER_1_3, "1.3" },
 171         { OF_BIT_VER_1_4, "1.4" },
 172         { OF_BIT_VER_1_5, "1.5" },
 173         { 0, NULL }
 174 };
 175 #define OF_BIT_VER_U (~(OF_BIT_VER_1_0 | OF_BIT_VER_1_1 | OF_BIT_VER_1_2 | \
 176                         OF_BIT_VER_1_3 | OF_BIT_VER_1_4 | OF_BIT_VER_1_5))
 177
 178 #define OFPET_HELLO_FAILED           0U
 179 #define OFPET_BAD_REQUEST            1U
 180 #define OFPET_BAD_ACTION             2U
 181 #define OFPET_BAD_INSTRUCTION        3U
 182 #define OFPET_BAD_MATCH              4U
 183 #define OFPET_FLOW_MOD_FAILED        5U
 184 #define OFPET_GROUP_MOD_FAILED       6U
 185 #define OFPET_PORT_MOD_FAILED        7U
 186 #define OFPET_TABLE_MOD_FAILED       8U
 187 #define OFPET_QUEUE_OP_FAILED        9U
 188 #define OFPET_SWITCH_CONFIG_FAILED  10U
 189 #define OFPET_ROLE_REQUEST_FAILED   11U
 190 #define OFPET_METER_MOD_FAILED      12U
 191 #define OFPET_TABLE_FEATURES_FAILED 13U
 192 #define OFPET_EXPERIMENTER          0xffffU /* a special case */
 193 static const struct tok ofpet_str[] = {
 194         { OFPET_HELLO_FAILED,          "HELLO_FAILED"          },
 195         { OFPET_BAD_REQUEST,           "BAD_REQUEST"           },
 196         { OFPET_BAD_ACTION,            "BAD_ACTION"            },
 197         { OFPET_BAD_INSTRUCTION,       "BAD_INSTRUCTION"       },
 198         { OFPET_BAD_MATCH,             "BAD_MATCH"             },
 199         { OFPET_FLOW_MOD_FAILED,       "FLOW_MOD_FAILED"       },
 200         { OFPET_GROUP_MOD_FAILED,      "GROUP_MOD_FAILED"      },
 201         { OFPET_PORT_MOD_FAILED,       "PORT_MOD_FAILED"       },
 202         { OFPET_TABLE_MOD_FAILED,      "TABLE_MOD_FAILED"      },
 203         { OFPET_QUEUE_OP_FAILED,       "QUEUE_OP_FAILED"       },
 204         { OFPET_SWITCH_CONFIG_FAILED,  "SWITCH_CONFIG_FAILED"  },
 205         { OFPET_ROLE_REQUEST_FAILED,   "ROLE_REQUEST_FAILED"   },
 206         { OFPET_METER_MOD_FAILED,      "METER_MOD_FAILED"      },
 207         { OFPET_TABLE_FEATURES_FAILED, "TABLE_FEATURES_FAILED" },
 208         { OFPET_EXPERIMENTER,          "EXPERIMENTER"          },
 209         { 0, NULL }
 210 };
 211 /*
 212  * As far as of13_error_print() is concerned, OFPET_EXPERIMENTER is too large
 213  * and defines no codes anyway.
 214  */
 215 #define OFPET_MAX OFPET_TABLE_FEATURES_FAILED
 216
 217 #define OFPHFC_INCOMPATIBLE 0U
 218 #define OFPHFC_EPERM        1U
 219 static const struct tok ofphfc_str[] = {
 220         { OFPHFC_INCOMPATIBLE, "INCOMPATIBLE" },
 221         { OFPHFC_EPERM,        "EPERM"        },
 222         { 0, NULL }
 223 };
 224
 225 #define OFPBRC_BAD_VERSION                0U
 226 #define OFPBRC_BAD_TYPE                   1U
 227 #define OFPBRC_BAD_MULTIPART              2U
 228 #define OFPBRC_BAD_EXPERIMENTER           3U
 229 #define OFPBRC_BAD_EXP_TYPE               4U
 230 #define OFPBRC_EPERM                      5U
 231 #define OFPBRC_BAD_LEN                    6U
 232 #define OFPBRC_BUFFER_EMPTY               7U
 233 #define OFPBRC_BUFFER_UNKNOWN             8U
 234 #define OFPBRC_BAD_TABLE_ID               9U
 235 #define OFPBRC_IS_SLAVE                  10U
 236 #define OFPBRC_BAD_PORT                  11U
 237 #define OFPBRC_BAD_PACKET                12U
 238 #define OFPBRC_MULTIPART_BUFFER_OVERFLOW 13U
 239 static const struct tok ofpbrc_str[] = {
 240         { OFPBRC_BAD_VERSION,               "BAD_VERSION"               },
 241         { OFPBRC_BAD_TYPE,                  "BAD_TYPE"                  },
 242         { OFPBRC_BAD_MULTIPART,             "BAD_MULTIPART"             },
 243         { OFPBRC_BAD_EXPERIMENTER,          "BAD_EXPERIMENTER"          },
 244         { OFPBRC_BAD_EXP_TYPE,              "BAD_EXP_TYPE"              },
 245         { OFPBRC_EPERM,                     "EPERM"                     },
 246         { OFPBRC_BAD_LEN,                   "BAD_LEN"                   },
 247         { OFPBRC_BUFFER_EMPTY,              "BUFFER_EMPTY"              },
 248         { OFPBRC_BUFFER_UNKNOWN,            "BUFFER_UNKNOWN"            },
 249         { OFPBRC_BAD_TABLE_ID,              "BAD_TABLE_ID"              },
 250         { OFPBRC_IS_SLAVE,                  "IS_SLAVE"                  },
 251         { OFPBRC_BAD_PORT,                  "BAD_PORT"                  },
 252         { OFPBRC_BAD_PACKET,                "BAD_PACKET"                },
 253         { OFPBRC_MULTIPART_BUFFER_OVERFLOW, "MULTIPART_BUFFER_OVERFLOW" },
 254         { 0, NULL }
 255 };
 256
 257 #define OFPBAC_BAD_TYPE            0U
 258 #define OFPBAC_BAD_LEN             1U
 259 #define OFPBAC_BAD_EXPERIMENTER    2U
 260 #define OFPBAC_BAD_EXP_TYPE        3U
 261 #define OFPBAC_BAD_OUT_PORT        4U
 262 #define OFPBAC_BAD_ARGUMENT        5U
 263 #define OFPBAC_EPERM               6U
 264 #define OFPBAC_TOO_MANY            7U
 265 #define OFPBAC_BAD_QUEUE           8U
 266 #define OFPBAC_BAD_OUT_GROUP       9U
 267 #define OFPBAC_MATCH_INCONSISTENT 10U
 268 #define OFPBAC_UNSUPPORTED_ORDER  11U
 269 #define OFPBAC_BAD_TAG            12U
 270 #define OFPBAC_BAD_SET_TYPE       13U
 271 #define OFPBAC_BAD_SET_LEN        14U
 272 #define OFPBAC_BAD_SET_ARGUMENT   15U
 273 static const struct tok ofpbac_str[] = {
 274         { OFPBAC_BAD_TYPE,           "BAD_TYPE"           },
 275         { OFPBAC_BAD_LEN,            "BAD_LEN"            },
 276         { OFPBAC_BAD_EXPERIMENTER,   "BAD_EXPERIMENTER"   },
 277         { OFPBAC_BAD_EXP_TYPE,       "BAD_EXP_TYPE"       },
 278         { OFPBAC_BAD_OUT_PORT,       "BAD_OUT_PORT"       },
 279         { OFPBAC_BAD_ARGUMENT,       "BAD_ARGUMENT"       },
 280         { OFPBAC_EPERM,              "EPERM"              },
 281         { OFPBAC_TOO_MANY,           "TOO_MANY"           },
 282         { OFPBAC_BAD_QUEUE,          "BAD_QUEUE"          },
 283         { OFPBAC_BAD_OUT_GROUP,      "BAD_OUT_GROUP"      },
 284         { OFPBAC_MATCH_INCONSISTENT, "MATCH_INCONSISTENT" },
 285         { OFPBAC_UNSUPPORTED_ORDER,  "UNSUPPORTED_ORDER"  },
 286         { OFPBAC_BAD_TAG,            "BAD_TAG"            },
 287         { OFPBAC_BAD_SET_TYPE,       "BAD_SET_TYPE"       },
 288         { OFPBAC_BAD_SET_LEN,        "BAD_SET_LEN"        },
 289         { OFPBAC_BAD_SET_ARGUMENT,   "BAD_SET_ARGUMENT"   },
 290         { 0, NULL }
 291 };
 292
 293 #define OFPBIC_UNKNOWN_INST        0U
 294 #define OFPBIC_UNSUP_INST          1U
 295 #define OFPBIC_BAD_TABLE_ID        2U
 296 #define OFPBIC_UNSUP_METADATA      3U
 297 #define OFPBIC_UNSUP_METADATA_MASK 4U
 298 #define OFPBIC_BAD_EXPERIMENTER    5U
 299 #define OFPBIC_BAD_EXP_TYPE        6U
 300 #define OFPBIC_BAD_LEN             7U
 301 #define OFPBIC_EPERM               8U
 302 static const struct tok ofpbic_str[] = {
 303         { OFPBIC_UNKNOWN_INST,        "UNKNOWN_INST"        },
 304         { OFPBIC_UNSUP_INST,          "UNSUP_INST"          },
 305         { OFPBIC_BAD_TABLE_ID,        "BAD_TABLE_ID"        },
 306         { OFPBIC_UNSUP_METADATA,      "UNSUP_METADATA"      },
 307         { OFPBIC_UNSUP_METADATA_MASK, "UNSUP_METADATA_MASK" },
 308         { OFPBIC_BAD_EXPERIMENTER,    "BAD_EXPERIMENTER"    },
 309         { OFPBIC_BAD_EXP_TYPE,        "BAD_EXP_TYPE"        },
 310         { OFPBIC_BAD_LEN,             "BAD_LEN"             },
 311         { OFPBIC_EPERM,               "EPERM"               },
 312         { 0, NULL }
 313 };
 314
 315 #define OFPBMC_BAD_TYPE          0U
 316 #define OFPBMC_BAD_LEN           1U
 317 #define OFPBMC_BAD_TAG           2U
 318 #define OFPBMC_BAD_DL_ADDR_MASK  3U
 319 #define OFPBMC_BAD_NW_ADDR_MASK  4U
 320 #define OFPBMC_BAD_WILDCARDS     5U
 321 #define OFPBMC_BAD_FIELD         6U
 322 #define OFPBMC_BAD_VALUE         7U
 323 #define OFPBMC_BAD_MASK          8U
 324 #define OFPBMC_BAD_PREREQ        9U
 325 #define OFPBMC_DUP_FIELD        10U
 326 #define OFPBMC_EPERM            11U
 327 static const struct tok ofpbmc_str[] = {
 328         { OFPBMC_BAD_TYPE,         "BAD_TYPE"         },
 329         { OFPBMC_BAD_LEN,          "BAD_LEN"          },
 330         { OFPBMC_BAD_TAG,          "BAD_TAG"          },
 331         { OFPBMC_BAD_DL_ADDR_MASK, "BAD_DL_ADDR_MASK" },
 332         { OFPBMC_BAD_NW_ADDR_MASK, "BAD_NW_ADDR_MASK" },
 333         { OFPBMC_BAD_WILDCARDS,    "BAD_WILDCARDS"    },
 334         { OFPBMC_BAD_FIELD,        "BAD_FIELD"        },
 335         { OFPBMC_BAD_VALUE,        "BAD_VALUE"        },
 336         { OFPBMC_BAD_MASK,         "BAD_MASK"         },
 337         { OFPBMC_BAD_PREREQ,       "BAD_PREREQ"       },
 338         { OFPBMC_DUP_FIELD,        "DUP_FIELD"        },
 339         { OFPBMC_EPERM,            "EPERM"            },
 340         { 0, NULL }
 341 };
 342
 343 #define OFPFMFC_UNKNOWN      0U
 344 #define OFPFMFC_TABLE_FULL   1U
 345 #define OFPFMFC_BAD_TABLE_ID 2U
 346 #define OFPFMFC_OVERLAP      3U
 347 #define OFPFMFC_EPERM        4U
 348 #define OFPFMFC_BAD_TIMEOUT  5U
 349 #define OFPFMFC_BAD_COMMAND  6U
 350 #define OFPFMFC_BAD_FLAGS    7U
 351 static const struct tok ofpfmfc_str[] = {
 352         { OFPFMFC_UNKNOWN,      "UNKNOWN"      },
 353         { OFPFMFC_TABLE_FULL,   "TABLE_FULL"   },
 354         { OFPFMFC_BAD_TABLE_ID, "BAD_TABLE_ID" },
 355         { OFPFMFC_OVERLAP,      "OVERLAP"      },
 356         { OFPFMFC_EPERM,        "EPERM"        },
 357         { OFPFMFC_BAD_TIMEOUT,  "BAD_TIMEOUT"  },
 358         { OFPFMFC_BAD_COMMAND,  "BAD_COMMAND"  },
 359         { OFPFMFC_BAD_FLAGS,    "BAD_FLAGS"    },
 360         { 0, NULL }
 361 };
 362
 363 #define OFPGMFC_GROUP_EXISTS          0U
 364 #define OFPGMFC_INVALID_GROUP         1U
 365 #define OFPGMFC_WEIGHT_UNSUPPORTED    2U
 366 #define OFPGMFC_OUT_OF_GROUPS         3U
 367 #define OFPGMFC_OUT_OF_BUCKETS        4U
 368 #define OFPGMFC_CHAINING_UNSUPPORTED  5U
 369 #define OFPGMFC_WATCH_UNSUPPORTED     6U
 370 #define OFPGMFC_LOOP                  7U
 371 #define OFPGMFC_UNKNOWN_GROUP         8U
 372 #define OFPGMFC_CHAINED_GROUP         9U
 373 #define OFPGMFC_BAD_TYPE             10U
 374 #define OFPGMFC_BAD_COMMAND          11U
 375 #define OFPGMFC_BAD_BUCKET           12U
 376 #define OFPGMFC_BAD_MATCH            13U
 377 #define OFPGMFC_EPERM                14U
 378 static const struct tok ofpgmfc_str[] = {
 379         { OFPGMFC_GROUP_EXISTS,         "GROUP_EXISTS"         },
 380         { OFPGMFC_INVALID_GROUP,        "INVALID_GROUP"        },
 381         { OFPGMFC_WEIGHT_UNSUPPORTED,   "WEIGHT_UNSUPPORTED"   },
 382         { OFPGMFC_OUT_OF_GROUPS,        "OUT_OF_GROUPS"        },
 383         { OFPGMFC_OUT_OF_BUCKETS,       "OUT_OF_BUCKETS"       },
 384         { OFPGMFC_CHAINING_UNSUPPORTED, "CHAINING_UNSUPPORTED" },
 385         { OFPGMFC_WATCH_UNSUPPORTED,    "WATCH_UNSUPPORTED"    },
 386         { OFPGMFC_LOOP,                 "LOOP"                 },
 387         { OFPGMFC_UNKNOWN_GROUP,        "UNKNOWN_GROUP"        },
 388         { OFPGMFC_CHAINED_GROUP,        "CHAINED_GROUP"        },
 389         { OFPGMFC_BAD_TYPE,             "BAD_TYPE"             },
 390         { OFPGMFC_BAD_COMMAND,          "BAD_COMMAND"          },
 391         { OFPGMFC_BAD_BUCKET,           "BAD_BUCKET"           },
 392         { OFPGMFC_BAD_MATCH,            "BAD_MATCH"            },
 393         { OFPGMFC_EPERM,                "EPERM"                },
 394         { 0, NULL }
 395 };
 396
 397 #define OFPPMFC_BAD_PORT      0U
 398 #define OFPPMFC_BAD_HW_ADDR   1U
 399 #define OFPPMFC_BAD_CONFIG    2U
 400 #define OFPPMFC_BAD_ADVERTISE 3U
 401 #define OFPPMFC_EPERM         4U
 402 static const struct tok ofppmfc_str[] = {
 403         { OFPPMFC_BAD_PORT,      "BAD_PORT"      },
 404         { OFPPMFC_BAD_HW_ADDR,   "BAD_HW_ADDR"   },
 405         { OFPPMFC_BAD_CONFIG,    "BAD_CONFIG"    },
 406         { OFPPMFC_BAD_ADVERTISE, "BAD_ADVERTISE" },
 407         { OFPPMFC_EPERM,         "EPERM"         },
 408         { 0, NULL }
 409 };
 410
 411 #define OFPTMFC_BAD_TABLE  0U
 412 #define OFPTMFC_BAD_CONFIG 1U
 413 #define OFPTMFC_EPERM      2U
 414 static const struct tok ofptmfc_str[] = {
 415         { OFPTMFC_BAD_TABLE,  "BAD_TABLE"  },
 416         { OFPTMFC_BAD_CONFIG, "BAD_CONFIG" },
 417         { OFPTMFC_EPERM,      "EPERM"      },
 418         { 0, NULL }
 419 };
 420
 421 #define OFPQOFC_BAD_PORT  0U
 422 #define OFPQOFC_BAD_QUEUE 1U
 423 #define OFPQOFC_EPERM     2U
 424 static const struct tok ofpqofc_str[] = {
 425         { OFPQOFC_BAD_PORT,  "BAD_PORT"  },
 426         { OFPQOFC_BAD_QUEUE, "BAD_QUEUE" },
 427         { OFPQOFC_EPERM,     "EPERM"     },
 428         { 0, NULL }
 429 };
 430
 431 #define OFPSCFC_BAD_FLAGS 0U
 432 #define OFPSCFC_BAD_LEN   1U
 433 #define OFPSCFC_EPERM     2U
 434 static const struct tok ofpscfc_str[] = {
 435         { OFPSCFC_BAD_FLAGS, "BAD_FLAGS" },
 436         { OFPSCFC_BAD_LEN,   "BAD_LEN"   },
 437         { OFPSCFC_EPERM,     "EPERM"     },
 438         { 0, NULL }
 439 };
 440
 441 #define OFPRRFC_STALE    0U
 442 #define OFPRRFC_UNSUP    1U
 443 #define OFPRRFC_BAD_ROLE 2U
 444 static const struct tok ofprrfc_str[] = {
 445         { OFPRRFC_STALE,    "STALE"    },
 446         { OFPRRFC_UNSUP,    "UNSUP"    },
 447         { OFPRRFC_BAD_ROLE, "BAD_ROLE" },
 448         { 0, NULL }
 449 };
 450
 451 #define OFPMMFC_UNKNOWN         0U
 452 #define OFPMMFC_METER_EXISTS    1U
 453 #define OFPMMFC_INVALID_METER   2U
 454 #define OFPMMFC_UNKNOWN_METER   3U
 455 #define OFPMMFC_BAD_COMMAND     4U
 456 #define OFPMMFC_BAD_FLAGS       5U
 457 #define OFPMMFC_BAD_RATE        6U
 458 #define OFPMMFC_BAD_BURST       7U
 459 #define OFPMMFC_BAD_BAND        8U
 460 #define OFPMMFC_BAD_BAND_VALUE  9U
 461 #define OFPMMFC_OUT_OF_METERS  10U
 462 #define OFPMMFC_OUT_OF_BANDS   11U
 463 static const struct tok ofpmmfc_str[] = {
 464         { OFPMMFC_UNKNOWN,        "UNKNOWN"        },
 465         { OFPMMFC_METER_EXISTS,   "METER_EXISTS"   },
 466         { OFPMMFC_INVALID_METER,  "INVALID_METER"  },
 467         { OFPMMFC_UNKNOWN_METER,  "UNKNOWN_METER"  },
 468         { OFPMMFC_BAD_COMMAND,    "BAD_COMMAND"    },
 469         { OFPMMFC_BAD_FLAGS,      "BAD_FLAGS"      },
 470         { OFPMMFC_BAD_RATE,       "BAD_RATE"       },
 471         { OFPMMFC_BAD_BURST,      "BAD_BURST"      },
 472         { OFPMMFC_BAD_BAND,       "BAD_BAND"       },
 473         { OFPMMFC_BAD_BAND_VALUE, "BAD_BAND_VALUE" },
 474         { OFPMMFC_OUT_OF_METERS,  "OUT_OF_METERS"  },
 475         { OFPMMFC_OUT_OF_BANDS,   "OUT_OF_BANDS"   },
 476         { 0, NULL }
 477 };
 478
 479 #define OFPTFFC_BAD_TABLE    0U
 480 #define OFPTFFC_BAD_METADATA 1U
 481 #define OFPTFFC_BAD_TYPE     2U
 482 #define OFPTFFC_BAD_LEN      3U
 483 #define OFPTFFC_BAD_ARGUMENT 4U
 484 #define OFPTFFC_EPERM        5U
 485 static const struct tok ofptffc_str[] = {
 486         { OFPTFFC_BAD_TABLE,    "BAD_TABLE"    },
 487         { OFPTFFC_BAD_METADATA, "BAD_METADATA" },
 488         { OFPTFFC_BAD_TYPE,     "BAD_TYPE"     },
 489         { OFPTFFC_BAD_LEN,      "BAD_LEN"      },
 490         { OFPTFFC_BAD_ARGUMENT, "BAD_ARGUMENT" },
 491         { OFPTFFC_EPERM,        "EPERM"        },
 492         { 0, NULL }
 493 };
 494
 495 /* lengths (fixed or minimal) of particular protocol structures */
 496 #define OF_HELLO_ELEM_MINSIZE                 4U
 497 #define OF_ERROR_MSG_MINLEN                   12U
 498 #define OF_FEATURES_REPLY_FIXLEN              32U
 499 #define OF_QUEUE_GET_CONFIG_REQUEST_FIXLEN    16U
 500
 501 /* [OF13] Section A.1 */
 502 const char *
 503 of13_msgtype_str(const uint8_t type)
 504 {
 505         return tok2str(ofpt_str, "invalid (0x%02x)", type);
 506 }
 507
 508 /* [OF13] Section 7.3.1 */
 509 static void
 510 of13_features_reply_print(netdissect_options *ndo,
 511                           const u_char *cp, u_int len)
 512 {
 513         /* datapath_id */
 514         ND_PRINT("\n\t dpid 0x%016" PRIx64, GET_BE_U_8(cp));
 515         OF_FWD(8);
 516         /* n_buffers */
 517         ND_PRINT(", n_buffers %u", GET_BE_U_4(cp));
 518         OF_FWD(4);
 519         /* n_tables */
 520         ND_PRINT(", n_tables %u", GET_U_1(cp));
 521         OF_FWD(1);
 522         /* auxiliary_id */
 523         ND_PRINT(", auxiliary_id %u", GET_U_1(cp));
 524         OF_FWD(1);
 525         /* pad */
 526         OF_FWD(2);
 527         /* capabilities */
 528         ND_PRINT("\n\t capabilities 0x%08x", GET_BE_U_4(cp));
 529         of_bitmap_print(ndo, ofp_capabilities_bm, GET_BE_U_4(cp), OFPCAP_U);
 530         OF_FWD(4);
 531         /* reserved */
 532         ND_TCHECK_4(cp);
 533 }
 534
 535 /* [OF13] Section 7.5.1 */
 536 static void
 537 of13_hello_elements_print(netdissect_options *ndo,
 538                           const u_char *cp, u_int len)
 539 {
 540         while (len) {
 541                 uint16_t type, bmlen;
 542
 543                 if (len < OF_HELLO_ELEM_MINSIZE)
 544                         goto invalid;
 545                 /* type */
 546                 type = GET_BE_U_2(cp);
 547                 OF_FWD(2);
 548                 ND_PRINT("\n\t type %s",
 549                          tok2str(ofphet_str, "unknown (0x%04x)", type));
 550                 /* length */
 551                 bmlen = GET_BE_U_2(cp);
 552                 OF_FWD(2);
 553                 ND_PRINT(", length %u", bmlen);
 554                 /* cp is OF_HELLO_ELEM_MINSIZE bytes in */
 555                 if (bmlen < OF_HELLO_ELEM_MINSIZE ||
 556                     bmlen > OF_HELLO_ELEM_MINSIZE + len)
 557                         goto invalid;
 558                 switch (type) {
 559                 case OFPHET_VERSIONBITMAP:
 560                         /*
 561                          * The specification obviously overprovisions the space
 562                          * for version bitmaps in this element ("ofp versions
 563                          * 32 to 63 are encoded in the second bitmap and so
 564                          * on"). Keep this code simple for now and recognize
 565                          * only a single bitmap with no padding.
 566                          */
 567                         if (bmlen == OF_HELLO_ELEM_MINSIZE + 4) {
 568                                 uint32_t bitmap = GET_BE_U_4(cp);
 569                                 ND_PRINT(", bitmap 0x%08x", bitmap);
 570                                 of_bitmap_print(ndo, ofverbm_str, bitmap,
 571                                                 OF_BIT_VER_U);
 572                         } else {
 573                                 ND_PRINT(" (bogus)");
 574                                 ND_TCHECK_LEN(cp, bmlen - OF_HELLO_ELEM_MINSIZE);
 575                         }
 576                         break;
 577                 default:
 578                         ND_TCHECK_LEN(cp, bmlen - OF_HELLO_ELEM_MINSIZE);
 579                 }
 580                 OF_FWD(bmlen - OF_HELLO_ELEM_MINSIZE);
 581         }
 582         return;
 583
 584 invalid:
 585         nd_print_invalid(ndo);
 586         ND_TCHECK_LEN(cp, len);
 587 }
 588
 589 /* [OF13] Section A.4.4 */
 590 static void
 591 of13_error_print(netdissect_options *ndo,
 592                  const u_char *cp, u_int len)
 593 {
 594         uint16_t type, code;
 595         const struct tok *code_str[OFPET_MAX + 1] = {
 596                 /* [OFPET_HELLO_FAILED         ] = */ ofphfc_str,
 597                 /* [OFPET_BAD_REQUEST          ] = */ ofpbrc_str,
 598                 /* [OFPET_BAD_ACTION           ] = */ ofpbac_str,
 599                 /* [OFPET_BAD_INSTRUCTION      ] = */ ofpbic_str,
 600                 /* [OFPET_BAD_MATCH            ] = */ ofpbmc_str,
 601                 /* [OFPET_FLOW_MOD_FAILED      ] = */ ofpfmfc_str,
 602                 /* [OFPET_GROUP_MOD_FAILED     ] = */ ofpgmfc_str,
 603                 /* [OFPET_PORT_MOD_FAILED      ] = */ ofppmfc_str,
 604                 /* [OFPET_TABLE_MOD_FAILED     ] = */ ofptmfc_str,
 605                 /* [OFPET_QUEUE_OP_FAILED      ] = */ ofpqofc_str,
 606                 /* [OFPET_SWITCH_CONFIG_FAILED ] = */ ofpscfc_str,
 607                 /* [OFPET_ROLE_REQUEST_FAILED  ] = */ ofprrfc_str,
 608                 /* [OFPET_METER_MOD_FAILED     ] = */ ofpmmfc_str,
 609                 /* [OFPET_TABLE_FEATURES_FAILED] = */ ofptffc_str,
 610         };
 611
 612         /* type */
 613         type = GET_BE_U_2(cp);
 614         OF_FWD(2);
 615         ND_PRINT("\n\t type %s", tok2str(ofpet_str, "invalid (0x%04x)", type));
 616         /* code */
 617         code = GET_BE_U_2(cp);
 618         OF_FWD(2);
 619         if (type <= OFPET_MAX && code_str[type] != NULL)
 620                 ND_PRINT(", code %s",
 621                          tok2str(code_str[type], "invalid (0x%04x)", code));
 622         else
 623                 ND_PRINT(", code invalid (0x%04x)", code);
 624         /* data */
 625         of_data_print(ndo, cp, len);
 626 }
 627
 628 void
 629 of13_message_print(netdissect_options *ndo,
 630                    const u_char *cp, uint16_t len, const uint8_t type)
 631 {
 632         /* See the comment at the beginning of of10_message_print(). */
 633         switch (type) {
 634         /* OpenFlow header only. */
 635         case OFPT_FEATURES_REQUEST: /* [OF13] Section A.3.1 */
 636         case OFPT_GET_CONFIG_REQUEST: /* [OF13] Section A.3.2 */
 637         case OFPT_BARRIER_REQUEST: /* [OF13] Section A.3.8 */
 638         case OFPT_BARRIER_REPLY: /* ibid */
 639                 if (len)
 640                         goto invalid;
 641                 return;
 642
 643         /* OpenFlow header and fixed-size message body. */
 644         case OFPT_FEATURES_REPLY:
 645                 if (len != OF_FEATURES_REPLY_FIXLEN - OF_HEADER_FIXLEN)
 646                         goto invalid;
 647                 if (ndo->ndo_vflag < 1)
 648                         break;
 649                 of13_features_reply_print(ndo, cp, len);
 650                 return;
 651         case OFPT_QUEUE_GET_CONFIG_REQUEST: /* [OF13] Section A.3.6 */
 652                 if (len != OF_QUEUE_GET_CONFIG_REQUEST_FIXLEN - OF_HEADER_FIXLEN)
 653                         goto invalid;
 654                 if (ndo->ndo_vflag < 1)
 655                         break;
 656                 /* port */
 657                 ND_PRINT("\n\t port %s",
 658                          tok2str(ofpp_str, "%u", GET_BE_U_4(cp)));
 659                 OF_FWD(4);
 660                 /* pad */
 661                 /* Always the last field, check bounds. */
 662                 ND_TCHECK_4(cp);
 663                 return;
 664
 665         /* OpenFlow header and variable-size data. */
 666         case OFPT_ECHO_REQUEST: /* [OF13] Section A.5.2 */
 667         case OFPT_ECHO_REPLY: /* [OF13] Section A.5.3 */
 668                 if (ndo->ndo_vflag < 1)
 669                         break;
 670                 of_data_print(ndo, cp, len);
 671                 return;
 672
 673         /* OpenFlow header and n * variable-size data units. */
 674         case OFPT_HELLO: /* [OF13] Section A.5.1 */
 675                 if (ndo->ndo_vflag < 1)
 676                         break;
 677                 of13_hello_elements_print(ndo, cp, len);
 678                 return;
 679
 680         /* OpenFlow header, fixed-size message body and variable-size data. */
 681         case OFPT_ERROR:
 682                 if (len < OF_ERROR_MSG_MINLEN - OF_HEADER_FIXLEN)
 683                         goto invalid;
 684                 if (ndo->ndo_vflag < 1)
 685                         break;
 686                 of13_error_print(ndo, cp, len);
 687                 return;
 688         }
 689         /*
 690          * Not a recognised type or did not print the details, fall back to
 691          * a bounds check.
 692          */
 693         ND_TCHECK_LEN(cp, len);
 694         return;
 695
 696 invalid: /* skip the message body */
 697         nd_print_invalid(ndo);
 698         ND_TCHECK_LEN(cp, len);
 699 }