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 ****************************************************************/
37 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
40 #include <linux/init.h>
41 #include <linux/module.h>
42 #include <linux/slab.h>
43 #include <linux/console.h>
44 #include <linux/moduleparam.h>
45 #include <linux/kernel.h>
46 #include <linux/string.h>
47 #include <linux/netpoll.h>
48 #include <linux/inet.h>
49 #include <linux/configfs.h>
50 #include <linux/etherdevice.h>
52 MODULE_AUTHOR("Maintainer: Matt Mackall <mpm@selenic.com>");
53 MODULE_DESCRIPTION("Console driver for network interfaces");
54 MODULE_LICENSE("GPL");
56 #define MAX_PARAM_LENGTH 256
57 #define MAX_PRINT_CHUNK 1000
59 static char config
[MAX_PARAM_LENGTH
];
60 module_param_string(netconsole
, config
, MAX_PARAM_LENGTH
, 0);
61 MODULE_PARM_DESC(netconsole
, " netconsole=[src-port]@[src-ip]/[dev],[tgt-port]@<tgt-ip>/[tgt-macaddr]");
63 static bool oops_only
= false;
64 module_param(oops_only
, bool, 0600);
65 MODULE_PARM_DESC(oops_only
, "Only log oops messages");
68 static int __init
option_setup(char *opt
)
70 strlcpy(config
, opt
, MAX_PARAM_LENGTH
);
73 __setup("netconsole=", option_setup
);
76 /* Linked list of all configured targets */
77 static LIST_HEAD(target_list
);
79 /* This needs to be a spinlock because write_msg() cannot sleep */
80 static DEFINE_SPINLOCK(target_list_lock
);
83 * struct netconsole_target - Represents a configured netconsole target.
84 * @list: Links this target into the target_list.
85 * @item: Links us into the configfs subsystem hierarchy.
86 * @enabled: On / off knob to enable / disable target.
87 * Visible from userspace (read-write).
88 * We maintain a strict 1:1 correspondence between this and
89 * whether the corresponding netpoll is active or inactive.
90 * Also, other parameters of a target may be modified at
91 * runtime only when it is disabled (enabled == 0).
92 * @np: The netpoll structure for this target.
93 * Contains the other userspace visible parameters:
94 * dev_name (read-write)
95 * local_port (read-write)
96 * remote_port (read-write)
97 * local_ip (read-write)
98 * remote_ip (read-write)
99 * local_mac (read-only)
100 * remote_mac (read-write)
102 struct netconsole_target
{
103 struct list_head list
;
104 #ifdef CONFIG_NETCONSOLE_DYNAMIC
105 struct config_item item
;
112 #ifdef CONFIG_NETCONSOLE_DYNAMIC
114 static struct configfs_subsystem netconsole_subsys
;
116 static int __init
dynamic_netconsole_init(void)
118 config_group_init(&netconsole_subsys
.su_group
);
119 mutex_init(&netconsole_subsys
.su_mutex
);
120 return configfs_register_subsystem(&netconsole_subsys
);
123 static void __exit
dynamic_netconsole_exit(void)
125 configfs_unregister_subsystem(&netconsole_subsys
);
129 * Targets that were created by parsing the boot/module option string
130 * do not exist in the configfs hierarchy (and have NULL names) and will
131 * never go away, so make these a no-op for them.
133 static void netconsole_target_get(struct netconsole_target
*nt
)
135 if (config_item_name(&nt
->item
))
136 config_item_get(&nt
->item
);
139 static void netconsole_target_put(struct netconsole_target
*nt
)
141 if (config_item_name(&nt
->item
))
142 config_item_put(&nt
->item
);
145 #else /* !CONFIG_NETCONSOLE_DYNAMIC */
147 static int __init
dynamic_netconsole_init(void)
152 static void __exit
dynamic_netconsole_exit(void)
157 * No danger of targets going away from under us when dynamic
158 * reconfigurability is off.
160 static void netconsole_target_get(struct netconsole_target
*nt
)
164 static void netconsole_target_put(struct netconsole_target
*nt
)
168 #endif /* CONFIG_NETCONSOLE_DYNAMIC */
170 /* Allocate new target (from boot/module param) and setup netpoll for it */
171 static struct netconsole_target
*alloc_param_target(char *target_config
)
174 struct netconsole_target
*nt
;
177 * Allocate and initialize with defaults.
178 * Note that these targets get their config_item fields zeroed-out.
180 nt
= kzalloc(sizeof(*nt
), GFP_KERNEL
);
184 nt
->np
.name
= "netconsole";
185 strlcpy(nt
->np
.dev_name
, "eth0", IFNAMSIZ
);
186 nt
->np
.local_port
= 6665;
187 nt
->np
.remote_port
= 6666;
188 mutex_init(&nt
->mutex
);
189 eth_broadcast_addr(nt
->np
.remote_mac
);
191 /* Parse parameters and setup netpoll */
192 err
= netpoll_parse_options(&nt
->np
, target_config
);
196 err
= netpoll_setup(&nt
->np
);
209 /* Cleanup netpoll for given target (from boot/module param) and free it */
210 static void free_param_target(struct netconsole_target
*nt
)
212 netpoll_cleanup(&nt
->np
);
216 #ifdef CONFIG_NETCONSOLE_DYNAMIC
219 * Our subsystem hierarchy is:
221 * /sys/kernel/config/netconsole/
236 struct netconsole_target_attr
{
237 struct configfs_attribute attr
;
238 ssize_t (*show
)(struct netconsole_target
*nt
,
240 ssize_t (*store
)(struct netconsole_target
*nt
,
245 static struct netconsole_target
*to_target(struct config_item
*item
)
248 container_of(item
, struct netconsole_target
, item
) :
253 * Attribute operations for netconsole_target.
256 static ssize_t
show_enabled(struct netconsole_target
*nt
, char *buf
)
258 return snprintf(buf
, PAGE_SIZE
, "%d\n", nt
->enabled
);
261 static ssize_t
show_dev_name(struct netconsole_target
*nt
, char *buf
)
263 return snprintf(buf
, PAGE_SIZE
, "%s\n", nt
->np
.dev_name
);
266 static ssize_t
show_local_port(struct netconsole_target
*nt
, char *buf
)
268 return snprintf(buf
, PAGE_SIZE
, "%d\n", nt
->np
.local_port
);
271 static ssize_t
show_remote_port(struct netconsole_target
*nt
, char *buf
)
273 return snprintf(buf
, PAGE_SIZE
, "%d\n", nt
->np
.remote_port
);
276 static ssize_t
show_local_ip(struct netconsole_target
*nt
, char *buf
)
279 return snprintf(buf
, PAGE_SIZE
, "%pI6c\n", &nt
->np
.local_ip
.in6
);
281 return snprintf(buf
, PAGE_SIZE
, "%pI4\n", &nt
->np
.local_ip
);
284 static ssize_t
show_remote_ip(struct netconsole_target
*nt
, char *buf
)
287 return snprintf(buf
, PAGE_SIZE
, "%pI6c\n", &nt
->np
.remote_ip
.in6
);
289 return snprintf(buf
, PAGE_SIZE
, "%pI4\n", &nt
->np
.remote_ip
);
292 static ssize_t
show_local_mac(struct netconsole_target
*nt
, char *buf
)
294 struct net_device
*dev
= nt
->np
.dev
;
295 static const u8 bcast
[ETH_ALEN
] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
297 return snprintf(buf
, PAGE_SIZE
, "%pM\n", dev
? dev
->dev_addr
: bcast
);
300 static ssize_t
show_remote_mac(struct netconsole_target
*nt
, char *buf
)
302 return snprintf(buf
, PAGE_SIZE
, "%pM\n", nt
->np
.remote_mac
);
306 * This one is special -- targets created through the configfs interface
307 * are not enabled (and the corresponding netpoll activated) by default.
308 * The user is expected to set the desired parameters first (which
309 * would enable him to dynamically add new netpoll targets for new
310 * network interfaces as and when they come up).
312 static ssize_t
store_enabled(struct netconsole_target
*nt
,
320 err
= kstrtoint(buf
, 10, &enabled
);
323 if (enabled
< 0 || enabled
> 1)
325 if (enabled
== nt
->enabled
) {
326 pr_info("network logging has already %s\n",
327 nt
->enabled
? "started" : "stopped");
331 if (enabled
) { /* 1 */
333 * Skip netpoll_parse_options() -- all the attributes are
334 * already configured via configfs. Just print them out.
336 netpoll_print_options(&nt
->np
);
338 err
= netpoll_setup(&nt
->np
);
342 pr_info("netconsole: network logging started\n");
344 /* We need to disable the netconsole before cleaning it up
345 * otherwise we might end up in write_msg() with
346 * nt->np.dev == NULL and nt->enabled == 1
348 spin_lock_irqsave(&target_list_lock
, flags
);
350 spin_unlock_irqrestore(&target_list_lock
, flags
);
351 netpoll_cleanup(&nt
->np
);
354 nt
->enabled
= enabled
;
356 return strnlen(buf
, count
);
359 static ssize_t
store_dev_name(struct netconsole_target
*nt
,
366 pr_err("target (%s) is enabled, disable to update parameters\n",
367 config_item_name(&nt
->item
));
371 strlcpy(nt
->np
.dev_name
, buf
, IFNAMSIZ
);
373 /* Get rid of possible trailing newline from echo(1) */
374 len
= strnlen(nt
->np
.dev_name
, IFNAMSIZ
);
375 if (nt
->np
.dev_name
[len
- 1] == '\n')
376 nt
->np
.dev_name
[len
- 1] = '\0';
378 return strnlen(buf
, count
);
381 static ssize_t
store_local_port(struct netconsole_target
*nt
,
388 pr_err("target (%s) is enabled, disable to update parameters\n",
389 config_item_name(&nt
->item
));
393 rv
= kstrtou16(buf
, 10, &nt
->np
.local_port
);
396 return strnlen(buf
, count
);
399 static ssize_t
store_remote_port(struct netconsole_target
*nt
,
406 pr_err("target (%s) is enabled, disable to update parameters\n",
407 config_item_name(&nt
->item
));
411 rv
= kstrtou16(buf
, 10, &nt
->np
.remote_port
);
414 return strnlen(buf
, count
);
417 static ssize_t
store_local_ip(struct netconsole_target
*nt
,
422 pr_err("target (%s) is enabled, disable to update parameters\n",
423 config_item_name(&nt
->item
));
427 if (strnchr(buf
, count
, ':')) {
429 if (in6_pton(buf
, count
, nt
->np
.local_ip
.in6
.s6_addr
, -1, &end
) > 0) {
430 if (*end
&& *end
!= '\n') {
431 pr_err("invalid IPv6 address at: <%c>\n", *end
);
439 nt
->np
.local_ip
.ip
= in_aton(buf
);
444 return strnlen(buf
, count
);
447 static ssize_t
store_remote_ip(struct netconsole_target
*nt
,
452 pr_err("target (%s) is enabled, disable to update parameters\n",
453 config_item_name(&nt
->item
));
457 if (strnchr(buf
, count
, ':')) {
459 if (in6_pton(buf
, count
, nt
->np
.remote_ip
.in6
.s6_addr
, -1, &end
) > 0) {
460 if (*end
&& *end
!= '\n') {
461 pr_err("invalid IPv6 address at: <%c>\n", *end
);
469 nt
->np
.remote_ip
.ip
= in_aton(buf
);
474 return strnlen(buf
, count
);
477 static ssize_t
store_remote_mac(struct netconsole_target
*nt
,
481 u8 remote_mac
[ETH_ALEN
];
484 pr_err("target (%s) is enabled, disable to update parameters\n",
485 config_item_name(&nt
->item
));
489 if (!mac_pton(buf
, remote_mac
))
491 if (buf
[3 * ETH_ALEN
- 1] && buf
[3 * ETH_ALEN
- 1] != '\n')
493 memcpy(nt
->np
.remote_mac
, remote_mac
, ETH_ALEN
);
495 return strnlen(buf
, count
);
499 * Attribute definitions for netconsole_target.
502 #define NETCONSOLE_TARGET_ATTR_RO(_name) \
503 static struct netconsole_target_attr netconsole_target_##_name = \
504 __CONFIGFS_ATTR(_name, S_IRUGO, show_##_name, NULL)
506 #define NETCONSOLE_TARGET_ATTR_RW(_name) \
507 static struct netconsole_target_attr netconsole_target_##_name = \
508 __CONFIGFS_ATTR(_name, S_IRUGO | S_IWUSR, show_##_name, store_##_name)
510 NETCONSOLE_TARGET_ATTR_RW(enabled
);
511 NETCONSOLE_TARGET_ATTR_RW(dev_name
);
512 NETCONSOLE_TARGET_ATTR_RW(local_port
);
513 NETCONSOLE_TARGET_ATTR_RW(remote_port
);
514 NETCONSOLE_TARGET_ATTR_RW(local_ip
);
515 NETCONSOLE_TARGET_ATTR_RW(remote_ip
);
516 NETCONSOLE_TARGET_ATTR_RO(local_mac
);
517 NETCONSOLE_TARGET_ATTR_RW(remote_mac
);
519 static struct configfs_attribute
*netconsole_target_attrs
[] = {
520 &netconsole_target_enabled
.attr
,
521 &netconsole_target_dev_name
.attr
,
522 &netconsole_target_local_port
.attr
,
523 &netconsole_target_remote_port
.attr
,
524 &netconsole_target_local_ip
.attr
,
525 &netconsole_target_remote_ip
.attr
,
526 &netconsole_target_local_mac
.attr
,
527 &netconsole_target_remote_mac
.attr
,
532 * Item operations and type for netconsole_target.
535 static void netconsole_target_release(struct config_item
*item
)
537 kfree(to_target(item
));
540 static ssize_t
netconsole_target_attr_show(struct config_item
*item
,
541 struct configfs_attribute
*attr
,
544 ssize_t ret
= -EINVAL
;
545 struct netconsole_target
*nt
= to_target(item
);
546 struct netconsole_target_attr
*na
=
547 container_of(attr
, struct netconsole_target_attr
, attr
);
550 ret
= na
->show(nt
, buf
);
555 static ssize_t
netconsole_target_attr_store(struct config_item
*item
,
556 struct configfs_attribute
*attr
,
560 ssize_t ret
= -EINVAL
;
561 struct netconsole_target
*nt
= to_target(item
);
562 struct netconsole_target_attr
*na
=
563 container_of(attr
, struct netconsole_target_attr
, attr
);
565 mutex_lock(&nt
->mutex
);
567 ret
= na
->store(nt
, buf
, count
);
568 mutex_unlock(&nt
->mutex
);
573 static struct configfs_item_operations netconsole_target_item_ops
= {
574 .release
= netconsole_target_release
,
575 .show_attribute
= netconsole_target_attr_show
,
576 .store_attribute
= netconsole_target_attr_store
,
579 static struct config_item_type netconsole_target_type
= {
580 .ct_attrs
= netconsole_target_attrs
,
581 .ct_item_ops
= &netconsole_target_item_ops
,
582 .ct_owner
= THIS_MODULE
,
586 * Group operations and type for netconsole_subsys.
589 static struct config_item
*make_netconsole_target(struct config_group
*group
,
593 struct netconsole_target
*nt
;
596 * Allocate and initialize with defaults.
597 * Target is disabled at creation (enabled == 0).
599 nt
= kzalloc(sizeof(*nt
), GFP_KERNEL
);
601 return ERR_PTR(-ENOMEM
);
603 nt
->np
.name
= "netconsole";
604 strlcpy(nt
->np
.dev_name
, "eth0", IFNAMSIZ
);
605 nt
->np
.local_port
= 6665;
606 nt
->np
.remote_port
= 6666;
607 mutex_init(&nt
->mutex
);
608 eth_broadcast_addr(nt
->np
.remote_mac
);
610 /* Initialize the config_item member */
611 config_item_init_type_name(&nt
->item
, name
, &netconsole_target_type
);
613 /* Adding, but it is disabled */
614 spin_lock_irqsave(&target_list_lock
, flags
);
615 list_add(&nt
->list
, &target_list
);
616 spin_unlock_irqrestore(&target_list_lock
, flags
);
621 static void drop_netconsole_target(struct config_group
*group
,
622 struct config_item
*item
)
625 struct netconsole_target
*nt
= to_target(item
);
627 spin_lock_irqsave(&target_list_lock
, flags
);
629 spin_unlock_irqrestore(&target_list_lock
, flags
);
632 * The target may have never been enabled, or was manually disabled
633 * before being removed so netpoll may have already been cleaned up.
636 netpoll_cleanup(&nt
->np
);
638 config_item_put(&nt
->item
);
641 static struct configfs_group_operations netconsole_subsys_group_ops
= {
642 .make_item
= make_netconsole_target
,
643 .drop_item
= drop_netconsole_target
,
646 static struct config_item_type netconsole_subsys_type
= {
647 .ct_group_ops
= &netconsole_subsys_group_ops
,
648 .ct_owner
= THIS_MODULE
,
651 /* The netconsole configfs subsystem */
652 static struct configfs_subsystem netconsole_subsys
= {
655 .ci_namebuf
= "netconsole",
656 .ci_type
= &netconsole_subsys_type
,
661 #endif /* CONFIG_NETCONSOLE_DYNAMIC */
663 /* Handle network interface device notifications */
664 static int netconsole_netdev_event(struct notifier_block
*this,
665 unsigned long event
, void *ptr
)
668 struct netconsole_target
*nt
;
669 struct net_device
*dev
= netdev_notifier_info_to_dev(ptr
);
670 bool stopped
= false;
672 if (!(event
== NETDEV_CHANGENAME
|| event
== NETDEV_UNREGISTER
||
673 event
== NETDEV_RELEASE
|| event
== NETDEV_JOIN
))
676 spin_lock_irqsave(&target_list_lock
, flags
);
678 list_for_each_entry(nt
, &target_list
, list
) {
679 netconsole_target_get(nt
);
680 if (nt
->np
.dev
== dev
) {
682 case NETDEV_CHANGENAME
:
683 strlcpy(nt
->np
.dev_name
, dev
->name
, IFNAMSIZ
);
687 case NETDEV_UNREGISTER
:
688 /* rtnl_lock already held
689 * we might sleep in __netpoll_cleanup()
691 spin_unlock_irqrestore(&target_list_lock
, flags
);
693 __netpoll_cleanup(&nt
->np
);
695 spin_lock_irqsave(&target_list_lock
, flags
);
700 netconsole_target_put(nt
);
704 netconsole_target_put(nt
);
706 spin_unlock_irqrestore(&target_list_lock
, flags
);
708 const char *msg
= "had an event";
710 case NETDEV_UNREGISTER
:
711 msg
= "unregistered";
714 msg
= "released slaves";
717 msg
= "is joining a master device";
720 pr_info("network logging stopped on interface %s as it %s\n",
728 static struct notifier_block netconsole_netdev_notifier
= {
729 .notifier_call
= netconsole_netdev_event
,
732 static void write_msg(struct console
*con
, const char *msg
, unsigned int len
)
736 struct netconsole_target
*nt
;
739 if (oops_only
&& !oops_in_progress
)
741 /* Avoid taking lock and disabling interrupts unnecessarily */
742 if (list_empty(&target_list
))
745 spin_lock_irqsave(&target_list_lock
, flags
);
746 list_for_each_entry(nt
, &target_list
, list
) {
747 netconsole_target_get(nt
);
748 if (nt
->enabled
&& netif_running(nt
->np
.dev
)) {
750 * We nest this inside the for-each-target loop above
751 * so that we're able to get as much logging out to
752 * at least one target if we die inside here, instead
753 * of unnecessarily keeping all targets in lock-step.
756 for (left
= len
; left
;) {
757 frag
= min(left
, MAX_PRINT_CHUNK
);
758 netpoll_send_udp(&nt
->np
, tmp
, frag
);
763 netconsole_target_put(nt
);
765 spin_unlock_irqrestore(&target_list_lock
, flags
);
768 static struct console netconsole
= {
770 .flags
= CON_ENABLED
,
774 static int __init
init_netconsole(void)
777 struct netconsole_target
*nt
, *tmp
;
780 char *input
= config
;
782 if (strnlen(input
, MAX_PARAM_LENGTH
)) {
783 while ((target_config
= strsep(&input
, ";"))) {
784 nt
= alloc_param_target(target_config
);
789 /* Dump existing printks when we register */
790 netconsole
.flags
|= CON_PRINTBUFFER
;
792 spin_lock_irqsave(&target_list_lock
, flags
);
793 list_add(&nt
->list
, &target_list
);
794 spin_unlock_irqrestore(&target_list_lock
, flags
);
798 err
= register_netdevice_notifier(&netconsole_netdev_notifier
);
802 err
= dynamic_netconsole_init();
806 register_console(&netconsole
);
807 pr_info("network logging started\n");
812 unregister_netdevice_notifier(&netconsole_netdev_notifier
);
815 pr_err("cleaning up\n");
818 * Remove all targets and destroy them (only targets created
819 * from the boot/module option exist here). Skipping the list
820 * lock is safe here, and netpoll_cleanup() will sleep.
822 list_for_each_entry_safe(nt
, tmp
, &target_list
, list
) {
824 free_param_target(nt
);
830 static void __exit
cleanup_netconsole(void)
832 struct netconsole_target
*nt
, *tmp
;
834 unregister_console(&netconsole
);
835 dynamic_netconsole_exit();
836 unregister_netdevice_notifier(&netconsole_netdev_notifier
);
839 * Targets created via configfs pin references on our module
840 * and would first be rmdir(2)'ed from userspace. We reach
841 * here only when they are already destroyed, and only those
842 * created from the boot/module option are left, so remove and
843 * destroy them. Skipping the list lock is safe here, and
844 * netpoll_cleanup() will sleep.
846 list_for_each_entry_safe(nt
, tmp
, &target_list
, list
) {
848 free_param_target(nt
);
853 * Use late_initcall to ensure netconsole is
854 * initialized after network device driver if built-in.
856 * late_initcall() and module_init() are identical if built as module.
858 late_initcall(init_netconsole
);
859 module_exit(cleanup_netconsole
);