Loading...
1/*
2 * linux/drivers/net/netconsole.c
3 *
4 * Copyright (C) 2001 Ingo Molnar <mingo@redhat.com>
5 *
6 * This file contains the implementation of an IRQ-safe, crash-safe
7 * kernel console implementation that outputs kernel messages to the
8 * network.
9 *
10 * Modification history:
11 *
12 * 2001-09-17 started by Ingo Molnar.
13 * 2003-08-11 2.6 port by Matt Mackall
14 * simplified options
15 * generic card hooks
16 * works non-modular
17 * 2003-09-07 rewritten with netpoll api
18 */
19
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)
24 * any later version.
25 *
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.
30 *
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.
34 *
35 ****************************************************************/
36
37#include <linux/mm.h>
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>
47
48MODULE_AUTHOR("Maintainer: Matt Mackall <mpm@selenic.com>");
49MODULE_DESCRIPTION("Console driver for network interfaces");
50MODULE_LICENSE("GPL");
51
52#define MAX_PARAM_LENGTH 256
53#define MAX_PRINT_CHUNK 1000
54
55static char config[MAX_PARAM_LENGTH];
56module_param_string(netconsole, config, MAX_PARAM_LENGTH, 0);
57MODULE_PARM_DESC(netconsole, " netconsole=[src-port]@[src-ip]/[dev],[tgt-port]@<tgt-ip>/[tgt-macaddr]");
58
59#ifndef MODULE
60static int __init option_setup(char *opt)
61{
62 strlcpy(config, opt, MAX_PARAM_LENGTH);
63 return 1;
64}
65__setup("netconsole=", option_setup);
66#endif /* MODULE */
67
68/* Linked list of all configured targets */
69static LIST_HEAD(target_list);
70
71/* This needs to be a spinlock because write_msg() cannot sleep */
72static DEFINE_SPINLOCK(target_list_lock);
73
74/**
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)
93 */
94struct netconsole_target {
95 struct list_head list;
96#ifdef CONFIG_NETCONSOLE_DYNAMIC
97 struct config_item item;
98#endif
99 int enabled;
100 struct netpoll np;
101};
102
103#ifdef CONFIG_NETCONSOLE_DYNAMIC
104
105static struct configfs_subsystem netconsole_subsys;
106
107static int __init dynamic_netconsole_init(void)
108{
109 config_group_init(&netconsole_subsys.su_group);
110 mutex_init(&netconsole_subsys.su_mutex);
111 return configfs_register_subsystem(&netconsole_subsys);
112}
113
114static void __exit dynamic_netconsole_exit(void)
115{
116 configfs_unregister_subsystem(&netconsole_subsys);
117}
118
119/*
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.
123 */
124static void netconsole_target_get(struct netconsole_target *nt)
125{
126 if (config_item_name(&nt->item))
127 config_item_get(&nt->item);
128}
129
130static void netconsole_target_put(struct netconsole_target *nt)
131{
132 if (config_item_name(&nt->item))
133 config_item_put(&nt->item);
134}
135
136#else /* !CONFIG_NETCONSOLE_DYNAMIC */
137
138static int __init dynamic_netconsole_init(void)
139{
140 return 0;
141}
142
143static void __exit dynamic_netconsole_exit(void)
144{
145}
146
147/*
148 * No danger of targets going away from under us when dynamic
149 * reconfigurability is off.
150 */
151static void netconsole_target_get(struct netconsole_target *nt)
152{
153}
154
155static void netconsole_target_put(struct netconsole_target *nt)
156{
157}
158
159#endif /* CONFIG_NETCONSOLE_DYNAMIC */
160
161/* Allocate new target (from boot/module param) and setup netpoll for it */
162static struct netconsole_target *alloc_param_target(char *target_config)
163{
164 int err = -ENOMEM;
165 struct netconsole_target *nt;
166
167 /*
168 * Allocate and initialize with defaults.
169 * Note that these targets get their config_item fields zeroed-out.
170 */
171 nt = kzalloc(sizeof(*nt), GFP_KERNEL);
172 if (!nt) {
173 printk(KERN_ERR "netconsole: failed to allocate memory\n");
174 goto fail;
175 }
176
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);
182
183 /* Parse parameters and setup netpoll */
184 err = netpoll_parse_options(&nt->np, target_config);
185 if (err)
186 goto fail;
187
188 err = netpoll_setup(&nt->np);
189 if (err)
190 goto fail;
191
192 nt->enabled = 1;
193
194 return nt;
195
196fail:
197 kfree(nt);
198 return ERR_PTR(err);
199}
200
201/* Cleanup netpoll for given target (from boot/module param) and free it */
202static void free_param_target(struct netconsole_target *nt)
203{
204 netpoll_cleanup(&nt->np);
205 kfree(nt);
206}
207
208#ifdef CONFIG_NETCONSOLE_DYNAMIC
209
210/*
211 * Our subsystem hierarchy is:
212 *
213 * /sys/kernel/config/netconsole/
214 * |
215 * <target>/
216 * | enabled
217 * | dev_name
218 * | local_port
219 * | remote_port
220 * | local_ip
221 * | remote_ip
222 * | local_mac
223 * | remote_mac
224 * |
225 * <target>/...
226 */
227
228struct netconsole_target_attr {
229 struct configfs_attribute attr;
230 ssize_t (*show)(struct netconsole_target *nt,
231 char *buf);
232 ssize_t (*store)(struct netconsole_target *nt,
233 const char *buf,
234 size_t count);
235};
236
237static struct netconsole_target *to_target(struct config_item *item)
238{
239 return item ?
240 container_of(item, struct netconsole_target, item) :
241 NULL;
242}
243
244/*
245 * Attribute operations for netconsole_target.
246 */
247
248static ssize_t show_enabled(struct netconsole_target *nt, char *buf)
249{
250 return snprintf(buf, PAGE_SIZE, "%d\n", nt->enabled);
251}
252
253static ssize_t show_dev_name(struct netconsole_target *nt, char *buf)
254{
255 return snprintf(buf, PAGE_SIZE, "%s\n", nt->np.dev_name);
256}
257
258static ssize_t show_local_port(struct netconsole_target *nt, char *buf)
259{
260 return snprintf(buf, PAGE_SIZE, "%d\n", nt->np.local_port);
261}
262
263static ssize_t show_remote_port(struct netconsole_target *nt, char *buf)
264{
265 return snprintf(buf, PAGE_SIZE, "%d\n", nt->np.remote_port);
266}
267
268static ssize_t show_local_ip(struct netconsole_target *nt, char *buf)
269{
270 return snprintf(buf, PAGE_SIZE, "%pI4\n", &nt->np.local_ip);
271}
272
273static ssize_t show_remote_ip(struct netconsole_target *nt, char *buf)
274{
275 return snprintf(buf, PAGE_SIZE, "%pI4\n", &nt->np.remote_ip);
276}
277
278static ssize_t show_local_mac(struct netconsole_target *nt, char *buf)
279{
280 struct net_device *dev = nt->np.dev;
281 static const u8 bcast[ETH_ALEN] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
282
283 return snprintf(buf, PAGE_SIZE, "%pM\n", dev ? dev->dev_addr : bcast);
284}
285
286static ssize_t show_remote_mac(struct netconsole_target *nt, char *buf)
287{
288 return snprintf(buf, PAGE_SIZE, "%pM\n", nt->np.remote_mac);
289}
290
291/*
292 * This one is special -- targets created through the configfs interface
293 * are not enabled (and the corresponding netpoll activated) by default.
294 * The user is expected to set the desired parameters first (which
295 * would enable him to dynamically add new netpoll targets for new
296 * network interfaces as and when they come up).
297 */
298static ssize_t store_enabled(struct netconsole_target *nt,
299 const char *buf,
300 size_t count)
301{
302 int enabled;
303 int err;
304
305 err = kstrtoint(buf, 10, &enabled);
306 if (err < 0)
307 return err;
308 if (enabled < 0 || enabled > 1)
309 return -EINVAL;
310 if (enabled == nt->enabled) {
311 printk(KERN_INFO "netconsole: network logging has already %s\n",
312 nt->enabled ? "started" : "stopped");
313 return -EINVAL;
314 }
315
316 if (enabled) { /* 1 */
317
318 /*
319 * Skip netpoll_parse_options() -- all the attributes are
320 * already configured via configfs. Just print them out.
321 */
322 netpoll_print_options(&nt->np);
323
324 err = netpoll_setup(&nt->np);
325 if (err)
326 return err;
327
328 printk(KERN_INFO "netconsole: network logging started\n");
329
330 } else { /* 0 */
331 netpoll_cleanup(&nt->np);
332 }
333
334 nt->enabled = enabled;
335
336 return strnlen(buf, count);
337}
338
339static ssize_t store_dev_name(struct netconsole_target *nt,
340 const char *buf,
341 size_t count)
342{
343 size_t len;
344
345 if (nt->enabled) {
346 printk(KERN_ERR "netconsole: target (%s) is enabled, "
347 "disable to update parameters\n",
348 config_item_name(&nt->item));
349 return -EINVAL;
350 }
351
352 strlcpy(nt->np.dev_name, buf, IFNAMSIZ);
353
354 /* Get rid of possible trailing newline from echo(1) */
355 len = strnlen(nt->np.dev_name, IFNAMSIZ);
356 if (nt->np.dev_name[len - 1] == '\n')
357 nt->np.dev_name[len - 1] = '\0';
358
359 return strnlen(buf, count);
360}
361
362static ssize_t store_local_port(struct netconsole_target *nt,
363 const char *buf,
364 size_t count)
365{
366 int rv;
367
368 if (nt->enabled) {
369 printk(KERN_ERR "netconsole: target (%s) is enabled, "
370 "disable to update parameters\n",
371 config_item_name(&nt->item));
372 return -EINVAL;
373 }
374
375 rv = kstrtou16(buf, 10, &nt->np.local_port);
376 if (rv < 0)
377 return rv;
378 return strnlen(buf, count);
379}
380
381static ssize_t store_remote_port(struct netconsole_target *nt,
382 const char *buf,
383 size_t count)
384{
385 int rv;
386
387 if (nt->enabled) {
388 printk(KERN_ERR "netconsole: target (%s) is enabled, "
389 "disable to update parameters\n",
390 config_item_name(&nt->item));
391 return -EINVAL;
392 }
393
394 rv = kstrtou16(buf, 10, &nt->np.remote_port);
395 if (rv < 0)
396 return rv;
397 return strnlen(buf, count);
398}
399
400static ssize_t store_local_ip(struct netconsole_target *nt,
401 const char *buf,
402 size_t count)
403{
404 if (nt->enabled) {
405 printk(KERN_ERR "netconsole: target (%s) is enabled, "
406 "disable to update parameters\n",
407 config_item_name(&nt->item));
408 return -EINVAL;
409 }
410
411 nt->np.local_ip = in_aton(buf);
412
413 return strnlen(buf, count);
414}
415
416static ssize_t store_remote_ip(struct netconsole_target *nt,
417 const char *buf,
418 size_t count)
419{
420 if (nt->enabled) {
421 printk(KERN_ERR "netconsole: target (%s) is enabled, "
422 "disable to update parameters\n",
423 config_item_name(&nt->item));
424 return -EINVAL;
425 }
426
427 nt->np.remote_ip = in_aton(buf);
428
429 return strnlen(buf, count);
430}
431
432static ssize_t store_remote_mac(struct netconsole_target *nt,
433 const char *buf,
434 size_t count)
435{
436 u8 remote_mac[ETH_ALEN];
437
438 if (nt->enabled) {
439 printk(KERN_ERR "netconsole: target (%s) is enabled, "
440 "disable to update parameters\n",
441 config_item_name(&nt->item));
442 return -EINVAL;
443 }
444
445 if (!mac_pton(buf, remote_mac))
446 return -EINVAL;
447 if (buf[3 * ETH_ALEN - 1] && buf[3 * ETH_ALEN - 1] != '\n')
448 return -EINVAL;
449 memcpy(nt->np.remote_mac, remote_mac, ETH_ALEN);
450
451 return strnlen(buf, count);
452}
453
454/*
455 * Attribute definitions for netconsole_target.
456 */
457
458#define NETCONSOLE_TARGET_ATTR_RO(_name) \
459static struct netconsole_target_attr netconsole_target_##_name = \
460 __CONFIGFS_ATTR(_name, S_IRUGO, show_##_name, NULL)
461
462#define NETCONSOLE_TARGET_ATTR_RW(_name) \
463static struct netconsole_target_attr netconsole_target_##_name = \
464 __CONFIGFS_ATTR(_name, S_IRUGO | S_IWUSR, show_##_name, store_##_name)
465
466NETCONSOLE_TARGET_ATTR_RW(enabled);
467NETCONSOLE_TARGET_ATTR_RW(dev_name);
468NETCONSOLE_TARGET_ATTR_RW(local_port);
469NETCONSOLE_TARGET_ATTR_RW(remote_port);
470NETCONSOLE_TARGET_ATTR_RW(local_ip);
471NETCONSOLE_TARGET_ATTR_RW(remote_ip);
472NETCONSOLE_TARGET_ATTR_RO(local_mac);
473NETCONSOLE_TARGET_ATTR_RW(remote_mac);
474
475static struct configfs_attribute *netconsole_target_attrs[] = {
476 &netconsole_target_enabled.attr,
477 &netconsole_target_dev_name.attr,
478 &netconsole_target_local_port.attr,
479 &netconsole_target_remote_port.attr,
480 &netconsole_target_local_ip.attr,
481 &netconsole_target_remote_ip.attr,
482 &netconsole_target_local_mac.attr,
483 &netconsole_target_remote_mac.attr,
484 NULL,
485};
486
487/*
488 * Item operations and type for netconsole_target.
489 */
490
491static void netconsole_target_release(struct config_item *item)
492{
493 kfree(to_target(item));
494}
495
496static ssize_t netconsole_target_attr_show(struct config_item *item,
497 struct configfs_attribute *attr,
498 char *buf)
499{
500 ssize_t ret = -EINVAL;
501 struct netconsole_target *nt = to_target(item);
502 struct netconsole_target_attr *na =
503 container_of(attr, struct netconsole_target_attr, attr);
504
505 if (na->show)
506 ret = na->show(nt, buf);
507
508 return ret;
509}
510
511static ssize_t netconsole_target_attr_store(struct config_item *item,
512 struct configfs_attribute *attr,
513 const char *buf,
514 size_t count)
515{
516 ssize_t ret = -EINVAL;
517 struct netconsole_target *nt = to_target(item);
518 struct netconsole_target_attr *na =
519 container_of(attr, struct netconsole_target_attr, attr);
520
521 if (na->store)
522 ret = na->store(nt, buf, count);
523
524 return ret;
525}
526
527static struct configfs_item_operations netconsole_target_item_ops = {
528 .release = netconsole_target_release,
529 .show_attribute = netconsole_target_attr_show,
530 .store_attribute = netconsole_target_attr_store,
531};
532
533static struct config_item_type netconsole_target_type = {
534 .ct_attrs = netconsole_target_attrs,
535 .ct_item_ops = &netconsole_target_item_ops,
536 .ct_owner = THIS_MODULE,
537};
538
539/*
540 * Group operations and type for netconsole_subsys.
541 */
542
543static struct config_item *make_netconsole_target(struct config_group *group,
544 const char *name)
545{
546 unsigned long flags;
547 struct netconsole_target *nt;
548
549 /*
550 * Allocate and initialize with defaults.
551 * Target is disabled at creation (enabled == 0).
552 */
553 nt = kzalloc(sizeof(*nt), GFP_KERNEL);
554 if (!nt) {
555 printk(KERN_ERR "netconsole: failed to allocate memory\n");
556 return ERR_PTR(-ENOMEM);
557 }
558
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);
564
565 /* Initialize the config_item member */
566 config_item_init_type_name(&nt->item, name, &netconsole_target_type);
567
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);
572
573 return &nt->item;
574}
575
576static void drop_netconsole_target(struct config_group *group,
577 struct config_item *item)
578{
579 unsigned long flags;
580 struct netconsole_target *nt = to_target(item);
581
582 spin_lock_irqsave(&target_list_lock, flags);
583 list_del(&nt->list);
584 spin_unlock_irqrestore(&target_list_lock, flags);
585
586 /*
587 * The target may have never been enabled, or was manually disabled
588 * before being removed so netpoll may have already been cleaned up.
589 */
590 if (nt->enabled)
591 netpoll_cleanup(&nt->np);
592
593 config_item_put(&nt->item);
594}
595
596static struct configfs_group_operations netconsole_subsys_group_ops = {
597 .make_item = make_netconsole_target,
598 .drop_item = drop_netconsole_target,
599};
600
601static struct config_item_type netconsole_subsys_type = {
602 .ct_group_ops = &netconsole_subsys_group_ops,
603 .ct_owner = THIS_MODULE,
604};
605
606/* The netconsole configfs subsystem */
607static struct configfs_subsystem netconsole_subsys = {
608 .su_group = {
609 .cg_item = {
610 .ci_namebuf = "netconsole",
611 .ci_type = &netconsole_subsys_type,
612 },
613 },
614};
615
616#endif /* CONFIG_NETCONSOLE_DYNAMIC */
617
618/* Handle network interface device notifications */
619static int netconsole_netdev_event(struct notifier_block *this,
620 unsigned long event,
621 void *ptr)
622{
623 unsigned long flags;
624 struct netconsole_target *nt;
625 struct net_device *dev = ptr;
626 bool stopped = false;
627
628 if (!(event == NETDEV_CHANGENAME || event == NETDEV_UNREGISTER ||
629 event == NETDEV_RELEASE || event == NETDEV_JOIN))
630 goto done;
631
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) {
636 switch (event) {
637 case NETDEV_CHANGENAME:
638 strlcpy(nt->np.dev_name, dev->name, IFNAMSIZ);
639 break;
640 case NETDEV_RELEASE:
641 case NETDEV_JOIN:
642 case NETDEV_UNREGISTER:
643 /*
644 * rtnl_lock already held
645 */
646 if (nt->np.dev) {
647 spin_unlock_irqrestore(
648 &target_list_lock,
649 flags);
650 __netpoll_cleanup(&nt->np);
651 spin_lock_irqsave(&target_list_lock,
652 flags);
653 dev_put(nt->np.dev);
654 nt->np.dev = NULL;
655 netconsole_target_put(nt);
656 }
657 nt->enabled = 0;
658 stopped = true;
659 break;
660 }
661 }
662 netconsole_target_put(nt);
663 }
664 spin_unlock_irqrestore(&target_list_lock, flags);
665 if (stopped) {
666 printk(KERN_INFO "netconsole: network logging stopped on "
667 "interface %s as it ", dev->name);
668 switch (event) {
669 case NETDEV_UNREGISTER:
670 printk(KERN_CONT "unregistered\n");
671 break;
672 case NETDEV_RELEASE:
673 printk(KERN_CONT "released slaves\n");
674 break;
675 case NETDEV_JOIN:
676 printk(KERN_CONT "is joining a master device\n");
677 break;
678 }
679 }
680
681done:
682 return NOTIFY_DONE;
683}
684
685static struct notifier_block netconsole_netdev_notifier = {
686 .notifier_call = netconsole_netdev_event,
687};
688
689static void write_msg(struct console *con, const char *msg, unsigned int len)
690{
691 int frag, left;
692 unsigned long flags;
693 struct netconsole_target *nt;
694 const char *tmp;
695
696 /* Avoid taking lock and disabling interrupts unnecessarily */
697 if (list_empty(&target_list))
698 return;
699
700 spin_lock_irqsave(&target_list_lock, flags);
701 list_for_each_entry(nt, &target_list, list) {
702 netconsole_target_get(nt);
703 if (nt->enabled && netif_running(nt->np.dev)) {
704 /*
705 * We nest this inside the for-each-target loop above
706 * so that we're able to get as much logging out to
707 * at least one target if we die inside here, instead
708 * of unnecessarily keeping all targets in lock-step.
709 */
710 tmp = msg;
711 for (left = len; left;) {
712 frag = min(left, MAX_PRINT_CHUNK);
713 netpoll_send_udp(&nt->np, tmp, frag);
714 tmp += frag;
715 left -= frag;
716 }
717 }
718 netconsole_target_put(nt);
719 }
720 spin_unlock_irqrestore(&target_list_lock, flags);
721}
722
723static struct console netconsole = {
724 .name = "netcon",
725 .flags = CON_ENABLED,
726 .write = write_msg,
727};
728
729static int __init init_netconsole(void)
730{
731 int err;
732 struct netconsole_target *nt, *tmp;
733 unsigned long flags;
734 char *target_config;
735 char *input = config;
736
737 if (strnlen(input, MAX_PARAM_LENGTH)) {
738 while ((target_config = strsep(&input, ";"))) {
739 nt = alloc_param_target(target_config);
740 if (IS_ERR(nt)) {
741 err = PTR_ERR(nt);
742 goto fail;
743 }
744 /* Dump existing printks when we register */
745 netconsole.flags |= CON_PRINTBUFFER;
746
747 spin_lock_irqsave(&target_list_lock, flags);
748 list_add(&nt->list, &target_list);
749 spin_unlock_irqrestore(&target_list_lock, flags);
750 }
751 }
752
753 err = register_netdevice_notifier(&netconsole_netdev_notifier);
754 if (err)
755 goto fail;
756
757 err = dynamic_netconsole_init();
758 if (err)
759 goto undonotifier;
760
761 register_console(&netconsole);
762 printk(KERN_INFO "netconsole: network logging started\n");
763
764 return err;
765
766undonotifier:
767 unregister_netdevice_notifier(&netconsole_netdev_notifier);
768
769fail:
770 printk(KERN_ERR "netconsole: cleaning up\n");
771
772 /*
773 * Remove all targets and destroy them (only targets created
774 * from the boot/module option exist here). Skipping the list
775 * lock is safe here, and netpoll_cleanup() will sleep.
776 */
777 list_for_each_entry_safe(nt, tmp, &target_list, list) {
778 list_del(&nt->list);
779 free_param_target(nt);
780 }
781
782 return err;
783}
784
785static void __exit cleanup_netconsole(void)
786{
787 struct netconsole_target *nt, *tmp;
788
789 unregister_console(&netconsole);
790 dynamic_netconsole_exit();
791 unregister_netdevice_notifier(&netconsole_netdev_notifier);
792
793 /*
794 * Targets created via configfs pin references on our module
795 * and would first be rmdir(2)'ed from userspace. We reach
796 * here only when they are already destroyed, and only those
797 * created from the boot/module option are left, so remove and
798 * destroy them. Skipping the list lock is safe here, and
799 * netpoll_cleanup() will sleep.
800 */
801 list_for_each_entry_safe(nt, tmp, &target_list, list) {
802 list_del(&nt->list);
803 free_param_target(nt);
804 }
805}
806
807/*
808 * Use late_initcall to ensure netconsole is
809 * initialized after network device driver if built-in.
810 *
811 * late_initcall() and module_init() are identical if built as module.
812 */
813late_initcall(init_netconsole);
814module_exit(cleanup_netconsole);
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * linux/drivers/net/netconsole.c
4 *
5 * Copyright (C) 2001 Ingo Molnar <mingo@redhat.com>
6 *
7 * This file contains the implementation of an IRQ-safe, crash-safe
8 * kernel console implementation that outputs kernel messages to the
9 * network.
10 *
11 * Modification history:
12 *
13 * 2001-09-17 started by Ingo Molnar.
14 * 2003-08-11 2.6 port by Matt Mackall
15 * simplified options
16 * generic card hooks
17 * works non-modular
18 * 2003-09-07 rewritten with netpoll api
19 */
20
21/****************************************************************
22 *
23 ****************************************************************/
24
25#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
26
27#include <linux/mm.h>
28#include <linux/init.h>
29#include <linux/module.h>
30#include <linux/slab.h>
31#include <linux/console.h>
32#include <linux/moduleparam.h>
33#include <linux/kernel.h>
34#include <linux/string.h>
35#include <linux/netpoll.h>
36#include <linux/inet.h>
37#include <linux/configfs.h>
38#include <linux/etherdevice.h>
39
40MODULE_AUTHOR("Maintainer: Matt Mackall <mpm@selenic.com>");
41MODULE_DESCRIPTION("Console driver for network interfaces");
42MODULE_LICENSE("GPL");
43
44#define MAX_PARAM_LENGTH 256
45#define MAX_PRINT_CHUNK 1000
46
47static char config[MAX_PARAM_LENGTH];
48module_param_string(netconsole, config, MAX_PARAM_LENGTH, 0);
49MODULE_PARM_DESC(netconsole, " netconsole=[src-port]@[src-ip]/[dev],[tgt-port]@<tgt-ip>/[tgt-macaddr]");
50
51static bool oops_only = false;
52module_param(oops_only, bool, 0600);
53MODULE_PARM_DESC(oops_only, "Only log oops messages");
54
55#ifndef MODULE
56static int __init option_setup(char *opt)
57{
58 strlcpy(config, opt, MAX_PARAM_LENGTH);
59 return 1;
60}
61__setup("netconsole=", option_setup);
62#endif /* MODULE */
63
64/* Linked list of all configured targets */
65static LIST_HEAD(target_list);
66
67/* This needs to be a spinlock because write_msg() cannot sleep */
68static DEFINE_SPINLOCK(target_list_lock);
69
70/*
71 * Console driver for extended netconsoles. Registered on the first use to
72 * avoid unnecessarily enabling ext message formatting.
73 */
74static struct console netconsole_ext;
75
76/**
77 * struct netconsole_target - Represents a configured netconsole target.
78 * @list: Links this target into the target_list.
79 * @item: Links us into the configfs subsystem hierarchy.
80 * @enabled: On / off knob to enable / disable target.
81 * Visible from userspace (read-write).
82 * We maintain a strict 1:1 correspondence between this and
83 * whether the corresponding netpoll is active or inactive.
84 * Also, other parameters of a target may be modified at
85 * runtime only when it is disabled (enabled == 0).
86 * @np: The netpoll structure for this target.
87 * Contains the other userspace visible parameters:
88 * dev_name (read-write)
89 * local_port (read-write)
90 * remote_port (read-write)
91 * local_ip (read-write)
92 * remote_ip (read-write)
93 * local_mac (read-only)
94 * remote_mac (read-write)
95 */
96struct netconsole_target {
97 struct list_head list;
98#ifdef CONFIG_NETCONSOLE_DYNAMIC
99 struct config_item item;
100#endif
101 bool enabled;
102 bool extended;
103 struct netpoll np;
104};
105
106#ifdef CONFIG_NETCONSOLE_DYNAMIC
107
108static struct configfs_subsystem netconsole_subsys;
109static DEFINE_MUTEX(dynamic_netconsole_mutex);
110
111static int __init dynamic_netconsole_init(void)
112{
113 config_group_init(&netconsole_subsys.su_group);
114 mutex_init(&netconsole_subsys.su_mutex);
115 return configfs_register_subsystem(&netconsole_subsys);
116}
117
118static void __exit dynamic_netconsole_exit(void)
119{
120 configfs_unregister_subsystem(&netconsole_subsys);
121}
122
123/*
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.
127 */
128static void netconsole_target_get(struct netconsole_target *nt)
129{
130 if (config_item_name(&nt->item))
131 config_item_get(&nt->item);
132}
133
134static void netconsole_target_put(struct netconsole_target *nt)
135{
136 if (config_item_name(&nt->item))
137 config_item_put(&nt->item);
138}
139
140#else /* !CONFIG_NETCONSOLE_DYNAMIC */
141
142static int __init dynamic_netconsole_init(void)
143{
144 return 0;
145}
146
147static void __exit dynamic_netconsole_exit(void)
148{
149}
150
151/*
152 * No danger of targets going away from under us when dynamic
153 * reconfigurability is off.
154 */
155static void netconsole_target_get(struct netconsole_target *nt)
156{
157}
158
159static void netconsole_target_put(struct netconsole_target *nt)
160{
161}
162
163#endif /* CONFIG_NETCONSOLE_DYNAMIC */
164
165/* Allocate new target (from boot/module param) and setup netpoll for it */
166static struct netconsole_target *alloc_param_target(char *target_config)
167{
168 int err = -ENOMEM;
169 struct netconsole_target *nt;
170
171 /*
172 * Allocate and initialize with defaults.
173 * Note that these targets get their config_item fields zeroed-out.
174 */
175 nt = kzalloc(sizeof(*nt), GFP_KERNEL);
176 if (!nt)
177 goto fail;
178
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 eth_broadcast_addr(nt->np.remote_mac);
184
185 if (*target_config == '+') {
186 nt->extended = true;
187 target_config++;
188 }
189
190 /* Parse parameters and setup netpoll */
191 err = netpoll_parse_options(&nt->np, target_config);
192 if (err)
193 goto fail;
194
195 err = netpoll_setup(&nt->np);
196 if (err)
197 goto fail;
198
199 nt->enabled = true;
200
201 return nt;
202
203fail:
204 kfree(nt);
205 return ERR_PTR(err);
206}
207
208/* Cleanup netpoll for given target (from boot/module param) and free it */
209static void free_param_target(struct netconsole_target *nt)
210{
211 netpoll_cleanup(&nt->np);
212 kfree(nt);
213}
214
215#ifdef CONFIG_NETCONSOLE_DYNAMIC
216
217/*
218 * Our subsystem hierarchy is:
219 *
220 * /sys/kernel/config/netconsole/
221 * |
222 * <target>/
223 * | enabled
224 * | dev_name
225 * | local_port
226 * | remote_port
227 * | local_ip
228 * | remote_ip
229 * | local_mac
230 * | remote_mac
231 * |
232 * <target>/...
233 */
234
235static struct netconsole_target *to_target(struct config_item *item)
236{
237 return item ?
238 container_of(item, struct netconsole_target, item) :
239 NULL;
240}
241
242/*
243 * Attribute operations for netconsole_target.
244 */
245
246static ssize_t enabled_show(struct config_item *item, char *buf)
247{
248 return snprintf(buf, PAGE_SIZE, "%d\n", to_target(item)->enabled);
249}
250
251static ssize_t extended_show(struct config_item *item, char *buf)
252{
253 return snprintf(buf, PAGE_SIZE, "%d\n", to_target(item)->extended);
254}
255
256static ssize_t dev_name_show(struct config_item *item, char *buf)
257{
258 return snprintf(buf, PAGE_SIZE, "%s\n", to_target(item)->np.dev_name);
259}
260
261static ssize_t local_port_show(struct config_item *item, char *buf)
262{
263 return snprintf(buf, PAGE_SIZE, "%d\n", to_target(item)->np.local_port);
264}
265
266static ssize_t remote_port_show(struct config_item *item, char *buf)
267{
268 return snprintf(buf, PAGE_SIZE, "%d\n", to_target(item)->np.remote_port);
269}
270
271static ssize_t local_ip_show(struct config_item *item, char *buf)
272{
273 struct netconsole_target *nt = to_target(item);
274
275 if (nt->np.ipv6)
276 return snprintf(buf, PAGE_SIZE, "%pI6c\n", &nt->np.local_ip.in6);
277 else
278 return snprintf(buf, PAGE_SIZE, "%pI4\n", &nt->np.local_ip);
279}
280
281static ssize_t remote_ip_show(struct config_item *item, char *buf)
282{
283 struct netconsole_target *nt = to_target(item);
284
285 if (nt->np.ipv6)
286 return snprintf(buf, PAGE_SIZE, "%pI6c\n", &nt->np.remote_ip.in6);
287 else
288 return snprintf(buf, PAGE_SIZE, "%pI4\n", &nt->np.remote_ip);
289}
290
291static ssize_t local_mac_show(struct config_item *item, char *buf)
292{
293 struct net_device *dev = to_target(item)->np.dev;
294 static const u8 bcast[ETH_ALEN] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
295
296 return snprintf(buf, PAGE_SIZE, "%pM\n", dev ? dev->dev_addr : bcast);
297}
298
299static ssize_t remote_mac_show(struct config_item *item, char *buf)
300{
301 return snprintf(buf, PAGE_SIZE, "%pM\n", to_target(item)->np.remote_mac);
302}
303
304/*
305 * This one is special -- targets created through the configfs interface
306 * are not enabled (and the corresponding netpoll activated) by default.
307 * The user is expected to set the desired parameters first (which
308 * would enable him to dynamically add new netpoll targets for new
309 * network interfaces as and when they come up).
310 */
311static ssize_t enabled_store(struct config_item *item,
312 const char *buf, size_t count)
313{
314 struct netconsole_target *nt = to_target(item);
315 unsigned long flags;
316 int enabled;
317 int err;
318
319 mutex_lock(&dynamic_netconsole_mutex);
320 err = kstrtoint(buf, 10, &enabled);
321 if (err < 0)
322 goto out_unlock;
323
324 err = -EINVAL;
325 if (enabled < 0 || enabled > 1)
326 goto out_unlock;
327 if ((bool)enabled == nt->enabled) {
328 pr_info("network logging has already %s\n",
329 nt->enabled ? "started" : "stopped");
330 goto out_unlock;
331 }
332
333 if (enabled) { /* true */
334 if (nt->extended && !(netconsole_ext.flags & CON_ENABLED)) {
335 netconsole_ext.flags |= CON_ENABLED;
336 register_console(&netconsole_ext);
337 }
338
339 /*
340 * Skip netpoll_parse_options() -- all the attributes are
341 * already configured via configfs. Just print them out.
342 */
343 netpoll_print_options(&nt->np);
344
345 err = netpoll_setup(&nt->np);
346 if (err)
347 goto out_unlock;
348
349 pr_info("network logging started\n");
350 } else { /* false */
351 /* We need to disable the netconsole before cleaning it up
352 * otherwise we might end up in write_msg() with
353 * nt->np.dev == NULL and nt->enabled == true
354 */
355 spin_lock_irqsave(&target_list_lock, flags);
356 nt->enabled = false;
357 spin_unlock_irqrestore(&target_list_lock, flags);
358 netpoll_cleanup(&nt->np);
359 }
360
361 nt->enabled = enabled;
362
363 mutex_unlock(&dynamic_netconsole_mutex);
364 return strnlen(buf, count);
365out_unlock:
366 mutex_unlock(&dynamic_netconsole_mutex);
367 return err;
368}
369
370static ssize_t extended_store(struct config_item *item, const char *buf,
371 size_t count)
372{
373 struct netconsole_target *nt = to_target(item);
374 int extended;
375 int err;
376
377 mutex_lock(&dynamic_netconsole_mutex);
378 if (nt->enabled) {
379 pr_err("target (%s) is enabled, disable to update parameters\n",
380 config_item_name(&nt->item));
381 err = -EINVAL;
382 goto out_unlock;
383 }
384
385 err = kstrtoint(buf, 10, &extended);
386 if (err < 0)
387 goto out_unlock;
388 if (extended < 0 || extended > 1) {
389 err = -EINVAL;
390 goto out_unlock;
391 }
392
393 nt->extended = extended;
394
395 mutex_unlock(&dynamic_netconsole_mutex);
396 return strnlen(buf, count);
397out_unlock:
398 mutex_unlock(&dynamic_netconsole_mutex);
399 return err;
400}
401
402static ssize_t dev_name_store(struct config_item *item, const char *buf,
403 size_t count)
404{
405 struct netconsole_target *nt = to_target(item);
406 size_t len;
407
408 mutex_lock(&dynamic_netconsole_mutex);
409 if (nt->enabled) {
410 pr_err("target (%s) is enabled, disable to update parameters\n",
411 config_item_name(&nt->item));
412 mutex_unlock(&dynamic_netconsole_mutex);
413 return -EINVAL;
414 }
415
416 strlcpy(nt->np.dev_name, buf, IFNAMSIZ);
417
418 /* Get rid of possible trailing newline from echo(1) */
419 len = strnlen(nt->np.dev_name, IFNAMSIZ);
420 if (nt->np.dev_name[len - 1] == '\n')
421 nt->np.dev_name[len - 1] = '\0';
422
423 mutex_unlock(&dynamic_netconsole_mutex);
424 return strnlen(buf, count);
425}
426
427static ssize_t local_port_store(struct config_item *item, const char *buf,
428 size_t count)
429{
430 struct netconsole_target *nt = to_target(item);
431 int rv = -EINVAL;
432
433 mutex_lock(&dynamic_netconsole_mutex);
434 if (nt->enabled) {
435 pr_err("target (%s) is enabled, disable to update parameters\n",
436 config_item_name(&nt->item));
437 goto out_unlock;
438 }
439
440 rv = kstrtou16(buf, 10, &nt->np.local_port);
441 if (rv < 0)
442 goto out_unlock;
443 mutex_unlock(&dynamic_netconsole_mutex);
444 return strnlen(buf, count);
445out_unlock:
446 mutex_unlock(&dynamic_netconsole_mutex);
447 return rv;
448}
449
450static ssize_t remote_port_store(struct config_item *item,
451 const char *buf, size_t count)
452{
453 struct netconsole_target *nt = to_target(item);
454 int rv = -EINVAL;
455
456 mutex_lock(&dynamic_netconsole_mutex);
457 if (nt->enabled) {
458 pr_err("target (%s) is enabled, disable to update parameters\n",
459 config_item_name(&nt->item));
460 goto out_unlock;
461 }
462
463 rv = kstrtou16(buf, 10, &nt->np.remote_port);
464 if (rv < 0)
465 goto out_unlock;
466 mutex_unlock(&dynamic_netconsole_mutex);
467 return strnlen(buf, count);
468out_unlock:
469 mutex_unlock(&dynamic_netconsole_mutex);
470 return rv;
471}
472
473static ssize_t local_ip_store(struct config_item *item, const char *buf,
474 size_t count)
475{
476 struct netconsole_target *nt = to_target(item);
477
478 mutex_lock(&dynamic_netconsole_mutex);
479 if (nt->enabled) {
480 pr_err("target (%s) is enabled, disable to update parameters\n",
481 config_item_name(&nt->item));
482 goto out_unlock;
483 }
484
485 if (strnchr(buf, count, ':')) {
486 const char *end;
487 if (in6_pton(buf, count, nt->np.local_ip.in6.s6_addr, -1, &end) > 0) {
488 if (*end && *end != '\n') {
489 pr_err("invalid IPv6 address at: <%c>\n", *end);
490 goto out_unlock;
491 }
492 nt->np.ipv6 = true;
493 } else
494 goto out_unlock;
495 } else {
496 if (!nt->np.ipv6) {
497 nt->np.local_ip.ip = in_aton(buf);
498 } else
499 goto out_unlock;
500 }
501
502 mutex_unlock(&dynamic_netconsole_mutex);
503 return strnlen(buf, count);
504out_unlock:
505 mutex_unlock(&dynamic_netconsole_mutex);
506 return -EINVAL;
507}
508
509static ssize_t remote_ip_store(struct config_item *item, const char *buf,
510 size_t count)
511{
512 struct netconsole_target *nt = to_target(item);
513
514 mutex_lock(&dynamic_netconsole_mutex);
515 if (nt->enabled) {
516 pr_err("target (%s) is enabled, disable to update parameters\n",
517 config_item_name(&nt->item));
518 goto out_unlock;
519 }
520
521 if (strnchr(buf, count, ':')) {
522 const char *end;
523 if (in6_pton(buf, count, nt->np.remote_ip.in6.s6_addr, -1, &end) > 0) {
524 if (*end && *end != '\n') {
525 pr_err("invalid IPv6 address at: <%c>\n", *end);
526 goto out_unlock;
527 }
528 nt->np.ipv6 = true;
529 } else
530 goto out_unlock;
531 } else {
532 if (!nt->np.ipv6) {
533 nt->np.remote_ip.ip = in_aton(buf);
534 } else
535 goto out_unlock;
536 }
537
538 mutex_unlock(&dynamic_netconsole_mutex);
539 return strnlen(buf, count);
540out_unlock:
541 mutex_unlock(&dynamic_netconsole_mutex);
542 return -EINVAL;
543}
544
545static ssize_t remote_mac_store(struct config_item *item, const char *buf,
546 size_t count)
547{
548 struct netconsole_target *nt = to_target(item);
549 u8 remote_mac[ETH_ALEN];
550
551 mutex_lock(&dynamic_netconsole_mutex);
552 if (nt->enabled) {
553 pr_err("target (%s) is enabled, disable to update parameters\n",
554 config_item_name(&nt->item));
555 goto out_unlock;
556 }
557
558 if (!mac_pton(buf, remote_mac))
559 goto out_unlock;
560 if (buf[3 * ETH_ALEN - 1] && buf[3 * ETH_ALEN - 1] != '\n')
561 goto out_unlock;
562 memcpy(nt->np.remote_mac, remote_mac, ETH_ALEN);
563
564 mutex_unlock(&dynamic_netconsole_mutex);
565 return strnlen(buf, count);
566out_unlock:
567 mutex_unlock(&dynamic_netconsole_mutex);
568 return -EINVAL;
569}
570
571CONFIGFS_ATTR(, enabled);
572CONFIGFS_ATTR(, extended);
573CONFIGFS_ATTR(, dev_name);
574CONFIGFS_ATTR(, local_port);
575CONFIGFS_ATTR(, remote_port);
576CONFIGFS_ATTR(, local_ip);
577CONFIGFS_ATTR(, remote_ip);
578CONFIGFS_ATTR_RO(, local_mac);
579CONFIGFS_ATTR(, remote_mac);
580
581static struct configfs_attribute *netconsole_target_attrs[] = {
582 &attr_enabled,
583 &attr_extended,
584 &attr_dev_name,
585 &attr_local_port,
586 &attr_remote_port,
587 &attr_local_ip,
588 &attr_remote_ip,
589 &attr_local_mac,
590 &attr_remote_mac,
591 NULL,
592};
593
594/*
595 * Item operations and type for netconsole_target.
596 */
597
598static void netconsole_target_release(struct config_item *item)
599{
600 kfree(to_target(item));
601}
602
603static struct configfs_item_operations netconsole_target_item_ops = {
604 .release = netconsole_target_release,
605};
606
607static const struct config_item_type netconsole_target_type = {
608 .ct_attrs = netconsole_target_attrs,
609 .ct_item_ops = &netconsole_target_item_ops,
610 .ct_owner = THIS_MODULE,
611};
612
613/*
614 * Group operations and type for netconsole_subsys.
615 */
616
617static struct config_item *make_netconsole_target(struct config_group *group,
618 const char *name)
619{
620 unsigned long flags;
621 struct netconsole_target *nt;
622
623 /*
624 * Allocate and initialize with defaults.
625 * Target is disabled at creation (!enabled).
626 */
627 nt = kzalloc(sizeof(*nt), GFP_KERNEL);
628 if (!nt)
629 return ERR_PTR(-ENOMEM);
630
631 nt->np.name = "netconsole";
632 strlcpy(nt->np.dev_name, "eth0", IFNAMSIZ);
633 nt->np.local_port = 6665;
634 nt->np.remote_port = 6666;
635 eth_broadcast_addr(nt->np.remote_mac);
636
637 /* Initialize the config_item member */
638 config_item_init_type_name(&nt->item, name, &netconsole_target_type);
639
640 /* Adding, but it is disabled */
641 spin_lock_irqsave(&target_list_lock, flags);
642 list_add(&nt->list, &target_list);
643 spin_unlock_irqrestore(&target_list_lock, flags);
644
645 return &nt->item;
646}
647
648static void drop_netconsole_target(struct config_group *group,
649 struct config_item *item)
650{
651 unsigned long flags;
652 struct netconsole_target *nt = to_target(item);
653
654 spin_lock_irqsave(&target_list_lock, flags);
655 list_del(&nt->list);
656 spin_unlock_irqrestore(&target_list_lock, flags);
657
658 /*
659 * The target may have never been enabled, or was manually disabled
660 * before being removed so netpoll may have already been cleaned up.
661 */
662 if (nt->enabled)
663 netpoll_cleanup(&nt->np);
664
665 config_item_put(&nt->item);
666}
667
668static struct configfs_group_operations netconsole_subsys_group_ops = {
669 .make_item = make_netconsole_target,
670 .drop_item = drop_netconsole_target,
671};
672
673static const struct config_item_type netconsole_subsys_type = {
674 .ct_group_ops = &netconsole_subsys_group_ops,
675 .ct_owner = THIS_MODULE,
676};
677
678/* The netconsole configfs subsystem */
679static struct configfs_subsystem netconsole_subsys = {
680 .su_group = {
681 .cg_item = {
682 .ci_namebuf = "netconsole",
683 .ci_type = &netconsole_subsys_type,
684 },
685 },
686};
687
688#endif /* CONFIG_NETCONSOLE_DYNAMIC */
689
690/* Handle network interface device notifications */
691static int netconsole_netdev_event(struct notifier_block *this,
692 unsigned long event, void *ptr)
693{
694 unsigned long flags;
695 struct netconsole_target *nt;
696 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
697 bool stopped = false;
698
699 if (!(event == NETDEV_CHANGENAME || event == NETDEV_UNREGISTER ||
700 event == NETDEV_RELEASE || event == NETDEV_JOIN))
701 goto done;
702
703 spin_lock_irqsave(&target_list_lock, flags);
704restart:
705 list_for_each_entry(nt, &target_list, list) {
706 netconsole_target_get(nt);
707 if (nt->np.dev == dev) {
708 switch (event) {
709 case NETDEV_CHANGENAME:
710 strlcpy(nt->np.dev_name, dev->name, IFNAMSIZ);
711 break;
712 case NETDEV_RELEASE:
713 case NETDEV_JOIN:
714 case NETDEV_UNREGISTER:
715 /* rtnl_lock already held
716 * we might sleep in __netpoll_cleanup()
717 */
718 spin_unlock_irqrestore(&target_list_lock, flags);
719
720 __netpoll_cleanup(&nt->np);
721
722 spin_lock_irqsave(&target_list_lock, flags);
723 dev_put(nt->np.dev);
724 nt->np.dev = NULL;
725 nt->enabled = false;
726 stopped = true;
727 netconsole_target_put(nt);
728 goto restart;
729 }
730 }
731 netconsole_target_put(nt);
732 }
733 spin_unlock_irqrestore(&target_list_lock, flags);
734 if (stopped) {
735 const char *msg = "had an event";
736 switch (event) {
737 case NETDEV_UNREGISTER:
738 msg = "unregistered";
739 break;
740 case NETDEV_RELEASE:
741 msg = "released slaves";
742 break;
743 case NETDEV_JOIN:
744 msg = "is joining a master device";
745 break;
746 }
747 pr_info("network logging stopped on interface %s as it %s\n",
748 dev->name, msg);
749 }
750
751done:
752 return NOTIFY_DONE;
753}
754
755static struct notifier_block netconsole_netdev_notifier = {
756 .notifier_call = netconsole_netdev_event,
757};
758
759/**
760 * send_ext_msg_udp - send extended log message to target
761 * @nt: target to send message to
762 * @msg: extended log message to send
763 * @msg_len: length of message
764 *
765 * Transfer extended log @msg to @nt. If @msg is longer than
766 * MAX_PRINT_CHUNK, it'll be split and transmitted in multiple chunks with
767 * ncfrag header field added to identify them.
768 */
769static void send_ext_msg_udp(struct netconsole_target *nt, const char *msg,
770 int msg_len)
771{
772 static char buf[MAX_PRINT_CHUNK]; /* protected by target_list_lock */
773 const char *header, *body;
774 int offset = 0;
775 int header_len, body_len;
776
777 if (msg_len <= MAX_PRINT_CHUNK) {
778 netpoll_send_udp(&nt->np, msg, msg_len);
779 return;
780 }
781
782 /* need to insert extra header fields, detect header and body */
783 header = msg;
784 body = memchr(msg, ';', msg_len);
785 if (WARN_ON_ONCE(!body))
786 return;
787
788 header_len = body - header;
789 body_len = msg_len - header_len - 1;
790 body++;
791
792 /*
793 * Transfer multiple chunks with the following extra header.
794 * "ncfrag=<byte-offset>/<total-bytes>"
795 */
796 memcpy(buf, header, header_len);
797
798 while (offset < body_len) {
799 int this_header = header_len;
800 int this_chunk;
801
802 this_header += scnprintf(buf + this_header,
803 sizeof(buf) - this_header,
804 ",ncfrag=%d/%d;", offset, body_len);
805
806 this_chunk = min(body_len - offset,
807 MAX_PRINT_CHUNK - this_header);
808 if (WARN_ON_ONCE(this_chunk <= 0))
809 return;
810
811 memcpy(buf + this_header, body + offset, this_chunk);
812
813 netpoll_send_udp(&nt->np, buf, this_header + this_chunk);
814
815 offset += this_chunk;
816 }
817}
818
819static void write_ext_msg(struct console *con, const char *msg,
820 unsigned int len)
821{
822 struct netconsole_target *nt;
823 unsigned long flags;
824
825 if ((oops_only && !oops_in_progress) || list_empty(&target_list))
826 return;
827
828 spin_lock_irqsave(&target_list_lock, flags);
829 list_for_each_entry(nt, &target_list, list)
830 if (nt->extended && nt->enabled && netif_running(nt->np.dev))
831 send_ext_msg_udp(nt, msg, len);
832 spin_unlock_irqrestore(&target_list_lock, flags);
833}
834
835static void write_msg(struct console *con, const char *msg, unsigned int len)
836{
837 int frag, left;
838 unsigned long flags;
839 struct netconsole_target *nt;
840 const char *tmp;
841
842 if (oops_only && !oops_in_progress)
843 return;
844 /* Avoid taking lock and disabling interrupts unnecessarily */
845 if (list_empty(&target_list))
846 return;
847
848 spin_lock_irqsave(&target_list_lock, flags);
849 list_for_each_entry(nt, &target_list, list) {
850 if (!nt->extended && nt->enabled && netif_running(nt->np.dev)) {
851 /*
852 * We nest this inside the for-each-target loop above
853 * so that we're able to get as much logging out to
854 * at least one target if we die inside here, instead
855 * of unnecessarily keeping all targets in lock-step.
856 */
857 tmp = msg;
858 for (left = len; left;) {
859 frag = min(left, MAX_PRINT_CHUNK);
860 netpoll_send_udp(&nt->np, tmp, frag);
861 tmp += frag;
862 left -= frag;
863 }
864 }
865 }
866 spin_unlock_irqrestore(&target_list_lock, flags);
867}
868
869static struct console netconsole_ext = {
870 .name = "netcon_ext",
871 .flags = CON_EXTENDED, /* starts disabled, registered on first use */
872 .write = write_ext_msg,
873};
874
875static struct console netconsole = {
876 .name = "netcon",
877 .flags = CON_ENABLED,
878 .write = write_msg,
879};
880
881static int __init init_netconsole(void)
882{
883 int err;
884 struct netconsole_target *nt, *tmp;
885 unsigned long flags;
886 char *target_config;
887 char *input = config;
888
889 if (strnlen(input, MAX_PARAM_LENGTH)) {
890 while ((target_config = strsep(&input, ";"))) {
891 nt = alloc_param_target(target_config);
892 if (IS_ERR(nt)) {
893 err = PTR_ERR(nt);
894 goto fail;
895 }
896 /* Dump existing printks when we register */
897 if (nt->extended)
898 netconsole_ext.flags |= CON_PRINTBUFFER |
899 CON_ENABLED;
900 else
901 netconsole.flags |= CON_PRINTBUFFER;
902
903 spin_lock_irqsave(&target_list_lock, flags);
904 list_add(&nt->list, &target_list);
905 spin_unlock_irqrestore(&target_list_lock, flags);
906 }
907 }
908
909 err = register_netdevice_notifier(&netconsole_netdev_notifier);
910 if (err)
911 goto fail;
912
913 err = dynamic_netconsole_init();
914 if (err)
915 goto undonotifier;
916
917 if (netconsole_ext.flags & CON_ENABLED)
918 register_console(&netconsole_ext);
919 register_console(&netconsole);
920 pr_info("network logging started\n");
921
922 return err;
923
924undonotifier:
925 unregister_netdevice_notifier(&netconsole_netdev_notifier);
926
927fail:
928 pr_err("cleaning up\n");
929
930 /*
931 * Remove all targets and destroy them (only targets created
932 * from the boot/module option exist here). Skipping the list
933 * lock is safe here, and netpoll_cleanup() will sleep.
934 */
935 list_for_each_entry_safe(nt, tmp, &target_list, list) {
936 list_del(&nt->list);
937 free_param_target(nt);
938 }
939
940 return err;
941}
942
943static void __exit cleanup_netconsole(void)
944{
945 struct netconsole_target *nt, *tmp;
946
947 unregister_console(&netconsole_ext);
948 unregister_console(&netconsole);
949 dynamic_netconsole_exit();
950 unregister_netdevice_notifier(&netconsole_netdev_notifier);
951
952 /*
953 * Targets created via configfs pin references on our module
954 * and would first be rmdir(2)'ed from userspace. We reach
955 * here only when they are already destroyed, and only those
956 * created from the boot/module option are left, so remove and
957 * destroy them. Skipping the list lock is safe here, and
958 * netpoll_cleanup() will sleep.
959 */
960 list_for_each_entry_safe(nt, tmp, &target_list, list) {
961 list_del(&nt->list);
962 free_param_target(nt);
963 }
964}
965
966/*
967 * Use late_initcall to ensure netconsole is
968 * initialized after network device driver if built-in.
969 *
970 * late_initcall() and module_init() are identical if built as module.
971 */
972late_initcall(init_netconsole);
973module_exit(cleanup_netconsole);