ofproto/ofproto-dpif-sflow.c

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