lib/odp-util.h

   1 /*
   2  * Copyright (c) 2009, 2010, 2011 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 ODP_UTIL_H
  18 #define ODP_UTIL_H 1
  19
  20 #include <stdbool.h>
  21 #include <stddef.h>
  22 #include <stdint.h>
  23 #include <string.h>
  24 #include <linux/openvswitch.h>
  25 #include "hash.h"
  26 #include "openflow/openflow.h"
  27 #include "util.h"
  28
  29 struct ds;
  30 struct flow;
  31 struct nlattr;
  32 struct ofpbuf;
  33
  34 #define OVSP_NONE ((uint16_t) -1)
  35
  36 static inline uint16_t
  37 ofp_port_to_odp_port(uint16_t ofp_port)
  38 {
  39     switch (ofp_port) {
  40     case OFPP_LOCAL:
  41         return OVSP_LOCAL;
  42     case OFPP_NONE:
  43         return OVSP_NONE;
  44     default:
  45         return ofp_port;
  46     }
  47 }
  48
  49 static inline uint16_t
  50 odp_port_to_ofp_port(uint16_t odp_port)
  51 {
  52     switch (odp_port) {
  53     case OVSP_LOCAL:
  54         return OFPP_LOCAL;
  55     case OVSP_NONE:
  56         return OFPP_NONE;
  57     default:
  58         return odp_port;
  59     }
  60 }
  61 void format_odp_actions(struct ds *, const struct nlattr *odp_actions,
  62                         size_t actions_len);
  63
  64 /* Upper bound on the length of a nlattr-formatted flow key.  The longest
  65  * nlattr-formatted flow key would be:
  66  *
  67  *                         struct  pad  nl hdr  total
  68  *                         ------  ---  ------  -----
  69  *  OVS_KEY_ATTR_TUN_ID        8    --     4     12
  70  *  OVS_KEY_ATTR_IN_PORT       4    --     4      8
  71  *  OVS_KEY_ATTR_ETHERNET     12    --     4     16
  72  *  OVS_KEY_ATTR_8021Q         4    --     4      8
  73  *  OVS_KEY_ATTR_ETHERTYPE     2     2     4      8
  74  *  OVS_KEY_ATTR_IPV6         34     2     4     40
  75  *  OVS_KEY_ATTR_ICMPV6        2     2     4      8
  76  *  OVS_KEY_ATTR_ND           28    --     4     32
  77  *  -------------------------------------------------
  78  *  total                                       132
  79  */
  80 #define ODPUTIL_FLOW_KEY_BYTES 132
  81
  82 /* This is an imperfect sanity-check that ODPUTIL_FLOW_KEY_BYTES doesn't
  83  * need to be updated, but will at least raise awareness when new OVS
  84  * datapath key types are added. */
  85 BUILD_ASSERT_DECL(__OVS_KEY_ATTR_MAX == 14);
  86
  87 /* A buffer with sufficient size and alignment to hold an nlattr-formatted flow
  88  * key.  An array of "struct nlattr" might not, in theory, be sufficiently
  89  * aligned because it only contains 16-bit types. */
  90 struct odputil_keybuf {
  91     uint32_t keybuf[DIV_ROUND_UP(ODPUTIL_FLOW_KEY_BYTES, 4)];
  92 };
  93
  94 void odp_flow_key_format(const struct nlattr *, size_t, struct ds *);
  95 int odp_flow_key_from_string(const char *s, struct ofpbuf *);
  96
  97 void odp_flow_key_from_flow(struct ofpbuf *, const struct flow *);
  98 int odp_flow_key_to_flow(const struct nlattr *, size_t, struct flow *);
  99
 100 enum user_action_cookie_type {
 101     USER_ACTION_COOKIE_UNSPEC,
 102     USER_ACTION_COOKIE_CONTROLLER,   /* Packet for controller. */
 103     USER_ACTION_COOKIE_SFLOW,        /* Packet for sFlow sampling. */
 104 };
 105
 106 /* user_action_cookie is passed as argument to OVS_ACTION_ATTR_USERSPACE.
 107  * Since is it passed to kernel as u64, its size has to be 8 bytes. */
 108 struct user_action_cookie {
 109     uint8_t   type;                 /* enum user_action_cookie_type. */
 110     uint8_t   n_output;             /* No of output ports. used by sflow. */
 111     ovs_be16  vlan_tci;             /* Used by sFlow */
 112     uint32_t  data;                 /* Data is len for OFPP_CONTROLLER action.
 113                                        For sFlow it is port_ifindex. */
 114 };
 115
 116 BUILD_ASSERT_DECL(sizeof(struct user_action_cookie) == 8);
 117
 118 #endif /* odp-util.h */