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 "openflow/openflow.h"
  24 #include "openvswitch/datapath-protocol.h"
  25 #include "util.h"
  26
  27 struct ds;
  28
  29 /* The kernel datapaths limits actions to those that fit in a single page of
  30  * memory, so there is no point in allocating more than that.  */
  31 enum { MAX_ODP_ACTIONS = 4096 / sizeof(union odp_action) };
  32
  33 /* odp_actions_add() assumes that MAX_ODP_ACTIONS is a power of 2. */
  34 BUILD_ASSERT_DECL(IS_POW2(MAX_ODP_ACTIONS));
  35
  36 struct odp_actions {
  37     size_t n_actions;
  38     union odp_action actions[MAX_ODP_ACTIONS];
  39 };
  40
  41 static inline void
  42 odp_actions_init(struct odp_actions *actions)
  43 {
  44     actions->n_actions = 0;
  45 }
  46
  47 union odp_action *odp_actions_add(struct odp_actions *actions, uint16_t type);
  48
  49 static inline bool
  50 odp_actions_overflow(const struct odp_actions *actions)
  51 {
  52     return actions->n_actions > MAX_ODP_ACTIONS;
  53 }
  54
  55 static inline uint16_t
  56 ofp_port_to_odp_port(uint16_t ofp_port)
  57 {
  58     switch (ofp_port) {
  59     case OFPP_LOCAL:
  60         return ODPP_LOCAL;
  61     case OFPP_NONE:
  62         return ODPP_NONE;
  63     default:
  64         return ofp_port;
  65     }
  66 }
  67
  68 static inline uint16_t
  69 odp_port_to_ofp_port(uint16_t odp_port)
  70 {
  71     switch (odp_port) {
  72     case ODPP_LOCAL:
  73         return OFPP_LOCAL;
  74     case ODPP_NONE:
  75         return OFPP_NONE;
  76     default:
  77         return odp_port;
  78     }
  79 }
  80
  81 void format_odp_action(struct ds *, const union odp_action *);
  82 void format_odp_actions(struct ds *, const union odp_action *actions,
  83                         size_t n_actions);
  84 void format_odp_flow_stats(struct ds *, const struct odp_flow_stats *);
  85 void format_odp_flow(struct ds *, const struct odp_flow *);
  86
  87 #endif /* odp-util.h */