ofproto/ofproto-dpif-ipfix.h

   1 /*
   2  * Copyright (c) 2012 Nicira, Inc.
   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 OFPROTO_DPIF_IPFIX_H
  18 #define OFPROTO_DPIF_IPFIX_H 1
  19
  20 #include <stddef.h>
  21 #include <stdint.h>
  22 #include <stdbool.h>
  23 #include "lib/odp-util.h"
  24
  25 struct flow;
  26 struct dp_packet;
  27 struct ofproto_ipfix_bridge_exporter_options;
  28 struct ofproto_ipfix_flow_exporter_options;
  29 struct flow_tnl;
  30 struct ofport;
  31
  32 struct dpif_ipfix_actions {
  33     bool output_action;     /* Set to true if packet has at least one
  34                                OVS_ACTION_ATTR_OUTPUT action. */
  35 };
  36
  37 struct dpif_ipfix *dpif_ipfix_create(void);
  38 struct dpif_ipfix *dpif_ipfix_ref(const struct dpif_ipfix *);
  39 void dpif_ipfix_unref(struct dpif_ipfix *);
  40
  41 void dpif_ipfix_add_port(struct dpif_ipfix *, struct ofport *, odp_port_t);
  42 void dpif_ipfix_del_port(struct dpif_ipfix *, odp_port_t);
  43
  44 uint32_t dpif_ipfix_get_bridge_exporter_probability(const struct dpif_ipfix *);
  45 bool dpif_ipfix_get_bridge_exporter_tunnel_sampling(const struct dpif_ipfix *);
  46 bool dpif_ipfix_get_bridge_exporter_input_sampling(const struct dpif_ipfix *);
  47 bool dpif_ipfix_get_bridge_exporter_output_sampling(const struct dpif_ipfix *);
  48 bool dpif_ipfix_get_flow_exporter_tunnel_sampling(const struct dpif_ipfix *,
  49                                                   const uint32_t);
  50 bool dpif_ipfix_is_tunnel_port(const struct dpif_ipfix *, odp_port_t);
  51 void dpif_ipfix_set_options(
  52     struct dpif_ipfix *,
  53     const struct ofproto_ipfix_bridge_exporter_options *,
  54     const struct ofproto_ipfix_flow_exporter_options *, size_t);
  55
  56 int dpif_ipfix_get_stats(const struct dpif_ipfix *, bool, struct ovs_list *);
  57
  58 void dpif_ipfix_bridge_sample(struct dpif_ipfix *, const struct dp_packet *,
  59                               const struct flow *,
  60                               odp_port_t, odp_port_t, const struct flow_tnl *,
  61                               const struct dpif_ipfix_actions *);
  62 void dpif_ipfix_flow_sample(struct dpif_ipfix *, const struct dp_packet *,
  63                             const struct flow *,
  64                             const struct user_action_cookie *,
  65                             odp_port_t, const struct flow_tnl *,
  66                             const struct dpif_ipfix_actions *);
  67
  68 void dpif_ipfix_run(struct dpif_ipfix *);
  69 void dpif_ipfix_wait(struct dpif_ipfix *);
  70
  71 void dpif_ipfix_read_actions(const struct flow *flow,
  72                              const struct nlattr *actions,
  73                              size_t actions_len,
  74                              struct dpif_ipfix_actions *ipfix_actions);
  75
  76 #endif /* ofproto/ofproto-dpif-ipfix.h */