[deliverable/linux.git] / drivers / staging / lustre / lnet / libcfs / debug.c

/*
 * GPL HEADER START
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 only,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License version 2 for more details (a copy is included
 * in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU General Public License
 * version 2 along with this program; If not, see
 * http://www.gnu.org/licenses/gpl-2.0.html
 *
 * GPL HEADER END
 */
/*
 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
 * Use is subject to license terms.
 *
 * Copyright (c) 2011, 2012, Intel Corporation.
 */
/*
 * This file is part of Lustre, http://www.lustre.org/
 * Lustre is a trademark of Sun Microsystems, Inc.
 *
 * libcfs/libcfs/debug.c
 *
 * Author: Phil Schwan <phil@clusterfs.com>
 *
 */

# define DEBUG_SUBSYSTEM S_LNET

#include "../../include/linux/libcfs/libcfs.h"
#include "tracefile.h"

static char debug_file_name[1024];

unsigned int libcfs_subsystem_debug = ~0;
EXPORT_SYMBOL(libcfs_subsystem_debug);
module_param(libcfs_subsystem_debug, int, 0644);
MODULE_PARM_DESC(libcfs_subsystem_debug, "Lustre kernel debug subsystem mask");

unsigned int libcfs_debug = (D_CANTMASK |
			     D_NETERROR | D_HA | D_CONFIG | D_IOCTL);
EXPORT_SYMBOL(libcfs_debug);
module_param(libcfs_debug, int, 0644);
MODULE_PARM_DESC(libcfs_debug, "Lustre kernel debug mask");

static int libcfs_param_debug_mb_set(const char *val,
				     const struct kernel_param *kp)
{
	int rc;
	unsigned num;

	rc = kstrtouint(val, 0, &num);
	if (rc < 0)
		return rc;

	if (!*((unsigned int *)kp->arg)) {
		*((unsigned int *)kp->arg) = num;
		return 0;
	}

	rc = cfs_trace_set_debug_mb(num);

	if (!rc)
		*((unsigned int *)kp->arg) = cfs_trace_get_debug_mb();

	return rc;
}

/* While debug_mb setting look like unsigned int, in fact
 * it needs quite a bunch of extra processing, so we define special
 * debugmb parameter type with corresponding methods to handle this case
 */
static struct kernel_param_ops param_ops_debugmb = {
	.set = libcfs_param_debug_mb_set,
	.get = param_get_uint,
};

#define param_check_debugmb(name, p) \
		__param_check(name, p, unsigned int)

static unsigned int libcfs_debug_mb;
module_param(libcfs_debug_mb, debugmb, 0644);
MODULE_PARM_DESC(libcfs_debug_mb, "Total debug buffer size.");

unsigned int libcfs_printk = D_CANTMASK;
module_param(libcfs_printk, uint, 0644);
MODULE_PARM_DESC(libcfs_printk, "Lustre kernel debug console mask");

unsigned int libcfs_console_ratelimit = 1;
module_param(libcfs_console_ratelimit, uint, 0644);
MODULE_PARM_DESC(libcfs_console_ratelimit, "Lustre kernel debug console ratelimit (0 to disable)");

static int param_set_delay_minmax(const char *val,
				  const struct kernel_param *kp,
				  long min, long max)
{
	long d;
	int sec;
	int rc;

	rc = kstrtoint(val, 0, &sec);
	if (rc)
		return -EINVAL;

	d = cfs_time_seconds(sec) / 100;
	if (d < min || d > max)
		return -EINVAL;

	*((unsigned int *)kp->arg) = d;

	return 0;
}

static int param_get_delay(char *buffer, const struct kernel_param *kp)
{
	unsigned int d = *(unsigned int *)kp->arg;

	return sprintf(buffer, "%u", (unsigned int)cfs_duration_sec(d * 100));
}

unsigned int libcfs_console_max_delay;
unsigned int libcfs_console_min_delay;

static int param_set_console_max_delay(const char *val,
				       const struct kernel_param *kp)
{
	return param_set_delay_minmax(val, kp,
				      libcfs_console_min_delay, INT_MAX);
}

static struct kernel_param_ops param_ops_console_max_delay = {
	.set = param_set_console_max_delay,
	.get = param_get_delay,
};

#define param_check_console_max_delay(name, p) \
		__param_check(name, p, unsigned int)

module_param(libcfs_console_max_delay, console_max_delay, 0644);
MODULE_PARM_DESC(libcfs_console_max_delay, "Lustre kernel debug console max delay (jiffies)");

static int param_set_console_min_delay(const char *val,
				       const struct kernel_param *kp)
{
	return param_set_delay_minmax(val, kp,
				      1, libcfs_console_max_delay);
}

static struct kernel_param_ops param_ops_console_min_delay = {
	.set = param_set_console_min_delay,
	.get = param_get_delay,
};

#define param_check_console_min_delay(name, p) \
		__param_check(name, p, unsigned int)

module_param(libcfs_console_min_delay, console_min_delay, 0644);
MODULE_PARM_DESC(libcfs_console_min_delay, "Lustre kernel debug console min delay (jiffies)");

static int param_set_uint_minmax(const char *val,
				 const struct kernel_param *kp,
				 unsigned int min, unsigned int max)
{
	unsigned int num;
	int ret;

	if (!val)
		return -EINVAL;
	ret = kstrtouint(val, 0, &num);
	if (ret < 0 || num < min || num > max)
		return -EINVAL;
	*((unsigned int *)kp->arg) = num;
	return 0;
}

static int param_set_uintpos(const char *val, const struct kernel_param *kp)
{
	return param_set_uint_minmax(val, kp, 1, -1);
}

static struct kernel_param_ops param_ops_uintpos = {
	.set = param_set_uintpos,
	.get = param_get_uint,
};

#define param_check_uintpos(name, p) \
		__param_check(name, p, unsigned int)

unsigned int libcfs_console_backoff = CDEBUG_DEFAULT_BACKOFF;
module_param(libcfs_console_backoff, uintpos, 0644);
MODULE_PARM_DESC(libcfs_console_backoff, "Lustre kernel debug console backoff factor");

unsigned int libcfs_debug_binary = 1;

unsigned int libcfs_stack = 3 * THREAD_SIZE / 4;
EXPORT_SYMBOL(libcfs_stack);

unsigned int libcfs_catastrophe;
EXPORT_SYMBOL(libcfs_catastrophe);

unsigned int libcfs_panic_on_lbug = 1;
module_param(libcfs_panic_on_lbug, uint, 0644);
MODULE_PARM_DESC(libcfs_panic_on_lbug, "Lustre kernel panic on LBUG");

static wait_queue_head_t debug_ctlwq;

char libcfs_debug_file_path_arr[PATH_MAX] = LIBCFS_DEBUG_FILE_PATH_DEFAULT;

/* We need to pass a pointer here, but elsewhere this must be a const */
static char *libcfs_debug_file_path;
module_param(libcfs_debug_file_path, charp, 0644);
MODULE_PARM_DESC(libcfs_debug_file_path,
		 "Path for dumping debug logs, set 'NONE' to prevent log dumping");

int libcfs_panic_in_progress;

/* libcfs_debug_token2mask() expects the returned string in lower-case */
static const char *
libcfs_debug_subsys2str(int subsys)
{
	static const char *libcfs_debug_subsystems[] = LIBCFS_DEBUG_SUBSYS_NAMES;

	if (subsys >= ARRAY_SIZE(libcfs_debug_subsystems))
		return NULL;

	return libcfs_debug_subsystems[subsys];
}

/* libcfs_debug_token2mask() expects the returned string in lower-case */
static const char *
libcfs_debug_dbg2str(int debug)
{
	static const char *libcfs_debug_masks[] = LIBCFS_DEBUG_MASKS_NAMES;

	if (debug >= ARRAY_SIZE(libcfs_debug_masks))
		return NULL;

	return libcfs_debug_masks[debug];
}

int
libcfs_debug_mask2str(char *str, int size, int mask, int is_subsys)
{
	const char *(*fn)(int bit) = is_subsys ? libcfs_debug_subsys2str :
						 libcfs_debug_dbg2str;
	int	   len = 0;
	const char   *token;
	int	   i;

	if (mask == 0) {			/* "0" */
		if (size > 0)
			str[0] = '0';
		len = 1;
	} else {				/* space-separated tokens */
		for (i = 0; i < 32; i++) {
			if ((mask & (1 << i)) == 0)
				continue;

			token = fn(i);
			if (!token)	      /* unused bit */
				continue;

			if (len > 0) {		  /* separator? */
				if (len < size)
					str[len] = ' ';
				len++;
			}

			while (*token != 0) {
				if (len < size)
					str[len] = *token;
				token++;
				len++;
			}
		}
	}

	/* terminate 'str' */
	if (len < size)
		str[len] = 0;
	else
		str[size - 1] = 0;

	return len;
}

int
libcfs_debug_str2mask(int *mask, const char *str, int is_subsys)
{
	const char *(*fn)(int bit) = is_subsys ? libcfs_debug_subsys2str :
						 libcfs_debug_dbg2str;
	int	 m = 0;
	int	 matched;
	int	 n;
	int	 t;

	/* Allow a number for backwards compatibility */

	for (n = strlen(str); n > 0; n--)
		if (!isspace(str[n - 1]))
			break;
	matched = n;
	t = sscanf(str, "%i%n", &m, &matched);
	if (t >= 1 && matched == n) {
		/* don't print warning for lctl set_param debug=0 or -1 */
		if (m != 0 && m != -1)
			CWARN("You are trying to use a numerical value for the mask - this will be deprecated in a future release.\n");
		*mask = m;
		return 0;
	}

	return cfs_str2mask(str, fn, mask, is_subsys ? 0 : D_CANTMASK,
			    0xffffffff);
}

/**
 * Dump Lustre log to ::debug_file_path by calling tracefile_dump_all_pages()
 */
void libcfs_debug_dumplog_internal(void *arg)
{
	static time64_t last_dump_time;
	time64_t current_time;
	void *journal_info;

	journal_info = current->journal_info;
	current->journal_info = NULL;
	current_time = ktime_get_real_seconds();

	if (strncmp(libcfs_debug_file_path_arr, "NONE", 4) &&
	    current_time > last_dump_time) {
		last_dump_time = current_time;
		snprintf(debug_file_name, sizeof(debug_file_name) - 1,
			 "%s.%lld.%ld", libcfs_debug_file_path_arr,
			 (s64)current_time, (long_ptr_t)arg);
		pr_alert("LustreError: dumping log to %s\n", debug_file_name);
		cfs_tracefile_dump_all_pages(debug_file_name);
		libcfs_run_debug_log_upcall(debug_file_name);
	}

	current->journal_info = journal_info;
}

static int libcfs_debug_dumplog_thread(void *arg)
{
	libcfs_debug_dumplog_internal(arg);
	wake_up(&debug_ctlwq);
	return 0;
}

void libcfs_debug_dumplog(void)
{
	wait_queue_t wait;
	struct task_struct *dumper;

	/* we're being careful to ensure that the kernel thread is
	 * able to set our state to running as it exits before we
	 * get to schedule()
	 */
	init_waitqueue_entry(&wait, current);
	add_wait_queue(&debug_ctlwq, &wait);

	dumper = kthread_run(libcfs_debug_dumplog_thread,
			     (void *)(long)current_pid(),
			     "libcfs_debug_dumper");
	set_current_state(TASK_INTERRUPTIBLE);
	if (IS_ERR(dumper))
		pr_err("LustreError: cannot start log dump thread: %ld\n",
		       PTR_ERR(dumper));
	else
		schedule();

	/* be sure to teardown if cfs_create_thread() failed */
	remove_wait_queue(&debug_ctlwq, &wait);
	set_current_state(TASK_RUNNING);
}
EXPORT_SYMBOL(libcfs_debug_dumplog);

int libcfs_debug_init(unsigned long bufsize)
{
	int    rc = 0;
	unsigned int max = libcfs_debug_mb;

	init_waitqueue_head(&debug_ctlwq);

	if (libcfs_console_max_delay <= 0 || /* not set by user or */
	    libcfs_console_min_delay <= 0 || /* set to invalid values */
	    libcfs_console_min_delay >= libcfs_console_max_delay) {
		libcfs_console_max_delay = CDEBUG_DEFAULT_MAX_DELAY;
		libcfs_console_min_delay = CDEBUG_DEFAULT_MIN_DELAY;
	}

	if (libcfs_debug_file_path) {
		strlcpy(libcfs_debug_file_path_arr,
			libcfs_debug_file_path,
			sizeof(libcfs_debug_file_path_arr));
	}

	/* If libcfs_debug_mb is set to an invalid value or uninitialized
	 * then just make the total buffers smp_num_cpus * TCD_MAX_PAGES
	 */
	if (max > cfs_trace_max_debug_mb() || max < num_possible_cpus()) {
		max = TCD_MAX_PAGES;
	} else {
		max = max / num_possible_cpus();
		max <<= (20 - PAGE_SHIFT);
	}
	rc = cfs_tracefile_init(max);

	if (rc == 0) {
		libcfs_register_panic_notifier();
		libcfs_debug_mb = cfs_trace_get_debug_mb();
	}

	return rc;
}

int libcfs_debug_cleanup(void)
{
	libcfs_unregister_panic_notifier();
	cfs_tracefile_exit();
	return 0;
}

int libcfs_debug_clear_buffer(void)
{
	cfs_trace_flush_pages();
	return 0;
}

/* Debug markers, although printed by S_LNET should not be be marked as such. */
#undef DEBUG_SUBSYSTEM
#define DEBUG_SUBSYSTEM S_UNDEFINED
int libcfs_debug_mark_buffer(const char *text)
{
	CDEBUG(D_TRACE,
	       "***************************************************\n");
	LCONSOLE(D_WARNING, "DEBUG MARKER: %s\n", text);
	CDEBUG(D_TRACE,
	       "***************************************************\n");

	return 0;
}

#undef DEBUG_SUBSYSTEM
#define DEBUG_SUBSYSTEM S_LNET
Commit	Line	Data
d7e09d03 PT	1	/*
	2	* GPL HEADER START
	3	*
	4	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License version 2 only,
	8	* as published by the Free Software Foundation.
	9	*
	10	* This program is distributed in the hope that it will be useful, but
	11	* WITHOUT ANY WARRANTY; without even the implied warranty of
	12	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	13	* General Public License version 2 for more details (a copy is included
	14	* in the LICENSE file that accompanied this code).
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* version 2 along with this program; If not, see
6a5b99a4	18	* http://www.gnu.org/licenses/gpl-2.0.html
d7e09d03	19	*
d7e09d03 PT	20	* GPL HEADER END
	21	*/
	22	/*
	23	* Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
	24	* Use is subject to license terms.
	25	*
	26	* Copyright (c) 2011, 2012, Intel Corporation.
	27	*/
	28	/*
	29	* This file is part of Lustre, http://www.lustre.org/
	30	* Lustre is a trademark of Sun Microsystems, Inc.
	31	*
	32	* libcfs/libcfs/debug.c
	33	*
	34	* Author: Phil Schwan <phil@clusterfs.com>
	35	*
	36	*/
	37
	38	# define DEBUG_SUBSYSTEM S_LNET
	39
9fdaf8c0	40	#include "../../include/linux/libcfs/libcfs.h"
d7e09d03 PT	41	#include "tracefile.h"
	42
	43	static char debug_file_name[1024];
	44
	45	unsigned int libcfs_subsystem_debug = ~0;
22628c7d	46	EXPORT_SYMBOL(libcfs_subsystem_debug);
8cc7b4b9 PT	47	module_param(libcfs_subsystem_debug, int, 0644);
8cc7b4b9 PT	48	MODULE_PARM_DESC(libcfs_subsystem_debug, "Lustre kernel debug subsystem mask");
d7e09d03 PT	49
	50	unsigned int libcfs_debug = (D_CANTMASK \|
	51	D_NETERROR \| D_HA \| D_CONFIG \| D_IOCTL);
22628c7d	52	EXPORT_SYMBOL(libcfs_debug);
8cc7b4b9 PT	53	module_param(libcfs_debug, int, 0644);
8cc7b4b9 PT	54	MODULE_PARM_DESC(libcfs_debug, "Lustre kernel debug mask");
d7e09d03	55
8dc08446 OD	56	static int libcfs_param_debug_mb_set(const char *val,
	57	const struct kernel_param *kp)
	58	{
	59	int rc;
	60	unsigned num;
	61
	62	rc = kstrtouint(val, 0, &num);
	63	if (rc < 0)
	64	return rc;
	65
	66	if (!((unsigned int )kp->arg)) {
	67	((unsigned int )kp->arg) = num;
	68	return 0;
	69	}
	70
	71	rc = cfs_trace_set_debug_mb(num);
	72
	73	if (!rc)
	74	((unsigned int )kp->arg) = cfs_trace_get_debug_mb();
	75
	76	return rc;
	77	}
	78
	79	/* While debug_mb setting look like unsigned int, in fact
	80	* it needs quite a bunch of extra processing, so we define special
a3fbcb3c OD	81	* debugmb parameter type with corresponding methods to handle this case
a3fbcb3c OD	82	*/
8dc08446 OD	83	static struct kernel_param_ops param_ops_debugmb = {
	84	.set = libcfs_param_debug_mb_set,
	85	.get = param_get_uint,
	86	};
	87
	88	#define param_check_debugmb(name, p) \
	89	__param_check(name, p, unsigned int)
	90
533e80b1	91	static unsigned int libcfs_debug_mb;
8dc08446	92	module_param(libcfs_debug_mb, debugmb, 0644);
8cc7b4b9	93	MODULE_PARM_DESC(libcfs_debug_mb, "Total debug buffer size.");
d7e09d03 PT	94
d7e09d03 PT	95	unsigned int libcfs_printk = D_CANTMASK;
8cc7b4b9 PT	96	module_param(libcfs_printk, uint, 0644);
8cc7b4b9 PT	97	MODULE_PARM_DESC(libcfs_printk, "Lustre kernel debug console mask");
d7e09d03 PT	98
d7e09d03 PT	99	unsigned int libcfs_console_ratelimit = 1;
8cc7b4b9 PT	100	module_param(libcfs_console_ratelimit, uint, 0644);
8cc7b4b9 PT	101	MODULE_PARM_DESC(libcfs_console_ratelimit, "Lustre kernel debug console ratelimit (0 to disable)");
d7e09d03	102
35ca907d DE	103	static int param_set_delay_minmax(const char *val,
	104	const struct kernel_param *kp,
	105	long min, long max)
	106	{
	107	long d;
	108	int sec;
	109	int rc;
	110
	111	rc = kstrtoint(val, 0, &sec);
	112	if (rc)
	113	return -EINVAL;
	114
	115	d = cfs_time_seconds(sec) / 100;
	116	if (d < min \|\| d > max)
	117	return -EINVAL;
	118
	119	((unsigned int )kp->arg) = d;
	120
	121	return 0;
	122	}
	123
	124	static int param_get_delay(char buffer, const struct kernel_param kp)
	125	{
	126	unsigned int d = (unsigned int )kp->arg;
	127
	128	return sprintf(buffer, "%u", (unsigned int)cfs_duration_sec(d * 100));
	129	}
	130
d7e09d03	131	unsigned int libcfs_console_max_delay;
d7e09d03	132	unsigned int libcfs_console_min_delay;
d7e09d03	133
35ca907d DE	134	static int param_set_console_max_delay(const char *val,
	135	const struct kernel_param *kp)
	136	{
	137	return param_set_delay_minmax(val, kp,
	138	libcfs_console_min_delay, INT_MAX);
	139	}
	140
	141	static struct kernel_param_ops param_ops_console_max_delay = {
	142	.set = param_set_console_max_delay,
	143	.get = param_get_delay,
	144	};
	145
	146	#define param_check_console_max_delay(name, p) \
	147	__param_check(name, p, unsigned int)
	148
	149	module_param(libcfs_console_max_delay, console_max_delay, 0644);
	150	MODULE_PARM_DESC(libcfs_console_max_delay, "Lustre kernel debug console max delay (jiffies)");
	151
	152	static int param_set_console_min_delay(const char *val,
	153	const struct kernel_param *kp)
	154	{
	155	return param_set_delay_minmax(val, kp,
	156	1, libcfs_console_max_delay);
	157	}
	158
	159	static struct kernel_param_ops param_ops_console_min_delay = {
	160	.set = param_set_console_min_delay,
	161	.get = param_get_delay,
	162	};
	163
	164	#define param_check_console_min_delay(name, p) \
	165	__param_check(name, p, unsigned int)
	166
	167	module_param(libcfs_console_min_delay, console_min_delay, 0644);
	168	MODULE_PARM_DESC(libcfs_console_min_delay, "Lustre kernel debug console min delay (jiffies)");
	169
8710427d OD	170	static int param_set_uint_minmax(const char *val,
	171	const struct kernel_param *kp,
	172	unsigned int min, unsigned int max)
	173	{
	174	unsigned int num;
	175	int ret;
	176
	177	if (!val)
	178	return -EINVAL;
	179	ret = kstrtouint(val, 0, &num);
aa66d6f8	180	if (ret < 0 \|\| num < min \|\| num > max)
8710427d OD	181	return -EINVAL;
	182	((unsigned int )kp->arg) = num;
	183	return 0;
	184	}
	185
	186	static int param_set_uintpos(const char val, const struct kernel_param kp)
	187	{
	188	return param_set_uint_minmax(val, kp, 1, -1);
	189	}
	190
	191	static struct kernel_param_ops param_ops_uintpos = {
	192	.set = param_set_uintpos,
	193	.get = param_get_uint,
	194	};
	195
	196	#define param_check_uintpos(name, p) \
	197	__param_check(name, p, unsigned int)
	198
d7e09d03	199	unsigned int libcfs_console_backoff = CDEBUG_DEFAULT_BACKOFF;
8710427d	200	module_param(libcfs_console_backoff, uintpos, 0644);
8cc7b4b9	201	MODULE_PARM_DESC(libcfs_console_backoff, "Lustre kernel debug console backoff factor");
d7e09d03 PT	202
d7e09d03 PT	203	unsigned int libcfs_debug_binary = 1;
d7e09d03 PT	204
	205	unsigned int libcfs_stack = 3 * THREAD_SIZE / 4;
	206	EXPORT_SYMBOL(libcfs_stack);
	207
d7e09d03 PT	208	unsigned int libcfs_catastrophe;
	209	EXPORT_SYMBOL(libcfs_catastrophe);
	210
d7e09d03	211	unsigned int libcfs_panic_on_lbug = 1;
8cc7b4b9 PT	212	module_param(libcfs_panic_on_lbug, uint, 0644);
8cc7b4b9 PT	213	MODULE_PARM_DESC(libcfs_panic_on_lbug, "Lustre kernel panic on LBUG");
d7e09d03	214
d7e09d03 PT	215	static wait_queue_head_t debug_ctlwq;
	216
	217	char libcfs_debug_file_path_arr[PATH_MAX] = LIBCFS_DEBUG_FILE_PATH_DEFAULT;
	218
	219	/* We need to pass a pointer here, but elsewhere this must be a const */
2a74b9bd	220	static char *libcfs_debug_file_path;
8cc7b4b9 PT	221	module_param(libcfs_debug_file_path, charp, 0644);
	222	MODULE_PARM_DESC(libcfs_debug_file_path,
	223	"Path for dumping debug logs, set 'NONE' to prevent log dumping");
d7e09d03 PT	224
	225	int libcfs_panic_in_progress;
	226
a3fbcb3c	227	/* libcfs_debug_token2mask() expects the returned string in lower-case */
2a74b9bd	228	static const char *
d7e09d03 PT	229	libcfs_debug_subsys2str(int subsys)
d7e09d03 PT	230	{
6f11cd97 JX	231	static const char *libcfs_debug_subsystems[] = LIBCFS_DEBUG_SUBSYS_NAMES;
	232
	233	if (subsys >= ARRAY_SIZE(libcfs_debug_subsystems))
d7e09d03	234	return NULL;
6f11cd97 JX	235
6f11cd97 JX	236	return libcfs_debug_subsystems[subsys];
d7e09d03 PT	237	}
d7e09d03 PT	238
a3fbcb3c	239	/* libcfs_debug_token2mask() expects the returned string in lower-case */
2a74b9bd	240	static const char *
d7e09d03 PT	241	libcfs_debug_dbg2str(int debug)
d7e09d03 PT	242	{
6f11cd97 JX	243	static const char *libcfs_debug_masks[] = LIBCFS_DEBUG_MASKS_NAMES;
	244
	245	if (debug >= ARRAY_SIZE(libcfs_debug_masks))
d7e09d03	246	return NULL;
6f11cd97 JX	247
6f11cd97 JX	248	return libcfs_debug_masks[debug];
d7e09d03 PT	249	}
	250
	251	int
	252	libcfs_debug_mask2str(char *str, int size, int mask, int is_subsys)
	253	{
	254	const char (fn)(int bit) = is_subsys ? libcfs_debug_subsys2str :
	255	libcfs_debug_dbg2str;
	256	int len = 0;
	257	const char *token;
	258	int i;
	259
	260	if (mask == 0) { /* "0" */
	261	if (size > 0)
	262	str[0] = '0';
	263	len = 1;
	264	} else { /* space-separated tokens */
	265	for (i = 0; i < 32; i++) {
	266	if ((mask & (1 << i)) == 0)
	267	continue;
	268
	269	token = fn(i);
15d9f520	270	if (!token) /* unused bit */
d7e09d03 PT	271	continue;
	272
	273	if (len > 0) { /* separator? */
	274	if (len < size)
	275	str[len] = ' ';
	276	len++;
	277	}
	278
	279	while (*token != 0) {
	280	if (len < size)
	281	str[len] = *token;
	282	token++;
	283	len++;
	284	}
	285	}
	286	}
	287
	288	/* terminate 'str' */
	289	if (len < size)
	290	str[len] = 0;
	291	else
	292	str[size - 1] = 0;
	293
	294	return len;
	295	}
	296
	297	int
	298	libcfs_debug_str2mask(int mask, const char str, int is_subsys)
	299	{
	300	const char (fn)(int bit) = is_subsys ? libcfs_debug_subsys2str :
	301	libcfs_debug_dbg2str;
	302	int m = 0;
	303	int matched;
	304	int n;
	305	int t;
	306
	307	/* Allow a number for backwards compatibility */
	308
	309	for (n = strlen(str); n > 0; n--)
60b156e3	310	if (!isspace(str[n - 1]))
d7e09d03 PT	311	break;
d7e09d03 PT	312	matched = n;
74bb9d4f HP	313	t = sscanf(str, "%i%n", &m, &matched);
74bb9d4f HP	314	if (t >= 1 && matched == n) {
d7e09d03 PT	315	/* don't print warning for lctl set_param debug=0 or -1 */
d7e09d03 PT	316	if (m != 0 && m != -1)
2d00bd17	317	CWARN("You are trying to use a numerical value for the mask - this will be deprecated in a future release.\n");
d7e09d03 PT	318	*mask = m;
	319	return 0;
	320	}
	321
	322	return cfs_str2mask(str, fn, mask, is_subsys ? 0 : D_CANTMASK,
	323	0xffffffff);
	324	}
	325
	326	/**
	327	* Dump Lustre log to ::debug_file_path by calling tracefile_dump_all_pages()
	328	*/
	329	void libcfs_debug_dumplog_internal(void *arg)
	330	{
a9bcd881 RH	331	static time64_t last_dump_time;
a9bcd881 RH	332	time64_t current_time;
9733ac33	333	void *journal_info;
d7e09d03	334
9733ac33 GKH	335	journal_info = current->journal_info;
9733ac33 GKH	336	current->journal_info = NULL;
a9bcd881	337	current_time = ktime_get_real_seconds();
d7e09d03	338
a9bcd881 RH	339	if (strncmp(libcfs_debug_file_path_arr, "NONE", 4) &&
	340	current_time > last_dump_time) {
	341	last_dump_time = current_time;
d7e09d03	342	snprintf(debug_file_name, sizeof(debug_file_name) - 1,
589bfa37	343	"%s.%lld.%ld", libcfs_debug_file_path_arr,
a9bcd881	344	(s64)current_time, (long_ptr_t)arg);
ae0b4833	345	pr_alert("LustreError: dumping log to %s\n", debug_file_name);
d7e09d03 PT	346	cfs_tracefile_dump_all_pages(debug_file_name);
	347	libcfs_run_debug_log_upcall(debug_file_name);
	348	}
9733ac33 GKH	349
9733ac33 GKH	350	current->journal_info = journal_info;
d7e09d03 PT	351	}
d7e09d03 PT	352
2a74b9bd	353	static int libcfs_debug_dumplog_thread(void *arg)
d7e09d03 PT	354	{
	355	libcfs_debug_dumplog_internal(arg);
	356	wake_up(&debug_ctlwq);
	357	return 0;
	358	}
	359
	360	void libcfs_debug_dumplog(void)
	361	{
	362	wait_queue_t wait;
68b636b6	363	struct task_struct *dumper;
d7e09d03 PT	364
	365	/* we're being careful to ensure that the kernel thread is
	366	* able to set our state to running as it exits before we
a3fbcb3c OD	367	* get to schedule()
a3fbcb3c OD	368	*/
9e795d35	369	init_waitqueue_entry(&wait, current);
d7e09d03 PT	370	add_wait_queue(&debug_ctlwq, &wait);
	371
	372	dumper = kthread_run(libcfs_debug_dumplog_thread,
	373	(void *)(long)current_pid(),
	374	"libcfs_debug_dumper");
281a8273	375	set_current_state(TASK_INTERRUPTIBLE);
d7e09d03	376	if (IS_ERR(dumper))
2d00bd17 JP	377	pr_err("LustreError: cannot start log dump thread: %ld\n",
2d00bd17 JP	378	PTR_ERR(dumper));
d7e09d03	379	else
b3669a7f	380	schedule();
d7e09d03 PT	381
	382	/* be sure to teardown if cfs_create_thread() failed */
	383	remove_wait_queue(&debug_ctlwq, &wait);
	384	set_current_state(TASK_RUNNING);
	385	}
	386	EXPORT_SYMBOL(libcfs_debug_dumplog);
	387
	388	int libcfs_debug_init(unsigned long bufsize)
	389	{
	390	int rc = 0;
	391	unsigned int max = libcfs_debug_mb;
	392
	393	init_waitqueue_head(&debug_ctlwq);
	394
	395	if (libcfs_console_max_delay <= 0 \|\| /* not set by user or */
	396	libcfs_console_min_delay <= 0 \|\| /* set to invalid values */
	397	libcfs_console_min_delay >= libcfs_console_max_delay) {
	398	libcfs_console_max_delay = CDEBUG_DEFAULT_MAX_DELAY;
	399	libcfs_console_min_delay = CDEBUG_DEFAULT_MIN_DELAY;
	400	}
	401
15d9f520	402	if (libcfs_debug_file_path) {
9563fe8a DE	403	strlcpy(libcfs_debug_file_path_arr,
	404	libcfs_debug_file_path,
	405	sizeof(libcfs_debug_file_path_arr));
d7e09d03 PT	406	}
	407
	408	/* If libcfs_debug_mb is set to an invalid value or uninitialized
a3fbcb3c OD	409	* then just make the total buffers smp_num_cpus * TCD_MAX_PAGES
a3fbcb3c OD	410	*/
d7e09d03 PT	411	if (max > cfs_trace_max_debug_mb() \|\| max < num_possible_cpus()) {
	412	max = TCD_MAX_PAGES;
	413	} else {
b6ee3824	414	max = max / num_possible_cpus();
09cbfeaf	415	max <<= (20 - PAGE_SHIFT);
d7e09d03 PT	416	}
	417	rc = cfs_tracefile_init(max);
	418
8dc08446	419	if (rc == 0) {
d7e09d03	420	libcfs_register_panic_notifier();
8dc08446 OD	421	libcfs_debug_mb = cfs_trace_get_debug_mb();
8dc08446 OD	422	}
d7e09d03 PT	423
	424	return rc;
	425	}
	426
	427	int libcfs_debug_cleanup(void)
	428	{
	429	libcfs_unregister_panic_notifier();
	430	cfs_tracefile_exit();
	431	return 0;
	432	}
	433
	434	int libcfs_debug_clear_buffer(void)
	435	{
	436	cfs_trace_flush_pages();
	437	return 0;
	438	}
	439
a3fbcb3c	440	/* Debug markers, although printed by S_LNET should not be be marked as such. */
d7e09d03 PT	441	#undef DEBUG_SUBSYSTEM
	442	#define DEBUG_SUBSYSTEM S_UNDEFINED
	443	int libcfs_debug_mark_buffer(const char *text)
	444	{
1d8cb70c GD	445	CDEBUG(D_TRACE,
1d8cb70c GD	446	"***************************************************\n");
d7e09d03	447	LCONSOLE(D_WARNING, "DEBUG MARKER: %s\n", text);
1d8cb70c GD	448	CDEBUG(D_TRACE,
1d8cb70c GD	449	"***************************************************\n");
d7e09d03 PT	450
	451	return 0;
	452	}
c9f6bb96	453
d7e09d03 PT	454	#undef DEBUG_SUBSYSTEM
d7e09d03 PT	455	#define DEBUG_SUBSYSTEM S_LNET