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 "dpif.h"
  24 #include "compiler.h"
  25 #include "netdev.h"
  26 #include "ofpbuf.h"
  27 #include "ofproto.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
  34 #define THIS_MODULE VLM_sflow
  35 #include "vlog.h"
  36
  37 struct ofproto_sflow_port {
  38     struct netdev *netdev;      /* Underlying network device, for stats. */
  39     SFLDataSource_instance dsi; /* sFlow library's notion of port number. */
  40 };
  41
  42 struct ofproto_sflow {
  43     struct ofproto *ofproto;
  44     struct collectors *collectors;
  45     SFLAgent *sflow_agent;
  46     struct ofproto_sflow_options *options;
  47     struct dpif *dpif;
  48     time_t next_tick;
  49     size_t n_flood, n_all;
  50     struct port_array ports;    /* Indexed by ODP port number. */
  51 };
  52
  53 #define RECEIVER_INDEX 1
  54
  55 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
  56
  57 static bool
  58 nullable_string_is_equal(const char *a, const char *b)
  59 {
  60     return a ? b && !strcmp(a, b) : !b;
  61 }
  62
  63 static bool
  64 ofproto_sflow_options_equal(const struct ofproto_sflow_options *a,
  65                             const struct ofproto_sflow_options *b)
  66 {
  67     return (svec_equal(&a->targets, &b->targets)
  68             && a->sampling_rate == b->sampling_rate
  69             && a->polling_interval == b->polling_interval
  70             && a->header_len == b->header_len
  71             && a->sub_id == b->sub_id
  72             && nullable_string_is_equal(a->agent_device, b->agent_device)
  73             && nullable_string_is_equal(a->control_ip, b->control_ip));
  74 }
  75
  76 static struct ofproto_sflow_options *
  77 ofproto_sflow_options_clone(const struct ofproto_sflow_options *old)
  78 {
  79     struct ofproto_sflow_options *new = xmemdup(old, sizeof *old);
  80     svec_clone(&new->targets, &old->targets);
  81     new->agent_device = old->agent_device ? xstrdup(old->agent_device) : NULL;
  82     new->control_ip = old->control_ip ? xstrdup(old->control_ip) : NULL;
  83     return new;
  84 }
  85
  86 static void
  87 ofproto_sflow_options_destroy(struct ofproto_sflow_options *options)
  88 {
  89     if (options) {
  90         svec_destroy(&options->targets);
  91         free(options->agent_device);
  92         free(options->control_ip);
  93         free(options);
  94     }
  95 }
  96
  97 /* sFlow library callback to allocate memory. */
  98 static void *
  99 sflow_agent_alloc_cb(void *magic OVS_UNUSED, SFLAgent *agent OVS_UNUSED,
 100                      size_t bytes)
 101 {
 102     return calloc(1, bytes);
 103 }
 104
 105 /* sFlow library callback to free memory. */
 106 static int
 107 sflow_agent_free_cb(void *magic OVS_UNUSED, SFLAgent *agent OVS_UNUSED,
 108                     void *obj)
 109 {
 110     free(obj);
 111     return 0;
 112 }
 113
 114 /* sFlow library callback to report error. */
 115 static void
 116 sflow_agent_error_cb(void *magic OVS_UNUSED, SFLAgent *agent OVS_UNUSED,
 117                      char *msg)
 118 {
 119     VLOG_WARN("sFlow agent error: %s", msg);
 120 }
 121
 122 /* sFlow library callback to send datagram. */
 123 static void
 124 sflow_agent_send_packet_cb(void *os_, SFLAgent *agent OVS_UNUSED,
 125                            SFLReceiver *receiver OVS_UNUSED, u_char *pkt,
 126                            uint32_t pktLen)
 127 {
 128     struct ofproto_sflow *os = os_;
 129     collectors_send(os->collectors, pkt, pktLen);
 130 }
 131
 132 static void
 133 sflow_agent_get_counters(void *os_, SFLPoller *poller,
 134                          SFL_COUNTERS_SAMPLE_TYPE *cs)
 135 {
 136     struct ofproto_sflow *os = os_;
 137     SFLCounters_sample_element elem;
 138     struct ofproto_sflow_port *osp;
 139     SFLIf_counters *counters;
 140     struct netdev_stats stats;
 141     enum netdev_flags flags;
 142     uint32_t current;
 143
 144     osp = port_array_get(&os->ports, poller->bridgePort);
 145     if (!osp) {
 146         return;
 147     }
 148
 149     elem.tag = SFLCOUNTERS_GENERIC;
 150     counters = &elem.counterBlock.generic;
 151     counters->ifIndex = SFL_DS_INDEX(poller->dsi);
 152     counters->ifType = 6;
 153     if (!netdev_get_features(osp->netdev, &current, NULL, NULL, NULL)) {
 154       /* The values of ifDirection come from MAU MIB (RFC 2668): 0 = unknown,
 155          1 = full-duplex, 2 = half-duplex, 3 = in, 4=out */
 156         counters->ifSpeed = netdev_features_to_bps(current);
 157         counters->ifDirection = (netdev_features_is_full_duplex(current)
 158                                  ? 1 : 2);
 159     } else {
 160         counters->ifSpeed = 100000000;
 161         counters->ifDirection = 0;
 162     }
 163     if (!netdev_get_flags(osp->netdev, &flags) && flags & NETDEV_UP) {
 164         bool carrier;
 165
 166         counters->ifStatus = 1; /* ifAdminStatus up. */
 167         if (!netdev_get_carrier(osp->netdev, &carrier) && carrier) {
 168             counters->ifStatus |= 2; /* ifOperStatus us. */
 169         }
 170     } else {
 171         counters->ifStatus = 0;  /* Down. */
 172     }
 173
 174     /* XXX
 175        1. Is the multicast counter filled in?
 176        2. Does the multicast counter include broadcasts?
 177        3. Does the rx_packets counter include multicasts/broadcasts?
 178     */
 179     netdev_get_stats(osp->netdev, &stats);
 180     counters->ifInOctets = stats.rx_bytes;
 181     counters->ifInUcastPkts = stats.rx_packets;
 182     counters->ifInMulticastPkts = stats.multicast;
 183     counters->ifInBroadcastPkts = -1;
 184     counters->ifInDiscards = stats.rx_dropped;
 185     counters->ifInErrors = stats.rx_errors;
 186     counters->ifInUnknownProtos = -1;
 187     counters->ifOutOctets = stats.tx_bytes;
 188     counters->ifOutUcastPkts = stats.tx_packets;
 189     counters->ifOutMulticastPkts = -1;
 190     counters->ifOutBroadcastPkts = -1;
 191     counters->ifOutDiscards = stats.tx_dropped;
 192     counters->ifOutErrors = stats.tx_errors;
 193     counters->ifPromiscuousMode = 0;
 194
 195     SFLADD_ELEMENT(cs, &elem);
 196     sfl_poller_writeCountersSample(poller, cs);
 197 }
 198
 199 /* Obtains an address to use for the local sFlow agent and stores it into
 200  * '*agent_addr'.  Returns true if successful, false on failure.
 201  *
 202  * The sFlow agent address should be a local IP address that is persistent and
 203  * reachable over the network, if possible.  The IP address associated with
 204  * 'agent_device' is used if it has one, and otherwise 'control_ip', the IP
 205  * address used to talk to the controller. */
 206 static bool
 207 sflow_choose_agent_address(const char *agent_device, const char *control_ip,
 208                            SFLAddress *agent_addr)
 209 {
 210     struct in_addr in4;
 211
 212     memset(agent_addr, 0, sizeof *agent_addr);
 213     agent_addr->type = SFLADDRESSTYPE_IP_V4;
 214
 215     if (agent_device) {
 216         struct netdev *netdev;
 217
 218         if (!netdev_open_default(agent_device, &netdev)) {
 219             int error = netdev_get_in4(netdev, &in4, NULL);
 220             netdev_close(netdev);
 221             if (!error) {
 222                 goto success;
 223             }
 224         }
 225     }
 226
 227     if (control_ip && !lookup_ip(control_ip, &in4)) {
 228         goto success;
 229     }
 230
 231     VLOG_ERR("could not determine IP address for sFlow agent");
 232     return false;
 233
 234 success:
 235     agent_addr->address.ip_v4.addr = in4.s_addr;
 236     return true;
 237 }
 238
 239 void
 240 ofproto_sflow_clear(struct ofproto_sflow *os)
 241 {
 242     struct ofproto_sflow_port *osp;
 243     unsigned int odp_port;
 244
 245     if (os->sflow_agent) {
 246         sfl_agent_release(os->sflow_agent);
 247         os->sflow_agent = NULL;
 248     }
 249     collectors_destroy(os->collectors);
 250     os->collectors = NULL;
 251     ofproto_sflow_options_destroy(os->options);
 252     os->options = NULL;
 253
 254     PORT_ARRAY_FOR_EACH (osp, &os->ports, odp_port) {
 255         ofproto_sflow_del_port(os, odp_port);
 256     }
 257     port_array_clear(&os->ports);
 258
 259     /* Turn off sampling to save CPU cycles. */
 260     dpif_set_sflow_probability(os->dpif, 0);
 261 }
 262
 263 bool
 264 ofproto_sflow_is_enabled(const struct ofproto_sflow *os)
 265 {
 266     return os->collectors != NULL;
 267 }
 268
 269 struct ofproto_sflow *
 270 ofproto_sflow_create(struct dpif *dpif)
 271 {
 272     struct ofproto_sflow *os;
 273
 274     os = xcalloc(1, sizeof *os);
 275     os->dpif = dpif;
 276     os->next_tick = time_now() + 1;
 277     port_array_init(&os->ports);
 278     return os;
 279 }
 280
 281 void
 282 ofproto_sflow_destroy(struct ofproto_sflow *os)
 283 {
 284     if (os) {
 285         ofproto_sflow_clear(os);
 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 odp_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, odp_port);
 300 }
 301
 302 static void
 303 ofproto_sflow_add_sampler(struct ofproto_sflow *os,
 304                           struct ofproto_sflow_port *osp,
 305                           u_int32_t sampling_rate, u_int32_t header_len)
 306 {
 307     SFLSampler *sampler = sfl_agent_addSampler(os->sflow_agent, &osp->dsi);
 308     sfl_sampler_set_sFlowFsPacketSamplingRate(sampler, sampling_rate);
 309     sfl_sampler_set_sFlowFsMaximumHeaderSize(sampler, header_len);
 310     sfl_sampler_set_sFlowFsReceiver(sampler, RECEIVER_INDEX);
 311 }
 312
 313 void
 314 ofproto_sflow_add_port(struct ofproto_sflow *os, uint16_t odp_port,
 315                        const char *netdev_name)
 316 {
 317     struct ofproto_sflow_port *osp;
 318     struct netdev *netdev;
 319     uint32_t ifindex;
 320     int error;
 321
 322     ofproto_sflow_del_port(os, odp_port);
 323
 324     /* Open network device. */
 325     error = netdev_open_default(netdev_name, &netdev);
 326     if (error) {
 327         VLOG_WARN_RL(&rl, "failed to open network device \"%s\": %s",
 328                      netdev_name, strerror(error));
 329         return;
 330     }
 331
 332     /* Add to table of ports. */
 333     osp = xmalloc(sizeof *osp);
 334     osp->netdev = netdev;
 335     ifindex = netdev_get_ifindex(netdev);
 336     if (ifindex <= 0) {
 337         ifindex = (os->sflow_agent->subId << 16) + odp_port;
 338     }
 339     SFL_DS_SET(osp->dsi, 0, ifindex, 0);
 340     port_array_set(&os->ports, odp_port, osp);
 341
 342     /* Add poller. */
 343     if (os->sflow_agent) {
 344         ofproto_sflow_add_poller(os, osp, odp_port);
 345     }
 346 }
 347
 348 void
 349 ofproto_sflow_del_port(struct ofproto_sflow *os, uint16_t odp_port)
 350 {
 351     struct ofproto_sflow_port *osp = port_array_get(&os->ports, odp_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_set(&os->ports, odp_port, NULL);
 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 odp_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_now();
 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     dpif_set_sflow_probability(os->dpif,
 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, odp_port) {
 442         ofproto_sflow_add_sampler(os, osp,
 443                                   options->sampling_rate, options->header_len);
 444     }
 445 }
 446
 447 static int
 448 ofproto_sflow_odp_port_to_ifindex(const struct ofproto_sflow *os,
 449                                   uint16_t odp_port)
 450 {
 451     struct ofproto_sflow_port *osp = port_array_get(&os->ports, odp_port);
 452     return osp ? SFL_DS_INDEX(osp->dsi) : 0;
 453 }
 454
 455 void
 456 ofproto_sflow_received(struct ofproto_sflow *os, struct odp_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 odp_sflow_sample_header *hdr;
 464     const union odp_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 odp_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 odp_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 odp_action *) (hdr + 1);
 495
 496     /* Get packet payload and extract flow. */
 497     payload.data = (union odp_action *) (actions + n_actions);
 498     payload.size = msg->length - min_size;
 499     flow_extract(&payload, msg->port, &flow);
 500
 501     /* Build a flow sample */
 502     memset(&fs, 0, sizeof fs);
 503     fs.input = ofproto_sflow_odp_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     header->frame_length = payload.size;
 523     header->stripped = 4; /* Ethernet FCS stripped off. */
 524     header->header_length = MIN(payload.size,
 525                                 sampler->sFlowFsMaximumHeaderSize);
 526     header->header_bytes = payload.data;
 527
 528     /* Add extended switch element. */
 529     memset(&switchElem, 0, sizeof(switchElem));
 530     switchElem.tag = SFLFLOW_EX_SWITCH;
 531     switchElem.flowType.sw.src_vlan = ntohs(flow.dl_vlan);
 532     switchElem.flowType.sw.src_priority = -1; /* XXX */
 533     switchElem.flowType.sw.dst_vlan = -1;     /* Filled in correctly below. */
 534     switchElem.flowType.sw.dst_priority = switchElem.flowType.sw.src_priority;
 535
 536     /* Figure out the output ports. */
 537     n_outputs = 0;
 538     for (i = 0; i < n_actions; i++) {
 539         const union odp_action *a = &actions[i];
 540
 541         switch (a->type) {
 542         case ODPAT_OUTPUT:
 543             fs.output = ofproto_sflow_odp_port_to_ifindex(os, a->output.port);
 544             n_outputs++;
 545             break;
 546
 547         case ODPAT_OUTPUT_GROUP:
 548             n_outputs += (a->output_group.group == DP_GROUP_FLOOD ? os->n_flood
 549                           : a->output_group.group == DP_GROUP_ALL ? os->n_all
 550                           : 0);
 551             break;
 552
 553         case ODPAT_SET_VLAN_VID:
 554             switchElem.flowType.sw.dst_vlan = ntohs(a->vlan_vid.vlan_vid);
 555             break;
 556
 557         case ODPAT_SET_VLAN_PCP:
 558             switchElem.flowType.sw.dst_priority = a->vlan_pcp.vlan_pcp;
 559             break;
 560
 561         default:
 562             break;
 563         }
 564     }
 565
 566     /* Set output port, as defined by http://www.sflow.org/sflow_version_5.txt
 567        (search for "Input/output port information"). */
 568     if (!n_outputs) {
 569         /* This value indicates that the packet was dropped for an unknown
 570          * reason. */
 571         fs.output = 0x40000000 | 256;
 572     } else if (n_outputs > 1 || !fs.output) {
 573         /* Setting the high bit means "multiple output ports". */
 574         fs.output = 0x80000000 | n_outputs;
 575     }
 576
 577     /* Submit the flow sample to be encoded into the next datagram. */
 578     SFLADD_ELEMENT(&fs, &hdrElem);
 579     SFLADD_ELEMENT(&fs, &switchElem);
 580     sfl_sampler_writeFlowSample(sampler, &fs);
 581 }
 582
 583 void
 584 ofproto_sflow_set_group_sizes(struct ofproto_sflow *os,
 585                               size_t n_flood, size_t n_all)
 586 {
 587     os->n_flood = n_flood;
 588     os->n_all = n_all;
 589 }
 590
 591 void
 592 ofproto_sflow_run(struct ofproto_sflow *os)
 593 {
 594     if (ofproto_sflow_is_enabled(os)) {
 595         time_t now = time_now();
 596         if (now >= os->next_tick) {
 597             sfl_agent_tick(os->sflow_agent, now);
 598             os->next_tick = now + 1;
 599         }
 600     }
 601 }
 602
 603 void
 604 ofproto_sflow_wait(struct ofproto_sflow *os)
 605 {
 606     if (ofproto_sflow_is_enabled(os)) {
 607         poll_timer_wait(os->next_tick * 1000 - time_msec());
 608     }
 609 }