Linux Audio

Check our new training course

Loading...
v4.17
 
  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#include <linux/etherdevice.h>
 
 51
 52MODULE_AUTHOR("Maintainer: Matt Mackall <mpm@selenic.com>");
 53MODULE_DESCRIPTION("Console driver for network interfaces");
 54MODULE_LICENSE("GPL");
 55
 56#define MAX_PARAM_LENGTH	256
 57#define MAX_PRINT_CHUNK		1000
 
 
 
 
 
 
 58
 59static char config[MAX_PARAM_LENGTH];
 60module_param_string(netconsole, config, MAX_PARAM_LENGTH, 0);
 61MODULE_PARM_DESC(netconsole, " netconsole=[src-port]@[src-ip]/[dev],[tgt-port]@<tgt-ip>/[tgt-macaddr]");
 62
 63static bool oops_only = false;
 64module_param(oops_only, bool, 0600);
 65MODULE_PARM_DESC(oops_only, "Only log oops messages");
 66
 
 
 67#ifndef	MODULE
 68static int __init option_setup(char *opt)
 69{
 70	strlcpy(config, opt, MAX_PARAM_LENGTH);
 71	return 1;
 72}
 73__setup("netconsole=", option_setup);
 74#endif	/* MODULE */
 75
 76/* Linked list of all configured targets */
 77static LIST_HEAD(target_list);
 78
 79/* This needs to be a spinlock because write_msg() cannot sleep */
 80static DEFINE_SPINLOCK(target_list_lock);
 81
 82/*
 83 * Console driver for extended netconsoles.  Registered on the first use to
 84 * avoid unnecessarily enabling ext message formatting.
 85 */
 86static struct console netconsole_ext;
 87
 88/**
 89 * struct netconsole_target - Represents a configured netconsole target.
 90 * @list:	Links this target into the target_list.
 91 * @item:	Links us into the configfs subsystem hierarchy.
 
 
 
 92 * @enabled:	On / off knob to enable / disable target.
 93 *		Visible from userspace (read-write).
 94 *		We maintain a strict 1:1 correspondence between this and
 95 *		whether the corresponding netpoll is active or inactive.
 96 *		Also, other parameters of a target may be modified at
 97 *		runtime only when it is disabled (enabled == 0).
 
 
 
 98 * @np:		The netpoll structure for this target.
 99 *		Contains the other userspace visible parameters:
100 *		dev_name	(read-write)
101 *		local_port	(read-write)
102 *		remote_port	(read-write)
103 *		local_ip	(read-write)
104 *		remote_ip	(read-write)
105 *		local_mac	(read-only)
106 *		remote_mac	(read-write)
107 */
108struct netconsole_target {
109	struct list_head	list;
110#ifdef	CONFIG_NETCONSOLE_DYNAMIC
111	struct config_item	item;
 
 
 
112#endif
113	bool			enabled;
114	bool			extended;
 
115	struct netpoll		np;
116};
117
118#ifdef	CONFIG_NETCONSOLE_DYNAMIC
119
120static struct configfs_subsystem netconsole_subsys;
121static DEFINE_MUTEX(dynamic_netconsole_mutex);
122
123static int __init dynamic_netconsole_init(void)
124{
125	config_group_init(&netconsole_subsys.su_group);
126	mutex_init(&netconsole_subsys.su_mutex);
127	return configfs_register_subsystem(&netconsole_subsys);
128}
129
130static void __exit dynamic_netconsole_exit(void)
131{
132	configfs_unregister_subsystem(&netconsole_subsys);
133}
134
135/*
136 * Targets that were created by parsing the boot/module option string
137 * do not exist in the configfs hierarchy (and have NULL names) and will
138 * never go away, so make these a no-op for them.
139 */
140static void netconsole_target_get(struct netconsole_target *nt)
141{
142	if (config_item_name(&nt->item))
143		config_item_get(&nt->item);
144}
145
146static void netconsole_target_put(struct netconsole_target *nt)
147{
148	if (config_item_name(&nt->item))
149		config_item_put(&nt->item);
150}
151
152#else	/* !CONFIG_NETCONSOLE_DYNAMIC */
153
154static int __init dynamic_netconsole_init(void)
155{
156	return 0;
157}
158
159static void __exit dynamic_netconsole_exit(void)
160{
161}
162
163/*
164 * No danger of targets going away from under us when dynamic
165 * reconfigurability is off.
166 */
167static void netconsole_target_get(struct netconsole_target *nt)
168{
169}
170
171static void netconsole_target_put(struct netconsole_target *nt)
172{
173}
174
 
 
 
 
175#endif	/* CONFIG_NETCONSOLE_DYNAMIC */
176
177/* Allocate new target (from boot/module param) and setup netpoll for it */
178static struct netconsole_target *alloc_param_target(char *target_config)
 
 
179{
180	int err = -ENOMEM;
181	struct netconsole_target *nt;
182
183	/*
184	 * Allocate and initialize with defaults.
185	 * Note that these targets get their config_item fields zeroed-out.
186	 */
187	nt = kzalloc(sizeof(*nt), GFP_KERNEL);
188	if (!nt)
189		goto fail;
 
 
 
 
 
190
191	nt->np.name = "netconsole";
192	strlcpy(nt->np.dev_name, "eth0", IFNAMSIZ);
193	nt->np.local_port = 6665;
194	nt->np.remote_port = 6666;
195	eth_broadcast_addr(nt->np.remote_mac);
196
197	if (*target_config == '+') {
198		nt->extended = true;
199		target_config++;
200	}
201
202	/* Parse parameters and setup netpoll */
203	err = netpoll_parse_options(&nt->np, target_config);
204	if (err)
205		goto fail;
206
207	err = netpoll_setup(&nt->np);
208	if (err)
209		goto fail;
210
211	nt->enabled = true;
212
213	return nt;
214
215fail:
216	kfree(nt);
217	return ERR_PTR(err);
218}
219
220/* Cleanup netpoll for given target (from boot/module param) and free it */
221static void free_param_target(struct netconsole_target *nt)
222{
223	netpoll_cleanup(&nt->np);
224	kfree(nt);
225}
226
227#ifdef	CONFIG_NETCONSOLE_DYNAMIC
228
229/*
230 * Our subsystem hierarchy is:
231 *
232 * /sys/kernel/config/netconsole/
233 *				|
234 *				<target>/
235 *				|	enabled
 
236 *				|	dev_name
237 *				|	local_port
238 *				|	remote_port
239 *				|	local_ip
240 *				|	remote_ip
241 *				|	local_mac
242 *				|	remote_mac
 
 
 
 
243 *				|
244 *				<target>/...
245 */
246
247static struct netconsole_target *to_target(struct config_item *item)
248{
249	return item ?
250		container_of(item, struct netconsole_target, item) :
251		NULL;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
252}
253
254/*
255 * Attribute operations for netconsole_target.
256 */
257
258static ssize_t enabled_show(struct config_item *item, char *buf)
259{
260	return snprintf(buf, PAGE_SIZE, "%d\n", to_target(item)->enabled);
261}
262
263static ssize_t extended_show(struct config_item *item, char *buf)
264{
265	return snprintf(buf, PAGE_SIZE, "%d\n", to_target(item)->extended);
 
 
 
 
 
266}
267
268static ssize_t dev_name_show(struct config_item *item, char *buf)
269{
270	return snprintf(buf, PAGE_SIZE, "%s\n", to_target(item)->np.dev_name);
271}
272
273static ssize_t local_port_show(struct config_item *item, char *buf)
274{
275	return snprintf(buf, PAGE_SIZE, "%d\n", to_target(item)->np.local_port);
276}
277
278static ssize_t remote_port_show(struct config_item *item, char *buf)
279{
280	return snprintf(buf, PAGE_SIZE, "%d\n", to_target(item)->np.remote_port);
281}
282
283static ssize_t local_ip_show(struct config_item *item, char *buf)
284{
285	struct netconsole_target *nt = to_target(item);
286
287	if (nt->np.ipv6)
288		return snprintf(buf, PAGE_SIZE, "%pI6c\n", &nt->np.local_ip.in6);
289	else
290		return snprintf(buf, PAGE_SIZE, "%pI4\n", &nt->np.local_ip);
291}
292
293static ssize_t remote_ip_show(struct config_item *item, char *buf)
294{
295	struct netconsole_target *nt = to_target(item);
296
297	if (nt->np.ipv6)
298		return snprintf(buf, PAGE_SIZE, "%pI6c\n", &nt->np.remote_ip.in6);
299	else
300		return snprintf(buf, PAGE_SIZE, "%pI4\n", &nt->np.remote_ip);
301}
302
303static ssize_t local_mac_show(struct config_item *item, char *buf)
304{
305	struct net_device *dev = to_target(item)->np.dev;
306	static const u8 bcast[ETH_ALEN] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
307
308	return snprintf(buf, PAGE_SIZE, "%pM\n", dev ? dev->dev_addr : bcast);
309}
310
311static ssize_t remote_mac_show(struct config_item *item, char *buf)
312{
313	return snprintf(buf, PAGE_SIZE, "%pM\n", to_target(item)->np.remote_mac);
314}
315
316/*
317 * This one is special -- targets created through the configfs interface
318 * are not enabled (and the corresponding netpoll activated) by default.
319 * The user is expected to set the desired parameters first (which
320 * would enable him to dynamically add new netpoll targets for new
321 * network interfaces as and when they come up).
322 */
323static ssize_t enabled_store(struct config_item *item,
324		const char *buf, size_t count)
325{
326	struct netconsole_target *nt = to_target(item);
327	unsigned long flags;
328	int enabled;
329	int err;
330
331	mutex_lock(&dynamic_netconsole_mutex);
332	err = kstrtoint(buf, 10, &enabled);
333	if (err < 0)
334		goto out_unlock;
335
336	err = -EINVAL;
337	if (enabled < 0 || enabled > 1)
338		goto out_unlock;
339	if ((bool)enabled == nt->enabled) {
340		pr_info("network logging has already %s\n",
341			nt->enabled ? "started" : "stopped");
342		goto out_unlock;
343	}
344
345	if (enabled) {	/* true */
346		if (nt->extended && !(netconsole_ext.flags & CON_ENABLED)) {
347			netconsole_ext.flags |= CON_ENABLED;
348			register_console(&netconsole_ext);
349		}
350
 
 
 
351		/*
352		 * Skip netpoll_parse_options() -- all the attributes are
353		 * already configured via configfs. Just print them out.
354		 */
355		netpoll_print_options(&nt->np);
356
357		err = netpoll_setup(&nt->np);
358		if (err)
359			goto out_unlock;
360
361		pr_info("network logging started\n");
362	} else {	/* false */
363		/* We need to disable the netconsole before cleaning it up
364		 * otherwise we might end up in write_msg() with
365		 * nt->np.dev == NULL and nt->enabled == true
366		 */
367		spin_lock_irqsave(&target_list_lock, flags);
368		nt->enabled = false;
369		spin_unlock_irqrestore(&target_list_lock, flags);
370		netpoll_cleanup(&nt->np);
371	}
372
373	nt->enabled = enabled;
374
375	mutex_unlock(&dynamic_netconsole_mutex);
376	return strnlen(buf, count);
377out_unlock:
378	mutex_unlock(&dynamic_netconsole_mutex);
379	return err;
380}
381
382static ssize_t extended_store(struct config_item *item, const char *buf,
383		size_t count)
384{
385	struct netconsole_target *nt = to_target(item);
386	int extended;
387	int err;
388
389	mutex_lock(&dynamic_netconsole_mutex);
390	if (nt->enabled) {
391		pr_err("target (%s) is enabled, disable to update parameters\n",
392		       config_item_name(&nt->item));
393		err = -EINVAL;
394		goto out_unlock;
395	}
396
397	err = kstrtoint(buf, 10, &extended);
398	if (err < 0)
399		goto out_unlock;
400	if (extended < 0 || extended > 1) {
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
401		err = -EINVAL;
402		goto out_unlock;
403	}
404
 
 
 
 
405	nt->extended = extended;
406
407	mutex_unlock(&dynamic_netconsole_mutex);
408	return strnlen(buf, count);
409out_unlock:
410	mutex_unlock(&dynamic_netconsole_mutex);
411	return err;
412}
413
414static ssize_t dev_name_store(struct config_item *item, const char *buf,
415		size_t count)
416{
417	struct netconsole_target *nt = to_target(item);
418	size_t len;
419
420	mutex_lock(&dynamic_netconsole_mutex);
421	if (nt->enabled) {
422		pr_err("target (%s) is enabled, disable to update parameters\n",
423		       config_item_name(&nt->item));
424		mutex_unlock(&dynamic_netconsole_mutex);
425		return -EINVAL;
426	}
427
428	strlcpy(nt->np.dev_name, buf, IFNAMSIZ);
429
430	/* Get rid of possible trailing newline from echo(1) */
431	len = strnlen(nt->np.dev_name, IFNAMSIZ);
432	if (nt->np.dev_name[len - 1] == '\n')
433		nt->np.dev_name[len - 1] = '\0';
434
435	mutex_unlock(&dynamic_netconsole_mutex);
436	return strnlen(buf, count);
437}
438
439static ssize_t local_port_store(struct config_item *item, const char *buf,
440		size_t count)
441{
442	struct netconsole_target *nt = to_target(item);
443	int rv = -EINVAL;
444
445	mutex_lock(&dynamic_netconsole_mutex);
446	if (nt->enabled) {
447		pr_err("target (%s) is enabled, disable to update parameters\n",
448		       config_item_name(&nt->item));
449		goto out_unlock;
450	}
451
452	rv = kstrtou16(buf, 10, &nt->np.local_port);
453	if (rv < 0)
454		goto out_unlock;
455	mutex_unlock(&dynamic_netconsole_mutex);
456	return strnlen(buf, count);
457out_unlock:
458	mutex_unlock(&dynamic_netconsole_mutex);
459	return rv;
460}
461
462static ssize_t remote_port_store(struct config_item *item,
463		const char *buf, size_t count)
464{
465	struct netconsole_target *nt = to_target(item);
466	int rv = -EINVAL;
467
468	mutex_lock(&dynamic_netconsole_mutex);
469	if (nt->enabled) {
470		pr_err("target (%s) is enabled, disable to update parameters\n",
471		       config_item_name(&nt->item));
472		goto out_unlock;
473	}
474
475	rv = kstrtou16(buf, 10, &nt->np.remote_port);
476	if (rv < 0)
477		goto out_unlock;
478	mutex_unlock(&dynamic_netconsole_mutex);
479	return strnlen(buf, count);
480out_unlock:
481	mutex_unlock(&dynamic_netconsole_mutex);
482	return rv;
483}
484
485static ssize_t local_ip_store(struct config_item *item, const char *buf,
486		size_t count)
487{
488	struct netconsole_target *nt = to_target(item);
489
490	mutex_lock(&dynamic_netconsole_mutex);
491	if (nt->enabled) {
492		pr_err("target (%s) is enabled, disable to update parameters\n",
493		       config_item_name(&nt->item));
494		goto out_unlock;
495	}
496
497	if (strnchr(buf, count, ':')) {
498		const char *end;
 
499		if (in6_pton(buf, count, nt->np.local_ip.in6.s6_addr, -1, &end) > 0) {
500			if (*end && *end != '\n') {
501				pr_err("invalid IPv6 address at: <%c>\n", *end);
502				goto out_unlock;
503			}
504			nt->np.ipv6 = true;
505		} else
506			goto out_unlock;
507	} else {
508		if (!nt->np.ipv6) {
509			nt->np.local_ip.ip = in_aton(buf);
510		} else
511			goto out_unlock;
512	}
513
514	mutex_unlock(&dynamic_netconsole_mutex);
515	return strnlen(buf, count);
516out_unlock:
517	mutex_unlock(&dynamic_netconsole_mutex);
518	return -EINVAL;
519}
520
521static ssize_t remote_ip_store(struct config_item *item, const char *buf,
522	       size_t count)
523{
524	struct netconsole_target *nt = to_target(item);
525
526	mutex_lock(&dynamic_netconsole_mutex);
527	if (nt->enabled) {
528		pr_err("target (%s) is enabled, disable to update parameters\n",
529		       config_item_name(&nt->item));
530		goto out_unlock;
531	}
532
533	if (strnchr(buf, count, ':')) {
534		const char *end;
 
535		if (in6_pton(buf, count, nt->np.remote_ip.in6.s6_addr, -1, &end) > 0) {
536			if (*end && *end != '\n') {
537				pr_err("invalid IPv6 address at: <%c>\n", *end);
538				goto out_unlock;
539			}
540			nt->np.ipv6 = true;
541		} else
542			goto out_unlock;
543	} else {
544		if (!nt->np.ipv6) {
545			nt->np.remote_ip.ip = in_aton(buf);
546		} else
547			goto out_unlock;
548	}
549
550	mutex_unlock(&dynamic_netconsole_mutex);
551	return strnlen(buf, count);
552out_unlock:
553	mutex_unlock(&dynamic_netconsole_mutex);
554	return -EINVAL;
555}
556
557static ssize_t remote_mac_store(struct config_item *item, const char *buf,
558		size_t count)
559{
560	struct netconsole_target *nt = to_target(item);
561	u8 remote_mac[ETH_ALEN];
562
563	mutex_lock(&dynamic_netconsole_mutex);
564	if (nt->enabled) {
565		pr_err("target (%s) is enabled, disable to update parameters\n",
566		       config_item_name(&nt->item));
567		goto out_unlock;
568	}
569
570	if (!mac_pton(buf, remote_mac))
571		goto out_unlock;
572	if (buf[3 * ETH_ALEN - 1] && buf[3 * ETH_ALEN - 1] != '\n')
573		goto out_unlock;
574	memcpy(nt->np.remote_mac, remote_mac, ETH_ALEN);
575
576	mutex_unlock(&dynamic_netconsole_mutex);
577	return strnlen(buf, count);
578out_unlock:
579	mutex_unlock(&dynamic_netconsole_mutex);
580	return -EINVAL;
581}
582
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
583CONFIGFS_ATTR(, enabled);
584CONFIGFS_ATTR(, extended);
585CONFIGFS_ATTR(, dev_name);
586CONFIGFS_ATTR(, local_port);
587CONFIGFS_ATTR(, remote_port);
588CONFIGFS_ATTR(, local_ip);
589CONFIGFS_ATTR(, remote_ip);
590CONFIGFS_ATTR_RO(, local_mac);
591CONFIGFS_ATTR(, remote_mac);
 
592
593static struct configfs_attribute *netconsole_target_attrs[] = {
594	&attr_enabled,
595	&attr_extended,
 
596	&attr_dev_name,
597	&attr_local_port,
598	&attr_remote_port,
599	&attr_local_ip,
600	&attr_remote_ip,
601	&attr_local_mac,
602	&attr_remote_mac,
603	NULL,
604};
605
606/*
607 * Item operations and type for netconsole_target.
608 */
609
610static void netconsole_target_release(struct config_item *item)
611{
612	kfree(to_target(item));
613}
614
615static struct configfs_item_operations netconsole_target_item_ops = {
616	.release		= netconsole_target_release,
617};
618
619static const struct config_item_type netconsole_target_type = {
620	.ct_attrs		= netconsole_target_attrs,
621	.ct_item_ops		= &netconsole_target_item_ops,
622	.ct_owner		= THIS_MODULE,
623};
624
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
625/*
626 * Group operations and type for netconsole_subsys.
627 */
628
629static struct config_item *make_netconsole_target(struct config_group *group,
630						  const char *name)
631{
632	unsigned long flags;
633	struct netconsole_target *nt;
 
634
635	/*
636	 * Allocate and initialize with defaults.
637	 * Target is disabled at creation (!enabled).
638	 */
639	nt = kzalloc(sizeof(*nt), GFP_KERNEL);
 
 
 
 
 
 
 
 
 
640	if (!nt)
641		return ERR_PTR(-ENOMEM);
642
643	nt->np.name = "netconsole";
644	strlcpy(nt->np.dev_name, "eth0", IFNAMSIZ);
645	nt->np.local_port = 6665;
646	nt->np.remote_port = 6666;
647	eth_broadcast_addr(nt->np.remote_mac);
648
649	/* Initialize the config_item member */
650	config_item_init_type_name(&nt->item, name, &netconsole_target_type);
651
652	/* Adding, but it is disabled */
653	spin_lock_irqsave(&target_list_lock, flags);
654	list_add(&nt->list, &target_list);
655	spin_unlock_irqrestore(&target_list_lock, flags);
656
657	return &nt->item;
658}
659
660static void drop_netconsole_target(struct config_group *group,
661				   struct config_item *item)
662{
663	unsigned long flags;
664	struct netconsole_target *nt = to_target(item);
665
666	spin_lock_irqsave(&target_list_lock, flags);
667	list_del(&nt->list);
668	spin_unlock_irqrestore(&target_list_lock, flags);
669
670	/*
671	 * The target may have never been enabled, or was manually disabled
672	 * before being removed so netpoll may have already been cleaned up.
673	 */
674	if (nt->enabled)
675		netpoll_cleanup(&nt->np);
676
677	config_item_put(&nt->item);
678}
679
680static struct configfs_group_operations netconsole_subsys_group_ops = {
681	.make_item	= make_netconsole_target,
682	.drop_item	= drop_netconsole_target,
683};
684
685static const struct config_item_type netconsole_subsys_type = {
686	.ct_group_ops	= &netconsole_subsys_group_ops,
687	.ct_owner	= THIS_MODULE,
688};
689
690/* The netconsole configfs subsystem */
691static struct configfs_subsystem netconsole_subsys = {
692	.su_group	= {
693		.cg_item	= {
694			.ci_namebuf	= "netconsole",
695			.ci_type	= &netconsole_subsys_type,
696		},
697	},
698};
699
 
 
 
 
 
 
 
 
 
 
700#endif	/* CONFIG_NETCONSOLE_DYNAMIC */
701
702/* Handle network interface device notifications */
703static int netconsole_netdev_event(struct notifier_block *this,
704				   unsigned long event, void *ptr)
705{
706	unsigned long flags;
707	struct netconsole_target *nt;
708	struct net_device *dev = netdev_notifier_info_to_dev(ptr);
709	bool stopped = false;
710
711	if (!(event == NETDEV_CHANGENAME || event == NETDEV_UNREGISTER ||
712	      event == NETDEV_RELEASE || event == NETDEV_JOIN))
713		goto done;
714
715	spin_lock_irqsave(&target_list_lock, flags);
716restart:
717	list_for_each_entry(nt, &target_list, list) {
718		netconsole_target_get(nt);
719		if (nt->np.dev == dev) {
720			switch (event) {
721			case NETDEV_CHANGENAME:
722				strlcpy(nt->np.dev_name, dev->name, IFNAMSIZ);
723				break;
724			case NETDEV_RELEASE:
725			case NETDEV_JOIN:
726			case NETDEV_UNREGISTER:
727				/* rtnl_lock already held
728				 * we might sleep in __netpoll_cleanup()
729				 */
730				spin_unlock_irqrestore(&target_list_lock, flags);
731
732				__netpoll_cleanup(&nt->np);
733
734				spin_lock_irqsave(&target_list_lock, flags);
735				dev_put(nt->np.dev);
736				nt->np.dev = NULL;
737				nt->enabled = false;
738				stopped = true;
739				netconsole_target_put(nt);
740				goto restart;
741			}
742		}
743		netconsole_target_put(nt);
744	}
745	spin_unlock_irqrestore(&target_list_lock, flags);
746	if (stopped) {
747		const char *msg = "had an event";
 
748		switch (event) {
749		case NETDEV_UNREGISTER:
750			msg = "unregistered";
751			break;
752		case NETDEV_RELEASE:
753			msg = "released slaves";
754			break;
755		case NETDEV_JOIN:
756			msg = "is joining a master device";
757			break;
758		}
759		pr_info("network logging stopped on interface %s as it %s\n",
760			dev->name, msg);
761	}
762
763done:
764	return NOTIFY_DONE;
765}
766
767static struct notifier_block netconsole_netdev_notifier = {
768	.notifier_call  = netconsole_netdev_event,
769};
770
771/**
772 * send_ext_msg_udp - send extended log message to target
773 * @nt: target to send message to
774 * @msg: extended log message to send
775 * @msg_len: length of message
776 *
777 * Transfer extended log @msg to @nt.  If @msg is longer than
778 * MAX_PRINT_CHUNK, it'll be split and transmitted in multiple chunks with
779 * ncfrag header field added to identify them.
780 */
781static void send_ext_msg_udp(struct netconsole_target *nt, const char *msg,
782			     int msg_len)
783{
784	static char buf[MAX_PRINT_CHUNK]; /* protected by target_list_lock */
785	const char *header, *body;
786	int offset = 0;
787	int header_len, body_len;
 
 
 
 
 
 
 
 
 
 
788
789	if (msg_len <= MAX_PRINT_CHUNK) {
790		netpoll_send_udp(&nt->np, msg, msg_len);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
791		return;
792	}
793
794	/* need to insert extra header fields, detect header and body */
795	header = msg;
796	body = memchr(msg, ';', msg_len);
797	if (WARN_ON_ONCE(!body))
798		return;
799
800	header_len = body - header;
801	body_len = msg_len - header_len - 1;
802	body++;
803
804	/*
805	 * Transfer multiple chunks with the following extra header.
806	 * "ncfrag=<byte-offset>/<total-bytes>"
807	 */
808	memcpy(buf, header, header_len);
 
 
 
809
810	while (offset < body_len) {
811		int this_header = header_len;
812		int this_chunk;
 
813
814		this_header += scnprintf(buf + this_header,
815					 sizeof(buf) - this_header,
816					 ",ncfrag=%d/%d;", offset, body_len);
817
818		this_chunk = min(body_len - offset,
819				 MAX_PRINT_CHUNK - this_header);
820		if (WARN_ON_ONCE(this_chunk <= 0))
821			return;
822
823		memcpy(buf + this_header, body + offset, this_chunk);
824
825		netpoll_send_udp(&nt->np, buf, this_header + this_chunk);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
826
827		offset += this_chunk;
 
828	}
829}
830
831static void write_ext_msg(struct console *con, const char *msg,
832			  unsigned int len)
833{
834	struct netconsole_target *nt;
835	unsigned long flags;
836
837	if ((oops_only && !oops_in_progress) || list_empty(&target_list))
838		return;
839
840	spin_lock_irqsave(&target_list_lock, flags);
841	list_for_each_entry(nt, &target_list, list)
842		if (nt->extended && nt->enabled && netif_running(nt->np.dev))
843			send_ext_msg_udp(nt, msg, len);
844	spin_unlock_irqrestore(&target_list_lock, flags);
845}
846
847static void write_msg(struct console *con, const char *msg, unsigned int len)
848{
849	int frag, left;
850	unsigned long flags;
851	struct netconsole_target *nt;
852	const char *tmp;
853
854	if (oops_only && !oops_in_progress)
855		return;
856	/* Avoid taking lock and disabling interrupts unnecessarily */
857	if (list_empty(&target_list))
858		return;
859
860	spin_lock_irqsave(&target_list_lock, flags);
861	list_for_each_entry(nt, &target_list, list) {
862		if (!nt->extended && nt->enabled && netif_running(nt->np.dev)) {
863			/*
864			 * We nest this inside the for-each-target loop above
865			 * so that we're able to get as much logging out to
866			 * at least one target if we die inside here, instead
867			 * of unnecessarily keeping all targets in lock-step.
868			 */
869			tmp = msg;
870			for (left = len; left;) {
871				frag = min(left, MAX_PRINT_CHUNK);
872				netpoll_send_udp(&nt->np, tmp, frag);
873				tmp += frag;
874				left -= frag;
875			}
876		}
877	}
878	spin_unlock_irqrestore(&target_list_lock, flags);
879}
880
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
881static struct console netconsole_ext = {
882	.name	= "netcon_ext",
883	.flags	= CON_EXTENDED,	/* starts disabled, registered on first use */
884	.write	= write_ext_msg,
885};
886
887static struct console netconsole = {
888	.name	= "netcon",
889	.flags	= CON_ENABLED,
890	.write	= write_msg,
891};
892
893static int __init init_netconsole(void)
894{
895	int err;
896	struct netconsole_target *nt, *tmp;
 
 
897	unsigned long flags;
898	char *target_config;
899	char *input = config;
900
901	if (strnlen(input, MAX_PARAM_LENGTH)) {
902		while ((target_config = strsep(&input, ";"))) {
903			nt = alloc_param_target(target_config);
904			if (IS_ERR(nt)) {
905				err = PTR_ERR(nt);
906				goto fail;
907			}
908			/* Dump existing printks when we register */
909			if (nt->extended)
910				netconsole_ext.flags |= CON_PRINTBUFFER |
911							CON_ENABLED;
912			else
913				netconsole.flags |= CON_PRINTBUFFER;
 
914
915			spin_lock_irqsave(&target_list_lock, flags);
916			list_add(&nt->list, &target_list);
917			spin_unlock_irqrestore(&target_list_lock, flags);
 
918		}
919	}
920
921	err = register_netdevice_notifier(&netconsole_netdev_notifier);
922	if (err)
923		goto fail;
924
925	err = dynamic_netconsole_init();
926	if (err)
927		goto undonotifier;
928
929	if (netconsole_ext.flags & CON_ENABLED)
930		register_console(&netconsole_ext);
931	register_console(&netconsole);
932	pr_info("network logging started\n");
933
934	return err;
935
936undonotifier:
937	unregister_netdevice_notifier(&netconsole_netdev_notifier);
938
939fail:
940	pr_err("cleaning up\n");
941
942	/*
943	 * Remove all targets and destroy them (only targets created
944	 * from the boot/module option exist here). Skipping the list
945	 * lock is safe here, and netpoll_cleanup() will sleep.
946	 */
947	list_for_each_entry_safe(nt, tmp, &target_list, list) {
948		list_del(&nt->list);
949		free_param_target(nt);
950	}
951
952	return err;
953}
954
955static void __exit cleanup_netconsole(void)
956{
957	struct netconsole_target *nt, *tmp;
958
959	unregister_console(&netconsole_ext);
 
960	unregister_console(&netconsole);
961	dynamic_netconsole_exit();
962	unregister_netdevice_notifier(&netconsole_netdev_notifier);
963
964	/*
965	 * Targets created via configfs pin references on our module
966	 * and would first be rmdir(2)'ed from userspace. We reach
967	 * here only when they are already destroyed, and only those
968	 * created from the boot/module option are left, so remove and
969	 * destroy them. Skipping the list lock is safe here, and
970	 * netpoll_cleanup() will sleep.
971	 */
972	list_for_each_entry_safe(nt, tmp, &target_list, list) {
973		list_del(&nt->list);
974		free_param_target(nt);
975	}
976}
977
978/*
979 * Use late_initcall to ensure netconsole is
980 * initialized after network device driver if built-in.
981 *
982 * late_initcall() and module_init() are identical if built as module.
983 */
984late_initcall(init_netconsole);
985module_exit(cleanup_netconsole);
v6.9.4
   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#include <linux/utsname.h>
  40
  41MODULE_AUTHOR("Maintainer: Matt Mackall <mpm@selenic.com>");
  42MODULE_DESCRIPTION("Console driver for network interfaces");
  43MODULE_LICENSE("GPL");
  44
  45#define MAX_PARAM_LENGTH		256
  46#define MAX_USERDATA_ENTRY_LENGTH	256
  47#define MAX_USERDATA_VALUE_LENGTH	200
  48/* The number 3 comes from userdata entry format characters (' ', '=', '\n') */
  49#define MAX_USERDATA_NAME_LENGTH	(MAX_USERDATA_ENTRY_LENGTH - \
  50					MAX_USERDATA_VALUE_LENGTH - 3)
  51#define MAX_USERDATA_ITEMS		16
  52#define MAX_PRINT_CHUNK			1000
  53
  54static char config[MAX_PARAM_LENGTH];
  55module_param_string(netconsole, config, MAX_PARAM_LENGTH, 0);
  56MODULE_PARM_DESC(netconsole, " netconsole=[src-port]@[src-ip]/[dev],[tgt-port]@<tgt-ip>/[tgt-macaddr]");
  57
  58static bool oops_only;
  59module_param(oops_only, bool, 0600);
  60MODULE_PARM_DESC(oops_only, "Only log oops messages");
  61
  62#define NETCONSOLE_PARAM_TARGET_PREFIX "cmdline"
  63
  64#ifndef	MODULE
  65static int __init option_setup(char *opt)
  66{
  67	strscpy(config, opt, MAX_PARAM_LENGTH);
  68	return 1;
  69}
  70__setup("netconsole=", option_setup);
  71#endif	/* MODULE */
  72
  73/* Linked list of all configured targets */
  74static LIST_HEAD(target_list);
  75
  76/* This needs to be a spinlock because write_msg() cannot sleep */
  77static DEFINE_SPINLOCK(target_list_lock);
  78
  79/*
  80 * Console driver for extended netconsoles.  Registered on the first use to
  81 * avoid unnecessarily enabling ext message formatting.
  82 */
  83static struct console netconsole_ext;
  84
  85/**
  86 * struct netconsole_target - Represents a configured netconsole target.
  87 * @list:	Links this target into the target_list.
  88 * @group:	Links us into the configfs subsystem hierarchy.
  89 * @userdata_group:	Links to the userdata configfs hierarchy
  90 * @userdata_complete:	Cached, formatted string of append
  91 * @userdata_length:	String length of userdata_complete
  92 * @enabled:	On / off knob to enable / disable target.
  93 *		Visible from userspace (read-write).
  94 *		We maintain a strict 1:1 correspondence between this and
  95 *		whether the corresponding netpoll is active or inactive.
  96 *		Also, other parameters of a target may be modified at
  97 *		runtime only when it is disabled (enabled == 0).
  98 * @extended:	Denotes whether console is extended or not.
  99 * @release:	Denotes whether kernel release version should be prepended
 100 *		to the message. Depends on extended console.
 101 * @np:		The netpoll structure for this target.
 102 *		Contains the other userspace visible parameters:
 103 *		dev_name	(read-write)
 104 *		local_port	(read-write)
 105 *		remote_port	(read-write)
 106 *		local_ip	(read-write)
 107 *		remote_ip	(read-write)
 108 *		local_mac	(read-only)
 109 *		remote_mac	(read-write)
 110 */
 111struct netconsole_target {
 112	struct list_head	list;
 113#ifdef	CONFIG_NETCONSOLE_DYNAMIC
 114	struct config_group	group;
 115	struct config_group	userdata_group;
 116	char userdata_complete[MAX_USERDATA_ENTRY_LENGTH * MAX_USERDATA_ITEMS];
 117	size_t			userdata_length;
 118#endif
 119	bool			enabled;
 120	bool			extended;
 121	bool			release;
 122	struct netpoll		np;
 123};
 124
 125#ifdef	CONFIG_NETCONSOLE_DYNAMIC
 126
 127static struct configfs_subsystem netconsole_subsys;
 128static DEFINE_MUTEX(dynamic_netconsole_mutex);
 129
 130static int __init dynamic_netconsole_init(void)
 131{
 132	config_group_init(&netconsole_subsys.su_group);
 133	mutex_init(&netconsole_subsys.su_mutex);
 134	return configfs_register_subsystem(&netconsole_subsys);
 135}
 136
 137static void __exit dynamic_netconsole_exit(void)
 138{
 139	configfs_unregister_subsystem(&netconsole_subsys);
 140}
 141
 142/*
 143 * Targets that were created by parsing the boot/module option string
 144 * do not exist in the configfs hierarchy (and have NULL names) and will
 145 * never go away, so make these a no-op for them.
 146 */
 147static void netconsole_target_get(struct netconsole_target *nt)
 148{
 149	if (config_item_name(&nt->group.cg_item))
 150		config_group_get(&nt->group);
 151}
 152
 153static void netconsole_target_put(struct netconsole_target *nt)
 154{
 155	if (config_item_name(&nt->group.cg_item))
 156		config_group_put(&nt->group);
 157}
 158
 159#else	/* !CONFIG_NETCONSOLE_DYNAMIC */
 160
 161static int __init dynamic_netconsole_init(void)
 162{
 163	return 0;
 164}
 165
 166static void __exit dynamic_netconsole_exit(void)
 167{
 168}
 169
 170/*
 171 * No danger of targets going away from under us when dynamic
 172 * reconfigurability is off.
 173 */
 174static void netconsole_target_get(struct netconsole_target *nt)
 175{
 176}
 177
 178static void netconsole_target_put(struct netconsole_target *nt)
 179{
 180}
 181
 182static void populate_configfs_item(struct netconsole_target *nt,
 183				   int cmdline_count)
 184{
 185}
 186#endif	/* CONFIG_NETCONSOLE_DYNAMIC */
 187
 188/* Allocate and initialize with defaults.
 189 * Note that these targets get their config_item fields zeroed-out.
 190 */
 191static struct netconsole_target *alloc_and_init(void)
 192{
 
 193	struct netconsole_target *nt;
 194
 
 
 
 
 195	nt = kzalloc(sizeof(*nt), GFP_KERNEL);
 196	if (!nt)
 197		return nt;
 198
 199	if (IS_ENABLED(CONFIG_NETCONSOLE_EXTENDED_LOG))
 200		nt->extended = true;
 201	if (IS_ENABLED(CONFIG_NETCONSOLE_PREPEND_RELEASE))
 202		nt->release = true;
 203
 204	nt->np.name = "netconsole";
 205	strscpy(nt->np.dev_name, "eth0", IFNAMSIZ);
 206	nt->np.local_port = 6665;
 207	nt->np.remote_port = 6666;
 208	eth_broadcast_addr(nt->np.remote_mac);
 209
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 210	return nt;
 
 
 
 
 
 
 
 
 
 
 
 211}
 212
 213#ifdef	CONFIG_NETCONSOLE_DYNAMIC
 214
 215/*
 216 * Our subsystem hierarchy is:
 217 *
 218 * /sys/kernel/config/netconsole/
 219 *				|
 220 *				<target>/
 221 *				|	enabled
 222 *				|	release
 223 *				|	dev_name
 224 *				|	local_port
 225 *				|	remote_port
 226 *				|	local_ip
 227 *				|	remote_ip
 228 *				|	local_mac
 229 *				|	remote_mac
 230 *				|	userdata/
 231 *				|		<key>/
 232 *				|			value
 233 *				|		...
 234 *				|
 235 *				<target>/...
 236 */
 237
 238static struct netconsole_target *to_target(struct config_item *item)
 239{
 240	struct config_group *cfg_group;
 241
 242	cfg_group = to_config_group(item);
 243	if (!cfg_group)
 244		return NULL;
 245	return container_of(to_config_group(item),
 246			    struct netconsole_target, group);
 247}
 248
 249/* Get rid of possible trailing newline, returning the new length */
 250static void trim_newline(char *s, size_t maxlen)
 251{
 252	size_t len;
 253
 254	len = strnlen(s, maxlen);
 255	if (s[len - 1] == '\n')
 256		s[len - 1] = '\0';
 257}
 258
 259/*
 260 * Attribute operations for netconsole_target.
 261 */
 262
 263static ssize_t enabled_show(struct config_item *item, char *buf)
 264{
 265	return sysfs_emit(buf, "%d\n", to_target(item)->enabled);
 266}
 267
 268static ssize_t extended_show(struct config_item *item, char *buf)
 269{
 270	return sysfs_emit(buf, "%d\n", to_target(item)->extended);
 271}
 272
 273static ssize_t release_show(struct config_item *item, char *buf)
 274{
 275	return sysfs_emit(buf, "%d\n", to_target(item)->release);
 276}
 277
 278static ssize_t dev_name_show(struct config_item *item, char *buf)
 279{
 280	return sysfs_emit(buf, "%s\n", to_target(item)->np.dev_name);
 281}
 282
 283static ssize_t local_port_show(struct config_item *item, char *buf)
 284{
 285	return sysfs_emit(buf, "%d\n", to_target(item)->np.local_port);
 286}
 287
 288static ssize_t remote_port_show(struct config_item *item, char *buf)
 289{
 290	return sysfs_emit(buf, "%d\n", to_target(item)->np.remote_port);
 291}
 292
 293static ssize_t local_ip_show(struct config_item *item, char *buf)
 294{
 295	struct netconsole_target *nt = to_target(item);
 296
 297	if (nt->np.ipv6)
 298		return sysfs_emit(buf, "%pI6c\n", &nt->np.local_ip.in6);
 299	else
 300		return sysfs_emit(buf, "%pI4\n", &nt->np.local_ip);
 301}
 302
 303static ssize_t remote_ip_show(struct config_item *item, char *buf)
 304{
 305	struct netconsole_target *nt = to_target(item);
 306
 307	if (nt->np.ipv6)
 308		return sysfs_emit(buf, "%pI6c\n", &nt->np.remote_ip.in6);
 309	else
 310		return sysfs_emit(buf, "%pI4\n", &nt->np.remote_ip);
 311}
 312
 313static ssize_t local_mac_show(struct config_item *item, char *buf)
 314{
 315	struct net_device *dev = to_target(item)->np.dev;
 316	static const u8 bcast[ETH_ALEN] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
 317
 318	return sysfs_emit(buf, "%pM\n", dev ? dev->dev_addr : bcast);
 319}
 320
 321static ssize_t remote_mac_show(struct config_item *item, char *buf)
 322{
 323	return sysfs_emit(buf, "%pM\n", to_target(item)->np.remote_mac);
 324}
 325
 326/*
 327 * This one is special -- targets created through the configfs interface
 328 * are not enabled (and the corresponding netpoll activated) by default.
 329 * The user is expected to set the desired parameters first (which
 330 * would enable him to dynamically add new netpoll targets for new
 331 * network interfaces as and when they come up).
 332 */
 333static ssize_t enabled_store(struct config_item *item,
 334		const char *buf, size_t count)
 335{
 336	struct netconsole_target *nt = to_target(item);
 337	unsigned long flags;
 338	bool enabled;
 339	int err;
 340
 341	mutex_lock(&dynamic_netconsole_mutex);
 342	err = kstrtobool(buf, &enabled);
 343	if (err)
 344		goto out_unlock;
 345
 346	err = -EINVAL;
 
 
 347	if ((bool)enabled == nt->enabled) {
 348		pr_info("network logging has already %s\n",
 349			nt->enabled ? "started" : "stopped");
 350		goto out_unlock;
 351	}
 352
 353	if (enabled) {	/* true */
 354		if (nt->release && !nt->extended) {
 355			pr_err("Not enabling netconsole. Release feature requires extended log message");
 356			goto out_unlock;
 357		}
 358
 359		if (nt->extended && !console_is_registered(&netconsole_ext))
 360			register_console(&netconsole_ext);
 361
 362		/*
 363		 * Skip netpoll_parse_options() -- all the attributes are
 364		 * already configured via configfs. Just print them out.
 365		 */
 366		netpoll_print_options(&nt->np);
 367
 368		err = netpoll_setup(&nt->np);
 369		if (err)
 370			goto out_unlock;
 371
 372		pr_info("network logging started\n");
 373	} else {	/* false */
 374		/* We need to disable the netconsole before cleaning it up
 375		 * otherwise we might end up in write_msg() with
 376		 * nt->np.dev == NULL and nt->enabled == true
 377		 */
 378		spin_lock_irqsave(&target_list_lock, flags);
 379		nt->enabled = false;
 380		spin_unlock_irqrestore(&target_list_lock, flags);
 381		netpoll_cleanup(&nt->np);
 382	}
 383
 384	nt->enabled = enabled;
 385
 386	mutex_unlock(&dynamic_netconsole_mutex);
 387	return strnlen(buf, count);
 388out_unlock:
 389	mutex_unlock(&dynamic_netconsole_mutex);
 390	return err;
 391}
 392
 393static ssize_t release_store(struct config_item *item, const char *buf,
 394			     size_t count)
 395{
 396	struct netconsole_target *nt = to_target(item);
 397	bool release;
 398	int err;
 399
 400	mutex_lock(&dynamic_netconsole_mutex);
 401	if (nt->enabled) {
 402		pr_err("target (%s) is enabled, disable to update parameters\n",
 403		       config_item_name(&nt->group.cg_item));
 404		err = -EINVAL;
 405		goto out_unlock;
 406	}
 407
 408	err = kstrtobool(buf, &release);
 409	if (err)
 410		goto out_unlock;
 411
 412	nt->release = release;
 413
 414	mutex_unlock(&dynamic_netconsole_mutex);
 415	return strnlen(buf, count);
 416out_unlock:
 417	mutex_unlock(&dynamic_netconsole_mutex);
 418	return err;
 419}
 420
 421static ssize_t extended_store(struct config_item *item, const char *buf,
 422		size_t count)
 423{
 424	struct netconsole_target *nt = to_target(item);
 425	bool extended;
 426	int err;
 427
 428	mutex_lock(&dynamic_netconsole_mutex);
 429	if (nt->enabled) {
 430		pr_err("target (%s) is enabled, disable to update parameters\n",
 431		       config_item_name(&nt->group.cg_item));
 432		err = -EINVAL;
 433		goto out_unlock;
 434	}
 435
 436	err = kstrtobool(buf, &extended);
 437	if (err)
 438		goto out_unlock;
 439
 440	nt->extended = extended;
 441
 442	mutex_unlock(&dynamic_netconsole_mutex);
 443	return strnlen(buf, count);
 444out_unlock:
 445	mutex_unlock(&dynamic_netconsole_mutex);
 446	return err;
 447}
 448
 449static ssize_t dev_name_store(struct config_item *item, const char *buf,
 450		size_t count)
 451{
 452	struct netconsole_target *nt = to_target(item);
 
 453
 454	mutex_lock(&dynamic_netconsole_mutex);
 455	if (nt->enabled) {
 456		pr_err("target (%s) is enabled, disable to update parameters\n",
 457		       config_item_name(&nt->group.cg_item));
 458		mutex_unlock(&dynamic_netconsole_mutex);
 459		return -EINVAL;
 460	}
 461
 462	strscpy(nt->np.dev_name, buf, IFNAMSIZ);
 463	trim_newline(nt->np.dev_name, IFNAMSIZ);
 
 
 
 
 464
 465	mutex_unlock(&dynamic_netconsole_mutex);
 466	return strnlen(buf, count);
 467}
 468
 469static ssize_t local_port_store(struct config_item *item, const char *buf,
 470		size_t count)
 471{
 472	struct netconsole_target *nt = to_target(item);
 473	int rv = -EINVAL;
 474
 475	mutex_lock(&dynamic_netconsole_mutex);
 476	if (nt->enabled) {
 477		pr_err("target (%s) is enabled, disable to update parameters\n",
 478		       config_item_name(&nt->group.cg_item));
 479		goto out_unlock;
 480	}
 481
 482	rv = kstrtou16(buf, 10, &nt->np.local_port);
 483	if (rv < 0)
 484		goto out_unlock;
 485	mutex_unlock(&dynamic_netconsole_mutex);
 486	return strnlen(buf, count);
 487out_unlock:
 488	mutex_unlock(&dynamic_netconsole_mutex);
 489	return rv;
 490}
 491
 492static ssize_t remote_port_store(struct config_item *item,
 493		const char *buf, size_t count)
 494{
 495	struct netconsole_target *nt = to_target(item);
 496	int rv = -EINVAL;
 497
 498	mutex_lock(&dynamic_netconsole_mutex);
 499	if (nt->enabled) {
 500		pr_err("target (%s) is enabled, disable to update parameters\n",
 501		       config_item_name(&nt->group.cg_item));
 502		goto out_unlock;
 503	}
 504
 505	rv = kstrtou16(buf, 10, &nt->np.remote_port);
 506	if (rv < 0)
 507		goto out_unlock;
 508	mutex_unlock(&dynamic_netconsole_mutex);
 509	return strnlen(buf, count);
 510out_unlock:
 511	mutex_unlock(&dynamic_netconsole_mutex);
 512	return rv;
 513}
 514
 515static ssize_t local_ip_store(struct config_item *item, const char *buf,
 516		size_t count)
 517{
 518	struct netconsole_target *nt = to_target(item);
 519
 520	mutex_lock(&dynamic_netconsole_mutex);
 521	if (nt->enabled) {
 522		pr_err("target (%s) is enabled, disable to update parameters\n",
 523		       config_item_name(&nt->group.cg_item));
 524		goto out_unlock;
 525	}
 526
 527	if (strnchr(buf, count, ':')) {
 528		const char *end;
 529
 530		if (in6_pton(buf, count, nt->np.local_ip.in6.s6_addr, -1, &end) > 0) {
 531			if (*end && *end != '\n') {
 532				pr_err("invalid IPv6 address at: <%c>\n", *end);
 533				goto out_unlock;
 534			}
 535			nt->np.ipv6 = true;
 536		} else
 537			goto out_unlock;
 538	} else {
 539		if (!nt->np.ipv6)
 540			nt->np.local_ip.ip = in_aton(buf);
 541		else
 542			goto out_unlock;
 543	}
 544
 545	mutex_unlock(&dynamic_netconsole_mutex);
 546	return strnlen(buf, count);
 547out_unlock:
 548	mutex_unlock(&dynamic_netconsole_mutex);
 549	return -EINVAL;
 550}
 551
 552static ssize_t remote_ip_store(struct config_item *item, const char *buf,
 553	       size_t count)
 554{
 555	struct netconsole_target *nt = to_target(item);
 556
 557	mutex_lock(&dynamic_netconsole_mutex);
 558	if (nt->enabled) {
 559		pr_err("target (%s) is enabled, disable to update parameters\n",
 560		       config_item_name(&nt->group.cg_item));
 561		goto out_unlock;
 562	}
 563
 564	if (strnchr(buf, count, ':')) {
 565		const char *end;
 566
 567		if (in6_pton(buf, count, nt->np.remote_ip.in6.s6_addr, -1, &end) > 0) {
 568			if (*end && *end != '\n') {
 569				pr_err("invalid IPv6 address at: <%c>\n", *end);
 570				goto out_unlock;
 571			}
 572			nt->np.ipv6 = true;
 573		} else
 574			goto out_unlock;
 575	} else {
 576		if (!nt->np.ipv6)
 577			nt->np.remote_ip.ip = in_aton(buf);
 578		else
 579			goto out_unlock;
 580	}
 581
 582	mutex_unlock(&dynamic_netconsole_mutex);
 583	return strnlen(buf, count);
 584out_unlock:
 585	mutex_unlock(&dynamic_netconsole_mutex);
 586	return -EINVAL;
 587}
 588
 589static ssize_t remote_mac_store(struct config_item *item, const char *buf,
 590		size_t count)
 591{
 592	struct netconsole_target *nt = to_target(item);
 593	u8 remote_mac[ETH_ALEN];
 594
 595	mutex_lock(&dynamic_netconsole_mutex);
 596	if (nt->enabled) {
 597		pr_err("target (%s) is enabled, disable to update parameters\n",
 598		       config_item_name(&nt->group.cg_item));
 599		goto out_unlock;
 600	}
 601
 602	if (!mac_pton(buf, remote_mac))
 603		goto out_unlock;
 604	if (buf[3 * ETH_ALEN - 1] && buf[3 * ETH_ALEN - 1] != '\n')
 605		goto out_unlock;
 606	memcpy(nt->np.remote_mac, remote_mac, ETH_ALEN);
 607
 608	mutex_unlock(&dynamic_netconsole_mutex);
 609	return strnlen(buf, count);
 610out_unlock:
 611	mutex_unlock(&dynamic_netconsole_mutex);
 612	return -EINVAL;
 613}
 614
 615struct userdatum {
 616	struct config_item item;
 617	char value[MAX_USERDATA_VALUE_LENGTH];
 618};
 619
 620static struct userdatum *to_userdatum(struct config_item *item)
 621{
 622	return container_of(item, struct userdatum, item);
 623}
 624
 625struct userdata {
 626	struct config_group group;
 627};
 628
 629static struct userdata *to_userdata(struct config_item *item)
 630{
 631	return container_of(to_config_group(item), struct userdata, group);
 632}
 633
 634static struct netconsole_target *userdata_to_target(struct userdata *ud)
 635{
 636	struct config_group *netconsole_group;
 637
 638	netconsole_group = to_config_group(ud->group.cg_item.ci_parent);
 639	return to_target(&netconsole_group->cg_item);
 640}
 641
 642static ssize_t userdatum_value_show(struct config_item *item, char *buf)
 643{
 644	return sysfs_emit(buf, "%s\n", &(to_userdatum(item)->value[0]));
 645}
 646
 647static void update_userdata(struct netconsole_target *nt)
 648{
 649	int complete_idx = 0, child_count = 0;
 650	struct list_head *entry;
 651
 652	/* Clear the current string in case the last userdatum was deleted */
 653	nt->userdata_length = 0;
 654	nt->userdata_complete[0] = 0;
 655
 656	list_for_each(entry, &nt->userdata_group.cg_children) {
 657		struct userdatum *udm_item;
 658		struct config_item *item;
 659
 660		if (child_count >= MAX_USERDATA_ITEMS)
 661			break;
 662		child_count++;
 663
 664		item = container_of(entry, struct config_item, ci_entry);
 665		udm_item = to_userdatum(item);
 666
 667		/* Skip userdata with no value set */
 668		if (strnlen(udm_item->value, MAX_USERDATA_VALUE_LENGTH) == 0)
 669			continue;
 670
 671		/* This doesn't overflow userdata_complete since it will write
 672		 * one entry length (1/MAX_USERDATA_ITEMS long), entry count is
 673		 * checked to not exceed MAX items with child_count above
 674		 */
 675		complete_idx += scnprintf(&nt->userdata_complete[complete_idx],
 676					  MAX_USERDATA_ENTRY_LENGTH, " %s=%s\n",
 677					  item->ci_name, udm_item->value);
 678	}
 679	nt->userdata_length = strnlen(nt->userdata_complete,
 680				      sizeof(nt->userdata_complete));
 681}
 682
 683static ssize_t userdatum_value_store(struct config_item *item, const char *buf,
 684				     size_t count)
 685{
 686	struct userdatum *udm = to_userdatum(item);
 687	struct netconsole_target *nt;
 688	struct userdata *ud;
 689	int ret;
 690
 691	if (count > MAX_USERDATA_VALUE_LENGTH)
 692		return -EMSGSIZE;
 693
 694	mutex_lock(&dynamic_netconsole_mutex);
 695
 696	ret = strscpy(udm->value, buf, sizeof(udm->value));
 697	if (ret < 0)
 698		goto out_unlock;
 699	trim_newline(udm->value, sizeof(udm->value));
 700
 701	ud = to_userdata(item->ci_parent);
 702	nt = userdata_to_target(ud);
 703	update_userdata(nt);
 704
 705	mutex_unlock(&dynamic_netconsole_mutex);
 706	return count;
 707out_unlock:
 708	mutex_unlock(&dynamic_netconsole_mutex);
 709	return ret;
 710}
 711
 712CONFIGFS_ATTR(userdatum_, value);
 713
 714static struct configfs_attribute *userdatum_attrs[] = {
 715	&userdatum_attr_value,
 716	NULL,
 717};
 718
 719static void userdatum_release(struct config_item *item)
 720{
 721	kfree(to_userdatum(item));
 722}
 723
 724static struct configfs_item_operations userdatum_ops = {
 725	.release = userdatum_release,
 726};
 727
 728static const struct config_item_type userdatum_type = {
 729	.ct_item_ops	= &userdatum_ops,
 730	.ct_attrs	= userdatum_attrs,
 731	.ct_owner	= THIS_MODULE,
 732};
 733
 734static struct config_item *userdatum_make_item(struct config_group *group,
 735					       const char *name)
 736{
 737	struct netconsole_target *nt;
 738	struct userdatum *udm;
 739	struct userdata *ud;
 740	size_t child_count;
 741
 742	if (strlen(name) > MAX_USERDATA_NAME_LENGTH)
 743		return ERR_PTR(-ENAMETOOLONG);
 744
 745	ud = to_userdata(&group->cg_item);
 746	nt = userdata_to_target(ud);
 747	child_count = list_count_nodes(&nt->userdata_group.cg_children);
 748	if (child_count >= MAX_USERDATA_ITEMS)
 749		return ERR_PTR(-ENOSPC);
 750
 751	udm = kzalloc(sizeof(*udm), GFP_KERNEL);
 752	if (!udm)
 753		return ERR_PTR(-ENOMEM);
 754
 755	config_item_init_type_name(&udm->item, name, &userdatum_type);
 756	return &udm->item;
 757}
 758
 759static void userdatum_drop(struct config_group *group, struct config_item *item)
 760{
 761	struct netconsole_target *nt;
 762	struct userdata *ud;
 763
 764	ud = to_userdata(&group->cg_item);
 765	nt = userdata_to_target(ud);
 766
 767	mutex_lock(&dynamic_netconsole_mutex);
 768	update_userdata(nt);
 769	config_item_put(item);
 770	mutex_unlock(&dynamic_netconsole_mutex);
 771}
 772
 773static struct configfs_attribute *userdata_attrs[] = {
 774	NULL,
 775};
 776
 777static struct configfs_group_operations userdata_ops = {
 778	.make_item		= userdatum_make_item,
 779	.drop_item		= userdatum_drop,
 780};
 781
 782static struct config_item_type userdata_type = {
 783	.ct_item_ops	= &userdatum_ops,
 784	.ct_group_ops	= &userdata_ops,
 785	.ct_attrs	= userdata_attrs,
 786	.ct_owner	= THIS_MODULE,
 787};
 788
 789CONFIGFS_ATTR(, enabled);
 790CONFIGFS_ATTR(, extended);
 791CONFIGFS_ATTR(, dev_name);
 792CONFIGFS_ATTR(, local_port);
 793CONFIGFS_ATTR(, remote_port);
 794CONFIGFS_ATTR(, local_ip);
 795CONFIGFS_ATTR(, remote_ip);
 796CONFIGFS_ATTR_RO(, local_mac);
 797CONFIGFS_ATTR(, remote_mac);
 798CONFIGFS_ATTR(, release);
 799
 800static struct configfs_attribute *netconsole_target_attrs[] = {
 801	&attr_enabled,
 802	&attr_extended,
 803	&attr_release,
 804	&attr_dev_name,
 805	&attr_local_port,
 806	&attr_remote_port,
 807	&attr_local_ip,
 808	&attr_remote_ip,
 809	&attr_local_mac,
 810	&attr_remote_mac,
 811	NULL,
 812};
 813
 814/*
 815 * Item operations and type for netconsole_target.
 816 */
 817
 818static void netconsole_target_release(struct config_item *item)
 819{
 820	kfree(to_target(item));
 821}
 822
 823static struct configfs_item_operations netconsole_target_item_ops = {
 824	.release		= netconsole_target_release,
 825};
 826
 827static const struct config_item_type netconsole_target_type = {
 828	.ct_attrs		= netconsole_target_attrs,
 829	.ct_item_ops		= &netconsole_target_item_ops,
 830	.ct_owner		= THIS_MODULE,
 831};
 832
 833static void init_target_config_group(struct netconsole_target *nt,
 834				     const char *name)
 835{
 836	config_group_init_type_name(&nt->group, name, &netconsole_target_type);
 837	config_group_init_type_name(&nt->userdata_group, "userdata",
 838				    &userdata_type);
 839	configfs_add_default_group(&nt->userdata_group, &nt->group);
 840}
 841
 842static struct netconsole_target *find_cmdline_target(const char *name)
 843{
 844	struct netconsole_target *nt, *ret = NULL;
 845	unsigned long flags;
 846
 847	spin_lock_irqsave(&target_list_lock, flags);
 848	list_for_each_entry(nt, &target_list, list) {
 849		if (!strcmp(nt->group.cg_item.ci_name, name)) {
 850			ret = nt;
 851			break;
 852		}
 853	}
 854	spin_unlock_irqrestore(&target_list_lock, flags);
 855
 856	return ret;
 857}
 858
 859/*
 860 * Group operations and type for netconsole_subsys.
 861 */
 862
 863static struct config_group *make_netconsole_target(struct config_group *group,
 864						   const char *name)
 865{
 
 866	struct netconsole_target *nt;
 867	unsigned long flags;
 868
 869	/* Checking if a target by this name was created at boot time.  If so,
 870	 * attach a configfs entry to that target.  This enables dynamic
 871	 * control.
 872	 */
 873	if (!strncmp(name, NETCONSOLE_PARAM_TARGET_PREFIX,
 874		     strlen(NETCONSOLE_PARAM_TARGET_PREFIX))) {
 875		nt = find_cmdline_target(name);
 876		if (nt) {
 877			init_target_config_group(nt, name);
 878			return &nt->group;
 879		}
 880	}
 881
 882	nt = alloc_and_init();
 883	if (!nt)
 884		return ERR_PTR(-ENOMEM);
 885
 886	/* Initialize the config_group member */
 887	init_target_config_group(nt, name);
 
 
 
 
 
 
 888
 889	/* Adding, but it is disabled */
 890	spin_lock_irqsave(&target_list_lock, flags);
 891	list_add(&nt->list, &target_list);
 892	spin_unlock_irqrestore(&target_list_lock, flags);
 893
 894	return &nt->group;
 895}
 896
 897static void drop_netconsole_target(struct config_group *group,
 898				   struct config_item *item)
 899{
 900	unsigned long flags;
 901	struct netconsole_target *nt = to_target(item);
 902
 903	spin_lock_irqsave(&target_list_lock, flags);
 904	list_del(&nt->list);
 905	spin_unlock_irqrestore(&target_list_lock, flags);
 906
 907	/*
 908	 * The target may have never been enabled, or was manually disabled
 909	 * before being removed so netpoll may have already been cleaned up.
 910	 */
 911	if (nt->enabled)
 912		netpoll_cleanup(&nt->np);
 913
 914	config_item_put(&nt->group.cg_item);
 915}
 916
 917static struct configfs_group_operations netconsole_subsys_group_ops = {
 918	.make_group	= make_netconsole_target,
 919	.drop_item	= drop_netconsole_target,
 920};
 921
 922static const struct config_item_type netconsole_subsys_type = {
 923	.ct_group_ops	= &netconsole_subsys_group_ops,
 924	.ct_owner	= THIS_MODULE,
 925};
 926
 927/* The netconsole configfs subsystem */
 928static struct configfs_subsystem netconsole_subsys = {
 929	.su_group	= {
 930		.cg_item	= {
 931			.ci_namebuf	= "netconsole",
 932			.ci_type	= &netconsole_subsys_type,
 933		},
 934	},
 935};
 936
 937static void populate_configfs_item(struct netconsole_target *nt,
 938				   int cmdline_count)
 939{
 940	char target_name[16];
 941
 942	snprintf(target_name, sizeof(target_name), "%s%d",
 943		 NETCONSOLE_PARAM_TARGET_PREFIX, cmdline_count);
 944	init_target_config_group(nt, target_name);
 945}
 946
 947#endif	/* CONFIG_NETCONSOLE_DYNAMIC */
 948
 949/* Handle network interface device notifications */
 950static int netconsole_netdev_event(struct notifier_block *this,
 951				   unsigned long event, void *ptr)
 952{
 953	unsigned long flags;
 954	struct netconsole_target *nt;
 955	struct net_device *dev = netdev_notifier_info_to_dev(ptr);
 956	bool stopped = false;
 957
 958	if (!(event == NETDEV_CHANGENAME || event == NETDEV_UNREGISTER ||
 959	      event == NETDEV_RELEASE || event == NETDEV_JOIN))
 960		goto done;
 961
 962	spin_lock_irqsave(&target_list_lock, flags);
 963restart:
 964	list_for_each_entry(nt, &target_list, list) {
 965		netconsole_target_get(nt);
 966		if (nt->np.dev == dev) {
 967			switch (event) {
 968			case NETDEV_CHANGENAME:
 969				strscpy(nt->np.dev_name, dev->name, IFNAMSIZ);
 970				break;
 971			case NETDEV_RELEASE:
 972			case NETDEV_JOIN:
 973			case NETDEV_UNREGISTER:
 974				/* rtnl_lock already held
 975				 * we might sleep in __netpoll_cleanup()
 976				 */
 977				spin_unlock_irqrestore(&target_list_lock, flags);
 978
 979				__netpoll_cleanup(&nt->np);
 980
 981				spin_lock_irqsave(&target_list_lock, flags);
 982				netdev_put(nt->np.dev, &nt->np.dev_tracker);
 983				nt->np.dev = NULL;
 984				nt->enabled = false;
 985				stopped = true;
 986				netconsole_target_put(nt);
 987				goto restart;
 988			}
 989		}
 990		netconsole_target_put(nt);
 991	}
 992	spin_unlock_irqrestore(&target_list_lock, flags);
 993	if (stopped) {
 994		const char *msg = "had an event";
 995
 996		switch (event) {
 997		case NETDEV_UNREGISTER:
 998			msg = "unregistered";
 999			break;
1000		case NETDEV_RELEASE:
1001			msg = "released slaves";
1002			break;
1003		case NETDEV_JOIN:
1004			msg = "is joining a master device";
1005			break;
1006		}
1007		pr_info("network logging stopped on interface %s as it %s\n",
1008			dev->name, msg);
1009	}
1010
1011done:
1012	return NOTIFY_DONE;
1013}
1014
1015static struct notifier_block netconsole_netdev_notifier = {
1016	.notifier_call  = netconsole_netdev_event,
1017};
1018
1019/**
1020 * send_ext_msg_udp - send extended log message to target
1021 * @nt: target to send message to
1022 * @msg: extended log message to send
1023 * @msg_len: length of message
1024 *
1025 * Transfer extended log @msg to @nt.  If @msg is longer than
1026 * MAX_PRINT_CHUNK, it'll be split and transmitted in multiple chunks with
1027 * ncfrag header field added to identify them.
1028 */
1029static void send_ext_msg_udp(struct netconsole_target *nt, const char *msg,
1030			     int msg_len)
1031{
1032	static char buf[MAX_PRINT_CHUNK]; /* protected by target_list_lock */
1033	const char *header, *body;
1034	int offset = 0;
1035	int header_len, body_len;
1036	const char *msg_ready = msg;
1037	const char *release;
1038	int release_len = 0;
1039	int userdata_len = 0;
1040	char *userdata = NULL;
1041
1042#ifdef CONFIG_NETCONSOLE_DYNAMIC
1043	userdata = nt->userdata_complete;
1044	userdata_len = nt->userdata_length;
1045#endif
1046
1047	if (nt->release) {
1048		release = init_utsname()->release;
1049		release_len = strlen(release) + 1;
1050	}
1051
1052	if (msg_len + release_len + userdata_len <= MAX_PRINT_CHUNK) {
1053		/* No fragmentation needed */
1054		if (nt->release) {
1055			scnprintf(buf, MAX_PRINT_CHUNK, "%s,%s", release, msg);
1056			msg_len += release_len;
1057		} else {
1058			memcpy(buf, msg, msg_len);
1059		}
1060
1061		if (userdata)
1062			msg_len += scnprintf(&buf[msg_len],
1063					     MAX_PRINT_CHUNK - msg_len,
1064					     "%s", userdata);
1065
1066		msg_ready = buf;
1067		netpoll_send_udp(&nt->np, msg_ready, msg_len);
1068		return;
1069	}
1070
1071	/* need to insert extra header fields, detect header and body */
1072	header = msg;
1073	body = memchr(msg, ';', msg_len);
1074	if (WARN_ON_ONCE(!body))
1075		return;
1076
1077	header_len = body - header;
1078	body_len = msg_len - header_len - 1;
1079	body++;
1080
1081	/*
1082	 * Transfer multiple chunks with the following extra header.
1083	 * "ncfrag=<byte-offset>/<total-bytes>"
1084	 */
1085	if (nt->release)
1086		scnprintf(buf, MAX_PRINT_CHUNK, "%s,", release);
1087	memcpy(buf + release_len, header, header_len);
1088	header_len += release_len;
1089
1090	while (offset < body_len + userdata_len) {
1091		int this_header = header_len;
1092		int this_offset = 0;
1093		int this_chunk = 0;
1094
1095		this_header += scnprintf(buf + this_header,
1096					 sizeof(buf) - this_header,
1097					 ",ncfrag=%d/%d;", offset,
1098					 body_len + userdata_len);
 
 
 
 
1099
1100		/* Not all body data has been written yet */
1101		if (offset < body_len) {
1102			this_chunk = min(body_len - offset,
1103					 MAX_PRINT_CHUNK - this_header);
1104			if (WARN_ON_ONCE(this_chunk <= 0))
1105				return;
1106			memcpy(buf + this_header, body + offset, this_chunk);
1107			this_offset += this_chunk;
1108		}
1109		/* Body is fully written and there is pending userdata to write,
1110		 * append userdata in this chunk
1111		 */
1112		if (offset + this_offset >= body_len &&
1113		    offset + this_offset < userdata_len + body_len) {
1114			int sent_userdata = (offset + this_offset) - body_len;
1115			int preceding_bytes = this_chunk + this_header;
1116
1117			if (WARN_ON_ONCE(sent_userdata < 0))
1118				return;
1119
1120			this_chunk = min(userdata_len - sent_userdata,
1121					 MAX_PRINT_CHUNK - preceding_bytes);
1122			if (WARN_ON_ONCE(this_chunk <= 0))
1123				return;
1124			memcpy(buf + this_header + this_offset,
1125			       userdata + sent_userdata,
1126			       this_chunk);
1127			this_offset += this_chunk;
1128		}
1129
1130		netpoll_send_udp(&nt->np, buf, this_header + this_offset);
1131		offset += this_offset;
1132	}
1133}
1134
1135static void write_ext_msg(struct console *con, const char *msg,
1136			  unsigned int len)
1137{
1138	struct netconsole_target *nt;
1139	unsigned long flags;
1140
1141	if ((oops_only && !oops_in_progress) || list_empty(&target_list))
1142		return;
1143
1144	spin_lock_irqsave(&target_list_lock, flags);
1145	list_for_each_entry(nt, &target_list, list)
1146		if (nt->extended && nt->enabled && netif_running(nt->np.dev))
1147			send_ext_msg_udp(nt, msg, len);
1148	spin_unlock_irqrestore(&target_list_lock, flags);
1149}
1150
1151static void write_msg(struct console *con, const char *msg, unsigned int len)
1152{
1153	int frag, left;
1154	unsigned long flags;
1155	struct netconsole_target *nt;
1156	const char *tmp;
1157
1158	if (oops_only && !oops_in_progress)
1159		return;
1160	/* Avoid taking lock and disabling interrupts unnecessarily */
1161	if (list_empty(&target_list))
1162		return;
1163
1164	spin_lock_irqsave(&target_list_lock, flags);
1165	list_for_each_entry(nt, &target_list, list) {
1166		if (!nt->extended && nt->enabled && netif_running(nt->np.dev)) {
1167			/*
1168			 * We nest this inside the for-each-target loop above
1169			 * so that we're able to get as much logging out to
1170			 * at least one target if we die inside here, instead
1171			 * of unnecessarily keeping all targets in lock-step.
1172			 */
1173			tmp = msg;
1174			for (left = len; left;) {
1175				frag = min(left, MAX_PRINT_CHUNK);
1176				netpoll_send_udp(&nt->np, tmp, frag);
1177				tmp += frag;
1178				left -= frag;
1179			}
1180		}
1181	}
1182	spin_unlock_irqrestore(&target_list_lock, flags);
1183}
1184
1185/* Allocate new target (from boot/module param) and setup netpoll for it */
1186static struct netconsole_target *alloc_param_target(char *target_config,
1187						    int cmdline_count)
1188{
1189	struct netconsole_target *nt;
1190	int err;
1191
1192	nt = alloc_and_init();
1193	if (!nt) {
1194		err = -ENOMEM;
1195		goto fail;
1196	}
1197
1198	if (*target_config == '+') {
1199		nt->extended = true;
1200		target_config++;
1201	}
1202
1203	if (*target_config == 'r') {
1204		if (!nt->extended) {
1205			pr_err("Netconsole configuration error. Release feature requires extended log message");
1206			err = -EINVAL;
1207			goto fail;
1208		}
1209		nt->release = true;
1210		target_config++;
1211	}
1212
1213	/* Parse parameters and setup netpoll */
1214	err = netpoll_parse_options(&nt->np, target_config);
1215	if (err)
1216		goto fail;
1217
1218	err = netpoll_setup(&nt->np);
1219	if (err)
1220		goto fail;
1221
1222	populate_configfs_item(nt, cmdline_count);
1223	nt->enabled = true;
1224
1225	return nt;
1226
1227fail:
1228	kfree(nt);
1229	return ERR_PTR(err);
1230}
1231
1232/* Cleanup netpoll for given target (from boot/module param) and free it */
1233static void free_param_target(struct netconsole_target *nt)
1234{
1235	netpoll_cleanup(&nt->np);
1236	kfree(nt);
1237}
1238
1239static struct console netconsole_ext = {
1240	.name	= "netcon_ext",
1241	.flags	= CON_ENABLED | CON_EXTENDED,
1242	.write	= write_ext_msg,
1243};
1244
1245static struct console netconsole = {
1246	.name	= "netcon",
1247	.flags	= CON_ENABLED,
1248	.write	= write_msg,
1249};
1250
1251static int __init init_netconsole(void)
1252{
1253	int err;
1254	struct netconsole_target *nt, *tmp;
1255	unsigned int count = 0;
1256	bool extended = false;
1257	unsigned long flags;
1258	char *target_config;
1259	char *input = config;
1260
1261	if (strnlen(input, MAX_PARAM_LENGTH)) {
1262		while ((target_config = strsep(&input, ";"))) {
1263			nt = alloc_param_target(target_config, count);
1264			if (IS_ERR(nt)) {
1265				err = PTR_ERR(nt);
1266				goto fail;
1267			}
1268			/* Dump existing printks when we register */
1269			if (nt->extended) {
1270				extended = true;
1271				netconsole_ext.flags |= CON_PRINTBUFFER;
1272			} else {
1273				netconsole.flags |= CON_PRINTBUFFER;
1274			}
1275
1276			spin_lock_irqsave(&target_list_lock, flags);
1277			list_add(&nt->list, &target_list);
1278			spin_unlock_irqrestore(&target_list_lock, flags);
1279			count++;
1280		}
1281	}
1282
1283	err = register_netdevice_notifier(&netconsole_netdev_notifier);
1284	if (err)
1285		goto fail;
1286
1287	err = dynamic_netconsole_init();
1288	if (err)
1289		goto undonotifier;
1290
1291	if (extended)
1292		register_console(&netconsole_ext);
1293	register_console(&netconsole);
1294	pr_info("network logging started\n");
1295
1296	return err;
1297
1298undonotifier:
1299	unregister_netdevice_notifier(&netconsole_netdev_notifier);
1300
1301fail:
1302	pr_err("cleaning up\n");
1303
1304	/*
1305	 * Remove all targets and destroy them (only targets created
1306	 * from the boot/module option exist here). Skipping the list
1307	 * lock is safe here, and netpoll_cleanup() will sleep.
1308	 */
1309	list_for_each_entry_safe(nt, tmp, &target_list, list) {
1310		list_del(&nt->list);
1311		free_param_target(nt);
1312	}
1313
1314	return err;
1315}
1316
1317static void __exit cleanup_netconsole(void)
1318{
1319	struct netconsole_target *nt, *tmp;
1320
1321	if (console_is_registered(&netconsole_ext))
1322		unregister_console(&netconsole_ext);
1323	unregister_console(&netconsole);
1324	dynamic_netconsole_exit();
1325	unregister_netdevice_notifier(&netconsole_netdev_notifier);
1326
1327	/*
1328	 * Targets created via configfs pin references on our module
1329	 * and would first be rmdir(2)'ed from userspace. We reach
1330	 * here only when they are already destroyed, and only those
1331	 * created from the boot/module option are left, so remove and
1332	 * destroy them. Skipping the list lock is safe here, and
1333	 * netpoll_cleanup() will sleep.
1334	 */
1335	list_for_each_entry_safe(nt, tmp, &target_list, list) {
1336		list_del(&nt->list);
1337		free_param_target(nt);
1338	}
1339}
1340
1341/*
1342 * Use late_initcall to ensure netconsole is
1343 * initialized after network device driver if built-in.
1344 *
1345 * late_initcall() and module_init() are identical if built as module.
1346 */
1347late_initcall(init_netconsole);
1348module_exit(cleanup_netconsole);