xref: /openbmc/linux/net/tipc/netlink.c (revision 5a170e9e)
1 /*
2  * net/tipc/netlink.c: TIPC configuration handling
3  *
4  * Copyright (c) 2005-2006, 2014, Ericsson AB
5  * Copyright (c) 2005-2007, Wind River Systems
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. Neither the names of the copyright holders nor the names of its
17  *    contributors may be used to endorse or promote products derived from
18  *    this software without specific prior written permission.
19  *
20  * Alternatively, this software may be distributed under the terms of the
21  * GNU General Public License ("GPL") version 2 as published by the Free
22  * Software Foundation.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
28  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34  * POSSIBILITY OF SUCH DAMAGE.
35  */
36 
37 #include "core.h"
38 #include "socket.h"
39 #include "name_table.h"
40 #include "bearer.h"
41 #include "link.h"
42 #include "node.h"
43 #include "net.h"
44 #include "udp_media.h"
45 #include <net/genetlink.h>
46 
47 static const struct nla_policy tipc_nl_policy[TIPC_NLA_MAX + 1] = {
48 	[TIPC_NLA_UNSPEC]	= { .type = NLA_UNSPEC, },
49 	[TIPC_NLA_BEARER]	= { .type = NLA_NESTED, },
50 	[TIPC_NLA_SOCK]		= { .type = NLA_NESTED, },
51 	[TIPC_NLA_PUBL]		= { .type = NLA_NESTED, },
52 	[TIPC_NLA_LINK]		= { .type = NLA_NESTED, },
53 	[TIPC_NLA_MEDIA]	= { .type = NLA_NESTED, },
54 	[TIPC_NLA_NODE]		= { .type = NLA_NESTED, },
55 	[TIPC_NLA_NET]		= { .type = NLA_NESTED, },
56 	[TIPC_NLA_NAME_TABLE]	= { .type = NLA_NESTED, },
57 	[TIPC_NLA_MON]		= { .type = NLA_NESTED, },
58 };
59 
60 const struct nla_policy
61 tipc_nl_name_table_policy[TIPC_NLA_NAME_TABLE_MAX + 1] = {
62 	[TIPC_NLA_NAME_TABLE_UNSPEC]	= { .type = NLA_UNSPEC },
63 	[TIPC_NLA_NAME_TABLE_PUBL]	= { .type = NLA_NESTED }
64 };
65 
66 const struct nla_policy tipc_nl_monitor_policy[TIPC_NLA_MON_MAX + 1] = {
67 	[TIPC_NLA_MON_UNSPEC]			= { .type = NLA_UNSPEC },
68 	[TIPC_NLA_MON_REF]			= { .type = NLA_U32 },
69 	[TIPC_NLA_MON_ACTIVATION_THRESHOLD]	= { .type = NLA_U32 },
70 };
71 
72 const struct nla_policy tipc_nl_sock_policy[TIPC_NLA_SOCK_MAX + 1] = {
73 	[TIPC_NLA_SOCK_UNSPEC]		= { .type = NLA_UNSPEC },
74 	[TIPC_NLA_SOCK_ADDR]		= { .type = NLA_U32 },
75 	[TIPC_NLA_SOCK_REF]		= { .type = NLA_U32 },
76 	[TIPC_NLA_SOCK_CON]		= { .type = NLA_NESTED },
77 	[TIPC_NLA_SOCK_HAS_PUBL]	= { .type = NLA_FLAG }
78 };
79 
80 const struct nla_policy tipc_nl_net_policy[TIPC_NLA_NET_MAX + 1] = {
81 	[TIPC_NLA_NET_UNSPEC]		= { .type = NLA_UNSPEC },
82 	[TIPC_NLA_NET_ID]		= { .type = NLA_U32 },
83 	[TIPC_NLA_NET_ADDR]		= { .type = NLA_U32 },
84 	[TIPC_NLA_NET_NODEID]		= { .type = NLA_U64 },
85 	[TIPC_NLA_NET_NODEID_W1]	= { .type = NLA_U64 },
86 };
87 
88 const struct nla_policy tipc_nl_link_policy[TIPC_NLA_LINK_MAX + 1] = {
89 	[TIPC_NLA_LINK_UNSPEC]		= { .type = NLA_UNSPEC },
90 	[TIPC_NLA_LINK_NAME]		= { .type = NLA_STRING,
91 					    .len = TIPC_MAX_LINK_NAME },
92 	[TIPC_NLA_LINK_MTU]		= { .type = NLA_U32 },
93 	[TIPC_NLA_LINK_BROADCAST]	= { .type = NLA_FLAG },
94 	[TIPC_NLA_LINK_UP]		= { .type = NLA_FLAG },
95 	[TIPC_NLA_LINK_ACTIVE]		= { .type = NLA_FLAG },
96 	[TIPC_NLA_LINK_PROP]		= { .type = NLA_NESTED },
97 	[TIPC_NLA_LINK_STATS]		= { .type = NLA_NESTED },
98 	[TIPC_NLA_LINK_RX]		= { .type = NLA_U32 },
99 	[TIPC_NLA_LINK_TX]		= { .type = NLA_U32 }
100 };
101 
102 const struct nla_policy tipc_nl_node_policy[TIPC_NLA_NODE_MAX + 1] = {
103 	[TIPC_NLA_NODE_UNSPEC]		= { .type = NLA_UNSPEC },
104 	[TIPC_NLA_NODE_ADDR]		= { .type = NLA_U32 },
105 	[TIPC_NLA_NODE_UP]		= { .type = NLA_FLAG }
106 };
107 
108 /* Properties valid for media, bearer and link */
109 const struct nla_policy tipc_nl_prop_policy[TIPC_NLA_PROP_MAX + 1] = {
110 	[TIPC_NLA_PROP_UNSPEC]		= { .type = NLA_UNSPEC },
111 	[TIPC_NLA_PROP_PRIO]		= { .type = NLA_U32 },
112 	[TIPC_NLA_PROP_TOL]		= { .type = NLA_U32 },
113 	[TIPC_NLA_PROP_WIN]		= { .type = NLA_U32 }
114 };
115 
116 const struct nla_policy tipc_nl_bearer_policy[TIPC_NLA_BEARER_MAX + 1]	= {
117 	[TIPC_NLA_BEARER_UNSPEC]	= { .type = NLA_UNSPEC },
118 	[TIPC_NLA_BEARER_NAME]		= { .type = NLA_STRING,
119 					    .len = TIPC_MAX_BEARER_NAME },
120 	[TIPC_NLA_BEARER_PROP]		= { .type = NLA_NESTED },
121 	[TIPC_NLA_BEARER_DOMAIN]	= { .type = NLA_U32 }
122 };
123 
124 const struct nla_policy tipc_nl_media_policy[TIPC_NLA_MEDIA_MAX + 1] = {
125 	[TIPC_NLA_MEDIA_UNSPEC]		= { .type = NLA_UNSPEC },
126 	[TIPC_NLA_MEDIA_NAME]		= { .type = NLA_STRING },
127 	[TIPC_NLA_MEDIA_PROP]		= { .type = NLA_NESTED }
128 };
129 
130 const struct nla_policy tipc_nl_udp_policy[TIPC_NLA_UDP_MAX + 1] = {
131 	[TIPC_NLA_UDP_UNSPEC]	= {.type = NLA_UNSPEC},
132 	[TIPC_NLA_UDP_LOCAL]	= {.type = NLA_BINARY,
133 				   .len = sizeof(struct sockaddr_storage)},
134 	[TIPC_NLA_UDP_REMOTE]	= {.type = NLA_BINARY,
135 				   .len = sizeof(struct sockaddr_storage)},
136 };
137 
138 /* Users of the legacy API (tipc-config) can't handle that we add operations,
139  * so we have a separate genl handling for the new API.
140  */
141 static const struct genl_ops tipc_genl_v2_ops[] = {
142 	{
143 		.cmd	= TIPC_NL_BEARER_DISABLE,
144 		.doit	= tipc_nl_bearer_disable,
145 		.policy = tipc_nl_policy,
146 	},
147 	{
148 		.cmd	= TIPC_NL_BEARER_ENABLE,
149 		.doit	= tipc_nl_bearer_enable,
150 		.policy = tipc_nl_policy,
151 	},
152 	{
153 		.cmd	= TIPC_NL_BEARER_GET,
154 		.doit	= tipc_nl_bearer_get,
155 		.dumpit	= tipc_nl_bearer_dump,
156 		.policy = tipc_nl_policy,
157 	},
158 	{
159 		.cmd	= TIPC_NL_BEARER_ADD,
160 		.doit	= tipc_nl_bearer_add,
161 		.policy = tipc_nl_policy,
162 	},
163 	{
164 		.cmd	= TIPC_NL_BEARER_SET,
165 		.doit	= tipc_nl_bearer_set,
166 		.policy = tipc_nl_policy,
167 	},
168 	{
169 		.cmd	= TIPC_NL_SOCK_GET,
170 		.start = tipc_dump_start,
171 		.dumpit	= tipc_nl_sk_dump,
172 		.done	= tipc_dump_done,
173 		.policy = tipc_nl_policy,
174 	},
175 	{
176 		.cmd	= TIPC_NL_PUBL_GET,
177 		.dumpit	= tipc_nl_publ_dump,
178 		.policy = tipc_nl_policy,
179 	},
180 	{
181 		.cmd	= TIPC_NL_LINK_GET,
182 		.doit   = tipc_nl_node_get_link,
183 		.dumpit	= tipc_nl_node_dump_link,
184 		.policy = tipc_nl_policy,
185 	},
186 	{
187 		.cmd	= TIPC_NL_LINK_SET,
188 		.doit	= tipc_nl_node_set_link,
189 		.policy = tipc_nl_policy,
190 	},
191 	{
192 		.cmd	= TIPC_NL_LINK_RESET_STATS,
193 		.doit   = tipc_nl_node_reset_link_stats,
194 		.policy = tipc_nl_policy,
195 	},
196 	{
197 		.cmd	= TIPC_NL_MEDIA_GET,
198 		.doit	= tipc_nl_media_get,
199 		.dumpit	= tipc_nl_media_dump,
200 		.policy = tipc_nl_policy,
201 	},
202 	{
203 		.cmd	= TIPC_NL_MEDIA_SET,
204 		.doit	= tipc_nl_media_set,
205 		.policy = tipc_nl_policy,
206 	},
207 	{
208 		.cmd	= TIPC_NL_NODE_GET,
209 		.dumpit	= tipc_nl_node_dump,
210 		.policy = tipc_nl_policy,
211 	},
212 	{
213 		.cmd	= TIPC_NL_NET_GET,
214 		.dumpit	= tipc_nl_net_dump,
215 		.policy = tipc_nl_policy,
216 	},
217 	{
218 		.cmd	= TIPC_NL_NET_SET,
219 		.doit	= tipc_nl_net_set,
220 		.policy = tipc_nl_policy,
221 	},
222 	{
223 		.cmd	= TIPC_NL_NAME_TABLE_GET,
224 		.dumpit	= tipc_nl_name_table_dump,
225 		.policy = tipc_nl_policy,
226 	},
227 	{
228 		.cmd	= TIPC_NL_MON_SET,
229 		.doit	= tipc_nl_node_set_monitor,
230 		.policy = tipc_nl_policy,
231 	},
232 	{
233 		.cmd	= TIPC_NL_MON_GET,
234 		.doit	= tipc_nl_node_get_monitor,
235 		.dumpit	= tipc_nl_node_dump_monitor,
236 		.policy = tipc_nl_policy,
237 	},
238 	{
239 		.cmd	= TIPC_NL_MON_PEER_GET,
240 		.dumpit	= tipc_nl_node_dump_monitor_peer,
241 		.policy = tipc_nl_policy,
242 	},
243 	{
244 		.cmd	= TIPC_NL_PEER_REMOVE,
245 		.doit	= tipc_nl_peer_rm,
246 		.policy = tipc_nl_policy,
247 	},
248 #ifdef CONFIG_TIPC_MEDIA_UDP
249 	{
250 		.cmd	= TIPC_NL_UDP_GET_REMOTEIP,
251 		.dumpit	= tipc_udp_nl_dump_remoteip,
252 		.policy = tipc_nl_policy,
253 	},
254 #endif
255 };
256 
257 struct genl_family tipc_genl_family __ro_after_init = {
258 	.name		= TIPC_GENL_V2_NAME,
259 	.version	= TIPC_GENL_V2_VERSION,
260 	.hdrsize	= 0,
261 	.maxattr	= TIPC_NLA_MAX,
262 	.netnsok	= true,
263 	.module		= THIS_MODULE,
264 	.ops		= tipc_genl_v2_ops,
265 	.n_ops		= ARRAY_SIZE(tipc_genl_v2_ops),
266 };
267 
268 int tipc_nlmsg_parse(const struct nlmsghdr *nlh, struct nlattr ***attr)
269 {
270 	u32 maxattr = tipc_genl_family.maxattr;
271 
272 	*attr = genl_family_attrbuf(&tipc_genl_family);
273 	if (!*attr)
274 		return -EOPNOTSUPP;
275 
276 	return nlmsg_parse(nlh, GENL_HDRLEN, *attr, maxattr, tipc_nl_policy,
277 			   NULL);
278 }
279 
280 int __init tipc_netlink_start(void)
281 {
282 	int res;
283 
284 	res = genl_register_family(&tipc_genl_family);
285 	if (res) {
286 		pr_err("Failed to register netlink interface\n");
287 		return res;
288 	}
289 	return 0;
290 }
291 
292 void tipc_netlink_stop(void)
293 {
294 	genl_unregister_family(&tipc_genl_family);
295 }
296