lib/ofp-util.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira Networks.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef OFP_UTIL_H
  18 #define OFP_UTIL_H 1
  19
  20 #include <assert.h>
  21 #include <stdbool.h>
  22 #include <stddef.h>
  23 #include <stdint.h>
  24 #include "classifier.h"
  25 #include "flow.h"
  26 #include "openflow/nicira-ext.h"
  27 #include "openvswitch/types.h"
  28
  29 struct cls_rule;
  30 struct ofpbuf;
  31
  32 /* Basic decoding and length validation of OpenFlow messages. */
  33 enum ofputil_msg_code {
  34     OFPUTIL_MSG_INVALID,
  35
  36     /* OFPT_* messages. */
  37     OFPUTIL_OFPT_HELLO,
  38     OFPUTIL_OFPT_ERROR,
  39     OFPUTIL_OFPT_ECHO_REQUEST,
  40     OFPUTIL_OFPT_ECHO_REPLY,
  41     OFPUTIL_OFPT_FEATURES_REQUEST,
  42     OFPUTIL_OFPT_FEATURES_REPLY,
  43     OFPUTIL_OFPT_GET_CONFIG_REQUEST,
  44     OFPUTIL_OFPT_GET_CONFIG_REPLY,
  45     OFPUTIL_OFPT_SET_CONFIG,
  46     OFPUTIL_OFPT_PACKET_IN,
  47     OFPUTIL_OFPT_FLOW_REMOVED,
  48     OFPUTIL_OFPT_PORT_STATUS,
  49     OFPUTIL_OFPT_PACKET_OUT,
  50     OFPUTIL_OFPT_FLOW_MOD,
  51     OFPUTIL_OFPT_PORT_MOD,
  52     OFPUTIL_OFPT_BARRIER_REQUEST,
  53     OFPUTIL_OFPT_BARRIER_REPLY,
  54     OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST,
  55     OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY,
  56
  57     /* OFPST_* stat requests. */
  58     OFPUTIL_OFPST_DESC_REQUEST,
  59     OFPUTIL_OFPST_FLOW_REQUEST,
  60     OFPUTIL_OFPST_AGGREGATE_REQUEST,
  61     OFPUTIL_OFPST_TABLE_REQUEST,
  62     OFPUTIL_OFPST_PORT_REQUEST,
  63     OFPUTIL_OFPST_QUEUE_REQUEST,
  64
  65     /* OFPST_* stat replies. */
  66     OFPUTIL_OFPST_DESC_REPLY,
  67     OFPUTIL_OFPST_FLOW_REPLY,
  68     OFPUTIL_OFPST_QUEUE_REPLY,
  69     OFPUTIL_OFPST_PORT_REPLY,
  70     OFPUTIL_OFPST_TABLE_REPLY,
  71     OFPUTIL_OFPST_AGGREGATE_REPLY,
  72
  73     /* NXT_* messages. */
  74     OFPUTIL_NXT_ROLE_REQUEST,
  75     OFPUTIL_NXT_ROLE_REPLY,
  76     OFPUTIL_NXT_SET_FLOW_FORMAT,
  77     OFPUTIL_NXT_FLOW_MOD_TABLE_ID,
  78     OFPUTIL_NXT_FLOW_MOD,
  79     OFPUTIL_NXT_FLOW_REMOVED,
  80     OFPUTIL_NXT_SET_PACKET_IN_FORMAT,
  81     OFPUTIL_NXT_PACKET_IN,
  82     OFPUTIL_NXT_FLOW_AGE,
  83     OFPUTIL_NXT_SET_ASYNC_CONFIG,
  84     OFPUTIL_NXT_SET_CONTROLLER_ID,
  85
  86     /* NXST_* stat requests. */
  87     OFPUTIL_NXST_FLOW_REQUEST,
  88     OFPUTIL_NXST_AGGREGATE_REQUEST,
  89
  90     /* NXST_* stat replies. */
  91     OFPUTIL_NXST_FLOW_REPLY,
  92     OFPUTIL_NXST_AGGREGATE_REPLY
  93 };
  94
  95 struct ofputil_msg_type;
  96 enum ofperr ofputil_decode_msg_type(const struct ofp_header *,
  97                                     const struct ofputil_msg_type **);
  98 enum ofperr ofputil_decode_msg_type_partial(const struct ofp_header *,
  99                                             size_t length,
 100                                             const struct ofputil_msg_type **);
 101 enum ofputil_msg_code ofputil_msg_type_code(const struct ofputil_msg_type *);
 102 const char *ofputil_msg_type_name(const struct ofputil_msg_type *);
 103
 104 /* Port numbers. */
 105 enum ofperr ofputil_check_output_port(uint16_t ofp_port, int max_ports);
 106 bool ofputil_port_from_string(const char *, uint16_t *port);
 107 void ofputil_format_port(uint16_t port, struct ds *);
 108
 109 /* Converting OFPFW_NW_SRC_MASK and OFPFW_NW_DST_MASK wildcard bit counts to
 110  * and from IP bitmasks. */
 111 ovs_be32 ofputil_wcbits_to_netmask(int wcbits);
 112 int ofputil_netmask_to_wcbits(ovs_be32 netmask);
 113
 114 /* Work with OpenFlow 1.0 ofp_match. */
 115 void ofputil_wildcard_from_openflow(uint32_t ofpfw, struct flow_wildcards *);
 116 void ofputil_cls_rule_from_match(const struct ofp_match *,
 117                                  unsigned int priority, struct cls_rule *);
 118 void ofputil_normalize_rule(struct cls_rule *, enum nx_flow_format);
 119 void ofputil_cls_rule_to_match(const struct cls_rule *, struct ofp_match *);
 120
 121 /* dl_type translation between OpenFlow and 'struct flow' format. */
 122 ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type);
 123 ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type);
 124
 125 /* Flow formats. */
 126 bool ofputil_flow_format_is_valid(enum nx_flow_format);
 127 const char *ofputil_flow_format_to_string(enum nx_flow_format);
 128 int ofputil_flow_format_from_string(const char *);
 129 enum nx_flow_format ofputil_min_flow_format(const struct cls_rule *);
 130
 131 struct ofpbuf *ofputil_make_set_flow_format(enum nx_flow_format);
 132
 133 /* PACKET_IN. */
 134 bool ofputil_packet_in_format_is_valid(enum nx_packet_in_format);
 135 int ofputil_packet_in_format_from_string(const char *);
 136 const char *ofputil_packet_in_format_to_string(enum nx_packet_in_format);
 137 struct ofpbuf *ofputil_make_set_packet_in_format(enum nx_packet_in_format);
 138
 139 /* NXT_FLOW_MOD_TABLE_ID extension. */
 140 struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id);
 141
 142 /* Flow format independent flow_mod. */
 143 struct ofputil_flow_mod {
 144     struct cls_rule cr;
 145     ovs_be64 cookie;
 146     ovs_be64 cookie_mask;
 147     uint8_t table_id;
 148     uint16_t command;
 149     uint16_t idle_timeout;
 150     uint16_t hard_timeout;
 151     uint32_t buffer_id;
 152     uint16_t out_port;
 153     uint16_t flags;
 154     union ofp_action *actions;
 155     size_t n_actions;
 156 };
 157
 158 enum ofperr ofputil_decode_flow_mod(struct ofputil_flow_mod *,
 159                                     const struct ofp_header *,
 160                                     bool flow_mod_table_id);
 161 struct ofpbuf *ofputil_encode_flow_mod(const struct ofputil_flow_mod *,
 162                                        enum nx_flow_format,
 163                                        bool flow_mod_table_id);
 164
 165 /* Flow stats or aggregate stats request, independent of flow format. */
 166 struct ofputil_flow_stats_request {
 167     bool aggregate;             /* Aggregate results? */
 168     struct cls_rule match;
 169     ovs_be64 cookie;
 170     ovs_be64 cookie_mask;
 171     uint16_t out_port;
 172     uint8_t table_id;
 173 };
 174
 175 enum ofperr ofputil_decode_flow_stats_request(
 176     struct ofputil_flow_stats_request *, const struct ofp_header *);
 177 struct ofpbuf *ofputil_encode_flow_stats_request(
 178     const struct ofputil_flow_stats_request *, enum nx_flow_format);
 179
 180 /* Flow stats reply, independent of flow format. */
 181 struct ofputil_flow_stats {
 182     struct cls_rule rule;
 183     ovs_be64 cookie;
 184     uint8_t table_id;
 185     uint32_t duration_sec;
 186     uint32_t duration_nsec;
 187     uint16_t idle_timeout;
 188     uint16_t hard_timeout;
 189     int idle_age;               /* Seconds since last packet, -1 if unknown. */
 190     int hard_age;               /* Seconds since last change, -1 if unknown. */
 191     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
 192     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
 193     union ofp_action *actions;
 194     size_t n_actions;
 195 };
 196
 197 int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
 198                                     struct ofpbuf *msg,
 199                                     bool flow_age_extension);
 200 void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *,
 201                                      struct list *replies);
 202
 203 /* Aggregate stats reply, independent of flow format. */
 204 struct ofputil_aggregate_stats {
 205     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
 206     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
 207     uint32_t flow_count;
 208 };
 209
 210 struct ofpbuf *ofputil_encode_aggregate_stats_reply(
 211     const struct ofputil_aggregate_stats *stats,
 212     const struct ofp_stats_msg *request);
 213
 214 /* Flow removed message, independent of flow format. */
 215 struct ofputil_flow_removed {
 216     struct cls_rule rule;
 217     ovs_be64 cookie;
 218     uint8_t reason;             /* One of OFPRR_*. */
 219     uint32_t duration_sec;
 220     uint32_t duration_nsec;
 221     uint16_t idle_timeout;
 222     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
 223     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
 224 };
 225
 226 enum ofperr ofputil_decode_flow_removed(struct ofputil_flow_removed *,
 227                                         const struct ofp_header *);
 228 struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *,
 229                                            enum nx_flow_format);
 230
 231 /* Abstract packet-in message. */
 232 struct ofputil_packet_in {
 233     const void *packet;
 234     size_t packet_len;
 235
 236     enum ofp_packet_in_reason reason;    /* One of OFPRR_*. */
 237     uint16_t controller_id;              /* Controller ID to send to. */
 238     uint8_t table_id;
 239     ovs_be64 cookie;
 240
 241     uint32_t buffer_id;
 242     int send_len;
 243     uint16_t total_len;         /* Full length of frame. */
 244
 245     struct flow_metadata fmd;   /* Metadata at creation time. */
 246 };
 247
 248 int ofputil_decode_packet_in(struct ofputil_packet_in *,
 249                              const struct ofp_header *);
 250 struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *,
 251                                         enum nx_packet_in_format);
 252
 253 const char *ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason);
 254 bool ofputil_packet_in_reason_from_string(const char *,
 255                                           enum ofp_packet_in_reason *);
 256
 257 /* Abstract packet-out message. */
 258 struct ofputil_packet_out {
 259     const void *packet;         /* Packet data, if buffer_id == UINT32_MAX. */
 260     size_t packet_len;          /* Length of packet data in bytes. */
 261     uint32_t buffer_id;         /* Buffer id or UINT32_MAX if no buffer. */
 262     uint16_t in_port;           /* Packet's input port or OFPP_NONE. */
 263     union ofp_action *actions;  /* Actions. */
 264     size_t n_actions;           /* Number of elements in 'actions' array. */
 265 };
 266
 267 enum ofperr ofputil_decode_packet_out(struct ofputil_packet_out *,
 268                                       const struct ofp_packet_out *);
 269 struct ofpbuf *ofputil_encode_packet_out(const struct ofputil_packet_out *);
 270
 271 /* OpenFlow protocol utility functions. */
 272 void *make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **);
 273 void *make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **);
 274
 275 void *make_openflow_xid(size_t openflow_len, uint8_t type,
 276                         ovs_be32 xid, struct ofpbuf **);
 277 void *make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
 278                      struct ofpbuf **);
 279
 280 void *put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *);
 281 void *put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
 282                        struct ofpbuf *);
 283
 284 void *put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *);
 285 void *put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
 286                     struct ofpbuf *);
 287
 288 void update_openflow_length(struct ofpbuf *);
 289
 290 void *ofputil_make_stats_request(size_t openflow_len, uint16_t type,
 291                                  uint32_t subtype, struct ofpbuf **);
 292 void *ofputil_make_stats_reply(size_t openflow_len,
 293                                const struct ofp_stats_msg *request,
 294                                struct ofpbuf **);
 295
 296 void ofputil_start_stats_reply(const struct ofp_stats_msg *request,
 297                                struct list *);
 298 struct ofpbuf *ofputil_reserve_stats_reply(size_t len, struct list *);
 299 void *ofputil_append_stats_reply(size_t len, struct list *);
 300
 301 const void *ofputil_stats_body(const struct ofp_header *);
 302 size_t ofputil_stats_body_len(const struct ofp_header *);
 303
 304 const void *ofputil_nxstats_body(const struct ofp_header *);
 305 size_t ofputil_nxstats_body_len(const struct ofp_header *);
 306
 307 struct ofpbuf *make_flow_mod(uint16_t command, const struct cls_rule *,
 308                              size_t actions_len);
 309 struct ofpbuf *make_add_flow(const struct cls_rule *, uint32_t buffer_id,
 310                              uint16_t max_idle, size_t actions_len);
 311 struct ofpbuf *make_del_flow(const struct cls_rule *);
 312 struct ofpbuf *make_add_simple_flow(const struct cls_rule *,
 313                                     uint32_t buffer_id, uint16_t out_port,
 314                                     uint16_t max_idle);
 315 struct ofpbuf *make_packet_in(uint32_t buffer_id, uint16_t in_port,
 316                               uint8_t reason,
 317                               const struct ofpbuf *payload, int max_send_len);
 318 struct ofpbuf *make_echo_request(void);
 319 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
 320
 321 struct ofpbuf *ofputil_encode_barrier_request(void);
 322
 323 const char *ofputil_frag_handling_to_string(enum ofp_config_flags);
 324 bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags *);
 325 \f
 326 /* Actions. */
 327
 328 /* The type of an action.
 329  *
 330  * For each implemented OFPAT_* and NXAST_* action type, there is a
 331  * corresponding constant prefixed with OFPUTIL_, e.g.:
 332  *
 333  * OFPUTIL_OFPAT_OUTPUT
 334  * OFPUTIL_OFPAT_SET_VLAN_VID
 335  * OFPUTIL_OFPAT_SET_VLAN_PCP
 336  * OFPUTIL_OFPAT_STRIP_VLAN
 337  * OFPUTIL_OFPAT_SET_DL_SRC
 338  * OFPUTIL_OFPAT_SET_DL_DST
 339  * OFPUTIL_OFPAT_SET_NW_SRC
 340  * OFPUTIL_OFPAT_SET_NW_DST
 341  * OFPUTIL_OFPAT_SET_NW_TOS
 342  * OFPUTIL_OFPAT_SET_TP_SRC
 343  * OFPUTIL_OFPAT_SET_TP_DST
 344  * OFPUTIL_OFPAT_ENQUEUE
 345  * OFPUTIL_NXAST_RESUBMIT
 346  * OFPUTIL_NXAST_SET_TUNNEL
 347  * OFPUTIL_NXAST_SET_QUEUE
 348  * OFPUTIL_NXAST_POP_QUEUE
 349  * OFPUTIL_NXAST_REG_MOVE
 350  * OFPUTIL_NXAST_REG_LOAD
 351  * OFPUTIL_NXAST_NOTE
 352  * OFPUTIL_NXAST_SET_TUNNEL64
 353  * OFPUTIL_NXAST_MULTIPATH
 354  * OFPUTIL_NXAST_AUTOPATH
 355  * OFPUTIL_NXAST_BUNDLE
 356  * OFPUTIL_NXAST_BUNDLE_LOAD
 357  * OFPUTIL_NXAST_RESUBMIT_TABLE
 358  * OFPUTIL_NXAST_OUTPUT_REG
 359  * OFPUTIL_NXAST_LEARN
 360  * OFPUTIL_NXAST_DEC_TTL
 361  * OFPUTIL_NXAST_FIN_TIMEOUT
 362  *
 363  * (The above list helps developers who want to "grep" for these definitions.)
 364  */
 365 enum ofputil_action_code {
 366 #define OFPAT_ACTION(ENUM, STRUCT, NAME)             OFPUTIL_##ENUM,
 367 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM,
 368 #include "ofp-util.def"
 369 };
 370
 371 /* The number of values of "enum ofputil_action_code". */
 372 enum {
 373 #define OFPAT_ACTION(ENUM, STRUCT, NAME)             + 1
 374 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
 375     OFPUTIL_N_ACTIONS = 0
 376 #include "ofp-util.def"
 377 };
 378
 379 int ofputil_decode_action(const union ofp_action *);
 380 enum ofputil_action_code ofputil_decode_action_unsafe(
 381     const union ofp_action *);
 382
 383 int ofputil_action_code_from_name(const char *);
 384
 385 void *ofputil_put_action(enum ofputil_action_code, struct ofpbuf *buf);
 386
 387 /* For each OpenFlow action <ENUM> that has a corresponding action structure
 388  * struct <STRUCT>, this defines two functions:
 389  *
 390  *   void ofputil_init_<ENUM>(struct <STRUCT> *action);
 391  *
 392  *     Initializes the parts of 'action' that identify it as having type <ENUM>
 393  *     and length 'sizeof *action' and zeros the rest.  For actions that have
 394  *     variable length, the length used and cleared is that of struct <STRUCT>.
 395  *
 396  *  struct <STRUCT> *ofputil_put_<ENUM>(struct ofpbuf *buf);
 397  *
 398  *     Appends a new 'action', of length 'sizeof(struct <STRUCT>)', to 'buf',
 399  *     initializes it with ofputil_init_<ENUM>(), and returns it.
 400  */
 401 #define OFPAT_ACTION(ENUM, STRUCT, NAME)                \
 402     void ofputil_init_##ENUM(struct STRUCT *);          \
 403     struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
 404 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)    \
 405     void ofputil_init_##ENUM(struct STRUCT *);          \
 406     struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
 407 #include "ofp-util.def"
 408
 409 #define OFP_ACTION_ALIGN 8      /* Alignment of ofp_actions. */
 410
 411 static inline union ofp_action *
 412 ofputil_action_next(const union ofp_action *a)
 413 {
 414     return ((union ofp_action *) (void *)
 415             ((uint8_t *) a + ntohs(a->header.len)));
 416 }
 417
 418 static inline bool
 419 ofputil_action_is_valid(const union ofp_action *a, size_t n_actions)
 420 {
 421     uint16_t len = ntohs(a->header.len);
 422     return (!(len % OFP_ACTION_ALIGN)
 423             && len >= sizeof *a
 424             && len / sizeof *a <= n_actions);
 425 }
 426
 427 /* This macro is careful to check for actions with bad lengths. */
 428 #define OFPUTIL_ACTION_FOR_EACH(ITER, LEFT, ACTIONS, N_ACTIONS)         \
 429     for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS);                      \
 430          (LEFT) > 0 && ofputil_action_is_valid(ITER, LEFT);             \
 431          ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
 432           (ITER) = ofputil_action_next(ITER)))
 433
 434 /* This macro does not check for actions with bad lengths.  It should only be
 435  * used with actions from trusted sources or with actions that have already
 436  * been validated (e.g. with OFPUTIL_ACTION_FOR_EACH).  */
 437 #define OFPUTIL_ACTION_FOR_EACH_UNSAFE(ITER, LEFT, ACTIONS, N_ACTIONS)  \
 438     for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS);                      \
 439          (LEFT) > 0;                                                    \
 440          ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
 441           (ITER) = ofputil_action_next(ITER)))
 442
 443 enum ofperr validate_actions(const union ofp_action *, size_t n_actions,
 444                              const struct flow *, int max_ports);
 445 bool action_outputs_to_port(const union ofp_action *, ovs_be16 port);
 446
 447 enum ofperr ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
 448                                  union ofp_action **, size_t *);
 449
 450 bool ofputil_actions_equal(const union ofp_action *a, size_t n_a,
 451                            const union ofp_action *b, size_t n_b);
 452 union ofp_action *ofputil_actions_clone(const union ofp_action *, size_t n);
 453
 454 /* Handy utility for parsing flows and actions. */
 455 bool ofputil_parse_key_value(char **stringp, char **keyp, char **valuep);
 456
 457 #endif /* ofp-util.h */