[mirror_ubuntu-zesty-kernel.git] / drivers / staging / lustre / lnet / libcfs / tracefile.h

/*
 * 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.sun.com/software/products/lustre/docs/GPLv2.pdf
 *
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
 * CA 95054 USA or visit www.sun.com if you need additional information or
 * have any questions.
 *
 * GPL HEADER END
 */
/*
 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
 * Use is subject to license terms.
 *
 * Copyright (c) 2012, Intel Corporation.
 */
/*
 * This file is part of Lustre, http://www.lustre.org/
 * Lustre is a trademark of Sun Microsystems, Inc.
 */

#ifndef __LIBCFS_TRACEFILE_H__
#define __LIBCFS_TRACEFILE_H__

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

enum cfs_trace_buf_type {
	CFS_TCD_TYPE_PROC = 0,
	CFS_TCD_TYPE_SOFTIRQ,
	CFS_TCD_TYPE_IRQ,
	CFS_TCD_TYPE_MAX
};

/* trace file lock routines */

#define TRACEFILE_NAME_SIZE 1024
extern char      cfs_tracefile[TRACEFILE_NAME_SIZE];
extern long long cfs_tracefile_size;

void libcfs_run_debug_log_upcall(char *file);

int  cfs_tracefile_init_arch(void);
void cfs_tracefile_fini_arch(void);

void cfs_tracefile_read_lock(void);
void cfs_tracefile_read_unlock(void);
void cfs_tracefile_write_lock(void);
void cfs_tracefile_write_unlock(void);

int cfs_tracefile_dump_all_pages(char *filename);
void cfs_trace_debug_print(void);
void cfs_trace_flush_pages(void);
int cfs_trace_start_thread(void);
void cfs_trace_stop_thread(void);
int cfs_tracefile_init(int max_pages);
void cfs_tracefile_exit(void);

int cfs_trace_copyin_string(char *knl_buffer, int knl_buffer_nob,
			    const char __user *usr_buffer, int usr_buffer_nob);
int cfs_trace_copyout_string(char __user *usr_buffer, int usr_buffer_nob,
			     const char *knl_str, char *append);
int cfs_trace_allocate_string_buffer(char **str, int nob);
int cfs_trace_dump_debug_buffer_usrstr(void __user *usr_str, int usr_str_nob);
int cfs_trace_daemon_command(char *str);
int cfs_trace_daemon_command_usrstr(void __user *usr_str, int usr_str_nob);
int cfs_trace_set_debug_mb(int mb);
int cfs_trace_get_debug_mb(void);

void libcfs_debug_dumplog_internal(void *arg);
void libcfs_register_panic_notifier(void);
void libcfs_unregister_panic_notifier(void);
extern int  libcfs_panic_in_progress;
int cfs_trace_max_debug_mb(void);

#define TCD_MAX_PAGES (5 << (20 - PAGE_SHIFT))
#define TCD_STOCK_PAGES (TCD_MAX_PAGES)
#define CFS_TRACEFILE_SIZE (500 << 20)

#ifdef LUSTRE_TRACEFILE_PRIVATE

/*
 * Private declare for tracefile
 */
#define TCD_MAX_PAGES (5 << (20 - PAGE_SHIFT))
#define TCD_STOCK_PAGES (TCD_MAX_PAGES)

#define CFS_TRACEFILE_SIZE (500 << 20)

/*
 * Size of a buffer for sprinting console messages if we can't get a page
 * from system
 */
#define CFS_TRACE_CONSOLE_BUFFER_SIZE   1024

union cfs_trace_data_union {
	struct cfs_trace_cpu_data {
		/*
		 * Even though this structure is meant to be per-CPU, locking
		 * is needed because in some places the data may be accessed
		 * from other CPUs. This lock is directly used in trace_get_tcd
		 * and trace_put_tcd, which are called in libcfs_debug_vmsg2 and
		 * tcd_for_each_type_lock
		 */
		spinlock_t		tcd_lock;
		unsigned long	   tcd_lock_flags;

		/*
		 * pages with trace records not yet processed by tracefiled.
		 */
		struct list_head	      tcd_pages;
		/* number of pages on ->tcd_pages */
		unsigned long	   tcd_cur_pages;

		/*
		 * pages with trace records already processed by
		 * tracefiled. These pages are kept in memory, so that some
		 * portion of log can be written in the event of LBUG. This
		 * list is maintained in LRU order.
		 *
		 * Pages are moved to ->tcd_daemon_pages by tracefiled()
		 * (put_pages_on_daemon_list()). LRU pages from this list are
		 * discarded when list grows too large.
		 */
		struct list_head	      tcd_daemon_pages;
		/* number of pages on ->tcd_daemon_pages */
		unsigned long	   tcd_cur_daemon_pages;

		/*
		 * Maximal number of pages allowed on ->tcd_pages and
		 * ->tcd_daemon_pages each.
		 * Always TCD_MAX_PAGES * tcd_pages_factor / 100 in current
		 * implementation.
		 */
		unsigned long	   tcd_max_pages;

		/*
		 * preallocated pages to write trace records into. Pages from
		 * ->tcd_stock_pages are moved to ->tcd_pages by
		 * portals_debug_msg().
		 *
		 * This list is necessary, because on some platforms it's
		 * impossible to perform efficient atomic page allocation in a
		 * non-blockable context.
		 *
		 * Such platforms fill ->tcd_stock_pages "on occasion", when
		 * tracing code is entered in blockable context.
		 *
		 * trace_get_tage_try() tries to get a page from
		 * ->tcd_stock_pages first and resorts to atomic page
		 * allocation only if this queue is empty. ->tcd_stock_pages
		 * is replenished when tracing code is entered in blocking
		 * context (darwin-tracefile.c:trace_get_tcd()). We try to
		 * maintain TCD_STOCK_PAGES (40 by default) pages in this
		 * queue. Atomic allocation is only required if more than
		 * TCD_STOCK_PAGES pagesful are consumed by trace records all
		 * emitted in non-blocking contexts. Which is quite unlikely.
		 */
		struct list_head	      tcd_stock_pages;
		/* number of pages on ->tcd_stock_pages */
		unsigned long	   tcd_cur_stock_pages;

		unsigned short	  tcd_shutting_down;
		unsigned short	  tcd_cpu;
		unsigned short	  tcd_type;
		/* The factors to share debug memory. */
		unsigned short	  tcd_pages_factor;
	} tcd;
	char __pad[L1_CACHE_ALIGN(sizeof(struct cfs_trace_cpu_data))];
};

#define TCD_MAX_TYPES      8
extern union cfs_trace_data_union (*cfs_trace_data[TCD_MAX_TYPES])[NR_CPUS];

#define cfs_tcd_for_each(tcd, i, j)				       \
	for (i = 0; cfs_trace_data[i]; i++)				\
		for (j = 0, ((tcd) = &(*cfs_trace_data[i])[j].tcd);	\
		     j < num_possible_cpus();				 \
		     j++, (tcd) = &(*cfs_trace_data[i])[j].tcd)

#define cfs_tcd_for_each_type_lock(tcd, i, cpu)			   \
	for (i = 0; cfs_trace_data[i] &&				\
	     (tcd = &(*cfs_trace_data[i])[cpu].tcd) &&			\
	     cfs_trace_lock_tcd(tcd, 1); cfs_trace_unlock_tcd(tcd, 1), i++)

void cfs_set_ptldebug_header(struct ptldebug_header *header,
			     struct libcfs_debug_msg_data *m,
			     unsigned long stack);
void cfs_print_to_console(struct ptldebug_header *hdr, int mask,
			  const char *buf, int len, const char *file,
			  const char *fn);

int cfs_trace_lock_tcd(struct cfs_trace_cpu_data *tcd, int walking);
void cfs_trace_unlock_tcd(struct cfs_trace_cpu_data *tcd, int walking);

extern char *cfs_trace_console_buffers[NR_CPUS][CFS_TCD_TYPE_MAX];
enum cfs_trace_buf_type cfs_trace_buf_idx_get(void);

static inline char *
cfs_trace_get_console_buffer(void)
{
	unsigned int i = get_cpu();
	unsigned int j = cfs_trace_buf_idx_get();

	return cfs_trace_console_buffers[i][j];
}

static inline struct cfs_trace_cpu_data *
cfs_trace_get_tcd(void)
{
	struct cfs_trace_cpu_data *tcd =
		&(*cfs_trace_data[cfs_trace_buf_idx_get()])[get_cpu()].tcd;

	cfs_trace_lock_tcd(tcd, 0);

	return tcd;
}

static inline void cfs_trace_put_tcd(struct cfs_trace_cpu_data *tcd)
{
	cfs_trace_unlock_tcd(tcd, 0);

	put_cpu();
}

int cfs_trace_refill_stock(struct cfs_trace_cpu_data *tcd, gfp_t gfp,
			   struct list_head *stock);

void cfs_trace_assertion_failed(const char *str,
				struct libcfs_debug_msg_data *m);

/* ASSERTION that is safe to use within the debug system */
#define __LASSERT(cond)						 \
do {								    \
	if (unlikely(!(cond))) {					\
		LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_EMERG, NULL);     \
		cfs_trace_assertion_failed("ASSERTION("#cond") failed", \
					   &msgdata);		   \
	}							       \
} while (0)

#define __LASSERT_TAGE_INVARIANT(tage)				  \
do {								    \
	__LASSERT(tage);					\
	__LASSERT(tage->page);				  \
	__LASSERT(tage->used <= PAGE_SIZE);			 \
	__LASSERT(page_count(tage->page) > 0);		      \
} while (0)

#endif	/* LUSTRE_TRACEFILE_PRIVATE */

#endif /* __LIBCFS_TRACEFILE_H__ */
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
	18	* http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
	19	*
	20	* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
	21	* CA 95054 USA or visit www.sun.com if you need additional information or
	22	* have any questions.
	23	*
	24	* GPL HEADER END
	25	*/
	26	/*
	27	* Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
	28	* Use is subject to license terms.
	29	*
	30	* Copyright (c) 2012, Intel Corporation.
	31	*/
	32	/*
	33	* This file is part of Lustre, http://www.lustre.org/
	34	* Lustre is a trademark of Sun Microsystems, Inc.
	35	*/
	36
	37	#ifndef __LIBCFS_TRACEFILE_H__
	38	#define __LIBCFS_TRACEFILE_H__
	39
9fdaf8c0	40	#include "../../include/linux/libcfs/libcfs.h"
d7e09d03	41
4a44ab68	42	enum cfs_trace_buf_type {
f11e1de2 JH	43	CFS_TCD_TYPE_PROC = 0,
	44	CFS_TCD_TYPE_SOFTIRQ,
	45	CFS_TCD_TYPE_IRQ,
	46	CFS_TCD_TYPE_MAX
4a44ab68	47	};
d7e09d03 PT	48
	49	/* trace file lock routines */
	50
	51	#define TRACEFILE_NAME_SIZE 1024
	52	extern char cfs_tracefile[TRACEFILE_NAME_SIZE];
	53	extern long long cfs_tracefile_size;
	54
8150a97f	55	void libcfs_run_debug_log_upcall(char *file);
d7e09d03 PT	56
	57	int cfs_tracefile_init_arch(void);
	58	void cfs_tracefile_fini_arch(void);
	59
	60	void cfs_tracefile_read_lock(void);
	61	void cfs_tracefile_read_unlock(void);
	62	void cfs_tracefile_write_lock(void);
	63	void cfs_tracefile_write_unlock(void);
	64
	65	int cfs_tracefile_dump_all_pages(char *filename);
	66	void cfs_trace_debug_print(void);
	67	void cfs_trace_flush_pages(void);
	68	int cfs_trace_start_thread(void);
	69	void cfs_trace_stop_thread(void);
	70	int cfs_tracefile_init(int max_pages);
	71	void cfs_tracefile_exit(void);
	72
d7e09d03	73	int cfs_trace_copyin_string(char *knl_buffer, int knl_buffer_nob,
5a08f067 LC	74	const char __user *usr_buffer, int usr_buffer_nob);
5a08f067 LC	75	int cfs_trace_copyout_string(char __user *usr_buffer, int usr_buffer_nob,
d7e09d03 PT	76	const char knl_str, char append);
d7e09d03 PT	77	int cfs_trace_allocate_string_buffer(char **str, int nob);
5a08f067	78	int cfs_trace_dump_debug_buffer_usrstr(void __user *usr_str, int usr_str_nob);
d7e09d03	79	int cfs_trace_daemon_command(char *str);
5a08f067	80	int cfs_trace_daemon_command_usrstr(void __user *usr_str, int usr_str_nob);
d7e09d03	81	int cfs_trace_set_debug_mb(int mb);
d7e09d03 PT	82	int cfs_trace_get_debug_mb(void);
d7e09d03 PT	83
8150a97f JP	84	void libcfs_debug_dumplog_internal(void *arg);
	85	void libcfs_register_panic_notifier(void);
	86	void libcfs_unregister_panic_notifier(void);
d7e09d03	87	extern int libcfs_panic_in_progress;
8150a97f	88	int cfs_trace_max_debug_mb(void);
d7e09d03	89
09cbfeaf	90	#define TCD_MAX_PAGES (5 << (20 - PAGE_SHIFT))
d7e09d03 PT	91	#define TCD_STOCK_PAGES (TCD_MAX_PAGES)
	92	#define CFS_TRACEFILE_SIZE (500 << 20)
	93
	94	#ifdef LUSTRE_TRACEFILE_PRIVATE
	95
	96	/*
	97	* Private declare for tracefile
	98	*/
09cbfeaf	99	#define TCD_MAX_PAGES (5 << (20 - PAGE_SHIFT))
d7e09d03 PT	100	#define TCD_STOCK_PAGES (TCD_MAX_PAGES)
	101
	102	#define CFS_TRACEFILE_SIZE (500 << 20)
	103
a3fbcb3c OD	104	/*
	105	* Size of a buffer for sprinting console messages if we can't get a page
	106	* from system
	107	*/
d7e09d03 PT	108	#define CFS_TRACE_CONSOLE_BUFFER_SIZE 1024
	109
	110	union cfs_trace_data_union {
	111	struct cfs_trace_cpu_data {
	112	/*
	113	* Even though this structure is meant to be per-CPU, locking
	114	* is needed because in some places the data may be accessed
	115	* from other CPUs. This lock is directly used in trace_get_tcd
	116	* and trace_put_tcd, which are called in libcfs_debug_vmsg2 and
	117	* tcd_for_each_type_lock
	118	*/
	119	spinlock_t tcd_lock;
	120	unsigned long tcd_lock_flags;
	121
	122	/*
	123	* pages with trace records not yet processed by tracefiled.
	124	*/
	125	struct list_head tcd_pages;
	126	/* number of pages on ->tcd_pages */
	127	unsigned long tcd_cur_pages;
	128
	129	/*
	130	* pages with trace records already processed by
	131	* tracefiled. These pages are kept in memory, so that some
	132	* portion of log can be written in the event of LBUG. This
	133	* list is maintained in LRU order.
	134	*
	135	* Pages are moved to ->tcd_daemon_pages by tracefiled()
	136	* (put_pages_on_daemon_list()). LRU pages from this list are
	137	* discarded when list grows too large.
	138	*/
	139	struct list_head tcd_daemon_pages;
	140	/* number of pages on ->tcd_daemon_pages */
	141	unsigned long tcd_cur_daemon_pages;
	142
	143	/*
	144	* Maximal number of pages allowed on ->tcd_pages and
	145	* ->tcd_daemon_pages each.
	146	* Always TCD_MAX_PAGES * tcd_pages_factor / 100 in current
	147	* implementation.
	148	*/
	149	unsigned long tcd_max_pages;
	150
	151	/*
	152	* preallocated pages to write trace records into. Pages from
	153	* ->tcd_stock_pages are moved to ->tcd_pages by
	154	* portals_debug_msg().
	155	*
	156	* This list is necessary, because on some platforms it's
	157	* impossible to perform efficient atomic page allocation in a
	158	* non-blockable context.
	159	*
	160	* Such platforms fill ->tcd_stock_pages "on occasion", when
	161	* tracing code is entered in blockable context.
	162	*
	163	* trace_get_tage_try() tries to get a page from
	164	* ->tcd_stock_pages first and resorts to atomic page
	165	* allocation only if this queue is empty. ->tcd_stock_pages
	166	* is replenished when tracing code is entered in blocking
	167	* context (darwin-tracefile.c:trace_get_tcd()). We try to
	168	* maintain TCD_STOCK_PAGES (40 by default) pages in this
	169	* queue. Atomic allocation is only required if more than
	170	* TCD_STOCK_PAGES pagesful are consumed by trace records all
	171	* emitted in non-blocking contexts. Which is quite unlikely.
172	*/
173	struct list_head tcd_stock_pages;
174	/* number of pages on ->tcd_stock_pages */
175	unsigned long tcd_cur_stock_pages;
176
177	unsigned short tcd_shutting_down;
178	unsigned short tcd_cpu;
179	unsigned short tcd_type;
180	/* The factors to share debug memory. */
181	unsigned short tcd_pages_factor;
182	} tcd;
183	char __pad[L1_CACHE_ALIGN(sizeof(struct cfs_trace_cpu_data))];
184	};
185
186	#define TCD_MAX_TYPES 8
187	extern union cfs_trace_data_union (*cfs_trace_data[TCD_MAX_TYPES])[NR_CPUS];
188
189	#define cfs_tcd_for_each(tcd, i, j) \
15d9f520 OD	190	for (i = 0; cfs_trace_data[i]; i++) \
	191	for (j = 0, ((tcd) = &(*cfs_trace_data[i])[j].tcd); \
	192	j < num_possible_cpus(); \
	193	j++, (tcd) = &(*cfs_trace_data[i])[j].tcd)
d7e09d03 PT	194
d7e09d03 PT	195	#define cfs_tcd_for_each_type_lock(tcd, i, cpu) \
36355e39 OD	196	for (i = 0; cfs_trace_data[i] && \
	197	(tcd = &(*cfs_trace_data[i])[cpu].tcd) && \
	198	cfs_trace_lock_tcd(tcd, 1); cfs_trace_unlock_tcd(tcd, 1), i++)
d7e09d03	199
8150a97f JP	200	void cfs_set_ptldebug_header(struct ptldebug_header *header,
	201	struct libcfs_debug_msg_data *m,
	202	unsigned long stack);
	203	void cfs_print_to_console(struct ptldebug_header *hdr, int mask,
	204	const char buf, int len, const char file,
	205	const char *fn);
d7e09d03	206
8150a97f JP	207	int cfs_trace_lock_tcd(struct cfs_trace_cpu_data *tcd, int walking);
8150a97f JP	208	void cfs_trace_unlock_tcd(struct cfs_trace_cpu_data *tcd, int walking);
d7e09d03	209
d7e09d03	210	extern char *cfs_trace_console_buffers[NR_CPUS][CFS_TCD_TYPE_MAX];
4a44ab68	211	enum cfs_trace_buf_type cfs_trace_buf_idx_get(void);
d7e09d03 PT	212
	213	static inline char *
	214	cfs_trace_get_console_buffer(void)
	215	{
	216	unsigned int i = get_cpu();
	217	unsigned int j = cfs_trace_buf_idx_get();
	218
	219	return cfs_trace_console_buffers[i][j];
	220	}
	221
d7e09d03 PT	222	static inline struct cfs_trace_cpu_data *
	223	cfs_trace_get_tcd(void)
	224	{
	225	struct cfs_trace_cpu_data *tcd =
	226	&(*cfs_trace_data[cfs_trace_buf_idx_get()])[get_cpu()].tcd;
	227
	228	cfs_trace_lock_tcd(tcd, 0);
	229
	230	return tcd;
	231	}
	232
ad6eb8bb	233	static inline void cfs_trace_put_tcd(struct cfs_trace_cpu_data *tcd)
d7e09d03 PT	234	{
	235	cfs_trace_unlock_tcd(tcd, 0);
	236
	237	put_cpu();
	238	}
	239
cad7aa13	240	int cfs_trace_refill_stock(struct cfs_trace_cpu_data *tcd, gfp_t gfp,
d7e09d03 PT	241	struct list_head *stock);
d7e09d03 PT	242
8150a97f JP	243	void cfs_trace_assertion_failed(const char *str,
8150a97f JP	244	struct libcfs_debug_msg_data *m);
d7e09d03 PT	245
	246	/* ASSERTION that is safe to use within the debug system */
	247	#define __LASSERT(cond) \
	248	do { \
	249	if (unlikely(!(cond))) { \
	250	LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_EMERG, NULL); \
	251	cfs_trace_assertion_failed("ASSERTION("#cond") failed", \
	252	&msgdata); \
	253	} \
	254	} while (0)
	255
	256	#define __LASSERT_TAGE_INVARIANT(tage) \
	257	do { \
15d9f520 OD	258	__LASSERT(tage); \
15d9f520 OD	259	__LASSERT(tage->page); \
09cbfeaf	260	__LASSERT(tage->used <= PAGE_SIZE); \
d7e09d03 PT	261	__LASSERT(page_count(tage->page) > 0); \
	262	} while (0)
	263
	264	#endif /* LUSTRE_TRACEFILE_PRIVATE */
	265
	266	#endif /* __LIBCFS_TRACEFILE_H__ */