2 * Copyright (c) 2009, 2010 Nicira Networks.
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-sflow.h"
22 #include "collectors.h"
32 #include "poll-loop.h"
33 #include "sflow_api.h"
34 #include "socket-util.h"
38 VLOG_DEFINE_THIS_MODULE(sflow);
40 struct ofproto_sflow_port {
41 struct hmap_node hmap_node; /* In struct ofproto_sflow's "ports" hmap. */
42 struct netdev *netdev; /* Underlying network device, for stats. */
43 SFLDataSource_instance dsi; /* sFlow library's notion of port number. */
44 uint16_t odp_port; /* ODP port number. */
47 struct ofproto_sflow {
48 struct ofproto *ofproto;
49 struct collectors *collectors;
50 SFLAgent *sflow_agent;
51 struct ofproto_sflow_options *options;
54 size_t n_flood, n_all;
55 struct hmap ports; /* Contains "struct ofproto_sflow_port"s. */
58 static void ofproto_sflow_del_port__(struct ofproto_sflow *,
59 struct ofproto_sflow_port *);
61 #define RECEIVER_INDEX 1
63 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
66 nullable_string_is_equal(const char *a, const char *b)
68 return a ? b && !strcmp(a, b) : !b;
72 ofproto_sflow_options_equal(const struct ofproto_sflow_options *a,
73 const struct ofproto_sflow_options *b)
75 return (svec_equal(&a->targets, &b->targets)
76 && a->sampling_rate == b->sampling_rate
77 && a->polling_interval == b->polling_interval
78 && a->header_len == b->header_len
79 && a->sub_id == b->sub_id
80 && nullable_string_is_equal(a->agent_device, b->agent_device)
81 && nullable_string_is_equal(a->control_ip, b->control_ip));
84 static struct ofproto_sflow_options *
85 ofproto_sflow_options_clone(const struct ofproto_sflow_options *old)
87 struct ofproto_sflow_options *new = xmemdup(old, sizeof *old);
88 svec_clone(&new->targets, &old->targets);
89 new->agent_device = old->agent_device ? xstrdup(old->agent_device) : NULL;
90 new->control_ip = old->control_ip ? xstrdup(old->control_ip) : NULL;
95 ofproto_sflow_options_destroy(struct ofproto_sflow_options *options)
98 svec_destroy(&options->targets);
99 free(options->agent_device);
100 free(options->control_ip);
105 /* sFlow library callback to allocate memory. */
107 sflow_agent_alloc_cb(void *magic OVS_UNUSED, SFLAgent *agent OVS_UNUSED,
110 return calloc(1, bytes);
113 /* sFlow library callback to free memory. */
115 sflow_agent_free_cb(void *magic OVS_UNUSED, SFLAgent *agent OVS_UNUSED,
122 /* sFlow library callback to report error. */
124 sflow_agent_error_cb(void *magic OVS_UNUSED, SFLAgent *agent OVS_UNUSED,
127 VLOG_WARN("sFlow agent error: %s", msg);
130 /* sFlow library callback to send datagram. */
132 sflow_agent_send_packet_cb(void *os_, SFLAgent *agent OVS_UNUSED,
133 SFLReceiver *receiver OVS_UNUSED, u_char *pkt,
136 struct ofproto_sflow *os = os_;
137 collectors_send(os->collectors, pkt, pktLen);
140 static struct ofproto_sflow_port *
141 ofproto_sflow_find_port(const struct ofproto_sflow *os, uint16_t odp_port)
143 struct ofproto_sflow_port *osp;
145 HMAP_FOR_EACH_IN_BUCKET (osp, hmap_node,
146 hash_int(odp_port, 0), &os->ports) {
147 if (osp->odp_port == odp_port) {
155 sflow_agent_get_counters(void *os_, SFLPoller *poller,
156 SFL_COUNTERS_SAMPLE_TYPE *cs)
158 struct ofproto_sflow *os = os_;
159 SFLCounters_sample_element elem;
160 struct ofproto_sflow_port *osp;
161 SFLIf_counters *counters;
162 struct netdev_stats stats;
163 enum netdev_flags flags;
166 osp = ofproto_sflow_find_port(os, poller->bridgePort);
171 elem.tag = SFLCOUNTERS_GENERIC;
172 counters = &elem.counterBlock.generic;
173 counters->ifIndex = SFL_DS_INDEX(poller->dsi);
174 counters->ifType = 6;
175 if (!netdev_get_features(osp->netdev, ¤t, NULL, NULL, NULL)) {
176 /* The values of ifDirection come from MAU MIB (RFC 2668): 0 = unknown,
177 1 = full-duplex, 2 = half-duplex, 3 = in, 4=out */
178 counters->ifSpeed = netdev_features_to_bps(current);
179 counters->ifDirection = (netdev_features_is_full_duplex(current)
182 counters->ifSpeed = 100000000;
183 counters->ifDirection = 0;
185 if (!netdev_get_flags(osp->netdev, &flags) && flags & NETDEV_UP) {
186 counters->ifStatus = 1; /* ifAdminStatus up. */
187 if (netdev_get_carrier(osp->netdev)) {
188 counters->ifStatus |= 2; /* ifOperStatus us. */
191 counters->ifStatus = 0; /* Down. */
195 1. Is the multicast counter filled in?
196 2. Does the multicast counter include broadcasts?
197 3. Does the rx_packets counter include multicasts/broadcasts?
199 netdev_get_stats(osp->netdev, &stats);
200 counters->ifInOctets = stats.rx_bytes;
201 counters->ifInUcastPkts = stats.rx_packets;
202 counters->ifInMulticastPkts = stats.multicast;
203 counters->ifInBroadcastPkts = -1;
204 counters->ifInDiscards = stats.rx_dropped;
205 counters->ifInErrors = stats.rx_errors;
206 counters->ifInUnknownProtos = -1;
207 counters->ifOutOctets = stats.tx_bytes;
208 counters->ifOutUcastPkts = stats.tx_packets;
209 counters->ifOutMulticastPkts = -1;
210 counters->ifOutBroadcastPkts = -1;
211 counters->ifOutDiscards = stats.tx_dropped;
212 counters->ifOutErrors = stats.tx_errors;
213 counters->ifPromiscuousMode = 0;
215 SFLADD_ELEMENT(cs, &elem);
216 sfl_poller_writeCountersSample(poller, cs);
219 /* Obtains an address to use for the local sFlow agent and stores it into
220 * '*agent_addr'. Returns true if successful, false on failure.
222 * The sFlow agent address should be a local IP address that is persistent and
223 * reachable over the network, if possible. The IP address associated with
224 * 'agent_device' is used if it has one, and otherwise 'control_ip', the IP
225 * address used to talk to the controller. */
227 sflow_choose_agent_address(const char *agent_device, const char *control_ip,
228 SFLAddress *agent_addr)
232 memset(agent_addr, 0, sizeof *agent_addr);
233 agent_addr->type = SFLADDRESSTYPE_IP_V4;
236 struct netdev *netdev;
238 if (!netdev_open_default(agent_device, &netdev)) {
239 int error = netdev_get_in4(netdev, &in4, NULL);
240 netdev_close(netdev);
247 if (control_ip && !lookup_ip(control_ip, &in4)) {
251 VLOG_ERR("could not determine IP address for sFlow agent");
255 agent_addr->address.ip_v4.addr = in4.s_addr;
260 ofproto_sflow_clear(struct ofproto_sflow *os)
262 if (os->sflow_agent) {
263 sfl_agent_release(os->sflow_agent);
264 os->sflow_agent = NULL;
266 collectors_destroy(os->collectors);
267 os->collectors = NULL;
268 ofproto_sflow_options_destroy(os->options);
271 /* Turn off sampling to save CPU cycles. */
272 dpif_set_sflow_probability(os->dpif, 0);
276 ofproto_sflow_is_enabled(const struct ofproto_sflow *os)
278 return os->collectors != NULL;
281 struct ofproto_sflow *
282 ofproto_sflow_create(struct dpif *dpif)
284 struct ofproto_sflow *os;
286 os = xcalloc(1, sizeof *os);
288 os->next_tick = time_now() + 1;
289 hmap_init(&os->ports);
294 ofproto_sflow_destroy(struct ofproto_sflow *os)
297 struct ofproto_sflow_port *osp, *next;
299 ofproto_sflow_clear(os);
300 HMAP_FOR_EACH_SAFE (osp, next, hmap_node, &os->ports) {
301 ofproto_sflow_del_port__(os, osp);
303 hmap_destroy(&os->ports);
309 ofproto_sflow_add_poller(struct ofproto_sflow *os,
310 struct ofproto_sflow_port *osp, uint16_t odp_port)
312 SFLPoller *poller = sfl_agent_addPoller(os->sflow_agent, &osp->dsi, os,
313 sflow_agent_get_counters);
314 sfl_poller_set_sFlowCpInterval(poller, os->options->polling_interval);
315 sfl_poller_set_sFlowCpReceiver(poller, RECEIVER_INDEX);
316 sfl_poller_set_bridgePort(poller, odp_port);
320 ofproto_sflow_add_sampler(struct ofproto_sflow *os,
321 struct ofproto_sflow_port *osp)
323 SFLSampler *sampler = sfl_agent_addSampler(os->sflow_agent, &osp->dsi);
324 sfl_sampler_set_sFlowFsPacketSamplingRate(sampler, os->options->sampling_rate);
325 sfl_sampler_set_sFlowFsMaximumHeaderSize(sampler, os->options->header_len);
326 sfl_sampler_set_sFlowFsReceiver(sampler, RECEIVER_INDEX);
330 ofproto_sflow_add_port(struct ofproto_sflow *os, uint16_t odp_port,
331 const char *netdev_name)
333 struct ofproto_sflow_port *osp;
334 struct netdev *netdev;
338 ofproto_sflow_del_port(os, odp_port);
340 /* Open network device. */
341 error = netdev_open_default(netdev_name, &netdev);
343 VLOG_WARN_RL(&rl, "failed to open network device \"%s\": %s",
344 netdev_name, strerror(error));
348 /* Add to table of ports. */
349 osp = xmalloc(sizeof *osp);
350 osp->netdev = netdev;
351 ifindex = netdev_get_ifindex(netdev);
353 ifindex = (os->sflow_agent->subId << 16) + odp_port;
355 SFL_DS_SET(osp->dsi, 0, ifindex, 0);
356 osp->odp_port = odp_port;
357 hmap_insert(&os->ports, &osp->hmap_node, hash_int(odp_port, 0));
359 /* Add poller and sampler. */
360 if (os->sflow_agent) {
361 ofproto_sflow_add_poller(os, osp, odp_port);
362 ofproto_sflow_add_sampler(os, osp);
367 ofproto_sflow_del_port__(struct ofproto_sflow *os,
368 struct ofproto_sflow_port *osp)
370 if (os->sflow_agent) {
371 sfl_agent_removePoller(os->sflow_agent, &osp->dsi);
372 sfl_agent_removeSampler(os->sflow_agent, &osp->dsi);
374 netdev_close(osp->netdev);
375 hmap_remove(&os->ports, &osp->hmap_node);
380 ofproto_sflow_del_port(struct ofproto_sflow *os, uint16_t odp_port)
382 struct ofproto_sflow_port *osp = ofproto_sflow_find_port(os, odp_port);
384 ofproto_sflow_del_port__(os, osp);
389 ofproto_sflow_set_options(struct ofproto_sflow *os,
390 const struct ofproto_sflow_options *options)
392 struct ofproto_sflow_port *osp;
393 bool options_changed;
394 SFLReceiver *receiver;
398 if (!options->targets.n || !options->sampling_rate) {
399 /* No point in doing any work if there are no targets or nothing to
401 ofproto_sflow_clear(os);
405 options_changed = (!os->options
406 || !ofproto_sflow_options_equal(options, os->options));
408 /* Configure collectors if options have changed or if we're shortchanged in
409 * collectors (which indicates that opening one or more of the configured
410 * collectors failed, so that we should retry). */
412 || collectors_count(os->collectors) < options->targets.n) {
413 collectors_destroy(os->collectors);
414 collectors_create(&options->targets, SFL_DEFAULT_COLLECTOR_PORT,
416 if (os->collectors == NULL) {
417 VLOG_WARN_RL(&rl, "no collectors could be initialized, "
419 ofproto_sflow_clear(os);
424 /* Avoid reconfiguring if options didn't change. */
425 if (!options_changed) {
428 ofproto_sflow_options_destroy(os->options);
429 os->options = ofproto_sflow_options_clone(options);
431 /* Choose agent IP address. */
432 if (!sflow_choose_agent_address(options->agent_device,
433 options->control_ip, &agentIP)) {
434 ofproto_sflow_clear(os);
439 VLOG_INFO("creating sFlow agent %d", options->sub_id);
440 if (os->sflow_agent) {
441 sfl_agent_release(os->sflow_agent);
443 os->sflow_agent = xcalloc(1, sizeof *os->sflow_agent);
445 sfl_agent_init(os->sflow_agent,
448 now, /* Boot time. */
449 now, /* Current time. */
450 os, /* Pointer supplied to callbacks. */
451 sflow_agent_alloc_cb,
453 sflow_agent_error_cb,
454 sflow_agent_send_packet_cb);
456 receiver = sfl_agent_addReceiver(os->sflow_agent);
457 sfl_receiver_set_sFlowRcvrOwner(receiver, "Open vSwitch sFlow");
458 sfl_receiver_set_sFlowRcvrTimeout(receiver, 0xffffffff);
460 /* Set the sampling_rate down in the datapath. */
461 dpif_set_sflow_probability(os->dpif,
462 MAX(1, UINT32_MAX / options->sampling_rate));
464 /* Add samplers and pollers for the currently known ports. */
465 HMAP_FOR_EACH (osp, hmap_node, &os->ports) {
466 ofproto_sflow_add_poller(os, osp, osp->odp_port);
467 ofproto_sflow_add_sampler(os, osp);
472 ofproto_sflow_odp_port_to_ifindex(const struct ofproto_sflow *os,
475 struct ofproto_sflow_port *osp = ofproto_sflow_find_port(os, odp_port);
476 return osp ? SFL_DS_INDEX(osp->dsi) : 0;
480 ofproto_sflow_received(struct ofproto_sflow *os, struct odp_msg *msg)
482 SFL_FLOW_SAMPLE_TYPE fs;
483 SFLFlow_sample_element hdrElem;
484 SFLSampled_header *header;
485 SFLFlow_sample_element switchElem;
487 const struct odp_sflow_sample_header *hdr;
488 const struct nlattr *actions, *a;
494 /* Pull odp_msg header. */
495 ofpbuf_use_const(&b, msg, msg->length);
496 ofpbuf_pull(&b, sizeof *msg);
498 /* Pull odp_sflow_sample_header. */
499 hdr = ofpbuf_try_pull(&b, sizeof *hdr);
501 VLOG_WARN_RL(&rl, "missing odp_sflow_sample_header");
506 actions = ofpbuf_try_pull(&b, hdr->actions_len);
508 VLOG_WARN_RL(&rl, "missing odp actions");
512 /* Now only the payload is left. */
513 flow_extract(&b, 0, msg->port, &flow);
515 /* Build a flow sample */
516 memset(&fs, 0, sizeof fs);
517 fs.input = ofproto_sflow_odp_port_to_ifindex(os, msg->port);
518 fs.output = 0; /* Filled in correctly below. */
519 fs.sample_pool = hdr->sample_pool;
521 /* We are going to give it to the sampler that represents this input port.
522 * By implementing "ingress-only" sampling like this we ensure that we
523 * never have to offer the same sample to more than one sampler. */
524 sampler = sfl_agent_getSamplerByIfIndex(os->sflow_agent, fs.input);
526 VLOG_WARN_RL(&rl, "no sampler for input ifIndex (%"PRIu32")",
531 /* Sampled header. */
532 memset(&hdrElem, 0, sizeof hdrElem);
533 hdrElem.tag = SFLFLOW_HEADER;
534 header = &hdrElem.flowType.header;
535 header->header_protocol = SFLHEADER_ETHERNET_ISO8023;
536 /* The frame_length should include the Ethernet FCS (4 bytes),
537 but it has already been stripped, so we need to add 4 here. */
538 header->frame_length = b.size + 4;
539 /* Ethernet FCS stripped off. */
540 header->stripped = 4;
541 header->header_length = MIN(b.size, sampler->sFlowFsMaximumHeaderSize);
542 header->header_bytes = b.data;
544 /* Add extended switch element. */
545 memset(&switchElem, 0, sizeof(switchElem));
546 switchElem.tag = SFLFLOW_EX_SWITCH;
547 switchElem.flowType.sw.src_vlan = vlan_tci_to_vid(flow.vlan_tci);
548 switchElem.flowType.sw.src_priority = vlan_tci_to_pcp(flow.vlan_tci);
549 /* Initialize the output VLAN and priority to be the same as the input,
550 but these fields can be overriden below if affected by an action. */
551 switchElem.flowType.sw.dst_vlan = switchElem.flowType.sw.src_vlan;
552 switchElem.flowType.sw.dst_priority = switchElem.flowType.sw.src_priority;
554 /* Figure out the output ports. */
556 NL_ATTR_FOR_EACH_UNSAFE (a, left, actions, hdr->actions_len) {
559 switch (nl_attr_type(a)) {
561 fs.output = ofproto_sflow_odp_port_to_ifindex(os,
566 case ODPAT_SET_DL_TCI:
567 tci = nl_attr_get_be16(a);
568 switchElem.flowType.sw.dst_vlan = vlan_tci_to_vid(tci);
569 switchElem.flowType.sw.dst_priority = vlan_tci_to_pcp(tci);
577 /* Set output port, as defined by http://www.sflow.org/sflow_version_5.txt
578 (search for "Input/output port information"). */
580 /* This value indicates that the packet was dropped for an unknown
582 fs.output = 0x40000000 | 256;
583 } else if (n_outputs > 1 || !fs.output) {
584 /* Setting the high bit means "multiple output ports". */
585 fs.output = 0x80000000 | n_outputs;
588 /* Submit the flow sample to be encoded into the next datagram. */
589 SFLADD_ELEMENT(&fs, &hdrElem);
590 SFLADD_ELEMENT(&fs, &switchElem);
591 sfl_sampler_writeFlowSample(sampler, &fs);
595 ofproto_sflow_run(struct ofproto_sflow *os)
597 if (ofproto_sflow_is_enabled(os)) {
598 time_t now = time_now();
599 if (now >= os->next_tick) {
600 sfl_agent_tick(os->sflow_agent, time_wall());
601 os->next_tick = now + 1;
607 ofproto_sflow_wait(struct ofproto_sflow *os)
609 if (ofproto_sflow_is_enabled(os)) {
610 poll_timer_wait_until(os->next_tick * 1000LL);