ofproto/ofproto-dpif-sflow.c

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