ofproto/ofproto-sflow.c

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