ofproto: Rename "private.h" to "ofproto->provider.h".
[openvswitch] / ofproto / ofproto-dpif-sflow.c
1 /*
2  * Copyright (c) 2009, 2010, 2011 Nicira Networks.
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 <stdlib.h>
22 #include "collectors.h"
23 #include "compiler.h"
24 #include "dpif.h"
25 #include "hash.h"
26 #include "hmap.h"
27 #include "netdev.h"
28 #include "netlink.h"
29 #include "ofpbuf.h"
30 #include "ofproto.h"
31 #include "packets.h"
32 #include "poll-loop.h"
33 #include "sflow_api.h"
34 #include "socket-util.h"
35 #include "timeval.h"
36 #include "vlog.h"
37
38 VLOG_DEFINE_THIS_MODULE(sflow);
39
40 struct dpif_sflow_port {
41     struct hmap_node hmap_node; /* In struct dpif_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. */
45 };
46
47 struct dpif_sflow {
48     struct ofproto *ofproto;
49     struct collectors *collectors;
50     SFLAgent *sflow_agent;
51     struct ofproto_sflow_options *options;
52     struct dpif *dpif;
53     time_t next_tick;
54     size_t n_flood, n_all;
55     struct hmap ports;          /* Contains "struct dpif_sflow_port"s. */
56 };
57
58 static void dpif_sflow_del_port__(struct dpif_sflow *,
59                                   struct dpif_sflow_port *);
60
61 #define RECEIVER_INDEX 1
62
63 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
64
65 static bool
66 nullable_string_is_equal(const char *a, const char *b)
67 {
68     return a ? b && !strcmp(a, b) : !b;
69 }
70
71 static bool
72 ofproto_sflow_options_equal(const struct ofproto_sflow_options *a,
73                          const struct ofproto_sflow_options *b)
74 {
75     return (sset_equals(&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));
82 }
83
84 static struct ofproto_sflow_options *
85 ofproto_sflow_options_clone(const struct ofproto_sflow_options *old)
86 {
87     struct ofproto_sflow_options *new = xmemdup(old, sizeof *old);
88     sset_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;
91     return new;
92 }
93
94 static void
95 ofproto_sflow_options_destroy(struct ofproto_sflow_options *options)
96 {
97     if (options) {
98         sset_destroy(&options->targets);
99         free(options->agent_device);
100         free(options->control_ip);
101         free(options);
102     }
103 }
104
105 /* sFlow library callback to allocate memory. */
106 static void *
107 sflow_agent_alloc_cb(void *magic OVS_UNUSED, SFLAgent *agent OVS_UNUSED,
108                      size_t bytes)
109 {
110     return calloc(1, bytes);
111 }
112
113 /* sFlow library callback to free memory. */
114 static int
115 sflow_agent_free_cb(void *magic OVS_UNUSED, SFLAgent *agent OVS_UNUSED,
116                     void *obj)
117 {
118     free(obj);
119     return 0;
120 }
121
122 /* sFlow library callback to report error. */
123 static void
124 sflow_agent_error_cb(void *magic OVS_UNUSED, SFLAgent *agent OVS_UNUSED,
125                      char *msg)
126 {
127     VLOG_WARN("sFlow agent error: %s", msg);
128 }
129
130 /* sFlow library callback to send datagram. */
131 static void
132 sflow_agent_send_packet_cb(void *ds_, SFLAgent *agent OVS_UNUSED,
133                            SFLReceiver *receiver OVS_UNUSED, u_char *pkt,
134                            uint32_t pktLen)
135 {
136     struct dpif_sflow *ds = ds_;
137     collectors_send(ds->collectors, pkt, pktLen);
138 }
139
140 static struct dpif_sflow_port *
141 dpif_sflow_find_port(const struct dpif_sflow *ds, uint16_t odp_port)
142 {
143     struct dpif_sflow_port *dsp;
144
145     HMAP_FOR_EACH_IN_BUCKET (dsp, hmap_node,
146                              hash_int(odp_port, 0), &ds->ports) {
147         if (dsp->odp_port == odp_port) {
148             return dsp;
149         }
150     }
151     return NULL;
152 }
153
154 static void
155 sflow_agent_get_counters(void *ds_, SFLPoller *poller,
156                          SFL_COUNTERS_SAMPLE_TYPE *cs)
157 {
158     struct dpif_sflow *ds = ds_;
159     SFLCounters_sample_element elem;
160     struct dpif_sflow_port *dsp;
161     SFLIf_counters *counters;
162     struct netdev_stats stats;
163     enum netdev_flags flags;
164     uint32_t current;
165
166     dsp = dpif_sflow_find_port(ds, poller->bridgePort);
167     if (!dsp) {
168         return;
169     }
170
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(dsp->netdev, &current, 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)
180                                  ? 1 : 2);
181     } else {
182         counters->ifSpeed = 100000000;
183         counters->ifDirection = 0;
184     }
185     if (!netdev_get_flags(dsp->netdev, &flags) && flags & NETDEV_UP) {
186         counters->ifStatus = 1; /* ifAdminStatus up. */
187         if (netdev_get_carrier(dsp->netdev)) {
188             counters->ifStatus |= 2; /* ifOperStatus us. */
189         }
190     } else {
191         counters->ifStatus = 0;  /* Down. */
192     }
193
194     /* XXX
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?
198     */
199     netdev_get_stats(dsp->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;
214
215     SFLADD_ELEMENT(cs, &elem);
216     sfl_poller_writeCountersSample(poller, cs);
217 }
218
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.
221  *
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. */
226 static bool
227 sflow_choose_agent_address(const char *agent_device, const char *control_ip,
228                            SFLAddress *agent_addr)
229 {
230     struct in_addr in4;
231
232     memset(agent_addr, 0, sizeof *agent_addr);
233     agent_addr->type = SFLADDRESSTYPE_IP_V4;
234
235     if (agent_device) {
236         struct netdev *netdev;
237
238         if (!netdev_open_default(agent_device, &netdev)) {
239             int error = netdev_get_in4(netdev, &in4, NULL);
240             netdev_close(netdev);
241             if (!error) {
242                 goto success;
243             }
244         }
245     }
246
247     if (control_ip && !lookup_ip(control_ip, &in4)) {
248         goto success;
249     }
250
251     VLOG_ERR("could not determine IP address for sFlow agent");
252     return false;
253
254 success:
255     agent_addr->address.ip_v4.addr = (OVS_FORCE uint32_t) in4.s_addr;
256     return true;
257 }
258
259 void
260 dpif_sflow_clear(struct dpif_sflow *ds)
261 {
262     if (ds->sflow_agent) {
263         sfl_agent_release(ds->sflow_agent);
264         ds->sflow_agent = NULL;
265     }
266     collectors_destroy(ds->collectors);
267     ds->collectors = NULL;
268     ofproto_sflow_options_destroy(ds->options);
269     ds->options = NULL;
270
271     /* Turn off sampling to save CPU cycles. */
272     dpif_set_sflow_probability(ds->dpif, 0);
273 }
274
275 bool
276 dpif_sflow_is_enabled(const struct dpif_sflow *ds)
277 {
278     return ds->collectors != NULL;
279 }
280
281 struct dpif_sflow *
282 dpif_sflow_create(struct dpif *dpif)
283 {
284     struct dpif_sflow *ds;
285
286     ds = xcalloc(1, sizeof *ds);
287     ds->dpif = dpif;
288     ds->next_tick = time_now() + 1;
289     hmap_init(&ds->ports);
290     return ds;
291 }
292
293 void
294 dpif_sflow_destroy(struct dpif_sflow *ds)
295 {
296     if (ds) {
297         struct dpif_sflow_port *dsp, *next;
298
299         dpif_sflow_clear(ds);
300         HMAP_FOR_EACH_SAFE (dsp, next, hmap_node, &ds->ports) {
301             dpif_sflow_del_port__(ds, dsp);
302         }
303         hmap_destroy(&ds->ports);
304         free(ds);
305     }
306 }
307
308 static void
309 dpif_sflow_add_poller(struct dpif_sflow *ds,
310                       struct dpif_sflow_port *dsp, uint16_t odp_port)
311 {
312     SFLPoller *poller = sfl_agent_addPoller(ds->sflow_agent, &dsp->dsi, ds,
313                                             sflow_agent_get_counters);
314     sfl_poller_set_sFlowCpInterval(poller, ds->options->polling_interval);
315     sfl_poller_set_sFlowCpReceiver(poller, RECEIVER_INDEX);
316     sfl_poller_set_bridgePort(poller, odp_port);
317 }
318
319 static void
320 dpif_sflow_add_sampler(struct dpif_sflow *ds, struct dpif_sflow_port *dsp)
321 {
322     SFLSampler *sampler = sfl_agent_addSampler(ds->sflow_agent, &dsp->dsi);
323     sfl_sampler_set_sFlowFsPacketSamplingRate(sampler, ds->options->sampling_rate);
324     sfl_sampler_set_sFlowFsMaximumHeaderSize(sampler, ds->options->header_len);
325     sfl_sampler_set_sFlowFsReceiver(sampler, RECEIVER_INDEX);
326 }
327
328 void
329 dpif_sflow_add_port(struct dpif_sflow *ds, uint16_t odp_port,
330                     const char *netdev_name)
331 {
332     struct dpif_sflow_port *dsp;
333     struct netdev *netdev;
334     uint32_t ifindex;
335     int error;
336
337     dpif_sflow_del_port(ds, odp_port);
338
339     /* Open network device. */
340     error = netdev_open_default(netdev_name, &netdev);
341     if (error) {
342         VLOG_WARN_RL(&rl, "failed to open network device \"%s\": %s",
343                      netdev_name, strerror(error));
344         return;
345     }
346
347     /* Add to table of ports. */
348     dsp = xmalloc(sizeof *dsp);
349     dsp->netdev = netdev;
350     ifindex = netdev_get_ifindex(netdev);
351     if (ifindex <= 0) {
352         ifindex = (ds->sflow_agent->subId << 16) + odp_port;
353     }
354     SFL_DS_SET(dsp->dsi, 0, ifindex, 0);
355     dsp->odp_port = odp_port;
356     hmap_insert(&ds->ports, &dsp->hmap_node, hash_int(odp_port, 0));
357
358     /* Add poller and sampler. */
359     if (ds->sflow_agent) {
360         dpif_sflow_add_poller(ds, dsp, odp_port);
361         dpif_sflow_add_sampler(ds, dsp);
362     }
363 }
364
365 static void
366 dpif_sflow_del_port__(struct dpif_sflow *ds, struct dpif_sflow_port *dsp)
367 {
368     if (ds->sflow_agent) {
369         sfl_agent_removePoller(ds->sflow_agent, &dsp->dsi);
370         sfl_agent_removeSampler(ds->sflow_agent, &dsp->dsi);
371     }
372     netdev_close(dsp->netdev);
373     hmap_remove(&ds->ports, &dsp->hmap_node);
374     free(dsp);
375 }
376
377 void
378 dpif_sflow_del_port(struct dpif_sflow *ds, uint16_t odp_port)
379 {
380     struct dpif_sflow_port *dsp = dpif_sflow_find_port(ds, odp_port);
381     if (dsp) {
382         dpif_sflow_del_port__(ds, dsp);
383     }
384 }
385
386 void
387 dpif_sflow_set_options(struct dpif_sflow *ds,
388                        const struct ofproto_sflow_options *options)
389 {
390     struct dpif_sflow_port *dsp;
391     bool options_changed;
392     SFLReceiver *receiver;
393     SFLAddress agentIP;
394     time_t now;
395
396     if (sset_is_empty(&options->targets) || !options->sampling_rate) {
397         /* No point in doing any work if there are no targets or nothing to
398          * sample. */
399         dpif_sflow_clear(ds);
400         return;
401     }
402
403     options_changed = (!ds->options
404                        || !ofproto_sflow_options_equal(options, ds->options));
405
406     /* Configure collectors if options have changed or if we're shortchanged in
407      * collectors (which indicates that opening one or more of the configured
408      * collectors failed, so that we should retry). */
409     if (options_changed
410         || collectors_count(ds->collectors) < sset_count(&options->targets)) {
411         collectors_destroy(ds->collectors);
412         collectors_create(&options->targets, SFL_DEFAULT_COLLECTOR_PORT,
413                           &ds->collectors);
414         if (ds->collectors == NULL) {
415             VLOG_WARN_RL(&rl, "no collectors could be initialized, "
416                          "sFlow disabled");
417             dpif_sflow_clear(ds);
418             return;
419         }
420     }
421
422     /* Avoid reconfiguring if options didn't change. */
423     if (!options_changed) {
424         return;
425     }
426     ofproto_sflow_options_destroy(ds->options);
427     ds->options = ofproto_sflow_options_clone(options);
428
429     /* Choose agent IP address. */
430     if (!sflow_choose_agent_address(options->agent_device,
431                                     options->control_ip, &agentIP)) {
432         dpif_sflow_clear(ds);
433         return;
434     }
435
436     /* Create agent. */
437     VLOG_INFO("creating sFlow agent %d", options->sub_id);
438     if (ds->sflow_agent) {
439         sfl_agent_release(ds->sflow_agent);
440     }
441     ds->sflow_agent = xcalloc(1, sizeof *ds->sflow_agent);
442     now = time_wall();
443     sfl_agent_init(ds->sflow_agent,
444                    &agentIP,
445                    options->sub_id,
446                    now,         /* Boot time. */
447                    now,         /* Current time. */
448                    ds,          /* Pointer supplied to callbacks. */
449                    sflow_agent_alloc_cb,
450                    sflow_agent_free_cb,
451                    sflow_agent_error_cb,
452                    sflow_agent_send_packet_cb);
453
454     receiver = sfl_agent_addReceiver(ds->sflow_agent);
455     sfl_receiver_set_sFlowRcvrOwner(receiver, "Open vSwitch sFlow");
456     sfl_receiver_set_sFlowRcvrTimeout(receiver, 0xffffffff);
457
458     /* Set the sampling_rate down in the datapath. */
459     dpif_set_sflow_probability(ds->dpif,
460                                MAX(1, UINT32_MAX / options->sampling_rate));
461
462     /* Add samplers and pollers for the currently known ports. */
463     HMAP_FOR_EACH (dsp, hmap_node, &ds->ports) {
464         dpif_sflow_add_poller(ds, dsp, dsp->odp_port);
465         dpif_sflow_add_sampler(ds, dsp);
466     }
467 }
468
469 static int
470 dpif_sflow_odp_port_to_ifindex(const struct dpif_sflow *ds,
471                                uint16_t odp_port)
472 {
473     struct dpif_sflow_port *dsp = dpif_sflow_find_port(ds, odp_port);
474     return dsp ? SFL_DS_INDEX(dsp->dsi) : 0;
475 }
476
477 void
478 dpif_sflow_received(struct dpif_sflow *ds, const struct dpif_upcall *upcall,
479                     const struct flow *flow)
480 {
481     SFL_FLOW_SAMPLE_TYPE fs;
482     SFLFlow_sample_element hdrElem;
483     SFLSampled_header *header;
484     SFLFlow_sample_element switchElem;
485     SFLSampler *sampler;
486     unsigned int left;
487     struct nlattr *a;
488     size_t n_outputs;
489
490     /* Build a flow sample */
491     memset(&fs, 0, sizeof fs);
492     fs.input = dpif_sflow_odp_port_to_ifindex(ds, flow->in_port);
493     fs.output = 0;              /* Filled in correctly below. */
494     fs.sample_pool = upcall->sample_pool;
495
496     /* We are going to give it to the sampler that represents this input port.
497      * By implementing "ingress-only" sampling like this we ensure that we
498      * never have to offer the same sample to more than one sampler. */
499     sampler = sfl_agent_getSamplerByIfIndex(ds->sflow_agent, fs.input);
500     if (!sampler) {
501         VLOG_WARN_RL(&rl, "no sampler for input ifIndex (%"PRIu32")",
502                      fs.input);
503         return;
504     }
505
506     /* Sampled header. */
507     memset(&hdrElem, 0, sizeof hdrElem);
508     hdrElem.tag = SFLFLOW_HEADER;
509     header = &hdrElem.flowType.header;
510     header->header_protocol = SFLHEADER_ETHERNET_ISO8023;
511     /* The frame_length should include the Ethernet FCS (4 bytes),
512        but it has already been stripped,  so we need to add 4 here. */
513     header->frame_length = upcall->packet->size + 4;
514     /* Ethernet FCS stripped off. */
515     header->stripped = 4;
516     header->header_length = MIN(upcall->packet->size,
517                                 sampler->sFlowFsMaximumHeaderSize);
518     header->header_bytes = upcall->packet->data;
519
520     /* Add extended switch element. */
521     memset(&switchElem, 0, sizeof(switchElem));
522     switchElem.tag = SFLFLOW_EX_SWITCH;
523     switchElem.flowType.sw.src_vlan = vlan_tci_to_vid(flow->vlan_tci);
524     switchElem.flowType.sw.src_priority = vlan_tci_to_pcp(flow->vlan_tci);
525     /* Initialize the output VLAN and priority to be the same as the input,
526        but these fields can be overriden below if affected by an action. */
527     switchElem.flowType.sw.dst_vlan = switchElem.flowType.sw.src_vlan;
528     switchElem.flowType.sw.dst_priority = switchElem.flowType.sw.src_priority;
529
530     /* Figure out the output ports. */
531     n_outputs = 0;
532     NL_ATTR_FOR_EACH_UNSAFE (a, left, upcall->actions, upcall->actions_len) {
533         ovs_be16 tci;
534
535         switch (nl_attr_type(a)) {
536         case ODP_ACTION_ATTR_OUTPUT:
537             fs.output = dpif_sflow_odp_port_to_ifindex(ds, nl_attr_get_u32(a));
538             n_outputs++;
539             break;
540
541         case ODP_ACTION_ATTR_SET_DL_TCI:
542             tci = nl_attr_get_be16(a);
543             switchElem.flowType.sw.dst_vlan = vlan_tci_to_vid(tci);
544             switchElem.flowType.sw.dst_priority = vlan_tci_to_pcp(tci);
545             break;
546
547         default:
548             break;
549         }
550     }
551
552     /* Set output port, as defined by http://www.sflow.org/sflow_version_5.txt
553        (search for "Input/output port information"). */
554     if (!n_outputs) {
555         /* This value indicates that the packet was dropped for an unknown
556          * reason. */
557         fs.output = 0x40000000 | 256;
558     } else if (n_outputs > 1 || !fs.output) {
559         /* Setting the high bit means "multiple output ports". */
560         fs.output = 0x80000000 | n_outputs;
561     }
562
563     /* Submit the flow sample to be encoded into the next datagram. */
564     SFLADD_ELEMENT(&fs, &hdrElem);
565     SFLADD_ELEMENT(&fs, &switchElem);
566     sfl_sampler_writeFlowSample(sampler, &fs);
567 }
568
569 void
570 dpif_sflow_run(struct dpif_sflow *ds)
571 {
572     if (dpif_sflow_is_enabled(ds)) {
573         time_t now = time_now();
574         if (now >= ds->next_tick) {
575             sfl_agent_tick(ds->sflow_agent, time_wall());
576             ds->next_tick = now + 1;
577         }
578     }
579 }
580
581 void
582 dpif_sflow_wait(struct dpif_sflow *ds)
583 {
584     if (dpif_sflow_is_enabled(ds)) {
585         poll_timer_wait_until(ds->next_tick * 1000LL);
586     }
587 }