ofp-util: Allow decoding of Open Flow 1.2 Packet In Messages
[openvswitch] / ofproto / ofproto-dpif-sflow.c
1 /*
2  * Copyright (c) 2009, 2010, 2011, 2012 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 "route-table.h"
36 #include "sflow_api.h"
37 #include "socket-util.h"
38 #include "timeval.h"
39 #include "vlog.h"
40 #include "lib/odp-util.h"
41 #include "ofproto-provider.h"
42
43 VLOG_DEFINE_THIS_MODULE(sflow);
44
45 struct dpif_sflow_port {
46     struct hmap_node hmap_node; /* In struct dpif_sflow's "ports" hmap. */
47     SFLDataSource_instance dsi; /* sFlow library's notion of port number. */
48     struct ofport *ofport;      /* To retrive port stats. */
49 };
50
51 struct dpif_sflow {
52     struct collectors *collectors;
53     SFLAgent *sflow_agent;
54     struct ofproto_sflow_options *options;
55     struct dpif *dpif;
56     time_t next_tick;
57     size_t n_flood, n_all;
58     struct hmap ports;          /* Contains "struct dpif_sflow_port"s. */
59     uint32_t probability;
60 };
61
62 static void dpif_sflow_del_port__(struct dpif_sflow *,
63                                   struct dpif_sflow_port *);
64
65 #define RECEIVER_INDEX 1
66
67 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
68
69 static bool
70 nullable_string_is_equal(const char *a, const char *b)
71 {
72     return a ? b && !strcmp(a, b) : !b;
73 }
74
75 static bool
76 ofproto_sflow_options_equal(const struct ofproto_sflow_options *a,
77                          const struct ofproto_sflow_options *b)
78 {
79     return (sset_equals(&a->targets, &b->targets)
80             && a->sampling_rate == b->sampling_rate
81             && a->polling_interval == b->polling_interval
82             && a->header_len == b->header_len
83             && a->sub_id == b->sub_id
84             && nullable_string_is_equal(a->agent_device, b->agent_device)
85             && nullable_string_is_equal(a->control_ip, b->control_ip));
86 }
87
88 static struct ofproto_sflow_options *
89 ofproto_sflow_options_clone(const struct ofproto_sflow_options *old)
90 {
91     struct ofproto_sflow_options *new = xmemdup(old, sizeof *old);
92     sset_clone(&new->targets, &old->targets);
93     new->agent_device = old->agent_device ? xstrdup(old->agent_device) : NULL;
94     new->control_ip = old->control_ip ? xstrdup(old->control_ip) : NULL;
95     return new;
96 }
97
98 static void
99 ofproto_sflow_options_destroy(struct ofproto_sflow_options *options)
100 {
101     if (options) {
102         sset_destroy(&options->targets);
103         free(options->agent_device);
104         free(options->control_ip);
105         free(options);
106     }
107 }
108
109 /* sFlow library callback to allocate memory. */
110 static void *
111 sflow_agent_alloc_cb(void *magic OVS_UNUSED, SFLAgent *agent OVS_UNUSED,
112                      size_t bytes)
113 {
114     return calloc(1, bytes);
115 }
116
117 /* sFlow library callback to free memory. */
118 static int
119 sflow_agent_free_cb(void *magic OVS_UNUSED, SFLAgent *agent OVS_UNUSED,
120                     void *obj)
121 {
122     free(obj);
123     return 0;
124 }
125
126 /* sFlow library callback to report error. */
127 static void
128 sflow_agent_error_cb(void *magic OVS_UNUSED, SFLAgent *agent OVS_UNUSED,
129                      char *msg)
130 {
131     VLOG_WARN("sFlow agent error: %s", msg);
132 }
133
134 /* sFlow library callback to send datagram. */
135 static void
136 sflow_agent_send_packet_cb(void *ds_, SFLAgent *agent OVS_UNUSED,
137                            SFLReceiver *receiver OVS_UNUSED, u_char *pkt,
138                            uint32_t pktLen)
139 {
140     struct dpif_sflow *ds = ds_;
141     collectors_send(ds->collectors, pkt, pktLen);
142 }
143
144 static struct dpif_sflow_port *
145 dpif_sflow_find_port(const struct dpif_sflow *ds, uint16_t odp_port)
146 {
147     struct dpif_sflow_port *dsp;
148
149     HMAP_FOR_EACH_IN_BUCKET (dsp, hmap_node,
150                              hash_int(odp_port, 0), &ds->ports) {
151         if (ofp_port_to_odp_port(dsp->ofport->ofp_port) == odp_port) {
152             return dsp;
153         }
154     }
155     return NULL;
156 }
157
158 static void
159 sflow_agent_get_counters(void *ds_, SFLPoller *poller,
160                          SFL_COUNTERS_SAMPLE_TYPE *cs)
161 {
162     struct dpif_sflow *ds = ds_;
163     SFLCounters_sample_element elem;
164     enum netdev_features current;
165     struct dpif_sflow_port *dsp;
166     SFLIf_counters *counters;
167     struct netdev_stats stats;
168     enum netdev_flags flags;
169
170     dsp = dpif_sflow_find_port(ds, poller->bridgePort);
171     if (!dsp) {
172         return;
173     }
174
175     elem.tag = SFLCOUNTERS_GENERIC;
176     counters = &elem.counterBlock.generic;
177     counters->ifIndex = SFL_DS_INDEX(poller->dsi);
178     counters->ifType = 6;
179     if (!netdev_get_features(dsp->ofport->netdev, &current, NULL, NULL, NULL)) {
180         /* The values of ifDirection come from MAU MIB (RFC 2668): 0 = unknown,
181            1 = full-duplex, 2 = half-duplex, 3 = in, 4=out */
182         counters->ifSpeed = netdev_features_to_bps(current);
183         counters->ifDirection = (netdev_features_is_full_duplex(current)
184                                  ? 1 : 2);
185     } else {
186         counters->ifSpeed = 100000000;
187         counters->ifDirection = 0;
188     }
189     if (!netdev_get_flags(dsp->ofport->netdev, &flags) && flags & NETDEV_UP) {
190         counters->ifStatus = 1; /* ifAdminStatus up. */
191         if (netdev_get_carrier(dsp->ofport->netdev)) {
192             counters->ifStatus |= 2; /* ifOperStatus us. */
193         }
194     } else {
195         counters->ifStatus = 0;  /* Down. */
196     }
197
198     /* XXX
199        1. Is the multicast counter filled in?
200        2. Does the multicast counter include broadcasts?
201        3. Does the rx_packets counter include multicasts/broadcasts?
202     */
203     ofproto_port_get_stats(dsp->ofport, &stats);
204     counters->ifInOctets = stats.rx_bytes;
205     counters->ifInUcastPkts = stats.rx_packets;
206     counters->ifInMulticastPkts = stats.multicast;
207     counters->ifInBroadcastPkts = -1;
208     counters->ifInDiscards = stats.rx_dropped;
209     counters->ifInErrors = stats.rx_errors;
210     counters->ifInUnknownProtos = -1;
211     counters->ifOutOctets = stats.tx_bytes;
212     counters->ifOutUcastPkts = stats.tx_packets;
213     counters->ifOutMulticastPkts = -1;
214     counters->ifOutBroadcastPkts = -1;
215     counters->ifOutDiscards = stats.tx_dropped;
216     counters->ifOutErrors = stats.tx_errors;
217     counters->ifPromiscuousMode = 0;
218
219     SFLADD_ELEMENT(cs, &elem);
220     sfl_poller_writeCountersSample(poller, cs);
221 }
222
223 /* Obtains an address to use for the local sFlow agent and stores it into
224  * '*agent_addr'.  Returns true if successful, false on failure.
225  *
226  * The sFlow agent address should be a local IP address that is persistent and
227  * reachable over the network, if possible.  The IP address associated with
228  * 'agent_device' is used if it has one, and otherwise 'control_ip', the IP
229  * address used to talk to the controller.  If the agent device is not
230  * specified then it is figured out by taking a look at the routing table based
231  * on 'targets'. */
232 static bool
233 sflow_choose_agent_address(const char *agent_device,
234                            const struct sset *targets,
235                            const char *control_ip,
236                            SFLAddress *agent_addr)
237 {
238     const char *target;
239     struct in_addr in4;
240
241     memset(agent_addr, 0, sizeof *agent_addr);
242     agent_addr->type = SFLADDRESSTYPE_IP_V4;
243
244     if (agent_device) {
245         if (!netdev_get_in4_by_name(agent_device, &in4)) {
246             goto success;
247         }
248     }
249
250     SSET_FOR_EACH (target, targets) {
251         struct sockaddr_in sin;
252         char name[IFNAMSIZ];
253
254         if (inet_parse_active(target, SFL_DEFAULT_COLLECTOR_PORT, &sin)
255             && route_table_get_name(sin.sin_addr.s_addr, name)
256             && !netdev_get_in4_by_name(name, &in4)) {
257             goto success;
258         }
259     }
260
261     if (control_ip && !lookup_ip(control_ip, &in4)) {
262         goto success;
263     }
264
265     VLOG_ERR("could not determine IP address for sFlow agent");
266     return false;
267
268 success:
269     agent_addr->address.ip_v4.addr = (OVS_FORCE uint32_t) in4.s_addr;
270     return true;
271 }
272
273 void
274 dpif_sflow_clear(struct dpif_sflow *ds)
275 {
276     if (ds->sflow_agent) {
277         sfl_agent_release(ds->sflow_agent);
278         ds->sflow_agent = NULL;
279     }
280     collectors_destroy(ds->collectors);
281     ds->collectors = NULL;
282     ofproto_sflow_options_destroy(ds->options);
283     ds->options = NULL;
284
285     /* Turn off sampling to save CPU cycles. */
286     ds->probability = 0;
287 }
288
289 bool
290 dpif_sflow_is_enabled(const struct dpif_sflow *ds)
291 {
292     return ds->collectors != NULL;
293 }
294
295 struct dpif_sflow *
296 dpif_sflow_create(struct dpif *dpif)
297 {
298     struct dpif_sflow *ds;
299
300     ds = xcalloc(1, sizeof *ds);
301     ds->dpif = dpif;
302     ds->next_tick = time_now() + 1;
303     hmap_init(&ds->ports);
304     ds->probability = 0;
305     route_table_register();
306
307     return ds;
308 }
309
310 /* 32-bit fraction of packets to sample with.  A value of 0 samples no packets,
311  * a value of %UINT32_MAX samples all packets and intermediate values sample
312  * intermediate fractions of packets. */
313 uint32_t
314 dpif_sflow_get_probability(const struct dpif_sflow *ds)
315 {
316     return ds->probability;
317 }
318
319 void
320 dpif_sflow_destroy(struct dpif_sflow *ds)
321 {
322     if (ds) {
323         struct dpif_sflow_port *dsp, *next;
324
325         route_table_unregister();
326         dpif_sflow_clear(ds);
327         HMAP_FOR_EACH_SAFE (dsp, next, hmap_node, &ds->ports) {
328             dpif_sflow_del_port__(ds, dsp);
329         }
330         hmap_destroy(&ds->ports);
331         free(ds);
332     }
333 }
334
335 static void
336 dpif_sflow_add_poller(struct dpif_sflow *ds, struct dpif_sflow_port *dsp)
337 {
338     SFLPoller *poller = sfl_agent_addPoller(ds->sflow_agent, &dsp->dsi, ds,
339                                             sflow_agent_get_counters);
340     sfl_poller_set_sFlowCpInterval(poller, ds->options->polling_interval);
341     sfl_poller_set_sFlowCpReceiver(poller, RECEIVER_INDEX);
342     sfl_poller_set_bridgePort(poller,
343                               ofp_port_to_odp_port(dsp->ofport->ofp_port));
344 }
345
346 static void
347 dpif_sflow_add_sampler(struct dpif_sflow *ds, struct dpif_sflow_port *dsp)
348 {
349     SFLSampler *sampler = sfl_agent_addSampler(ds->sflow_agent, &dsp->dsi);
350     sfl_sampler_set_sFlowFsPacketSamplingRate(sampler, ds->options->sampling_rate);
351     sfl_sampler_set_sFlowFsMaximumHeaderSize(sampler, ds->options->header_len);
352     sfl_sampler_set_sFlowFsReceiver(sampler, RECEIVER_INDEX);
353 }
354
355 void
356 dpif_sflow_add_port(struct dpif_sflow *ds, struct ofport *ofport)
357 {
358     struct dpif_sflow_port *dsp;
359     uint16_t odp_port = ofp_port_to_odp_port(ofport->ofp_port);
360     uint32_t ifindex;
361
362     dpif_sflow_del_port(ds, odp_port);
363
364     /* Add to table of ports. */
365     dsp = xmalloc(sizeof *dsp);
366     ifindex = netdev_get_ifindex(ofport->netdev);
367     if (ifindex <= 0) {
368         ifindex = (ds->sflow_agent->subId << 16) + odp_port;
369     }
370     dsp->ofport = ofport;
371     SFL_DS_SET(dsp->dsi, 0, ifindex, 0);
372     hmap_insert(&ds->ports, &dsp->hmap_node, hash_int(odp_port, 0));
373
374     /* Add poller and sampler. */
375     if (ds->sflow_agent) {
376         dpif_sflow_add_poller(ds, dsp);
377         dpif_sflow_add_sampler(ds, dsp);
378     }
379 }
380
381 static void
382 dpif_sflow_del_port__(struct dpif_sflow *ds, struct dpif_sflow_port *dsp)
383 {
384     if (ds->sflow_agent) {
385         sfl_agent_removePoller(ds->sflow_agent, &dsp->dsi);
386         sfl_agent_removeSampler(ds->sflow_agent, &dsp->dsi);
387     }
388     hmap_remove(&ds->ports, &dsp->hmap_node);
389     free(dsp);
390 }
391
392 void
393 dpif_sflow_del_port(struct dpif_sflow *ds, uint16_t odp_port)
394 {
395     struct dpif_sflow_port *dsp = dpif_sflow_find_port(ds, odp_port);
396     if (dsp) {
397         dpif_sflow_del_port__(ds, dsp);
398     }
399 }
400
401 void
402 dpif_sflow_set_options(struct dpif_sflow *ds,
403                        const struct ofproto_sflow_options *options)
404 {
405     struct dpif_sflow_port *dsp;
406     bool options_changed;
407     SFLReceiver *receiver;
408     SFLAddress agentIP;
409     time_t now;
410
411     if (sset_is_empty(&options->targets) || !options->sampling_rate) {
412         /* No point in doing any work if there are no targets or nothing to
413          * sample. */
414         dpif_sflow_clear(ds);
415         return;
416     }
417
418     options_changed = (!ds->options
419                        || !ofproto_sflow_options_equal(options, ds->options));
420
421     /* Configure collectors if options have changed or if we're shortchanged in
422      * collectors (which indicates that opening one or more of the configured
423      * collectors failed, so that we should retry). */
424     if (options_changed
425         || collectors_count(ds->collectors) < sset_count(&options->targets)) {
426         collectors_destroy(ds->collectors);
427         collectors_create(&options->targets, SFL_DEFAULT_COLLECTOR_PORT,
428                           &ds->collectors);
429         if (ds->collectors == NULL) {
430             VLOG_WARN_RL(&rl, "no collectors could be initialized, "
431                          "sFlow disabled");
432             dpif_sflow_clear(ds);
433             return;
434         }
435     }
436
437     /* Choose agent IP address and agent device (if not yet setup) */
438     if (!sflow_choose_agent_address(options->agent_device,
439                                     &options->targets,
440                                     options->control_ip, &agentIP)) {
441         dpif_sflow_clear(ds);
442         return;
443     }
444
445     /* Avoid reconfiguring if options didn't change. */
446     if (!options_changed) {
447         return;
448     }
449     ofproto_sflow_options_destroy(ds->options);
450     ds->options = ofproto_sflow_options_clone(options);
451
452     /* Create agent. */
453     VLOG_INFO("creating sFlow agent %d", options->sub_id);
454     if (ds->sflow_agent) {
455         sfl_agent_release(ds->sflow_agent);
456     }
457     ds->sflow_agent = xcalloc(1, sizeof *ds->sflow_agent);
458     now = time_wall();
459     sfl_agent_init(ds->sflow_agent,
460                    &agentIP,
461                    options->sub_id,
462                    now,         /* Boot time. */
463                    now,         /* Current time. */
464                    ds,          /* Pointer supplied to callbacks. */
465                    sflow_agent_alloc_cb,
466                    sflow_agent_free_cb,
467                    sflow_agent_error_cb,
468                    sflow_agent_send_packet_cb);
469
470     receiver = sfl_agent_addReceiver(ds->sflow_agent);
471     sfl_receiver_set_sFlowRcvrOwner(receiver, "Open vSwitch sFlow");
472     sfl_receiver_set_sFlowRcvrTimeout(receiver, 0xffffffff);
473
474     /* Set the sampling_rate down in the datapath. */
475     ds->probability = MAX(1, UINT32_MAX / ds->options->sampling_rate);
476
477     /* Add samplers and pollers for the currently known ports. */
478     HMAP_FOR_EACH (dsp, hmap_node, &ds->ports) {
479         dpif_sflow_add_poller(ds, dsp);
480         dpif_sflow_add_sampler(ds, dsp);
481     }
482 }
483
484 int
485 dpif_sflow_odp_port_to_ifindex(const struct dpif_sflow *ds,
486                                uint16_t odp_port)
487 {
488     struct dpif_sflow_port *dsp = dpif_sflow_find_port(ds, odp_port);
489     return dsp ? SFL_DS_INDEX(dsp->dsi) : 0;
490 }
491
492 void
493 dpif_sflow_received(struct dpif_sflow *ds, struct ofpbuf *packet,
494                     const struct flow *flow,
495                     const union user_action_cookie *cookie)
496 {
497     SFL_FLOW_SAMPLE_TYPE fs;
498     SFLFlow_sample_element hdrElem;
499     SFLSampled_header *header;
500     SFLFlow_sample_element switchElem;
501     SFLSampler *sampler;
502     struct dpif_sflow_port *in_dsp;
503     struct netdev_stats stats;
504     ovs_be16 vlan_tci;
505     int error;
506
507     /* Build a flow sample */
508     memset(&fs, 0, sizeof fs);
509
510     in_dsp = dpif_sflow_find_port(ds, ofp_port_to_odp_port(flow->in_port));
511     if (!in_dsp) {
512         return;
513     }
514     fs.input = SFL_DS_INDEX(in_dsp->dsi);
515
516     error = ofproto_port_get_stats(in_dsp->ofport, &stats);
517     if (error) {
518         VLOG_WARN_RL(&rl, "netdev get-stats error %s", strerror(error));
519         return;
520     }
521     fs.sample_pool = stats.rx_packets;
522
523     /* We are going to give it to the sampler that represents this input port.
524      * By implementing "ingress-only" sampling like this we ensure that we
525      * never have to offer the same sample to more than one sampler. */
526     sampler = sfl_agent_getSamplerByIfIndex(ds->sflow_agent, fs.input);
527     if (!sampler) {
528         VLOG_WARN_RL(&rl, "no sampler for input ifIndex (%"PRIu32")",
529                      fs.input);
530         return;
531     }
532
533     /* Sampled header. */
534     memset(&hdrElem, 0, sizeof hdrElem);
535     hdrElem.tag = SFLFLOW_HEADER;
536     header = &hdrElem.flowType.header;
537     header->header_protocol = SFLHEADER_ETHERNET_ISO8023;
538     /* The frame_length should include the Ethernet FCS (4 bytes),
539        but it has already been stripped,  so we need to add 4 here. */
540     header->frame_length = packet->size + 4;
541     /* Ethernet FCS stripped off. */
542     header->stripped = 4;
543     header->header_length = MIN(packet->size,
544                                 sampler->sFlowFsMaximumHeaderSize);
545     header->header_bytes = packet->data;
546
547     /* Add extended switch element. */
548     memset(&switchElem, 0, sizeof(switchElem));
549     switchElem.tag = SFLFLOW_EX_SWITCH;
550     switchElem.flowType.sw.src_vlan = vlan_tci_to_vid(flow->vlan_tci);
551     switchElem.flowType.sw.src_priority = vlan_tci_to_pcp(flow->vlan_tci);
552
553     /* Retrieve data from user_action_cookie. */
554     vlan_tci = cookie->sflow.vlan_tci;
555     switchElem.flowType.sw.dst_vlan = vlan_tci_to_vid(vlan_tci);
556     switchElem.flowType.sw.dst_priority = vlan_tci_to_pcp(vlan_tci);
557
558     fs.output = cookie->sflow.output;
559
560     /* Submit the flow sample to be encoded into the next datagram. */
561     SFLADD_ELEMENT(&fs, &hdrElem);
562     SFLADD_ELEMENT(&fs, &switchElem);
563     sfl_sampler_writeFlowSample(sampler, &fs);
564 }
565
566 void
567 dpif_sflow_run(struct dpif_sflow *ds)
568 {
569     if (dpif_sflow_is_enabled(ds)) {
570         time_t now = time_now();
571         route_table_run();
572         if (now >= ds->next_tick) {
573             sfl_agent_tick(ds->sflow_agent, time_wall());
574             ds->next_tick = now + 1;
575         }
576     }
577 }
578
579 void
580 dpif_sflow_wait(struct dpif_sflow *ds)
581 {
582     if (dpif_sflow_is_enabled(ds)) {
583         poll_timer_wait_until(ds->next_tick * 1000LL);
584     }
585 }