blob: a8ef4c4b94bed593a2423878041de3ed926567e7 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Joe Perches22ded572013-10-28 12:53:21 -070037#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
38
Linus Torvalds1da177e2005-04-16 15:20:36 -070039#include <linux/mm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070040#include <linux/init.h>
41#include <linux/module.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090042#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070043#include <linux/console.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#include <linux/moduleparam.h>
Andy Shevchenko4cd57732013-06-04 19:46:26 +030045#include <linux/kernel.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070046#include <linux/string.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070047#include <linux/netpoll.h>
Satyam Sharma0bcc1812007-08-10 15:35:05 -070048#include <linux/inet.h>
49#include <linux/configfs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
51MODULE_AUTHOR("Maintainer: Matt Mackall <mpm@selenic.com>");
52MODULE_DESCRIPTION("Console driver for network interfaces");
53MODULE_LICENSE("GPL");
54
Satyam Sharmad39badf2007-08-10 15:27:24 -070055#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);
Niels de Vos61a2d072008-07-31 00:07:23 -070060MODULE_PARM_DESC(netconsole, " netconsole=[src-port]@[src-ip]/[dev],[tgt-port]@<tgt-ip>/[tgt-macaddr]");
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
Amerigo Wangc1a60852012-11-08 03:42:38 +000062static bool oops_only = false;
63module_param(oops_only, bool, 0600);
64MODULE_PARM_DESC(oops_only, "Only log oops messages");
65
Satyam Sharmad2b60882007-08-10 15:29:47 -070066#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
Satyam Sharmab5427c22007-08-10 15:33:40 -070075/* 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
Satyam Sharmadf180e32007-08-10 15:32:14 -070081/**
82 * struct netconsole_target - Represents a configured netconsole target.
Satyam Sharmab5427c22007-08-10 15:33:40 -070083 * @list: Links this target into the target_list.
Satyam Sharma0bcc1812007-08-10 15:35:05 -070084 * @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).
Satyam Sharmadf180e32007-08-10 15:32:14 -070091 * @np: The netpoll structure for this target.
Satyam Sharma0bcc1812007-08-10 15:35:05 -070092 * 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)
Satyam Sharmadf180e32007-08-10 15:32:14 -0700100 */
101struct netconsole_target {
Satyam Sharmab5427c22007-08-10 15:33:40 -0700102 struct list_head list;
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700103#ifdef CONFIG_NETCONSOLE_DYNAMIC
104 struct config_item item;
105#endif
106 int enabled;
Dan Aloni7a163bf2013-08-30 13:59:46 +0300107 struct mutex mutex;
Satyam Sharmadf180e32007-08-10 15:32:14 -0700108 struct netpoll np;
109};
110
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700111#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)
Satyam Sharmab5427c22007-08-10 15:33:40 -0700171{
172 int err = -ENOMEM;
173 struct netconsole_target *nt;
174
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700175 /*
176 * Allocate and initialize with defaults.
177 * Note that these targets get their config_item fields zeroed-out.
178 */
Satyam Sharmab5427c22007-08-10 15:33:40 -0700179 nt = kzalloc(sizeof(*nt), GFP_KERNEL);
Joe Perchese404dec2012-01-29 12:56:23 +0000180 if (!nt)
Satyam Sharmab5427c22007-08-10 15:33:40 -0700181 goto fail;
Satyam Sharmab5427c22007-08-10 15:33:40 -0700182
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;
Dan Aloni7a163bf2013-08-30 13:59:46 +0300187 mutex_init(&nt->mutex);
Satyam Sharmab5427c22007-08-10 15:33:40 -0700188 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
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700199 nt->enabled = 1;
200
Satyam Sharmab5427c22007-08-10 15:33:40 -0700201 return nt;
202
203fail:
204 kfree(nt);
205 return ERR_PTR(err);
206}
207
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700208/* Cleanup netpoll for given target (from boot/module param) and free it */
209static void free_param_target(struct netconsole_target *nt)
Satyam Sharmab5427c22007-08-10 15:33:40 -0700210{
211 netpoll_cleanup(&nt->np);
212 kfree(nt);
213}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700215#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/*
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700252 * 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{
Cong Wangb3d936f2013-01-07 20:52:41 +0000277 if (nt->np.ipv6)
278 return snprintf(buf, PAGE_SIZE, "%pI6c\n", &nt->np.local_ip.in6);
279 else
Cong Wangb7394d22013-01-07 20:52:39 +0000280 return snprintf(buf, PAGE_SIZE, "%pI4\n", &nt->np.local_ip);
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700281}
282
283static ssize_t show_remote_ip(struct netconsole_target *nt, char *buf)
284{
Cong Wangb3d936f2013-01-07 20:52:41 +0000285 if (nt->np.ipv6)
286 return snprintf(buf, PAGE_SIZE, "%pI6c\n", &nt->np.remote_ip.in6);
287 else
Cong Wangb7394d22013-01-07 20:52:39 +0000288 return snprintf(buf, PAGE_SIZE, "%pI4\n", &nt->np.remote_ip);
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700289}
290
291static ssize_t show_local_mac(struct netconsole_target *nt, char *buf)
292{
Stephen Hemminger09538642007-11-19 19:23:29 -0800293 struct net_device *dev = nt->np.dev;
Johannes Berge1749612008-10-27 15:59:26 -0700294 static const u8 bcast[ETH_ALEN] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
Stephen Hemminger09538642007-11-19 19:23:29 -0800295
Johannes Berge1749612008-10-27 15:59:26 -0700296 return snprintf(buf, PAGE_SIZE, "%pM\n", dev ? dev->dev_addr : bcast);
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700297}
298
299static ssize_t show_remote_mac(struct netconsole_target *nt, char *buf)
300{
Johannes Berge1749612008-10-27 15:59:26 -0700301 return snprintf(buf, PAGE_SIZE, "%pM\n", nt->np.remote_mac);
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700302}
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{
Alexey Dobriyan99f823f2011-05-07 20:33:13 +0000315 int enabled;
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700316 int err;
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700317
Alexey Dobriyan99f823f2011-05-07 20:33:13 +0000318 err = kstrtoint(buf, 10, &enabled);
319 if (err < 0)
320 return err;
321 if (enabled < 0 || enabled > 1)
322 return -EINVAL;
Gao fengd5123482011-10-11 16:08:11 +0000323 if (enabled == nt->enabled) {
Joe Perches22ded572013-10-28 12:53:21 -0700324 pr_info("network logging has already %s\n",
325 nt->enabled ? "started" : "stopped");
Gao fengd5123482011-10-11 16:08:11 +0000326 return -EINVAL;
327 }
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700328
Dan Aloni7a163bf2013-08-30 13:59:46 +0300329 mutex_lock(&nt->mutex);
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700330 if (enabled) { /* 1 */
331
332 /*
333 * Skip netpoll_parse_options() -- all the attributes are
334 * already configured via configfs. Just print them out.
335 */
336 netpoll_print_options(&nt->np);
337
338 err = netpoll_setup(&nt->np);
Dan Aloni7a163bf2013-08-30 13:59:46 +0300339 if (err) {
340 mutex_unlock(&nt->mutex);
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700341 return err;
Dan Aloni7a163bf2013-08-30 13:59:46 +0300342 }
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700343
Joe Perches22ded572013-10-28 12:53:21 -0700344 pr_info("network logging started\n");
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700345
346 } else { /* 0 */
347 netpoll_cleanup(&nt->np);
348 }
349
350 nt->enabled = enabled;
Dan Aloni7a163bf2013-08-30 13:59:46 +0300351 mutex_unlock(&nt->mutex);
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700352
353 return strnlen(buf, count);
354}
355
356static ssize_t store_dev_name(struct netconsole_target *nt,
357 const char *buf,
358 size_t count)
359{
360 size_t len;
361
362 if (nt->enabled) {
Joe Perches22ded572013-10-28 12:53:21 -0700363 pr_err("target (%s) is enabled, disable to update parameters\n",
364 config_item_name(&nt->item));
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700365 return -EINVAL;
366 }
367
368 strlcpy(nt->np.dev_name, buf, IFNAMSIZ);
369
370 /* Get rid of possible trailing newline from echo(1) */
371 len = strnlen(nt->np.dev_name, IFNAMSIZ);
372 if (nt->np.dev_name[len - 1] == '\n')
373 nt->np.dev_name[len - 1] = '\0';
374
375 return strnlen(buf, count);
376}
377
378static ssize_t store_local_port(struct netconsole_target *nt,
379 const char *buf,
380 size_t count)
381{
Alexey Dobriyan99f823f2011-05-07 20:33:13 +0000382 int rv;
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700383
384 if (nt->enabled) {
Joe Perches22ded572013-10-28 12:53:21 -0700385 pr_err("target (%s) is enabled, disable to update parameters\n",
386 config_item_name(&nt->item));
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700387 return -EINVAL;
388 }
389
Alexey Dobriyan99f823f2011-05-07 20:33:13 +0000390 rv = kstrtou16(buf, 10, &nt->np.local_port);
391 if (rv < 0)
392 return rv;
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700393 return strnlen(buf, count);
394}
395
396static ssize_t store_remote_port(struct netconsole_target *nt,
397 const char *buf,
398 size_t count)
399{
Alexey Dobriyan99f823f2011-05-07 20:33:13 +0000400 int rv;
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700401
402 if (nt->enabled) {
Joe Perches22ded572013-10-28 12:53:21 -0700403 pr_err("target (%s) is enabled, disable to update parameters\n",
404 config_item_name(&nt->item));
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700405 return -EINVAL;
406 }
407
Alexey Dobriyan99f823f2011-05-07 20:33:13 +0000408 rv = kstrtou16(buf, 10, &nt->np.remote_port);
409 if (rv < 0)
410 return rv;
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700411 return strnlen(buf, count);
412}
413
414static ssize_t store_local_ip(struct netconsole_target *nt,
415 const char *buf,
416 size_t count)
417{
418 if (nt->enabled) {
Joe Perches22ded572013-10-28 12:53:21 -0700419 pr_err("target (%s) is enabled, disable to update parameters\n",
420 config_item_name(&nt->item));
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700421 return -EINVAL;
422 }
423
Cong Wangb3d936f2013-01-07 20:52:41 +0000424 if (strnchr(buf, count, ':')) {
425 const char *end;
426 if (in6_pton(buf, count, nt->np.local_ip.in6.s6_addr, -1, &end) > 0) {
427 if (*end && *end != '\n') {
Joe Perches22ded572013-10-28 12:53:21 -0700428 pr_err("invalid IPv6 address at: <%c>\n", *end);
Cong Wangb3d936f2013-01-07 20:52:41 +0000429 return -EINVAL;
430 }
431 nt->np.ipv6 = true;
432 } else
433 return -EINVAL;
434 } else {
435 if (!nt->np.ipv6) {
436 nt->np.local_ip.ip = in_aton(buf);
437 } else
438 return -EINVAL;
439 }
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700440
441 return strnlen(buf, count);
442}
443
444static ssize_t store_remote_ip(struct netconsole_target *nt,
445 const char *buf,
446 size_t count)
447{
448 if (nt->enabled) {
Joe Perches22ded572013-10-28 12:53:21 -0700449 pr_err("target (%s) is enabled, disable to update parameters\n",
450 config_item_name(&nt->item));
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700451 return -EINVAL;
452 }
453
Cong Wangb3d936f2013-01-07 20:52:41 +0000454 if (strnchr(buf, count, ':')) {
455 const char *end;
456 if (in6_pton(buf, count, nt->np.remote_ip.in6.s6_addr, -1, &end) > 0) {
457 if (*end && *end != '\n') {
Joe Perches22ded572013-10-28 12:53:21 -0700458 pr_err("invalid IPv6 address at: <%c>\n", *end);
Cong Wangb3d936f2013-01-07 20:52:41 +0000459 return -EINVAL;
460 }
461 nt->np.ipv6 = true;
462 } else
463 return -EINVAL;
464 } else {
465 if (!nt->np.ipv6) {
466 nt->np.remote_ip.ip = in_aton(buf);
467 } else
468 return -EINVAL;
469 }
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700470
471 return strnlen(buf, count);
472}
473
474static ssize_t store_remote_mac(struct netconsole_target *nt,
475 const char *buf,
476 size_t count)
477{
478 u8 remote_mac[ETH_ALEN];
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700479
480 if (nt->enabled) {
Joe Perches22ded572013-10-28 12:53:21 -0700481 pr_err("target (%s) is enabled, disable to update parameters\n",
482 config_item_name(&nt->item));
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700483 return -EINVAL;
484 }
485
Alexey Dobriyan4940fc82011-05-07 23:00:07 +0000486 if (!mac_pton(buf, remote_mac))
487 return -EINVAL;
488 if (buf[3 * ETH_ALEN - 1] && buf[3 * ETH_ALEN - 1] != '\n')
489 return -EINVAL;
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700490 memcpy(nt->np.remote_mac, remote_mac, ETH_ALEN);
491
492 return strnlen(buf, count);
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700493}
494
495/*
496 * Attribute definitions for netconsole_target.
497 */
498
499#define NETCONSOLE_TARGET_ATTR_RO(_name) \
500static struct netconsole_target_attr netconsole_target_##_name = \
501 __CONFIGFS_ATTR(_name, S_IRUGO, show_##_name, NULL)
502
503#define NETCONSOLE_TARGET_ATTR_RW(_name) \
504static struct netconsole_target_attr netconsole_target_##_name = \
505 __CONFIGFS_ATTR(_name, S_IRUGO | S_IWUSR, show_##_name, store_##_name)
506
507NETCONSOLE_TARGET_ATTR_RW(enabled);
508NETCONSOLE_TARGET_ATTR_RW(dev_name);
509NETCONSOLE_TARGET_ATTR_RW(local_port);
510NETCONSOLE_TARGET_ATTR_RW(remote_port);
511NETCONSOLE_TARGET_ATTR_RW(local_ip);
512NETCONSOLE_TARGET_ATTR_RW(remote_ip);
513NETCONSOLE_TARGET_ATTR_RO(local_mac);
514NETCONSOLE_TARGET_ATTR_RW(remote_mac);
515
516static struct configfs_attribute *netconsole_target_attrs[] = {
517 &netconsole_target_enabled.attr,
518 &netconsole_target_dev_name.attr,
519 &netconsole_target_local_port.attr,
520 &netconsole_target_remote_port.attr,
521 &netconsole_target_local_ip.attr,
522 &netconsole_target_remote_ip.attr,
523 &netconsole_target_local_mac.attr,
524 &netconsole_target_remote_mac.attr,
525 NULL,
526};
527
528/*
529 * Item operations and type for netconsole_target.
530 */
531
532static void netconsole_target_release(struct config_item *item)
533{
534 kfree(to_target(item));
535}
536
537static ssize_t netconsole_target_attr_show(struct config_item *item,
538 struct configfs_attribute *attr,
539 char *buf)
540{
541 ssize_t ret = -EINVAL;
542 struct netconsole_target *nt = to_target(item);
543 struct netconsole_target_attr *na =
544 container_of(attr, struct netconsole_target_attr, attr);
545
546 if (na->show)
547 ret = na->show(nt, buf);
548
549 return ret;
550}
551
552static ssize_t netconsole_target_attr_store(struct config_item *item,
553 struct configfs_attribute *attr,
554 const char *buf,
555 size_t count)
556{
557 ssize_t ret = -EINVAL;
558 struct netconsole_target *nt = to_target(item);
559 struct netconsole_target_attr *na =
560 container_of(attr, struct netconsole_target_attr, attr);
561
562 if (na->store)
563 ret = na->store(nt, buf, count);
564
565 return ret;
566}
567
568static struct configfs_item_operations netconsole_target_item_ops = {
569 .release = netconsole_target_release,
570 .show_attribute = netconsole_target_attr_show,
571 .store_attribute = netconsole_target_attr_store,
572};
573
574static struct config_item_type netconsole_target_type = {
575 .ct_attrs = netconsole_target_attrs,
576 .ct_item_ops = &netconsole_target_item_ops,
577 .ct_owner = THIS_MODULE,
578};
579
580/*
581 * Group operations and type for netconsole_subsys.
582 */
583
Joel Beckerf89ab862008-07-17 14:53:48 -0700584static struct config_item *make_netconsole_target(struct config_group *group,
585 const char *name)
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700586{
587 unsigned long flags;
588 struct netconsole_target *nt;
589
590 /*
591 * Allocate and initialize with defaults.
592 * Target is disabled at creation (enabled == 0).
593 */
594 nt = kzalloc(sizeof(*nt), GFP_KERNEL);
Joe Perchese404dec2012-01-29 12:56:23 +0000595 if (!nt)
Joel Beckera6795e92008-07-17 15:21:29 -0700596 return ERR_PTR(-ENOMEM);
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700597
598 nt->np.name = "netconsole";
599 strlcpy(nt->np.dev_name, "eth0", IFNAMSIZ);
600 nt->np.local_port = 6665;
601 nt->np.remote_port = 6666;
Dan Aloni7a163bf2013-08-30 13:59:46 +0300602 mutex_init(&nt->mutex);
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700603 memset(nt->np.remote_mac, 0xff, ETH_ALEN);
604
605 /* Initialize the config_item member */
606 config_item_init_type_name(&nt->item, name, &netconsole_target_type);
607
608 /* Adding, but it is disabled */
609 spin_lock_irqsave(&target_list_lock, flags);
610 list_add(&nt->list, &target_list);
611 spin_unlock_irqrestore(&target_list_lock, flags);
612
Joel Beckerf89ab862008-07-17 14:53:48 -0700613 return &nt->item;
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700614}
615
616static void drop_netconsole_target(struct config_group *group,
617 struct config_item *item)
618{
619 unsigned long flags;
620 struct netconsole_target *nt = to_target(item);
621
622 spin_lock_irqsave(&target_list_lock, flags);
623 list_del(&nt->list);
624 spin_unlock_irqrestore(&target_list_lock, flags);
625
626 /*
627 * The target may have never been enabled, or was manually disabled
628 * before being removed so netpoll may have already been cleaned up.
629 */
630 if (nt->enabled)
631 netpoll_cleanup(&nt->np);
632
633 config_item_put(&nt->item);
634}
635
636static struct configfs_group_operations netconsole_subsys_group_ops = {
637 .make_item = make_netconsole_target,
638 .drop_item = drop_netconsole_target,
639};
640
641static struct config_item_type netconsole_subsys_type = {
642 .ct_group_ops = &netconsole_subsys_group_ops,
643 .ct_owner = THIS_MODULE,
644};
645
646/* The netconsole configfs subsystem */
647static struct configfs_subsystem netconsole_subsys = {
648 .su_group = {
649 .cg_item = {
650 .ci_namebuf = "netconsole",
651 .ci_type = &netconsole_subsys_type,
652 },
653 },
654};
655
656#endif /* CONFIG_NETCONSOLE_DYNAMIC */
657
Satyam Sharma17951f32007-08-10 15:33:01 -0700658/* Handle network interface device notifications */
659static int netconsole_netdev_event(struct notifier_block *this,
Jiri Pirko351638e2013-05-28 01:30:21 +0000660 unsigned long event, void *ptr)
Satyam Sharma17951f32007-08-10 15:33:01 -0700661{
Satyam Sharmab5427c22007-08-10 15:33:40 -0700662 unsigned long flags;
663 struct netconsole_target *nt;
Jiri Pirko351638e2013-05-28 01:30:21 +0000664 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
Ferenc Wagner141dfba2011-01-06 05:11:19 +0000665 bool stopped = false;
Satyam Sharma17951f32007-08-10 15:33:01 -0700666
WANG Cong0e34e932010-05-06 00:47:21 -0700667 if (!(event == NETDEV_CHANGENAME || event == NETDEV_UNREGISTER ||
Amerigo Wangdaf92092011-05-19 21:39:12 +0000668 event == NETDEV_RELEASE || event == NETDEV_JOIN))
Satyam Sharmab5427c22007-08-10 15:33:40 -0700669 goto done;
Satyam Sharma17951f32007-08-10 15:33:01 -0700670
Satyam Sharmab5427c22007-08-10 15:33:40 -0700671 spin_lock_irqsave(&target_list_lock, flags);
Veaceslav Falico3f315be2013-03-11 00:21:48 +0000672restart:
Satyam Sharmab5427c22007-08-10 15:33:40 -0700673 list_for_each_entry(nt, &target_list, list) {
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700674 netconsole_target_get(nt);
Satyam Sharmab5427c22007-08-10 15:33:40 -0700675 if (nt->np.dev == dev) {
676 switch (event) {
Satyam Sharmab5427c22007-08-10 15:33:40 -0700677 case NETDEV_CHANGENAME:
678 strlcpy(nt->np.dev_name, dev->name, IFNAMSIZ);
679 break;
Amerigo Wangdaf92092011-05-19 21:39:12 +0000680 case NETDEV_RELEASE:
Amerigo Wang8d8fc292011-05-19 21:39:10 +0000681 case NETDEV_JOIN:
Bruno Prémont2382b152009-04-29 20:45:17 +0000682 case NETDEV_UNREGISTER:
Nikolay Aleksandrovc71380f2013-09-19 15:02:36 +0200683 /* rtnl_lock already held
Veaceslav Falico3f315be2013-03-11 00:21:48 +0000684 * we might sleep in __netpoll_cleanup()
Neil Horman3b410a32010-10-13 16:01:52 +0000685 */
Veaceslav Falico3f315be2013-03-11 00:21:48 +0000686 spin_unlock_irqrestore(&target_list_lock, flags);
Dan Aloni7a163bf2013-08-30 13:59:46 +0300687
Veaceslav Falico3f315be2013-03-11 00:21:48 +0000688 __netpoll_cleanup(&nt->np);
Dan Aloni7a163bf2013-08-30 13:59:46 +0300689
Veaceslav Falico3f315be2013-03-11 00:21:48 +0000690 spin_lock_irqsave(&target_list_lock, flags);
691 dev_put(nt->np.dev);
692 nt->np.dev = NULL;
Bruno Prémont2382b152009-04-29 20:45:17 +0000693 nt->enabled = 0;
Ferenc Wagner141dfba2011-01-06 05:11:19 +0000694 stopped = true;
Veaceslav Falico3f315be2013-03-11 00:21:48 +0000695 netconsole_target_put(nt);
696 goto restart;
Satyam Sharmab5427c22007-08-10 15:33:40 -0700697 }
Satyam Sharma17951f32007-08-10 15:33:01 -0700698 }
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700699 netconsole_target_put(nt);
Satyam Sharma17951f32007-08-10 15:33:01 -0700700 }
Satyam Sharmab5427c22007-08-10 15:33:40 -0700701 spin_unlock_irqrestore(&target_list_lock, flags);
Amerigo Wang8d8fc292011-05-19 21:39:10 +0000702 if (stopped) {
Joe Perches22ded572013-10-28 12:53:21 -0700703 const char *msg = "had an event";
Amerigo Wang8d8fc292011-05-19 21:39:10 +0000704 switch (event) {
705 case NETDEV_UNREGISTER:
Joe Perches22ded572013-10-28 12:53:21 -0700706 msg = "unregistered";
Amerigo Wang8d8fc292011-05-19 21:39:10 +0000707 break;
Amerigo Wangdaf92092011-05-19 21:39:12 +0000708 case NETDEV_RELEASE:
Joe Perches22ded572013-10-28 12:53:21 -0700709 msg = "released slaves";
Amerigo Wang8d8fc292011-05-19 21:39:10 +0000710 break;
711 case NETDEV_JOIN:
Joe Perches22ded572013-10-28 12:53:21 -0700712 msg = "is joining a master device";
Amerigo Wang8d8fc292011-05-19 21:39:10 +0000713 break;
714 }
Joe Perches22ded572013-10-28 12:53:21 -0700715 pr_info("network logging stopped on interface %s as it %s\n",
716 dev->name, msg);
Amerigo Wang8d8fc292011-05-19 21:39:10 +0000717 }
Satyam Sharma17951f32007-08-10 15:33:01 -0700718
Satyam Sharmab5427c22007-08-10 15:33:40 -0700719done:
Satyam Sharma17951f32007-08-10 15:33:01 -0700720 return NOTIFY_DONE;
721}
722
723static struct notifier_block netconsole_netdev_notifier = {
724 .notifier_call = netconsole_netdev_event,
725};
726
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727static void write_msg(struct console *con, const char *msg, unsigned int len)
728{
729 int frag, left;
730 unsigned long flags;
Satyam Sharmab5427c22007-08-10 15:33:40 -0700731 struct netconsole_target *nt;
732 const char *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733
Amerigo Wangc1a60852012-11-08 03:42:38 +0000734 if (oops_only && !oops_in_progress)
735 return;
Satyam Sharmab5427c22007-08-10 15:33:40 -0700736 /* Avoid taking lock and disabling interrupts unnecessarily */
737 if (list_empty(&target_list))
738 return;
739
740 spin_lock_irqsave(&target_list_lock, flags);
741 list_for_each_entry(nt, &target_list, list) {
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700742 netconsole_target_get(nt);
743 if (nt->enabled && netif_running(nt->np.dev)) {
Satyam Sharmab5427c22007-08-10 15:33:40 -0700744 /*
745 * We nest this inside the for-each-target loop above
746 * so that we're able to get as much logging out to
747 * at least one target if we die inside here, instead
748 * of unnecessarily keeping all targets in lock-step.
749 */
750 tmp = msg;
751 for (left = len; left;) {
752 frag = min(left, MAX_PRINT_CHUNK);
753 netpoll_send_udp(&nt->np, tmp, frag);
754 tmp += frag;
755 left -= frag;
756 }
Satyam Sharma0cc120b2007-08-10 15:30:31 -0700757 }
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700758 netconsole_target_put(nt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 }
Satyam Sharmab5427c22007-08-10 15:33:40 -0700760 spin_unlock_irqrestore(&target_list_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761}
762
763static struct console netconsole = {
Satyam Sharmad39badf2007-08-10 15:27:24 -0700764 .name = "netcon",
Michael Ellerman0517dee2008-04-15 00:49:04 -0700765 .flags = CON_ENABLED,
Satyam Sharmad39badf2007-08-10 15:27:24 -0700766 .write = write_msg,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767};
768
Satyam Sharmad39badf2007-08-10 15:27:24 -0700769static int __init init_netconsole(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770{
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700771 int err;
Satyam Sharmab5427c22007-08-10 15:33:40 -0700772 struct netconsole_target *nt, *tmp;
773 unsigned long flags;
774 char *target_config;
775 char *input = config;
Stephen Hemmingerb41848b2006-10-26 15:46:52 -0700776
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700777 if (strnlen(input, MAX_PARAM_LENGTH)) {
778 while ((target_config = strsep(&input, ";"))) {
779 nt = alloc_param_target(target_config);
780 if (IS_ERR(nt)) {
781 err = PTR_ERR(nt);
782 goto fail;
783 }
Michael Ellerman0517dee2008-04-15 00:49:04 -0700784 /* Dump existing printks when we register */
785 netconsole.flags |= CON_PRINTBUFFER;
786
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700787 spin_lock_irqsave(&target_list_lock, flags);
788 list_add(&nt->list, &target_list);
789 spin_unlock_irqrestore(&target_list_lock, flags);
Satyam Sharmab5427c22007-08-10 15:33:40 -0700790 }
Satyam Sharmab5427c22007-08-10 15:33:40 -0700791 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792
Satyam Sharma17951f32007-08-10 15:33:01 -0700793 err = register_netdevice_notifier(&netconsole_netdev_notifier);
794 if (err)
Satyam Sharmab5427c22007-08-10 15:33:40 -0700795 goto fail;
Satyam Sharma17951f32007-08-10 15:33:01 -0700796
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700797 err = dynamic_netconsole_init();
798 if (err)
799 goto undonotifier;
800
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801 register_console(&netconsole);
Joe Perches22ded572013-10-28 12:53:21 -0700802 pr_info("network logging started\n");
Satyam Sharmad39badf2007-08-10 15:27:24 -0700803
Satyam Sharmad39badf2007-08-10 15:27:24 -0700804 return err;
Satyam Sharmab5427c22007-08-10 15:33:40 -0700805
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700806undonotifier:
807 unregister_netdevice_notifier(&netconsole_netdev_notifier);
808
Satyam Sharmab5427c22007-08-10 15:33:40 -0700809fail:
Joe Perches22ded572013-10-28 12:53:21 -0700810 pr_err("cleaning up\n");
Satyam Sharmab5427c22007-08-10 15:33:40 -0700811
812 /*
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700813 * Remove all targets and destroy them (only targets created
814 * from the boot/module option exist here). Skipping the list
Satyam Sharmab5427c22007-08-10 15:33:40 -0700815 * lock is safe here, and netpoll_cleanup() will sleep.
816 */
817 list_for_each_entry_safe(nt, tmp, &target_list, list) {
818 list_del(&nt->list);
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700819 free_param_target(nt);
Satyam Sharmab5427c22007-08-10 15:33:40 -0700820 }
821
822 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823}
824
Satyam Sharmad39badf2007-08-10 15:27:24 -0700825static void __exit cleanup_netconsole(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826{
Satyam Sharmab5427c22007-08-10 15:33:40 -0700827 struct netconsole_target *nt, *tmp;
Satyam Sharmadf180e32007-08-10 15:32:14 -0700828
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 unregister_console(&netconsole);
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700830 dynamic_netconsole_exit();
Satyam Sharma17951f32007-08-10 15:33:01 -0700831 unregister_netdevice_notifier(&netconsole_netdev_notifier);
Satyam Sharmab5427c22007-08-10 15:33:40 -0700832
833 /*
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700834 * Targets created via configfs pin references on our module
835 * and would first be rmdir(2)'ed from userspace. We reach
836 * here only when they are already destroyed, and only those
837 * created from the boot/module option are left, so remove and
838 * destroy them. Skipping the list lock is safe here, and
839 * netpoll_cleanup() will sleep.
Satyam Sharmab5427c22007-08-10 15:33:40 -0700840 */
841 list_for_each_entry_safe(nt, tmp, &target_list, list) {
842 list_del(&nt->list);
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700843 free_param_target(nt);
Satyam Sharmab5427c22007-08-10 15:33:40 -0700844 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845}
846
Lin Ming97c7de02011-09-20 15:45:07 -0400847/*
848 * Use late_initcall to ensure netconsole is
849 * initialized after network device driver if built-in.
850 *
851 * late_initcall() and module_init() are identical if built as module.
852 */
853late_initcall(init_netconsole);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854module_exit(cleanup_netconsole);