2 * net/tipc/config.c: TIPC configuration management code
4 * Copyright (c) 2002-2006, Ericsson AB
5 * Copyright (c) 2004-2006, 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.
44 #include "name_table.h"
53 struct list_head subd_list;
60 u32 link_subscriptions;
61 struct list_head link_subscribers;
64 static struct manager mng = { 0};
66 static DEFINE_SPINLOCK(config_lock);
68 static const void *req_tlv_area; /* request message TLV area */
69 static int req_tlv_space; /* request message TLV area size */
70 static int rep_headroom; /* reply message headroom to use */
73 void tipc_cfg_link_event(u32 addr, char *name, int up)
75 /* TIPC DOESN'T HANDLE LINK EVENT SUBSCRIPTIONS AT THE MOMENT */
79 struct sk_buff *tipc_cfg_reply_alloc(int payload_size)
83 buf = alloc_skb(rep_headroom + payload_size, GFP_ATOMIC);
85 skb_reserve(buf, rep_headroom);
89 int tipc_cfg_append_tlv(struct sk_buff *buf, int tlv_type,
90 void *tlv_data, int tlv_data_size)
92 struct tlv_desc *tlv = (struct tlv_desc *)buf->tail;
93 int new_tlv_space = TLV_SPACE(tlv_data_size);
95 if (skb_tailroom(buf) < new_tlv_space) {
96 dbg("tipc_cfg_append_tlv unable to append TLV\n");
99 skb_put(buf, new_tlv_space);
100 tlv->tlv_type = htons(tlv_type);
101 tlv->tlv_len = htons(TLV_LENGTH(tlv_data_size));
102 if (tlv_data_size && tlv_data)
103 memcpy(TLV_DATA(tlv), tlv_data, tlv_data_size);
107 struct sk_buff *tipc_cfg_reply_unsigned_type(u16 tlv_type, u32 value)
112 buf = tipc_cfg_reply_alloc(TLV_SPACE(sizeof(value)));
114 value_net = htonl(value);
115 tipc_cfg_append_tlv(buf, tlv_type, &value_net,
121 struct sk_buff *tipc_cfg_reply_string_type(u16 tlv_type, char *string)
124 int string_len = strlen(string) + 1;
126 buf = tipc_cfg_reply_alloc(TLV_SPACE(string_len));
128 tipc_cfg_append_tlv(buf, tlv_type, string, string_len);
137 /* Now obsolete code for handling commands not yet implemented the new way */
139 int tipc_cfg_cmd(const struct tipc_cmd_msg * msg,
143 struct tipc_portid *orig)
150 case TIPC_REMOVE_LINK:
151 case TIPC_CMD_BLOCK_LINK:
152 case TIPC_CMD_UNBLOCK_LINK:
153 if (!cfg_check_connection(orig))
154 rv = link_control(msg->argv.link_name, msg->cmd, 0);
160 tipc_isconnected(mng.conn_port_ref, &connected);
161 if (connected || !orig) {
165 rv = tipc_connect2port(mng.conn_port_ref, orig);
170 case TIPC_GET_PEER_ADDRESS:
171 *ret_size = link_peer_addr(msg->argv.link_name, data, sz);
173 case TIPC_GET_ROUTES:
183 static void cfg_cmd_event(struct tipc_cmd_msg *msg,
186 struct tipc_portid const *orig)
189 struct tipc_cmd_result_msg rmsg;
190 struct iovec msg_sect[2];
193 msg->cmd = ntohl(msg->cmd);
195 cfg_prepare_res_msg(msg->cmd, msg->usr_handle, rv, &rmsg, msg_sect,
197 if (ntohl(msg->magic) != TIPC_MAGIC)
201 case TIPC_CREATE_LINK:
202 if (!cfg_check_connection(orig))
203 rv = disc_create_link(&msg->argv.create_link);
205 case TIPC_LINK_SUBSCRIBE:
207 struct subscr_data *sub;
209 if (mng.link_subscriptions > 64)
211 sub = kmalloc(sizeof(*sub),
214 warn("Memory squeeze; dropped remote link subscription\n");
217 INIT_LIST_HEAD(&sub->subd_list);
218 tipc_createport(mng.user_ref,
220 TIPC_HIGH_IMPORTANCE,
223 (tipc_conn_shutdown_event)cfg_linksubscr_cancel,
226 (tipc_conn_msg_event)cfg_linksubscr_cancel,
229 if (!sub->port_ref) {
233 memcpy(sub->usr_handle,msg->usr_handle,
234 sizeof(sub->usr_handle));
235 sub->domain = msg->argv.domain;
236 list_add_tail(&sub->subd_list, &mng.link_subscribers);
237 tipc_connect2port(sub->port_ref, orig);
238 rmsg.retval = TIPC_OK;
239 tipc_send(sub->port_ref, 2u, msg_sect);
240 mng.link_subscriptions++;
244 rv = tipc_cfg_cmd(msg, data, sz, (u32 *)&msg_sect[1].iov_len, orig);
247 rmsg.result_len = htonl(msg_sect[1].iov_len);
248 rmsg.retval = htonl(rv);
249 tipc_cfg_respond(msg_sect, 2u, orig);
253 static struct sk_buff *cfg_enable_bearer(void)
255 struct tipc_bearer_config *args;
257 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_BEARER_CONFIG))
258 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
260 args = (struct tipc_bearer_config *)TLV_DATA(req_tlv_area);
261 if (tipc_enable_bearer(args->name,
262 ntohl(args->detect_scope),
263 ntohl(args->priority)))
264 return tipc_cfg_reply_error_string("unable to enable bearer");
266 return tipc_cfg_reply_none();
269 static struct sk_buff *cfg_disable_bearer(void)
271 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_BEARER_NAME))
272 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
274 if (tipc_disable_bearer((char *)TLV_DATA(req_tlv_area)))
275 return tipc_cfg_reply_error_string("unable to disable bearer");
277 return tipc_cfg_reply_none();
280 static struct sk_buff *cfg_set_own_addr(void)
284 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_NET_ADDR))
285 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
287 addr = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
288 if (addr == tipc_own_addr)
289 return tipc_cfg_reply_none();
290 if (!tipc_addr_node_valid(addr))
291 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
293 if (tipc_mode == TIPC_NET_MODE)
294 return tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
295 " (cannot change node address once assigned)");
296 tipc_own_addr = addr;
299 * Must release all spinlocks before calling start_net() because
300 * Linux version of TIPC calls eth_media_start() which calls
301 * register_netdevice_notifier() which may block!
303 * Temporarily releasing the lock should be harmless for non-Linux TIPC,
304 * but Linux version of eth_media_start() should really be reworked
305 * so that it can be called with spinlocks held.
308 spin_unlock_bh(&config_lock);
309 tipc_core_start_net();
310 spin_lock_bh(&config_lock);
311 return tipc_cfg_reply_none();
314 static struct sk_buff *cfg_set_remote_mng(void)
318 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_UNSIGNED))
319 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
321 value = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
322 tipc_remote_management = (value != 0);
323 return tipc_cfg_reply_none();
326 static struct sk_buff *cfg_set_max_publications(void)
330 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_UNSIGNED))
331 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
333 value = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
334 if (value != delimit(value, 1, 65535))
335 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
336 " (max publications must be 1-65535)");
337 tipc_max_publications = value;
338 return tipc_cfg_reply_none();
341 static struct sk_buff *cfg_set_max_subscriptions(void)
345 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_UNSIGNED))
346 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
348 value = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
349 if (value != delimit(value, 1, 65535))
350 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
351 " (max subscriptions must be 1-65535");
352 tipc_max_subscriptions = value;
353 return tipc_cfg_reply_none();
356 static struct sk_buff *cfg_set_max_ports(void)
360 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_UNSIGNED))
361 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
362 value = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
363 if (value == tipc_max_ports)
364 return tipc_cfg_reply_none();
365 if (value != delimit(value, 127, 65535))
366 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
367 " (max ports must be 127-65535)");
368 if (tipc_mode != TIPC_NOT_RUNNING)
369 return tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
370 " (cannot change max ports while TIPC is active)");
371 tipc_max_ports = value;
372 return tipc_cfg_reply_none();
375 static struct sk_buff *cfg_set_max_zones(void)
379 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_UNSIGNED))
380 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
381 value = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
382 if (value == tipc_max_zones)
383 return tipc_cfg_reply_none();
384 if (value != delimit(value, 1, 255))
385 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
386 " (max zones must be 1-255)");
387 if (tipc_mode == TIPC_NET_MODE)
388 return tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
389 " (cannot change max zones once TIPC has joined a network)");
390 tipc_max_zones = value;
391 return tipc_cfg_reply_none();
394 static struct sk_buff *cfg_set_max_clusters(void)
398 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_UNSIGNED))
399 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
400 value = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
401 if (value != delimit(value, 1, 1))
402 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
403 " (max clusters fixed at 1)");
404 return tipc_cfg_reply_none();
407 static struct sk_buff *cfg_set_max_nodes(void)
411 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_UNSIGNED))
412 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
413 value = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
414 if (value == tipc_max_nodes)
415 return tipc_cfg_reply_none();
416 if (value != delimit(value, 8, 2047))
417 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
418 " (max nodes must be 8-2047)");
419 if (tipc_mode == TIPC_NET_MODE)
420 return tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
421 " (cannot change max nodes once TIPC has joined a network)");
422 tipc_max_nodes = value;
423 return tipc_cfg_reply_none();
426 static struct sk_buff *cfg_set_max_slaves(void)
430 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_UNSIGNED))
431 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
432 value = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
434 return tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
435 " (max secondary nodes fixed at 0)");
436 return tipc_cfg_reply_none();
439 static struct sk_buff *cfg_set_netid(void)
443 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_UNSIGNED))
444 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
445 value = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
446 if (value == tipc_net_id)
447 return tipc_cfg_reply_none();
448 if (value != delimit(value, 1, 9999))
449 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
450 " (network id must be 1-9999)");
451 if (tipc_mode == TIPC_NET_MODE)
452 return tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
453 " (cannot change network id once TIPC has joined a network)");
455 return tipc_cfg_reply_none();
458 struct sk_buff *tipc_cfg_do_cmd(u32 orig_node, u16 cmd, const void *request_area,
459 int request_space, int reply_headroom)
461 struct sk_buff *rep_tlv_buf;
463 spin_lock_bh(&config_lock);
465 /* Save request and reply details in a well-known location */
467 req_tlv_area = request_area;
468 req_tlv_space = request_space;
469 rep_headroom = reply_headroom;
471 /* Check command authorization */
473 if (likely(orig_node == tipc_own_addr)) {
474 /* command is permitted */
475 } else if (cmd >= 0x8000) {
476 rep_tlv_buf = tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
477 " (cannot be done remotely)");
479 } else if (!tipc_remote_management) {
480 rep_tlv_buf = tipc_cfg_reply_error_string(TIPC_CFG_NO_REMOTE);
483 else if (cmd >= 0x4000) {
486 if ((tipc_nametbl_translate(TIPC_ZM_SRV, 0, &domain) == 0) ||
487 (domain != orig_node)) {
488 rep_tlv_buf = tipc_cfg_reply_error_string(TIPC_CFG_NOT_ZONE_MSTR);
493 /* Call appropriate processing routine */
497 rep_tlv_buf = tipc_cfg_reply_none();
499 case TIPC_CMD_GET_NODES:
500 rep_tlv_buf = tipc_node_get_nodes(req_tlv_area, req_tlv_space);
502 case TIPC_CMD_GET_LINKS:
503 rep_tlv_buf = tipc_node_get_links(req_tlv_area, req_tlv_space);
505 case TIPC_CMD_SHOW_LINK_STATS:
506 rep_tlv_buf = tipc_link_cmd_show_stats(req_tlv_area, req_tlv_space);
508 case TIPC_CMD_RESET_LINK_STATS:
509 rep_tlv_buf = tipc_link_cmd_reset_stats(req_tlv_area, req_tlv_space);
511 case TIPC_CMD_SHOW_NAME_TABLE:
512 rep_tlv_buf = tipc_nametbl_get(req_tlv_area, req_tlv_space);
514 case TIPC_CMD_GET_BEARER_NAMES:
515 rep_tlv_buf = tipc_bearer_get_names();
517 case TIPC_CMD_GET_MEDIA_NAMES:
518 rep_tlv_buf = tipc_media_get_names();
520 case TIPC_CMD_SHOW_PORTS:
521 rep_tlv_buf = tipc_port_get_ports();
524 case TIPC_CMD_SHOW_PORT_STATS:
525 rep_tlv_buf = port_show_stats(req_tlv_area, req_tlv_space);
527 case TIPC_CMD_RESET_PORT_STATS:
528 rep_tlv_buf = tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED);
531 case TIPC_CMD_SET_LOG_SIZE:
532 rep_tlv_buf = tipc_log_resize(req_tlv_area, req_tlv_space);
534 case TIPC_CMD_DUMP_LOG:
535 rep_tlv_buf = tipc_log_dump();
537 case TIPC_CMD_SET_LINK_TOL:
538 case TIPC_CMD_SET_LINK_PRI:
539 case TIPC_CMD_SET_LINK_WINDOW:
540 rep_tlv_buf = tipc_link_cmd_config(req_tlv_area, req_tlv_space, cmd);
542 case TIPC_CMD_ENABLE_BEARER:
543 rep_tlv_buf = cfg_enable_bearer();
545 case TIPC_CMD_DISABLE_BEARER:
546 rep_tlv_buf = cfg_disable_bearer();
548 case TIPC_CMD_SET_NODE_ADDR:
549 rep_tlv_buf = cfg_set_own_addr();
551 case TIPC_CMD_SET_REMOTE_MNG:
552 rep_tlv_buf = cfg_set_remote_mng();
554 case TIPC_CMD_SET_MAX_PORTS:
555 rep_tlv_buf = cfg_set_max_ports();
557 case TIPC_CMD_SET_MAX_PUBL:
558 rep_tlv_buf = cfg_set_max_publications();
560 case TIPC_CMD_SET_MAX_SUBSCR:
561 rep_tlv_buf = cfg_set_max_subscriptions();
563 case TIPC_CMD_SET_MAX_ZONES:
564 rep_tlv_buf = cfg_set_max_zones();
566 case TIPC_CMD_SET_MAX_CLUSTERS:
567 rep_tlv_buf = cfg_set_max_clusters();
569 case TIPC_CMD_SET_MAX_NODES:
570 rep_tlv_buf = cfg_set_max_nodes();
572 case TIPC_CMD_SET_MAX_SLAVES:
573 rep_tlv_buf = cfg_set_max_slaves();
575 case TIPC_CMD_SET_NETID:
576 rep_tlv_buf = cfg_set_netid();
578 case TIPC_CMD_GET_REMOTE_MNG:
579 rep_tlv_buf = tipc_cfg_reply_unsigned(tipc_remote_management);
581 case TIPC_CMD_GET_MAX_PORTS:
582 rep_tlv_buf = tipc_cfg_reply_unsigned(tipc_max_ports);
584 case TIPC_CMD_GET_MAX_PUBL:
585 rep_tlv_buf = tipc_cfg_reply_unsigned(tipc_max_publications);
587 case TIPC_CMD_GET_MAX_SUBSCR:
588 rep_tlv_buf = tipc_cfg_reply_unsigned(tipc_max_subscriptions);
590 case TIPC_CMD_GET_MAX_ZONES:
591 rep_tlv_buf = tipc_cfg_reply_unsigned(tipc_max_zones);
593 case TIPC_CMD_GET_MAX_CLUSTERS:
594 rep_tlv_buf = tipc_cfg_reply_unsigned(tipc_max_clusters);
596 case TIPC_CMD_GET_MAX_NODES:
597 rep_tlv_buf = tipc_cfg_reply_unsigned(tipc_max_nodes);
599 case TIPC_CMD_GET_MAX_SLAVES:
600 rep_tlv_buf = tipc_cfg_reply_unsigned(tipc_max_slaves);
602 case TIPC_CMD_GET_NETID:
603 rep_tlv_buf = tipc_cfg_reply_unsigned(tipc_net_id);
606 rep_tlv_buf = tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
607 " (unknown command)");
611 /* Return reply buffer */
613 spin_unlock_bh(&config_lock);
617 static void cfg_named_msg_event(void *userdata,
619 struct sk_buff **buf,
623 struct tipc_portid const *orig,
624 struct tipc_name_seq const *dest)
626 struct tipc_cfg_msg_hdr *req_hdr;
627 struct tipc_cfg_msg_hdr *rep_hdr;
628 struct sk_buff *rep_buf;
630 /* Validate configuration message header (ignore invalid message) */
632 req_hdr = (struct tipc_cfg_msg_hdr *)msg;
633 if ((size < sizeof(*req_hdr)) ||
634 (size != TCM_ALIGN(ntohl(req_hdr->tcm_len))) ||
635 (ntohs(req_hdr->tcm_flags) != TCM_F_REQUEST)) {
636 warn("Invalid configuration message discarded\n");
640 /* Generate reply for request (if can't, return request) */
642 rep_buf = tipc_cfg_do_cmd(orig->node,
643 ntohs(req_hdr->tcm_type),
644 msg + sizeof(*req_hdr),
645 size - sizeof(*req_hdr),
646 BUF_HEADROOM + MAX_H_SIZE + sizeof(*rep_hdr));
648 skb_push(rep_buf, sizeof(*rep_hdr));
649 rep_hdr = (struct tipc_cfg_msg_hdr *)rep_buf->data;
650 memcpy(rep_hdr, req_hdr, sizeof(*rep_hdr));
651 rep_hdr->tcm_len = htonl(rep_buf->len);
652 rep_hdr->tcm_flags &= htons(~TCM_F_REQUEST);
658 /* NEED TO ADD CODE TO HANDLE FAILED SEND (SUCH AS CONGESTION) */
659 tipc_send_buf2port(port_ref, orig, rep_buf, rep_buf->len);
662 int tipc_cfg_init(void)
664 struct tipc_name_seq seq;
667 memset(&mng, 0, sizeof(mng));
668 INIT_LIST_HEAD(&mng.link_subscribers);
670 res = tipc_attach(&mng.user_ref, NULL, NULL);
674 res = tipc_createport(mng.user_ref, NULL, TIPC_CRITICAL_IMPORTANCE,
676 NULL, cfg_named_msg_event, NULL,
677 NULL, &mng.port_ref);
681 seq.type = TIPC_CFG_SRV;
682 seq.lower = seq.upper = tipc_own_addr;
683 res = tipc_nametbl_publish_rsv(mng.port_ref, TIPC_ZONE_SCOPE, &seq);
690 err("Unable to create configuration service\n");
691 tipc_detach(mng.user_ref);
696 void tipc_cfg_stop(void)
699 tipc_detach(mng.user_ref);