tests: Add tunnel unit tests.
[sliver-openvswitch.git] / lib / rtnetlink-link.c
1 /*
2  * Copyright (c) 2009, 2010 Nicira, Inc.
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 "rtnetlink-link.h"
20
21 #include <sys/socket.h>
22 #include <linux/rtnetlink.h>
23 #include <net/if.h>
24
25 #include "netlink.h"
26 #include "netlink-notifier.h"
27 #include "ofpbuf.h"
28
29 static struct nln *nln = NULL;
30 static struct rtnetlink_link_change rtn_change;
31
32 /* Parses a rtnetlink message 'buf' into 'change'.  If 'buf' is unparseable,
33  * leaves 'change' untouched and returns false.  Otherwise, populates 'change'
34  * and returns true. */
35 bool
36 rtnetlink_link_parse(struct ofpbuf *buf,
37                      struct rtnetlink_link_change *change)
38 {
39     bool parsed;
40
41     /* Policy for RTNLGRP_LINK messages.
42      *
43      * There are *many* more fields in these messages, but currently we
44      * only care about these fields. */
45     static const struct nl_policy policy[] = {
46         [IFLA_IFNAME] = { .type = NL_A_STRING, .optional = false },
47         [IFLA_MASTER] = { .type = NL_A_U32,    .optional = true },
48         [IFLA_MTU]    = { .type = NL_A_U32,    .optional = true },
49         [IFLA_ADDRESS] = { .type = NL_A_UNSPEC, .optional = true },
50     };
51
52     static struct nlattr *attrs[ARRAY_SIZE(policy)];
53
54     parsed = nl_policy_parse(buf, NLMSG_HDRLEN + sizeof(struct ifinfomsg),
55                              policy, attrs, ARRAY_SIZE(policy));
56
57     if (parsed) {
58         const struct nlmsghdr *nlmsg;
59         const struct ifinfomsg *ifinfo;
60
61         nlmsg  = buf->data;
62         ifinfo = ((const struct ifinfomsg *)
63                   ((const char *) buf->data + NLMSG_HDRLEN));
64
65         change->nlmsg_type     = nlmsg->nlmsg_type;
66         change->ifi_index      = ifinfo->ifi_index;
67         change->ifname         = nl_attr_get_string(attrs[IFLA_IFNAME]);
68         change->ifi_flags      = ifinfo->ifi_flags;
69         change->master_ifindex = (attrs[IFLA_MASTER]
70                                   ? nl_attr_get_u32(attrs[IFLA_MASTER])
71                                   : 0);
72         change->mtu            = (attrs[IFLA_MTU]
73                                   ? nl_attr_get_u32(attrs[IFLA_MTU])
74                                   : 0);
75
76         if (attrs[IFLA_ADDRESS] &&
77             nl_attr_get_size(attrs[IFLA_ADDRESS]) == ETH_ALEN) {
78             memcpy(change->addr, nl_attr_get(attrs[IFLA_ADDRESS]), ETH_ALEN);
79         } else {
80             memset(change->addr, 0, ETH_ALEN);
81         }
82     }
83
84     return parsed;
85 }
86
87 static bool
88 rtnetlink_link_parse_cb(struct ofpbuf *buf, void *change)
89 {
90     return rtnetlink_link_parse(buf, change);
91 }
92
93 /* Registers 'cb' to be called with auxiliary data 'aux' with network device
94  * change notifications.  The notifier is stored in 'notifier', which the
95  * caller must not modify or free.
96  *
97  * This is probably not the function that you want.  You should probably be
98  * using dpif_port_poll() or netdev_change_seq(), which unlike this function
99  * are not Linux-specific.
100  *
101  * Returns an initialized nln_notifier if successful, NULL otherwise. */
102 struct nln_notifier *
103 rtnetlink_link_notifier_create(rtnetlink_link_notify_func *cb, void *aux)
104 {
105     if (!nln) {
106         nln = nln_create(NETLINK_ROUTE, RTNLGRP_LINK, rtnetlink_link_parse_cb,
107                          &rtn_change);
108     }
109
110     return nln_notifier_create(nln, (nln_notify_func *) cb, aux);
111 }
112
113 /* Destroys 'notifier', which must have previously been created with
114  * rtnetlink_link_notifier_register(). */
115 void
116 rtnetlink_link_notifier_destroy(struct nln_notifier *notifier)
117 {
118     nln_notifier_destroy(notifier);
119 }
120
121 /* Calls all of the registered notifiers, passing along any as-yet-unreported
122  * netdev change events. */
123 void
124 rtnetlink_link_run(void)
125 {
126     if (nln) {
127         nln_run(nln);
128     }
129 }
130
131 /* Causes poll_block() to wake up when network device change notifications are
132  * ready. */
133 void
134 rtnetlink_link_wait(void)
135 {
136     if (nln) {
137         nln_wait(nln);
138     }
139 }