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]");
59 static bool oops_only = false;
60 module_param(oops_only, bool, 0600);
61 MODULE_PARM_DESC(oops_only, "Only log oops messages");
64 static int __init option_setup(char *opt)
66 strlcpy(config, opt, MAX_PARAM_LENGTH);
69 __setup("netconsole=", option_setup);
72 /* Linked list of all configured targets */
73 static LIST_HEAD(target_list);
75 /* This needs to be a spinlock because write_msg() cannot sleep */
76 static DEFINE_SPINLOCK(target_list_lock);
79 * struct netconsole_target - Represents a configured netconsole target.
80 * @list: Links this target into the target_list.
81 * @item: Links us into the configfs subsystem hierarchy.
82 * @enabled: On / off knob to enable / disable target.
83 * Visible from userspace (read-write).
84 * We maintain a strict 1:1 correspondence between this and
85 * whether the corresponding netpoll is active or inactive.
86 * Also, other parameters of a target may be modified at
87 * runtime only when it is disabled (enabled == 0).
88 * @np: The netpoll structure for this target.
89 * Contains the other userspace visible parameters:
90 * dev_name (read-write)
91 * local_port (read-write)
92 * remote_port (read-write)
93 * local_ip (read-write)
94 * remote_ip (read-write)
95 * local_mac (read-only)
96 * remote_mac (read-write)
98 struct netconsole_target {
99 struct list_head list;
100 #ifdef CONFIG_NETCONSOLE_DYNAMIC
101 struct config_item item;
107 #ifdef CONFIG_NETCONSOLE_DYNAMIC
109 static struct configfs_subsystem netconsole_subsys;
111 static int __init dynamic_netconsole_init(void)
113 config_group_init(&netconsole_subsys.su_group);
114 mutex_init(&netconsole_subsys.su_mutex);
115 return configfs_register_subsystem(&netconsole_subsys);
118 static void __exit dynamic_netconsole_exit(void)
120 configfs_unregister_subsystem(&netconsole_subsys);
124 * Targets that were created by parsing the boot/module option string
125 * do not exist in the configfs hierarchy (and have NULL names) and will
126 * never go away, so make these a no-op for them.
128 static void netconsole_target_get(struct netconsole_target *nt)
130 if (config_item_name(&nt->item))
131 config_item_get(&nt->item);
134 static void netconsole_target_put(struct netconsole_target *nt)
136 if (config_item_name(&nt->item))
137 config_item_put(&nt->item);
140 #else /* !CONFIG_NETCONSOLE_DYNAMIC */
142 static int __init dynamic_netconsole_init(void)
147 static void __exit dynamic_netconsole_exit(void)
152 * No danger of targets going away from under us when dynamic
153 * reconfigurability is off.
155 static void netconsole_target_get(struct netconsole_target *nt)
159 static void netconsole_target_put(struct netconsole_target *nt)
163 #endif /* CONFIG_NETCONSOLE_DYNAMIC */
165 /* Allocate new target (from boot/module param) and setup netpoll for it */
166 static struct netconsole_target *alloc_param_target(char *target_config)
169 struct netconsole_target *nt;
172 * Allocate and initialize with defaults.
173 * Note that these targets get their config_item fields zeroed-out.
175 nt = kzalloc(sizeof(*nt), GFP_KERNEL);
179 nt->np.name = "netconsole";
180 strlcpy(nt->np.dev_name, "eth0", IFNAMSIZ);
181 nt->np.local_port = 6665;
182 nt->np.remote_port = 6666;
183 memset(nt->np.remote_mac, 0xff, ETH_ALEN);
185 /* Parse parameters and setup netpoll */
186 err = netpoll_parse_options(&nt->np, target_config);
190 err = netpoll_setup(&nt->np);
203 /* Cleanup netpoll for given target (from boot/module param) and free it */
204 static void free_param_target(struct netconsole_target *nt)
206 netpoll_cleanup(&nt->np);
210 #ifdef CONFIG_NETCONSOLE_DYNAMIC
213 * Our subsystem hierarchy is:
215 * /sys/kernel/config/netconsole/
230 struct netconsole_target_attr {
231 struct configfs_attribute attr;
232 ssize_t (*show)(struct netconsole_target *nt,
234 ssize_t (*store)(struct netconsole_target *nt,
239 static struct netconsole_target *to_target(struct config_item *item)
242 container_of(item, struct netconsole_target, item) :
247 * Attribute operations for netconsole_target.
250 static ssize_t show_enabled(struct netconsole_target *nt, char *buf)
252 return snprintf(buf, PAGE_SIZE, "%d\n", nt->enabled);
255 static ssize_t show_dev_name(struct netconsole_target *nt, char *buf)
257 return snprintf(buf, PAGE_SIZE, "%s\n", nt->np.dev_name);
260 static ssize_t show_local_port(struct netconsole_target *nt, char *buf)
262 return snprintf(buf, PAGE_SIZE, "%d\n", nt->np.local_port);
265 static ssize_t show_remote_port(struct netconsole_target *nt, char *buf)
267 return snprintf(buf, PAGE_SIZE, "%d\n", nt->np.remote_port);
270 static ssize_t show_local_ip(struct netconsole_target *nt, char *buf)
272 return snprintf(buf, PAGE_SIZE, "%pI4\n", &nt->np.local_ip);
275 static ssize_t show_remote_ip(struct netconsole_target *nt, char *buf)
277 return snprintf(buf, PAGE_SIZE, "%pI4\n", &nt->np.remote_ip);
280 static ssize_t show_local_mac(struct netconsole_target *nt, char *buf)
282 struct net_device *dev = nt->np.dev;
283 static const u8 bcast[ETH_ALEN] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
285 return snprintf(buf, PAGE_SIZE, "%pM\n", dev ? dev->dev_addr : bcast);
288 static ssize_t show_remote_mac(struct netconsole_target *nt, char *buf)
290 return snprintf(buf, PAGE_SIZE, "%pM\n", nt->np.remote_mac);
294 * This one is special -- targets created through the configfs interface
295 * are not enabled (and the corresponding netpoll activated) by default.
296 * The user is expected to set the desired parameters first (which
297 * would enable him to dynamically add new netpoll targets for new
298 * network interfaces as and when they come up).
300 static ssize_t store_enabled(struct netconsole_target *nt,
307 err = kstrtoint(buf, 10, &enabled);
310 if (enabled < 0 || enabled > 1)
312 if (enabled == nt->enabled) {
313 printk(KERN_INFO "netconsole: network logging has already %s\n",
314 nt->enabled ? "started" : "stopped");
318 if (enabled) { /* 1 */
321 * Skip netpoll_parse_options() -- all the attributes are
322 * already configured via configfs. Just print them out.
324 netpoll_print_options(&nt->np);
326 err = netpoll_setup(&nt->np);
330 printk(KERN_INFO "netconsole: network logging started\n");
333 netpoll_cleanup(&nt->np);
336 nt->enabled = enabled;
338 return strnlen(buf, count);
341 static ssize_t store_dev_name(struct netconsole_target *nt,
348 printk(KERN_ERR "netconsole: target (%s) is enabled, "
349 "disable to update parameters\n",
350 config_item_name(&nt->item));
354 strlcpy(nt->np.dev_name, buf, IFNAMSIZ);
356 /* Get rid of possible trailing newline from echo(1) */
357 len = strnlen(nt->np.dev_name, IFNAMSIZ);
358 if (nt->np.dev_name[len - 1] == '\n')
359 nt->np.dev_name[len - 1] = '\0';
361 return strnlen(buf, count);
364 static ssize_t store_local_port(struct netconsole_target *nt,
371 printk(KERN_ERR "netconsole: target (%s) is enabled, "
372 "disable to update parameters\n",
373 config_item_name(&nt->item));
377 rv = kstrtou16(buf, 10, &nt->np.local_port);
380 return strnlen(buf, count);
383 static ssize_t store_remote_port(struct netconsole_target *nt,
390 printk(KERN_ERR "netconsole: target (%s) is enabled, "
391 "disable to update parameters\n",
392 config_item_name(&nt->item));
396 rv = kstrtou16(buf, 10, &nt->np.remote_port);
399 return strnlen(buf, count);
402 static ssize_t store_local_ip(struct netconsole_target *nt,
407 printk(KERN_ERR "netconsole: target (%s) is enabled, "
408 "disable to update parameters\n",
409 config_item_name(&nt->item));
413 nt->np.local_ip = in_aton(buf);
415 return strnlen(buf, count);
418 static ssize_t store_remote_ip(struct netconsole_target *nt,
423 printk(KERN_ERR "netconsole: target (%s) is enabled, "
424 "disable to update parameters\n",
425 config_item_name(&nt->item));
429 nt->np.remote_ip = in_aton(buf);
431 return strnlen(buf, count);
434 static ssize_t store_remote_mac(struct netconsole_target *nt,
438 u8 remote_mac[ETH_ALEN];
441 printk(KERN_ERR "netconsole: target (%s) is enabled, "
442 "disable to update parameters\n",
443 config_item_name(&nt->item));
447 if (!mac_pton(buf, remote_mac))
449 if (buf[3 * ETH_ALEN - 1] && buf[3 * ETH_ALEN - 1] != '\n')
451 memcpy(nt->np.remote_mac, remote_mac, ETH_ALEN);
453 return strnlen(buf, count);
457 * Attribute definitions for netconsole_target.
460 #define NETCONSOLE_TARGET_ATTR_RO(_name) \
461 static struct netconsole_target_attr netconsole_target_##_name = \
462 __CONFIGFS_ATTR(_name, S_IRUGO, show_##_name, NULL)
464 #define NETCONSOLE_TARGET_ATTR_RW(_name) \
465 static struct netconsole_target_attr netconsole_target_##_name = \
466 __CONFIGFS_ATTR(_name, S_IRUGO | S_IWUSR, show_##_name, store_##_name)
468 NETCONSOLE_TARGET_ATTR_RW(enabled);
469 NETCONSOLE_TARGET_ATTR_RW(dev_name);
470 NETCONSOLE_TARGET_ATTR_RW(local_port);
471 NETCONSOLE_TARGET_ATTR_RW(remote_port);
472 NETCONSOLE_TARGET_ATTR_RW(local_ip);
473 NETCONSOLE_TARGET_ATTR_RW(remote_ip);
474 NETCONSOLE_TARGET_ATTR_RO(local_mac);
475 NETCONSOLE_TARGET_ATTR_RW(remote_mac);
477 static struct configfs_attribute *netconsole_target_attrs[] = {
478 &netconsole_target_enabled.attr,
479 &netconsole_target_dev_name.attr,
480 &netconsole_target_local_port.attr,
481 &netconsole_target_remote_port.attr,
482 &netconsole_target_local_ip.attr,
483 &netconsole_target_remote_ip.attr,
484 &netconsole_target_local_mac.attr,
485 &netconsole_target_remote_mac.attr,
490 * Item operations and type for netconsole_target.
493 static void netconsole_target_release(struct config_item *item)
495 kfree(to_target(item));
498 static ssize_t netconsole_target_attr_show(struct config_item *item,
499 struct configfs_attribute *attr,
502 ssize_t ret = -EINVAL;
503 struct netconsole_target *nt = to_target(item);
504 struct netconsole_target_attr *na =
505 container_of(attr, struct netconsole_target_attr, attr);
508 ret = na->show(nt, buf);
513 static ssize_t netconsole_target_attr_store(struct config_item *item,
514 struct configfs_attribute *attr,
518 ssize_t ret = -EINVAL;
519 struct netconsole_target *nt = to_target(item);
520 struct netconsole_target_attr *na =
521 container_of(attr, struct netconsole_target_attr, attr);
524 ret = na->store(nt, buf, count);
529 static struct configfs_item_operations netconsole_target_item_ops = {
530 .release = netconsole_target_release,
531 .show_attribute = netconsole_target_attr_show,
532 .store_attribute = netconsole_target_attr_store,
535 static struct config_item_type netconsole_target_type = {
536 .ct_attrs = netconsole_target_attrs,
537 .ct_item_ops = &netconsole_target_item_ops,
538 .ct_owner = THIS_MODULE,
542 * Group operations and type for netconsole_subsys.
545 static struct config_item *make_netconsole_target(struct config_group *group,
549 struct netconsole_target *nt;
552 * Allocate and initialize with defaults.
553 * Target is disabled at creation (enabled == 0).
555 nt = kzalloc(sizeof(*nt), GFP_KERNEL);
557 return ERR_PTR(-ENOMEM);
559 nt->np.name = "netconsole";
560 strlcpy(nt->np.dev_name, "eth0", IFNAMSIZ);
561 nt->np.local_port = 6665;
562 nt->np.remote_port = 6666;
563 memset(nt->np.remote_mac, 0xff, ETH_ALEN);
565 /* Initialize the config_item member */
566 config_item_init_type_name(&nt->item, name, &netconsole_target_type);
568 /* Adding, but it is disabled */
569 spin_lock_irqsave(&target_list_lock, flags);
570 list_add(&nt->list, &target_list);
571 spin_unlock_irqrestore(&target_list_lock, flags);
576 static void drop_netconsole_target(struct config_group *group,
577 struct config_item *item)
580 struct netconsole_target *nt = to_target(item);
582 spin_lock_irqsave(&target_list_lock, flags);
584 spin_unlock_irqrestore(&target_list_lock, flags);
587 * The target may have never been enabled, or was manually disabled
588 * before being removed so netpoll may have already been cleaned up.
591 netpoll_cleanup(&nt->np);
593 config_item_put(&nt->item);
596 static struct configfs_group_operations netconsole_subsys_group_ops = {
597 .make_item = make_netconsole_target,
598 .drop_item = drop_netconsole_target,
601 static struct config_item_type netconsole_subsys_type = {
602 .ct_group_ops = &netconsole_subsys_group_ops,
603 .ct_owner = THIS_MODULE,
606 /* The netconsole configfs subsystem */
607 static struct configfs_subsystem netconsole_subsys = {
610 .ci_namebuf = "netconsole",
611 .ci_type = &netconsole_subsys_type,
616 #endif /* CONFIG_NETCONSOLE_DYNAMIC */
618 /* Handle network interface device notifications */
619 static int netconsole_netdev_event(struct notifier_block *this,
624 struct netconsole_target *nt;
625 struct net_device *dev = ptr;
626 bool stopped = false;
628 if (!(event == NETDEV_CHANGENAME || event == NETDEV_UNREGISTER ||
629 event == NETDEV_RELEASE || event == NETDEV_JOIN))
632 spin_lock_irqsave(&target_list_lock, flags);
633 list_for_each_entry(nt, &target_list, list) {
634 netconsole_target_get(nt);
635 if (nt->np.dev == dev) {
637 case NETDEV_CHANGENAME:
638 strlcpy(nt->np.dev_name, dev->name, IFNAMSIZ);
642 case NETDEV_UNREGISTER:
644 * rtnl_lock already held
647 __netpoll_cleanup(&nt->np);
656 netconsole_target_put(nt);
658 spin_unlock_irqrestore(&target_list_lock, flags);
660 printk(KERN_INFO "netconsole: network logging stopped on "
661 "interface %s as it ", dev->name);
663 case NETDEV_UNREGISTER:
664 printk(KERN_CONT "unregistered\n");
667 printk(KERN_CONT "released slaves\n");
670 printk(KERN_CONT "is joining a master device\n");
679 static struct notifier_block netconsole_netdev_notifier = {
680 .notifier_call = netconsole_netdev_event,
683 static void write_msg(struct console *con, const char *msg, unsigned int len)
687 struct netconsole_target *nt;
690 if (oops_only && !oops_in_progress)
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);