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 "hash.h"
  25 #include "openflow/openflow.h"
  26 #include "openvswitch/datapath-protocol.h"
  27 #include "util.h"
  28
  29 struct ds;
  30 struct flow;
  31 struct ofpbuf;
  32
  33 static inline uint16_t
  34 ofp_port_to_odp_port(uint16_t ofp_port)
  35 {
  36     switch (ofp_port) {
  37     case OFPP_LOCAL:
  38         return ODPP_LOCAL;
  39     case OFPP_NONE:
  40         return ODPP_NONE;
  41     default:
  42         return ofp_port;
  43     }
  44 }
  45
  46 static inline uint16_t
  47 odp_port_to_ofp_port(uint16_t odp_port)
  48 {
  49     switch (odp_port) {
  50     case ODPP_LOCAL:
  51         return OFPP_LOCAL;
  52     case ODPP_NONE:
  53         return OFPP_NONE;
  54     default:
  55         return odp_port;
  56     }
  57 }
  58
  59 int odp_action_len(uint16_t type);
  60 void format_odp_action(struct ds *, const struct nlattr *);
  61 void format_odp_actions(struct ds *, const struct nlattr *odp_actions,
  62                         size_t actions_len);
  63 void format_odp_flow_stats(struct ds *, const struct odp_flow_stats *);
  64
  65 /* By my calculations currently the longest valid nlattr-formatted flow key is
  66  * 80 bytes long, so this leaves some safety margin.
  67  *
  68  * We allocate temporary on-stack buffers for flow keys as arrays of uint32_t
  69  * to ensure proper 32-bit alignment for Netlink attributes.  (An array of
  70  * "struct nlattr" might not, in theory, be sufficiently aligned because it
  71  * only contains 16-bit types.) */
  72 #define ODPUTIL_FLOW_KEY_BYTES 96
  73 #define ODPUTIL_FLOW_KEY_U32S DIV_ROUND_UP(ODPUTIL_FLOW_KEY_BYTES, 4)
  74
  75 void odp_flow_key_format(const struct nlattr *, size_t, struct ds *);
  76
  77 void odp_flow_key_from_flow(struct ofpbuf *, const struct flow *);
  78 int odp_flow_key_to_flow(const struct nlattr *, size_t, struct flow *);
  79
  80 #endif /* odp-util.h */