2 * Copyright (c) 2009, 2010 InMon Corp.
3 * Copyright (c) 2009 Nicira Networks.
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"
28 #include "poll-loop.h"
29 #include "port-array.h"
30 #include "sflow_api.h"
31 #include "socket-util.h"
34 #define THIS_MODULE VLM_sflow
37 struct ofproto_sflow_port {
38 struct netdev *netdev; /* Underlying network device, for stats. */
39 SFLDataSource_instance dsi; /* sFlow library's notion of port number. */
42 struct ofproto_sflow {
43 struct ofproto *ofproto;
44 struct collectors *collectors;
45 SFLAgent *sflow_agent;
46 struct ofproto_sflow_options *options;
49 size_t n_flood, n_all;
50 struct port_array ports; /* Indexed by ODP port number. */
53 #define RECEIVER_INDEX 1
55 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
58 nullable_string_is_equal(const char *a, const char *b)
60 return a ? b && !strcmp(a, b) : !b;
64 ofproto_sflow_options_equal(const struct ofproto_sflow_options *a,
65 const struct ofproto_sflow_options *b)
67 return (svec_equal(&a->targets, &b->targets)
68 && a->sampling_rate == b->sampling_rate
69 && a->polling_interval == b->polling_interval
70 && a->header_len == b->header_len
71 && a->sub_id == b->sub_id
72 && nullable_string_is_equal(a->agent_device, b->agent_device)
73 && nullable_string_is_equal(a->control_ip, b->control_ip));
76 static struct ofproto_sflow_options *
77 ofproto_sflow_options_clone(const struct ofproto_sflow_options *old)
79 struct ofproto_sflow_options *new = xmemdup(old, sizeof *old);
80 svec_clone(&new->targets, &old->targets);
81 new->agent_device = old->agent_device ? xstrdup(old->agent_device) : NULL;
82 new->control_ip = old->control_ip ? xstrdup(old->control_ip) : NULL;
87 ofproto_sflow_options_destroy(struct ofproto_sflow_options *options)
90 svec_destroy(&options->targets);
91 free(options->agent_device);
92 free(options->control_ip);
97 /* sFlow library callback to allocate memory. */
99 sflow_agent_alloc_cb(void *magic UNUSED, SFLAgent *agent UNUSED, size_t bytes)
101 return calloc(1, bytes);
104 /* sFlow library callback to free memory. */
106 sflow_agent_free_cb(void *magic UNUSED, SFLAgent *agent UNUSED, void *obj)
112 /* sFlow library callback to report error. */
114 sflow_agent_error_cb(void *magic UNUSED, SFLAgent *agent UNUSED, char *msg)
116 VLOG_WARN("sFlow agent error: %s", msg);
119 /* sFlow library callback to send datagram. */
121 sflow_agent_send_packet_cb(void *os_, SFLAgent *agent UNUSED,
122 SFLReceiver *receiver UNUSED, u_char *pkt,
125 struct ofproto_sflow *os = os_;
126 collectors_send(os->collectors, pkt, pktLen);
130 sflow_agent_get_counters(void *os_, SFLPoller *poller,
131 SFL_COUNTERS_SAMPLE_TYPE *cs)
133 struct ofproto_sflow *os = os_;
134 SFLCounters_sample_element elem;
135 struct ofproto_sflow_port *osp;
136 SFLIf_counters *counters;
137 struct netdev_stats stats;
138 enum netdev_flags flags;
141 osp = port_array_get(&os->ports, poller->bridgePort);
146 elem.tag = SFLCOUNTERS_GENERIC;
147 counters = &elem.counterBlock.generic;
148 counters->ifIndex = SFL_DS_INDEX(poller->dsi);
149 counters->ifType = 6;
150 if (!netdev_get_features(osp->netdev, ¤t, NULL, NULL, NULL)) {
151 /* The values of ifDirection come from MAU MIB (RFC 2668): 0 = unknown,
152 1 = full-duplex, 2 = half-duplex, 3 = in, 4=out */
153 counters->ifSpeed = netdev_features_to_bps(current);
154 counters->ifDirection = (netdev_features_is_full_duplex(current)
157 counters->ifSpeed = 100000000;
158 counters->ifDirection = 0;
160 if (!netdev_get_flags(osp->netdev, &flags) && flags & NETDEV_UP) {
163 counters->ifStatus = 1; /* ifAdminStatus up. */
164 if (!netdev_get_carrier(osp->netdev, &carrier) && carrier) {
165 counters->ifStatus |= 2; /* ifOperStatus us. */
168 counters->ifStatus = 0; /* Down. */
172 1. Is the multicast counter filled in?
173 2. Does the multicast counter include broadcasts?
174 3. Does the rx_packets counter include multicasts/broadcasts?
176 netdev_get_stats(osp->netdev, &stats);
177 counters->ifInOctets = stats.rx_bytes;
178 counters->ifInUcastPkts = stats.rx_packets;
179 counters->ifInMulticastPkts = stats.multicast;
180 counters->ifInBroadcastPkts = -1;
181 counters->ifInDiscards = stats.rx_dropped;
182 counters->ifInErrors = stats.rx_errors;
183 counters->ifInUnknownProtos = -1;
184 counters->ifOutOctets = stats.tx_bytes;
185 counters->ifOutUcastPkts = stats.tx_packets;
186 counters->ifOutMulticastPkts = -1;
187 counters->ifOutBroadcastPkts = -1;
188 counters->ifOutDiscards = stats.tx_dropped;
189 counters->ifOutErrors = stats.tx_errors;
190 counters->ifPromiscuousMode = 0;
192 SFLADD_ELEMENT(cs, &elem);
193 sfl_poller_writeCountersSample(poller, cs);
196 /* Obtains an address to use for the local sFlow agent and stores it into
197 * '*agent_addr'. Returns true if successful, false on failure.
199 * The sFlow agent address should be a local IP address that is persistent and
200 * reachable over the network, if possible. The IP address associated with
201 * 'agent_device' is used if it has one, and otherwise 'control_ip', the IP
202 * address used to talk to the controller. */
204 sflow_choose_agent_address(const char *agent_device, const char *control_ip,
205 SFLAddress *agent_addr)
209 memset(agent_addr, 0, sizeof *agent_addr);
210 agent_addr->type = SFLADDRESSTYPE_IP_V4;
213 struct netdev *netdev;
215 if (!netdev_open(agent_device, NETDEV_ETH_TYPE_NONE, &netdev)) {
216 int error = netdev_get_in4(netdev, &in4, NULL);
217 netdev_close(netdev);
224 if (control_ip && !lookup_ip(control_ip, &in4)) {
228 VLOG_ERR("could not determine IP address for sFlow agent");
232 agent_addr->address.ip_v4.addr = in4.s_addr;
237 ofproto_sflow_clear(struct ofproto_sflow *os)
239 struct ofproto_sflow_port *osp;
240 unsigned int odp_port;
242 if (os->sflow_agent) {
243 sfl_agent_release(os->sflow_agent);
244 os->sflow_agent = NULL;
246 collectors_destroy(os->collectors);
247 os->collectors = NULL;
248 ofproto_sflow_options_destroy(os->options);
251 PORT_ARRAY_FOR_EACH (osp, &os->ports, odp_port) {
252 ofproto_sflow_del_port(os, odp_port);
254 port_array_clear(&os->ports);
256 /* Turn off sampling to save CPU cycles. */
257 dpif_set_sflow_probability(os->dpif, 0);
261 ofproto_sflow_is_enabled(const struct ofproto_sflow *os)
263 return os->collectors != NULL;
266 struct ofproto_sflow *
267 ofproto_sflow_create(struct dpif *dpif)
269 struct ofproto_sflow *os;
271 os = xcalloc(1, sizeof *os);
273 os->next_tick = time_now() + 1;
274 port_array_init(&os->ports);
279 ofproto_sflow_destroy(struct ofproto_sflow *os)
282 ofproto_sflow_clear(os);
283 port_array_destroy(&os->ports);
289 ofproto_sflow_add_poller(struct ofproto_sflow *os,
290 struct ofproto_sflow_port *osp, uint16_t odp_port)
292 SFLPoller *poller = sfl_agent_addPoller(os->sflow_agent, &osp->dsi, os,
293 sflow_agent_get_counters);
294 sfl_poller_set_sFlowCpInterval(poller, os->options->polling_interval);
295 sfl_poller_set_sFlowCpReceiver(poller, RECEIVER_INDEX);
296 sfl_poller_set_bridgePort(poller, odp_port);
300 ofproto_sflow_add_port(struct ofproto_sflow *os, uint16_t odp_port,
301 const char *netdev_name)
303 struct ofproto_sflow_port *osp;
304 struct netdev *netdev;
308 ofproto_sflow_del_port(os, odp_port);
310 /* Open network device. */
311 error = netdev_open(netdev_name, NETDEV_ETH_TYPE_NONE, &netdev);
313 VLOG_WARN_RL(&rl, "failed to open network device \"%s\": %s",
314 netdev_name, strerror(error));
318 /* Add to table of ports. */
319 osp = xmalloc(sizeof *osp);
320 osp->netdev = netdev;
321 ifindex = netdev_get_ifindex(netdev);
323 ifindex = (os->sflow_agent->subId << 16) + odp_port;
325 SFL_DS_SET(osp->dsi, 0, ifindex, 0);
326 port_array_set(&os->ports, odp_port, osp);
329 if (os->sflow_agent) {
330 ofproto_sflow_add_poller(os, osp, odp_port);
335 ofproto_sflow_del_port(struct ofproto_sflow *os, uint16_t odp_port)
337 struct ofproto_sflow_port *osp = port_array_get(&os->ports, odp_port);
339 if (os->sflow_agent) {
340 sfl_agent_removePoller(os->sflow_agent, &osp->dsi);
342 netdev_close(osp->netdev);
344 port_array_set(&os->ports, odp_port, NULL);
349 ofproto_sflow_set_options(struct ofproto_sflow *os,
350 const struct ofproto_sflow_options *options)
352 struct ofproto_sflow_port *osp;
353 SFLDataSource_instance dsi;
354 bool options_changed;
356 SFLReceiver *receiver;
357 unsigned int odp_port;
362 if (!options->targets.n || !options->sampling_rate) {
363 /* No point in doing any work if there are no targets or nothing to
365 ofproto_sflow_clear(os);
369 options_changed = (!os->options
370 || !ofproto_sflow_options_equal(options, os->options));
372 /* Configure collectors if options have changed or if we're shortchanged in
373 * collectors (which indicates that opening one or more of the configured
374 * collectors failed, so that we should retry). */
376 || collectors_count(os->collectors) < options->targets.n) {
377 collectors_destroy(os->collectors);
378 error = collectors_create(&options->targets,
379 SFL_DEFAULT_COLLECTOR_PORT, &os->collectors);
380 if (os->collectors == NULL) {
381 VLOG_WARN_RL(&rl, "no collectors could be initialized, "
383 ofproto_sflow_clear(os);
388 /* Avoid reconfiguring if options didn't change. */
389 if (!options_changed) {
392 ofproto_sflow_options_destroy(os->options);
393 os->options = ofproto_sflow_options_clone(options);
395 /* Choose agent IP address. */
396 if (!sflow_choose_agent_address(options->agent_device,
397 options->control_ip, &agentIP)) {
398 ofproto_sflow_clear(os);
403 VLOG_INFO("creating sFlow agent %d", options->sub_id);
404 if (os->sflow_agent) {
405 sfl_agent_release(os->sflow_agent);
407 os->sflow_agent = xcalloc(1, sizeof *os->sflow_agent);
409 sfl_agent_init(os->sflow_agent,
412 now, /* Boot time. */
413 now, /* Current time. */
414 os, /* Pointer supplied to callbacks. */
415 sflow_agent_alloc_cb,
417 sflow_agent_error_cb,
418 sflow_agent_send_packet_cb);
420 receiver = sfl_agent_addReceiver(os->sflow_agent);
421 sfl_receiver_set_sFlowRcvrOwner(receiver, "Open vSwitch sFlow");
422 sfl_receiver_set_sFlowRcvrTimeout(receiver, 0xffffffff);
424 /* Add a single sampler to represent the datapath (special <ifIndex>:0
425 * datasource). The alternative is to model a physical switch more closely
426 * and instantiate a separate sampler object for each interface, but then
427 * unicasts would have to be offered to two samplers, and
428 * broadcasts/multicasts would have to be offered to all of them. Doing it
429 * this way with a single <ifindex>:0 sampler is much more efficient for a
430 * virtual switch, and is allowed by the sFlow standard.
432 SFL_DS_SET(dsi, 0, 0, 0);
433 sampler = sfl_agent_addSampler(os->sflow_agent, &dsi);
434 sfl_sampler_set_sFlowFsReceiver(sampler, RECEIVER_INDEX);
435 sfl_sampler_set_sFlowFsPacketSamplingRate(sampler, options->sampling_rate);
436 sfl_sampler_set_sFlowFsMaximumHeaderSize(sampler, options->header_len);
438 /* Set the sampling_rate down in the datapath. */
439 dpif_set_sflow_probability(os->dpif,
440 MAX(1, UINT32_MAX / options->sampling_rate));
442 /* Add the currently known ports. */
443 PORT_ARRAY_FOR_EACH (osp, &os->ports, odp_port) {
444 ofproto_sflow_add_poller(os, osp, odp_port);
449 ofproto_sflow_odp_port_to_ifindex(const struct ofproto_sflow *os,
452 struct ofproto_sflow_port *osp = port_array_get(&os->ports, odp_port);
453 return osp ? SFL_DS_INDEX(osp->dsi) : 0;
457 ofproto_sflow_received(struct ofproto_sflow *os, struct odp_msg *msg)
459 SFL_FLOW_SAMPLE_TYPE fs;
460 SFLFlow_sample_element hdrElem;
461 SFLSampled_header *header;
462 SFLFlow_sample_element switchElem;
463 SFLSampler *sampler = os->sflow_agent->samplers;
464 const struct odp_sflow_sample_header *hdr;
465 const union odp_action *actions;
466 struct ofpbuf payload;
467 size_t n_actions, n_outputs;
472 /* Get odp_sflow_sample_header. */
473 min_size = sizeof *msg + sizeof *hdr;
474 if (min_size > msg->length) {
475 VLOG_WARN_RL(&rl, "sFlow packet too small (%"PRIu32" < %zu)",
476 msg->length, min_size);
479 hdr = (const struct odp_sflow_sample_header *) (msg + 1);
482 n_actions = hdr->n_actions;
483 if (n_actions > 65536 / sizeof *actions) {
484 VLOG_WARN_RL(&rl, "too many actions in sFlow packet (%zu > %zu)",
485 65536 / sizeof *actions, n_actions);
488 min_size += n_actions * sizeof *actions;
489 if (min_size > msg->length) {
490 VLOG_WARN_RL(&rl, "sFlow packet with %zu actions too small "
492 n_actions, msg->length, min_size);
495 actions = (const union odp_action *) (hdr + 1);
497 /* Get packet payload and extract flow. */
498 payload.data = (union odp_action *) (actions + n_actions);
499 payload.size = msg->length - min_size;
500 flow_extract(&payload, msg->port, &flow);
502 /* Build a flow sample */
503 memset(&fs, 0, sizeof fs);
504 fs.input = ofproto_sflow_odp_port_to_ifindex(os, msg->port);
505 fs.output = 0; /* Filled in correctly below. */
506 fs.sample_pool = hdr->sample_pool;
508 /* Sampled header. */
509 memset(&hdrElem, 0, sizeof hdrElem);
510 hdrElem.tag = SFLFLOW_HEADER;
511 header = &hdrElem.flowType.header;
512 header->header_protocol = SFLHEADER_ETHERNET_ISO8023;
513 header->frame_length = payload.size;
514 header->stripped = 4; /* Ethernet FCS stripped off. */
515 header->header_length = MIN(payload.size,
516 sampler->sFlowFsMaximumHeaderSize);
517 header->header_bytes = payload.data;
519 /* Add extended switch element. */
520 memset(&switchElem, 0, sizeof(switchElem));
521 switchElem.tag = SFLFLOW_EX_SWITCH;
522 switchElem.flowType.sw.src_vlan = ntohs(flow.dl_vlan);
523 switchElem.flowType.sw.src_priority = -1; /* XXX */
524 switchElem.flowType.sw.dst_vlan = -1; /* Filled in correctly below. */
525 switchElem.flowType.sw.dst_priority = switchElem.flowType.sw.src_priority;
527 /* Figure out the output ports. */
529 for (i = 0; i < n_actions; i++) {
530 const union odp_action *a = &actions[i];
534 fs.output = ofproto_sflow_odp_port_to_ifindex(os, a->output.port);
538 case ODPAT_OUTPUT_GROUP:
539 n_outputs += (a->output_group.group == DP_GROUP_FLOOD ? os->n_flood
540 : a->output_group.group == DP_GROUP_ALL ? os->n_all
544 case ODPAT_SET_VLAN_VID:
545 switchElem.flowType.sw.dst_vlan = ntohs(a->vlan_vid.vlan_vid);
548 case ODPAT_SET_VLAN_PCP:
549 switchElem.flowType.sw.dst_priority = a->vlan_pcp.vlan_pcp;
557 /* Set output port, as defined by http://www.sflow.org/sflow_version_5.txt
558 (search for "Input/output port information"). */
560 /* This value indicates that the packet was dropped for an unknown
562 fs.output = 0x40000000 | 256;
563 } else if (n_outputs > 1 || !fs.output) {
564 /* Setting the high bit means "multiple output ports". */
565 fs.output = 0x80000000 | n_outputs;
568 /* Submit the flow sample to be encoded into the next datagram. */
569 SFLADD_ELEMENT(&fs, &hdrElem);
570 SFLADD_ELEMENT(&fs, &switchElem);
571 sfl_sampler_writeFlowSample(sampler, &fs);
575 ofproto_sflow_set_group_sizes(struct ofproto_sflow *os,
576 size_t n_flood, size_t n_all)
578 os->n_flood = n_flood;
583 ofproto_sflow_run(struct ofproto_sflow *os)
585 if (ofproto_sflow_is_enabled(os)) {
586 time_t now = time_now();
587 if (now >= os->next_tick) {
588 sfl_agent_tick(os->sflow_agent, now);
589 os->next_tick = now + 1;
595 ofproto_sflow_wait(struct ofproto_sflow *os)
597 if (ofproto_sflow_is_enabled(os)) {
598 poll_timer_wait(os->next_tick * 1000 - time_msec());