lib/odp-util.h

   1 /*
   2  * Copyright (c) 2009, 2010 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
  32 /* The kernel datapaths limits actions to those that fit in a single page of
  33  * memory, so there is no point in allocating more than that.  */
  34 enum { MAX_ODP_ACTIONS = 4096 / sizeof(union odp_action) };
  35
  36 /* odp_actions_add() assumes that MAX_ODP_ACTIONS is a power of 2. */
  37 BUILD_ASSERT_DECL(IS_POW2(MAX_ODP_ACTIONS));
  38
  39 struct odp_actions {
  40     size_t n_actions;
  41     union odp_action actions[MAX_ODP_ACTIONS];
  42 };
  43
  44 static inline void
  45 odp_actions_init(struct odp_actions *actions)
  46 {
  47     actions->n_actions = 0;
  48 }
  49
  50 union odp_action *odp_actions_add(struct odp_actions *actions, uint16_t type);
  51
  52 static inline bool
  53 odp_actions_overflow(const struct odp_actions *actions)
  54 {
  55     return actions->n_actions > MAX_ODP_ACTIONS;
  56 }
  57
  58 static inline uint16_t
  59 ofp_port_to_odp_port(uint16_t ofp_port)
  60 {
  61     switch (ofp_port) {
  62     case OFPP_LOCAL:
  63         return ODPP_LOCAL;
  64     case OFPP_NONE:
  65         return ODPP_NONE;
  66     default:
  67         return ofp_port;
  68     }
  69 }
  70
  71 static inline uint16_t
  72 odp_port_to_ofp_port(uint16_t odp_port)
  73 {
  74     switch (odp_port) {
  75     case ODPP_LOCAL:
  76         return OFPP_LOCAL;
  77     case ODPP_NONE:
  78         return OFPP_NONE;
  79     default:
  80         return odp_port;
  81     }
  82 }
  83
  84 void format_odp_flow_key(struct ds *, const struct odp_flow_key *);
  85 void format_odp_action(struct ds *, const union odp_action *);
  86 void format_odp_actions(struct ds *, const union odp_action *actions,
  87                         size_t n_actions);
  88 void format_odp_flow_stats(struct ds *, const struct odp_flow_stats *);
  89 void format_odp_flow(struct ds *, const struct odp_flow *);
  90
  91 void odp_flow_key_from_flow(struct odp_flow_key *, const struct flow *);
  92 void odp_flow_key_to_flow(const struct odp_flow_key *, struct flow *);
  93
  94 static inline bool
  95 odp_flow_key_equal(const struct odp_flow_key *a, const struct odp_flow_key *b)
  96 {
  97     return !memcmp(a, b, sizeof *a);
  98 }
  99
 100 static inline size_t
 101 odp_flow_key_hash(const struct odp_flow_key *flow, uint32_t basis)
 102 {
 103     BUILD_ASSERT_DECL(!(sizeof *flow % sizeof(uint32_t)));
 104     return hash_words((const uint32_t *) flow,
 105                       sizeof *flow / sizeof(uint32_t), basis);
 106 }
 107
 108 #endif /* odp-util.h */