ofproto/netflow.c

   1 /*
   2  * Copyright (c) 2008, 2009 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 #include <config.h>
  18 #include "netflow.h"
  19 #include <arpa/inet.h>
  20 #include <errno.h>
  21 #include <stdlib.h>
  22 #include <unistd.h>
  23 #include "collectors.h"
  24 #include "flow.h"
  25 #include "netflow.h"
  26 #include "ofpbuf.h"
  27 #include "ofproto.h"
  28 #include "packets.h"
  29 #include "socket-util.h"
  30 #include "svec.h"
  31 #include "timeval.h"
  32 #include "util.h"
  33 #include "xtoxll.h"
  34
  35 #define THIS_MODULE VLM_netflow
  36 #include "vlog.h"
  37
  38 #define NETFLOW_V5_VERSION 5
  39
  40 static const int ACTIVE_TIMEOUT_DEFAULT = 600;
  41
  42 /* Every NetFlow v5 message contains the header that follows.  This is
  43  * followed by up to thirty records that describe a terminating flow.
  44  * We only send a single record per NetFlow message.
  45  */
  46 struct netflow_v5_header {
  47     uint16_t version;              /* NetFlow version is 5. */
  48     uint16_t count;                /* Number of records in this message. */
  49     uint32_t sysuptime;            /* System uptime in milliseconds. */
  50     uint32_t unix_secs;            /* Number of seconds since Unix epoch. */
  51     uint32_t unix_nsecs;           /* Number of residual nanoseconds
  52                                       after epoch seconds. */
  53     uint32_t flow_seq;             /* Number of flows since sending
  54                                       messages began. */
  55     uint8_t  engine_type;          /* Engine type. */
  56     uint8_t  engine_id;            /* Engine id. */
  57     uint16_t sampling_interval;    /* Set to zero. */
  58 };
  59 BUILD_ASSERT_DECL(sizeof(struct netflow_v5_header) == 24);
  60
  61 /* A NetFlow v5 description of a terminating flow.  It is preceded by a
  62  * NetFlow v5 header.
  63  */
  64 struct netflow_v5_record {
  65     uint32_t src_addr;             /* Source IP address. */
  66     uint32_t dst_addr;             /* Destination IP address. */
  67     uint32_t nexthop;              /* IP address of next hop.  Set to 0. */
  68     uint16_t input;                /* Input interface index. */
  69     uint16_t output;               /* Output interface index. */
  70     uint32_t packet_count;         /* Number of packets. */
  71     uint32_t byte_count;           /* Number of bytes. */
  72     uint32_t init_time;            /* Value of sysuptime on first packet. */
  73     uint32_t used_time;            /* Value of sysuptime on last packet. */
  74
  75     /* The 'src_port' and 'dst_port' identify the source and destination
  76      * port, respectively, for TCP and UDP.  For ICMP, the high-order
  77      * byte identifies the type and low-order byte identifies the code
  78      * in the 'dst_port' field. */
  79     uint16_t src_port;
  80     uint16_t dst_port;
  81
  82     uint8_t  pad1;
  83     uint8_t  tcp_flags;            /* Union of seen TCP flags. */
  84     uint8_t  ip_proto;             /* IP protocol. */
  85     uint8_t  ip_tos;               /* IP TOS value. */
  86     uint16_t src_as;               /* Source AS ID.  Set to 0. */
  87     uint16_t dst_as;               /* Destination AS ID.  Set to 0. */
  88     uint8_t  src_mask;             /* Source mask bits.  Set to 0. */
  89     uint8_t  dst_mask;             /* Destination mask bits.  Set to 0. */
  90     uint8_t  pad[2];
  91 };
  92 BUILD_ASSERT_DECL(sizeof(struct netflow_v5_record) == 48);
  93
  94 struct netflow {
  95     uint8_t engine_type;          /* Value of engine_type to use. */
  96     uint8_t engine_id;            /* Value of engine_id to use. */
  97     long long int boot_time;      /* Time when netflow_create() was called. */
  98     struct collectors *collectors; /* NetFlow collectors. */
  99     bool add_id_to_iface;         /* Put the 7 least signficiant bits of
 100                                    * 'engine_id' into the most signficant
 101                                    * bits of the interface fields. */
 102     uint32_t netflow_cnt;         /* Flow sequence number for NetFlow. */
 103     struct ofpbuf packet;         /* NetFlow packet being accumulated. */
 104     long long int active_timeout; /* Timeout for flows that are still active. */
 105     long long int reconfig_time;  /* When we reconfigured the timeouts. */
 106 };
 107
 108 void
 109 netflow_expire(struct netflow *nf, struct netflow_flow *nf_flow,
 110                struct ofexpired *expired)
 111 {
 112     struct netflow_v5_header *nf_hdr;
 113     struct netflow_v5_record *nf_rec;
 114     struct timeval now;
 115
 116     nf_flow->last_expired += nf->active_timeout;
 117
 118     /* NetFlow only reports on IP packets and we should only report flows
 119      * that actually have traffic. */
 120     if (expired->flow.dl_type != htons(ETH_TYPE_IP) ||
 121         expired->packet_count - nf_flow->packet_count_off == 0) {
 122         return;
 123     }
 124
 125     time_timeval(&now);
 126
 127     if (!nf->packet.size) {
 128         nf_hdr = ofpbuf_put_zeros(&nf->packet, sizeof *nf_hdr);
 129         nf_hdr->version = htons(NETFLOW_V5_VERSION);
 130         nf_hdr->count = htons(0);
 131         nf_hdr->sysuptime = htonl(time_msec() - nf->boot_time);
 132         nf_hdr->unix_secs = htonl(now.tv_sec);
 133         nf_hdr->unix_nsecs = htonl(now.tv_usec * 1000);
 134         nf_hdr->flow_seq = htonl(nf->netflow_cnt++);
 135         nf_hdr->engine_type = nf->engine_type;
 136         nf_hdr->engine_id = nf->engine_id;
 137         nf_hdr->sampling_interval = htons(0);
 138     }
 139
 140     nf_hdr = nf->packet.data;
 141     nf_hdr->count = htons(ntohs(nf_hdr->count) + 1);
 142
 143     nf_rec = ofpbuf_put_zeros(&nf->packet, sizeof *nf_rec);
 144     nf_rec->src_addr = expired->flow.nw_src;
 145     nf_rec->dst_addr = expired->flow.nw_dst;
 146     nf_rec->nexthop = htons(0);
 147     if (nf->add_id_to_iface) {
 148         uint16_t iface = (nf->engine_id & 0x7f) << 9;
 149         nf_rec->input = htons(iface | (expired->flow.in_port & 0x1ff));
 150         nf_rec->output = htons(iface | (nf_flow->output_iface & 0x1ff));
 151     } else {
 152         nf_rec->input = htons(expired->flow.in_port);
 153         nf_rec->output = htons(nf_flow->output_iface);
 154     }
 155     nf_rec->packet_count = htonl(MIN(expired->packet_count -
 156                                      nf_flow->packet_count_off, UINT32_MAX));
 157     nf_rec->byte_count = htonl(MIN(expired->byte_count -
 158                                    nf_flow->byte_count_off, UINT32_MAX));
 159     nf_rec->init_time = htonl(nf_flow->created - nf->boot_time);
 160     nf_rec->used_time = htonl(MAX(nf_flow->created, expired->used)
 161                              - nf->boot_time);
 162     if (expired->flow.nw_proto == IP_TYPE_ICMP) {
 163         /* In NetFlow, the ICMP type and code are concatenated and
 164          * placed in the 'dst_port' field. */
 165         uint8_t type = ntohs(expired->flow.tp_src);
 166         uint8_t code = ntohs(expired->flow.tp_dst);
 167         nf_rec->src_port = htons(0);
 168         nf_rec->dst_port = htons((type << 8) | code);
 169     } else {
 170         nf_rec->src_port = expired->flow.tp_src;
 171         nf_rec->dst_port = expired->flow.tp_dst;
 172     }
 173     nf_rec->tcp_flags = nf_flow->tcp_flags;
 174     nf_rec->ip_proto = expired->flow.nw_proto;
 175     nf_rec->ip_tos = nf_flow->ip_tos;
 176
 177     /* Update flow tracking data. */
 178     nf_flow->created = 0;
 179     nf_flow->packet_count_off = expired->packet_count;
 180     nf_flow->byte_count_off = expired->byte_count;
 181     nf_flow->tcp_flags = 0;
 182
 183     /* NetFlow messages are limited to 30 records. */
 184     if (ntohs(nf_hdr->count) >= 30) {
 185         netflow_run(nf);
 186     }
 187 }
 188
 189 void
 190 netflow_run(struct netflow *nf)
 191 {
 192     if (nf->packet.size) {
 193         collectors_send(nf->collectors, nf->packet.data, nf->packet.size);
 194         nf->packet.size = 0;
 195     }
 196 }
 197
 198 int
 199 netflow_set_options(struct netflow *nf,
 200                     const struct netflow_options *nf_options)
 201 {
 202     int error = 0;
 203     long long int old_timeout;
 204
 205     nf->engine_type = nf_options->engine_type;
 206     nf->engine_id = nf_options->engine_id;
 207     nf->add_id_to_iface = nf_options->add_id_to_iface;
 208
 209     collectors_destroy(nf->collectors);
 210     collectors_create(&nf_options->collectors, 0, &nf->collectors);
 211
 212     old_timeout = nf->active_timeout;
 213     if (nf_options->active_timeout > 0) {
 214         nf->active_timeout = nf_options->active_timeout;
 215     } else {
 216         nf->active_timeout = ACTIVE_TIMEOUT_DEFAULT;
 217     }
 218     nf->active_timeout *= 1000;
 219     if (old_timeout != nf->active_timeout) {
 220         nf->reconfig_time = time_msec();
 221     }
 222
 223     return error;
 224 }
 225
 226 struct netflow *
 227 netflow_create(void)
 228 {
 229     struct netflow *nf = xmalloc(sizeof *nf);
 230     nf->engine_type = 0;
 231     nf->engine_id = 0;
 232     nf->boot_time = time_msec();
 233     nf->collectors = NULL;
 234     nf->add_id_to_iface = false;
 235     nf->netflow_cnt = 0;
 236     ofpbuf_init(&nf->packet, 1500);
 237     return nf;
 238 }
 239
 240 void
 241 netflow_destroy(struct netflow *nf)
 242 {
 243     if (nf) {
 244         ofpbuf_uninit(&nf->packet);
 245         collectors_destroy(nf->collectors);
 246         free(nf);
 247     }
 248 }
 249
 250 void
 251 netflow_flow_clear(struct netflow_flow *nf_flow)
 252 {
 253     uint16_t output_iface = nf_flow->output_iface;
 254
 255     memset(nf_flow, 0, sizeof *nf_flow);
 256     nf_flow->output_iface = output_iface;
 257 }
 258
 259 void
 260 netflow_flow_update_time(struct netflow *nf, struct netflow_flow *nf_flow,
 261                          long long int used)
 262 {
 263     if (!nf_flow->created) {
 264         nf_flow->created = used;
 265     }
 266
 267     if (!nf || !nf->active_timeout || !nf_flow->last_expired ||
 268         nf->reconfig_time > nf_flow->last_expired) {
 269         /* Keep the time updated to prevent a flood of expiration in
 270          * the future. */
 271         nf_flow->last_expired = time_msec();
 272     }
 273 }
 274
 275 void
 276 netflow_flow_update_flags(struct netflow_flow *nf_flow, uint8_t ip_tos,
 277                           uint8_t tcp_flags)
 278 {
 279     nf_flow->ip_tos = ip_tos;
 280     nf_flow->tcp_flags |= tcp_flags;
 281 }
 282
 283 bool
 284 netflow_active_timeout_expired(struct netflow *nf, struct netflow_flow *nf_flow)
 285 {
 286     if (nf->active_timeout) {
 287         return time_msec() > nf_flow->last_expired + nf->active_timeout;
 288     }
 289
 290     return false;
 291 }