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/kernel.h>
44 #include <linux/string.h>
45 #include <linux/netpoll.h>
46 #include <linux/inet.h>
47 #include <linux/configfs.h>
49 MODULE_AUTHOR("Maintainer: Matt Mackall <mpm@selenic.com>");
50 MODULE_DESCRIPTION("Console driver for network interfaces");
51 MODULE_LICENSE("GPL");
53 #define MAX_PARAM_LENGTH 256
54 #define MAX_PRINT_CHUNK 1000
56 static char config
[MAX_PARAM_LENGTH
];
57 module_param_string(netconsole
, config
, MAX_PARAM_LENGTH
, 0);
58 MODULE_PARM_DESC(netconsole
, " netconsole=[src-port]@[src-ip]/[dev],[tgt-port]@<tgt-ip>/[tgt-macaddr]");
60 static bool oops_only
= false;
61 module_param(oops_only
, bool, 0600);
62 MODULE_PARM_DESC(oops_only
, "Only log oops messages");
65 static int __init
option_setup(char *opt
)
67 strlcpy(config
, opt
, MAX_PARAM_LENGTH
);
70 __setup("netconsole=", option_setup
);
73 /* Linked list of all configured targets */
74 static LIST_HEAD(target_list
);
76 /* This needs to be a spinlock because write_msg() cannot sleep */
77 static DEFINE_SPINLOCK(target_list_lock
);
80 * struct netconsole_target - Represents a configured netconsole target.
81 * @list: Links this target into the target_list.
82 * @item: Links us into the configfs subsystem hierarchy.
83 * @enabled: On / off knob to enable / disable target.
84 * Visible from userspace (read-write).
85 * We maintain a strict 1:1 correspondence between this and
86 * whether the corresponding netpoll is active or inactive.
87 * Also, other parameters of a target may be modified at
88 * runtime only when it is disabled (enabled == 0).
89 * @np: The netpoll structure for this target.
90 * Contains the other userspace visible parameters:
91 * dev_name (read-write)
92 * local_port (read-write)
93 * remote_port (read-write)
94 * local_ip (read-write)
95 * remote_ip (read-write)
96 * local_mac (read-only)
97 * remote_mac (read-write)
99 struct netconsole_target
{
100 struct list_head list
;
101 #ifdef CONFIG_NETCONSOLE_DYNAMIC
102 struct config_item item
;
108 #ifdef CONFIG_NETCONSOLE_DYNAMIC
110 static struct configfs_subsystem netconsole_subsys
;
112 static int __init
dynamic_netconsole_init(void)
114 config_group_init(&netconsole_subsys
.su_group
);
115 mutex_init(&netconsole_subsys
.su_mutex
);
116 return configfs_register_subsystem(&netconsole_subsys
);
119 static void __exit
dynamic_netconsole_exit(void)
121 configfs_unregister_subsystem(&netconsole_subsys
);
125 * Targets that were created by parsing the boot/module option string
126 * do not exist in the configfs hierarchy (and have NULL names) and will
127 * never go away, so make these a no-op for them.
129 static void netconsole_target_get(struct netconsole_target
*nt
)
131 if (config_item_name(&nt
->item
))
132 config_item_get(&nt
->item
);
135 static void netconsole_target_put(struct netconsole_target
*nt
)
137 if (config_item_name(&nt
->item
))
138 config_item_put(&nt
->item
);
141 #else /* !CONFIG_NETCONSOLE_DYNAMIC */
143 static int __init
dynamic_netconsole_init(void)
148 static void __exit
dynamic_netconsole_exit(void)
153 * No danger of targets going away from under us when dynamic
154 * reconfigurability is off.
156 static void netconsole_target_get(struct netconsole_target
*nt
)
160 static void netconsole_target_put(struct netconsole_target
*nt
)
164 #endif /* CONFIG_NETCONSOLE_DYNAMIC */
166 /* Allocate new target (from boot/module param) and setup netpoll for it */
167 static struct netconsole_target
*alloc_param_target(char *target_config
)
170 struct netconsole_target
*nt
;
173 * Allocate and initialize with defaults.
174 * Note that these targets get their config_item fields zeroed-out.
176 nt
= kzalloc(sizeof(*nt
), GFP_KERNEL
);
180 nt
->np
.name
= "netconsole";
181 strlcpy(nt
->np
.dev_name
, "eth0", IFNAMSIZ
);
182 nt
->np
.local_port
= 6665;
183 nt
->np
.remote_port
= 6666;
184 memset(nt
->np
.remote_mac
, 0xff, ETH_ALEN
);
186 /* Parse parameters and setup netpoll */
187 err
= netpoll_parse_options(&nt
->np
, target_config
);
191 err
= netpoll_setup(&nt
->np
);
204 /* Cleanup netpoll for given target (from boot/module param) and free it */
205 static void free_param_target(struct netconsole_target
*nt
)
207 netpoll_cleanup(&nt
->np
);
211 #ifdef CONFIG_NETCONSOLE_DYNAMIC
214 * Our subsystem hierarchy is:
216 * /sys/kernel/config/netconsole/
231 struct netconsole_target_attr
{
232 struct configfs_attribute attr
;
233 ssize_t (*show
)(struct netconsole_target
*nt
,
235 ssize_t (*store
)(struct netconsole_target
*nt
,
240 static struct netconsole_target
*to_target(struct config_item
*item
)
243 container_of(item
, struct netconsole_target
, item
) :
248 * Attribute operations for netconsole_target.
251 static ssize_t
show_enabled(struct netconsole_target
*nt
, char *buf
)
253 return snprintf(buf
, PAGE_SIZE
, "%d\n", nt
->enabled
);
256 static ssize_t
show_dev_name(struct netconsole_target
*nt
, char *buf
)
258 return snprintf(buf
, PAGE_SIZE
, "%s\n", nt
->np
.dev_name
);
261 static ssize_t
show_local_port(struct netconsole_target
*nt
, char *buf
)
263 return snprintf(buf
, PAGE_SIZE
, "%d\n", nt
->np
.local_port
);
266 static ssize_t
show_remote_port(struct netconsole_target
*nt
, char *buf
)
268 return snprintf(buf
, PAGE_SIZE
, "%d\n", nt
->np
.remote_port
);
271 static ssize_t
show_local_ip(struct netconsole_target
*nt
, char *buf
)
274 return snprintf(buf
, PAGE_SIZE
, "%pI6c\n", &nt
->np
.local_ip
.in6
);
276 return snprintf(buf
, PAGE_SIZE
, "%pI4\n", &nt
->np
.local_ip
);
279 static ssize_t
show_remote_ip(struct netconsole_target
*nt
, char *buf
)
282 return snprintf(buf
, PAGE_SIZE
, "%pI6c\n", &nt
->np
.remote_ip
.in6
);
284 return snprintf(buf
, PAGE_SIZE
, "%pI4\n", &nt
->np
.remote_ip
);
287 static ssize_t
show_local_mac(struct netconsole_target
*nt
, char *buf
)
289 struct net_device
*dev
= nt
->np
.dev
;
290 static const u8 bcast
[ETH_ALEN
] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
292 return snprintf(buf
, PAGE_SIZE
, "%pM\n", dev
? dev
->dev_addr
: bcast
);
295 static ssize_t
show_remote_mac(struct netconsole_target
*nt
, char *buf
)
297 return snprintf(buf
, PAGE_SIZE
, "%pM\n", nt
->np
.remote_mac
);
301 * This one is special -- targets created through the configfs interface
302 * are not enabled (and the corresponding netpoll activated) by default.
303 * The user is expected to set the desired parameters first (which
304 * would enable him to dynamically add new netpoll targets for new
305 * network interfaces as and when they come up).
307 static ssize_t
store_enabled(struct netconsole_target
*nt
,
314 err
= kstrtoint(buf
, 10, &enabled
);
317 if (enabled
< 0 || enabled
> 1)
319 if (enabled
== nt
->enabled
) {
320 printk(KERN_INFO
"netconsole: network logging has already %s\n",
321 nt
->enabled
? "started" : "stopped");
325 if (enabled
) { /* 1 */
328 * Skip netpoll_parse_options() -- all the attributes are
329 * already configured via configfs. Just print them out.
331 netpoll_print_options(&nt
->np
);
333 err
= netpoll_setup(&nt
->np
);
337 printk(KERN_INFO
"netconsole: network logging started\n");
340 netpoll_cleanup(&nt
->np
);
343 nt
->enabled
= enabled
;
345 return strnlen(buf
, count
);
348 static ssize_t
store_dev_name(struct netconsole_target
*nt
,
355 printk(KERN_ERR
"netconsole: target (%s) is enabled, "
356 "disable to update parameters\n",
357 config_item_name(&nt
->item
));
361 strlcpy(nt
->np
.dev_name
, buf
, IFNAMSIZ
);
363 /* Get rid of possible trailing newline from echo(1) */
364 len
= strnlen(nt
->np
.dev_name
, IFNAMSIZ
);
365 if (nt
->np
.dev_name
[len
- 1] == '\n')
366 nt
->np
.dev_name
[len
- 1] = '\0';
368 return strnlen(buf
, count
);
371 static ssize_t
store_local_port(struct netconsole_target
*nt
,
378 printk(KERN_ERR
"netconsole: target (%s) is enabled, "
379 "disable to update parameters\n",
380 config_item_name(&nt
->item
));
384 rv
= kstrtou16(buf
, 10, &nt
->np
.local_port
);
387 return strnlen(buf
, count
);
390 static ssize_t
store_remote_port(struct netconsole_target
*nt
,
397 printk(KERN_ERR
"netconsole: target (%s) is enabled, "
398 "disable to update parameters\n",
399 config_item_name(&nt
->item
));
403 rv
= kstrtou16(buf
, 10, &nt
->np
.remote_port
);
406 return strnlen(buf
, count
);
409 static ssize_t
store_local_ip(struct netconsole_target
*nt
,
414 printk(KERN_ERR
"netconsole: target (%s) is enabled, "
415 "disable to update parameters\n",
416 config_item_name(&nt
->item
));
420 if (strnchr(buf
, count
, ':')) {
422 if (in6_pton(buf
, count
, nt
->np
.local_ip
.in6
.s6_addr
, -1, &end
) > 0) {
423 if (*end
&& *end
!= '\n') {
424 printk(KERN_ERR
"netconsole: invalid IPv6 address at: <%c>\n", *end
);
432 nt
->np
.local_ip
.ip
= in_aton(buf
);
437 return strnlen(buf
, count
);
440 static ssize_t
store_remote_ip(struct netconsole_target
*nt
,
445 printk(KERN_ERR
"netconsole: target (%s) is enabled, "
446 "disable to update parameters\n",
447 config_item_name(&nt
->item
));
451 if (strnchr(buf
, count
, ':')) {
453 if (in6_pton(buf
, count
, nt
->np
.remote_ip
.in6
.s6_addr
, -1, &end
) > 0) {
454 if (*end
&& *end
!= '\n') {
455 printk(KERN_ERR
"netconsole: invalid IPv6 address at: <%c>\n", *end
);
463 nt
->np
.remote_ip
.ip
= in_aton(buf
);
468 return strnlen(buf
, count
);
471 static ssize_t
store_remote_mac(struct netconsole_target
*nt
,
475 u8 remote_mac
[ETH_ALEN
];
478 printk(KERN_ERR
"netconsole: target (%s) is enabled, "
479 "disable to update parameters\n",
480 config_item_name(&nt
->item
));
484 if (!mac_pton(buf
, remote_mac
))
486 if (buf
[3 * ETH_ALEN
- 1] && buf
[3 * ETH_ALEN
- 1] != '\n')
488 memcpy(nt
->np
.remote_mac
, remote_mac
, ETH_ALEN
);
490 return strnlen(buf
, count
);
494 * Attribute definitions for netconsole_target.
497 #define NETCONSOLE_TARGET_ATTR_RO(_name) \
498 static struct netconsole_target_attr netconsole_target_##_name = \
499 __CONFIGFS_ATTR(_name, S_IRUGO, show_##_name, NULL)
501 #define NETCONSOLE_TARGET_ATTR_RW(_name) \
502 static struct netconsole_target_attr netconsole_target_##_name = \
503 __CONFIGFS_ATTR(_name, S_IRUGO | S_IWUSR, show_##_name, store_##_name)
505 NETCONSOLE_TARGET_ATTR_RW(enabled
);
506 NETCONSOLE_TARGET_ATTR_RW(dev_name
);
507 NETCONSOLE_TARGET_ATTR_RW(local_port
);
508 NETCONSOLE_TARGET_ATTR_RW(remote_port
);
509 NETCONSOLE_TARGET_ATTR_RW(local_ip
);
510 NETCONSOLE_TARGET_ATTR_RW(remote_ip
);
511 NETCONSOLE_TARGET_ATTR_RO(local_mac
);
512 NETCONSOLE_TARGET_ATTR_RW(remote_mac
);
514 static struct configfs_attribute
*netconsole_target_attrs
[] = {
515 &netconsole_target_enabled
.attr
,
516 &netconsole_target_dev_name
.attr
,
517 &netconsole_target_local_port
.attr
,
518 &netconsole_target_remote_port
.attr
,
519 &netconsole_target_local_ip
.attr
,
520 &netconsole_target_remote_ip
.attr
,
521 &netconsole_target_local_mac
.attr
,
522 &netconsole_target_remote_mac
.attr
,
527 * Item operations and type for netconsole_target.
530 static void netconsole_target_release(struct config_item
*item
)
532 kfree(to_target(item
));
535 static ssize_t
netconsole_target_attr_show(struct config_item
*item
,
536 struct configfs_attribute
*attr
,
539 ssize_t ret
= -EINVAL
;
540 struct netconsole_target
*nt
= to_target(item
);
541 struct netconsole_target_attr
*na
=
542 container_of(attr
, struct netconsole_target_attr
, attr
);
545 ret
= na
->show(nt
, buf
);
550 static ssize_t
netconsole_target_attr_store(struct config_item
*item
,
551 struct configfs_attribute
*attr
,
555 ssize_t ret
= -EINVAL
;
556 struct netconsole_target
*nt
= to_target(item
);
557 struct netconsole_target_attr
*na
=
558 container_of(attr
, struct netconsole_target_attr
, attr
);
561 ret
= na
->store(nt
, buf
, count
);
566 static struct configfs_item_operations netconsole_target_item_ops
= {
567 .release
= netconsole_target_release
,
568 .show_attribute
= netconsole_target_attr_show
,
569 .store_attribute
= netconsole_target_attr_store
,
572 static struct config_item_type netconsole_target_type
= {
573 .ct_attrs
= netconsole_target_attrs
,
574 .ct_item_ops
= &netconsole_target_item_ops
,
575 .ct_owner
= THIS_MODULE
,
579 * Group operations and type for netconsole_subsys.
582 static struct config_item
*make_netconsole_target(struct config_group
*group
,
586 struct netconsole_target
*nt
;
589 * Allocate and initialize with defaults.
590 * Target is disabled at creation (enabled == 0).
592 nt
= kzalloc(sizeof(*nt
), GFP_KERNEL
);
594 return ERR_PTR(-ENOMEM
);
596 nt
->np
.name
= "netconsole";
597 strlcpy(nt
->np
.dev_name
, "eth0", IFNAMSIZ
);
598 nt
->np
.local_port
= 6665;
599 nt
->np
.remote_port
= 6666;
600 memset(nt
->np
.remote_mac
, 0xff, ETH_ALEN
);
602 /* Initialize the config_item member */
603 config_item_init_type_name(&nt
->item
, name
, &netconsole_target_type
);
605 /* Adding, but it is disabled */
606 spin_lock_irqsave(&target_list_lock
, flags
);
607 list_add(&nt
->list
, &target_list
);
608 spin_unlock_irqrestore(&target_list_lock
, flags
);
613 static void drop_netconsole_target(struct config_group
*group
,
614 struct config_item
*item
)
617 struct netconsole_target
*nt
= to_target(item
);
619 spin_lock_irqsave(&target_list_lock
, flags
);
621 spin_unlock_irqrestore(&target_list_lock
, flags
);
624 * The target may have never been enabled, or was manually disabled
625 * before being removed so netpoll may have already been cleaned up.
628 netpoll_cleanup(&nt
->np
);
630 config_item_put(&nt
->item
);
633 static struct configfs_group_operations netconsole_subsys_group_ops
= {
634 .make_item
= make_netconsole_target
,
635 .drop_item
= drop_netconsole_target
,
638 static struct config_item_type netconsole_subsys_type
= {
639 .ct_group_ops
= &netconsole_subsys_group_ops
,
640 .ct_owner
= THIS_MODULE
,
643 /* The netconsole configfs subsystem */
644 static struct configfs_subsystem netconsole_subsys
= {
647 .ci_namebuf
= "netconsole",
648 .ci_type
= &netconsole_subsys_type
,
653 #endif /* CONFIG_NETCONSOLE_DYNAMIC */
655 /* Handle network interface device notifications */
656 static int netconsole_netdev_event(struct notifier_block
*this,
657 unsigned long event
, void *ptr
)
660 struct netconsole_target
*nt
;
661 struct net_device
*dev
= netdev_notifier_info_to_dev(ptr
);
662 bool stopped
= false;
664 if (!(event
== NETDEV_CHANGENAME
|| event
== NETDEV_UNREGISTER
||
665 event
== NETDEV_RELEASE
|| event
== NETDEV_JOIN
))
668 spin_lock_irqsave(&target_list_lock
, flags
);
670 list_for_each_entry(nt
, &target_list
, list
) {
671 netconsole_target_get(nt
);
672 if (nt
->np
.dev
== dev
) {
674 case NETDEV_CHANGENAME
:
675 strlcpy(nt
->np
.dev_name
, dev
->name
, IFNAMSIZ
);
679 case NETDEV_UNREGISTER
:
681 * rtnl_lock already held
682 * we might sleep in __netpoll_cleanup()
684 spin_unlock_irqrestore(&target_list_lock
, flags
);
685 __netpoll_cleanup(&nt
->np
);
686 spin_lock_irqsave(&target_list_lock
, flags
);
691 netconsole_target_put(nt
);
695 netconsole_target_put(nt
);
697 spin_unlock_irqrestore(&target_list_lock
, flags
);
699 printk(KERN_INFO
"netconsole: network logging stopped on "
700 "interface %s as it ", dev
->name
);
702 case NETDEV_UNREGISTER
:
703 printk(KERN_CONT
"unregistered\n");
706 printk(KERN_CONT
"released slaves\n");
709 printk(KERN_CONT
"is joining a master device\n");
718 static struct notifier_block netconsole_netdev_notifier
= {
719 .notifier_call
= netconsole_netdev_event
,
722 static void write_msg(struct console
*con
, const char *msg
, unsigned int len
)
726 struct netconsole_target
*nt
;
729 if (oops_only
&& !oops_in_progress
)
731 /* Avoid taking lock and disabling interrupts unnecessarily */
732 if (list_empty(&target_list
))
735 spin_lock_irqsave(&target_list_lock
, flags
);
736 list_for_each_entry(nt
, &target_list
, list
) {
737 netconsole_target_get(nt
);
738 if (nt
->enabled
&& netif_running(nt
->np
.dev
)) {
740 * We nest this inside the for-each-target loop above
741 * so that we're able to get as much logging out to
742 * at least one target if we die inside here, instead
743 * of unnecessarily keeping all targets in lock-step.
746 for (left
= len
; left
;) {
747 frag
= min(left
, MAX_PRINT_CHUNK
);
748 netpoll_send_udp(&nt
->np
, tmp
, frag
);
753 netconsole_target_put(nt
);
755 spin_unlock_irqrestore(&target_list_lock
, flags
);
758 static struct console netconsole
= {
760 .flags
= CON_ENABLED
,
764 static int __init
init_netconsole(void)
767 struct netconsole_target
*nt
, *tmp
;
770 char *input
= config
;
772 if (strnlen(input
, MAX_PARAM_LENGTH
)) {
773 while ((target_config
= strsep(&input
, ";"))) {
774 nt
= alloc_param_target(target_config
);
779 /* Dump existing printks when we register */
780 netconsole
.flags
|= CON_PRINTBUFFER
;
782 spin_lock_irqsave(&target_list_lock
, flags
);
783 list_add(&nt
->list
, &target_list
);
784 spin_unlock_irqrestore(&target_list_lock
, flags
);
788 err
= register_netdevice_notifier(&netconsole_netdev_notifier
);
792 err
= dynamic_netconsole_init();
796 register_console(&netconsole
);
797 printk(KERN_INFO
"netconsole: network logging started\n");
802 unregister_netdevice_notifier(&netconsole_netdev_notifier
);
805 printk(KERN_ERR
"netconsole: cleaning up\n");
808 * Remove all targets and destroy them (only targets created
809 * from the boot/module option exist here). Skipping the list
810 * lock is safe here, and netpoll_cleanup() will sleep.
812 list_for_each_entry_safe(nt
, tmp
, &target_list
, list
) {
814 free_param_target(nt
);
820 static void __exit
cleanup_netconsole(void)
822 struct netconsole_target
*nt
, *tmp
;
824 unregister_console(&netconsole
);
825 dynamic_netconsole_exit();
826 unregister_netdevice_notifier(&netconsole_netdev_notifier
);
829 * Targets created via configfs pin references on our module
830 * and would first be rmdir(2)'ed from userspace. We reach
831 * here only when they are already destroyed, and only those
832 * created from the boot/module option are left, so remove and
833 * destroy them. Skipping the list lock is safe here, and
834 * netpoll_cleanup() will sleep.
836 list_for_each_entry_safe(nt
, tmp
, &target_list
, list
) {
838 free_param_target(nt
);
843 * Use late_initcall to ensure netconsole is
844 * initialized after network device driver if built-in.
846 * late_initcall() and module_init() are identical if built as module.
848 late_initcall(init_netconsole
);
849 module_exit(cleanup_netconsole
);