Cleanup isdigit() warnings.
[openvswitch] / lib / dpif-linux.c
1 /*
2  * Copyright (c) 2008, 2009 Nicira Networks.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #include <config.h>
18 #include "dpif.h"
19
20 #include <assert.h>
21 #include <ctype.h>
22 #include <errno.h>
23 #include <fcntl.h>
24 #include <inttypes.h>
25 #include <net/if.h>
26 #include <linux/ethtool.h>
27 #include <linux/rtnetlink.h>
28 #include <linux/sockios.h>
29 #include <stdlib.h>
30 #include <sys/ioctl.h>
31 #include <unistd.h>
32
33 #include "dpif-provider.h"
34 #include "ofpbuf.h"
35 #include "poll-loop.h"
36 #include "rtnetlink.h"
37 #include "svec.h"
38 #include "util.h"
39
40 #include "vlog.h"
41 #define THIS_MODULE VLM_dpif_linux
42
43 /* Datapath interface for the openvswitch Linux kernel module. */
44 struct dpif_linux {
45     struct dpif dpif;
46     int fd;
47
48     /* Used by dpif_linux_get_all_names(). */
49     char *local_ifname;
50     int minor;
51
52     /* Change notification. */
53     int local_ifindex;          /* Ifindex of local port. */
54     struct svec changed_ports;  /* Ports that have changed. */
55     struct rtnetlink_notifier port_notifier;
56     bool change_error;
57 };
58
59 static struct vlog_rate_limit error_rl = VLOG_RATE_LIMIT_INIT(9999, 5);
60
61 static int do_ioctl(const struct dpif *, int cmd, const void *arg);
62 static int lookup_minor(const char *name, int *minor);
63 static int finish_open(struct dpif *, const char *local_ifname);
64 static int create_minor(const char *name, int minor, struct dpif **dpifp);
65 static int open_minor(int minor, struct dpif **dpifp);
66 static int make_openvswitch_device(int minor, char **fnp);
67 static void dpif_linux_port_changed(const struct rtnetlink_change *,
68                                     void *dpif);
69
70 static struct dpif_linux *
71 dpif_linux_cast(const struct dpif *dpif)
72 {
73     dpif_assert_class(dpif, &dpif_linux_class);
74     return CONTAINER_OF(dpif, struct dpif_linux, dpif);
75 }
76
77 static int
78 dpif_linux_enumerate(struct svec *all_dps)
79 {
80     int error;
81     int i;
82
83     error = 0;
84     for (i = 0; i < ODP_MAX; i++) {
85         struct dpif *dpif;
86         char devname[16];
87         int retval;
88
89         sprintf(devname, "dp%d", i);
90         retval = dpif_open(devname, &dpif);
91         if (!retval) {
92             svec_add(all_dps, devname);
93             dpif_close(dpif);
94         } else if (retval != ENODEV && !error) {
95             error = retval;
96         }
97     }
98     return error;
99 }
100
101 static int
102 dpif_linux_open(const char *name UNUSED, char *suffix, bool create,
103                 struct dpif **dpifp)
104 {
105     int minor;
106
107     minor = !strncmp(name, "dp", 2)
108             && isdigit((unsigned char)name[2]) ? atoi(name + 2) : -1;
109     if (create) {
110         if (minor >= 0) {
111             return create_minor(suffix, minor, dpifp);
112         } else {
113             /* Scan for unused minor number. */
114             for (minor = 0; minor < ODP_MAX; minor++) {
115                 int error = create_minor(suffix, minor, dpifp);
116                 if (error != EBUSY) {
117                     return error;
118                 }
119             }
120
121             /* All datapath numbers in use. */
122             return ENOBUFS;
123         }
124     } else {
125         struct dpif_linux *dpif;
126         struct odp_port port;
127         int error;
128
129         if (minor < 0) {
130             error = lookup_minor(suffix, &minor);
131             if (error) {
132                 return error;
133             }
134         }
135
136         error = open_minor(minor, dpifp);
137         if (error) {
138             return error;
139         }
140         dpif = dpif_linux_cast(*dpifp);
141
142         /* We need the local port's ifindex for the poll function.  Start by
143          * getting the local port's name. */
144         memset(&port, 0, sizeof port);
145         port.port = ODPP_LOCAL;
146         if (ioctl(dpif->fd, ODP_PORT_QUERY, &port)) {
147             error = errno;
148             if (error != ENODEV) {
149                 VLOG_WARN("%s: probe returned unexpected error: %s",
150                           dpif_name(*dpifp), strerror(error));
151             }
152             dpif_close(*dpifp);
153             return error;
154         }
155
156         /* Then use that to finish up opening. */
157         return finish_open(&dpif->dpif, port.devname);
158     }
159 }
160
161 static void
162 dpif_linux_close(struct dpif *dpif_)
163 {
164     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
165     rtnetlink_notifier_unregister(&dpif->port_notifier);
166     svec_destroy(&dpif->changed_ports);
167     free(dpif->local_ifname);
168     close(dpif->fd);
169     free(dpif);
170 }
171
172 static int
173 dpif_linux_get_all_names(const struct dpif *dpif_, struct svec *all_names)
174 {
175     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
176
177     svec_add_nocopy(all_names, xasprintf("dp%d", dpif->minor));
178     svec_add(all_names, dpif->local_ifname);
179     return 0;
180 }
181
182 static int
183 dpif_linux_delete(struct dpif *dpif_)
184 {
185     return do_ioctl(dpif_, ODP_DP_DESTROY, NULL);
186 }
187
188 static int
189 dpif_linux_get_stats(const struct dpif *dpif_, struct odp_stats *stats)
190 {
191     return do_ioctl(dpif_, ODP_DP_STATS, stats);
192 }
193
194 static int
195 dpif_linux_get_drop_frags(const struct dpif *dpif_, bool *drop_fragsp)
196 {
197     int drop_frags;
198     int error;
199
200     error = do_ioctl(dpif_, ODP_GET_DROP_FRAGS, &drop_frags);
201     if (!error) {
202         *drop_fragsp = drop_frags & 1;
203     }
204     return error;
205 }
206
207 static int
208 dpif_linux_set_drop_frags(struct dpif *dpif_, bool drop_frags)
209 {
210     int drop_frags_int = drop_frags;
211     return do_ioctl(dpif_, ODP_SET_DROP_FRAGS, &drop_frags_int);
212 }
213
214 static int
215 dpif_linux_port_add(struct dpif *dpif_, const char *devname, uint16_t flags,
216                     uint16_t *port_no)
217 {
218     struct odp_port port;
219     int error;
220
221     memset(&port, 0, sizeof port);
222     strncpy(port.devname, devname, sizeof port.devname);
223     port.flags = flags;
224     error = do_ioctl(dpif_, ODP_PORT_ADD, &port);
225     if (!error) {
226         *port_no = port.port;
227     }
228     return error;
229 }
230
231 static int
232 dpif_linux_port_del(struct dpif *dpif_, uint16_t port_no)
233 {
234     int tmp = port_no;
235     return do_ioctl(dpif_, ODP_PORT_DEL, &tmp);
236 }
237
238 static int
239 dpif_linux_port_query_by_number(const struct dpif *dpif_, uint16_t port_no,
240                           struct odp_port *port)
241 {
242     memset(port, 0, sizeof *port);
243     port->port = port_no;
244     return do_ioctl(dpif_, ODP_PORT_QUERY, port);
245 }
246
247 static int
248 dpif_linux_port_query_by_name(const struct dpif *dpif_, const char *devname,
249                               struct odp_port *port)
250 {
251     memset(port, 0, sizeof *port);
252     strncpy(port->devname, devname, sizeof port->devname);
253     return do_ioctl(dpif_, ODP_PORT_QUERY, port);
254 }
255
256 static int
257 dpif_linux_flow_flush(struct dpif *dpif_)
258 {
259     return do_ioctl(dpif_, ODP_FLOW_FLUSH, NULL);
260 }
261
262 static int
263 dpif_linux_port_list(const struct dpif *dpif_, struct odp_port *ports, int n)
264 {
265     struct odp_portvec pv;
266     int error;
267
268     pv.ports = ports;
269     pv.n_ports = n;
270     error = do_ioctl(dpif_, ODP_PORT_LIST, &pv);
271     return error ? -error : pv.n_ports;
272 }
273
274 static int
275 dpif_linux_port_poll(const struct dpif *dpif_, char **devnamep)
276 {
277     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
278
279     if (dpif->change_error) {
280         dpif->change_error = false;
281         svec_clear(&dpif->changed_ports);
282         return ENOBUFS;
283     } else if (dpif->changed_ports.n) {
284         *devnamep = dpif->changed_ports.names[--dpif->changed_ports.n];
285         return 0;
286     } else {
287         return EAGAIN;
288     }
289 }
290
291 static void
292 dpif_linux_port_poll_wait(const struct dpif *dpif_)
293 {
294     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
295     if (dpif->changed_ports.n || dpif->change_error) {
296         poll_immediate_wake();
297     } else {
298         rtnetlink_notifier_wait();
299     }
300 }
301
302 static int
303 dpif_linux_port_group_get(const struct dpif *dpif_, int group,
304                           uint16_t ports[], int n)
305 {
306     struct odp_port_group pg;
307     int error;
308
309     assert(n <= UINT16_MAX);
310     pg.group = group;
311     pg.ports = ports;
312     pg.n_ports = n;
313     error = do_ioctl(dpif_, ODP_PORT_GROUP_GET, &pg);
314     return error ? -error : pg.n_ports;
315 }
316
317 static int
318 dpif_linux_port_group_set(struct dpif *dpif_, int group,
319                           const uint16_t ports[], int n)
320 {
321     struct odp_port_group pg;
322
323     assert(n <= UINT16_MAX);
324     pg.group = group;
325     pg.ports = (uint16_t *) ports;
326     pg.n_ports = n;
327     return do_ioctl(dpif_, ODP_PORT_GROUP_SET, &pg);
328 }
329
330 static int
331 dpif_linux_flow_get(const struct dpif *dpif_, struct odp_flow flows[], int n)
332 {
333     struct odp_flowvec fv;
334     fv.flows = flows;
335     fv.n_flows = n;
336     return do_ioctl(dpif_, ODP_FLOW_GET, &fv);
337 }
338
339 static int
340 dpif_linux_flow_put(struct dpif *dpif_, struct odp_flow_put *put)
341 {
342     return do_ioctl(dpif_, ODP_FLOW_PUT, put);
343 }
344
345 static int
346 dpif_linux_flow_del(struct dpif *dpif_, struct odp_flow *flow)
347 {
348     return do_ioctl(dpif_, ODP_FLOW_DEL, flow);
349 }
350
351 static int
352 dpif_linux_flow_list(const struct dpif *dpif_, struct odp_flow flows[], int n)
353 {
354     struct odp_flowvec fv;
355     int error;
356
357     fv.flows = flows;
358     fv.n_flows = n;
359     error = do_ioctl(dpif_, ODP_FLOW_LIST, &fv);
360     return error ? -error : fv.n_flows;
361 }
362
363 static int
364 dpif_linux_execute(struct dpif *dpif_, uint16_t in_port,
365                    const union odp_action actions[], int n_actions,
366                    const struct ofpbuf *buf)
367 {
368     struct odp_execute execute;
369     memset(&execute, 0, sizeof execute);
370     execute.in_port = in_port;
371     execute.actions = (union odp_action *) actions;
372     execute.n_actions = n_actions;
373     execute.data = buf->data;
374     execute.length = buf->size;
375     return do_ioctl(dpif_, ODP_EXECUTE, &execute);
376 }
377
378 static int
379 dpif_linux_recv_get_mask(const struct dpif *dpif_, int *listen_mask)
380 {
381     return do_ioctl(dpif_, ODP_GET_LISTEN_MASK, listen_mask);
382 }
383
384 static int
385 dpif_linux_recv_set_mask(struct dpif *dpif_, int listen_mask)
386 {
387     return do_ioctl(dpif_, ODP_SET_LISTEN_MASK, &listen_mask);
388 }
389
390 static int
391 dpif_linux_recv(struct dpif *dpif_, struct ofpbuf **bufp)
392 {
393     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
394     struct ofpbuf *buf;
395     int retval;
396     int error;
397
398     buf = ofpbuf_new(65536);
399     retval = read(dpif->fd, ofpbuf_tail(buf), ofpbuf_tailroom(buf));
400     if (retval < 0) {
401         error = errno;
402         if (error != EAGAIN) {
403             VLOG_WARN_RL(&error_rl, "%s: read failed: %s",
404                          dpif_name(dpif_), strerror(error));
405         }
406     } else if (retval >= sizeof(struct odp_msg)) {
407         struct odp_msg *msg = buf->data;
408         if (msg->length <= retval) {
409             buf->size += retval;
410             *bufp = buf;
411             return 0;
412         } else {
413             VLOG_WARN_RL(&error_rl, "%s: discarding message truncated "
414                          "from %zu bytes to %d",
415                          dpif_name(dpif_), msg->length, retval);
416             error = ERANGE;
417         }
418     } else if (!retval) {
419         VLOG_WARN_RL(&error_rl, "%s: unexpected end of file", dpif_name(dpif_));
420         error = EPROTO;
421     } else {
422         VLOG_WARN_RL(&error_rl,
423                      "%s: discarding too-short message (%d bytes)",
424                      dpif_name(dpif_), retval);
425         error = ERANGE;
426     }
427
428     *bufp = NULL;
429     ofpbuf_delete(buf);
430     return error;
431 }
432
433 static void
434 dpif_linux_recv_wait(struct dpif *dpif_)
435 {
436     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
437     poll_fd_wait(dpif->fd, POLLIN);
438 }
439
440 const struct dpif_class dpif_linux_class = {
441     "",                         /* This is the default class. */
442     "linux",
443     NULL,
444     NULL,
445     dpif_linux_enumerate,
446     dpif_linux_open,
447     dpif_linux_close,
448     dpif_linux_get_all_names,
449     dpif_linux_delete,
450     dpif_linux_get_stats,
451     dpif_linux_get_drop_frags,
452     dpif_linux_set_drop_frags,
453     dpif_linux_port_add,
454     dpif_linux_port_del,
455     dpif_linux_port_query_by_number,
456     dpif_linux_port_query_by_name,
457     dpif_linux_port_list,
458     dpif_linux_port_poll,
459     dpif_linux_port_poll_wait,
460     dpif_linux_port_group_get,
461     dpif_linux_port_group_set,
462     dpif_linux_flow_get,
463     dpif_linux_flow_put,
464     dpif_linux_flow_del,
465     dpif_linux_flow_flush,
466     dpif_linux_flow_list,
467     dpif_linux_execute,
468     dpif_linux_recv_get_mask,
469     dpif_linux_recv_set_mask,
470     dpif_linux_recv,
471     dpif_linux_recv_wait,
472 };
473 \f
474 static int get_openvswitch_major(void);
475 static int get_major(const char *target, int default_major);
476
477 static int
478 do_ioctl(const struct dpif *dpif_, int cmd, const void *arg)
479 {
480     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
481     return ioctl(dpif->fd, cmd, arg) ? errno : 0;
482 }
483
484 static int
485 lookup_minor(const char *name, int *minorp)
486 {
487     struct ethtool_drvinfo drvinfo;
488     int minor, port_no;
489     struct ifreq ifr;
490     int error;
491     int sock;
492
493     sock = socket(AF_INET, SOCK_DGRAM, 0);
494     if (sock < 0) {
495         VLOG_WARN("socket(AF_INET) failed: %s", strerror(errno));
496         error = errno;
497         goto error;
498     }
499
500     memset(&ifr, 0, sizeof ifr);
501     strncpy(ifr.ifr_name, name, sizeof ifr.ifr_name);
502     ifr.ifr_data = (caddr_t) &drvinfo;
503
504     memset(&drvinfo, 0, sizeof drvinfo);
505     drvinfo.cmd = ETHTOOL_GDRVINFO;
506     if (ioctl(sock, SIOCETHTOOL, &ifr)) {
507         VLOG_WARN("ioctl(SIOCETHTOOL) failed: %s", strerror(errno));
508         error = errno;
509         goto error_close_sock;
510     }
511
512     if (strcmp(drvinfo.driver, "openvswitch")) {
513         VLOG_WARN("%s is not an openvswitch device", name);
514         error = EOPNOTSUPP;
515         goto error_close_sock;
516     }
517
518     if (sscanf(drvinfo.bus_info, "%d.%d", &minor, &port_no) != 2) {
519         VLOG_WARN("%s ethtool bus_info has unexpected format", name);
520         error = EPROTOTYPE;
521         goto error_close_sock;
522     } else if (port_no != ODPP_LOCAL) {
523         /* This is an Open vSwitch device but not the local port.  We
524          * intentionally support only using the name of the local port as the
525          * name of a datapath; otherwise, it would be too difficult to
526          * enumerate all the names of a datapath. */
527         error = EOPNOTSUPP;
528         goto error_close_sock;
529     }
530
531     *minorp = minor;
532     close(sock);
533     return 0;
534
535 error_close_sock:
536     close(sock);
537 error:
538     return error;
539 }
540
541 static int
542 make_openvswitch_device(int minor, char **fnp)
543 {
544     dev_t dev = makedev(get_openvswitch_major(), minor);
545     const char dirname[] = "/dev/net";
546     struct stat s;
547     char fn[128];
548
549     *fnp = NULL;
550     sprintf(fn, "%s/dp%d", dirname, minor);
551     if (!stat(fn, &s)) {
552         if (!S_ISCHR(s.st_mode)) {
553             VLOG_WARN_RL(&error_rl, "%s is not a character device, fixing",
554                          fn);
555         } else if (s.st_rdev != dev) {
556             VLOG_WARN_RL(&error_rl,
557                          "%s is device %u:%u instead of %u:%u, fixing",
558                          fn, major(s.st_rdev), minor(s.st_rdev),
559                          major(dev), minor(dev));
560         } else {
561             goto success;
562         }
563         if (unlink(fn)) {
564             VLOG_WARN_RL(&error_rl, "%s: unlink failed (%s)",
565                          fn, strerror(errno));
566             return errno;
567         }
568     } else if (errno == ENOENT) {
569         if (stat(dirname, &s)) {
570             if (errno == ENOENT) {
571                 if (mkdir(dirname, 0755)) {
572                     VLOG_WARN_RL(&error_rl, "%s: mkdir failed (%s)",
573                                  dirname, strerror(errno));
574                     return errno;
575                 }
576             } else {
577                 VLOG_WARN_RL(&error_rl, "%s: stat failed (%s)",
578                              dirname, strerror(errno));
579                 return errno;
580             }
581         }
582     } else {
583         VLOG_WARN_RL(&error_rl, "%s: stat failed (%s)", fn, strerror(errno));
584         return errno;
585     }
586
587     /* The device needs to be created. */
588     if (mknod(fn, S_IFCHR | 0700, dev)) {
589         VLOG_WARN_RL(&error_rl,
590                      "%s: creating character device %u:%u failed (%s)",
591                      fn, major(dev), minor(dev), strerror(errno));
592         return errno;
593     }
594
595 success:
596     *fnp = xstrdup(fn);
597     return 0;
598 }
599
600
601 static int
602 get_openvswitch_major(void)
603 {
604     static unsigned int openvswitch_major;
605     if (!openvswitch_major) {
606         enum { DEFAULT_MAJOR = 248 };
607         openvswitch_major = get_major("openvswitch", DEFAULT_MAJOR);
608     }
609     return openvswitch_major;
610 }
611
612 static int
613 get_major(const char *target, int default_major)
614 {
615     const char fn[] = "/proc/devices";
616     char line[128];
617     FILE *file;
618     int ln;
619
620     file = fopen(fn, "r");
621     if (!file) {
622         VLOG_ERR("opening %s failed (%s)", fn, strerror(errno));
623         goto error;
624     }
625
626     for (ln = 1; fgets(line, sizeof line, file); ln++) {
627         char name[64];
628         int major;
629
630         if (!strncmp(line, "Character", 9) || line[0] == '\0') {
631             /* Nothing to do. */
632         } else if (!strncmp(line, "Block", 5)) {
633             /* We only want character devices, so skip the rest of the file. */
634             break;
635         } else if (sscanf(line, "%d %63s", &major, name)) {
636             if (!strcmp(name, target)) {
637                 fclose(file);
638                 return major;
639             }
640         } else {
641             static bool warned;
642             if (!warned) {
643                 VLOG_WARN("%s:%d: syntax error", fn, ln);
644             }
645             warned = true;
646         }
647     }
648
649     VLOG_ERR("%s: %s major not found (is the module loaded?), using "
650              "default major %d", fn, target, default_major);
651 error:
652     VLOG_INFO("using default major %d for %s", default_major, target);
653     return default_major;
654 }
655
656 static int
657 finish_open(struct dpif *dpif_, const char *local_ifname)
658 {
659     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
660     dpif->local_ifname = strdup(local_ifname);
661     dpif->local_ifindex = if_nametoindex(local_ifname);
662     if (!dpif->local_ifindex) {
663         int error = errno;
664         dpif_close(dpif_);
665         VLOG_WARN("could not get ifindex of %s device: %s",
666                   local_ifname, strerror(errno));
667         return error;
668     }
669     return 0;
670 }
671
672 static int
673 create_minor(const char *name, int minor, struct dpif **dpifp)
674 {
675     int error = open_minor(minor, dpifp);
676     if (!error) {
677         error = do_ioctl(*dpifp, ODP_DP_CREATE, name);
678         if (!error) {
679             error = finish_open(*dpifp, name);
680         } else {
681             dpif_close(*dpifp);
682         }
683     }
684     return error;
685 }
686
687 static int
688 open_minor(int minor, struct dpif **dpifp)
689 {
690     int error;
691     char *fn;
692     int fd;
693
694     error = make_openvswitch_device(minor, &fn);
695     if (error) {
696         return error;
697     }
698
699     fd = open(fn, O_RDONLY | O_NONBLOCK);
700     if (fd >= 0) {
701         struct dpif_linux *dpif = xmalloc(sizeof *dpif);
702         error = rtnetlink_notifier_register(&dpif->port_notifier,
703                                            dpif_linux_port_changed, dpif);
704         if (!error) {
705             char *name;
706
707             name = xasprintf("dp%d", minor);
708             dpif_init(&dpif->dpif, &dpif_linux_class, name, minor, minor);
709             free(name);
710
711             dpif->fd = fd;
712             dpif->local_ifname = NULL;
713             dpif->minor = minor;
714             dpif->local_ifindex = 0;
715             svec_init(&dpif->changed_ports);
716             dpif->change_error = false;
717             *dpifp = &dpif->dpif;
718         } else {
719             free(dpif);
720         }
721     } else {
722         error = errno;
723         VLOG_WARN("%s: open failed (%s)", fn, strerror(error));
724     }
725     free(fn);
726
727     return error;
728 }
729
730 static void
731 dpif_linux_port_changed(const struct rtnetlink_change *change, void *dpif_)
732 {
733     struct dpif_linux *dpif = dpif_;
734
735     if (change) {
736         if (change->master_ifindex == dpif->local_ifindex
737             && (change->nlmsg_type == RTM_NEWLINK
738                 || change->nlmsg_type == RTM_DELLINK))
739         {
740             /* Our datapath changed, either adding a new port or deleting an
741              * existing one. */
742             if (!svec_contains(&dpif->changed_ports, change->ifname)) {
743                 svec_add(&dpif->changed_ports, change->ifname);
744                 svec_sort(&dpif->changed_ports);
745             }
746         }
747     } else {
748         dpif->change_error = true;
749     }
750 }