ofproto/netflow.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2013 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_NETFLOW_H
  18 #define OFPROTO_NETFLOW_H 1
  19
  20 #include <stdint.h>
  21 #include "flow.h"
  22 #include "sset.h"
  23
  24 /* Default active timeout interval, in seconds.
  25  *
  26  * (The active timeout interval is the interval at which NetFlow records are
  27  * sent for flows that do not expire, so that such flows are still
  28  * accounted.) */
  29 #define NF_ACTIVE_TIMEOUT_DEFAULT 600
  30
  31 struct ofexpired;
  32
  33 struct netflow_options {
  34     struct sset collectors;
  35     uint8_t engine_type;
  36     uint8_t engine_id;
  37     int active_timeout;
  38     bool add_id_to_iface;
  39 };
  40
  41 #define NF_OUT_FLOOD OFP_PORT_C(UINT16_MAX)
  42 #define NF_OUT_MULTI OFP_PORT_C(UINT16_MAX - 1)
  43 #define NF_OUT_DROP  OFP_PORT_C(UINT16_MAX - 2)
  44
  45 struct netflow_flow {
  46     long long int last_expired;   /* Time this flow last timed out. */
  47     long long int created;        /* Time flow was created since time out. */
  48
  49     uint64_t packet_count_off;    /* Packet count at last time out. */
  50     uint64_t byte_count_off;      /* Byte count at last time out. */
  51
  52     ofp_port_t output_iface;      /* Output interface index. */
  53     uint8_t tcp_flags;            /* Bitwise-OR of all TCP flags seen. */
  54 };
  55
  56 struct netflow *netflow_create(void);
  57 void netflow_destroy(struct netflow *);
  58 int netflow_set_options(struct netflow *, const struct netflow_options *);
  59 void netflow_expire(struct netflow *, struct netflow_flow *,
  60                     struct ofexpired *);
  61
  62 bool netflow_run(struct netflow *);
  63 void netflow_wait(struct netflow *);
  64
  65 void netflow_mask_wc(struct flow_wildcards *);
  66
  67 void netflow_flow_init(struct netflow_flow *);
  68 void netflow_flow_clear(struct netflow_flow *);
  69 void netflow_flow_update_time(struct netflow *, struct netflow_flow *,
  70                               long long int used);
  71 void netflow_flow_update_flags(struct netflow_flow *, uint8_t tcp_flags);
  72 bool netflow_active_timeout_expired(struct netflow *, struct netflow_flow *);
  73
  74 #endif /* netflow.h */