blob: 1505dcb950fa57b44c97dcfe583ffe3fb3d1559d [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
37#include <linux/mm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070038#include <linux/init.h>
39#include <linux/module.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090040#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070041#include <linux/console.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070042#include <linux/moduleparam.h>
Andy Shevchenko4cd57732013-06-04 19:46:26 +030043#include <linux/kernel.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#include <linux/string.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#include <linux/netpoll.h>
Satyam Sharma0bcc1812007-08-10 15:35:05 -070046#include <linux/inet.h>
47#include <linux/configfs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070048
49MODULE_AUTHOR("Maintainer: Matt Mackall <mpm@selenic.com>");
50MODULE_DESCRIPTION("Console driver for network interfaces");
51MODULE_LICENSE("GPL");
52
Satyam Sharmad39badf2007-08-10 15:27:24 -070053#define MAX_PARAM_LENGTH 256
54#define MAX_PRINT_CHUNK 1000
55
56static char config[MAX_PARAM_LENGTH];
57module_param_string(netconsole, config, MAX_PARAM_LENGTH, 0);
Niels de Vos61a2d072008-07-31 00:07:23 -070058MODULE_PARM_DESC(netconsole, " netconsole=[src-port]@[src-ip]/[dev],[tgt-port]@<tgt-ip>/[tgt-macaddr]");
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
Amerigo Wangc1a60852012-11-08 03:42:38 +000060static bool oops_only = false;
61module_param(oops_only, bool, 0600);
62MODULE_PARM_DESC(oops_only, "Only log oops messages");
63
Satyam Sharmad2b60882007-08-10 15:29:47 -070064#ifndef MODULE
65static int __init option_setup(char *opt)
66{
67 strlcpy(config, opt, MAX_PARAM_LENGTH);
68 return 1;
69}
70__setup("netconsole=", option_setup);
71#endif /* MODULE */
72
Satyam Sharmab5427c22007-08-10 15:33:40 -070073/* 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
Satyam Sharmadf180e32007-08-10 15:32:14 -070079/**
80 * struct netconsole_target - Represents a configured netconsole target.
Satyam Sharmab5427c22007-08-10 15:33:40 -070081 * @list: Links this target into the target_list.
Satyam Sharma0bcc1812007-08-10 15:35:05 -070082 * @item: Links us into the configfs subsystem hierarchy.
83 * @enabled: On / off knob to enable / disable target.
84 * Visible from userspace (read-write).
85 * We maintain a strict 1:1 correspondence between this and
86 * whether the corresponding netpoll is active or inactive.
87 * Also, other parameters of a target may be modified at
88 * runtime only when it is disabled (enabled == 0).
Satyam Sharmadf180e32007-08-10 15:32:14 -070089 * @np: The netpoll structure for this target.
Satyam Sharma0bcc1812007-08-10 15:35:05 -070090 * Contains the other userspace visible parameters:
91 * dev_name (read-write)
92 * local_port (read-write)
93 * remote_port (read-write)
94 * local_ip (read-write)
95 * remote_ip (read-write)
96 * local_mac (read-only)
97 * remote_mac (read-write)
Satyam Sharmadf180e32007-08-10 15:32:14 -070098 */
99struct netconsole_target {
Satyam Sharmab5427c22007-08-10 15:33:40 -0700100 struct list_head list;
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700101#ifdef CONFIG_NETCONSOLE_DYNAMIC
102 struct config_item item;
103#endif
104 int enabled;
Dan Aloni7a163bf2013-08-30 13:59:46 +0300105 struct mutex mutex;
Satyam Sharmadf180e32007-08-10 15:32:14 -0700106 struct netpoll np;
107};
108
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700109#ifdef CONFIG_NETCONSOLE_DYNAMIC
110
111static struct configfs_subsystem netconsole_subsys;
112
113static int __init dynamic_netconsole_init(void)
114{
115 config_group_init(&netconsole_subsys.su_group);
116 mutex_init(&netconsole_subsys.su_mutex);
117 return configfs_register_subsystem(&netconsole_subsys);
118}
119
120static void __exit dynamic_netconsole_exit(void)
121{
122 configfs_unregister_subsystem(&netconsole_subsys);
123}
124
125/*
126 * Targets that were created by parsing the boot/module option string
127 * do not exist in the configfs hierarchy (and have NULL names) and will
128 * never go away, so make these a no-op for them.
129 */
130static void netconsole_target_get(struct netconsole_target *nt)
131{
132 if (config_item_name(&nt->item))
133 config_item_get(&nt->item);
134}
135
136static void netconsole_target_put(struct netconsole_target *nt)
137{
138 if (config_item_name(&nt->item))
139 config_item_put(&nt->item);
140}
141
142#else /* !CONFIG_NETCONSOLE_DYNAMIC */
143
144static int __init dynamic_netconsole_init(void)
145{
146 return 0;
147}
148
149static void __exit dynamic_netconsole_exit(void)
150{
151}
152
153/*
154 * No danger of targets going away from under us when dynamic
155 * reconfigurability is off.
156 */
157static void netconsole_target_get(struct netconsole_target *nt)
158{
159}
160
161static void netconsole_target_put(struct netconsole_target *nt)
162{
163}
164
165#endif /* CONFIG_NETCONSOLE_DYNAMIC */
166
167/* Allocate new target (from boot/module param) and setup netpoll for it */
168static struct netconsole_target *alloc_param_target(char *target_config)
Satyam Sharmab5427c22007-08-10 15:33:40 -0700169{
170 int err = -ENOMEM;
171 struct netconsole_target *nt;
172
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700173 /*
174 * Allocate and initialize with defaults.
175 * Note that these targets get their config_item fields zeroed-out.
176 */
Satyam Sharmab5427c22007-08-10 15:33:40 -0700177 nt = kzalloc(sizeof(*nt), GFP_KERNEL);
Joe Perchese404dec2012-01-29 12:56:23 +0000178 if (!nt)
Satyam Sharmab5427c22007-08-10 15:33:40 -0700179 goto fail;
Satyam Sharmab5427c22007-08-10 15:33:40 -0700180
181 nt->np.name = "netconsole";
182 strlcpy(nt->np.dev_name, "eth0", IFNAMSIZ);
183 nt->np.local_port = 6665;
184 nt->np.remote_port = 6666;
Dan Aloni7a163bf2013-08-30 13:59:46 +0300185 mutex_init(&nt->mutex);
Satyam Sharmab5427c22007-08-10 15:33:40 -0700186 memset(nt->np.remote_mac, 0xff, ETH_ALEN);
187
188 /* Parse parameters and setup netpoll */
189 err = netpoll_parse_options(&nt->np, target_config);
190 if (err)
191 goto fail;
192
193 err = netpoll_setup(&nt->np);
194 if (err)
195 goto fail;
196
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700197 nt->enabled = 1;
198
Satyam Sharmab5427c22007-08-10 15:33:40 -0700199 return nt;
200
201fail:
202 kfree(nt);
203 return ERR_PTR(err);
204}
205
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700206/* Cleanup netpoll for given target (from boot/module param) and free it */
207static void free_param_target(struct netconsole_target *nt)
Satyam Sharmab5427c22007-08-10 15:33:40 -0700208{
209 netpoll_cleanup(&nt->np);
210 kfree(nt);
211}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700213#ifdef CONFIG_NETCONSOLE_DYNAMIC
214
215/*
216 * Our subsystem hierarchy is:
217 *
218 * /sys/kernel/config/netconsole/
219 * |
220 * <target>/
221 * | enabled
222 * | dev_name
223 * | local_port
224 * | remote_port
225 * | local_ip
226 * | remote_ip
227 * | local_mac
228 * | remote_mac
229 * |
230 * <target>/...
231 */
232
233struct netconsole_target_attr {
234 struct configfs_attribute attr;
235 ssize_t (*show)(struct netconsole_target *nt,
236 char *buf);
237 ssize_t (*store)(struct netconsole_target *nt,
238 const char *buf,
239 size_t count);
240};
241
242static struct netconsole_target *to_target(struct config_item *item)
243{
244 return item ?
245 container_of(item, struct netconsole_target, item) :
246 NULL;
247}
248
249/*
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700250 * Attribute operations for netconsole_target.
251 */
252
253static ssize_t show_enabled(struct netconsole_target *nt, char *buf)
254{
255 return snprintf(buf, PAGE_SIZE, "%d\n", nt->enabled);
256}
257
258static ssize_t show_dev_name(struct netconsole_target *nt, char *buf)
259{
260 return snprintf(buf, PAGE_SIZE, "%s\n", nt->np.dev_name);
261}
262
263static ssize_t show_local_port(struct netconsole_target *nt, char *buf)
264{
265 return snprintf(buf, PAGE_SIZE, "%d\n", nt->np.local_port);
266}
267
268static ssize_t show_remote_port(struct netconsole_target *nt, char *buf)
269{
270 return snprintf(buf, PAGE_SIZE, "%d\n", nt->np.remote_port);
271}
272
273static ssize_t show_local_ip(struct netconsole_target *nt, char *buf)
274{
Cong Wangb3d936f2013-01-07 20:52:41 +0000275 if (nt->np.ipv6)
276 return snprintf(buf, PAGE_SIZE, "%pI6c\n", &nt->np.local_ip.in6);
277 else
Cong Wangb7394d22013-01-07 20:52:39 +0000278 return snprintf(buf, PAGE_SIZE, "%pI4\n", &nt->np.local_ip);
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700279}
280
281static ssize_t show_remote_ip(struct netconsole_target *nt, char *buf)
282{
Cong Wangb3d936f2013-01-07 20:52:41 +0000283 if (nt->np.ipv6)
284 return snprintf(buf, PAGE_SIZE, "%pI6c\n", &nt->np.remote_ip.in6);
285 else
Cong Wangb7394d22013-01-07 20:52:39 +0000286 return snprintf(buf, PAGE_SIZE, "%pI4\n", &nt->np.remote_ip);
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700287}
288
289static ssize_t show_local_mac(struct netconsole_target *nt, char *buf)
290{
Stephen Hemminger09538642007-11-19 19:23:29 -0800291 struct net_device *dev = nt->np.dev;
Johannes Berge1749612008-10-27 15:59:26 -0700292 static const u8 bcast[ETH_ALEN] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
Stephen Hemminger09538642007-11-19 19:23:29 -0800293
Johannes Berge1749612008-10-27 15:59:26 -0700294 return snprintf(buf, PAGE_SIZE, "%pM\n", dev ? dev->dev_addr : bcast);
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700295}
296
297static ssize_t show_remote_mac(struct netconsole_target *nt, char *buf)
298{
Johannes Berge1749612008-10-27 15:59:26 -0700299 return snprintf(buf, PAGE_SIZE, "%pM\n", nt->np.remote_mac);
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700300}
301
302/*
303 * This one is special -- targets created through the configfs interface
304 * are not enabled (and the corresponding netpoll activated) by default.
305 * The user is expected to set the desired parameters first (which
306 * would enable him to dynamically add new netpoll targets for new
307 * network interfaces as and when they come up).
308 */
309static ssize_t store_enabled(struct netconsole_target *nt,
310 const char *buf,
311 size_t count)
312{
Nikolay Aleksandrov45e526e2013-10-23 15:04:49 +0200313 unsigned long flags;
Alexey Dobriyan99f823f2011-05-07 20:33:13 +0000314 int enabled;
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700315 int err;
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700316
Alexey Dobriyan99f823f2011-05-07 20:33:13 +0000317 err = kstrtoint(buf, 10, &enabled);
318 if (err < 0)
319 return err;
320 if (enabled < 0 || enabled > 1)
321 return -EINVAL;
Gao fengd5123482011-10-11 16:08:11 +0000322 if (enabled == nt->enabled) {
323 printk(KERN_INFO "netconsole: network logging has already %s\n",
324 nt->enabled ? "started" : "stopped");
325 return -EINVAL;
326 }
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700327
Dan Aloni7a163bf2013-08-30 13:59:46 +0300328 mutex_lock(&nt->mutex);
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700329 if (enabled) { /* 1 */
330
331 /*
332 * Skip netpoll_parse_options() -- all the attributes are
333 * already configured via configfs. Just print them out.
334 */
335 netpoll_print_options(&nt->np);
336
337 err = netpoll_setup(&nt->np);
Dan Aloni7a163bf2013-08-30 13:59:46 +0300338 if (err) {
339 mutex_unlock(&nt->mutex);
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700340 return err;
Dan Aloni7a163bf2013-08-30 13:59:46 +0300341 }
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700342
343 printk(KERN_INFO "netconsole: network logging started\n");
344
345 } else { /* 0 */
Nikolay Aleksandrov45e526e2013-10-23 15:04:49 +0200346 /* We need to disable the netconsole before cleaning it up
347 * otherwise we might end up in write_msg() with
348 * nt->np.dev == NULL and nt->enabled == 1
349 */
350 spin_lock_irqsave(&target_list_lock, flags);
351 nt->enabled = 0;
352 spin_unlock_irqrestore(&target_list_lock, flags);
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700353 netpoll_cleanup(&nt->np);
354 }
355
356 nt->enabled = enabled;
Dan Aloni7a163bf2013-08-30 13:59:46 +0300357 mutex_unlock(&nt->mutex);
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700358
359 return strnlen(buf, count);
360}
361
362static ssize_t store_dev_name(struct netconsole_target *nt,
363 const char *buf,
364 size_t count)
365{
366 size_t len;
367
368 if (nt->enabled) {
369 printk(KERN_ERR "netconsole: target (%s) is enabled, "
370 "disable to update parameters\n",
371 config_item_name(&nt->item));
372 return -EINVAL;
373 }
374
375 strlcpy(nt->np.dev_name, buf, IFNAMSIZ);
376
377 /* Get rid of possible trailing newline from echo(1) */
378 len = strnlen(nt->np.dev_name, IFNAMSIZ);
379 if (nt->np.dev_name[len - 1] == '\n')
380 nt->np.dev_name[len - 1] = '\0';
381
382 return strnlen(buf, count);
383}
384
385static ssize_t store_local_port(struct netconsole_target *nt,
386 const char *buf,
387 size_t count)
388{
Alexey Dobriyan99f823f2011-05-07 20:33:13 +0000389 int rv;
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700390
391 if (nt->enabled) {
392 printk(KERN_ERR "netconsole: target (%s) is enabled, "
393 "disable to update parameters\n",
394 config_item_name(&nt->item));
395 return -EINVAL;
396 }
397
Alexey Dobriyan99f823f2011-05-07 20:33:13 +0000398 rv = kstrtou16(buf, 10, &nt->np.local_port);
399 if (rv < 0)
400 return rv;
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700401 return strnlen(buf, count);
402}
403
404static ssize_t store_remote_port(struct netconsole_target *nt,
405 const char *buf,
406 size_t count)
407{
Alexey Dobriyan99f823f2011-05-07 20:33:13 +0000408 int rv;
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700409
410 if (nt->enabled) {
411 printk(KERN_ERR "netconsole: target (%s) is enabled, "
412 "disable to update parameters\n",
413 config_item_name(&nt->item));
414 return -EINVAL;
415 }
416
Alexey Dobriyan99f823f2011-05-07 20:33:13 +0000417 rv = kstrtou16(buf, 10, &nt->np.remote_port);
418 if (rv < 0)
419 return rv;
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700420 return strnlen(buf, count);
421}
422
423static ssize_t store_local_ip(struct netconsole_target *nt,
424 const char *buf,
425 size_t count)
426{
427 if (nt->enabled) {
428 printk(KERN_ERR "netconsole: target (%s) is enabled, "
429 "disable to update parameters\n",
430 config_item_name(&nt->item));
431 return -EINVAL;
432 }
433
Cong Wangb3d936f2013-01-07 20:52:41 +0000434 if (strnchr(buf, count, ':')) {
435 const char *end;
436 if (in6_pton(buf, count, nt->np.local_ip.in6.s6_addr, -1, &end) > 0) {
437 if (*end && *end != '\n') {
438 printk(KERN_ERR "netconsole: invalid IPv6 address at: <%c>\n", *end);
439 return -EINVAL;
440 }
441 nt->np.ipv6 = true;
442 } else
443 return -EINVAL;
444 } else {
445 if (!nt->np.ipv6) {
446 nt->np.local_ip.ip = in_aton(buf);
447 } else
448 return -EINVAL;
449 }
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700450
451 return strnlen(buf, count);
452}
453
454static ssize_t store_remote_ip(struct netconsole_target *nt,
455 const char *buf,
456 size_t count)
457{
458 if (nt->enabled) {
459 printk(KERN_ERR "netconsole: target (%s) is enabled, "
460 "disable to update parameters\n",
461 config_item_name(&nt->item));
462 return -EINVAL;
463 }
464
Cong Wangb3d936f2013-01-07 20:52:41 +0000465 if (strnchr(buf, count, ':')) {
466 const char *end;
467 if (in6_pton(buf, count, nt->np.remote_ip.in6.s6_addr, -1, &end) > 0) {
468 if (*end && *end != '\n') {
469 printk(KERN_ERR "netconsole: invalid IPv6 address at: <%c>\n", *end);
470 return -EINVAL;
471 }
472 nt->np.ipv6 = true;
473 } else
474 return -EINVAL;
475 } else {
476 if (!nt->np.ipv6) {
477 nt->np.remote_ip.ip = in_aton(buf);
478 } else
479 return -EINVAL;
480 }
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700481
482 return strnlen(buf, count);
483}
484
485static ssize_t store_remote_mac(struct netconsole_target *nt,
486 const char *buf,
487 size_t count)
488{
489 u8 remote_mac[ETH_ALEN];
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700490
491 if (nt->enabled) {
492 printk(KERN_ERR "netconsole: target (%s) is enabled, "
493 "disable to update parameters\n",
494 config_item_name(&nt->item));
495 return -EINVAL;
496 }
497
Alexey Dobriyan4940fc82011-05-07 23:00:07 +0000498 if (!mac_pton(buf, remote_mac))
499 return -EINVAL;
500 if (buf[3 * ETH_ALEN - 1] && buf[3 * ETH_ALEN - 1] != '\n')
501 return -EINVAL;
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700502 memcpy(nt->np.remote_mac, remote_mac, ETH_ALEN);
503
504 return strnlen(buf, count);
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700505}
506
507/*
508 * Attribute definitions for netconsole_target.
509 */
510
511#define NETCONSOLE_TARGET_ATTR_RO(_name) \
512static struct netconsole_target_attr netconsole_target_##_name = \
513 __CONFIGFS_ATTR(_name, S_IRUGO, show_##_name, NULL)
514
515#define NETCONSOLE_TARGET_ATTR_RW(_name) \
516static struct netconsole_target_attr netconsole_target_##_name = \
517 __CONFIGFS_ATTR(_name, S_IRUGO | S_IWUSR, show_##_name, store_##_name)
518
519NETCONSOLE_TARGET_ATTR_RW(enabled);
520NETCONSOLE_TARGET_ATTR_RW(dev_name);
521NETCONSOLE_TARGET_ATTR_RW(local_port);
522NETCONSOLE_TARGET_ATTR_RW(remote_port);
523NETCONSOLE_TARGET_ATTR_RW(local_ip);
524NETCONSOLE_TARGET_ATTR_RW(remote_ip);
525NETCONSOLE_TARGET_ATTR_RO(local_mac);
526NETCONSOLE_TARGET_ATTR_RW(remote_mac);
527
528static struct configfs_attribute *netconsole_target_attrs[] = {
529 &netconsole_target_enabled.attr,
530 &netconsole_target_dev_name.attr,
531 &netconsole_target_local_port.attr,
532 &netconsole_target_remote_port.attr,
533 &netconsole_target_local_ip.attr,
534 &netconsole_target_remote_ip.attr,
535 &netconsole_target_local_mac.attr,
536 &netconsole_target_remote_mac.attr,
537 NULL,
538};
539
540/*
541 * Item operations and type for netconsole_target.
542 */
543
544static void netconsole_target_release(struct config_item *item)
545{
546 kfree(to_target(item));
547}
548
549static ssize_t netconsole_target_attr_show(struct config_item *item,
550 struct configfs_attribute *attr,
551 char *buf)
552{
553 ssize_t ret = -EINVAL;
554 struct netconsole_target *nt = to_target(item);
555 struct netconsole_target_attr *na =
556 container_of(attr, struct netconsole_target_attr, attr);
557
558 if (na->show)
559 ret = na->show(nt, buf);
560
561 return ret;
562}
563
564static ssize_t netconsole_target_attr_store(struct config_item *item,
565 struct configfs_attribute *attr,
566 const char *buf,
567 size_t count)
568{
569 ssize_t ret = -EINVAL;
570 struct netconsole_target *nt = to_target(item);
571 struct netconsole_target_attr *na =
572 container_of(attr, struct netconsole_target_attr, attr);
573
574 if (na->store)
575 ret = na->store(nt, buf, count);
576
577 return ret;
578}
579
580static struct configfs_item_operations netconsole_target_item_ops = {
581 .release = netconsole_target_release,
582 .show_attribute = netconsole_target_attr_show,
583 .store_attribute = netconsole_target_attr_store,
584};
585
586static struct config_item_type netconsole_target_type = {
587 .ct_attrs = netconsole_target_attrs,
588 .ct_item_ops = &netconsole_target_item_ops,
589 .ct_owner = THIS_MODULE,
590};
591
592/*
593 * Group operations and type for netconsole_subsys.
594 */
595
Joel Beckerf89ab862008-07-17 14:53:48 -0700596static struct config_item *make_netconsole_target(struct config_group *group,
597 const char *name)
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700598{
599 unsigned long flags;
600 struct netconsole_target *nt;
601
602 /*
603 * Allocate and initialize with defaults.
604 * Target is disabled at creation (enabled == 0).
605 */
606 nt = kzalloc(sizeof(*nt), GFP_KERNEL);
Joe Perchese404dec2012-01-29 12:56:23 +0000607 if (!nt)
Joel Beckera6795e92008-07-17 15:21:29 -0700608 return ERR_PTR(-ENOMEM);
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700609
610 nt->np.name = "netconsole";
611 strlcpy(nt->np.dev_name, "eth0", IFNAMSIZ);
612 nt->np.local_port = 6665;
613 nt->np.remote_port = 6666;
Dan Aloni7a163bf2013-08-30 13:59:46 +0300614 mutex_init(&nt->mutex);
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700615 memset(nt->np.remote_mac, 0xff, ETH_ALEN);
616
617 /* Initialize the config_item member */
618 config_item_init_type_name(&nt->item, name, &netconsole_target_type);
619
620 /* Adding, but it is disabled */
621 spin_lock_irqsave(&target_list_lock, flags);
622 list_add(&nt->list, &target_list);
623 spin_unlock_irqrestore(&target_list_lock, flags);
624
Joel Beckerf89ab862008-07-17 14:53:48 -0700625 return &nt->item;
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700626}
627
628static void drop_netconsole_target(struct config_group *group,
629 struct config_item *item)
630{
631 unsigned long flags;
632 struct netconsole_target *nt = to_target(item);
633
634 spin_lock_irqsave(&target_list_lock, flags);
635 list_del(&nt->list);
636 spin_unlock_irqrestore(&target_list_lock, flags);
637
638 /*
639 * The target may have never been enabled, or was manually disabled
640 * before being removed so netpoll may have already been cleaned up.
641 */
642 if (nt->enabled)
643 netpoll_cleanup(&nt->np);
644
645 config_item_put(&nt->item);
646}
647
648static struct configfs_group_operations netconsole_subsys_group_ops = {
649 .make_item = make_netconsole_target,
650 .drop_item = drop_netconsole_target,
651};
652
653static struct config_item_type netconsole_subsys_type = {
654 .ct_group_ops = &netconsole_subsys_group_ops,
655 .ct_owner = THIS_MODULE,
656};
657
658/* The netconsole configfs subsystem */
659static struct configfs_subsystem netconsole_subsys = {
660 .su_group = {
661 .cg_item = {
662 .ci_namebuf = "netconsole",
663 .ci_type = &netconsole_subsys_type,
664 },
665 },
666};
667
668#endif /* CONFIG_NETCONSOLE_DYNAMIC */
669
Satyam Sharma17951f32007-08-10 15:33:01 -0700670/* Handle network interface device notifications */
671static int netconsole_netdev_event(struct notifier_block *this,
Jiri Pirko351638e2013-05-28 01:30:21 +0000672 unsigned long event, void *ptr)
Satyam Sharma17951f32007-08-10 15:33:01 -0700673{
Satyam Sharmab5427c22007-08-10 15:33:40 -0700674 unsigned long flags;
675 struct netconsole_target *nt;
Jiri Pirko351638e2013-05-28 01:30:21 +0000676 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
Ferenc Wagner141dfba2011-01-06 05:11:19 +0000677 bool stopped = false;
Satyam Sharma17951f32007-08-10 15:33:01 -0700678
WANG Cong0e34e932010-05-06 00:47:21 -0700679 if (!(event == NETDEV_CHANGENAME || event == NETDEV_UNREGISTER ||
Amerigo Wangdaf92092011-05-19 21:39:12 +0000680 event == NETDEV_RELEASE || event == NETDEV_JOIN))
Satyam Sharmab5427c22007-08-10 15:33:40 -0700681 goto done;
Satyam Sharma17951f32007-08-10 15:33:01 -0700682
Satyam Sharmab5427c22007-08-10 15:33:40 -0700683 spin_lock_irqsave(&target_list_lock, flags);
Veaceslav Falico3f315be2013-03-11 00:21:48 +0000684restart:
Satyam Sharmab5427c22007-08-10 15:33:40 -0700685 list_for_each_entry(nt, &target_list, list) {
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700686 netconsole_target_get(nt);
Satyam Sharmab5427c22007-08-10 15:33:40 -0700687 if (nt->np.dev == dev) {
688 switch (event) {
Satyam Sharmab5427c22007-08-10 15:33:40 -0700689 case NETDEV_CHANGENAME:
690 strlcpy(nt->np.dev_name, dev->name, IFNAMSIZ);
691 break;
Amerigo Wangdaf92092011-05-19 21:39:12 +0000692 case NETDEV_RELEASE:
Amerigo Wang8d8fc292011-05-19 21:39:10 +0000693 case NETDEV_JOIN:
Bruno Prémont2382b152009-04-29 20:45:17 +0000694 case NETDEV_UNREGISTER:
Nikolay Aleksandrovc71380f2013-09-19 15:02:36 +0200695 /* rtnl_lock already held
Veaceslav Falico3f315be2013-03-11 00:21:48 +0000696 * we might sleep in __netpoll_cleanup()
Neil Horman3b410a32010-10-13 16:01:52 +0000697 */
Veaceslav Falico3f315be2013-03-11 00:21:48 +0000698 spin_unlock_irqrestore(&target_list_lock, flags);
Dan Aloni7a163bf2013-08-30 13:59:46 +0300699
Veaceslav Falico3f315be2013-03-11 00:21:48 +0000700 __netpoll_cleanup(&nt->np);
Dan Aloni7a163bf2013-08-30 13:59:46 +0300701
Veaceslav Falico3f315be2013-03-11 00:21:48 +0000702 spin_lock_irqsave(&target_list_lock, flags);
703 dev_put(nt->np.dev);
704 nt->np.dev = NULL;
Bruno Prémont2382b152009-04-29 20:45:17 +0000705 nt->enabled = 0;
Ferenc Wagner141dfba2011-01-06 05:11:19 +0000706 stopped = true;
Veaceslav Falico3f315be2013-03-11 00:21:48 +0000707 netconsole_target_put(nt);
708 goto restart;
Satyam Sharmab5427c22007-08-10 15:33:40 -0700709 }
Satyam Sharma17951f32007-08-10 15:33:01 -0700710 }
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700711 netconsole_target_put(nt);
Satyam Sharma17951f32007-08-10 15:33:01 -0700712 }
Satyam Sharmab5427c22007-08-10 15:33:40 -0700713 spin_unlock_irqrestore(&target_list_lock, flags);
Amerigo Wang8d8fc292011-05-19 21:39:10 +0000714 if (stopped) {
Ferenc Wagner38cfb902011-01-06 05:11:20 +0000715 printk(KERN_INFO "netconsole: network logging stopped on "
Amerigo Wang8d8fc292011-05-19 21:39:10 +0000716 "interface %s as it ", dev->name);
717 switch (event) {
718 case NETDEV_UNREGISTER:
719 printk(KERN_CONT "unregistered\n");
720 break;
Amerigo Wangdaf92092011-05-19 21:39:12 +0000721 case NETDEV_RELEASE:
Amerigo Wang8d8fc292011-05-19 21:39:10 +0000722 printk(KERN_CONT "released slaves\n");
723 break;
724 case NETDEV_JOIN:
725 printk(KERN_CONT "is joining a master device\n");
726 break;
727 }
728 }
Satyam Sharma17951f32007-08-10 15:33:01 -0700729
Satyam Sharmab5427c22007-08-10 15:33:40 -0700730done:
Satyam Sharma17951f32007-08-10 15:33:01 -0700731 return NOTIFY_DONE;
732}
733
734static struct notifier_block netconsole_netdev_notifier = {
735 .notifier_call = netconsole_netdev_event,
736};
737
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738static void write_msg(struct console *con, const char *msg, unsigned int len)
739{
740 int frag, left;
741 unsigned long flags;
Satyam Sharmab5427c22007-08-10 15:33:40 -0700742 struct netconsole_target *nt;
743 const char *tmp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744
Amerigo Wangc1a60852012-11-08 03:42:38 +0000745 if (oops_only && !oops_in_progress)
746 return;
Satyam Sharmab5427c22007-08-10 15:33:40 -0700747 /* Avoid taking lock and disabling interrupts unnecessarily */
748 if (list_empty(&target_list))
749 return;
750
751 spin_lock_irqsave(&target_list_lock, flags);
752 list_for_each_entry(nt, &target_list, list) {
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700753 netconsole_target_get(nt);
754 if (nt->enabled && netif_running(nt->np.dev)) {
Satyam Sharmab5427c22007-08-10 15:33:40 -0700755 /*
756 * We nest this inside the for-each-target loop above
757 * so that we're able to get as much logging out to
758 * at least one target if we die inside here, instead
759 * of unnecessarily keeping all targets in lock-step.
760 */
761 tmp = msg;
762 for (left = len; left;) {
763 frag = min(left, MAX_PRINT_CHUNK);
764 netpoll_send_udp(&nt->np, tmp, frag);
765 tmp += frag;
766 left -= frag;
767 }
Satyam Sharma0cc120be2007-08-10 15:30:31 -0700768 }
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700769 netconsole_target_put(nt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 }
Satyam Sharmab5427c22007-08-10 15:33:40 -0700771 spin_unlock_irqrestore(&target_list_lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772}
773
774static struct console netconsole = {
Satyam Sharmad39badf2007-08-10 15:27:24 -0700775 .name = "netcon",
Michael Ellerman0517dee2008-04-15 00:49:04 -0700776 .flags = CON_ENABLED,
Satyam Sharmad39badf2007-08-10 15:27:24 -0700777 .write = write_msg,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778};
779
Satyam Sharmad39badf2007-08-10 15:27:24 -0700780static int __init init_netconsole(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781{
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700782 int err;
Satyam Sharmab5427c22007-08-10 15:33:40 -0700783 struct netconsole_target *nt, *tmp;
784 unsigned long flags;
785 char *target_config;
786 char *input = config;
Stephen Hemmingerb41848b2006-10-26 15:46:52 -0700787
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700788 if (strnlen(input, MAX_PARAM_LENGTH)) {
789 while ((target_config = strsep(&input, ";"))) {
790 nt = alloc_param_target(target_config);
791 if (IS_ERR(nt)) {
792 err = PTR_ERR(nt);
793 goto fail;
794 }
Michael Ellerman0517dee2008-04-15 00:49:04 -0700795 /* Dump existing printks when we register */
796 netconsole.flags |= CON_PRINTBUFFER;
797
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700798 spin_lock_irqsave(&target_list_lock, flags);
799 list_add(&nt->list, &target_list);
800 spin_unlock_irqrestore(&target_list_lock, flags);
Satyam Sharmab5427c22007-08-10 15:33:40 -0700801 }
Satyam Sharmab5427c22007-08-10 15:33:40 -0700802 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803
Satyam Sharma17951f32007-08-10 15:33:01 -0700804 err = register_netdevice_notifier(&netconsole_netdev_notifier);
805 if (err)
Satyam Sharmab5427c22007-08-10 15:33:40 -0700806 goto fail;
Satyam Sharma17951f32007-08-10 15:33:01 -0700807
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700808 err = dynamic_netconsole_init();
809 if (err)
810 goto undonotifier;
811
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 register_console(&netconsole);
813 printk(KERN_INFO "netconsole: network logging started\n");
Satyam Sharmad39badf2007-08-10 15:27:24 -0700814
Satyam Sharmad39badf2007-08-10 15:27:24 -0700815 return err;
Satyam Sharmab5427c22007-08-10 15:33:40 -0700816
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700817undonotifier:
818 unregister_netdevice_notifier(&netconsole_netdev_notifier);
819
Satyam Sharmab5427c22007-08-10 15:33:40 -0700820fail:
821 printk(KERN_ERR "netconsole: cleaning up\n");
822
823 /*
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700824 * Remove all targets and destroy them (only targets created
825 * from the boot/module option exist here). Skipping the list
Satyam Sharmab5427c22007-08-10 15:33:40 -0700826 * lock is safe here, and netpoll_cleanup() will sleep.
827 */
828 list_for_each_entry_safe(nt, tmp, &target_list, list) {
829 list_del(&nt->list);
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700830 free_param_target(nt);
Satyam Sharmab5427c22007-08-10 15:33:40 -0700831 }
832
833 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834}
835
Satyam Sharmad39badf2007-08-10 15:27:24 -0700836static void __exit cleanup_netconsole(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837{
Satyam Sharmab5427c22007-08-10 15:33:40 -0700838 struct netconsole_target *nt, *tmp;
Satyam Sharmadf180e32007-08-10 15:32:14 -0700839
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840 unregister_console(&netconsole);
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700841 dynamic_netconsole_exit();
Satyam Sharma17951f32007-08-10 15:33:01 -0700842 unregister_netdevice_notifier(&netconsole_netdev_notifier);
Satyam Sharmab5427c22007-08-10 15:33:40 -0700843
844 /*
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700845 * Targets created via configfs pin references on our module
846 * and would first be rmdir(2)'ed from userspace. We reach
847 * here only when they are already destroyed, and only those
848 * created from the boot/module option are left, so remove and
849 * destroy them. Skipping the list lock is safe here, and
850 * netpoll_cleanup() will sleep.
Satyam Sharmab5427c22007-08-10 15:33:40 -0700851 */
852 list_for_each_entry_safe(nt, tmp, &target_list, list) {
853 list_del(&nt->list);
Satyam Sharma0bcc1812007-08-10 15:35:05 -0700854 free_param_target(nt);
Satyam Sharmab5427c22007-08-10 15:33:40 -0700855 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856}
857
Lin Ming97c7de02011-09-20 15:45:07 -0400858/*
859 * Use late_initcall to ensure netconsole is
860 * initialized after network device driver if built-in.
861 *
862 * late_initcall() and module_init() are identical if built as module.
863 */
864late_initcall(init_netconsole);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865module_exit(cleanup_netconsole);