2 * linux/drivers/net/netconsole.c
4 * Copyright (C) 2001 Ingo Molnar <mingo@redhat.com>
6 * This file contains the implementation of an IRQ-safe, crash-safe
7 * kernel console implementation that outputs kernel messages to the
10 * Modification history:
12 * 2001-09-17 started by Ingo Molnar.
13 * 2003-08-11 2.6 port by Matt Mackall
17 * 2003-09-07 rewritten with netpoll api
20 /****************************************************************
21 * This program is free software; you can redistribute it and/or modify
22 * it under the terms of the GNU General Public License as published by
23 * the Free Software Foundation; either version 2, or (at your option)
26 * This program is distributed in the hope that it will be useful,
27 * but WITHOUT ANY WARRANTY; without even the implied warranty of
28 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
29 * GNU General Public License for more details.
31 * You should have received a copy of the GNU General Public License
32 * along with this program; if not, write to the Free Software
33 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
35 ****************************************************************/
38 #include <linux/init.h>
39 #include <linux/module.h>
40 #include <linux/slab.h>
41 #include <linux/console.h>
42 #include <linux/moduleparam.h>
43 #include <linux/string.h>
44 #include <linux/netpoll.h>
45 #include <linux/inet.h>
46 #include <linux/configfs.h>
48 MODULE_AUTHOR("Maintainer: Matt Mackall <mpm@selenic.com>");
49 MODULE_DESCRIPTION("Console driver for network interfaces");
50 MODULE_LICENSE("GPL");
52 #define MAX_PARAM_LENGTH 256
53 #define MAX_PRINT_CHUNK 1000
55 static char config[MAX_PARAM_LENGTH];
56 module_param_string(netconsole, config, MAX_PARAM_LENGTH, 0);
57 MODULE_PARM_DESC(netconsole, " netconsole=[src-port]@[src-ip]/[dev],[tgt-port]@<tgt-ip>/[tgt-macaddr]");
60 static int __init option_setup(char *opt)
62 strlcpy(config, opt, MAX_PARAM_LENGTH);
65 __setup("netconsole=", option_setup);
68 /* Linked list of all configured targets */
69 static LIST_HEAD(target_list);
71 /* This needs to be a spinlock because write_msg() cannot sleep */
72 static DEFINE_SPINLOCK(target_list_lock);
75 * struct netconsole_target - Represents a configured netconsole target.
76 * @list: Links this target into the target_list.
77 * @item: Links us into the configfs subsystem hierarchy.
78 * @enabled: On / off knob to enable / disable target.
79 * Visible from userspace (read-write).
80 * We maintain a strict 1:1 correspondence between this and
81 * whether the corresponding netpoll is active or inactive.
82 * Also, other parameters of a target may be modified at
83 * runtime only when it is disabled (enabled == 0).
84 * @np: The netpoll structure for this target.
85 * Contains the other userspace visible parameters:
86 * dev_name (read-write)
87 * local_port (read-write)
88 * remote_port (read-write)
89 * local_ip (read-write)
90 * remote_ip (read-write)
91 * local_mac (read-only)
92 * remote_mac (read-write)
94 struct netconsole_target {
95 struct list_head list;
96 #ifdef CONFIG_NETCONSOLE_DYNAMIC
97 struct config_item item;
103 #ifdef CONFIG_NETCONSOLE_DYNAMIC
105 static struct configfs_subsystem netconsole_subsys;
107 static int __init dynamic_netconsole_init(void)
109 config_group_init(&netconsole_subsys.su_group);
110 mutex_init(&netconsole_subsys.su_mutex);
111 return configfs_register_subsystem(&netconsole_subsys);
114 static void __exit dynamic_netconsole_exit(void)
116 configfs_unregister_subsystem(&netconsole_subsys);
120 * Targets that were created by parsing the boot/module option string
121 * do not exist in the configfs hierarchy (and have NULL names) and will
122 * never go away, so make these a no-op for them.
124 static void netconsole_target_get(struct netconsole_target *nt)
126 if (config_item_name(&nt->item))
127 config_item_get(&nt->item);
130 static void netconsole_target_put(struct netconsole_target *nt)
132 if (config_item_name(&nt->item))
133 config_item_put(&nt->item);
136 #else /* !CONFIG_NETCONSOLE_DYNAMIC */
138 static int __init dynamic_netconsole_init(void)
143 static void __exit dynamic_netconsole_exit(void)
148 * No danger of targets going away from under us when dynamic
149 * reconfigurability is off.
151 static void netconsole_target_get(struct netconsole_target *nt)
155 static void netconsole_target_put(struct netconsole_target *nt)
159 #endif /* CONFIG_NETCONSOLE_DYNAMIC */
161 /* Allocate new target (from boot/module param) and setup netpoll for it */
162 static struct netconsole_target *alloc_param_target(char *target_config)
165 struct netconsole_target *nt;
168 * Allocate and initialize with defaults.
169 * Note that these targets get their config_item fields zeroed-out.
171 nt = kzalloc(sizeof(*nt), GFP_KERNEL);
173 printk(KERN_ERR "netconsole: failed to allocate memory\n");
177 nt->np.name = "netconsole";
178 strlcpy(nt->np.dev_name, "eth0", IFNAMSIZ);
179 nt->np.local_port = 6665;
180 nt->np.remote_port = 6666;
181 memset(nt->np.remote_mac, 0xff, ETH_ALEN);
183 /* Parse parameters and setup netpoll */
184 err = netpoll_parse_options(&nt->np, target_config);
188 err = netpoll_setup(&nt->np);
201 /* Cleanup netpoll for given target (from boot/module param) and free it */
202 static void free_param_target(struct netconsole_target *nt)
204 netpoll_cleanup(&nt->np);
208 #ifdef CONFIG_NETCONSOLE_DYNAMIC
211 * Our subsystem hierarchy is:
213 * /sys/kernel/config/netconsole/
228 struct netconsole_target_attr {
229 struct configfs_attribute attr;
230 ssize_t (*show)(struct netconsole_target *nt,
232 ssize_t (*store)(struct netconsole_target *nt,
237 static struct netconsole_target *to_target(struct config_item *item)
240 container_of(item, struct netconsole_target, item) :
245 * Wrapper over simple_strtol (base 10) with sanity and range checking.
246 * We return (signed) long only because we may want to return errors.
247 * Do not use this to convert numbers that are allowed to be negative.
249 static long strtol10_check_range(const char *cp, long min, long max)
252 char *p = (char *) cp;
257 ret = simple_strtol(p, &p, 10);
259 if (*p && (*p != '\n')) {
260 printk(KERN_ERR "netconsole: invalid input\n");
263 if ((ret < min) || (ret > max)) {
264 printk(KERN_ERR "netconsole: input %ld must be between "
265 "%ld and %ld\n", ret, min, max);
273 * Attribute operations for netconsole_target.
276 static ssize_t show_enabled(struct netconsole_target *nt, char *buf)
278 return snprintf(buf, PAGE_SIZE, "%d\n", nt->enabled);
281 static ssize_t show_dev_name(struct netconsole_target *nt, char *buf)
283 return snprintf(buf, PAGE_SIZE, "%s\n", nt->np.dev_name);
286 static ssize_t show_local_port(struct netconsole_target *nt, char *buf)
288 return snprintf(buf, PAGE_SIZE, "%d\n", nt->np.local_port);
291 static ssize_t show_remote_port(struct netconsole_target *nt, char *buf)
293 return snprintf(buf, PAGE_SIZE, "%d\n", nt->np.remote_port);
296 static ssize_t show_local_ip(struct netconsole_target *nt, char *buf)
298 return snprintf(buf, PAGE_SIZE, "%pI4\n", &nt->np.local_ip);
301 static ssize_t show_remote_ip(struct netconsole_target *nt, char *buf)
303 return snprintf(buf, PAGE_SIZE, "%pI4\n", &nt->np.remote_ip);
306 static ssize_t show_local_mac(struct netconsole_target *nt, char *buf)
308 struct net_device *dev = nt->np.dev;
309 static const u8 bcast[ETH_ALEN] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
311 return snprintf(buf, PAGE_SIZE, "%pM\n", dev ? dev->dev_addr : bcast);
314 static ssize_t show_remote_mac(struct netconsole_target *nt, char *buf)
316 return snprintf(buf, PAGE_SIZE, "%pM\n", nt->np.remote_mac);
320 * This one is special -- targets created through the configfs interface
321 * are not enabled (and the corresponding netpoll activated) by default.
322 * The user is expected to set the desired parameters first (which
323 * would enable him to dynamically add new netpoll targets for new
324 * network interfaces as and when they come up).
326 static ssize_t store_enabled(struct netconsole_target *nt,
333 enabled = strtol10_check_range(buf, 0, 1);
337 if (enabled) { /* 1 */
340 * Skip netpoll_parse_options() -- all the attributes are
341 * already configured via configfs. Just print them out.
343 netpoll_print_options(&nt->np);
345 err = netpoll_setup(&nt->np);
349 printk(KERN_INFO "netconsole: network logging started\n");
352 netpoll_cleanup(&nt->np);
355 nt->enabled = enabled;
357 return strnlen(buf, count);
360 static ssize_t store_dev_name(struct netconsole_target *nt,
367 printk(KERN_ERR "netconsole: target (%s) is enabled, "
368 "disable to update parameters\n",
369 config_item_name(&nt->item));
373 strlcpy(nt->np.dev_name, buf, IFNAMSIZ);
375 /* Get rid of possible trailing newline from echo(1) */
376 len = strnlen(nt->np.dev_name, IFNAMSIZ);
377 if (nt->np.dev_name[len - 1] == '\n')
378 nt->np.dev_name[len - 1] = '\0';
380 return strnlen(buf, count);
383 static ssize_t store_local_port(struct netconsole_target *nt,
388 #define __U16_MAX ((__u16) ~0U)
391 printk(KERN_ERR "netconsole: target (%s) is enabled, "
392 "disable to update parameters\n",
393 config_item_name(&nt->item));
397 local_port = strtol10_check_range(buf, 0, __U16_MAX);
401 nt->np.local_port = local_port;
403 return strnlen(buf, count);
406 static ssize_t store_remote_port(struct netconsole_target *nt,
411 #define __U16_MAX ((__u16) ~0U)
414 printk(KERN_ERR "netconsole: target (%s) is enabled, "
415 "disable to update parameters\n",
416 config_item_name(&nt->item));
420 remote_port = strtol10_check_range(buf, 0, __U16_MAX);
424 nt->np.remote_port = remote_port;
426 return strnlen(buf, count);
429 static ssize_t store_local_ip(struct netconsole_target *nt,
434 printk(KERN_ERR "netconsole: target (%s) is enabled, "
435 "disable to update parameters\n",
436 config_item_name(&nt->item));
440 nt->np.local_ip = in_aton(buf);
442 return strnlen(buf, count);
445 static ssize_t store_remote_ip(struct netconsole_target *nt,
450 printk(KERN_ERR "netconsole: target (%s) is enabled, "
451 "disable to update parameters\n",
452 config_item_name(&nt->item));
456 nt->np.remote_ip = in_aton(buf);
458 return strnlen(buf, count);
461 static ssize_t store_remote_mac(struct netconsole_target *nt,
465 u8 remote_mac[ETH_ALEN];
466 char *p = (char *) buf;
470 printk(KERN_ERR "netconsole: target (%s) is enabled, "
471 "disable to update parameters\n",
472 config_item_name(&nt->item));
476 for (i = 0; i < ETH_ALEN - 1; i++) {
477 remote_mac[i] = simple_strtoul(p, &p, 16);
482 remote_mac[ETH_ALEN - 1] = simple_strtoul(p, &p, 16);
483 if (*p && (*p != '\n'))
486 memcpy(nt->np.remote_mac, remote_mac, ETH_ALEN);
488 return strnlen(buf, count);
491 printk(KERN_ERR "netconsole: invalid input\n");
496 * Attribute definitions for netconsole_target.
499 #define NETCONSOLE_TARGET_ATTR_RO(_name) \
500 static struct netconsole_target_attr netconsole_target_##_name = \
501 __CONFIGFS_ATTR(_name, S_IRUGO, show_##_name, NULL)
503 #define NETCONSOLE_TARGET_ATTR_RW(_name) \
504 static struct netconsole_target_attr netconsole_target_##_name = \
505 __CONFIGFS_ATTR(_name, S_IRUGO | S_IWUSR, show_##_name, store_##_name)
507 NETCONSOLE_TARGET_ATTR_RW(enabled);
508 NETCONSOLE_TARGET_ATTR_RW(dev_name);
509 NETCONSOLE_TARGET_ATTR_RW(local_port);
510 NETCONSOLE_TARGET_ATTR_RW(remote_port);
511 NETCONSOLE_TARGET_ATTR_RW(local_ip);
512 NETCONSOLE_TARGET_ATTR_RW(remote_ip);
513 NETCONSOLE_TARGET_ATTR_RO(local_mac);
514 NETCONSOLE_TARGET_ATTR_RW(remote_mac);
516 static struct configfs_attribute *netconsole_target_attrs[] = {
517 &netconsole_target_enabled.attr,
518 &netconsole_target_dev_name.attr,
519 &netconsole_target_local_port.attr,
520 &netconsole_target_remote_port.attr,
521 &netconsole_target_local_ip.attr,
522 &netconsole_target_remote_ip.attr,
523 &netconsole_target_local_mac.attr,
524 &netconsole_target_remote_mac.attr,
529 * Item operations and type for netconsole_target.
532 static void netconsole_target_release(struct config_item *item)
534 kfree(to_target(item));
537 static ssize_t netconsole_target_attr_show(struct config_item *item,
538 struct configfs_attribute *attr,
541 ssize_t ret = -EINVAL;
542 struct netconsole_target *nt = to_target(item);
543 struct netconsole_target_attr *na =
544 container_of(attr, struct netconsole_target_attr, attr);
547 ret = na->show(nt, buf);
552 static ssize_t netconsole_target_attr_store(struct config_item *item,
553 struct configfs_attribute *attr,
557 ssize_t ret = -EINVAL;
558 struct netconsole_target *nt = to_target(item);
559 struct netconsole_target_attr *na =
560 container_of(attr, struct netconsole_target_attr, attr);
563 ret = na->store(nt, buf, count);
568 static struct configfs_item_operations netconsole_target_item_ops = {
569 .release = netconsole_target_release,
570 .show_attribute = netconsole_target_attr_show,
571 .store_attribute = netconsole_target_attr_store,
574 static struct config_item_type netconsole_target_type = {
575 .ct_attrs = netconsole_target_attrs,
576 .ct_item_ops = &netconsole_target_item_ops,
577 .ct_owner = THIS_MODULE,
581 * Group operations and type for netconsole_subsys.
584 static struct config_item *make_netconsole_target(struct config_group *group,
588 struct netconsole_target *nt;
591 * Allocate and initialize with defaults.
592 * Target is disabled at creation (enabled == 0).
594 nt = kzalloc(sizeof(*nt), GFP_KERNEL);
596 printk(KERN_ERR "netconsole: failed to allocate memory\n");
597 return ERR_PTR(-ENOMEM);
600 nt->np.name = "netconsole";
601 strlcpy(nt->np.dev_name, "eth0", IFNAMSIZ);
602 nt->np.local_port = 6665;
603 nt->np.remote_port = 6666;
604 memset(nt->np.remote_mac, 0xff, ETH_ALEN);
606 /* Initialize the config_item member */
607 config_item_init_type_name(&nt->item, name, &netconsole_target_type);
609 /* Adding, but it is disabled */
610 spin_lock_irqsave(&target_list_lock, flags);
611 list_add(&nt->list, &target_list);
612 spin_unlock_irqrestore(&target_list_lock, flags);
617 static void drop_netconsole_target(struct config_group *group,
618 struct config_item *item)
621 struct netconsole_target *nt = to_target(item);
623 spin_lock_irqsave(&target_list_lock, flags);
625 spin_unlock_irqrestore(&target_list_lock, flags);
628 * The target may have never been enabled, or was manually disabled
629 * before being removed so netpoll may have already been cleaned up.
632 netpoll_cleanup(&nt->np);
634 config_item_put(&nt->item);
637 static struct configfs_group_operations netconsole_subsys_group_ops = {
638 .make_item = make_netconsole_target,
639 .drop_item = drop_netconsole_target,
642 static struct config_item_type netconsole_subsys_type = {
643 .ct_group_ops = &netconsole_subsys_group_ops,
644 .ct_owner = THIS_MODULE,
647 /* The netconsole configfs subsystem */
648 static struct configfs_subsystem netconsole_subsys = {
651 .ci_namebuf = "netconsole",
652 .ci_type = &netconsole_subsys_type,
657 #endif /* CONFIG_NETCONSOLE_DYNAMIC */
659 /* Handle network interface device notifications */
660 static int netconsole_netdev_event(struct notifier_block *this,
665 struct netconsole_target *nt;
666 struct net_device *dev = ptr;
667 bool stopped = false;
669 if (!(event == NETDEV_CHANGENAME || event == NETDEV_UNREGISTER ||
670 event == NETDEV_BONDING_DESLAVE || event == NETDEV_GOING_DOWN))
673 spin_lock_irqsave(&target_list_lock, flags);
674 list_for_each_entry(nt, &target_list, list) {
675 netconsole_target_get(nt);
676 if (nt->np.dev == dev) {
678 case NETDEV_CHANGENAME:
679 strlcpy(nt->np.dev_name, dev->name, IFNAMSIZ);
681 case NETDEV_UNREGISTER:
683 * rtnl_lock already held
686 __netpoll_cleanup(&nt->np);
691 case NETDEV_GOING_DOWN:
692 case NETDEV_BONDING_DESLAVE:
698 netconsole_target_put(nt);
700 spin_unlock_irqrestore(&target_list_lock, flags);
701 if (stopped && (event == NETDEV_UNREGISTER || event == NETDEV_BONDING_DESLAVE))
702 printk(KERN_INFO "netconsole: network logging stopped on "
703 "interface %s as it %s\n", dev->name,
704 event == NETDEV_UNREGISTER ? "unregistered" : "released slaves");
710 static struct notifier_block netconsole_netdev_notifier = {
711 .notifier_call = netconsole_netdev_event,
714 static void write_msg(struct console *con, const char *msg, unsigned int len)
718 struct netconsole_target *nt;
721 /* Avoid taking lock and disabling interrupts unnecessarily */
722 if (list_empty(&target_list))
725 spin_lock_irqsave(&target_list_lock, flags);
726 list_for_each_entry(nt, &target_list, list) {
727 netconsole_target_get(nt);
728 if (nt->enabled && netif_running(nt->np.dev)) {
730 * We nest this inside the for-each-target loop above
731 * so that we're able to get as much logging out to
732 * at least one target if we die inside here, instead
733 * of unnecessarily keeping all targets in lock-step.
736 for (left = len; left;) {
737 frag = min(left, MAX_PRINT_CHUNK);
738 netpoll_send_udp(&nt->np, tmp, frag);
743 netconsole_target_put(nt);
745 spin_unlock_irqrestore(&target_list_lock, flags);
748 static struct console netconsole = {
750 .flags = CON_ENABLED,
754 static int __init init_netconsole(void)
757 struct netconsole_target *nt, *tmp;
760 char *input = config;
762 if (strnlen(input, MAX_PARAM_LENGTH)) {
763 while ((target_config = strsep(&input, ";"))) {
764 nt = alloc_param_target(target_config);
769 /* Dump existing printks when we register */
770 netconsole.flags |= CON_PRINTBUFFER;
772 spin_lock_irqsave(&target_list_lock, flags);
773 list_add(&nt->list, &target_list);
774 spin_unlock_irqrestore(&target_list_lock, flags);
778 err = register_netdevice_notifier(&netconsole_netdev_notifier);
782 err = dynamic_netconsole_init();
786 register_console(&netconsole);
787 printk(KERN_INFO "netconsole: network logging started\n");
792 unregister_netdevice_notifier(&netconsole_netdev_notifier);
795 printk(KERN_ERR "netconsole: cleaning up\n");
798 * Remove all targets and destroy them (only targets created
799 * from the boot/module option exist here). Skipping the list
800 * lock is safe here, and netpoll_cleanup() will sleep.
802 list_for_each_entry_safe(nt, tmp, &target_list, list) {
804 free_param_target(nt);
810 static void __exit cleanup_netconsole(void)
812 struct netconsole_target *nt, *tmp;
814 unregister_console(&netconsole);
815 dynamic_netconsole_exit();
816 unregister_netdevice_notifier(&netconsole_netdev_notifier);
819 * Targets created via configfs pin references on our module
820 * and would first be rmdir(2)'ed from userspace. We reach
821 * here only when they are already destroyed, and only those
822 * created from the boot/module option are left, so remove and
823 * destroy them. Skipping the list lock is safe here, and
824 * netpoll_cleanup() will sleep.
826 list_for_each_entry_safe(nt, tmp, &target_list, list) {
828 free_param_target(nt);
832 module_init(init_netconsole);
833 module_exit(cleanup_netconsole);