2 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
3 * Copyright (c) 2009 InMon Corp.
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:
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include "ofproto-dpif-sflow.h"
21 #include <sys/socket.h>
24 #include "collectors.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"
41 #include "lib/odp-util.h"
42 #include "ofproto-provider.h"
45 VLOG_DEFINE_THIS_MODULE(sflow);
47 static struct ovs_mutex mutex;
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. */
57 struct collectors *collectors;
58 SFLAgent *sflow_agent;
59 struct ofproto_sflow_options *options;
61 size_t n_flood, n_all;
62 struct hmap ports; /* Contains "struct dpif_sflow_port"s. */
64 struct ovs_refcount ref_cnt;
67 static void dpif_sflow_del_port__(struct dpif_sflow *,
68 struct dpif_sflow_port *);
70 #define RECEIVER_INDEX 1
72 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
75 nullable_string_is_equal(const char *a, const char *b)
77 return a ? b && !strcmp(a, b) : !b;
81 ofproto_sflow_options_equal(const struct ofproto_sflow_options *a,
82 const struct ofproto_sflow_options *b)
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));
93 static struct ofproto_sflow_options *
94 ofproto_sflow_options_clone(const struct ofproto_sflow_options *old)
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;
104 ofproto_sflow_options_destroy(struct ofproto_sflow_options *options)
107 sset_destroy(&options->targets);
108 free(options->agent_device);
109 free(options->control_ip);
114 /* sFlow library callback to allocate memory. */
116 sflow_agent_alloc_cb(void *magic OVS_UNUSED, SFLAgent *agent OVS_UNUSED,
119 return calloc(1, bytes);
122 /* sFlow library callback to free memory. */
124 sflow_agent_free_cb(void *magic OVS_UNUSED, SFLAgent *agent OVS_UNUSED,
131 /* sFlow library callback to report error. */
133 sflow_agent_error_cb(void *magic OVS_UNUSED, SFLAgent *agent OVS_UNUSED,
136 VLOG_WARN("sFlow agent error: %s", msg);
139 /* sFlow library callback to send datagram. */
141 sflow_agent_send_packet_cb(void *ds_, SFLAgent *agent OVS_UNUSED,
142 SFLReceiver *receiver OVS_UNUSED, u_char *pkt,
145 struct dpif_sflow *ds = ds_;
146 collectors_send(ds->collectors, pkt, pktLen);
149 static struct dpif_sflow_port *
150 dpif_sflow_find_port(const struct dpif_sflow *ds, odp_port_t odp_port)
153 struct dpif_sflow_port *dsp;
155 HMAP_FOR_EACH_IN_BUCKET (dsp, hmap_node, hash_odp_port(odp_port),
157 if (dsp->odp_port == odp_port) {
165 sflow_agent_get_counters(void *ds_, SFLPoller *poller,
166 SFL_COUNTERS_SAMPLE_TYPE *cs)
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;
179 dsp = dpif_sflow_find_port(ds, u32_to_odp(poller->bridgePort));
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, ¤t, 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)
195 counters->ifSpeed = 100000000;
196 counters->ifDirection = 0;
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. */
204 counters->ifStatus = 0; /* Down. */
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?
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;
228 SFLADD_ELEMENT(cs, &elem);
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,
237 memcpy(&lacp_elem.counterBlock.lacp.partnerSystemID,
238 lacp_stats.dot3adAggPortPartnerOperSystemID,
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);
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);
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);
282 sfl_poller_writeCountersSample(poller, cs);
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.
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
295 sflow_choose_agent_address(const char *agent_device,
296 const struct sset *targets,
297 const char *control_ip,
298 SFLAddress *agent_addr)
303 memset(agent_addr, 0, sizeof *agent_addr);
304 agent_addr->type = SFLADDRESSTYPE_IP_V4;
307 if (!netdev_get_in4_by_name(agent_device, &in4)) {
312 SSET_FOR_EACH (target, targets) {
314 struct sockaddr_storage ss;
315 struct sockaddr_in sin;
319 if (inet_parse_active(target, SFL_DEFAULT_COLLECTOR_PORT, &sa.ss)
320 && sa.ss.ss_family == AF_INET) {
323 if (ovs_router_lookup(sa.sin.sin_addr.s_addr, name, &gw)
324 && !netdev_get_in4_by_name(name, &in4)) {
330 if (control_ip && !lookup_ip(control_ip, &in4)) {
334 VLOG_ERR("could not determine IP address for sFlow agent");
338 agent_addr->address.ip_v4.addr = (OVS_FORCE uint32_t) in4.s_addr;
343 dpif_sflow_clear__(struct dpif_sflow *ds) OVS_REQUIRES(mutex)
345 if (ds->sflow_agent) {
346 sfl_agent_release(ds->sflow_agent);
347 free(ds->sflow_agent);
348 ds->sflow_agent = NULL;
350 collectors_destroy(ds->collectors);
351 ds->collectors = NULL;
352 ofproto_sflow_options_destroy(ds->options);
355 /* Turn off sampling to save CPU cycles. */
360 dpif_sflow_clear(struct dpif_sflow *ds) OVS_EXCLUDED(mutex)
362 ovs_mutex_lock(&mutex);
363 dpif_sflow_clear__(ds);
364 ovs_mutex_unlock(&mutex);
368 dpif_sflow_is_enabled(const struct dpif_sflow *ds) OVS_EXCLUDED(mutex)
372 ovs_mutex_lock(&mutex);
373 enabled = ds->collectors != NULL;
374 ovs_mutex_unlock(&mutex);
379 dpif_sflow_create(void)
381 static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
382 struct dpif_sflow *ds;
384 if (ovsthread_once_start(&once)) {
385 ovs_mutex_init_recursive(&mutex);
386 ovsthread_once_done(&once);
389 ds = xcalloc(1, sizeof *ds);
390 ds->next_tick = time_now() + 1;
391 hmap_init(&ds->ports);
393 route_table_register();
394 ovs_refcount_init(&ds->ref_cnt);
400 dpif_sflow_ref(const struct dpif_sflow *ds_)
402 struct dpif_sflow *ds = CONST_CAST(struct dpif_sflow *, ds_);
404 ovs_refcount_ref(&ds->ref_cnt);
409 /* 32-bit fraction of packets to sample with. A value of 0 samples no packets,
410 * a value of %UINT32_MAX samples all packets and intermediate values sample
411 * intermediate fractions of packets. */
413 dpif_sflow_get_probability(const struct dpif_sflow *ds) OVS_EXCLUDED(mutex)
415 uint32_t probability;
416 ovs_mutex_lock(&mutex);
417 probability = ds->probability;
418 ovs_mutex_unlock(&mutex);
423 dpif_sflow_unref(struct dpif_sflow *ds) OVS_EXCLUDED(mutex)
425 if (ds && ovs_refcount_unref_relaxed(&ds->ref_cnt) == 1) {
426 struct dpif_sflow_port *dsp, *next;
428 route_table_unregister();
429 dpif_sflow_clear(ds);
430 HMAP_FOR_EACH_SAFE (dsp, next, hmap_node, &ds->ports) {
431 dpif_sflow_del_port__(ds, dsp);
433 hmap_destroy(&ds->ports);
439 dpif_sflow_add_poller(struct dpif_sflow *ds, struct dpif_sflow_port *dsp)
442 SFLPoller *poller = sfl_agent_addPoller(ds->sflow_agent, &dsp->dsi, ds,
443 sflow_agent_get_counters);
444 sfl_poller_set_sFlowCpInterval(poller, ds->options->polling_interval);
445 sfl_poller_set_sFlowCpReceiver(poller, RECEIVER_INDEX);
446 sfl_poller_set_bridgePort(poller, odp_to_u32(dsp->odp_port));
450 dpif_sflow_add_port(struct dpif_sflow *ds, struct ofport *ofport,
451 odp_port_t odp_port) OVS_EXCLUDED(mutex)
453 struct dpif_sflow_port *dsp;
456 ovs_mutex_lock(&mutex);
457 dpif_sflow_del_port(ds, odp_port);
459 ifindex = netdev_get_ifindex(ofport->netdev);
462 /* Not an ifindex port, so do not add a cross-reference to it here */
466 /* Add to table of ports. */
467 dsp = xmalloc(sizeof *dsp);
468 dsp->ofport = ofport;
469 dsp->odp_port = odp_port;
470 SFL_DS_SET(dsp->dsi, SFL_DSCLASS_IFINDEX, ifindex, 0);
471 hmap_insert(&ds->ports, &dsp->hmap_node, hash_odp_port(odp_port));
474 if (ds->sflow_agent) {
475 dpif_sflow_add_poller(ds, dsp);
479 ovs_mutex_unlock(&mutex);
483 dpif_sflow_del_port__(struct dpif_sflow *ds, struct dpif_sflow_port *dsp)
486 if (ds->sflow_agent) {
487 sfl_agent_removePoller(ds->sflow_agent, &dsp->dsi);
488 sfl_agent_removeSampler(ds->sflow_agent, &dsp->dsi);
490 hmap_remove(&ds->ports, &dsp->hmap_node);
495 dpif_sflow_del_port(struct dpif_sflow *ds, odp_port_t odp_port)
498 struct dpif_sflow_port *dsp;
500 ovs_mutex_lock(&mutex);
501 dsp = dpif_sflow_find_port(ds, odp_port);
503 dpif_sflow_del_port__(ds, dsp);
505 ovs_mutex_unlock(&mutex);
509 dpif_sflow_set_options(struct dpif_sflow *ds,
510 const struct ofproto_sflow_options *options)
513 struct dpif_sflow_port *dsp;
514 bool options_changed;
515 SFLReceiver *receiver;
518 SFLDataSource_instance dsi;
522 ovs_mutex_lock(&mutex);
523 if (sset_is_empty(&options->targets) || !options->sampling_rate) {
524 /* No point in doing any work if there are no targets or nothing to
526 dpif_sflow_clear__(ds);
530 options_changed = (!ds->options
531 || !ofproto_sflow_options_equal(options, ds->options));
533 /* Configure collectors if options have changed or if we're shortchanged in
534 * collectors (which indicates that opening one or more of the configured
535 * collectors failed, so that we should retry). */
537 || collectors_count(ds->collectors) < sset_count(&options->targets)) {
538 collectors_destroy(ds->collectors);
539 collectors_create(&options->targets, SFL_DEFAULT_COLLECTOR_PORT,
541 if (ds->collectors == NULL) {
542 VLOG_WARN_RL(&rl, "no collectors could be initialized, "
544 dpif_sflow_clear__(ds);
549 /* Choose agent IP address and agent device (if not yet setup) */
550 if (!sflow_choose_agent_address(options->agent_device,
552 options->control_ip, &agentIP)) {
553 dpif_sflow_clear__(ds);
557 /* Avoid reconfiguring if options didn't change. */
558 if (!options_changed) {
561 ofproto_sflow_options_destroy(ds->options);
562 ds->options = ofproto_sflow_options_clone(options);
565 VLOG_INFO("creating sFlow agent %d", options->sub_id);
566 if (ds->sflow_agent) {
567 sfl_agent_release(ds->sflow_agent);
569 ds->sflow_agent = xcalloc(1, sizeof *ds->sflow_agent);
571 sfl_agent_init(ds->sflow_agent,
574 now, /* Boot time. */
575 now, /* Current time. */
576 ds, /* Pointer supplied to callbacks. */
577 sflow_agent_alloc_cb,
579 sflow_agent_error_cb,
580 sflow_agent_send_packet_cb);
582 receiver = sfl_agent_addReceiver(ds->sflow_agent);
583 sfl_receiver_set_sFlowRcvrOwner(receiver, "Open vSwitch sFlow");
584 sfl_receiver_set_sFlowRcvrTimeout(receiver, 0xffffffff);
586 /* Set the sampling_rate down in the datapath. */
587 ds->probability = MAX(1, UINT32_MAX / ds->options->sampling_rate);
589 /* Add a single sampler for the bridge. This appears as a PHYSICAL_ENTITY
590 because it is associated with the hypervisor, and interacts with the server
591 hardware directly. The sub_id is used to distinguish this sampler from
592 others on other bridges within the same agent. */
593 dsIndex = 1000 + options->sub_id;
594 SFL_DS_SET(dsi, SFL_DSCLASS_PHYSICAL_ENTITY, dsIndex, 0);
595 sampler = sfl_agent_addSampler(ds->sflow_agent, &dsi);
596 sfl_sampler_set_sFlowFsPacketSamplingRate(sampler, ds->options->sampling_rate);
597 sfl_sampler_set_sFlowFsMaximumHeaderSize(sampler, ds->options->header_len);
598 sfl_sampler_set_sFlowFsReceiver(sampler, RECEIVER_INDEX);
600 /* Add pollers for the currently known ifindex-ports */
601 HMAP_FOR_EACH (dsp, hmap_node, &ds->ports) {
602 dpif_sflow_add_poller(ds, dsp);
607 ovs_mutex_unlock(&mutex);
611 dpif_sflow_odp_port_to_ifindex(const struct dpif_sflow *ds,
612 odp_port_t odp_port) OVS_EXCLUDED(mutex)
614 struct dpif_sflow_port *dsp;
617 ovs_mutex_lock(&mutex);
618 dsp = dpif_sflow_find_port(ds, odp_port);
619 ret = dsp ? SFL_DS_INDEX(dsp->dsi) : 0;
620 ovs_mutex_unlock(&mutex);
625 dpif_sflow_received(struct dpif_sflow *ds, const struct ofpbuf *packet,
626 const struct flow *flow, odp_port_t odp_in_port,
627 const union user_action_cookie *cookie)
630 SFL_FLOW_SAMPLE_TYPE fs;
631 SFLFlow_sample_element hdrElem;
632 SFLSampled_header *header;
633 SFLFlow_sample_element switchElem;
635 struct dpif_sflow_port *in_dsp;
638 ovs_mutex_lock(&mutex);
639 sampler = ds->sflow_agent->samplers;
644 /* Build a flow sample. */
645 memset(&fs, 0, sizeof fs);
647 /* Look up the input ifIndex if this port has one. Otherwise just
648 * leave it as 0 (meaning 'unknown') and continue. */
649 in_dsp = dpif_sflow_find_port(ds, odp_in_port);
651 fs.input = SFL_DS_INDEX(in_dsp->dsi);
654 /* Make the assumption that the random number generator in the datapath converges
655 * to the configured mean, and just increment the samplePool by the configured
656 * sampling rate every time. */
657 sampler->samplePool += sfl_sampler_get_sFlowFsPacketSamplingRate(sampler);
659 /* Sampled header. */
660 memset(&hdrElem, 0, sizeof hdrElem);
661 hdrElem.tag = SFLFLOW_HEADER;
662 header = &hdrElem.flowType.header;
663 header->header_protocol = SFLHEADER_ETHERNET_ISO8023;
664 /* The frame_length should include the Ethernet FCS (4 bytes),
665 * but it has already been stripped, so we need to add 4 here. */
666 header->frame_length = ofpbuf_size(packet) + 4;
667 /* Ethernet FCS stripped off. */
668 header->stripped = 4;
669 header->header_length = MIN(ofpbuf_size(packet),
670 sampler->sFlowFsMaximumHeaderSize);
671 header->header_bytes = ofpbuf_data(packet);
673 /* Add extended switch element. */
674 memset(&switchElem, 0, sizeof(switchElem));
675 switchElem.tag = SFLFLOW_EX_SWITCH;
676 switchElem.flowType.sw.src_vlan = vlan_tci_to_vid(flow->vlan_tci);
677 switchElem.flowType.sw.src_priority = vlan_tci_to_pcp(flow->vlan_tci);
679 /* Retrieve data from user_action_cookie. */
680 vlan_tci = cookie->sflow.vlan_tci;
681 switchElem.flowType.sw.dst_vlan = vlan_tci_to_vid(vlan_tci);
682 switchElem.flowType.sw.dst_priority = vlan_tci_to_pcp(vlan_tci);
684 fs.output = cookie->sflow.output;
686 /* Submit the flow sample to be encoded into the next datagram. */
687 SFLADD_ELEMENT(&fs, &hdrElem);
688 SFLADD_ELEMENT(&fs, &switchElem);
689 sfl_sampler_writeFlowSample(sampler, &fs);
692 ovs_mutex_unlock(&mutex);
696 dpif_sflow_run(struct dpif_sflow *ds) OVS_EXCLUDED(mutex)
698 ovs_mutex_lock(&mutex);
699 if (ds->collectors != NULL) {
700 time_t now = time_now();
702 if (now >= ds->next_tick) {
703 sfl_agent_tick(ds->sflow_agent, time_wall());
704 ds->next_tick = now + 1;
707 ovs_mutex_unlock(&mutex);
711 dpif_sflow_wait(struct dpif_sflow *ds) OVS_EXCLUDED(mutex)
713 ovs_mutex_lock(&mutex);
714 if (ds->collectors != NULL) {
715 poll_timer_wait_until(ds->next_tick * 1000LL);
717 ovs_mutex_unlock(&mutex);