ofproto/ofproto-dpif.h

   1 /* Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
   2  *
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License. */
  14
  15 #ifndef OFPROTO_DPIF_H
  16 #define OFPROTO_DPIF_H 1
  17
  18 #include <stdint.h>
  19
  20 #include "hmapx.h"
  21 #include "ofproto/ofproto-provider.h"
  22 #include "timer.h"
  23 #include "util.h"
  24
  25 union user_action_cookie;
  26 struct ofproto_dpif;
  27 struct ofport_dpif;
  28
  29 struct rule_dpif {
  30     struct rule up;
  31
  32     /* These statistics:
  33      *
  34      *   - Do include packets and bytes from facets that have been deleted or
  35      *     whose own statistics have been folded into the rule.
  36      *
  37      *   - Do include packets and bytes sent "by hand" that were accounted to
  38      *     the rule without any facet being involved (this is a rare corner
  39      *     case in rule_execute()).
  40      *
  41      *   - Do not include packet or bytes that can be obtained from any facet's
  42      *     packet_count or byte_count member or that can be obtained from the
  43      *     datapath by, e.g., dpif_flow_get() for any subfacet.
  44      */
  45     uint64_t packet_count;       /* Number of packets received. */
  46     uint64_t byte_count;         /* Number of bytes received. */
  47 };
  48
  49 static inline struct rule_dpif *rule_dpif_cast(const struct rule *rule)
  50 {
  51     return rule ? CONTAINER_OF(rule, struct rule_dpif, up) : NULL;
  52 }
  53
  54 struct rule_dpif *rule_dpif_lookup_in_table(struct ofproto_dpif *,
  55                                             const struct flow *,
  56                                             struct flow_wildcards *,
  57                                             uint8_t table_id);
  58
  59 struct rule_dpif *rule_dpif_miss_rule(struct ofproto_dpif *ofproto,
  60                                       const struct flow *);
  61
  62 void rule_credit_stats(struct rule_dpif *, const struct dpif_flow_stats *);
  63
  64 size_t put_userspace_action(const struct ofproto_dpif *,
  65                             struct ofpbuf *odp_actions, const struct flow *,
  66                             const union user_action_cookie *,
  67                             const size_t cookie_size);
  68
  69 bool ofproto_has_vlan_splinters(const struct ofproto_dpif *);
  70 ofp_port_t vsp_realdev_to_vlandev(const struct ofproto_dpif *,
  71                                   ofp_port_t realdev_ofp_port,
  72                                   ovs_be16 vlan_tci);
  73
  74 int ofproto_dpif_queue_to_priority(const struct ofproto_dpif *,
  75                                    uint32_t queue_id, uint32_t *priority);
  76
  77 void ofproto_dpif_send_packet_in(struct ofproto_dpif *,
  78                                  struct ofputil_packet_in *pin);
  79 void ofproto_dpif_flow_mod(struct ofproto_dpif *, struct ofputil_flow_mod *);
  80
  81 #endif /* ofproto-dpif.h */