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"
43 static u32 config_port_ref;
45 static DEFINE_SPINLOCK(config_lock);
47 static const void *req_tlv_area; /* request message TLV area */
48 static int req_tlv_space; /* request message TLV area size */
49 static int rep_headroom; /* reply message headroom to use */
52 struct sk_buff *tipc_cfg_reply_alloc(int payload_size)
56 buf = alloc_skb(rep_headroom + payload_size, GFP_ATOMIC);
58 skb_reserve(buf, rep_headroom);
62 int tipc_cfg_append_tlv(struct sk_buff *buf, int tlv_type,
63 void *tlv_data, int tlv_data_size)
65 struct tlv_desc *tlv = (struct tlv_desc *)skb_tail_pointer(buf);
66 int new_tlv_space = TLV_SPACE(tlv_data_size);
68 if (skb_tailroom(buf) < new_tlv_space) {
69 dbg("tipc_cfg_append_tlv unable to append TLV\n");
72 skb_put(buf, new_tlv_space);
73 tlv->tlv_type = htons(tlv_type);
74 tlv->tlv_len = htons(TLV_LENGTH(tlv_data_size));
75 if (tlv_data_size && tlv_data)
76 memcpy(TLV_DATA(tlv), tlv_data, tlv_data_size);
80 static struct sk_buff *tipc_cfg_reply_unsigned_type(u16 tlv_type, u32 value)
85 buf = tipc_cfg_reply_alloc(TLV_SPACE(sizeof(value)));
87 value_net = htonl(value);
88 tipc_cfg_append_tlv(buf, tlv_type, &value_net,
94 static struct sk_buff *tipc_cfg_reply_unsigned(u32 value)
96 return tipc_cfg_reply_unsigned_type(TIPC_TLV_UNSIGNED, value);
99 struct sk_buff *tipc_cfg_reply_string_type(u16 tlv_type, char *string)
102 int string_len = strlen(string) + 1;
104 buf = tipc_cfg_reply_alloc(TLV_SPACE(string_len));
106 tipc_cfg_append_tlv(buf, tlv_type, string, string_len);
110 #define MAX_STATS_INFO 2000
112 static struct sk_buff *tipc_show_stats(void)
115 struct tlv_desc *rep_tlv;
120 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_UNSIGNED))
121 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
123 value = ntohl(*(u32 *)TLV_DATA(req_tlv_area));
125 return tipc_cfg_reply_error_string("unsupported argument");
127 buf = tipc_cfg_reply_alloc(TLV_SPACE(MAX_STATS_INFO));
131 rep_tlv = (struct tlv_desc *)buf->data;
132 tipc_printbuf_init(&pb, (char *)TLV_DATA(rep_tlv), MAX_STATS_INFO);
134 tipc_printf(&pb, "TIPC version " TIPC_MOD_VER "\n");
136 /* Use additional tipc_printf()'s to return more info ... */
138 str_len = tipc_printbuf_validate(&pb);
139 skb_put(buf, TLV_SPACE(str_len));
140 TLV_SET(rep_tlv, TIPC_TLV_ULTRA_STRING, NULL, str_len);
145 static struct sk_buff *cfg_enable_bearer(void)
147 struct tipc_bearer_config *args;
149 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_BEARER_CONFIG))
150 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
152 args = (struct tipc_bearer_config *)TLV_DATA(req_tlv_area);
153 if (tipc_enable_bearer(args->name,
154 ntohl(args->detect_scope),
155 ntohl(args->priority)))
156 return tipc_cfg_reply_error_string("unable to enable bearer");
158 return tipc_cfg_reply_none();
161 static struct sk_buff *cfg_disable_bearer(void)
163 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_BEARER_NAME))
164 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
166 if (tipc_disable_bearer((char *)TLV_DATA(req_tlv_area)))
167 return tipc_cfg_reply_error_string("unable to disable bearer");
169 return tipc_cfg_reply_none();
172 static struct sk_buff *cfg_set_own_addr(void)
176 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_NET_ADDR))
177 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
179 addr = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
180 if (addr == tipc_own_addr)
181 return tipc_cfg_reply_none();
182 if (!tipc_addr_node_valid(addr))
183 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
185 if (tipc_mode == TIPC_NET_MODE)
186 return tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
187 " (cannot change node address once assigned)");
190 * Must release all spinlocks before calling start_net() because
191 * Linux version of TIPC calls eth_media_start() which calls
192 * register_netdevice_notifier() which may block!
194 * Temporarily releasing the lock should be harmless for non-Linux TIPC,
195 * but Linux version of eth_media_start() should really be reworked
196 * so that it can be called with spinlocks held.
199 spin_unlock_bh(&config_lock);
200 tipc_core_start_net(addr);
201 spin_lock_bh(&config_lock);
202 return tipc_cfg_reply_none();
205 static struct sk_buff *cfg_set_remote_mng(void)
209 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_UNSIGNED))
210 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
212 value = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
213 tipc_remote_management = (value != 0);
214 return tipc_cfg_reply_none();
217 static struct sk_buff *cfg_set_max_publications(void)
221 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_UNSIGNED))
222 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
224 value = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
225 if (value != delimit(value, 1, 65535))
226 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
227 " (max publications must be 1-65535)");
228 tipc_max_publications = value;
229 return tipc_cfg_reply_none();
232 static struct sk_buff *cfg_set_max_subscriptions(void)
236 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_UNSIGNED))
237 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
239 value = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
240 if (value != delimit(value, 1, 65535))
241 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
242 " (max subscriptions must be 1-65535");
243 tipc_max_subscriptions = value;
244 return tipc_cfg_reply_none();
247 static struct sk_buff *cfg_set_max_ports(void)
251 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_UNSIGNED))
252 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
253 value = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
254 if (value == tipc_max_ports)
255 return tipc_cfg_reply_none();
256 if (value != delimit(value, 127, 65535))
257 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
258 " (max ports must be 127-65535)");
259 if (tipc_mode != TIPC_NOT_RUNNING)
260 return tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
261 " (cannot change max ports while TIPC is active)");
262 tipc_max_ports = value;
263 return tipc_cfg_reply_none();
266 static struct sk_buff *cfg_set_max_nodes(void)
270 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_UNSIGNED))
271 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
272 value = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
273 if (value == tipc_max_nodes)
274 return tipc_cfg_reply_none();
275 if (value != delimit(value, 8, 2047))
276 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
277 " (max nodes must be 8-2047)");
278 if (tipc_mode == TIPC_NET_MODE)
279 return tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
280 " (cannot change max nodes once TIPC has joined a network)");
281 tipc_max_nodes = value;
282 return tipc_cfg_reply_none();
285 static struct sk_buff *cfg_set_netid(void)
289 if (!TLV_CHECK(req_tlv_area, req_tlv_space, TIPC_TLV_UNSIGNED))
290 return tipc_cfg_reply_error_string(TIPC_CFG_TLV_ERROR);
291 value = ntohl(*(__be32 *)TLV_DATA(req_tlv_area));
292 if (value == tipc_net_id)
293 return tipc_cfg_reply_none();
294 if (value != delimit(value, 1, 9999))
295 return tipc_cfg_reply_error_string(TIPC_CFG_INVALID_VALUE
296 " (network id must be 1-9999)");
297 if (tipc_mode == TIPC_NET_MODE)
298 return tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
299 " (cannot change network id once TIPC has joined a network)");
301 return tipc_cfg_reply_none();
304 struct sk_buff *tipc_cfg_do_cmd(u32 orig_node, u16 cmd, const void *request_area,
305 int request_space, int reply_headroom)
307 struct sk_buff *rep_tlv_buf;
309 spin_lock_bh(&config_lock);
311 /* Save request and reply details in a well-known location */
313 req_tlv_area = request_area;
314 req_tlv_space = request_space;
315 rep_headroom = reply_headroom;
317 /* Check command authorization */
319 if (likely(orig_node == tipc_own_addr)) {
320 /* command is permitted */
321 } else if (cmd >= 0x8000) {
322 rep_tlv_buf = tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
323 " (cannot be done remotely)");
325 } else if (!tipc_remote_management) {
326 rep_tlv_buf = tipc_cfg_reply_error_string(TIPC_CFG_NO_REMOTE);
329 else if (cmd >= 0x4000) {
332 if ((tipc_nametbl_translate(TIPC_ZM_SRV, 0, &domain) == 0) ||
333 (domain != orig_node)) {
334 rep_tlv_buf = tipc_cfg_reply_error_string(TIPC_CFG_NOT_ZONE_MSTR);
339 /* Call appropriate processing routine */
343 rep_tlv_buf = tipc_cfg_reply_none();
345 case TIPC_CMD_GET_NODES:
346 rep_tlv_buf = tipc_node_get_nodes(req_tlv_area, req_tlv_space);
348 case TIPC_CMD_GET_LINKS:
349 rep_tlv_buf = tipc_node_get_links(req_tlv_area, req_tlv_space);
351 case TIPC_CMD_SHOW_LINK_STATS:
352 rep_tlv_buf = tipc_link_cmd_show_stats(req_tlv_area, req_tlv_space);
354 case TIPC_CMD_RESET_LINK_STATS:
355 rep_tlv_buf = tipc_link_cmd_reset_stats(req_tlv_area, req_tlv_space);
357 case TIPC_CMD_SHOW_NAME_TABLE:
358 rep_tlv_buf = tipc_nametbl_get(req_tlv_area, req_tlv_space);
360 case TIPC_CMD_GET_BEARER_NAMES:
361 rep_tlv_buf = tipc_bearer_get_names();
363 case TIPC_CMD_GET_MEDIA_NAMES:
364 rep_tlv_buf = tipc_media_get_names();
366 case TIPC_CMD_SHOW_PORTS:
367 rep_tlv_buf = tipc_port_get_ports();
369 case TIPC_CMD_SET_LOG_SIZE:
370 rep_tlv_buf = tipc_log_resize_cmd(req_tlv_area, req_tlv_space);
372 case TIPC_CMD_DUMP_LOG:
373 rep_tlv_buf = tipc_log_dump();
375 case TIPC_CMD_SHOW_STATS:
376 rep_tlv_buf = tipc_show_stats();
378 case TIPC_CMD_SET_LINK_TOL:
379 case TIPC_CMD_SET_LINK_PRI:
380 case TIPC_CMD_SET_LINK_WINDOW:
381 rep_tlv_buf = tipc_link_cmd_config(req_tlv_area, req_tlv_space, cmd);
383 case TIPC_CMD_ENABLE_BEARER:
384 rep_tlv_buf = cfg_enable_bearer();
386 case TIPC_CMD_DISABLE_BEARER:
387 rep_tlv_buf = cfg_disable_bearer();
389 case TIPC_CMD_SET_NODE_ADDR:
390 rep_tlv_buf = cfg_set_own_addr();
392 case TIPC_CMD_SET_REMOTE_MNG:
393 rep_tlv_buf = cfg_set_remote_mng();
395 case TIPC_CMD_SET_MAX_PORTS:
396 rep_tlv_buf = cfg_set_max_ports();
398 case TIPC_CMD_SET_MAX_PUBL:
399 rep_tlv_buf = cfg_set_max_publications();
401 case TIPC_CMD_SET_MAX_SUBSCR:
402 rep_tlv_buf = cfg_set_max_subscriptions();
404 case TIPC_CMD_SET_MAX_NODES:
405 rep_tlv_buf = cfg_set_max_nodes();
407 case TIPC_CMD_SET_NETID:
408 rep_tlv_buf = cfg_set_netid();
410 case TIPC_CMD_GET_REMOTE_MNG:
411 rep_tlv_buf = tipc_cfg_reply_unsigned(tipc_remote_management);
413 case TIPC_CMD_GET_MAX_PORTS:
414 rep_tlv_buf = tipc_cfg_reply_unsigned(tipc_max_ports);
416 case TIPC_CMD_GET_MAX_PUBL:
417 rep_tlv_buf = tipc_cfg_reply_unsigned(tipc_max_publications);
419 case TIPC_CMD_GET_MAX_SUBSCR:
420 rep_tlv_buf = tipc_cfg_reply_unsigned(tipc_max_subscriptions);
422 case TIPC_CMD_GET_MAX_NODES:
423 rep_tlv_buf = tipc_cfg_reply_unsigned(tipc_max_nodes);
425 case TIPC_CMD_GET_NETID:
426 rep_tlv_buf = tipc_cfg_reply_unsigned(tipc_net_id);
428 case TIPC_CMD_NOT_NET_ADMIN:
430 tipc_cfg_reply_error_string(TIPC_CFG_NOT_NET_ADMIN);
432 case TIPC_CMD_SET_MAX_ZONES:
433 case TIPC_CMD_GET_MAX_ZONES:
434 case TIPC_CMD_SET_MAX_SLAVES:
435 case TIPC_CMD_GET_MAX_SLAVES:
436 case TIPC_CMD_SET_MAX_CLUSTERS:
437 case TIPC_CMD_GET_MAX_CLUSTERS:
438 rep_tlv_buf = tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
439 " (obsolete command)");
442 rep_tlv_buf = tipc_cfg_reply_error_string(TIPC_CFG_NOT_SUPPORTED
443 " (unknown command)");
447 /* Return reply buffer */
449 spin_unlock_bh(&config_lock);
453 static void cfg_named_msg_event(void *userdata,
455 struct sk_buff **buf,
459 struct tipc_portid const *orig,
460 struct tipc_name_seq const *dest)
462 struct tipc_cfg_msg_hdr *req_hdr;
463 struct tipc_cfg_msg_hdr *rep_hdr;
464 struct sk_buff *rep_buf;
466 /* Validate configuration message header (ignore invalid message) */
468 req_hdr = (struct tipc_cfg_msg_hdr *)msg;
469 if ((size < sizeof(*req_hdr)) ||
470 (size != TCM_ALIGN(ntohl(req_hdr->tcm_len))) ||
471 (ntohs(req_hdr->tcm_flags) != TCM_F_REQUEST)) {
472 warn("Invalid configuration message discarded\n");
476 /* Generate reply for request (if can't, return request) */
478 rep_buf = tipc_cfg_do_cmd(orig->node,
479 ntohs(req_hdr->tcm_type),
480 msg + sizeof(*req_hdr),
481 size - sizeof(*req_hdr),
482 BUF_HEADROOM + MAX_H_SIZE + sizeof(*rep_hdr));
484 skb_push(rep_buf, sizeof(*rep_hdr));
485 rep_hdr = (struct tipc_cfg_msg_hdr *)rep_buf->data;
486 memcpy(rep_hdr, req_hdr, sizeof(*rep_hdr));
487 rep_hdr->tcm_len = htonl(rep_buf->len);
488 rep_hdr->tcm_flags &= htons(~TCM_F_REQUEST);
494 /* NEED TO ADD CODE TO HANDLE FAILED SEND (SUCH AS CONGESTION) */
495 tipc_send_buf2port(port_ref, orig, rep_buf, rep_buf->len);
498 int tipc_cfg_init(void)
500 struct tipc_name_seq seq;
503 res = tipc_createport(NULL, TIPC_CRITICAL_IMPORTANCE,
505 NULL, cfg_named_msg_event, NULL,
506 NULL, &config_port_ref);
510 seq.type = TIPC_CFG_SRV;
511 seq.lower = seq.upper = tipc_own_addr;
512 res = tipc_nametbl_publish_rsv(config_port_ref, TIPC_ZONE_SCOPE, &seq);
519 err("Unable to create configuration service\n");
523 void tipc_cfg_stop(void)
525 if (config_port_ref) {
526 tipc_deleteport(config_port_ref);