xref: /linux/net/tipc/netlink.c (revision ad61dd303a0f2439bb104349e2d2ec91a3010ce0)
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 };
84 
85 const struct nla_policy tipc_nl_link_policy[TIPC_NLA_LINK_MAX + 1] = {
86 	[TIPC_NLA_LINK_UNSPEC]		= { .type = NLA_UNSPEC },
87 	[TIPC_NLA_LINK_NAME]		= { .type = NLA_STRING,
88 					    .len = TIPC_MAX_LINK_NAME },
89 	[TIPC_NLA_LINK_MTU]		= { .type = NLA_U32 },
90 	[TIPC_NLA_LINK_BROADCAST]	= { .type = NLA_FLAG },
91 	[TIPC_NLA_LINK_UP]		= { .type = NLA_FLAG },
92 	[TIPC_NLA_LINK_ACTIVE]		= { .type = NLA_FLAG },
93 	[TIPC_NLA_LINK_PROP]		= { .type = NLA_NESTED },
94 	[TIPC_NLA_LINK_STATS]		= { .type = NLA_NESTED },
95 	[TIPC_NLA_LINK_RX]		= { .type = NLA_U32 },
96 	[TIPC_NLA_LINK_TX]		= { .type = NLA_U32 }
97 };
98 
99 const struct nla_policy tipc_nl_node_policy[TIPC_NLA_NODE_MAX + 1] = {
100 	[TIPC_NLA_NODE_UNSPEC]		= { .type = NLA_UNSPEC },
101 	[TIPC_NLA_NODE_ADDR]		= { .type = NLA_U32 },
102 	[TIPC_NLA_NODE_UP]		= { .type = NLA_FLAG }
103 };
104 
105 /* Properties valid for media, bearer and link */
106 const struct nla_policy tipc_nl_prop_policy[TIPC_NLA_PROP_MAX + 1] = {
107 	[TIPC_NLA_PROP_UNSPEC]		= { .type = NLA_UNSPEC },
108 	[TIPC_NLA_PROP_PRIO]		= { .type = NLA_U32 },
109 	[TIPC_NLA_PROP_TOL]		= { .type = NLA_U32 },
110 	[TIPC_NLA_PROP_WIN]		= { .type = NLA_U32 }
111 };
112 
113 const struct nla_policy tipc_nl_bearer_policy[TIPC_NLA_BEARER_MAX + 1]	= {
114 	[TIPC_NLA_BEARER_UNSPEC]	= { .type = NLA_UNSPEC },
115 	[TIPC_NLA_BEARER_NAME]		= { .type = NLA_STRING,
116 					    .len = TIPC_MAX_BEARER_NAME },
117 	[TIPC_NLA_BEARER_PROP]		= { .type = NLA_NESTED },
118 	[TIPC_NLA_BEARER_DOMAIN]	= { .type = NLA_U32 }
119 };
120 
121 const struct nla_policy tipc_nl_media_policy[TIPC_NLA_MEDIA_MAX + 1] = {
122 	[TIPC_NLA_MEDIA_UNSPEC]		= { .type = NLA_UNSPEC },
123 	[TIPC_NLA_MEDIA_NAME]		= { .type = NLA_STRING },
124 	[TIPC_NLA_MEDIA_PROP]		= { .type = NLA_NESTED }
125 };
126 
127 const struct nla_policy tipc_nl_udp_policy[TIPC_NLA_UDP_MAX + 1] = {
128 	[TIPC_NLA_UDP_UNSPEC]	= {.type = NLA_UNSPEC},
129 	[TIPC_NLA_UDP_LOCAL]	= {.type = NLA_BINARY,
130 				   .len = sizeof(struct sockaddr_storage)},
131 	[TIPC_NLA_UDP_REMOTE]	= {.type = NLA_BINARY,
132 				   .len = sizeof(struct sockaddr_storage)},
133 };
134 
135 /* Users of the legacy API (tipc-config) can't handle that we add operations,
136  * so we have a separate genl handling for the new API.
137  */
138 static const struct genl_ops tipc_genl_v2_ops[] = {
139 	{
140 		.cmd	= TIPC_NL_BEARER_DISABLE,
141 		.doit	= tipc_nl_bearer_disable,
142 		.policy = tipc_nl_policy,
143 	},
144 	{
145 		.cmd	= TIPC_NL_BEARER_ENABLE,
146 		.doit	= tipc_nl_bearer_enable,
147 		.policy = tipc_nl_policy,
148 	},
149 	{
150 		.cmd	= TIPC_NL_BEARER_GET,
151 		.doit	= tipc_nl_bearer_get,
152 		.dumpit	= tipc_nl_bearer_dump,
153 		.policy = tipc_nl_policy,
154 	},
155 	{
156 		.cmd	= TIPC_NL_BEARER_ADD,
157 		.doit	= tipc_nl_bearer_add,
158 		.policy = tipc_nl_policy,
159 	},
160 	{
161 		.cmd	= TIPC_NL_BEARER_SET,
162 		.doit	= tipc_nl_bearer_set,
163 		.policy = tipc_nl_policy,
164 	},
165 	{
166 		.cmd	= TIPC_NL_SOCK_GET,
167 		.dumpit	= tipc_nl_sk_dump,
168 		.policy = tipc_nl_policy,
169 	},
170 	{
171 		.cmd	= TIPC_NL_PUBL_GET,
172 		.dumpit	= tipc_nl_publ_dump,
173 		.policy = tipc_nl_policy,
174 	},
175 	{
176 		.cmd	= TIPC_NL_LINK_GET,
177 		.doit   = tipc_nl_node_get_link,
178 		.dumpit	= tipc_nl_node_dump_link,
179 		.policy = tipc_nl_policy,
180 	},
181 	{
182 		.cmd	= TIPC_NL_LINK_SET,
183 		.doit	= tipc_nl_node_set_link,
184 		.policy = tipc_nl_policy,
185 	},
186 	{
187 		.cmd	= TIPC_NL_LINK_RESET_STATS,
188 		.doit   = tipc_nl_node_reset_link_stats,
189 		.policy = tipc_nl_policy,
190 	},
191 	{
192 		.cmd	= TIPC_NL_MEDIA_GET,
193 		.doit	= tipc_nl_media_get,
194 		.dumpit	= tipc_nl_media_dump,
195 		.policy = tipc_nl_policy,
196 	},
197 	{
198 		.cmd	= TIPC_NL_MEDIA_SET,
199 		.doit	= tipc_nl_media_set,
200 		.policy = tipc_nl_policy,
201 	},
202 	{
203 		.cmd	= TIPC_NL_NODE_GET,
204 		.dumpit	= tipc_nl_node_dump,
205 		.policy = tipc_nl_policy,
206 	},
207 	{
208 		.cmd	= TIPC_NL_NET_GET,
209 		.dumpit	= tipc_nl_net_dump,
210 		.policy = tipc_nl_policy,
211 	},
212 	{
213 		.cmd	= TIPC_NL_NET_SET,
214 		.doit	= tipc_nl_net_set,
215 		.policy = tipc_nl_policy,
216 	},
217 	{
218 		.cmd	= TIPC_NL_NAME_TABLE_GET,
219 		.dumpit	= tipc_nl_name_table_dump,
220 		.policy = tipc_nl_policy,
221 	},
222 	{
223 		.cmd	= TIPC_NL_MON_SET,
224 		.doit	= tipc_nl_node_set_monitor,
225 		.policy = tipc_nl_policy,
226 	},
227 	{
228 		.cmd	= TIPC_NL_MON_GET,
229 		.doit	= tipc_nl_node_get_monitor,
230 		.dumpit	= tipc_nl_node_dump_monitor,
231 		.policy = tipc_nl_policy,
232 	},
233 	{
234 		.cmd	= TIPC_NL_MON_PEER_GET,
235 		.dumpit	= tipc_nl_node_dump_monitor_peer,
236 		.policy = tipc_nl_policy,
237 	},
238 	{
239 		.cmd	= TIPC_NL_PEER_REMOVE,
240 		.doit	= tipc_nl_peer_rm,
241 		.policy = tipc_nl_policy,
242 	},
243 #ifdef CONFIG_TIPC_MEDIA_UDP
244 	{
245 		.cmd	= TIPC_NL_UDP_GET_REMOTEIP,
246 		.dumpit	= tipc_udp_nl_dump_remoteip,
247 		.policy = tipc_nl_policy,
248 	},
249 #endif
250 };
251 
252 struct genl_family tipc_genl_family __ro_after_init = {
253 	.name		= TIPC_GENL_V2_NAME,
254 	.version	= TIPC_GENL_V2_VERSION,
255 	.hdrsize	= 0,
256 	.maxattr	= TIPC_NLA_MAX,
257 	.netnsok	= true,
258 	.module		= THIS_MODULE,
259 	.ops		= tipc_genl_v2_ops,
260 	.n_ops		= ARRAY_SIZE(tipc_genl_v2_ops),
261 };
262 
263 int tipc_nlmsg_parse(const struct nlmsghdr *nlh, struct nlattr ***attr)
264 {
265 	u32 maxattr = tipc_genl_family.maxattr;
266 
267 	*attr = genl_family_attrbuf(&tipc_genl_family);
268 	if (!*attr)
269 		return -EOPNOTSUPP;
270 
271 	return nlmsg_parse(nlh, GENL_HDRLEN, *attr, maxattr, tipc_nl_policy,
272 			   NULL);
273 }
274 
275 int __init tipc_netlink_start(void)
276 {
277 	int res;
278 
279 	res = genl_register_family(&tipc_genl_family);
280 	if (res) {
281 		pr_err("Failed to register netlink interface\n");
282 		return res;
283 	}
284 	return 0;
285 }
286 
287 void tipc_netlink_stop(void)
288 {
289 	genl_unregister_family(&tipc_genl_family);
290 }
291