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