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
  84     /* NXST_* stat requests. */
  85     OFPUTIL_NXST_FLOW_REQUEST,
  86     OFPUTIL_NXST_AGGREGATE_REQUEST,
  87
  88     /* NXST_* stat replies. */
  89     OFPUTIL_NXST_FLOW_REPLY,
  90     OFPUTIL_NXST_AGGREGATE_REPLY
  91 };
  92
  93 struct ofputil_msg_type;
  94 enum ofperr ofputil_decode_msg_type(const struct ofp_header *,
  95                                     const struct ofputil_msg_type **);
  96 enum ofperr ofputil_decode_msg_type_partial(const struct ofp_header *,
  97                                             size_t length,
  98                                             const struct ofputil_msg_type **);
  99 enum ofputil_msg_code ofputil_msg_type_code(const struct ofputil_msg_type *);
 100 const char *ofputil_msg_type_name(const struct ofputil_msg_type *);
 101
 102 /* Port numbers. */
 103 enum ofperr ofputil_check_output_port(uint16_t ofp_port, int max_ports);
 104 bool ofputil_port_from_string(const char *, uint16_t *port);
 105 void ofputil_format_port(uint16_t port, struct ds *);
 106
 107 /* Converting OFPFW_NW_SRC_MASK and OFPFW_NW_DST_MASK wildcard bit counts to
 108  * and from IP bitmasks. */
 109 ovs_be32 ofputil_wcbits_to_netmask(int wcbits);
 110 int ofputil_netmask_to_wcbits(ovs_be32 netmask);
 111
 112 /* Work with OpenFlow 1.0 ofp_match. */
 113 void ofputil_wildcard_from_openflow(uint32_t ofpfw, struct flow_wildcards *);
 114 void ofputil_cls_rule_from_match(const struct ofp_match *,
 115                                  unsigned int priority, struct cls_rule *);
 116 void ofputil_normalize_rule(struct cls_rule *, enum nx_flow_format);
 117 void ofputil_cls_rule_to_match(const struct cls_rule *, struct ofp_match *);
 118
 119 /* dl_type translation between OpenFlow and 'struct flow' format. */
 120 ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type);
 121 ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type);
 122
 123 /* Flow formats. */
 124 bool ofputil_flow_format_is_valid(enum nx_flow_format);
 125 const char *ofputil_flow_format_to_string(enum nx_flow_format);
 126 int ofputil_flow_format_from_string(const char *);
 127 enum nx_flow_format ofputil_min_flow_format(const struct cls_rule *);
 128
 129 struct ofpbuf *ofputil_make_set_flow_format(enum nx_flow_format);
 130
 131 /* PACKET_IN. */
 132 bool ofputil_packet_in_format_is_valid(enum nx_packet_in_format);
 133 int ofputil_packet_in_format_from_string(const char *);
 134 const char *ofputil_packet_in_format_to_string(enum nx_packet_in_format);
 135 struct ofpbuf *ofputil_make_set_packet_in_format(enum nx_packet_in_format);
 136
 137 /* NXT_FLOW_MOD_TABLE_ID extension. */
 138 struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id);
 139
 140 /* Flow format independent flow_mod. */
 141 struct ofputil_flow_mod {
 142     struct cls_rule cr;
 143     ovs_be64 cookie;
 144     ovs_be64 cookie_mask;
 145     uint8_t table_id;
 146     uint16_t command;
 147     uint16_t idle_timeout;
 148     uint16_t hard_timeout;
 149     uint32_t buffer_id;
 150     uint16_t out_port;
 151     uint16_t flags;
 152     union ofp_action *actions;
 153     size_t n_actions;
 154 };
 155
 156 enum ofperr ofputil_decode_flow_mod(struct ofputil_flow_mod *,
 157                                     const struct ofp_header *,
 158                                     bool flow_mod_table_id);
 159 struct ofpbuf *ofputil_encode_flow_mod(const struct ofputil_flow_mod *,
 160                                        enum nx_flow_format,
 161                                        bool flow_mod_table_id);
 162
 163 /* Flow stats or aggregate stats request, independent of flow format. */
 164 struct ofputil_flow_stats_request {
 165     bool aggregate;             /* Aggregate results? */
 166     struct cls_rule match;
 167     ovs_be64 cookie;
 168     ovs_be64 cookie_mask;
 169     uint16_t out_port;
 170     uint8_t table_id;
 171 };
 172
 173 enum ofperr ofputil_decode_flow_stats_request(
 174     struct ofputil_flow_stats_request *, const struct ofp_header *);
 175 struct ofpbuf *ofputil_encode_flow_stats_request(
 176     const struct ofputil_flow_stats_request *, enum nx_flow_format);
 177
 178 /* Flow stats reply, independent of flow format. */
 179 struct ofputil_flow_stats {
 180     struct cls_rule rule;
 181     ovs_be64 cookie;
 182     uint8_t table_id;
 183     uint32_t duration_sec;
 184     uint32_t duration_nsec;
 185     uint16_t idle_timeout;
 186     uint16_t hard_timeout;
 187     int idle_age;               /* Seconds since last packet, -1 if unknown. */
 188     int hard_age;               /* Seconds since last change, -1 if unknown. */
 189     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
 190     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
 191     union ofp_action *actions;
 192     size_t n_actions;
 193 };
 194
 195 int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
 196                                     struct ofpbuf *msg,
 197                                     bool flow_age_extension);
 198 void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *,
 199                                      struct list *replies);
 200
 201 /* Aggregate stats reply, independent of flow format. */
 202 struct ofputil_aggregate_stats {
 203     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
 204     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
 205     uint32_t flow_count;
 206 };
 207
 208 struct ofpbuf *ofputil_encode_aggregate_stats_reply(
 209     const struct ofputil_aggregate_stats *stats,
 210     const struct ofp_stats_msg *request);
 211
 212 /* Flow removed message, independent of flow format. */
 213 struct ofputil_flow_removed {
 214     struct cls_rule rule;
 215     ovs_be64 cookie;
 216     uint8_t reason;             /* One of OFPRR_*. */
 217     uint32_t duration_sec;
 218     uint32_t duration_nsec;
 219     uint16_t idle_timeout;
 220     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
 221     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
 222 };
 223
 224 enum ofperr ofputil_decode_flow_removed(struct ofputil_flow_removed *,
 225                                         const struct ofp_header *);
 226 struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *,
 227                                            enum nx_flow_format);
 228
 229 /* Abstract packet-in message. */
 230 struct ofputil_packet_in {
 231     const void *packet;
 232     size_t packet_len;
 233
 234     enum ofp_packet_in_reason reason;    /* One of OFPRR_*. */
 235     uint8_t table_id;
 236     ovs_be64 cookie;
 237
 238     uint32_t buffer_id;
 239     int send_len;
 240     uint16_t total_len;         /* Full length of frame. */
 241
 242     struct flow_metadata fmd;   /* Metadata at creation time. */
 243 };
 244
 245 int ofputil_decode_packet_in(struct ofputil_packet_in *,
 246                              const struct ofp_header *);
 247 struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *,
 248                                         enum nx_packet_in_format);
 249 int ofputil_decode_packet_in(struct ofputil_packet_in *pi,
 250                              const struct ofp_header *oh);
 251
 252 /* Abstract packet-out message. */
 253 struct ofputil_packet_out {
 254     const void *packet;         /* Packet data, if buffer_id == UINT32_MAX. */
 255     size_t packet_len;          /* Length of packet data in bytes. */
 256     uint32_t buffer_id;         /* Buffer id or UINT32_MAX if no buffer. */
 257     uint16_t in_port;           /* Packet's input port or OFPP_NONE. */
 258     union ofp_action *actions;  /* Actions. */
 259     size_t n_actions;           /* Number of elements in 'actions' array. */
 260 };
 261
 262 enum ofperr ofputil_decode_packet_out(struct ofputil_packet_out *,
 263                                       const struct ofp_packet_out *);
 264 struct ofpbuf *ofputil_encode_packet_out(const struct ofputil_packet_out *);
 265
 266 /* OpenFlow protocol utility functions. */
 267 void *make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **);
 268 void *make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **);
 269
 270 void *make_openflow_xid(size_t openflow_len, uint8_t type,
 271                         ovs_be32 xid, struct ofpbuf **);
 272 void *make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
 273                      struct ofpbuf **);
 274
 275 void *put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *);
 276 void *put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
 277                        struct ofpbuf *);
 278
 279 void *put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *);
 280 void *put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
 281                     struct ofpbuf *);
 282
 283 void update_openflow_length(struct ofpbuf *);
 284
 285 void *ofputil_make_stats_request(size_t openflow_len, uint16_t type,
 286                                  uint32_t subtype, struct ofpbuf **);
 287 void *ofputil_make_stats_reply(size_t openflow_len,
 288                                const struct ofp_stats_msg *request,
 289                                struct ofpbuf **);
 290
 291 void ofputil_start_stats_reply(const struct ofp_stats_msg *request,
 292                                struct list *);
 293 struct ofpbuf *ofputil_reserve_stats_reply(size_t len, struct list *);
 294 void *ofputil_append_stats_reply(size_t len, struct list *);
 295
 296 const void *ofputil_stats_body(const struct ofp_header *);
 297 size_t ofputil_stats_body_len(const struct ofp_header *);
 298
 299 const void *ofputil_nxstats_body(const struct ofp_header *);
 300 size_t ofputil_nxstats_body_len(const struct ofp_header *);
 301
 302 struct ofpbuf *make_flow_mod(uint16_t command, const struct cls_rule *,
 303                              size_t actions_len);
 304 struct ofpbuf *make_add_flow(const struct cls_rule *, uint32_t buffer_id,
 305                              uint16_t max_idle, size_t actions_len);
 306 struct ofpbuf *make_del_flow(const struct cls_rule *);
 307 struct ofpbuf *make_add_simple_flow(const struct cls_rule *,
 308                                     uint32_t buffer_id, uint16_t out_port,
 309                                     uint16_t max_idle);
 310 struct ofpbuf *make_packet_in(uint32_t buffer_id, uint16_t in_port,
 311                               uint8_t reason,
 312                               const struct ofpbuf *payload, int max_send_len);
 313 struct ofpbuf *make_echo_request(void);
 314 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
 315
 316 struct ofpbuf *ofputil_encode_barrier_request(void);
 317
 318 const char *ofputil_frag_handling_to_string(enum ofp_config_flags);
 319 bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags *);
 320 \f
 321 /* Actions. */
 322
 323 /* The type of an action.
 324  *
 325  * For each implemented OFPAT_* and NXAST_* action type, there is a
 326  * corresponding constant prefixed with OFPUTIL_, e.g.:
 327  *
 328  * OFPUTIL_OFPAT_OUTPUT
 329  * OFPUTIL_OFPAT_SET_VLAN_VID
 330  * OFPUTIL_OFPAT_SET_VLAN_PCP
 331  * OFPUTIL_OFPAT_STRIP_VLAN
 332  * OFPUTIL_OFPAT_SET_DL_SRC
 333  * OFPUTIL_OFPAT_SET_DL_DST
 334  * OFPUTIL_OFPAT_SET_NW_SRC
 335  * OFPUTIL_OFPAT_SET_NW_DST
 336  * OFPUTIL_OFPAT_SET_NW_TOS
 337  * OFPUTIL_OFPAT_SET_TP_SRC
 338  * OFPUTIL_OFPAT_SET_TP_DST
 339  * OFPUTIL_OFPAT_ENQUEUE
 340  * OFPUTIL_NXAST_RESUBMIT
 341  * OFPUTIL_NXAST_SET_TUNNEL
 342  * OFPUTIL_NXAST_SET_QUEUE
 343  * OFPUTIL_NXAST_POP_QUEUE
 344  * OFPUTIL_NXAST_REG_MOVE
 345  * OFPUTIL_NXAST_REG_LOAD
 346  * OFPUTIL_NXAST_NOTE
 347  * OFPUTIL_NXAST_SET_TUNNEL64
 348  * OFPUTIL_NXAST_MULTIPATH
 349  * OFPUTIL_NXAST_AUTOPATH
 350  * OFPUTIL_NXAST_BUNDLE
 351  * OFPUTIL_NXAST_BUNDLE_LOAD
 352  * OFPUTIL_NXAST_RESUBMIT_TABLE
 353  * OFPUTIL_NXAST_OUTPUT_REG
 354  *
 355  * (The above list helps developers who want to "grep" for these definitions.)
 356  */
 357 enum ofputil_action_code {
 358 #define OFPAT_ACTION(ENUM, STRUCT, NAME)             OFPUTIL_##ENUM,
 359 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM,
 360 #include "ofp-util.def"
 361 };
 362
 363 /* The number of values of "enum ofputil_action_code". */
 364 enum {
 365 #define OFPAT_ACTION(ENUM, STRUCT, NAME)             + 1
 366 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
 367     OFPUTIL_N_ACTIONS = 0
 368 #include "ofp-util.def"
 369 };
 370
 371 int ofputil_decode_action(const union ofp_action *);
 372 enum ofputil_action_code ofputil_decode_action_unsafe(
 373     const union ofp_action *);
 374
 375 int ofputil_action_code_from_name(const char *);
 376
 377 void *ofputil_put_action(enum ofputil_action_code, struct ofpbuf *buf);
 378
 379 /* For each OpenFlow action <ENUM> that has a corresponding action structure
 380  * struct <STRUCT>, this defines two functions:
 381  *
 382  *   void ofputil_init_<ENUM>(struct <STRUCT> *action);
 383  *
 384  *     Initializes the parts of 'action' that identify it as having type <ENUM>
 385  *     and length 'sizeof *action' and zeros the rest.  For actions that have
 386  *     variable length, the length used and cleared is that of struct <STRUCT>.
 387  *
 388  *  struct <STRUCT> *ofputil_put_<ENUM>(struct ofpbuf *buf);
 389  *
 390  *     Appends a new 'action', of length 'sizeof(struct <STRUCT>)', to 'buf',
 391  *     initializes it with ofputil_init_<ENUM>(), and returns it.
 392  */
 393 #define OFPAT_ACTION(ENUM, STRUCT, NAME)                \
 394     void ofputil_init_##ENUM(struct STRUCT *);          \
 395     struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
 396 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)    \
 397     void ofputil_init_##ENUM(struct STRUCT *);          \
 398     struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
 399 #include "ofp-util.def"
 400
 401 #define OFP_ACTION_ALIGN 8      /* Alignment of ofp_actions. */
 402
 403 static inline union ofp_action *
 404 ofputil_action_next(const union ofp_action *a)
 405 {
 406     return ((union ofp_action *) (void *)
 407             ((uint8_t *) a + ntohs(a->header.len)));
 408 }
 409
 410 static inline bool
 411 ofputil_action_is_valid(const union ofp_action *a, size_t n_actions)
 412 {
 413     uint16_t len = ntohs(a->header.len);
 414     return (!(len % OFP_ACTION_ALIGN)
 415             && len >= sizeof *a
 416             && len / sizeof *a <= n_actions);
 417 }
 418
 419 /* This macro is careful to check for actions with bad lengths. */
 420 #define OFPUTIL_ACTION_FOR_EACH(ITER, LEFT, ACTIONS, N_ACTIONS)         \
 421     for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS);                      \
 422          (LEFT) > 0 && ofputil_action_is_valid(ITER, LEFT);             \
 423          ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
 424           (ITER) = ofputil_action_next(ITER)))
 425
 426 /* This macro does not check for actions with bad lengths.  It should only be
 427  * used with actions from trusted sources or with actions that have already
 428  * been validated (e.g. with OFPUTIL_ACTION_FOR_EACH).  */
 429 #define OFPUTIL_ACTION_FOR_EACH_UNSAFE(ITER, LEFT, ACTIONS, N_ACTIONS)  \
 430     for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS);                      \
 431          (LEFT) > 0;                                                    \
 432          ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
 433           (ITER) = ofputil_action_next(ITER)))
 434
 435 enum ofperr validate_actions(const union ofp_action *, size_t n_actions,
 436                              const struct flow *, int max_ports);
 437 bool action_outputs_to_port(const union ofp_action *, ovs_be16 port);
 438
 439 enum ofperr ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
 440                                  union ofp_action **, size_t *);
 441
 442 bool ofputil_actions_equal(const union ofp_action *a, size_t n_a,
 443                            const union ofp_action *b, size_t n_b);
 444 union ofp_action *ofputil_actions_clone(const union ofp_action *, size_t n);
 445
 446 /* Handy utility for parsing flows and actions. */
 447 bool ofputil_parse_key_value(char **stringp, char **keyp, char **valuep);
 448
 449 #endif /* ofp-util.h */