netlink-socket: Make caller provide message receive buffers.
[openvswitch] / lib / dpif-linux.c
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 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
19 #include "dpif-linux.h"
20
21 #include <assert.h>
22 #include <ctype.h>
23 #include <errno.h>
24 #include <fcntl.h>
25 #include <inttypes.h>
26 #include <net/if.h>
27 #include <linux/types.h>
28 #include <linux/pkt_sched.h>
29 #include <linux/rtnetlink.h>
30 #include <linux/sockios.h>
31 #include <poll.h>
32 #include <stdlib.h>
33 #include <strings.h>
34 #include <sys/epoll.h>
35 #include <sys/stat.h>
36 #include <unistd.h>
37
38 #include "bitmap.h"
39 #include "dpif-provider.h"
40 #include "dynamic-string.h"
41 #include "flow.h"
42 #include "netdev.h"
43 #include "netdev-linux.h"
44 #include "netdev-vport.h"
45 #include "netlink-notifier.h"
46 #include "netlink-socket.h"
47 #include "netlink.h"
48 #include "odp-util.h"
49 #include "ofpbuf.h"
50 #include "openvswitch/datapath-compat.h"
51 #include "openvswitch/tunnel.h"
52 #include "packets.h"
53 #include "poll-loop.h"
54 #include "random.h"
55 #include "shash.h"
56 #include "sset.h"
57 #include "unaligned.h"
58 #include "util.h"
59 #include "vlog.h"
60
61 VLOG_DEFINE_THIS_MODULE(dpif_linux);
62 enum { MAX_PORTS = USHRT_MAX };
63
64 enum { N_UPCALL_SOCKS = 16 };
65 BUILD_ASSERT_DECL(IS_POW2(N_UPCALL_SOCKS));
66 BUILD_ASSERT_DECL(N_UPCALL_SOCKS <= 32); /* We use a 32-bit word as a mask. */
67
68 /* This ethtool flag was introduced in Linux 2.6.24, so it might be
69  * missing if we have old headers. */
70 #define ETH_FLAG_LRO      (1 << 15)    /* LRO is enabled */
71
72 struct dpif_linux_dp {
73     /* Generic Netlink header. */
74     uint8_t cmd;
75
76     /* struct ovs_header. */
77     int dp_ifindex;
78
79     /* Attributes. */
80     const char *name;                  /* OVS_DP_ATTR_NAME. */
81     const uint32_t *upcall_pid;        /* OVS_DP_UPCALL_PID. */
82     struct ovs_dp_stats stats;         /* OVS_DP_ATTR_STATS. */
83 };
84
85 static void dpif_linux_dp_init(struct dpif_linux_dp *);
86 static int dpif_linux_dp_from_ofpbuf(struct dpif_linux_dp *,
87                                      const struct ofpbuf *);
88 static void dpif_linux_dp_dump_start(struct nl_dump *);
89 static int dpif_linux_dp_transact(const struct dpif_linux_dp *request,
90                                   struct dpif_linux_dp *reply,
91                                   struct ofpbuf **bufp);
92 static int dpif_linux_dp_get(const struct dpif *, struct dpif_linux_dp *reply,
93                              struct ofpbuf **bufp);
94
95 struct dpif_linux_flow {
96     /* Generic Netlink header. */
97     uint8_t cmd;
98
99     /* struct ovs_header. */
100     unsigned int nlmsg_flags;
101     int dp_ifindex;
102
103     /* Attributes.
104      *
105      * The 'stats' member points to 64-bit data that might only be aligned on
106      * 32-bit boundaries, so get_unaligned_u64() should be used to access its
107      * values.
108      *
109      * If 'actions' is nonnull then OVS_FLOW_ATTR_ACTIONS will be included in
110      * the Netlink version of the command, even if actions_len is zero. */
111     const struct nlattr *key;           /* OVS_FLOW_ATTR_KEY. */
112     size_t key_len;
113     const struct nlattr *actions;       /* OVS_FLOW_ATTR_ACTIONS. */
114     size_t actions_len;
115     const struct ovs_flow_stats *stats; /* OVS_FLOW_ATTR_STATS. */
116     const uint8_t *tcp_flags;           /* OVS_FLOW_ATTR_TCP_FLAGS. */
117     const ovs_32aligned_u64 *used;      /* OVS_FLOW_ATTR_USED. */
118     bool clear;                         /* OVS_FLOW_ATTR_CLEAR. */
119 };
120
121 static void dpif_linux_flow_init(struct dpif_linux_flow *);
122 static int dpif_linux_flow_from_ofpbuf(struct dpif_linux_flow *,
123                                        const struct ofpbuf *);
124 static void dpif_linux_flow_to_ofpbuf(const struct dpif_linux_flow *,
125                                       struct ofpbuf *);
126 static int dpif_linux_flow_transact(struct dpif_linux_flow *request,
127                                     struct dpif_linux_flow *reply,
128                                     struct ofpbuf **bufp);
129 static void dpif_linux_flow_get_stats(const struct dpif_linux_flow *,
130                                       struct dpif_flow_stats *);
131
132 /* Datapath interface for the openvswitch Linux kernel module. */
133 struct dpif_linux {
134     struct dpif dpif;
135     int dp_ifindex;
136
137     /* Upcall messages. */
138     struct nl_sock *upcall_socks[N_UPCALL_SOCKS];
139     uint32_t ready_mask;        /* 1-bit for each sock with unread messages. */
140     int epoll_fd;               /* epoll fd that includes the upcall socks. */
141
142     /* Change notification. */
143     struct sset changed_ports;  /* Ports that have changed. */
144     struct nln_notifier *port_notifier;
145     bool change_error;
146
147     /* Port number allocation. */
148     uint16_t alloc_port_no;
149 };
150
151 static struct vlog_rate_limit error_rl = VLOG_RATE_LIMIT_INIT(9999, 5);
152
153 /* Generic Netlink family numbers for OVS. */
154 static int ovs_datapath_family;
155 static int ovs_vport_family;
156 static int ovs_flow_family;
157 static int ovs_packet_family;
158
159 /* Generic Netlink socket. */
160 static struct nl_sock *genl_sock;
161 static struct nln *nln = NULL;
162
163 static int dpif_linux_init(void);
164 static void open_dpif(const struct dpif_linux_dp *, struct dpif **);
165 static bool dpif_linux_nln_parse(struct ofpbuf *, void *);
166 static void dpif_linux_port_changed(const void *vport, void *dpif);
167 static uint32_t dpif_linux_port_get_pid(const struct dpif *, uint16_t port_no);
168
169 static void dpif_linux_vport_to_ofpbuf(const struct dpif_linux_vport *,
170                                        struct ofpbuf *);
171 static int dpif_linux_vport_from_ofpbuf(struct dpif_linux_vport *,
172                                         const struct ofpbuf *);
173
174 static struct dpif_linux *
175 dpif_linux_cast(const struct dpif *dpif)
176 {
177     dpif_assert_class(dpif, &dpif_linux_class);
178     return CONTAINER_OF(dpif, struct dpif_linux, dpif);
179 }
180
181 static int
182 dpif_linux_enumerate(struct sset *all_dps)
183 {
184     struct nl_dump dump;
185     struct ofpbuf msg;
186     int error;
187
188     error = dpif_linux_init();
189     if (error) {
190         return error;
191     }
192
193     dpif_linux_dp_dump_start(&dump);
194     while (nl_dump_next(&dump, &msg)) {
195         struct dpif_linux_dp dp;
196
197         if (!dpif_linux_dp_from_ofpbuf(&dp, &msg)) {
198             sset_add(all_dps, dp.name);
199         }
200     }
201     return nl_dump_done(&dump);
202 }
203
204 static int
205 dpif_linux_open(const struct dpif_class *class OVS_UNUSED, const char *name,
206                 bool create, struct dpif **dpifp)
207 {
208     struct dpif_linux_dp dp_request, dp;
209     struct ofpbuf *buf;
210     uint32_t upcall_pid;
211     int error;
212
213     error = dpif_linux_init();
214     if (error) {
215         return error;
216     }
217
218     /* Create or look up datapath. */
219     dpif_linux_dp_init(&dp_request);
220     if (create) {
221         dp_request.cmd = OVS_DP_CMD_NEW;
222         upcall_pid = 0;
223         dp_request.upcall_pid = &upcall_pid;
224     } else {
225         dp_request.cmd = OVS_DP_CMD_GET;
226     }
227     dp_request.name = name;
228     error = dpif_linux_dp_transact(&dp_request, &dp, &buf);
229     if (error) {
230         return error;
231     }
232
233     open_dpif(&dp, dpifp);
234     ofpbuf_delete(buf);
235     return 0;
236 }
237
238 static void
239 open_dpif(const struct dpif_linux_dp *dp, struct dpif **dpifp)
240 {
241     struct dpif_linux *dpif;
242
243     dpif = xzalloc(sizeof *dpif);
244     dpif->port_notifier = nln_notifier_create(nln, dpif_linux_port_changed,
245                                               dpif);
246     dpif->epoll_fd = -1;
247
248     dpif_init(&dpif->dpif, &dpif_linux_class, dp->name,
249               dp->dp_ifindex, dp->dp_ifindex);
250
251     dpif->dp_ifindex = dp->dp_ifindex;
252     sset_init(&dpif->changed_ports);
253     *dpifp = &dpif->dpif;
254 }
255
256 static void
257 destroy_upcall_socks(struct dpif_linux *dpif)
258 {
259     int i;
260
261     if (dpif->epoll_fd >= 0) {
262         close(dpif->epoll_fd);
263         dpif->epoll_fd = -1;
264     }
265     for (i = 0; i < N_UPCALL_SOCKS; i++) {
266         nl_sock_destroy(dpif->upcall_socks[i]);
267         dpif->upcall_socks[i] = NULL;
268     }
269 }
270
271 static void
272 dpif_linux_close(struct dpif *dpif_)
273 {
274     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
275
276     nln_notifier_destroy(dpif->port_notifier);
277     destroy_upcall_socks(dpif);
278     sset_destroy(&dpif->changed_ports);
279     free(dpif);
280 }
281
282 static int
283 dpif_linux_destroy(struct dpif *dpif_)
284 {
285     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
286     struct dpif_linux_dp dp;
287
288     dpif_linux_dp_init(&dp);
289     dp.cmd = OVS_DP_CMD_DEL;
290     dp.dp_ifindex = dpif->dp_ifindex;
291     return dpif_linux_dp_transact(&dp, NULL, NULL);
292 }
293
294 static void
295 dpif_linux_run(struct dpif *dpif OVS_UNUSED)
296 {
297     if (nln) {
298         nln_run(nln);
299     }
300 }
301
302 static void
303 dpif_linux_wait(struct dpif *dpif OVS_UNUSED)
304 {
305     if (nln) {
306         nln_wait(nln);
307     }
308 }
309
310 static int
311 dpif_linux_get_stats(const struct dpif *dpif_, struct dpif_dp_stats *stats)
312 {
313     struct dpif_linux_dp dp;
314     struct ofpbuf *buf;
315     int error;
316
317     error = dpif_linux_dp_get(dpif_, &dp, &buf);
318     if (!error) {
319         stats->n_hit    = dp.stats.n_hit;
320         stats->n_missed = dp.stats.n_missed;
321         stats->n_lost   = dp.stats.n_lost;
322         stats->n_flows  = dp.stats.n_flows;
323         ofpbuf_delete(buf);
324     }
325     return error;
326 }
327
328 static int
329 dpif_linux_port_add(struct dpif *dpif_, struct netdev *netdev,
330                     uint16_t *port_nop)
331 {
332     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
333     const char *name = netdev_get_name(netdev);
334     const char *type = netdev_get_type(netdev);
335     struct dpif_linux_vport request, reply;
336     const struct ofpbuf *options;
337     struct ofpbuf *buf;
338     int error, i = 0, max_ports = MAX_PORTS;
339
340     dpif_linux_vport_init(&request);
341     request.cmd = OVS_VPORT_CMD_NEW;
342     request.dp_ifindex = dpif->dp_ifindex;
343     request.type = netdev_vport_get_vport_type(netdev);
344     if (request.type == OVS_VPORT_TYPE_UNSPEC) {
345         VLOG_WARN_RL(&error_rl, "%s: cannot create port `%s' because it has "
346                      "unsupported type `%s'",
347                      dpif_name(dpif_), name, type);
348         return EINVAL;
349     }
350     request.name = name;
351
352     options = netdev_vport_get_options(netdev);
353     if (options && options->size) {
354         request.options = options->data;
355         request.options_len = options->size;
356     }
357
358     if (request.type == OVS_VPORT_TYPE_NETDEV) {
359         netdev_linux_ethtool_set_flag(netdev, ETH_FLAG_LRO, "LRO", false);
360     }
361
362     /* Loop until we find a port that isn't used. */
363     do {
364         uint32_t upcall_pid;
365
366         request.port_no = ++dpif->alloc_port_no;
367         upcall_pid = dpif_linux_port_get_pid(dpif_, request.port_no);
368         request.upcall_pid = &upcall_pid;
369         error = dpif_linux_vport_transact(&request, &reply, &buf);
370
371         if (!error) {
372             *port_nop = reply.port_no;
373             VLOG_DBG("%s: assigning port %"PRIu32" to netlink pid %"PRIu32,
374                      dpif_name(dpif_), request.port_no, upcall_pid);
375         } else if (error == EFBIG) {
376             /* Older datapath has lower limit. */
377             max_ports = dpif->alloc_port_no;
378             dpif->alloc_port_no = 0;
379         }
380
381         ofpbuf_delete(buf);
382     } while ((i++ < max_ports)
383              && (error == EBUSY || error == EFBIG));
384
385     return error;
386 }
387
388 static int
389 dpif_linux_port_del(struct dpif *dpif_, uint16_t port_no)
390 {
391     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
392     struct dpif_linux_vport vport;
393     int error;
394
395     dpif_linux_vport_init(&vport);
396     vport.cmd = OVS_VPORT_CMD_DEL;
397     vport.dp_ifindex = dpif->dp_ifindex;
398     vport.port_no = port_no;
399     error = dpif_linux_vport_transact(&vport, NULL, NULL);
400
401     return error;
402 }
403
404 static int
405 dpif_linux_port_query__(const struct dpif *dpif, uint32_t port_no,
406                         const char *port_name, struct dpif_port *dpif_port)
407 {
408     struct dpif_linux_vport request;
409     struct dpif_linux_vport reply;
410     struct ofpbuf *buf;
411     int error;
412
413     dpif_linux_vport_init(&request);
414     request.cmd = OVS_VPORT_CMD_GET;
415     request.dp_ifindex = dpif_linux_cast(dpif)->dp_ifindex;
416     request.port_no = port_no;
417     request.name = port_name;
418
419     error = dpif_linux_vport_transact(&request, &reply, &buf);
420     if (!error) {
421         if (reply.dp_ifindex != request.dp_ifindex) {
422             /* A query by name reported that 'port_name' is in some datapath
423              * other than 'dpif', but the caller wants to know about 'dpif'. */
424             error = ENODEV;
425         } else {
426             dpif_port->name = xstrdup(reply.name);
427             dpif_port->type = xstrdup(netdev_vport_get_netdev_type(&reply));
428             dpif_port->port_no = reply.port_no;
429         }
430         ofpbuf_delete(buf);
431     }
432     return error;
433 }
434
435 static int
436 dpif_linux_port_query_by_number(const struct dpif *dpif, uint16_t port_no,
437                                 struct dpif_port *dpif_port)
438 {
439     return dpif_linux_port_query__(dpif, port_no, NULL, dpif_port);
440 }
441
442 static int
443 dpif_linux_port_query_by_name(const struct dpif *dpif, const char *devname,
444                               struct dpif_port *dpif_port)
445 {
446     return dpif_linux_port_query__(dpif, 0, devname, dpif_port);
447 }
448
449 static int
450 dpif_linux_get_max_ports(const struct dpif *dpif OVS_UNUSED)
451 {
452     return MAX_PORTS;
453 }
454
455 static uint32_t
456 dpif_linux_port_get_pid(const struct dpif *dpif_, uint16_t port_no)
457 {
458     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
459
460     if (dpif->epoll_fd < 0) {
461         return 0;
462     } else {
463         int idx = port_no & (N_UPCALL_SOCKS - 1);
464         return nl_sock_pid(dpif->upcall_socks[idx]);
465     }
466 }
467
468 static int
469 dpif_linux_flow_flush(struct dpif *dpif_)
470 {
471     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
472     struct dpif_linux_flow flow;
473
474     dpif_linux_flow_init(&flow);
475     flow.cmd = OVS_FLOW_CMD_DEL;
476     flow.dp_ifindex = dpif->dp_ifindex;
477     return dpif_linux_flow_transact(&flow, NULL, NULL);
478 }
479
480 struct dpif_linux_port_state {
481     struct nl_dump dump;
482 };
483
484 static int
485 dpif_linux_port_dump_start(const struct dpif *dpif_, void **statep)
486 {
487     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
488     struct dpif_linux_port_state *state;
489     struct dpif_linux_vport request;
490     struct ofpbuf *buf;
491
492     *statep = state = xmalloc(sizeof *state);
493
494     dpif_linux_vport_init(&request);
495     request.cmd = OVS_DP_CMD_GET;
496     request.dp_ifindex = dpif->dp_ifindex;
497
498     buf = ofpbuf_new(1024);
499     dpif_linux_vport_to_ofpbuf(&request, buf);
500     nl_dump_start(&state->dump, genl_sock, buf);
501     ofpbuf_delete(buf);
502
503     return 0;
504 }
505
506 static int
507 dpif_linux_port_dump_next(const struct dpif *dpif OVS_UNUSED, void *state_,
508                           struct dpif_port *dpif_port)
509 {
510     struct dpif_linux_port_state *state = state_;
511     struct dpif_linux_vport vport;
512     struct ofpbuf buf;
513     int error;
514
515     if (!nl_dump_next(&state->dump, &buf)) {
516         return EOF;
517     }
518
519     error = dpif_linux_vport_from_ofpbuf(&vport, &buf);
520     if (error) {
521         return error;
522     }
523
524     dpif_port->name = (char *) vport.name;
525     dpif_port->type = (char *) netdev_vport_get_netdev_type(&vport);
526     dpif_port->port_no = vport.port_no;
527     return 0;
528 }
529
530 static int
531 dpif_linux_port_dump_done(const struct dpif *dpif_ OVS_UNUSED, void *state_)
532 {
533     struct dpif_linux_port_state *state = state_;
534     int error = nl_dump_done(&state->dump);
535
536     free(state);
537     return error;
538 }
539
540 static int
541 dpif_linux_port_poll(const struct dpif *dpif_, char **devnamep)
542 {
543     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
544
545     if (dpif->change_error) {
546         dpif->change_error = false;
547         sset_clear(&dpif->changed_ports);
548         return ENOBUFS;
549     } else if (!sset_is_empty(&dpif->changed_ports)) {
550         *devnamep = sset_pop(&dpif->changed_ports);
551         return 0;
552     } else {
553         return EAGAIN;
554     }
555 }
556
557 static void
558 dpif_linux_port_poll_wait(const struct dpif *dpif_)
559 {
560     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
561     if (!sset_is_empty(&dpif->changed_ports) || dpif->change_error) {
562         poll_immediate_wake();
563     }
564 }
565
566 static int
567 dpif_linux_flow_get__(const struct dpif *dpif_,
568                       const struct nlattr *key, size_t key_len,
569                       struct dpif_linux_flow *reply, struct ofpbuf **bufp)
570 {
571     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
572     struct dpif_linux_flow request;
573
574     dpif_linux_flow_init(&request);
575     request.cmd = OVS_FLOW_CMD_GET;
576     request.dp_ifindex = dpif->dp_ifindex;
577     request.key = key;
578     request.key_len = key_len;
579     return dpif_linux_flow_transact(&request, reply, bufp);
580 }
581
582 static int
583 dpif_linux_flow_get(const struct dpif *dpif_,
584                     const struct nlattr *key, size_t key_len,
585                     struct ofpbuf **actionsp, struct dpif_flow_stats *stats)
586 {
587     struct dpif_linux_flow reply;
588     struct ofpbuf *buf;
589     int error;
590
591     error = dpif_linux_flow_get__(dpif_, key, key_len, &reply, &buf);
592     if (!error) {
593         if (stats) {
594             dpif_linux_flow_get_stats(&reply, stats);
595         }
596         if (actionsp) {
597             buf->data = (void *) reply.actions;
598             buf->size = reply.actions_len;
599             *actionsp = buf;
600         } else {
601             ofpbuf_delete(buf);
602         }
603     }
604     return error;
605 }
606
607 static void
608 dpif_linux_init_flow_put(struct dpif *dpif_, const struct dpif_flow_put *put,
609                          struct dpif_linux_flow *request)
610 {
611     static struct nlattr dummy_action;
612
613     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
614
615     dpif_linux_flow_init(request);
616     request->cmd = (put->flags & DPIF_FP_CREATE
617                     ? OVS_FLOW_CMD_NEW : OVS_FLOW_CMD_SET);
618     request->dp_ifindex = dpif->dp_ifindex;
619     request->key = put->key;
620     request->key_len = put->key_len;
621     /* Ensure that OVS_FLOW_ATTR_ACTIONS will always be included. */
622     request->actions = put->actions ? put->actions : &dummy_action;
623     request->actions_len = put->actions_len;
624     if (put->flags & DPIF_FP_ZERO_STATS) {
625         request->clear = true;
626     }
627     request->nlmsg_flags = put->flags & DPIF_FP_MODIFY ? 0 : NLM_F_CREATE;
628 }
629
630 static int
631 dpif_linux_flow_put(struct dpif *dpif_, const struct dpif_flow_put *put)
632 {
633     struct dpif_linux_flow request, reply;
634     struct ofpbuf *buf;
635     int error;
636
637     dpif_linux_init_flow_put(dpif_, put, &request);
638     error = dpif_linux_flow_transact(&request,
639                                      put->stats ? &reply : NULL,
640                                      put->stats ? &buf : NULL);
641     if (!error && put->stats) {
642         dpif_linux_flow_get_stats(&reply, put->stats);
643         ofpbuf_delete(buf);
644     }
645     return error;
646 }
647
648 static void
649 dpif_linux_init_flow_del(struct dpif *dpif_, const struct dpif_flow_del *del,
650                          struct dpif_linux_flow *request)
651 {
652     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
653
654     dpif_linux_flow_init(request);
655     request->cmd = OVS_FLOW_CMD_DEL;
656     request->dp_ifindex = dpif->dp_ifindex;
657     request->key = del->key;
658     request->key_len = del->key_len;
659 }
660
661 static int
662 dpif_linux_flow_del(struct dpif *dpif_, const struct dpif_flow_del *del)
663 {
664     struct dpif_linux_flow request, reply;
665     struct ofpbuf *buf;
666     int error;
667
668     dpif_linux_init_flow_del(dpif_, del, &request);
669     error = dpif_linux_flow_transact(&request,
670                                      del->stats ? &reply : NULL,
671                                      del->stats ? &buf : NULL);
672     if (!error && del->stats) {
673         dpif_linux_flow_get_stats(&reply, del->stats);
674         ofpbuf_delete(buf);
675     }
676     return error;
677 }
678
679 struct dpif_linux_flow_state {
680     struct nl_dump dump;
681     struct dpif_linux_flow flow;
682     struct dpif_flow_stats stats;
683     struct ofpbuf *buf;
684 };
685
686 static int
687 dpif_linux_flow_dump_start(const struct dpif *dpif_, void **statep)
688 {
689     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
690     struct dpif_linux_flow_state *state;
691     struct dpif_linux_flow request;
692     struct ofpbuf *buf;
693
694     *statep = state = xmalloc(sizeof *state);
695
696     dpif_linux_flow_init(&request);
697     request.cmd = OVS_DP_CMD_GET;
698     request.dp_ifindex = dpif->dp_ifindex;
699
700     buf = ofpbuf_new(1024);
701     dpif_linux_flow_to_ofpbuf(&request, buf);
702     nl_dump_start(&state->dump, genl_sock, buf);
703     ofpbuf_delete(buf);
704
705     state->buf = NULL;
706
707     return 0;
708 }
709
710 static int
711 dpif_linux_flow_dump_next(const struct dpif *dpif_ OVS_UNUSED, void *state_,
712                           const struct nlattr **key, size_t *key_len,
713                           const struct nlattr **actions, size_t *actions_len,
714                           const struct dpif_flow_stats **stats)
715 {
716     struct dpif_linux_flow_state *state = state_;
717     struct ofpbuf buf;
718     int error;
719
720     do {
721         ofpbuf_delete(state->buf);
722         state->buf = NULL;
723
724         if (!nl_dump_next(&state->dump, &buf)) {
725             return EOF;
726         }
727
728         error = dpif_linux_flow_from_ofpbuf(&state->flow, &buf);
729         if (error) {
730             return error;
731         }
732
733         if (actions && !state->flow.actions) {
734             error = dpif_linux_flow_get__(dpif_, state->flow.key,
735                                           state->flow.key_len,
736                                           &state->flow, &state->buf);
737             if (error == ENOENT) {
738                 VLOG_DBG("dumped flow disappeared on get");
739             } else if (error) {
740                 VLOG_WARN("error fetching dumped flow: %s", strerror(error));
741             }
742         }
743     } while (error);
744
745     if (actions) {
746         *actions = state->flow.actions;
747         *actions_len = state->flow.actions_len;
748     }
749     if (key) {
750         *key = state->flow.key;
751         *key_len = state->flow.key_len;
752     }
753     if (stats) {
754         dpif_linux_flow_get_stats(&state->flow, &state->stats);
755         *stats = &state->stats;
756     }
757     return error;
758 }
759
760 static int
761 dpif_linux_flow_dump_done(const struct dpif *dpif OVS_UNUSED, void *state_)
762 {
763     struct dpif_linux_flow_state *state = state_;
764     int error = nl_dump_done(&state->dump);
765     ofpbuf_delete(state->buf);
766     free(state);
767     return error;
768 }
769
770 static void
771 dpif_linux_encode_execute(int dp_ifindex, const struct dpif_execute *d_exec,
772                           struct ofpbuf *buf)
773 {
774     struct ovs_header *k_exec;
775
776     ofpbuf_prealloc_tailroom(buf, (64
777                                    + d_exec->packet->size
778                                    + d_exec->key_len
779                                    + d_exec->actions_len));
780
781     nl_msg_put_genlmsghdr(buf, 0, ovs_packet_family, NLM_F_REQUEST,
782                           OVS_PACKET_CMD_EXECUTE, OVS_PACKET_VERSION);
783
784     k_exec = ofpbuf_put_uninit(buf, sizeof *k_exec);
785     k_exec->dp_ifindex = dp_ifindex;
786
787     nl_msg_put_unspec(buf, OVS_PACKET_ATTR_PACKET,
788                       d_exec->packet->data, d_exec->packet->size);
789     nl_msg_put_unspec(buf, OVS_PACKET_ATTR_KEY, d_exec->key, d_exec->key_len);
790     nl_msg_put_unspec(buf, OVS_PACKET_ATTR_ACTIONS,
791                       d_exec->actions, d_exec->actions_len);
792 }
793
794 static int
795 dpif_linux_execute__(int dp_ifindex, const struct dpif_execute *execute)
796 {
797     uint64_t request_stub[1024 / 8];
798     struct ofpbuf request;
799     int error;
800
801     ofpbuf_use_stub(&request, request_stub, sizeof request_stub);
802     dpif_linux_encode_execute(dp_ifindex, execute, &request);
803     error = nl_sock_transact(genl_sock, &request, NULL);
804     ofpbuf_uninit(&request);
805
806     return error;
807 }
808
809 static int
810 dpif_linux_execute(struct dpif *dpif_, const struct dpif_execute *execute)
811 {
812     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
813
814     return dpif_linux_execute__(dpif->dp_ifindex, execute);
815 }
816
817 #define MAX_OPS 50
818
819 static void
820 dpif_linux_operate__(struct dpif *dpif_, struct dpif_op **ops, size_t n_ops)
821 {
822     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
823
824     struct op_auxdata {
825         struct nl_transaction txn;
826
827         struct ofpbuf request;
828         uint64_t request_stub[1024 / 8];
829
830         struct ofpbuf reply;
831         uint64_t reply_stub[1024 / 8];
832     } auxes[MAX_OPS];
833
834     struct nl_transaction *txnsp[MAX_OPS];
835     size_t i;
836
837     assert(n_ops <= MAX_OPS);
838     for (i = 0; i < n_ops; i++) {
839         struct op_auxdata *aux = &auxes[i];
840         struct dpif_op *op = ops[i];
841         struct dpif_flow_put *put;
842         struct dpif_flow_del *del;
843         struct dpif_execute *execute;
844         struct dpif_linux_flow flow;
845
846         ofpbuf_use_stub(&aux->request,
847                         aux->request_stub, sizeof aux->request_stub);
848         aux->txn.request = &aux->request;
849
850         ofpbuf_use_stub(&aux->reply, aux->reply_stub, sizeof aux->reply_stub);
851         aux->txn.reply = NULL;
852
853         switch (op->type) {
854         case DPIF_OP_FLOW_PUT:
855             put = &op->u.flow_put;
856             dpif_linux_init_flow_put(dpif_, put, &flow);
857             if (put->stats) {
858                 flow.nlmsg_flags |= NLM_F_ECHO;
859                 aux->txn.reply = &aux->reply;
860             }
861             dpif_linux_flow_to_ofpbuf(&flow, &aux->request);
862             break;
863
864         case DPIF_OP_FLOW_DEL:
865             del = &op->u.flow_del;
866             dpif_linux_init_flow_del(dpif_, del, &flow);
867             if (del->stats) {
868                 flow.nlmsg_flags |= NLM_F_ECHO;
869                 aux->txn.reply = &aux->reply;
870             }
871             dpif_linux_flow_to_ofpbuf(&flow, &aux->request);
872             break;
873
874         case DPIF_OP_EXECUTE:
875             execute = &op->u.execute;
876             dpif_linux_encode_execute(dpif->dp_ifindex, execute,
877                                       &aux->request);
878             break;
879
880         default:
881             NOT_REACHED();
882         }
883     }
884
885     for (i = 0; i < n_ops; i++) {
886         txnsp[i] = &auxes[i].txn;
887     }
888     nl_sock_transact_multiple(genl_sock, txnsp, n_ops);
889
890     for (i = 0; i < n_ops; i++) {
891         struct op_auxdata *aux = &auxes[i];
892         struct nl_transaction *txn = &auxes[i].txn;
893         struct dpif_op *op = ops[i];
894         struct dpif_flow_put *put;
895         struct dpif_flow_del *del;
896
897         op->error = txn->error;
898
899         switch (op->type) {
900         case DPIF_OP_FLOW_PUT:
901             put = &op->u.flow_put;
902             if (!op->error && put->stats) {
903                 struct dpif_linux_flow reply;
904
905                 op->error = dpif_linux_flow_from_ofpbuf(&reply, txn->reply);
906                 if (!op->error) {
907                     dpif_linux_flow_get_stats(&reply, put->stats);
908                 }
909             }
910             break;
911
912         case DPIF_OP_FLOW_DEL:
913             del = &op->u.flow_del;
914             if (!op->error && del->stats) {
915                 struct dpif_linux_flow reply;
916
917                 op->error = dpif_linux_flow_from_ofpbuf(&reply, txn->reply);
918                 if (!op->error) {
919                     dpif_linux_flow_get_stats(&reply, del->stats);
920                 }
921             }
922             break;
923
924         case DPIF_OP_EXECUTE:
925             break;
926
927         default:
928             NOT_REACHED();
929         }
930
931         ofpbuf_uninit(&aux->request);
932         ofpbuf_uninit(&aux->reply);
933     }
934 }
935
936 static void
937 dpif_linux_operate(struct dpif *dpif, struct dpif_op **ops, size_t n_ops)
938 {
939     while (n_ops > 0) {
940         size_t chunk = MIN(n_ops, MAX_OPS);
941         dpif_linux_operate__(dpif, ops, chunk);
942         ops += chunk;
943         n_ops -= chunk;
944     }
945 }
946
947 static void
948 set_upcall_pids(struct dpif *dpif_)
949 {
950     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
951     struct dpif_port_dump port_dump;
952     struct dpif_port port;
953     int error;
954
955     DPIF_PORT_FOR_EACH (&port, &port_dump, &dpif->dpif) {
956         uint32_t upcall_pid = dpif_linux_port_get_pid(dpif_, port.port_no);
957         struct dpif_linux_vport vport_request;
958
959         dpif_linux_vport_init(&vport_request);
960         vport_request.cmd = OVS_VPORT_CMD_SET;
961         vport_request.dp_ifindex = dpif->dp_ifindex;
962         vport_request.port_no = port.port_no;
963         vport_request.upcall_pid = &upcall_pid;
964         error = dpif_linux_vport_transact(&vport_request, NULL, NULL);
965         if (!error) {
966             VLOG_DBG("%s: assigning port %"PRIu32" to netlink pid %"PRIu32,
967                      dpif_name(&dpif->dpif), vport_request.port_no,
968                      upcall_pid);
969         } else {
970             VLOG_WARN_RL(&error_rl, "%s: failed to set upcall pid on port: %s",
971                          dpif_name(&dpif->dpif), strerror(error));
972         }
973     }
974 }
975
976 static int
977 dpif_linux_recv_set(struct dpif *dpif_, bool enable)
978 {
979     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
980
981     if ((dpif->epoll_fd >= 0) == enable) {
982         return 0;
983     }
984
985     if (!enable) {
986         destroy_upcall_socks(dpif);
987     } else {
988         int i;
989         int error;
990
991         dpif->epoll_fd = epoll_create(N_UPCALL_SOCKS);
992         if (dpif->epoll_fd < 0) {
993             return errno;
994         }
995
996         for (i = 0; i < N_UPCALL_SOCKS; i++) {
997             struct epoll_event event;
998
999             error = nl_sock_create(NETLINK_GENERIC, &dpif->upcall_socks[i]);
1000             if (error) {
1001                 destroy_upcall_socks(dpif);
1002                 return error;
1003             }
1004
1005             memset(&event, 0, sizeof event);
1006             event.events = EPOLLIN;
1007             event.data.u32 = i;
1008             if (epoll_ctl(dpif->epoll_fd, EPOLL_CTL_ADD,
1009                           nl_sock_fd(dpif->upcall_socks[i]), &event) < 0) {
1010                 error = errno;
1011                 destroy_upcall_socks(dpif);
1012                 return error;
1013             }
1014         }
1015
1016         dpif->ready_mask = 0;
1017     }
1018
1019     set_upcall_pids(dpif_);
1020
1021     return 0;
1022 }
1023
1024 static int
1025 dpif_linux_queue_to_priority(const struct dpif *dpif OVS_UNUSED,
1026                              uint32_t queue_id, uint32_t *priority)
1027 {
1028     if (queue_id < 0xf000) {
1029         *priority = TC_H_MAKE(1 << 16, queue_id + 1);
1030         return 0;
1031     } else {
1032         return EINVAL;
1033     }
1034 }
1035
1036 static int
1037 parse_odp_packet(struct ofpbuf *buf, struct dpif_upcall *upcall,
1038                  int *dp_ifindex)
1039 {
1040     static const struct nl_policy ovs_packet_policy[] = {
1041         /* Always present. */
1042         [OVS_PACKET_ATTR_PACKET] = { .type = NL_A_UNSPEC,
1043                                      .min_len = ETH_HEADER_LEN },
1044         [OVS_PACKET_ATTR_KEY] = { .type = NL_A_NESTED },
1045
1046         /* OVS_PACKET_CMD_ACTION only. */
1047         [OVS_PACKET_ATTR_USERDATA] = { .type = NL_A_U64, .optional = true },
1048     };
1049
1050     struct ovs_header *ovs_header;
1051     struct nlattr *a[ARRAY_SIZE(ovs_packet_policy)];
1052     struct nlmsghdr *nlmsg;
1053     struct genlmsghdr *genl;
1054     struct ofpbuf b;
1055     int type;
1056
1057     ofpbuf_use_const(&b, buf->data, buf->size);
1058
1059     nlmsg = ofpbuf_try_pull(&b, sizeof *nlmsg);
1060     genl = ofpbuf_try_pull(&b, sizeof *genl);
1061     ovs_header = ofpbuf_try_pull(&b, sizeof *ovs_header);
1062     if (!nlmsg || !genl || !ovs_header
1063         || nlmsg->nlmsg_type != ovs_packet_family
1064         || !nl_policy_parse(&b, 0, ovs_packet_policy, a,
1065                             ARRAY_SIZE(ovs_packet_policy))) {
1066         return EINVAL;
1067     }
1068
1069     type = (genl->cmd == OVS_PACKET_CMD_MISS ? DPIF_UC_MISS
1070             : genl->cmd == OVS_PACKET_CMD_ACTION ? DPIF_UC_ACTION
1071             : -1);
1072     if (type < 0) {
1073         return EINVAL;
1074     }
1075
1076     memset(upcall, 0, sizeof *upcall);
1077     upcall->type = type;
1078     upcall->packet = buf;
1079     upcall->packet->data = (void *) nl_attr_get(a[OVS_PACKET_ATTR_PACKET]);
1080     upcall->packet->size = nl_attr_get_size(a[OVS_PACKET_ATTR_PACKET]);
1081     upcall->key = (void *) nl_attr_get(a[OVS_PACKET_ATTR_KEY]);
1082     upcall->key_len = nl_attr_get_size(a[OVS_PACKET_ATTR_KEY]);
1083     upcall->userdata = (a[OVS_PACKET_ATTR_USERDATA]
1084                         ? nl_attr_get_u64(a[OVS_PACKET_ATTR_USERDATA])
1085                         : 0);
1086     *dp_ifindex = ovs_header->dp_ifindex;
1087
1088     return 0;
1089 }
1090
1091 static int
1092 dpif_linux_recv(struct dpif *dpif_, struct dpif_upcall *upcall)
1093 {
1094     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
1095     int read_tries = 0;
1096
1097     if (dpif->epoll_fd < 0) {
1098        return EAGAIN;
1099     }
1100
1101     if (!dpif->ready_mask) {
1102         struct epoll_event events[N_UPCALL_SOCKS];
1103         int retval;
1104         int i;
1105
1106         do {
1107             retval = epoll_wait(dpif->epoll_fd, events, N_UPCALL_SOCKS, 0);
1108         } while (retval < 0 && errno == EINTR);
1109         if (retval < 0) {
1110             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
1111             VLOG_WARN_RL(&rl, "epoll_wait failed (%s)", strerror(errno));
1112         }
1113
1114         for (i = 0; i < retval; i++) {
1115             dpif->ready_mask |= 1u << events[i].data.u32;
1116         }
1117     }
1118
1119     while (dpif->ready_mask) {
1120         int indx = ffs(dpif->ready_mask) - 1;
1121         struct nl_sock *upcall_sock = dpif->upcall_socks[indx];
1122
1123         dpif->ready_mask &= ~(1u << indx);
1124
1125         for (;;) {
1126             struct ofpbuf *buf;
1127             int dp_ifindex;
1128             int error;
1129
1130             if (++read_tries > 50) {
1131                 return EAGAIN;
1132             }
1133
1134             buf = ofpbuf_new(2048);
1135             error = nl_sock_recv(upcall_sock, buf, false);
1136             if (error) {
1137                 ofpbuf_delete(buf);
1138                 if (error == EAGAIN) {
1139                     break;
1140                 }
1141                 return error;
1142             }
1143
1144             error = parse_odp_packet(buf, upcall, &dp_ifindex);
1145             if (!error && dp_ifindex == dpif->dp_ifindex) {
1146                 return 0;
1147             }
1148
1149             ofpbuf_delete(buf);
1150             if (error) {
1151                 return error;
1152             }
1153         }
1154     }
1155
1156     return EAGAIN;
1157 }
1158
1159 static void
1160 dpif_linux_recv_wait(struct dpif *dpif_)
1161 {
1162     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
1163
1164     if (dpif->epoll_fd < 0) {
1165        return;
1166     }
1167
1168     poll_fd_wait(dpif->epoll_fd, POLLIN);
1169 }
1170
1171 static void
1172 dpif_linux_recv_purge(struct dpif *dpif_)
1173 {
1174     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
1175     int i;
1176
1177     if (dpif->epoll_fd < 0) {
1178        return;
1179     }
1180
1181     for (i = 0; i < N_UPCALL_SOCKS; i++) {
1182         nl_sock_drain(dpif->upcall_socks[i]);
1183     }
1184 }
1185
1186 const struct dpif_class dpif_linux_class = {
1187     "system",
1188     dpif_linux_enumerate,
1189     dpif_linux_open,
1190     dpif_linux_close,
1191     dpif_linux_destroy,
1192     dpif_linux_run,
1193     dpif_linux_wait,
1194     dpif_linux_get_stats,
1195     dpif_linux_port_add,
1196     dpif_linux_port_del,
1197     dpif_linux_port_query_by_number,
1198     dpif_linux_port_query_by_name,
1199     dpif_linux_get_max_ports,
1200     dpif_linux_port_get_pid,
1201     dpif_linux_port_dump_start,
1202     dpif_linux_port_dump_next,
1203     dpif_linux_port_dump_done,
1204     dpif_linux_port_poll,
1205     dpif_linux_port_poll_wait,
1206     dpif_linux_flow_get,
1207     dpif_linux_flow_put,
1208     dpif_linux_flow_del,
1209     dpif_linux_flow_flush,
1210     dpif_linux_flow_dump_start,
1211     dpif_linux_flow_dump_next,
1212     dpif_linux_flow_dump_done,
1213     dpif_linux_execute,
1214     dpif_linux_operate,
1215     dpif_linux_recv_set,
1216     dpif_linux_queue_to_priority,
1217     dpif_linux_recv,
1218     dpif_linux_recv_wait,
1219     dpif_linux_recv_purge,
1220 };
1221 \f
1222 static int
1223 dpif_linux_init(void)
1224 {
1225     static int error = -1;
1226
1227     if (error < 0) {
1228         unsigned int ovs_vport_mcgroup;
1229
1230         error = nl_lookup_genl_family(OVS_DATAPATH_FAMILY,
1231                                       &ovs_datapath_family);
1232         if (error) {
1233             VLOG_ERR("Generic Netlink family '%s' does not exist. "
1234                      "The Open vSwitch kernel module is probably not loaded.",
1235                      OVS_DATAPATH_FAMILY);
1236         }
1237         if (!error) {
1238             error = nl_lookup_genl_family(OVS_VPORT_FAMILY, &ovs_vport_family);
1239         }
1240         if (!error) {
1241             error = nl_lookup_genl_family(OVS_FLOW_FAMILY, &ovs_flow_family);
1242         }
1243         if (!error) {
1244             error = nl_lookup_genl_family(OVS_PACKET_FAMILY,
1245                                           &ovs_packet_family);
1246         }
1247         if (!error) {
1248             error = nl_sock_create(NETLINK_GENERIC, &genl_sock);
1249         }
1250         if (!error) {
1251             error = nl_lookup_genl_mcgroup(OVS_VPORT_FAMILY, OVS_VPORT_MCGROUP,
1252                                            &ovs_vport_mcgroup,
1253                                            OVS_VPORT_MCGROUP_FALLBACK_ID);
1254         }
1255         if (!error) {
1256             static struct dpif_linux_vport vport;
1257             nln = nln_create(NETLINK_GENERIC, ovs_vport_mcgroup,
1258                              dpif_linux_nln_parse, &vport);
1259         }
1260     }
1261
1262     return error;
1263 }
1264
1265 bool
1266 dpif_linux_is_internal_device(const char *name)
1267 {
1268     struct dpif_linux_vport reply;
1269     struct ofpbuf *buf;
1270     int error;
1271
1272     error = dpif_linux_vport_get(name, &reply, &buf);
1273     if (!error) {
1274         ofpbuf_delete(buf);
1275     } else if (error != ENODEV && error != ENOENT) {
1276         VLOG_WARN_RL(&error_rl, "%s: vport query failed (%s)",
1277                      name, strerror(error));
1278     }
1279
1280     return reply.type == OVS_VPORT_TYPE_INTERNAL;
1281 }
1282
1283 int
1284 dpif_linux_vport_send(int dp_ifindex, uint32_t port_no,
1285                       const void *data, size_t size)
1286 {
1287     struct ofpbuf actions, key, packet;
1288     struct odputil_keybuf keybuf;
1289     struct dpif_execute execute;
1290     struct flow flow;
1291     uint64_t action;
1292
1293     ofpbuf_use_const(&packet, data, size);
1294     flow_extract(&packet, 0, htonll(0), 0, &flow);
1295
1296     ofpbuf_use_stack(&key, &keybuf, sizeof keybuf);
1297     odp_flow_key_from_flow(&key, &flow);
1298
1299     ofpbuf_use_stack(&actions, &action, sizeof action);
1300     nl_msg_put_u32(&actions, OVS_ACTION_ATTR_OUTPUT, port_no);
1301
1302     execute.key = key.data;
1303     execute.key_len = key.size;
1304     execute.actions = actions.data;
1305     execute.actions_len = actions.size;
1306     execute.packet = &packet;
1307     return dpif_linux_execute__(dp_ifindex, &execute);
1308 }
1309
1310 static bool
1311 dpif_linux_nln_parse(struct ofpbuf *buf, void *vport_)
1312 {
1313     struct dpif_linux_vport *vport = vport_;
1314     return dpif_linux_vport_from_ofpbuf(vport, buf) == 0;
1315 }
1316
1317 static void
1318 dpif_linux_port_changed(const void *vport_, void *dpif_)
1319 {
1320     const struct dpif_linux_vport *vport = vport_;
1321     struct dpif_linux *dpif = dpif_;
1322
1323     if (vport) {
1324         if (vport->dp_ifindex == dpif->dp_ifindex
1325             && (vport->cmd == OVS_VPORT_CMD_NEW
1326                 || vport->cmd == OVS_VPORT_CMD_DEL
1327                 || vport->cmd == OVS_VPORT_CMD_SET)) {
1328             VLOG_DBG("port_changed: dpif:%s vport:%s cmd:%"PRIu8,
1329                      dpif->dpif.full_name, vport->name, vport->cmd);
1330             sset_add(&dpif->changed_ports, vport->name);
1331         }
1332     } else {
1333         dpif->change_error = true;
1334     }
1335 }
1336 \f
1337 /* Parses the contents of 'buf', which contains a "struct ovs_header" followed
1338  * by Netlink attributes, into 'vport'.  Returns 0 if successful, otherwise a
1339  * positive errno value.
1340  *
1341  * 'vport' will contain pointers into 'buf', so the caller should not free
1342  * 'buf' while 'vport' is still in use. */
1343 static int
1344 dpif_linux_vport_from_ofpbuf(struct dpif_linux_vport *vport,
1345                              const struct ofpbuf *buf)
1346 {
1347     static const struct nl_policy ovs_vport_policy[] = {
1348         [OVS_VPORT_ATTR_PORT_NO] = { .type = NL_A_U32 },
1349         [OVS_VPORT_ATTR_TYPE] = { .type = NL_A_U32 },
1350         [OVS_VPORT_ATTR_NAME] = { .type = NL_A_STRING, .max_len = IFNAMSIZ },
1351         [OVS_VPORT_ATTR_UPCALL_PID] = { .type = NL_A_U32 },
1352         [OVS_VPORT_ATTR_STATS] = { NL_POLICY_FOR(struct ovs_vport_stats),
1353                                    .optional = true },
1354         [OVS_VPORT_ATTR_ADDRESS] = { .type = NL_A_UNSPEC,
1355                                      .min_len = ETH_ADDR_LEN,
1356                                      .max_len = ETH_ADDR_LEN,
1357                                      .optional = true },
1358         [OVS_VPORT_ATTR_OPTIONS] = { .type = NL_A_NESTED, .optional = true },
1359     };
1360
1361     struct nlattr *a[ARRAY_SIZE(ovs_vport_policy)];
1362     struct ovs_header *ovs_header;
1363     struct nlmsghdr *nlmsg;
1364     struct genlmsghdr *genl;
1365     struct ofpbuf b;
1366
1367     dpif_linux_vport_init(vport);
1368
1369     ofpbuf_use_const(&b, buf->data, buf->size);
1370     nlmsg = ofpbuf_try_pull(&b, sizeof *nlmsg);
1371     genl = ofpbuf_try_pull(&b, sizeof *genl);
1372     ovs_header = ofpbuf_try_pull(&b, sizeof *ovs_header);
1373     if (!nlmsg || !genl || !ovs_header
1374         || nlmsg->nlmsg_type != ovs_vport_family
1375         || !nl_policy_parse(&b, 0, ovs_vport_policy, a,
1376                             ARRAY_SIZE(ovs_vport_policy))) {
1377         return EINVAL;
1378     }
1379
1380     vport->cmd = genl->cmd;
1381     vport->dp_ifindex = ovs_header->dp_ifindex;
1382     vport->port_no = nl_attr_get_u32(a[OVS_VPORT_ATTR_PORT_NO]);
1383     vport->type = nl_attr_get_u32(a[OVS_VPORT_ATTR_TYPE]);
1384     vport->name = nl_attr_get_string(a[OVS_VPORT_ATTR_NAME]);
1385     if (a[OVS_VPORT_ATTR_UPCALL_PID]) {
1386         vport->upcall_pid = nl_attr_get(a[OVS_VPORT_ATTR_UPCALL_PID]);
1387     }
1388     if (a[OVS_VPORT_ATTR_STATS]) {
1389         vport->stats = nl_attr_get(a[OVS_VPORT_ATTR_STATS]);
1390     }
1391     if (a[OVS_VPORT_ATTR_ADDRESS]) {
1392         vport->address = nl_attr_get(a[OVS_VPORT_ATTR_ADDRESS]);
1393     }
1394     if (a[OVS_VPORT_ATTR_OPTIONS]) {
1395         vport->options = nl_attr_get(a[OVS_VPORT_ATTR_OPTIONS]);
1396         vport->options_len = nl_attr_get_size(a[OVS_VPORT_ATTR_OPTIONS]);
1397     }
1398     return 0;
1399 }
1400
1401 /* Appends to 'buf' (which must initially be empty) a "struct ovs_header"
1402  * followed by Netlink attributes corresponding to 'vport'. */
1403 static void
1404 dpif_linux_vport_to_ofpbuf(const struct dpif_linux_vport *vport,
1405                            struct ofpbuf *buf)
1406 {
1407     struct ovs_header *ovs_header;
1408
1409     nl_msg_put_genlmsghdr(buf, 0, ovs_vport_family, NLM_F_REQUEST | NLM_F_ECHO,
1410                           vport->cmd, OVS_VPORT_VERSION);
1411
1412     ovs_header = ofpbuf_put_uninit(buf, sizeof *ovs_header);
1413     ovs_header->dp_ifindex = vport->dp_ifindex;
1414
1415     if (vport->port_no != UINT32_MAX) {
1416         nl_msg_put_u32(buf, OVS_VPORT_ATTR_PORT_NO, vport->port_no);
1417     }
1418
1419     if (vport->type != OVS_VPORT_TYPE_UNSPEC) {
1420         nl_msg_put_u32(buf, OVS_VPORT_ATTR_TYPE, vport->type);
1421     }
1422
1423     if (vport->name) {
1424         nl_msg_put_string(buf, OVS_VPORT_ATTR_NAME, vport->name);
1425     }
1426
1427     if (vport->upcall_pid) {
1428         nl_msg_put_u32(buf, OVS_VPORT_ATTR_UPCALL_PID, *vport->upcall_pid);
1429     }
1430
1431     if (vport->stats) {
1432         nl_msg_put_unspec(buf, OVS_VPORT_ATTR_STATS,
1433                           vport->stats, sizeof *vport->stats);
1434     }
1435
1436     if (vport->address) {
1437         nl_msg_put_unspec(buf, OVS_VPORT_ATTR_ADDRESS,
1438                           vport->address, ETH_ADDR_LEN);
1439     }
1440
1441     if (vport->options) {
1442         nl_msg_put_nested(buf, OVS_VPORT_ATTR_OPTIONS,
1443                           vport->options, vport->options_len);
1444     }
1445 }
1446
1447 /* Clears 'vport' to "empty" values. */
1448 void
1449 dpif_linux_vport_init(struct dpif_linux_vport *vport)
1450 {
1451     memset(vport, 0, sizeof *vport);
1452     vport->port_no = UINT32_MAX;
1453 }
1454
1455 /* Executes 'request' in the kernel datapath.  If the command fails, returns a
1456  * positive errno value.  Otherwise, if 'reply' and 'bufp' are null, returns 0
1457  * without doing anything else.  If 'reply' and 'bufp' are nonnull, then the
1458  * result of the command is expected to be an ovs_vport also, which is decoded
1459  * and stored in '*reply' and '*bufp'.  The caller must free '*bufp' when the
1460  * reply is no longer needed ('reply' will contain pointers into '*bufp'). */
1461 int
1462 dpif_linux_vport_transact(const struct dpif_linux_vport *request,
1463                           struct dpif_linux_vport *reply,
1464                           struct ofpbuf **bufp)
1465 {
1466     struct ofpbuf *request_buf;
1467     int error;
1468
1469     assert((reply != NULL) == (bufp != NULL));
1470
1471     error = dpif_linux_init();
1472     if (error) {
1473         if (reply) {
1474             *bufp = NULL;
1475             dpif_linux_vport_init(reply);
1476         }
1477         return error;
1478     }
1479
1480     request_buf = ofpbuf_new(1024);
1481     dpif_linux_vport_to_ofpbuf(request, request_buf);
1482     error = nl_sock_transact(genl_sock, request_buf, bufp);
1483     ofpbuf_delete(request_buf);
1484
1485     if (reply) {
1486         if (!error) {
1487             error = dpif_linux_vport_from_ofpbuf(reply, *bufp);
1488         }
1489         if (error) {
1490             dpif_linux_vport_init(reply);
1491             ofpbuf_delete(*bufp);
1492             *bufp = NULL;
1493         }
1494     }
1495     return error;
1496 }
1497
1498 /* Obtains information about the kernel vport named 'name' and stores it into
1499  * '*reply' and '*bufp'.  The caller must free '*bufp' when the reply is no
1500  * longer needed ('reply' will contain pointers into '*bufp').  */
1501 int
1502 dpif_linux_vport_get(const char *name, struct dpif_linux_vport *reply,
1503                      struct ofpbuf **bufp)
1504 {
1505     struct dpif_linux_vport request;
1506
1507     dpif_linux_vport_init(&request);
1508     request.cmd = OVS_VPORT_CMD_GET;
1509     request.name = name;
1510
1511     return dpif_linux_vport_transact(&request, reply, bufp);
1512 }
1513 \f
1514 /* Parses the contents of 'buf', which contains a "struct ovs_header" followed
1515  * by Netlink attributes, into 'dp'.  Returns 0 if successful, otherwise a
1516  * positive errno value.
1517  *
1518  * 'dp' will contain pointers into 'buf', so the caller should not free 'buf'
1519  * while 'dp' is still in use. */
1520 static int
1521 dpif_linux_dp_from_ofpbuf(struct dpif_linux_dp *dp, const struct ofpbuf *buf)
1522 {
1523     static const struct nl_policy ovs_datapath_policy[] = {
1524         [OVS_DP_ATTR_NAME] = { .type = NL_A_STRING, .max_len = IFNAMSIZ },
1525         [OVS_DP_ATTR_STATS] = { NL_POLICY_FOR(struct ovs_dp_stats),
1526                                 .optional = true },
1527     };
1528
1529     struct nlattr *a[ARRAY_SIZE(ovs_datapath_policy)];
1530     struct ovs_header *ovs_header;
1531     struct nlmsghdr *nlmsg;
1532     struct genlmsghdr *genl;
1533     struct ofpbuf b;
1534
1535     dpif_linux_dp_init(dp);
1536
1537     ofpbuf_use_const(&b, buf->data, buf->size);
1538     nlmsg = ofpbuf_try_pull(&b, sizeof *nlmsg);
1539     genl = ofpbuf_try_pull(&b, sizeof *genl);
1540     ovs_header = ofpbuf_try_pull(&b, sizeof *ovs_header);
1541     if (!nlmsg || !genl || !ovs_header
1542         || nlmsg->nlmsg_type != ovs_datapath_family
1543         || !nl_policy_parse(&b, 0, ovs_datapath_policy, a,
1544                             ARRAY_SIZE(ovs_datapath_policy))) {
1545         return EINVAL;
1546     }
1547
1548     dp->cmd = genl->cmd;
1549     dp->dp_ifindex = ovs_header->dp_ifindex;
1550     dp->name = nl_attr_get_string(a[OVS_DP_ATTR_NAME]);
1551     if (a[OVS_DP_ATTR_STATS]) {
1552         /* Can't use structure assignment because Netlink doesn't ensure
1553          * sufficient alignment for 64-bit members. */
1554         memcpy(&dp->stats, nl_attr_get(a[OVS_DP_ATTR_STATS]),
1555                sizeof dp->stats);
1556     }
1557
1558     return 0;
1559 }
1560
1561 /* Appends to 'buf' the Generic Netlink message described by 'dp'. */
1562 static void
1563 dpif_linux_dp_to_ofpbuf(const struct dpif_linux_dp *dp, struct ofpbuf *buf)
1564 {
1565     struct ovs_header *ovs_header;
1566
1567     nl_msg_put_genlmsghdr(buf, 0, ovs_datapath_family,
1568                           NLM_F_REQUEST | NLM_F_ECHO, dp->cmd,
1569                           OVS_DATAPATH_VERSION);
1570
1571     ovs_header = ofpbuf_put_uninit(buf, sizeof *ovs_header);
1572     ovs_header->dp_ifindex = dp->dp_ifindex;
1573
1574     if (dp->name) {
1575         nl_msg_put_string(buf, OVS_DP_ATTR_NAME, dp->name);
1576     }
1577
1578     if (dp->upcall_pid) {
1579         nl_msg_put_u32(buf, OVS_DP_ATTR_UPCALL_PID, *dp->upcall_pid);
1580     }
1581
1582     /* Skip OVS_DP_ATTR_STATS since we never have a reason to serialize it. */
1583 }
1584
1585 /* Clears 'dp' to "empty" values. */
1586 static void
1587 dpif_linux_dp_init(struct dpif_linux_dp *dp)
1588 {
1589     memset(dp, 0, sizeof *dp);
1590 }
1591
1592 static void
1593 dpif_linux_dp_dump_start(struct nl_dump *dump)
1594 {
1595     struct dpif_linux_dp request;
1596     struct ofpbuf *buf;
1597
1598     dpif_linux_dp_init(&request);
1599     request.cmd = OVS_DP_CMD_GET;
1600
1601     buf = ofpbuf_new(1024);
1602     dpif_linux_dp_to_ofpbuf(&request, buf);
1603     nl_dump_start(dump, genl_sock, buf);
1604     ofpbuf_delete(buf);
1605 }
1606
1607 /* Executes 'request' in the kernel datapath.  If the command fails, returns a
1608  * positive errno value.  Otherwise, if 'reply' and 'bufp' are null, returns 0
1609  * without doing anything else.  If 'reply' and 'bufp' are nonnull, then the
1610  * result of the command is expected to be of the same form, which is decoded
1611  * and stored in '*reply' and '*bufp'.  The caller must free '*bufp' when the
1612  * reply is no longer needed ('reply' will contain pointers into '*bufp'). */
1613 static int
1614 dpif_linux_dp_transact(const struct dpif_linux_dp *request,
1615                        struct dpif_linux_dp *reply, struct ofpbuf **bufp)
1616 {
1617     struct ofpbuf *request_buf;
1618     int error;
1619
1620     assert((reply != NULL) == (bufp != NULL));
1621
1622     request_buf = ofpbuf_new(1024);
1623     dpif_linux_dp_to_ofpbuf(request, request_buf);
1624     error = nl_sock_transact(genl_sock, request_buf, bufp);
1625     ofpbuf_delete(request_buf);
1626
1627     if (reply) {
1628         if (!error) {
1629             error = dpif_linux_dp_from_ofpbuf(reply, *bufp);
1630         }
1631         if (error) {
1632             dpif_linux_dp_init(reply);
1633             ofpbuf_delete(*bufp);
1634             *bufp = NULL;
1635         }
1636     }
1637     return error;
1638 }
1639
1640 /* Obtains information about 'dpif_' and stores it into '*reply' and '*bufp'.
1641  * The caller must free '*bufp' when the reply is no longer needed ('reply'
1642  * will contain pointers into '*bufp').  */
1643 static int
1644 dpif_linux_dp_get(const struct dpif *dpif_, struct dpif_linux_dp *reply,
1645                   struct ofpbuf **bufp)
1646 {
1647     struct dpif_linux *dpif = dpif_linux_cast(dpif_);
1648     struct dpif_linux_dp request;
1649
1650     dpif_linux_dp_init(&request);
1651     request.cmd = OVS_DP_CMD_GET;
1652     request.dp_ifindex = dpif->dp_ifindex;
1653
1654     return dpif_linux_dp_transact(&request, reply, bufp);
1655 }
1656 \f
1657 /* Parses the contents of 'buf', which contains a "struct ovs_header" followed
1658  * by Netlink attributes, into 'flow'.  Returns 0 if successful, otherwise a
1659  * positive errno value.
1660  *
1661  * 'flow' will contain pointers into 'buf', so the caller should not free 'buf'
1662  * while 'flow' is still in use. */
1663 static int
1664 dpif_linux_flow_from_ofpbuf(struct dpif_linux_flow *flow,
1665                             const struct ofpbuf *buf)
1666 {
1667     static const struct nl_policy ovs_flow_policy[] = {
1668         [OVS_FLOW_ATTR_KEY] = { .type = NL_A_NESTED },
1669         [OVS_FLOW_ATTR_ACTIONS] = { .type = NL_A_NESTED, .optional = true },
1670         [OVS_FLOW_ATTR_STATS] = { NL_POLICY_FOR(struct ovs_flow_stats),
1671                                   .optional = true },
1672         [OVS_FLOW_ATTR_TCP_FLAGS] = { .type = NL_A_U8, .optional = true },
1673         [OVS_FLOW_ATTR_USED] = { .type = NL_A_U64, .optional = true },
1674         /* The kernel never uses OVS_FLOW_ATTR_CLEAR. */
1675     };
1676
1677     struct nlattr *a[ARRAY_SIZE(ovs_flow_policy)];
1678     struct ovs_header *ovs_header;
1679     struct nlmsghdr *nlmsg;
1680     struct genlmsghdr *genl;
1681     struct ofpbuf b;
1682
1683     dpif_linux_flow_init(flow);
1684
1685     ofpbuf_use_const(&b, buf->data, buf->size);
1686     nlmsg = ofpbuf_try_pull(&b, sizeof *nlmsg);
1687     genl = ofpbuf_try_pull(&b, sizeof *genl);
1688     ovs_header = ofpbuf_try_pull(&b, sizeof *ovs_header);
1689     if (!nlmsg || !genl || !ovs_header
1690         || nlmsg->nlmsg_type != ovs_flow_family
1691         || !nl_policy_parse(&b, 0, ovs_flow_policy, a,
1692                             ARRAY_SIZE(ovs_flow_policy))) {
1693         return EINVAL;
1694     }
1695
1696     flow->nlmsg_flags = nlmsg->nlmsg_flags;
1697     flow->dp_ifindex = ovs_header->dp_ifindex;
1698     flow->key = nl_attr_get(a[OVS_FLOW_ATTR_KEY]);
1699     flow->key_len = nl_attr_get_size(a[OVS_FLOW_ATTR_KEY]);
1700     if (a[OVS_FLOW_ATTR_ACTIONS]) {
1701         flow->actions = nl_attr_get(a[OVS_FLOW_ATTR_ACTIONS]);
1702         flow->actions_len = nl_attr_get_size(a[OVS_FLOW_ATTR_ACTIONS]);
1703     }
1704     if (a[OVS_FLOW_ATTR_STATS]) {
1705         flow->stats = nl_attr_get(a[OVS_FLOW_ATTR_STATS]);
1706     }
1707     if (a[OVS_FLOW_ATTR_TCP_FLAGS]) {
1708         flow->tcp_flags = nl_attr_get(a[OVS_FLOW_ATTR_TCP_FLAGS]);
1709     }
1710     if (a[OVS_FLOW_ATTR_USED]) {
1711         flow->used = nl_attr_get(a[OVS_FLOW_ATTR_USED]);
1712     }
1713     return 0;
1714 }
1715
1716 /* Appends to 'buf' (which must initially be empty) a "struct ovs_header"
1717  * followed by Netlink attributes corresponding to 'flow'. */
1718 static void
1719 dpif_linux_flow_to_ofpbuf(const struct dpif_linux_flow *flow,
1720                           struct ofpbuf *buf)
1721 {
1722     struct ovs_header *ovs_header;
1723
1724     nl_msg_put_genlmsghdr(buf, 0, ovs_flow_family,
1725                           NLM_F_REQUEST | flow->nlmsg_flags,
1726                           flow->cmd, OVS_FLOW_VERSION);
1727
1728     ovs_header = ofpbuf_put_uninit(buf, sizeof *ovs_header);
1729     ovs_header->dp_ifindex = flow->dp_ifindex;
1730
1731     if (flow->key_len) {
1732         nl_msg_put_unspec(buf, OVS_FLOW_ATTR_KEY, flow->key, flow->key_len);
1733     }
1734
1735     if (flow->actions || flow->actions_len) {
1736         nl_msg_put_unspec(buf, OVS_FLOW_ATTR_ACTIONS,
1737                           flow->actions, flow->actions_len);
1738     }
1739
1740     /* We never need to send these to the kernel. */
1741     assert(!flow->stats);
1742     assert(!flow->tcp_flags);
1743     assert(!flow->used);
1744
1745     if (flow->clear) {
1746         nl_msg_put_flag(buf, OVS_FLOW_ATTR_CLEAR);
1747     }
1748 }
1749
1750 /* Clears 'flow' to "empty" values. */
1751 static void
1752 dpif_linux_flow_init(struct dpif_linux_flow *flow)
1753 {
1754     memset(flow, 0, sizeof *flow);
1755 }
1756
1757 /* Executes 'request' in the kernel datapath.  If the command fails, returns a
1758  * positive errno value.  Otherwise, if 'reply' and 'bufp' are null, returns 0
1759  * without doing anything else.  If 'reply' and 'bufp' are nonnull, then the
1760  * result of the command is expected to be a flow also, which is decoded and
1761  * stored in '*reply' and '*bufp'.  The caller must free '*bufp' when the reply
1762  * is no longer needed ('reply' will contain pointers into '*bufp'). */
1763 static int
1764 dpif_linux_flow_transact(struct dpif_linux_flow *request,
1765                          struct dpif_linux_flow *reply, struct ofpbuf **bufp)
1766 {
1767     struct ofpbuf *request_buf;
1768     int error;
1769
1770     assert((reply != NULL) == (bufp != NULL));
1771
1772     if (reply) {
1773         request->nlmsg_flags |= NLM_F_ECHO;
1774     }
1775
1776     request_buf = ofpbuf_new(1024);
1777     dpif_linux_flow_to_ofpbuf(request, request_buf);
1778     error = nl_sock_transact(genl_sock, request_buf, bufp);
1779     ofpbuf_delete(request_buf);
1780
1781     if (reply) {
1782         if (!error) {
1783             error = dpif_linux_flow_from_ofpbuf(reply, *bufp);
1784         }
1785         if (error) {
1786             dpif_linux_flow_init(reply);
1787             ofpbuf_delete(*bufp);
1788             *bufp = NULL;
1789         }
1790     }
1791     return error;
1792 }
1793
1794 static void
1795 dpif_linux_flow_get_stats(const struct dpif_linux_flow *flow,
1796                           struct dpif_flow_stats *stats)
1797 {
1798     if (flow->stats) {
1799         stats->n_packets = get_unaligned_u64(&flow->stats->n_packets);
1800         stats->n_bytes = get_unaligned_u64(&flow->stats->n_bytes);
1801     } else {
1802         stats->n_packets = 0;
1803         stats->n_bytes = 0;
1804     }
1805     stats->used = flow->used ? get_32aligned_u64(flow->used) : 0;
1806     stats->tcp_flags = flow->tcp_flags ? *flow->tcp_flags : 0;
1807 }