2 * net/tipc/config.c: TIPC configuration management code
4 * Copyright (c) 2002-2006, Ericsson AB
5 * Copyright (c) 2004-2007, 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.
40 #include "name_table.h"
49 static struct manager mng = { 0};
51 static DEFINE_SPINLOCK(config_lock);
53 static const void *req_tlv_area; /* request message TLV area */
54 static int req_tlv_space; /* request message TLV area size */
55 static int rep_headroom; /* reply message headroom to use */
58 struct sk_buff *tipc_cfg_reply_alloc(int payload_size)
62 buf = alloc_skb(rep_headroom + payload_size, GFP_ATOMIC);
64 skb_reserve(buf, rep_headroom);
68 int tipc_cfg_append_tlv(struct sk_buff *buf, int tlv_type,
69 void *tlv_data, int tlv_data_size)
71 struct tlv_desc *tlv = (struct tlv_desc *)skb_tail_pointer(buf);
72 int new_tlv_space = TLV_SPACE(tlv_data_size);
74 if (skb_tailroom(buf) < new_tlv_space) {
75 dbg("tipc_cfg_append_tlv unable to append TLV\n");
78 skb_put(buf, new_tlv_space);
79 tlv->tlv_type = htons(tlv_type);
80 tlv->tlv_len = htons(TLV_LENGTH(tlv_data_size));
81 if (tlv_data_size && tlv_data)
82 memcpy(TLV_DATA(tlv), tlv_data, tlv_data_size);
86 static struct sk_buff *tipc_cfg_reply_unsigned_type(u16 tlv_type, u32 value)
91 buf = tipc_cfg_reply_alloc(TLV_SPACE(sizeof(value)));
93 value_net = htonl(value);
94 tipc_cfg_append_tlv(buf, tlv_type, &value_net,
100 static struct sk_buff *tipc_cfg_reply_unsigned(u32 value)
102 return tipc_cfg_reply_unsigned_type(TIPC_TLV_UNSIGNED, value);
105 struct sk_buff *tipc_cfg_reply_string_type(u16 tlv_type, char *string)
108 int string_len = strlen(string) + 1;
110 buf = tipc_cfg_reply_alloc(TLV_SPACE(string_len));
112 tipc_cfg_append_tlv(buf, tlv_type, string, string_len);
116 #define MAX_STATS_INFO 2000
118 static struct sk_buff *tipc_show_stats(void)
121 struct tlv_desc *rep_tlv;
126 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_UNSIGNED))
127 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
129 value = ntohl(*(u32 *)TLV_DATA(req_tlv_area));
131 return tipc_cfg_reply_error_string("unsupported argument");
133 buf = tipc_cfg_reply_alloc(TLV_SPACE(MAX_STATS_INFO));
137 rep_tlv = (struct tlv_desc *)buf->data;
138 tipc_printbuf_init(&pb, (char *)TLV_DATA(rep_tlv), MAX_STATS_INFO);
140 tipc_printf(&pb, "TIPC version " TIPC_MOD_VER "\n");
142 /* Use additional tipc_printf()'s to return more info ... */
144 str_len = tipc_printbuf_validate(&pb);
145 skb_put(buf, TLV_SPACE(str_len));
146 TLV_SET(rep_tlv, TIPC_TLV_ULTRA_STRING, NULL, str_len);
151 static struct sk_buff *cfg_enable_bearer(void)
153 struct tipc_bearer_config *args;
155 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_BEARER_CONFIG))
156 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
158 args = (struct tipc_bearer_config *)TLV_DATA(req_tlv_area);
159 if (tipc_enable_bearer(args->name,
160 ntohl(args->detect_scope),
161 ntohl(args->priority)))
162 return tipc_cfg_reply_error_string("unable to enable bearer");
164 return tipc_cfg_reply_none();
167 static struct sk_buff *cfg_disable_bearer(void)
169 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_BEARER_NAME))
170 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
172 if (tipc_disable_bearer((char *)TLV_DATA(req_tlv_area)))
173 return tipc_cfg_reply_error_string("unable to disable bearer");
175 return tipc_cfg_reply_none();
178 static struct sk_buff *cfg_set_own_addr(void)
182 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_NET_ADDR))
183 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
185 addr = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
186 if (addr == tipc_own_addr)
187 return tipc_cfg_reply_none();
188 if (!tipc_addr_node_valid(addr))
189 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
191 if (tipc_mode == TIPC_NET_MODE)
192 return tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
193 " (cannot change node address once assigned)");
196 * Must release all spinlocks before calling start_net() because
197 * Linux version of TIPC calls eth_media_start() which calls
198 * register_netdevice_notifier() which may block!
200 * Temporarily releasing the lock should be harmless for non-Linux TIPC,
201 * but Linux version of eth_media_start() should really be reworked
202 * so that it can be called with spinlocks held.
205 spin_unlock_bh(&config_lock);
206 tipc_core_start_net(addr);
207 spin_lock_bh(&config_lock);
208 return tipc_cfg_reply_none();
211 static struct sk_buff *cfg_set_remote_mng(void)
215 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_UNSIGNED))
216 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
218 value = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
219 tipc_remote_management = (value != 0);
220 return tipc_cfg_reply_none();
223 static struct sk_buff *cfg_set_max_publications(void)
227 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_UNSIGNED))
228 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
230 value = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
231 if (value != delimit(value, 1, 65535))
232 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
233 " (max publications must be 1-65535)");
234 tipc_max_publications = value;
235 return tipc_cfg_reply_none();
238 static struct sk_buff *cfg_set_max_subscriptions(void)
242 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_UNSIGNED))
243 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
245 value = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
246 if (value != delimit(value, 1, 65535))
247 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
248 " (max subscriptions must be 1-65535");
249 tipc_max_subscriptions = value;
250 return tipc_cfg_reply_none();
253 static struct sk_buff *cfg_set_max_ports(void)
257 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_UNSIGNED))
258 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
259 value = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
260 if (value == tipc_max_ports)
261 return tipc_cfg_reply_none();
262 if (value != delimit(value, 127, 65535))
263 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
264 " (max ports must be 127-65535)");
265 if (tipc_mode != TIPC_NOT_RUNNING)
266 return tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
267 " (cannot change max ports while TIPC is active)");
268 tipc_max_ports = value;
269 return tipc_cfg_reply_none();
272 static struct sk_buff *cfg_set_max_zones(void)
276 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_UNSIGNED))
277 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
278 value = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
279 if (value == tipc_max_zones)
280 return tipc_cfg_reply_none();
281 if (value != delimit(value, 1, 255))
282 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
283 " (max zones must be 1-255)");
284 if (tipc_mode == TIPC_NET_MODE)
285 return tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
286 " (cannot change max zones once TIPC has joined a network)");
287 tipc_max_zones = value;
288 return tipc_cfg_reply_none();
291 static struct sk_buff *cfg_set_max_clusters(void)
295 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_UNSIGNED))
296 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
297 value = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
298 if (value != delimit(value, 1, 1))
299 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
300 " (max clusters fixed at 1)");
301 return tipc_cfg_reply_none();
304 static struct sk_buff *cfg_set_max_nodes(void)
308 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_UNSIGNED))
309 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
310 value = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
311 if (value == tipc_max_nodes)
312 return tipc_cfg_reply_none();
313 if (value != delimit(value, 8, 2047))
314 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
315 " (max nodes must be 8-2047)");
316 if (tipc_mode == TIPC_NET_MODE)
317 return tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
318 " (cannot change max nodes once TIPC has joined a network)");
319 tipc_max_nodes = value;
320 return tipc_cfg_reply_none();
323 static struct sk_buff *cfg_set_max_slaves(void)
327 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_UNSIGNED))
328 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
329 value = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
331 return tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
332 " (max secondary nodes fixed at 0)");
333 return tipc_cfg_reply_none();
336 static struct sk_buff *cfg_set_netid(void)
340 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_UNSIGNED))
341 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
342 value = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
343 if (value == tipc_net_id)
344 return tipc_cfg_reply_none();
345 if (value != delimit(value, 1, 9999))
346 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
347 " (network id must be 1-9999)");
348 if (tipc_mode == TIPC_NET_MODE)
349 return tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
350 " (cannot change network id once TIPC has joined a network)");
352 return tipc_cfg_reply_none();
355 struct sk_buff *tipc_cfg_do_cmd(u32 orig_node, u16 cmd, const void *request_area,
356 int request_space, int reply_headroom)
358 struct sk_buff *rep_tlv_buf;
360 spin_lock_bh(&config_lock);
362 /* Save request and reply details in a well-known location */
364 req_tlv_area = request_area;
365 req_tlv_space = request_space;
366 rep_headroom = reply_headroom;
368 /* Check command authorization */
370 if (likely(orig_node == tipc_own_addr)) {
371 /* command is permitted */
372 } else if (cmd >= 0x8000) {
373 rep_tlv_buf = tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
374 " (cannot be done remotely)");
376 } else if (!tipc_remote_management) {
377 rep_tlv_buf = tipc_cfg_reply_error_string(TIPC_CFG_NO_REMOTE);
380 else if (cmd >= 0x4000) {
383 if ((tipc_nametbl_translate(TIPC_ZM_SRV, 0, &domain) == 0) ||
384 (domain != orig_node)) {
385 rep_tlv_buf = tipc_cfg_reply_error_string(TIPC_CFG_NOT_ZONE_MSTR);
390 /* Call appropriate processing routine */
394 rep_tlv_buf = tipc_cfg_reply_none();
396 case TIPC_CMD_GET_NODES:
397 rep_tlv_buf = tipc_node_get_nodes(req_tlv_area, req_tlv_space);
399 case TIPC_CMD_GET_LINKS:
400 rep_tlv_buf = tipc_node_get_links(req_tlv_area, req_tlv_space);
402 case TIPC_CMD_SHOW_LINK_STATS:
403 rep_tlv_buf = tipc_link_cmd_show_stats(req_tlv_area, req_tlv_space);
405 case TIPC_CMD_RESET_LINK_STATS:
406 rep_tlv_buf = tipc_link_cmd_reset_stats(req_tlv_area, req_tlv_space);
408 case TIPC_CMD_SHOW_NAME_TABLE:
409 rep_tlv_buf = tipc_nametbl_get(req_tlv_area, req_tlv_space);
411 case TIPC_CMD_GET_BEARER_NAMES:
412 rep_tlv_buf = tipc_bearer_get_names();
414 case TIPC_CMD_GET_MEDIA_NAMES:
415 rep_tlv_buf = tipc_media_get_names();
417 case TIPC_CMD_SHOW_PORTS:
418 rep_tlv_buf = tipc_port_get_ports();
420 case TIPC_CMD_SET_LOG_SIZE:
421 rep_tlv_buf = tipc_log_resize_cmd(req_tlv_area, req_tlv_space);
423 case TIPC_CMD_DUMP_LOG:
424 rep_tlv_buf = tipc_log_dump();
426 case TIPC_CMD_SHOW_STATS:
427 rep_tlv_buf = tipc_show_stats();
429 case TIPC_CMD_SET_LINK_TOL:
430 case TIPC_CMD_SET_LINK_PRI:
431 case TIPC_CMD_SET_LINK_WINDOW:
432 rep_tlv_buf = tipc_link_cmd_config(req_tlv_area, req_tlv_space, cmd);
434 case TIPC_CMD_ENABLE_BEARER:
435 rep_tlv_buf = cfg_enable_bearer();
437 case TIPC_CMD_DISABLE_BEARER:
438 rep_tlv_buf = cfg_disable_bearer();
440 case TIPC_CMD_SET_NODE_ADDR:
441 rep_tlv_buf = cfg_set_own_addr();
443 case TIPC_CMD_SET_REMOTE_MNG:
444 rep_tlv_buf = cfg_set_remote_mng();
446 case TIPC_CMD_SET_MAX_PORTS:
447 rep_tlv_buf = cfg_set_max_ports();
449 case TIPC_CMD_SET_MAX_PUBL:
450 rep_tlv_buf = cfg_set_max_publications();
452 case TIPC_CMD_SET_MAX_SUBSCR:
453 rep_tlv_buf = cfg_set_max_subscriptions();
455 case TIPC_CMD_SET_MAX_ZONES:
456 rep_tlv_buf = cfg_set_max_zones();
458 case TIPC_CMD_SET_MAX_CLUSTERS:
459 rep_tlv_buf = cfg_set_max_clusters();
461 case TIPC_CMD_SET_MAX_NODES:
462 rep_tlv_buf = cfg_set_max_nodes();
464 case TIPC_CMD_SET_MAX_SLAVES:
465 rep_tlv_buf = cfg_set_max_slaves();
467 case TIPC_CMD_SET_NETID:
468 rep_tlv_buf = cfg_set_netid();
470 case TIPC_CMD_GET_REMOTE_MNG:
471 rep_tlv_buf = tipc_cfg_reply_unsigned(tipc_remote_management);
473 case TIPC_CMD_GET_MAX_PORTS:
474 rep_tlv_buf = tipc_cfg_reply_unsigned(tipc_max_ports);
476 case TIPC_CMD_GET_MAX_PUBL:
477 rep_tlv_buf = tipc_cfg_reply_unsigned(tipc_max_publications);
479 case TIPC_CMD_GET_MAX_SUBSCR:
480 rep_tlv_buf = tipc_cfg_reply_unsigned(tipc_max_subscriptions);
482 case TIPC_CMD_GET_MAX_ZONES:
483 rep_tlv_buf = tipc_cfg_reply_unsigned(tipc_max_zones);
485 case TIPC_CMD_GET_MAX_CLUSTERS:
486 rep_tlv_buf = tipc_cfg_reply_unsigned(tipc_max_clusters);
488 case TIPC_CMD_GET_MAX_NODES:
489 rep_tlv_buf = tipc_cfg_reply_unsigned(tipc_max_nodes);
491 case TIPC_CMD_GET_MAX_SLAVES:
492 rep_tlv_buf = tipc_cfg_reply_unsigned(tipc_max_slaves);
494 case TIPC_CMD_GET_NETID:
495 rep_tlv_buf = tipc_cfg_reply_unsigned(tipc_net_id);
497 case TIPC_CMD_NOT_NET_ADMIN:
499 tipc_cfg_reply_error_string(TIPC_CFG_NOT_NET_ADMIN);
502 rep_tlv_buf = tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
503 " (unknown command)");
507 /* Return reply buffer */
509 spin_unlock_bh(&config_lock);
513 static void cfg_named_msg_event(void *userdata,
515 struct sk_buff **buf,
519 struct tipc_portid const *orig,
520 struct tipc_name_seq const *dest)
522 struct tipc_cfg_msg_hdr *req_hdr;
523 struct tipc_cfg_msg_hdr *rep_hdr;
524 struct sk_buff *rep_buf;
526 /* Validate configuration message header (ignore invalid message) */
528 req_hdr = (struct tipc_cfg_msg_hdr *)msg;
529 if ((size < sizeof(*req_hdr)) ||
530 (size != TCM_ALIGN(ntohl(req_hdr->tcm_len))) ||
531 (ntohs(req_hdr->tcm_flags) != TCM_F_REQUEST)) {
532 warn("Invalid configuration message discarded\n");
536 /* Generate reply for request (if can't, return request) */
538 rep_buf = tipc_cfg_do_cmd(orig->node,
539 ntohs(req_hdr->tcm_type),
540 msg + sizeof(*req_hdr),
541 size - sizeof(*req_hdr),
542 BUF_HEADROOM + MAX_H_SIZE + sizeof(*rep_hdr));
544 skb_push(rep_buf, sizeof(*rep_hdr));
545 rep_hdr = (struct tipc_cfg_msg_hdr *)rep_buf->data;
546 memcpy(rep_hdr, req_hdr, sizeof(*rep_hdr));
547 rep_hdr->tcm_len = htonl(rep_buf->len);
548 rep_hdr->tcm_flags &= htons(~TCM_F_REQUEST);
554 /* NEED TO ADD CODE TO HANDLE FAILED SEND (SUCH AS CONGESTION) */
555 tipc_send_buf2port(port_ref, orig, rep_buf, rep_buf->len);
558 int tipc_cfg_init(void)
560 struct tipc_name_seq seq;
563 res = tipc_attach(&mng.user_ref);
567 res = tipc_createport(mng.user_ref, NULL, TIPC_CRITICAL_IMPORTANCE,
569 NULL, cfg_named_msg_event, NULL,
570 NULL, &mng.port_ref);
574 seq.type = TIPC_CFG_SRV;
575 seq.lower = seq.upper = tipc_own_addr;
576 res = tipc_nametbl_publish_rsv(mng.port_ref, TIPC_ZONE_SCOPE, &seq);
583 err("Unable to create configuration service\n");
584 tipc_detach(mng.user_ref);
589 void tipc_cfg_stop(void)
592 tipc_detach(mng.user_ref);