ofproto/netflow.h

   1 /*
   2  * Copyright (c) 2008, 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 NETFLOW_H
  18 #define NETFLOW_H 1
  19
  20 #include <stdint.h>
  21 #include "flow.h"
  22 #include "svec.h"
  23
  24 static const int NF_ACTIVE_TIMEOUT_DEFAULT = 600;
  25
  26 struct ofexpired;
  27
  28 struct netflow_options {
  29     struct svec collectors;
  30     uint8_t engine_type;
  31     uint8_t engine_id;
  32     int active_timeout;
  33     bool add_id_to_iface;
  34 };
  35
  36 enum netflow_output_ports {
  37     NF_OUT_FLOOD = UINT16_MAX,
  38     NF_OUT_MULTI = UINT16_MAX - 1,
  39     NF_OUT_DROP = UINT16_MAX - 2
  40 };
  41
  42 struct netflow_flow {
  43     long long int last_expired;   /* Time this flow last timed out. */
  44     long long int created;        /* Time flow was created since time out. */
  45
  46     uint64_t packet_count_off;    /* Packet count at last time out. */
  47     uint64_t byte_count_off;      /* Byte count at last time out. */
  48
  49     uint16_t output_iface;        /* Output interface index. */
  50     uint8_t ip_tos;               /* Last-seen IP type-of-service. */
  51     uint8_t tcp_flags;            /* Bitwise-OR of all TCP flags seen. */
  52 };
  53
  54 struct netflow *netflow_create(void);
  55 void netflow_destroy(struct netflow *);
  56 int netflow_set_options(struct netflow *, const struct netflow_options *);
  57 void netflow_expire(struct netflow *, struct netflow_flow *,
  58                     struct ofexpired *);
  59 void netflow_run(struct netflow *);
  60
  61 void netflow_flow_clear(struct netflow_flow *);
  62 void netflow_flow_update_time(struct netflow *, struct netflow_flow *,
  63                               long long int used);
  64 void netflow_flow_update_flags(struct netflow_flow *, uint8_t ip_tos,
  65                                uint8_t tcp_flags);
  66 bool netflow_active_timeout_expired(struct netflow *, struct netflow_flow *);
  67
  68 #endif /* netflow.h */