2 * linux/drivers/net/netconsole.c
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>
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);
175 nt->np.name = "netconsole";
176 strlcpy(nt->np.dev_name, "eth0", IFNAMSIZ);
177 nt->np.local_port = 6665;
178 nt->np.remote_port = 6666;
179 memset(nt->np.remote_mac, 0xff, ETH_ALEN);
181 /* Parse parameters and setup netpoll */
182 err = netpoll_parse_options(&nt->np, target_config);
186 err = netpoll_setup(&nt->np);
199 /* Cleanup netpoll for given target (from boot/module param) and free it */
200 static void free_param_target(struct netconsole_target *nt)
202 netpoll_cleanup(&nt->np);
206 #ifdef CONFIG_NETCONSOLE_DYNAMIC
209 * Our subsystem hierarchy is:
211 * /sys/kernel/config/netconsole/
226 struct netconsole_target_attr {
227 struct configfs_attribute attr;
228 ssize_t (*show)(struct netconsole_target *nt,
230 ssize_t (*store)(struct netconsole_target *nt,
235 static struct netconsole_target *to_target(struct config_item *item)
238 container_of(item, struct netconsole_target, item) :
243 * Attribute operations for netconsole_target.
246 static ssize_t show_enabled(struct netconsole_target *nt, char *buf)
248 return snprintf(buf, PAGE_SIZE, "%d\n", nt->enabled);
251 static ssize_t show_dev_name(struct netconsole_target *nt, char *buf)
253 return snprintf(buf, PAGE_SIZE, "%s\n", nt->np.dev_name);
256 static ssize_t show_local_port(struct netconsole_target *nt, char *buf)
258 return snprintf(buf, PAGE_SIZE, "%d\n", nt->np.local_port);
261 static ssize_t show_remote_port(struct netconsole_target *nt, char *buf)
263 return snprintf(buf, PAGE_SIZE, "%d\n", nt->np.remote_port);
266 static ssize_t show_local_ip(struct netconsole_target *nt, char *buf)
268 return snprintf(buf, PAGE_SIZE, "%pI4\n", &nt->np.local_ip);
271 static ssize_t show_remote_ip(struct netconsole_target *nt, char *buf)
273 return snprintf(buf, PAGE_SIZE, "%pI4\n", &nt->np.remote_ip);
276 static ssize_t show_local_mac(struct netconsole_target *nt, char *buf)
278 struct net_device *dev = nt->np.dev;
279 static const u8 bcast[ETH_ALEN] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
281 return snprintf(buf, PAGE_SIZE, "%pM\n", dev ? dev->dev_addr : bcast);
284 static ssize_t show_remote_mac(struct netconsole_target *nt, char *buf)
286 return snprintf(buf, PAGE_SIZE, "%pM\n", nt->np.remote_mac);
290 * This one is special -- targets created through the configfs interface
291 * are not enabled (and the corresponding netpoll activated) by default.
292 * The user is expected to set the desired parameters first (which
293 * would enable him to dynamically add new netpoll targets for new
294 * network interfaces as and when they come up).
296 static ssize_t store_enabled(struct netconsole_target *nt,
303 err = kstrtoint(buf, 10, &enabled);
306 if (enabled < 0 || enabled > 1)
308 if (enabled == nt->enabled) {
309 printk(KERN_INFO "netconsole: network logging has already %s\n",
310 nt->enabled ? "started" : "stopped");
314 if (enabled) { /* 1 */
317 * Skip netpoll_parse_options() -- all the attributes are
318 * already configured via configfs. Just print them out.
320 netpoll_print_options(&nt->np);
322 err = netpoll_setup(&nt->np);
326 printk(KERN_INFO "netconsole: network logging started\n");
329 netpoll_cleanup(&nt->np);
332 nt->enabled = enabled;
334 return strnlen(buf, count);
337 static ssize_t store_dev_name(struct netconsole_target *nt,
344 printk(KERN_ERR "netconsole: target (%s) is enabled, "
345 "disable to update parameters\n",
346 config_item_name(&nt->item));
350 strlcpy(nt->np.dev_name, buf, IFNAMSIZ);
352 /* Get rid of possible trailing newline from echo(1) */
353 len = strnlen(nt->np.dev_name, IFNAMSIZ);
354 if (nt->np.dev_name[len - 1] == '\n')
355 nt->np.dev_name[len - 1] = '\0';
357 return strnlen(buf, count);
360 static ssize_t store_local_port(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 rv = kstrtou16(buf, 10, &nt->np.local_port);
376 return strnlen(buf, count);
379 static ssize_t store_remote_port(struct netconsole_target *nt,
386 printk(KERN_ERR "netconsole: target (%s) is enabled, "
387 "disable to update parameters\n",
388 config_item_name(&nt->item));
392 rv = kstrtou16(buf, 10, &nt->np.remote_port);
395 return strnlen(buf, count);
398 static ssize_t store_local_ip(struct netconsole_target *nt,
403 printk(KERN_ERR "netconsole: target (%s) is enabled, "
404 "disable to update parameters\n",
405 config_item_name(&nt->item));
409 nt->np.local_ip = in_aton(buf);
411 return strnlen(buf, count);
414 static ssize_t store_remote_ip(struct netconsole_target *nt,
419 printk(KERN_ERR "netconsole: target (%s) is enabled, "
420 "disable to update parameters\n",
421 config_item_name(&nt->item));
425 nt->np.remote_ip = in_aton(buf);
427 return strnlen(buf, count);
430 static ssize_t store_remote_mac(struct netconsole_target *nt,
434 u8 remote_mac[ETH_ALEN];
437 printk(KERN_ERR "netconsole: target (%s) is enabled, "
438 "disable to update parameters\n",
439 config_item_name(&nt->item));
443 if (!mac_pton(buf, remote_mac))
445 if (buf[3 * ETH_ALEN - 1] && buf[3 * ETH_ALEN - 1] != '\n')
447 memcpy(nt->np.remote_mac, remote_mac, ETH_ALEN);
449 return strnlen(buf, count);
453 * Attribute definitions for netconsole_target.
456 #define NETCONSOLE_TARGET_ATTR_RO(_name) \
457 static struct netconsole_target_attr netconsole_target_##_name = \
458 __CONFIGFS_ATTR(_name, S_IRUGO, show_##_name, NULL)
460 #define NETCONSOLE_TARGET_ATTR_RW(_name) \
461 static struct netconsole_target_attr netconsole_target_##_name = \
462 __CONFIGFS_ATTR(_name, S_IRUGO | S_IWUSR, show_##_name, store_##_name)
464 NETCONSOLE_TARGET_ATTR_RW(enabled);
465 NETCONSOLE_TARGET_ATTR_RW(dev_name);
466 NETCONSOLE_TARGET_ATTR_RW(local_port);
467 NETCONSOLE_TARGET_ATTR_RW(remote_port);
468 NETCONSOLE_TARGET_ATTR_RW(local_ip);
469 NETCONSOLE_TARGET_ATTR_RW(remote_ip);
470 NETCONSOLE_TARGET_ATTR_RO(local_mac);
471 NETCONSOLE_TARGET_ATTR_RW(remote_mac);
473 static struct configfs_attribute *netconsole_target_attrs[] = {
474 &netconsole_target_enabled.attr,
475 &netconsole_target_dev_name.attr,
476 &netconsole_target_local_port.attr,
477 &netconsole_target_remote_port.attr,
478 &netconsole_target_local_ip.attr,
479 &netconsole_target_remote_ip.attr,
480 &netconsole_target_local_mac.attr,
481 &netconsole_target_remote_mac.attr,
486 * Item operations and type for netconsole_target.
489 static void netconsole_target_release(struct config_item *item)
491 kfree(to_target(item));
494 static ssize_t netconsole_target_attr_show(struct config_item *item,
495 struct configfs_attribute *attr,
498 ssize_t ret = -EINVAL;
499 struct netconsole_target *nt = to_target(item);
500 struct netconsole_target_attr *na =
501 container_of(attr, struct netconsole_target_attr, attr);
504 ret = na->show(nt, buf);
509 static ssize_t netconsole_target_attr_store(struct config_item *item,
510 struct configfs_attribute *attr,
514 ssize_t ret = -EINVAL;
515 struct netconsole_target *nt = to_target(item);
516 struct netconsole_target_attr *na =
517 container_of(attr, struct netconsole_target_attr, attr);
520 ret = na->store(nt, buf, count);
525 static struct configfs_item_operations netconsole_target_item_ops = {
526 .release = netconsole_target_release,
527 .show_attribute = netconsole_target_attr_show,
528 .store_attribute = netconsole_target_attr_store,
531 static struct config_item_type netconsole_target_type = {
532 .ct_attrs = netconsole_target_attrs,
533 .ct_item_ops = &netconsole_target_item_ops,
534 .ct_owner = THIS_MODULE,
538 * Group operations and type for netconsole_subsys.
541 static struct config_item *make_netconsole_target(struct config_group *group,
545 struct netconsole_target *nt;
548 * Allocate and initialize with defaults.
549 * Target is disabled at creation (enabled == 0).
551 nt = kzalloc(sizeof(*nt), GFP_KERNEL);
553 return ERR_PTR(-ENOMEM);
555 nt->np.name = "netconsole";
556 strlcpy(nt->np.dev_name, "eth0", IFNAMSIZ);
557 nt->np.local_port = 6665;
558 nt->np.remote_port = 6666;
559 memset(nt->np.remote_mac, 0xff, ETH_ALEN);
561 /* Initialize the config_item member */
562 config_item_init_type_name(&nt->item, name, &netconsole_target_type);
564 /* Adding, but it is disabled */
565 spin_lock_irqsave(&target_list_lock, flags);
566 list_add(&nt->list, &target_list);
567 spin_unlock_irqrestore(&target_list_lock, flags);
572 static void drop_netconsole_target(struct config_group *group,
573 struct config_item *item)
576 struct netconsole_target *nt = to_target(item);
578 spin_lock_irqsave(&target_list_lock, flags);
580 spin_unlock_irqrestore(&target_list_lock, flags);
583 * The target may have never been enabled, or was manually disabled
584 * before being removed so netpoll may have already been cleaned up.
587 netpoll_cleanup(&nt->np);
589 config_item_put(&nt->item);
592 static struct configfs_group_operations netconsole_subsys_group_ops = {
593 .make_item = make_netconsole_target,
594 .drop_item = drop_netconsole_target,
597 static struct config_item_type netconsole_subsys_type = {
598 .ct_group_ops = &netconsole_subsys_group_ops,
599 .ct_owner = THIS_MODULE,
602 /* The netconsole configfs subsystem */
603 static struct configfs_subsystem netconsole_subsys = {
606 .ci_namebuf = "netconsole",
607 .ci_type = &netconsole_subsys_type,
612 #endif /* CONFIG_NETCONSOLE_DYNAMIC */
614 /* Handle network interface device notifications */
615 static int netconsole_netdev_event(struct notifier_block *this,
620 struct netconsole_target *nt;
621 struct net_device *dev = ptr;
622 bool stopped = false;
624 if (!(event == NETDEV_CHANGENAME || event == NETDEV_UNREGISTER ||
625 event == NETDEV_RELEASE || event == NETDEV_JOIN))
628 spin_lock_irqsave(&target_list_lock, flags);
629 list_for_each_entry(nt, &target_list, list) {
630 netconsole_target_get(nt);
631 if (nt->np.dev == dev) {
633 case NETDEV_CHANGENAME:
634 strlcpy(nt->np.dev_name, dev->name, IFNAMSIZ);
638 case NETDEV_UNREGISTER:
640 * rtnl_lock already held
643 spin_unlock_irqrestore(
646 __netpoll_cleanup(&nt->np);
647 spin_lock_irqsave(&target_list_lock,
651 netconsole_target_put(nt);
658 netconsole_target_put(nt);
660 spin_unlock_irqrestore(&target_list_lock, flags);
662 printk(KERN_INFO "netconsole: network logging stopped on "
663 "interface %s as it ", dev->name);
665 case NETDEV_UNREGISTER:
666 printk(KERN_CONT "unregistered\n");
669 printk(KERN_CONT "released slaves\n");
672 printk(KERN_CONT "is joining a master device\n");
681 static struct notifier_block netconsole_netdev_notifier = {
682 .notifier_call = netconsole_netdev_event,
685 static void write_msg(struct console *con, const char *msg, unsigned int len)
689 struct netconsole_target *nt;
692 /* Avoid taking lock and disabling interrupts unnecessarily */
693 if (list_empty(&target_list))
696 spin_lock_irqsave(&target_list_lock, flags);
697 list_for_each_entry(nt, &target_list, list) {
698 netconsole_target_get(nt);
699 if (nt->enabled && netif_running(nt->np.dev)) {
701 * We nest this inside the for-each-target loop above
702 * so that we're able to get as much logging out to
703 * at least one target if we die inside here, instead
704 * of unnecessarily keeping all targets in lock-step.
707 for (left = len; left;) {
708 frag = min(left, MAX_PRINT_CHUNK);
709 netpoll_send_udp(&nt->np, tmp, frag);
714 netconsole_target_put(nt);
716 spin_unlock_irqrestore(&target_list_lock, flags);
719 static struct console netconsole = {
721 .flags = CON_ENABLED,
725 static int __init init_netconsole(void)
728 struct netconsole_target *nt, *tmp;
731 char *input = config;
733 if (strnlen(input, MAX_PARAM_LENGTH)) {
734 while ((target_config = strsep(&input, ";"))) {
735 nt = alloc_param_target(target_config);
740 /* Dump existing printks when we register */
741 netconsole.flags |= CON_PRINTBUFFER;
743 spin_lock_irqsave(&target_list_lock, flags);
744 list_add(&nt->list, &target_list);
745 spin_unlock_irqrestore(&target_list_lock, flags);
749 err = register_netdevice_notifier(&netconsole_netdev_notifier);
753 err = dynamic_netconsole_init();
757 register_console(&netconsole);
758 printk(KERN_INFO "netconsole: network logging started\n");
763 unregister_netdevice_notifier(&netconsole_netdev_notifier);
766 printk(KERN_ERR "netconsole: cleaning up\n");
769 * Remove all targets and destroy them (only targets created
770 * from the boot/module option exist here). Skipping the list
771 * lock is safe here, and netpoll_cleanup() will sleep.
773 list_for_each_entry_safe(nt, tmp, &target_list, list) {
775 free_param_target(nt);
781 static void __exit cleanup_netconsole(void)
783 struct netconsole_target *nt, *tmp;
785 unregister_console(&netconsole);
786 dynamic_netconsole_exit();
787 unregister_netdevice_notifier(&netconsole_netdev_notifier);
790 * Targets created via configfs pin references on our module
791 * and would first be rmdir(2)'ed from userspace. We reach
792 * here only when they are already destroyed, and only those
793 * created from the boot/module option are left, so remove and
794 * destroy them. Skipping the list lock is safe here, and
795 * netpoll_cleanup() will sleep.
797 list_for_each_entry_safe(nt, tmp, &target_list, list) {
799 free_param_target(nt);
804 * Use late_initcall to ensure netconsole is
805 * initialized after network device driver if built-in.
807 * late_initcall() and module_init() are identical if built as module.
809 late_initcall(init_netconsole);
810 module_exit(cleanup_netconsole);