2 * net/tipc/config.c: TIPC configuration management code
4 * Copyright (c) 2002-2006, Ericsson AB
5 * Copyright (c) 2004-2007, 2010-2011, Wind River Systems
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
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.
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.
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.
39 #include "name_table.h"
42 static u32 config_port_ref
;
44 static DEFINE_SPINLOCK(config_lock
);
46 static const void *req_tlv_area
; /* request message TLV area */
47 static int req_tlv_space
; /* request message TLV area size */
48 static int rep_headroom
; /* reply message headroom to use */
51 struct sk_buff
*tipc_cfg_reply_alloc(int payload_size
)
55 buf
= alloc_skb(rep_headroom
+ payload_size
, GFP_ATOMIC
);
57 skb_reserve(buf
, rep_headroom
);
61 int tipc_cfg_append_tlv(struct sk_buff
*buf
, int tlv_type
,
62 void *tlv_data
, int tlv_data_size
)
64 struct tlv_desc
*tlv
= (struct tlv_desc
*)skb_tail_pointer(buf
);
65 int new_tlv_space
= TLV_SPACE(tlv_data_size
);
67 if (skb_tailroom(buf
) < new_tlv_space
)
69 skb_put(buf
, new_tlv_space
);
70 tlv
->tlv_type
= htons(tlv_type
);
71 tlv
->tlv_len
= htons(TLV_LENGTH(tlv_data_size
));
72 if (tlv_data_size
&& tlv_data
)
73 memcpy(TLV_DATA(tlv
), tlv_data
, tlv_data_size
);
77 static struct sk_buff
*tipc_cfg_reply_unsigned_type(u16 tlv_type
, u32 value
)
82 buf
= tipc_cfg_reply_alloc(TLV_SPACE(sizeof(value
)));
84 value_net
= htonl(value
);
85 tipc_cfg_append_tlv(buf
, tlv_type
, &value_net
,
91 static struct sk_buff
*tipc_cfg_reply_unsigned(u32 value
)
93 return tipc_cfg_reply_unsigned_type(TIPC_TLV_UNSIGNED
, value
);
96 struct sk_buff
*tipc_cfg_reply_string_type(u16 tlv_type
, char *string
)
99 int string_len
= strlen(string
) + 1;
101 buf
= tipc_cfg_reply_alloc(TLV_SPACE(string_len
));
103 tipc_cfg_append_tlv(buf
, tlv_type
, string
, string_len
);
107 #define MAX_STATS_INFO 2000
109 static struct sk_buff
*tipc_show_stats(void)
112 struct tlv_desc
*rep_tlv
;
117 if (!TLV_CHECK(req_tlv_area
, req_tlv_space
, TIPC_TLV_UNSIGNED
))
118 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR
);
120 value
= ntohl(*(u32
*)TLV_DATA(req_tlv_area
));
122 return tipc_cfg_reply_error_string("unsupported argument");
124 buf
= tipc_cfg_reply_alloc(TLV_SPACE(MAX_STATS_INFO
));
128 rep_tlv
= (struct tlv_desc
*)buf
->data
;
129 tipc_printbuf_init(&pb
, (char *)TLV_DATA(rep_tlv
), MAX_STATS_INFO
);
131 tipc_printf(&pb
, "TIPC version " TIPC_MOD_VER
"\n");
133 /* Use additional tipc_printf()'s to return more info ... */
135 str_len
= tipc_printbuf_validate(&pb
);
136 skb_put(buf
, TLV_SPACE(str_len
));
137 TLV_SET(rep_tlv
, TIPC_TLV_ULTRA_STRING
, NULL
, str_len
);
142 static struct sk_buff
*cfg_enable_bearer(void)
144 struct tipc_bearer_config
*args
;
146 if (!TLV_CHECK(req_tlv_area
, req_tlv_space
, TIPC_TLV_BEARER_CONFIG
))
147 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR
);
149 args
= (struct tipc_bearer_config
*)TLV_DATA(req_tlv_area
);
150 if (tipc_enable_bearer(args
->name
,
151 ntohl(args
->disc_domain
),
152 ntohl(args
->priority
)))
153 return tipc_cfg_reply_error_string("unable to enable bearer");
155 return tipc_cfg_reply_none();
158 static struct sk_buff
*cfg_disable_bearer(void)
160 if (!TLV_CHECK(req_tlv_area
, req_tlv_space
, TIPC_TLV_BEARER_NAME
))
161 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR
);
163 if (tipc_disable_bearer((char *)TLV_DATA(req_tlv_area
)))
164 return tipc_cfg_reply_error_string("unable to disable bearer");
166 return tipc_cfg_reply_none();
169 static struct sk_buff
*cfg_set_own_addr(void)
173 if (!TLV_CHECK(req_tlv_area
, req_tlv_space
, TIPC_TLV_NET_ADDR
))
174 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR
);
176 addr
= ntohl(*(__be32
*)TLV_DATA(req_tlv_area
));
177 if (addr
== tipc_own_addr
)
178 return tipc_cfg_reply_none();
179 if (!tipc_addr_node_valid(addr
))
180 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
183 return tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
184 " (cannot change node address once assigned)");
187 * Must temporarily release configuration spinlock while switching into
188 * networking mode as it calls tipc_eth_media_start(), which may sleep.
189 * Releasing the lock is harmless as other locally-issued configuration
190 * commands won't occur until this one completes, and remotely-issued
191 * configuration commands can't be received until a local configuration
192 * command to enable the first bearer is received and processed.
195 spin_unlock_bh(&config_lock
);
196 tipc_core_start_net(addr
);
197 spin_lock_bh(&config_lock
);
198 return tipc_cfg_reply_none();
201 static struct sk_buff
*cfg_set_remote_mng(void)
205 if (!TLV_CHECK(req_tlv_area
, req_tlv_space
, TIPC_TLV_UNSIGNED
))
206 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR
);
208 value
= ntohl(*(__be32
*)TLV_DATA(req_tlv_area
));
209 tipc_remote_management
= (value
!= 0);
210 return tipc_cfg_reply_none();
213 static struct sk_buff
*cfg_set_max_publications(void)
217 if (!TLV_CHECK(req_tlv_area
, req_tlv_space
, TIPC_TLV_UNSIGNED
))
218 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR
);
220 value
= ntohl(*(__be32
*)TLV_DATA(req_tlv_area
));
221 if (value
< 1 || value
> 65535)
222 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
223 " (max publications must be 1-65535)");
224 tipc_max_publications
= value
;
225 return tipc_cfg_reply_none();
228 static struct sk_buff
*cfg_set_max_subscriptions(void)
232 if (!TLV_CHECK(req_tlv_area
, req_tlv_space
, TIPC_TLV_UNSIGNED
))
233 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR
);
235 value
= ntohl(*(__be32
*)TLV_DATA(req_tlv_area
));
236 if (value
< 1 || value
> 65535)
237 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
238 " (max subscriptions must be 1-65535");
239 tipc_max_subscriptions
= value
;
240 return tipc_cfg_reply_none();
243 static struct sk_buff
*cfg_set_max_ports(void)
247 if (!TLV_CHECK(req_tlv_area
, req_tlv_space
, TIPC_TLV_UNSIGNED
))
248 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR
);
249 value
= ntohl(*(__be32
*)TLV_DATA(req_tlv_area
));
250 if (value
== tipc_max_ports
)
251 return tipc_cfg_reply_none();
252 if (value
< 127 || value
> 65535)
253 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
254 " (max ports must be 127-65535)");
255 return tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
256 " (cannot change max ports while TIPC is active)");
259 static struct sk_buff
*cfg_set_netid(void)
263 if (!TLV_CHECK(req_tlv_area
, req_tlv_space
, TIPC_TLV_UNSIGNED
))
264 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR
);
265 value
= ntohl(*(__be32
*)TLV_DATA(req_tlv_area
));
266 if (value
== tipc_net_id
)
267 return tipc_cfg_reply_none();
268 if (value
< 1 || value
> 9999)
269 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
270 " (network id must be 1-9999)");
272 return tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
273 " (cannot change network id once TIPC has joined a network)");
275 return tipc_cfg_reply_none();
278 struct sk_buff
*tipc_cfg_do_cmd(u32 orig_node
, u16 cmd
, const void *request_area
,
279 int request_space
, int reply_headroom
)
281 struct sk_buff
*rep_tlv_buf
;
283 spin_lock_bh(&config_lock
);
285 /* Save request and reply details in a well-known location */
287 req_tlv_area
= request_area
;
288 req_tlv_space
= request_space
;
289 rep_headroom
= reply_headroom
;
291 /* Check command authorization */
293 if (likely(orig_node
== tipc_own_addr
)) {
294 /* command is permitted */
295 } else if (cmd
>= 0x8000) {
296 rep_tlv_buf
= tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
297 " (cannot be done remotely)");
299 } else if (!tipc_remote_management
) {
300 rep_tlv_buf
= tipc_cfg_reply_error_string(TIPC_CFG_NO_REMOTE
);
302 } else if (cmd
>= 0x4000) {
305 if ((tipc_nametbl_translate(TIPC_ZM_SRV
, 0, &domain
) == 0) ||
306 (domain
!= orig_node
)) {
307 rep_tlv_buf
= tipc_cfg_reply_error_string(TIPC_CFG_NOT_ZONE_MSTR
);
312 /* Call appropriate processing routine */
316 rep_tlv_buf
= tipc_cfg_reply_none();
318 case TIPC_CMD_GET_NODES
:
319 rep_tlv_buf
= tipc_node_get_nodes(req_tlv_area
, req_tlv_space
);
321 case TIPC_CMD_GET_LINKS
:
322 rep_tlv_buf
= tipc_node_get_links(req_tlv_area
, req_tlv_space
);
324 case TIPC_CMD_SHOW_LINK_STATS
:
325 rep_tlv_buf
= tipc_link_cmd_show_stats(req_tlv_area
, req_tlv_space
);
327 case TIPC_CMD_RESET_LINK_STATS
:
328 rep_tlv_buf
= tipc_link_cmd_reset_stats(req_tlv_area
, req_tlv_space
);
330 case TIPC_CMD_SHOW_NAME_TABLE
:
331 rep_tlv_buf
= tipc_nametbl_get(req_tlv_area
, req_tlv_space
);
333 case TIPC_CMD_GET_BEARER_NAMES
:
334 rep_tlv_buf
= tipc_bearer_get_names();
336 case TIPC_CMD_GET_MEDIA_NAMES
:
337 rep_tlv_buf
= tipc_media_get_names();
339 case TIPC_CMD_SHOW_PORTS
:
340 rep_tlv_buf
= tipc_port_get_ports();
342 case TIPC_CMD_SET_LOG_SIZE
:
343 rep_tlv_buf
= tipc_log_resize_cmd(req_tlv_area
, req_tlv_space
);
345 case TIPC_CMD_DUMP_LOG
:
346 rep_tlv_buf
= tipc_log_dump();
348 case TIPC_CMD_SHOW_STATS
:
349 rep_tlv_buf
= tipc_show_stats();
351 case TIPC_CMD_SET_LINK_TOL
:
352 case TIPC_CMD_SET_LINK_PRI
:
353 case TIPC_CMD_SET_LINK_WINDOW
:
354 rep_tlv_buf
= tipc_link_cmd_config(req_tlv_area
, req_tlv_space
, cmd
);
356 case TIPC_CMD_ENABLE_BEARER
:
357 rep_tlv_buf
= cfg_enable_bearer();
359 case TIPC_CMD_DISABLE_BEARER
:
360 rep_tlv_buf
= cfg_disable_bearer();
362 case TIPC_CMD_SET_NODE_ADDR
:
363 rep_tlv_buf
= cfg_set_own_addr();
365 case TIPC_CMD_SET_REMOTE_MNG
:
366 rep_tlv_buf
= cfg_set_remote_mng();
368 case TIPC_CMD_SET_MAX_PORTS
:
369 rep_tlv_buf
= cfg_set_max_ports();
371 case TIPC_CMD_SET_MAX_PUBL
:
372 rep_tlv_buf
= cfg_set_max_publications();
374 case TIPC_CMD_SET_MAX_SUBSCR
:
375 rep_tlv_buf
= cfg_set_max_subscriptions();
377 case TIPC_CMD_SET_NETID
:
378 rep_tlv_buf
= cfg_set_netid();
380 case TIPC_CMD_GET_REMOTE_MNG
:
381 rep_tlv_buf
= tipc_cfg_reply_unsigned(tipc_remote_management
);
383 case TIPC_CMD_GET_MAX_PORTS
:
384 rep_tlv_buf
= tipc_cfg_reply_unsigned(tipc_max_ports
);
386 case TIPC_CMD_GET_MAX_PUBL
:
387 rep_tlv_buf
= tipc_cfg_reply_unsigned(tipc_max_publications
);
389 case TIPC_CMD_GET_MAX_SUBSCR
:
390 rep_tlv_buf
= tipc_cfg_reply_unsigned(tipc_max_subscriptions
);
392 case TIPC_CMD_GET_NETID
:
393 rep_tlv_buf
= tipc_cfg_reply_unsigned(tipc_net_id
);
395 case TIPC_CMD_NOT_NET_ADMIN
:
397 tipc_cfg_reply_error_string(TIPC_CFG_NOT_NET_ADMIN
);
399 case TIPC_CMD_SET_MAX_ZONES
:
400 case TIPC_CMD_GET_MAX_ZONES
:
401 case TIPC_CMD_SET_MAX_SLAVES
:
402 case TIPC_CMD_GET_MAX_SLAVES
:
403 case TIPC_CMD_SET_MAX_CLUSTERS
:
404 case TIPC_CMD_GET_MAX_CLUSTERS
:
405 case TIPC_CMD_SET_MAX_NODES
:
406 case TIPC_CMD_GET_MAX_NODES
:
407 rep_tlv_buf
= tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
408 " (obsolete command)");
411 rep_tlv_buf
= tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
412 " (unknown command)");
416 /* Return reply buffer */
418 spin_unlock_bh(&config_lock
);
422 static void cfg_named_msg_event(void *userdata
,
424 struct sk_buff
**buf
,
428 struct tipc_portid
const *orig
,
429 struct tipc_name_seq
const *dest
)
431 struct tipc_cfg_msg_hdr
*req_hdr
;
432 struct tipc_cfg_msg_hdr
*rep_hdr
;
433 struct sk_buff
*rep_buf
;
435 /* Validate configuration message header (ignore invalid message) */
437 req_hdr
= (struct tipc_cfg_msg_hdr
*)msg
;
438 if ((size
< sizeof(*req_hdr
)) ||
439 (size
!= TCM_ALIGN(ntohl(req_hdr
->tcm_len
))) ||
440 (ntohs(req_hdr
->tcm_flags
) != TCM_F_REQUEST
)) {
441 warn("Invalid configuration message discarded\n");
445 /* Generate reply for request (if can't, return request) */
447 rep_buf
= tipc_cfg_do_cmd(orig
->node
,
448 ntohs(req_hdr
->tcm_type
),
449 msg
+ sizeof(*req_hdr
),
450 size
- sizeof(*req_hdr
),
451 BUF_HEADROOM
+ MAX_H_SIZE
+ sizeof(*rep_hdr
));
453 skb_push(rep_buf
, sizeof(*rep_hdr
));
454 rep_hdr
= (struct tipc_cfg_msg_hdr
*)rep_buf
->data
;
455 memcpy(rep_hdr
, req_hdr
, sizeof(*rep_hdr
));
456 rep_hdr
->tcm_len
= htonl(rep_buf
->len
);
457 rep_hdr
->tcm_flags
&= htons(~TCM_F_REQUEST
);
463 /* NEED TO ADD CODE TO HANDLE FAILED SEND (SUCH AS CONGESTION) */
464 tipc_send_buf2port(port_ref
, orig
, rep_buf
, rep_buf
->len
);
467 int tipc_cfg_init(void)
469 struct tipc_name_seq seq
;
472 res
= tipc_createport(NULL
, TIPC_CRITICAL_IMPORTANCE
,
474 NULL
, cfg_named_msg_event
, NULL
,
475 NULL
, &config_port_ref
);
479 seq
.type
= TIPC_CFG_SRV
;
480 seq
.lower
= seq
.upper
= tipc_own_addr
;
481 res
= tipc_publish(config_port_ref
, TIPC_ZONE_SCOPE
, &seq
);
488 err("Unable to create configuration service\n");
492 void tipc_cfg_stop(void)
494 if (config_port_ref
) {
495 tipc_deleteport(config_port_ref
);