ofproto/ofproto-dpif-sflow.c

   1 /*
   2  * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015 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/resource.h>
  22 #include <sys/socket.h>
  23 #include <net/if.h>
  24 #include <stdlib.h>
  25 #include "collectors.h"
  26 #include "compiler.h"
  27 #include "dpif.h"
  28 #include "hash.h"
  29 #include "hmap.h"
  30 #include "netdev.h"
  31 #include "netlink.h"
  32 #include "ofpbuf.h"
  33 #include "ofproto.h"
  34 #include "packets.h"
  35 #include "poll-loop.h"
  36 #include "ovs-router.h"
  37 #include "route-table.h"
  38 #include "sflow_api.h"
  39 #include "socket-util.h"
  40 #include "timeval.h"
  41 #include "openvswitch/vlog.h"
  42 #include "lib/odp-util.h"
  43 #include "ofproto-provider.h"
  44 #include "lacp.h"
  45
  46 VLOG_DEFINE_THIS_MODULE(sflow);
  47
  48 static struct ovs_mutex mutex;
  49
  50 /* This global var is used to determine which sFlow
  51    sub-agent should send the datapath counters. */
  52 #define SFLOW_GC_SUBID_UNCLAIMED (uint32_t)-1
  53 static uint32_t sflow_global_counters_subid = SFLOW_GC_SUBID_UNCLAIMED;
  54
  55 struct dpif_sflow_port {
  56     struct hmap_node hmap_node; /* In struct dpif_sflow's "ports" hmap. */
  57     SFLDataSource_instance dsi; /* sFlow library's notion of port number. */
  58     struct ofport *ofport;      /* To retrive port stats. */
  59     odp_port_t odp_port;
  60 };
  61
  62 struct dpif_sflow {
  63     struct collectors *collectors;
  64     SFLAgent *sflow_agent;
  65     struct ofproto_sflow_options *options;
  66     time_t next_tick;
  67     size_t n_flood, n_all;
  68     struct hmap ports;          /* Contains "struct dpif_sflow_port"s. */
  69     uint32_t probability;
  70     struct ovs_refcount ref_cnt;
  71 };
  72
  73 static void dpif_sflow_del_port__(struct dpif_sflow *,
  74                                   struct dpif_sflow_port *);
  75
  76 #define RECEIVER_INDEX 1
  77
  78 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
  79
  80 static bool
  81 nullable_string_is_equal(const char *a, const char *b)
  82 {
  83     return a ? b && !strcmp(a, b) : !b;
  84 }
  85
  86 static bool
  87 ofproto_sflow_options_equal(const struct ofproto_sflow_options *a,
  88                          const struct ofproto_sflow_options *b)
  89 {
  90     return (sset_equals(&a->targets, &b->targets)
  91             && a->sampling_rate == b->sampling_rate
  92             && a->polling_interval == b->polling_interval
  93             && a->header_len == b->header_len
  94             && a->sub_id == b->sub_id
  95             && nullable_string_is_equal(a->agent_device, b->agent_device)
  96             && nullable_string_is_equal(a->control_ip, b->control_ip));
  97 }
  98
  99 static struct ofproto_sflow_options *
 100 ofproto_sflow_options_clone(const struct ofproto_sflow_options *old)
 101 {
 102     struct ofproto_sflow_options *new = xmemdup(old, sizeof *old);
 103     sset_clone(&new->targets, &old->targets);
 104     new->agent_device = old->agent_device ? xstrdup(old->agent_device) : NULL;
 105     new->control_ip = old->control_ip ? xstrdup(old->control_ip) : NULL;
 106     return new;
 107 }
 108
 109 static void
 110 ofproto_sflow_options_destroy(struct ofproto_sflow_options *options)
 111 {
 112     if (options) {
 113         sset_destroy(&options->targets);
 114         free(options->agent_device);
 115         free(options->control_ip);
 116         free(options);
 117     }
 118 }
 119
 120 /* sFlow library callback to allocate memory. */
 121 static void *
 122 sflow_agent_alloc_cb(void *magic OVS_UNUSED, SFLAgent *agent OVS_UNUSED,
 123                      size_t bytes)
 124 {
 125     return calloc(1, bytes);
 126 }
 127
 128 /* sFlow library callback to free memory. */
 129 static int
 130 sflow_agent_free_cb(void *magic OVS_UNUSED, SFLAgent *agent OVS_UNUSED,
 131                     void *obj)
 132 {
 133     free(obj);
 134     return 0;
 135 }
 136
 137 /* sFlow library callback to report error. */
 138 static void
 139 sflow_agent_error_cb(void *magic OVS_UNUSED, SFLAgent *agent OVS_UNUSED,
 140                      char *msg)
 141 {
 142     VLOG_WARN("sFlow agent error: %s", msg);
 143 }
 144
 145 /* sFlow library callback to send datagram. */
 146 static void
 147 sflow_agent_send_packet_cb(void *ds_, SFLAgent *agent OVS_UNUSED,
 148                            SFLReceiver *receiver OVS_UNUSED, u_char *pkt,
 149                            uint32_t pktLen)
 150 {
 151     struct dpif_sflow *ds = ds_;
 152     collectors_send(ds->collectors, pkt, pktLen);
 153 }
 154
 155 static struct dpif_sflow_port *
 156 dpif_sflow_find_port(const struct dpif_sflow *ds, odp_port_t odp_port)
 157     OVS_REQUIRES(mutex)
 158 {
 159     struct dpif_sflow_port *dsp;
 160
 161     HMAP_FOR_EACH_IN_BUCKET (dsp, hmap_node, hash_odp_port(odp_port),
 162                              &ds->ports) {
 163         if (dsp->odp_port == odp_port) {
 164             return dsp;
 165         }
 166     }
 167     return NULL;
 168 }
 169
 170 /* Call to get the datapath stats. Modeled after the dpctl utility.
 171  *
 172  * It might be more efficient for this module to be given a handle it can use
 173  * to get these stats more efficiently, but this is only going to be called
 174  * once every 20-30 seconds.  Return number of datapaths found (normally expect
 175  * 1). */
 176 static int
 177 sflow_get_dp_stats(struct dpif_sflow *ds OVS_UNUSED,
 178                    struct dpif_dp_stats *dp_totals)
 179 {
 180     struct sset types;
 181     const char *type;
 182     int count = 0;
 183
 184     memset(dp_totals, 0, sizeof *dp_totals);
 185     sset_init(&types);
 186     dp_enumerate_types(&types);
 187     SSET_FOR_EACH (type, &types) {
 188         struct sset names;
 189         const char *name;
 190         sset_init(&names);
 191         if (dp_enumerate_names(type, &names) == 0) {
 192             SSET_FOR_EACH (name, &names) {
 193                 struct dpif *dpif;
 194                 if (dpif_open(name, type, &dpif) == 0) {
 195                     struct dpif_dp_stats dp_stats;
 196                     if (dpif_get_dp_stats(dpif, &dp_stats) == 0) {
 197                         count++;
 198                         dp_totals->n_hit += dp_stats.n_hit;
 199                         dp_totals->n_missed += dp_stats.n_missed;
 200                         dp_totals->n_lost += dp_stats.n_lost;
 201                         dp_totals->n_flows += dp_stats.n_flows;
 202                         dp_totals->n_mask_hit += dp_stats.n_mask_hit;
 203                         dp_totals->n_masks += dp_stats.n_masks;
 204                     }
 205                     dpif_close(dpif);
 206                 }
 207             }
 208             sset_destroy(&names);
 209         }
 210     }
 211     sset_destroy(&types);
 212     return count;
 213 }
 214
 215 /* If there are multiple bridges defined then we need some
 216    minimal artibration to decide which one should send the
 217    global counters.  This function allows each sub-agent to
 218    ask if he should do it or not. */
 219 static bool
 220 sflow_global_counters_subid_test(uint32_t subid)
 221     OVS_REQUIRES(mutex)
 222 {
 223     if (sflow_global_counters_subid == SFLOW_GC_SUBID_UNCLAIMED) {
 224         /* The role is up for grabs. */
 225         sflow_global_counters_subid = subid;
 226     }
 227     return (sflow_global_counters_subid == subid);
 228 }
 229
 230 static void
 231 sflow_global_counters_subid_clear(uint32_t subid)
 232     OVS_REQUIRES(mutex)
 233 {
 234     if (sflow_global_counters_subid == subid) {
 235         /* The sub-agent that was sending global counters
 236            is going away, so reset to allow another
 237            to take over. */
 238         sflow_global_counters_subid = SFLOW_GC_SUBID_UNCLAIMED;
 239     }
 240 }
 241
 242 static void
 243 sflow_agent_get_global_counters(void *ds_, SFLPoller *poller,
 244                                 SFL_COUNTERS_SAMPLE_TYPE *cs)
 245     OVS_REQUIRES(mutex)
 246 {
 247     struct dpif_sflow *ds = ds_;
 248     SFLCounters_sample_element dp_elem, res_elem;
 249     struct dpif_dp_stats dp_totals;
 250     struct rusage usage;
 251
 252     if (!sflow_global_counters_subid_test(poller->agent->subId)) {
 253         /* Another sub-agent is currently responsible for this. */
 254         return;
 255     }
 256
 257     /* datapath stats */
 258     if (sflow_get_dp_stats(ds, &dp_totals)) {
 259         dp_elem.tag = SFLCOUNTERS_OVSDP;
 260         dp_elem.counterBlock.ovsdp.n_hit = dp_totals.n_hit;
 261         dp_elem.counterBlock.ovsdp.n_missed = dp_totals.n_missed;
 262         dp_elem.counterBlock.ovsdp.n_lost = dp_totals.n_lost;
 263         dp_elem.counterBlock.ovsdp.n_mask_hit = dp_totals.n_mask_hit;
 264         dp_elem.counterBlock.ovsdp.n_flows = dp_totals.n_flows;
 265         dp_elem.counterBlock.ovsdp.n_masks = dp_totals.n_masks;
 266         SFLADD_ELEMENT(cs, &dp_elem);
 267     }
 268
 269     /* resource usage */
 270     getrusage(RUSAGE_SELF, &usage);
 271     res_elem.tag = SFLCOUNTERS_APP_RESOURCES;
 272     res_elem.counterBlock.appResources.user_time
 273         = timeval_to_msec(&usage.ru_utime);
 274     res_elem.counterBlock.appResources.system_time
 275         = timeval_to_msec(&usage.ru_stime);
 276     res_elem.counterBlock.appResources.mem_used = (usage.ru_maxrss * 1024);
 277     SFL_UNDEF_GAUGE(res_elem.counterBlock.appResources.mem_max);
 278     SFL_UNDEF_GAUGE(res_elem.counterBlock.appResources.fd_open);
 279     SFL_UNDEF_GAUGE(res_elem.counterBlock.appResources.fd_max);
 280     SFL_UNDEF_GAUGE(res_elem.counterBlock.appResources.conn_open);
 281     SFL_UNDEF_GAUGE(res_elem.counterBlock.appResources.conn_max);
 282
 283     SFLADD_ELEMENT(cs, &res_elem);
 284     sfl_poller_writeCountersSample(poller, cs);
 285 }
 286
 287 static void
 288 sflow_agent_get_counters(void *ds_, SFLPoller *poller,
 289                          SFL_COUNTERS_SAMPLE_TYPE *cs)
 290     OVS_REQUIRES(mutex)
 291 {
 292     struct dpif_sflow *ds = ds_;
 293     SFLCounters_sample_element elem, lacp_elem, of_elem, name_elem;
 294     enum netdev_features current;
 295     struct dpif_sflow_port *dsp;
 296     SFLIf_counters *counters;
 297     struct netdev_stats stats;
 298     enum netdev_flags flags;
 299     struct lacp_slave_stats lacp_stats;
 300     const char *ifName;
 301
 302     dsp = dpif_sflow_find_port(ds, u32_to_odp(poller->bridgePort));
 303     if (!dsp) {
 304         return;
 305     }
 306
 307     elem.tag = SFLCOUNTERS_GENERIC;
 308     counters = &elem.counterBlock.generic;
 309     counters->ifIndex = SFL_DS_INDEX(poller->dsi);
 310     counters->ifType = 6;
 311     if (!netdev_get_features(dsp->ofport->netdev, &current, NULL, NULL, NULL)) {
 312         /* The values of ifDirection come from MAU MIB (RFC 2668): 0 = unknown,
 313            1 = full-duplex, 2 = half-duplex, 3 = in, 4=out */
 314         counters->ifSpeed = netdev_features_to_bps(current, 0);
 315         counters->ifDirection = (netdev_features_is_full_duplex(current)
 316                                  ? 1 : 2);
 317     } else {
 318         counters->ifSpeed = 100000000;
 319         counters->ifDirection = 0;
 320     }
 321     if (!netdev_get_flags(dsp->ofport->netdev, &flags) && flags & NETDEV_UP) {
 322         counters->ifStatus = 1; /* ifAdminStatus up. */
 323         if (netdev_get_carrier(dsp->ofport->netdev)) {
 324             counters->ifStatus |= 2; /* ifOperStatus us. */
 325         }
 326     } else {
 327         counters->ifStatus = 0;  /* Down. */
 328     }
 329
 330     /* XXX
 331        1. Is the multicast counter filled in?
 332        2. Does the multicast counter include broadcasts?
 333        3. Does the rx_packets counter include multicasts/broadcasts?
 334     */
 335     ofproto_port_get_stats(dsp->ofport, &stats);
 336     counters->ifInOctets = stats.rx_bytes;
 337     counters->ifInUcastPkts = stats.rx_packets;
 338     counters->ifInMulticastPkts = stats.multicast;
 339     counters->ifInBroadcastPkts = -1;
 340     counters->ifInDiscards = stats.rx_dropped;
 341     counters->ifInErrors = stats.rx_errors;
 342     counters->ifInUnknownProtos = -1;
 343     counters->ifOutOctets = stats.tx_bytes;
 344     counters->ifOutUcastPkts = stats.tx_packets;
 345     counters->ifOutMulticastPkts = -1;
 346     counters->ifOutBroadcastPkts = -1;
 347     counters->ifOutDiscards = stats.tx_dropped;
 348     counters->ifOutErrors = stats.tx_errors;
 349     counters->ifPromiscuousMode = 0;
 350
 351     SFLADD_ELEMENT(cs, &elem);
 352
 353     /* Include LACP counters and identifiers if this port is part of a LAG. */
 354     if (ofproto_port_get_lacp_stats(dsp->ofport, &lacp_stats) == 0) {
 355         memset(&lacp_elem, 0, sizeof lacp_elem);
 356         lacp_elem.tag = SFLCOUNTERS_LACP;
 357         memcpy(&lacp_elem.counterBlock.lacp.actorSystemID,
 358                lacp_stats.dot3adAggPortActorSystemID,
 359                ETH_ADDR_LEN);
 360         memcpy(&lacp_elem.counterBlock.lacp.partnerSystemID,
 361                lacp_stats.dot3adAggPortPartnerOperSystemID,
 362                ETH_ADDR_LEN);
 363         lacp_elem.counterBlock.lacp.attachedAggID =
 364             lacp_stats.dot3adAggPortAttachedAggID;
 365         lacp_elem.counterBlock.lacp.portState.v.actorAdmin =
 366             lacp_stats.dot3adAggPortActorAdminState;
 367         lacp_elem.counterBlock.lacp.portState.v.actorOper =
 368             lacp_stats.dot3adAggPortActorOperState;
 369         lacp_elem.counterBlock.lacp.portState.v.partnerAdmin =
 370             lacp_stats.dot3adAggPortPartnerAdminState;
 371         lacp_elem.counterBlock.lacp.portState.v.partnerOper =
 372             lacp_stats.dot3adAggPortPartnerOperState;
 373         lacp_elem.counterBlock.lacp.LACPDUsRx =
 374             lacp_stats.dot3adAggPortStatsLACPDUsRx;
 375         SFL_UNDEF_COUNTER(lacp_elem.counterBlock.lacp.markerPDUsRx);
 376         SFL_UNDEF_COUNTER(lacp_elem.counterBlock.lacp.markerResponsePDUsRx);
 377         SFL_UNDEF_COUNTER(lacp_elem.counterBlock.lacp.unknownRx);
 378         lacp_elem.counterBlock.lacp.illegalRx =
 379             lacp_stats.dot3adAggPortStatsIllegalRx;
 380         lacp_elem.counterBlock.lacp.LACPDUsTx =
 381             lacp_stats.dot3adAggPortStatsLACPDUsTx;
 382         SFL_UNDEF_COUNTER(lacp_elem.counterBlock.lacp.markerPDUsTx);
 383         SFL_UNDEF_COUNTER(lacp_elem.counterBlock.lacp.markerResponsePDUsTx);
 384         SFLADD_ELEMENT(cs, &lacp_elem);
 385     }
 386
 387     /* Include Port name. */
 388     if ((ifName = netdev_get_name(dsp->ofport->netdev)) != NULL) {
 389         memset(&name_elem, 0, sizeof name_elem);
 390         name_elem.tag = SFLCOUNTERS_PORTNAME;
 391         name_elem.counterBlock.portName.portName.str = (char *)ifName;
 392         name_elem.counterBlock.portName.portName.len = strlen(ifName);
 393         SFLADD_ELEMENT(cs, &name_elem);
 394     }
 395
 396     /* Include OpenFlow DPID and openflow port number. */
 397     memset(&of_elem, 0, sizeof of_elem);
 398     of_elem.tag = SFLCOUNTERS_OPENFLOWPORT;
 399     of_elem.counterBlock.ofPort.datapath_id =
 400         ofproto_get_datapath_id(dsp->ofport->ofproto);
 401     of_elem.counterBlock.ofPort.port_no =
 402       (OVS_FORCE uint32_t)dsp->ofport->ofp_port;
 403     SFLADD_ELEMENT(cs, &of_elem);
 404
 405     sfl_poller_writeCountersSample(poller, cs);
 406 }
 407
 408 /* Obtains an address to use for the local sFlow agent and stores it into
 409  * '*agent_addr'.  Returns true if successful, false on failure.
 410  *
 411  * The sFlow agent address should be a local IP address that is persistent and
 412  * reachable over the network, if possible.  The IP address associated with
 413  * 'agent_device' is used if it has one, and otherwise 'control_ip', the IP
 414  * address used to talk to the controller.  If the agent device is not
 415  * specified then it is figured out by taking a look at the routing table based
 416  * on 'targets'. */
 417 static bool
 418 sflow_choose_agent_address(const char *agent_device,
 419                            const struct sset *targets,
 420                            const char *control_ip,
 421                            SFLAddress *agent_addr)
 422 {
 423     const char *target;
 424     struct in_addr in4;
 425
 426     memset(agent_addr, 0, sizeof *agent_addr);
 427     agent_addr->type = SFLADDRESSTYPE_IP_V4;
 428
 429     if (agent_device) {
 430         if (!netdev_get_in4_by_name(agent_device, &in4)) {
 431             goto success;
 432         }
 433     }
 434
 435     SSET_FOR_EACH (target, targets) {
 436         union {
 437             struct sockaddr_storage ss;
 438             struct sockaddr_in sin;
 439         } sa;
 440         char name[IFNAMSIZ];
 441
 442         if (inet_parse_active(target, SFL_DEFAULT_COLLECTOR_PORT, &sa.ss)
 443             && sa.ss.ss_family == AF_INET) {
 444             ovs_be32 gw;
 445
 446             if (ovs_router_lookup(sa.sin.sin_addr.s_addr, name, &gw)
 447                 && !netdev_get_in4_by_name(name, &in4)) {
 448                 goto success;
 449             }
 450         }
 451     }
 452
 453     if (control_ip && !lookup_ip(control_ip, &in4)) {
 454         goto success;
 455     }
 456
 457     VLOG_ERR("could not determine IP address for sFlow agent");
 458     return false;
 459
 460 success:
 461     agent_addr->address.ip_v4.addr = (OVS_FORCE uint32_t) in4.s_addr;
 462     return true;
 463 }
 464
 465 static void
 466 dpif_sflow_clear__(struct dpif_sflow *ds) OVS_REQUIRES(mutex)
 467 {
 468     if (ds->sflow_agent) {
 469         sflow_global_counters_subid_clear(ds->sflow_agent->subId);
 470         sfl_agent_release(ds->sflow_agent);
 471         free(ds->sflow_agent);
 472         ds->sflow_agent = NULL;
 473     }
 474     collectors_destroy(ds->collectors);
 475     ds->collectors = NULL;
 476     ofproto_sflow_options_destroy(ds->options);
 477     ds->options = NULL;
 478
 479     /* Turn off sampling to save CPU cycles. */
 480     ds->probability = 0;
 481 }
 482
 483 void
 484 dpif_sflow_clear(struct dpif_sflow *ds) OVS_EXCLUDED(mutex)
 485 {
 486     ovs_mutex_lock(&mutex);
 487     dpif_sflow_clear__(ds);
 488     ovs_mutex_unlock(&mutex);
 489 }
 490
 491 bool
 492 dpif_sflow_is_enabled(const struct dpif_sflow *ds) OVS_EXCLUDED(mutex)
 493 {
 494     bool enabled;
 495
 496     ovs_mutex_lock(&mutex);
 497     enabled = ds->collectors != NULL;
 498     ovs_mutex_unlock(&mutex);
 499     return enabled;
 500 }
 501
 502 struct dpif_sflow *
 503 dpif_sflow_create(void)
 504 {
 505     static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
 506     struct dpif_sflow *ds;
 507
 508     if (ovsthread_once_start(&once)) {
 509         ovs_mutex_init_recursive(&mutex);
 510         ovsthread_once_done(&once);
 511     }
 512
 513     ds = xcalloc(1, sizeof *ds);
 514     ds->next_tick = time_now() + 1;
 515     hmap_init(&ds->ports);
 516     ds->probability = 0;
 517     ovs_refcount_init(&ds->ref_cnt);
 518
 519     return ds;
 520 }
 521
 522 struct dpif_sflow *
 523 dpif_sflow_ref(const struct dpif_sflow *ds_)
 524 {
 525     struct dpif_sflow *ds = CONST_CAST(struct dpif_sflow *, ds_);
 526     if (ds) {
 527         ovs_refcount_ref(&ds->ref_cnt);
 528     }
 529     return ds;
 530 }
 531
 532 /* 32-bit fraction of packets to sample with.  A value of 0 samples no packets,
 533  * a value of %UINT32_MAX samples all packets and intermediate values sample
 534  * intermediate fractions of packets. */
 535 uint32_t
 536 dpif_sflow_get_probability(const struct dpif_sflow *ds) OVS_EXCLUDED(mutex)
 537 {
 538     uint32_t probability;
 539     ovs_mutex_lock(&mutex);
 540     probability = ds->probability;
 541     ovs_mutex_unlock(&mutex);
 542     return probability;
 543 }
 544
 545 void
 546 dpif_sflow_unref(struct dpif_sflow *ds) OVS_EXCLUDED(mutex)
 547 {
 548     if (ds && ovs_refcount_unref_relaxed(&ds->ref_cnt) == 1) {
 549         struct dpif_sflow_port *dsp, *next;
 550
 551         dpif_sflow_clear(ds);
 552         HMAP_FOR_EACH_SAFE (dsp, next, hmap_node, &ds->ports) {
 553             dpif_sflow_del_port__(ds, dsp);
 554         }
 555         hmap_destroy(&ds->ports);
 556         free(ds);
 557     }
 558 }
 559
 560 static void
 561 dpif_sflow_add_poller(struct dpif_sflow *ds, struct dpif_sflow_port *dsp)
 562     OVS_REQUIRES(mutex)
 563 {
 564     SFLPoller *poller = sfl_agent_addPoller(ds->sflow_agent, &dsp->dsi, ds,
 565                                             sflow_agent_get_counters);
 566     sfl_poller_set_sFlowCpInterval(poller, ds->options->polling_interval);
 567     sfl_poller_set_sFlowCpReceiver(poller, RECEIVER_INDEX);
 568     sfl_poller_set_bridgePort(poller, odp_to_u32(dsp->odp_port));
 569 }
 570
 571 void
 572 dpif_sflow_add_port(struct dpif_sflow *ds, struct ofport *ofport,
 573                     odp_port_t odp_port) OVS_EXCLUDED(mutex)
 574 {
 575     struct dpif_sflow_port *dsp;
 576     int ifindex;
 577
 578     ovs_mutex_lock(&mutex);
 579     dpif_sflow_del_port(ds, odp_port);
 580
 581     ifindex = netdev_get_ifindex(ofport->netdev);
 582
 583     if (ifindex <= 0) {
 584         /* Not an ifindex port, so do not add a cross-reference to it here */
 585         goto out;
 586     }
 587
 588     /* Add to table of ports. */
 589     dsp = xmalloc(sizeof *dsp);
 590     dsp->ofport = ofport;
 591     dsp->odp_port = odp_port;
 592     SFL_DS_SET(dsp->dsi, SFL_DSCLASS_IFINDEX, ifindex, 0);
 593     hmap_insert(&ds->ports, &dsp->hmap_node, hash_odp_port(odp_port));
 594
 595     /* Add poller. */
 596     if (ds->sflow_agent) {
 597         dpif_sflow_add_poller(ds, dsp);
 598     }
 599
 600 out:
 601     ovs_mutex_unlock(&mutex);
 602 }
 603
 604 static void
 605 dpif_sflow_del_port__(struct dpif_sflow *ds, struct dpif_sflow_port *dsp)
 606     OVS_REQUIRES(mutex)
 607 {
 608     if (ds->sflow_agent) {
 609         sfl_agent_removePoller(ds->sflow_agent, &dsp->dsi);
 610         sfl_agent_removeSampler(ds->sflow_agent, &dsp->dsi);
 611     }
 612     hmap_remove(&ds->ports, &dsp->hmap_node);
 613     free(dsp);
 614 }
 615
 616 void
 617 dpif_sflow_del_port(struct dpif_sflow *ds, odp_port_t odp_port)
 618     OVS_EXCLUDED(mutex)
 619 {
 620     struct dpif_sflow_port *dsp;
 621
 622     ovs_mutex_lock(&mutex);
 623     dsp = dpif_sflow_find_port(ds, odp_port);
 624     if (dsp) {
 625         dpif_sflow_del_port__(ds, dsp);
 626     }
 627     ovs_mutex_unlock(&mutex);
 628 }
 629
 630 void
 631 dpif_sflow_set_options(struct dpif_sflow *ds,
 632                        const struct ofproto_sflow_options *options)
 633     OVS_EXCLUDED(mutex)
 634 {
 635     struct dpif_sflow_port *dsp;
 636     bool options_changed;
 637     SFLReceiver *receiver;
 638     SFLAddress agentIP;
 639     time_t now;
 640     SFLDataSource_instance dsi;
 641     uint32_t dsIndex;
 642     SFLSampler *sampler;
 643     SFLPoller *poller;
 644
 645     ovs_mutex_lock(&mutex);
 646     if (sset_is_empty(&options->targets) || !options->sampling_rate) {
 647         /* No point in doing any work if there are no targets or nothing to
 648          * sample. */
 649         dpif_sflow_clear__(ds);
 650         goto out;
 651     }
 652
 653     options_changed = (!ds->options
 654                        || !ofproto_sflow_options_equal(options, ds->options));
 655
 656     /* Configure collectors if options have changed or if we're shortchanged in
 657      * collectors (which indicates that opening one or more of the configured
 658      * collectors failed, so that we should retry). */
 659     if (options_changed
 660         || collectors_count(ds->collectors) < sset_count(&options->targets)) {
 661         collectors_destroy(ds->collectors);
 662         collectors_create(&options->targets, SFL_DEFAULT_COLLECTOR_PORT,
 663                           &ds->collectors);
 664         if (ds->collectors == NULL) {
 665             VLOG_WARN_RL(&rl, "no collectors could be initialized, "
 666                          "sFlow disabled");
 667             dpif_sflow_clear__(ds);
 668             goto out;
 669         }
 670     }
 671
 672     /* Choose agent IP address and agent device (if not yet setup) */
 673     if (!sflow_choose_agent_address(options->agent_device,
 674                                     &options->targets,
 675                                     options->control_ip, &agentIP)) {
 676         dpif_sflow_clear__(ds);
 677         goto out;
 678     }
 679
 680     /* Avoid reconfiguring if options didn't change. */
 681     if (!options_changed) {
 682         goto out;
 683     }
 684     ofproto_sflow_options_destroy(ds->options);
 685     ds->options = ofproto_sflow_options_clone(options);
 686
 687     /* Create agent. */
 688     VLOG_INFO("creating sFlow agent %d", options->sub_id);
 689     if (ds->sflow_agent) {
 690         sflow_global_counters_subid_clear(ds->sflow_agent->subId);
 691         sfl_agent_release(ds->sflow_agent);
 692     }
 693     ds->sflow_agent = xcalloc(1, sizeof *ds->sflow_agent);
 694     now = time_wall();
 695     sfl_agent_init(ds->sflow_agent,
 696                    &agentIP,
 697                    options->sub_id,
 698                    now,         /* Boot time. */
 699                    now,         /* Current time. */
 700                    ds,          /* Pointer supplied to callbacks. */
 701                    sflow_agent_alloc_cb,
 702                    sflow_agent_free_cb,
 703                    sflow_agent_error_cb,
 704                    sflow_agent_send_packet_cb);
 705
 706     receiver = sfl_agent_addReceiver(ds->sflow_agent);
 707     sfl_receiver_set_sFlowRcvrOwner(receiver, "Open vSwitch sFlow");
 708     sfl_receiver_set_sFlowRcvrTimeout(receiver, 0xffffffff);
 709
 710     /* Set the sampling_rate down in the datapath. */
 711     ds->probability = MAX(1, UINT32_MAX / ds->options->sampling_rate);
 712
 713     /* Add a single sampler for the bridge. This appears as a PHYSICAL_ENTITY
 714        because it is associated with the hypervisor, and interacts with the server
 715        hardware directly.  The sub_id is used to distinguish this sampler from
 716        others on other bridges within the same agent. */
 717     dsIndex = 1000 + options->sub_id;
 718     SFL_DS_SET(dsi, SFL_DSCLASS_PHYSICAL_ENTITY, dsIndex, 0);
 719     sampler = sfl_agent_addSampler(ds->sflow_agent, &dsi);
 720     sfl_sampler_set_sFlowFsPacketSamplingRate(sampler, ds->options->sampling_rate);
 721     sfl_sampler_set_sFlowFsMaximumHeaderSize(sampler, ds->options->header_len);
 722     sfl_sampler_set_sFlowFsReceiver(sampler, RECEIVER_INDEX);
 723
 724     /* Add a counter poller for the bridge so we can use it to send
 725        global counters such as datapath cache hit/miss stats. */
 726     poller = sfl_agent_addPoller(ds->sflow_agent, &dsi, ds,
 727                                  sflow_agent_get_global_counters);
 728     sfl_poller_set_sFlowCpInterval(poller, ds->options->polling_interval);
 729     sfl_poller_set_sFlowCpReceiver(poller, RECEIVER_INDEX);
 730
 731     /* Add pollers for the currently known ifindex-ports */
 732     HMAP_FOR_EACH (dsp, hmap_node, &ds->ports) {
 733         dpif_sflow_add_poller(ds, dsp);
 734     }
 735
 736
 737 out:
 738     ovs_mutex_unlock(&mutex);
 739 }
 740
 741 int
 742 dpif_sflow_odp_port_to_ifindex(const struct dpif_sflow *ds,
 743                                odp_port_t odp_port) OVS_EXCLUDED(mutex)
 744 {
 745     struct dpif_sflow_port *dsp;
 746     int ret;
 747
 748     ovs_mutex_lock(&mutex);
 749     dsp = dpif_sflow_find_port(ds, odp_port);
 750     ret = dsp ? SFL_DS_INDEX(dsp->dsi) : 0;
 751     ovs_mutex_unlock(&mutex);
 752     return ret;
 753 }
 754
 755 void
 756 dpif_sflow_received(struct dpif_sflow *ds, const struct dp_packet *packet,
 757                     const struct flow *flow, odp_port_t odp_in_port,
 758                     const union user_action_cookie *cookie)
 759     OVS_EXCLUDED(mutex)
 760 {
 761     SFL_FLOW_SAMPLE_TYPE fs;
 762     SFLFlow_sample_element hdrElem;
 763     SFLSampled_header *header;
 764     SFLFlow_sample_element switchElem;
 765     SFLSampler *sampler;
 766     struct dpif_sflow_port *in_dsp;
 767     ovs_be16 vlan_tci;
 768
 769     ovs_mutex_lock(&mutex);
 770     sampler = ds->sflow_agent->samplers;
 771     if (!sampler) {
 772         goto out;
 773     }
 774
 775     /* Build a flow sample. */
 776     memset(&fs, 0, sizeof fs);
 777
 778     /* Look up the input ifIndex if this port has one. Otherwise just
 779      * leave it as 0 (meaning 'unknown') and continue. */
 780     in_dsp = dpif_sflow_find_port(ds, odp_in_port);
 781     if (in_dsp) {
 782         fs.input = SFL_DS_INDEX(in_dsp->dsi);
 783     }
 784
 785     /* Make the assumption that the random number generator in the datapath converges
 786      * to the configured mean, and just increment the samplePool by the configured
 787      * sampling rate every time. */
 788     sampler->samplePool += sfl_sampler_get_sFlowFsPacketSamplingRate(sampler);
 789
 790     /* Sampled header. */
 791     memset(&hdrElem, 0, sizeof hdrElem);
 792     hdrElem.tag = SFLFLOW_HEADER;
 793     header = &hdrElem.flowType.header;
 794     header->header_protocol = SFLHEADER_ETHERNET_ISO8023;
 795     /* The frame_length should include the Ethernet FCS (4 bytes),
 796      * but it has already been stripped,  so we need to add 4 here. */
 797     header->frame_length = dp_packet_size(packet) + 4;
 798     /* Ethernet FCS stripped off. */
 799     header->stripped = 4;
 800     header->header_length = MIN(dp_packet_size(packet),
 801                                 sampler->sFlowFsMaximumHeaderSize);
 802     header->header_bytes = dp_packet_data(packet);
 803
 804     /* Add extended switch element. */
 805     memset(&switchElem, 0, sizeof(switchElem));
 806     switchElem.tag = SFLFLOW_EX_SWITCH;
 807     switchElem.flowType.sw.src_vlan = vlan_tci_to_vid(flow->vlan_tci);
 808     switchElem.flowType.sw.src_priority = vlan_tci_to_pcp(flow->vlan_tci);
 809
 810     /* Retrieve data from user_action_cookie. */
 811     vlan_tci = cookie->sflow.vlan_tci;
 812     switchElem.flowType.sw.dst_vlan = vlan_tci_to_vid(vlan_tci);
 813     switchElem.flowType.sw.dst_priority = vlan_tci_to_pcp(vlan_tci);
 814
 815     fs.output = cookie->sflow.output;
 816
 817     /* Submit the flow sample to be encoded into the next datagram. */
 818     SFLADD_ELEMENT(&fs, &hdrElem);
 819     SFLADD_ELEMENT(&fs, &switchElem);
 820     sfl_sampler_writeFlowSample(sampler, &fs);
 821
 822 out:
 823     ovs_mutex_unlock(&mutex);
 824 }
 825
 826 void
 827 dpif_sflow_run(struct dpif_sflow *ds) OVS_EXCLUDED(mutex)
 828 {
 829     ovs_mutex_lock(&mutex);
 830     if (ds->collectors != NULL) {
 831         time_t now = time_now();
 832         route_table_run();
 833         if (now >= ds->next_tick) {
 834             sfl_agent_tick(ds->sflow_agent, time_wall());
 835             ds->next_tick = now + 1;
 836         }
 837     }
 838     ovs_mutex_unlock(&mutex);
 839 }
 840
 841 void
 842 dpif_sflow_wait(struct dpif_sflow *ds) OVS_EXCLUDED(mutex)
 843 {
 844     ovs_mutex_lock(&mutex);
 845     if (ds->collectors != NULL) {
 846         poll_timer_wait_until(ds->next_tick * 1000LL);
 847     }
 848     ovs_mutex_unlock(&mutex);
 849 }