ofproto/ofproto-dpif-sflow.c

   1 /*
   2  * Copyright (c) 2009, 2010, 2011, 2012 Nicira, Inc.
   3  * Copyright (c) 2009 InMon Corp.
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at:
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #include <config.h>
  19 #include "ofproto-dpif-sflow.h"
  20 #include <inttypes.h>
  21 #include <sys/socket.h>
  22 #include <net/if.h>
  23 #include <stdlib.h>
  24 #include "collectors.h"
  25 #include "compiler.h"
  26 #include "dpif.h"
  27 #include "hash.h"
  28 #include "hmap.h"
  29 #include "netdev.h"
  30 #include "netlink.h"
  31 #include "ofpbuf.h"
  32 #include "ofproto.h"
  33 #include "packets.h"
  34 #include "poll-loop.h"
  35 #include "route-table.h"
  36 #include "sflow_api.h"
  37 #include "socket-util.h"
  38 #include "timeval.h"
  39 #include "vlog.h"
  40 #include "lib/odp-util.h"
  41 #include "ofproto-provider.h"
  42
  43 VLOG_DEFINE_THIS_MODULE(sflow);
  44
  45 struct dpif_sflow_port {
  46     struct hmap_node hmap_node; /* In struct dpif_sflow's "ports" hmap. */
  47     SFLDataSource_instance dsi; /* sFlow library's notion of port number. */
  48     struct ofport *ofport;      /* To retrive port stats. */
  49     odp_port_t odp_port;
  50 };
  51
  52 struct dpif_sflow {
  53     struct collectors *collectors;
  54     SFLAgent *sflow_agent;
  55     struct ofproto_sflow_options *options;
  56     time_t next_tick;
  57     size_t n_flood, n_all;
  58     struct hmap ports;          /* Contains "struct dpif_sflow_port"s. */
  59     uint32_t probability;
  60 };
  61
  62 static void dpif_sflow_del_port__(struct dpif_sflow *,
  63                                   struct dpif_sflow_port *);
  64
  65 #define RECEIVER_INDEX 1
  66
  67 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
  68
  69 static bool
  70 nullable_string_is_equal(const char *a, const char *b)
  71 {
  72     return a ? b && !strcmp(a, b) : !b;
  73 }
  74
  75 static bool
  76 ofproto_sflow_options_equal(const struct ofproto_sflow_options *a,
  77                          const struct ofproto_sflow_options *b)
  78 {
  79     return (sset_equals(&a->targets, &b->targets)
  80             && a->sampling_rate == b->sampling_rate
  81             && a->polling_interval == b->polling_interval
  82             && a->header_len == b->header_len
  83             && a->sub_id == b->sub_id
  84             && nullable_string_is_equal(a->agent_device, b->agent_device)
  85             && nullable_string_is_equal(a->control_ip, b->control_ip));
  86 }
  87
  88 static struct ofproto_sflow_options *
  89 ofproto_sflow_options_clone(const struct ofproto_sflow_options *old)
  90 {
  91     struct ofproto_sflow_options *new = xmemdup(old, sizeof *old);
  92     sset_clone(&new->targets, &old->targets);
  93     new->agent_device = old->agent_device ? xstrdup(old->agent_device) : NULL;
  94     new->control_ip = old->control_ip ? xstrdup(old->control_ip) : NULL;
  95     return new;
  96 }
  97
  98 static void
  99 ofproto_sflow_options_destroy(struct ofproto_sflow_options *options)
 100 {
 101     if (options) {
 102         sset_destroy(&options->targets);
 103         free(options->agent_device);
 104         free(options->control_ip);
 105         free(options);
 106     }
 107 }
 108
 109 /* sFlow library callback to allocate memory. */
 110 static void *
 111 sflow_agent_alloc_cb(void *magic OVS_UNUSED, SFLAgent *agent OVS_UNUSED,
 112                      size_t bytes)
 113 {
 114     return calloc(1, bytes);
 115 }
 116
 117 /* sFlow library callback to free memory. */
 118 static int
 119 sflow_agent_free_cb(void *magic OVS_UNUSED, SFLAgent *agent OVS_UNUSED,
 120                     void *obj)
 121 {
 122     free(obj);
 123     return 0;
 124 }
 125
 126 /* sFlow library callback to report error. */
 127 static void
 128 sflow_agent_error_cb(void *magic OVS_UNUSED, SFLAgent *agent OVS_UNUSED,
 129                      char *msg)
 130 {
 131     VLOG_WARN("sFlow agent error: %s", msg);
 132 }
 133
 134 /* sFlow library callback to send datagram. */
 135 static void
 136 sflow_agent_send_packet_cb(void *ds_, SFLAgent *agent OVS_UNUSED,
 137                            SFLReceiver *receiver OVS_UNUSED, u_char *pkt,
 138                            uint32_t pktLen)
 139 {
 140     struct dpif_sflow *ds = ds_;
 141     collectors_send(ds->collectors, pkt, pktLen);
 142 }
 143
 144 static struct dpif_sflow_port *
 145 dpif_sflow_find_port(const struct dpif_sflow *ds, odp_port_t odp_port)
 146 {
 147     struct dpif_sflow_port *dsp;
 148
 149     HMAP_FOR_EACH_IN_BUCKET (dsp, hmap_node,
 150                              hash_int(odp_to_u32(odp_port), 0),
 151                                       &ds->ports) {
 152         if (dsp->odp_port == odp_port) {
 153             return dsp;
 154         }
 155     }
 156     return NULL;
 157 }
 158
 159 static void
 160 sflow_agent_get_counters(void *ds_, SFLPoller *poller,
 161                          SFL_COUNTERS_SAMPLE_TYPE *cs)
 162 {
 163     struct dpif_sflow *ds = ds_;
 164     SFLCounters_sample_element elem;
 165     enum netdev_features current;
 166     struct dpif_sflow_port *dsp;
 167     SFLIf_counters *counters;
 168     struct netdev_stats stats;
 169     enum netdev_flags flags;
 170
 171     dsp = dpif_sflow_find_port(ds, u32_to_odp(poller->bridgePort));
 172     if (!dsp) {
 173         return;
 174     }
 175
 176     elem.tag = SFLCOUNTERS_GENERIC;
 177     counters = &elem.counterBlock.generic;
 178     counters->ifIndex = SFL_DS_INDEX(poller->dsi);
 179     counters->ifType = 6;
 180     if (!netdev_get_features(dsp->ofport->netdev, &current, NULL, NULL, NULL)) {
 181         /* The values of ifDirection come from MAU MIB (RFC 2668): 0 = unknown,
 182            1 = full-duplex, 2 = half-duplex, 3 = in, 4=out */
 183         counters->ifSpeed = netdev_features_to_bps(current, 0);
 184         counters->ifDirection = (netdev_features_is_full_duplex(current)
 185                                  ? 1 : 2);
 186     } else {
 187         counters->ifSpeed = 100000000;
 188         counters->ifDirection = 0;
 189     }
 190     if (!netdev_get_flags(dsp->ofport->netdev, &flags) && flags & NETDEV_UP) {
 191         counters->ifStatus = 1; /* ifAdminStatus up. */
 192         if (netdev_get_carrier(dsp->ofport->netdev)) {
 193             counters->ifStatus |= 2; /* ifOperStatus us. */
 194         }
 195     } else {
 196         counters->ifStatus = 0;  /* Down. */
 197     }
 198
 199     /* XXX
 200        1. Is the multicast counter filled in?
 201        2. Does the multicast counter include broadcasts?
 202        3. Does the rx_packets counter include multicasts/broadcasts?
 203     */
 204     ofproto_port_get_stats(dsp->ofport, &stats);
 205     counters->ifInOctets = stats.rx_bytes;
 206     counters->ifInUcastPkts = stats.rx_packets;
 207     counters->ifInMulticastPkts = stats.multicast;
 208     counters->ifInBroadcastPkts = -1;
 209     counters->ifInDiscards = stats.rx_dropped;
 210     counters->ifInErrors = stats.rx_errors;
 211     counters->ifInUnknownProtos = -1;
 212     counters->ifOutOctets = stats.tx_bytes;
 213     counters->ifOutUcastPkts = stats.tx_packets;
 214     counters->ifOutMulticastPkts = -1;
 215     counters->ifOutBroadcastPkts = -1;
 216     counters->ifOutDiscards = stats.tx_dropped;
 217     counters->ifOutErrors = stats.tx_errors;
 218     counters->ifPromiscuousMode = 0;
 219
 220     SFLADD_ELEMENT(cs, &elem);
 221     sfl_poller_writeCountersSample(poller, cs);
 222 }
 223
 224 /* Obtains an address to use for the local sFlow agent and stores it into
 225  * '*agent_addr'.  Returns true if successful, false on failure.
 226  *
 227  * The sFlow agent address should be a local IP address that is persistent and
 228  * reachable over the network, if possible.  The IP address associated with
 229  * 'agent_device' is used if it has one, and otherwise 'control_ip', the IP
 230  * address used to talk to the controller.  If the agent device is not
 231  * specified then it is figured out by taking a look at the routing table based
 232  * on 'targets'. */
 233 static bool
 234 sflow_choose_agent_address(const char *agent_device,
 235                            const struct sset *targets,
 236                            const char *control_ip,
 237                            SFLAddress *agent_addr)
 238 {
 239     const char *target;
 240     struct in_addr in4;
 241
 242     memset(agent_addr, 0, sizeof *agent_addr);
 243     agent_addr->type = SFLADDRESSTYPE_IP_V4;
 244
 245     if (agent_device) {
 246         if (!netdev_get_in4_by_name(agent_device, &in4)) {
 247             goto success;
 248         }
 249     }
 250
 251     SSET_FOR_EACH (target, targets) {
 252         struct sockaddr_in sin;
 253         char name[IFNAMSIZ];
 254
 255         if (inet_parse_active(target, SFL_DEFAULT_COLLECTOR_PORT, &sin)
 256             && route_table_get_name(sin.sin_addr.s_addr, name)
 257             && !netdev_get_in4_by_name(name, &in4)) {
 258             goto success;
 259         }
 260     }
 261
 262     if (control_ip && !lookup_ip(control_ip, &in4)) {
 263         goto success;
 264     }
 265
 266     VLOG_ERR("could not determine IP address for sFlow agent");
 267     return false;
 268
 269 success:
 270     agent_addr->address.ip_v4.addr = (OVS_FORCE uint32_t) in4.s_addr;
 271     return true;
 272 }
 273
 274 void
 275 dpif_sflow_clear(struct dpif_sflow *ds)
 276 {
 277     if (ds->sflow_agent) {
 278         sfl_agent_release(ds->sflow_agent);
 279         ds->sflow_agent = NULL;
 280     }
 281     collectors_destroy(ds->collectors);
 282     ds->collectors = NULL;
 283     ofproto_sflow_options_destroy(ds->options);
 284     ds->options = NULL;
 285
 286     /* Turn off sampling to save CPU cycles. */
 287     ds->probability = 0;
 288 }
 289
 290 bool
 291 dpif_sflow_is_enabled(const struct dpif_sflow *ds)
 292 {
 293     return ds->collectors != NULL;
 294 }
 295
 296 struct dpif_sflow *
 297 dpif_sflow_create(void)
 298 {
 299     struct dpif_sflow *ds;
 300
 301     ds = xcalloc(1, sizeof *ds);
 302     ds->next_tick = time_now() + 1;
 303     hmap_init(&ds->ports);
 304     ds->probability = 0;
 305     route_table_register();
 306
 307     return ds;
 308 }
 309
 310 /* 32-bit fraction of packets to sample with.  A value of 0 samples no packets,
 311  * a value of %UINT32_MAX samples all packets and intermediate values sample
 312  * intermediate fractions of packets. */
 313 uint32_t
 314 dpif_sflow_get_probability(const struct dpif_sflow *ds)
 315 {
 316     return ds->probability;
 317 }
 318
 319 void
 320 dpif_sflow_destroy(struct dpif_sflow *ds)
 321 {
 322     if (ds) {
 323         struct dpif_sflow_port *dsp, *next;
 324
 325         route_table_unregister();
 326         dpif_sflow_clear(ds);
 327         HMAP_FOR_EACH_SAFE (dsp, next, hmap_node, &ds->ports) {
 328             dpif_sflow_del_port__(ds, dsp);
 329         }
 330         hmap_destroy(&ds->ports);
 331         free(ds);
 332     }
 333 }
 334
 335 static void
 336 dpif_sflow_add_poller(struct dpif_sflow *ds, struct dpif_sflow_port *dsp)
 337 {
 338     SFLPoller *poller = sfl_agent_addPoller(ds->sflow_agent, &dsp->dsi, ds,
 339                                             sflow_agent_get_counters);
 340     sfl_poller_set_sFlowCpInterval(poller, ds->options->polling_interval);
 341     sfl_poller_set_sFlowCpReceiver(poller, RECEIVER_INDEX);
 342     sfl_poller_set_bridgePort(poller, odp_to_u32(dsp->odp_port));
 343 }
 344
 345 void
 346 dpif_sflow_add_port(struct dpif_sflow *ds, struct ofport *ofport,
 347                     odp_port_t odp_port)
 348 {
 349     struct dpif_sflow_port *dsp;
 350     int ifindex;
 351
 352     dpif_sflow_del_port(ds, odp_port);
 353
 354     ifindex = netdev_get_ifindex(ofport->netdev);
 355
 356     if (ifindex <= 0) {
 357         /* Not an ifindex port, so do not add a cross-reference to it here */
 358         return;
 359     }
 360
 361     /* Add to table of ports. */
 362     dsp = xmalloc(sizeof *dsp);
 363     dsp->ofport = ofport;
 364     dsp->odp_port = odp_port;
 365     SFL_DS_SET(dsp->dsi, SFL_DSCLASS_IFINDEX, ifindex, 0);
 366     hmap_insert(&ds->ports, &dsp->hmap_node, hash_int(odp_to_u32(odp_port), 0));
 367
 368     /* Add poller. */
 369     if (ds->sflow_agent) {
 370         dpif_sflow_add_poller(ds, dsp);
 371     }
 372 }
 373
 374 static void
 375 dpif_sflow_del_port__(struct dpif_sflow *ds, struct dpif_sflow_port *dsp)
 376 {
 377     if (ds->sflow_agent) {
 378         sfl_agent_removePoller(ds->sflow_agent, &dsp->dsi);
 379         sfl_agent_removeSampler(ds->sflow_agent, &dsp->dsi);
 380     }
 381     hmap_remove(&ds->ports, &dsp->hmap_node);
 382     free(dsp);
 383 }
 384
 385 void
 386 dpif_sflow_del_port(struct dpif_sflow *ds, odp_port_t odp_port)
 387 {
 388     struct dpif_sflow_port *dsp = dpif_sflow_find_port(ds, odp_port);
 389     if (dsp) {
 390         dpif_sflow_del_port__(ds, dsp);
 391     }
 392 }
 393
 394 void
 395 dpif_sflow_set_options(struct dpif_sflow *ds,
 396                        const struct ofproto_sflow_options *options)
 397 {
 398     struct dpif_sflow_port *dsp;
 399     bool options_changed;
 400     SFLReceiver *receiver;
 401     SFLAddress agentIP;
 402     time_t now;
 403     SFLDataSource_instance dsi;
 404     uint32_t dsIndex;
 405     SFLSampler *sampler;
 406
 407     if (sset_is_empty(&options->targets) || !options->sampling_rate) {
 408         /* No point in doing any work if there are no targets or nothing to
 409          * sample. */
 410         dpif_sflow_clear(ds);
 411         return;
 412     }
 413
 414     options_changed = (!ds->options
 415                        || !ofproto_sflow_options_equal(options, ds->options));
 416
 417     /* Configure collectors if options have changed or if we're shortchanged in
 418      * collectors (which indicates that opening one or more of the configured
 419      * collectors failed, so that we should retry). */
 420     if (options_changed
 421         || collectors_count(ds->collectors) < sset_count(&options->targets)) {
 422         collectors_destroy(ds->collectors);
 423         collectors_create(&options->targets, SFL_DEFAULT_COLLECTOR_PORT,
 424                           &ds->collectors);
 425         if (ds->collectors == NULL) {
 426             VLOG_WARN_RL(&rl, "no collectors could be initialized, "
 427                          "sFlow disabled");
 428             dpif_sflow_clear(ds);
 429             return;
 430         }
 431     }
 432
 433     /* Choose agent IP address and agent device (if not yet setup) */
 434     if (!sflow_choose_agent_address(options->agent_device,
 435                                     &options->targets,
 436                                     options->control_ip, &agentIP)) {
 437         dpif_sflow_clear(ds);
 438         return;
 439     }
 440
 441     /* Avoid reconfiguring if options didn't change. */
 442     if (!options_changed) {
 443         return;
 444     }
 445     ofproto_sflow_options_destroy(ds->options);
 446     ds->options = ofproto_sflow_options_clone(options);
 447
 448     /* Create agent. */
 449     VLOG_INFO("creating sFlow agent %d", options->sub_id);
 450     if (ds->sflow_agent) {
 451         sfl_agent_release(ds->sflow_agent);
 452     }
 453     ds->sflow_agent = xcalloc(1, sizeof *ds->sflow_agent);
 454     now = time_wall();
 455     sfl_agent_init(ds->sflow_agent,
 456                    &agentIP,
 457                    options->sub_id,
 458                    now,         /* Boot time. */
 459                    now,         /* Current time. */
 460                    ds,          /* Pointer supplied to callbacks. */
 461                    sflow_agent_alloc_cb,
 462                    sflow_agent_free_cb,
 463                    sflow_agent_error_cb,
 464                    sflow_agent_send_packet_cb);
 465
 466     receiver = sfl_agent_addReceiver(ds->sflow_agent);
 467     sfl_receiver_set_sFlowRcvrOwner(receiver, "Open vSwitch sFlow");
 468     sfl_receiver_set_sFlowRcvrTimeout(receiver, 0xffffffff);
 469
 470     /* Set the sampling_rate down in the datapath. */
 471     ds->probability = MAX(1, UINT32_MAX / ds->options->sampling_rate);
 472
 473     /* Add a single sampler for the bridge. This appears as a PHYSICAL_ENTITY
 474        because it is associated with the hypervisor, and interacts with the server
 475        hardware directly.  The sub_id is used to distinguish this sampler from
 476        others on other bridges within the same agent. */
 477     dsIndex = 1000 + options->sub_id;
 478     SFL_DS_SET(dsi, SFL_DSCLASS_PHYSICAL_ENTITY, dsIndex, 0);
 479     sampler = sfl_agent_addSampler(ds->sflow_agent, &dsi);
 480     sfl_sampler_set_sFlowFsPacketSamplingRate(sampler, ds->options->sampling_rate);
 481     sfl_sampler_set_sFlowFsMaximumHeaderSize(sampler, ds->options->header_len);
 482     sfl_sampler_set_sFlowFsReceiver(sampler, RECEIVER_INDEX);
 483
 484     /* Add pollers for the currently known ifindex-ports */
 485     HMAP_FOR_EACH (dsp, hmap_node, &ds->ports) {
 486         dpif_sflow_add_poller(ds, dsp);
 487     }
 488 }
 489
 490 int
 491 dpif_sflow_odp_port_to_ifindex(const struct dpif_sflow *ds,
 492                                odp_port_t odp_port)
 493 {
 494     struct dpif_sflow_port *dsp = dpif_sflow_find_port(ds, odp_port);
 495     return dsp ? SFL_DS_INDEX(dsp->dsi) : 0;
 496 }
 497
 498 void
 499 dpif_sflow_received(struct dpif_sflow *ds, struct ofpbuf *packet,
 500                     const struct flow *flow, odp_port_t odp_in_port,
 501                     const union user_action_cookie *cookie)
 502 {
 503     SFL_FLOW_SAMPLE_TYPE fs;
 504     SFLFlow_sample_element hdrElem;
 505     SFLSampled_header *header;
 506     SFLFlow_sample_element switchElem;
 507     SFLSampler *sampler;
 508     struct dpif_sflow_port *in_dsp;
 509     ovs_be16 vlan_tci;
 510
 511     sampler = ds->sflow_agent->samplers;
 512     if (!sampler) {
 513         return;
 514     }
 515
 516     /* Build a flow sample. */
 517     memset(&fs, 0, sizeof fs);
 518
 519     /* Look up the input ifIndex if this port has one. Otherwise just
 520      * leave it as 0 (meaning 'unknown') and continue. */
 521     in_dsp = dpif_sflow_find_port(ds, odp_in_port);
 522     if (in_dsp) {
 523         fs.input = SFL_DS_INDEX(in_dsp->dsi);
 524     }
 525
 526     /* Make the assumption that the random number generator in the datapath converges
 527      * to the configured mean, and just increment the samplePool by the configured
 528      * sampling rate every time. */
 529     sampler->samplePool += sfl_sampler_get_sFlowFsPacketSamplingRate(sampler);
 530
 531     /* Sampled header. */
 532     memset(&hdrElem, 0, sizeof hdrElem);
 533     hdrElem.tag = SFLFLOW_HEADER;
 534     header = &hdrElem.flowType.header;
 535     header->header_protocol = SFLHEADER_ETHERNET_ISO8023;
 536     /* The frame_length should include the Ethernet FCS (4 bytes),
 537      * but it has already been stripped,  so we need to add 4 here. */
 538     header->frame_length = packet->size + 4;
 539     /* Ethernet FCS stripped off. */
 540     header->stripped = 4;
 541     header->header_length = MIN(packet->size,
 542                                 sampler->sFlowFsMaximumHeaderSize);
 543     header->header_bytes = packet->data;
 544
 545     /* Add extended switch element. */
 546     memset(&switchElem, 0, sizeof(switchElem));
 547     switchElem.tag = SFLFLOW_EX_SWITCH;
 548     switchElem.flowType.sw.src_vlan = vlan_tci_to_vid(flow->vlan_tci);
 549     switchElem.flowType.sw.src_priority = vlan_tci_to_pcp(flow->vlan_tci);
 550
 551     /* Retrieve data from user_action_cookie. */
 552     vlan_tci = cookie->sflow.vlan_tci;
 553     switchElem.flowType.sw.dst_vlan = vlan_tci_to_vid(vlan_tci);
 554     switchElem.flowType.sw.dst_priority = vlan_tci_to_pcp(vlan_tci);
 555
 556     fs.output = cookie->sflow.output;
 557
 558     /* Submit the flow sample to be encoded into the next datagram. */
 559     SFLADD_ELEMENT(&fs, &hdrElem);
 560     SFLADD_ELEMENT(&fs, &switchElem);
 561     sfl_sampler_writeFlowSample(sampler, &fs);
 562 }
 563
 564 void
 565 dpif_sflow_run(struct dpif_sflow *ds)
 566 {
 567     if (dpif_sflow_is_enabled(ds)) {
 568         time_t now = time_now();
 569         route_table_run();
 570         if (now >= ds->next_tick) {
 571             sfl_agent_tick(ds->sflow_agent, time_wall());
 572             ds->next_tick = now + 1;
 573         }
 574     }
 575 }
 576
 577 void
 578 dpif_sflow_wait(struct dpif_sflow *ds)
 579 {
 580     if (dpif_sflow_is_enabled(ds)) {
 581         poll_timer_wait_until(ds->next_tick * 1000LL);
 582     }
 583 }