[mirror_spl-debian.git] / module / splat / splat-internal.h

/*****************************************************************************\
 *  Copyright (C) 2007-2010 Lawrence Livermore National Security, LLC.
 *  Copyright (C) 2007 The Regents of the University of California.
 *  Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
 *  Written by Brian Behlendorf <behlendorf1@llnl.gov>.
 *  UCRL-CODE-235197
 *
 *  This file is part of the SPL, Solaris Porting Layer.
 *  For details, see <http://github.com/behlendorf/spl/>.
 *
 *  The SPL is free software; you can redistribute it and/or modify it
 *  under the terms of the GNU General Public License as published by the
 *  Free Software Foundation; either version 2 of the License, or (at your
 *  option) any later version.
 *
 *  The SPL 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
 *  for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with the SPL.  If not, see <http://www.gnu.org/licenses/>.
\*****************************************************************************/

#ifndef _SPLAT_INTERNAL_H
#define _SPLAT_INTERNAL_H

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/string.h>
#include <linux/errno.h>
#include <linux/slab.h>
#include <linux/sched.h>
#include <linux/elf.h>
#include <linux/limits.h>
#include <linux/version.h>
#include <linux/vmalloc.h>
#include <linux/module.h>
#include <linux/device.h>
#include <linux/list.h>
#include <linux/swap.h>
#include <linux/delay.h>

#include <asm/ioctls.h>
#include <asm/uaccess.h>
#include <stdarg.h>

#include <sys/callb.h>
#include <sys/condvar.h>
#include <sys/cred.h>
#include <sys/sysmacros.h>
#include <sys/kmem.h>
#include <sys/kstat.h>
#include <sys/mutex.h>
#include <sys/random.h>
#include <sys/rwlock.h>
#include <sys/taskq.h>
#include <sys/thread.h>
#include <sys/time.h>
#include <sys/timer.h>
#include <sys/types.h>
#include <sys/kobj.h>
#include <sys/atomic.h>
#include <sys/list.h>
#include <sys/sunddi.h>
#include <linux/cdev.h>

#include "spl-device.h"
#include "splat-ctl.h"

#define SPLAT_SUBSYSTEM_INIT(type)                                      \
({      splat_subsystem_t *_sub_;                                       \
                                                                        \
        _sub_ = (splat_subsystem_t *)splat_##type##_init();             \
        if (_sub_ == NULL) {                                            \
                printk(KERN_ERR "splat: Error initializing: " #type "\n"); \
        } else {                                                        \
                spin_lock(&splat_module_lock);                          \
                list_add_tail(&(_sub_->subsystem_list),			\
		              &splat_module_list);			\
                spin_unlock(&splat_module_lock);                        \
        }                                                               \
})

#define SPLAT_SUBSYSTEM_FINI(type)                                      \
({      splat_subsystem_t *_sub_, *_tmp_;                               \
        int _id_, _flag_ = 0;                                           \
                                                                        \
	_id_ = splat_##type##_id();                                     \
        spin_lock(&splat_module_lock);                                  \
        list_for_each_entry_safe(_sub_, _tmp_,  &splat_module_list,	\
		                 subsystem_list) {			\
                if (_sub_->desc.id == _id_) {                           \
                        list_del_init(&(_sub_->subsystem_list));        \
                        spin_unlock(&splat_module_lock);                \
                        splat_##type##_fini(_sub_);                     \
			spin_lock(&splat_module_lock);			\
                        _flag_ = 1;                                     \
                }                                                       \
        }                                                               \
        spin_unlock(&splat_module_lock);                                \
                                                                        \
	if (!_flag_)                                                    \
                printk(KERN_ERR "splat: Error finalizing: " #type "\n"); \
})

#define SPLAT_TEST_INIT(sub, n, d, tid, func)				\
({      splat_test_t *_test_;                                           \
                                                                        \
	_test_ = (splat_test_t *)kmalloc(sizeof(*_test_), GFP_KERNEL);  \
        if (_test_ == NULL) {						\
		printk(KERN_ERR "splat: Error initializing: " n "/" #tid" \n");\
	} else {							\
		memset(_test_, 0, sizeof(*_test_));			\
		strncpy(_test_->desc.name, n, SPLAT_NAME_SIZE-1);	\
		strncpy(_test_->desc.desc, d, SPLAT_DESC_SIZE-1);	\
		_test_->desc.id = tid;					\
	        _test_->test = func;					\
		INIT_LIST_HEAD(&(_test_->test_list));			\
                spin_lock(&((sub)->test_lock));				\
                list_add_tail(&(_test_->test_list),&((sub)->test_list));\
                spin_unlock(&((sub)->test_lock));			\
        }								\
})

#define SPLAT_TEST_FINI(sub, tid)					\
({      splat_test_t *_test_, *_tmp_;                                   \
        int _flag_ = 0;							\
                                                                        \
        spin_lock(&((sub)->test_lock));					\
        list_for_each_entry_safe(_test_, _tmp_,				\
		                 &((sub)->test_list), test_list) {	\
                if (_test_->desc.id == tid) {                           \
                        list_del_init(&(_test_->test_list));		\
                        _flag_ = 1;                                     \
                }                                                       \
        }                                                               \
        spin_unlock(&((sub)->test_lock));				\
                                                                        \
	if (!_flag_)                                                    \
                printk(KERN_ERR "splat: Error finalizing: " #tid "\n");	\
})

typedef int (*splat_test_func_t)(struct file *, void *);

typedef struct splat_test {
	struct list_head test_list;
	splat_user_t desc;
	splat_test_func_t test;
} splat_test_t;

typedef struct splat_subsystem {
	struct list_head subsystem_list;/* List had to chain entries */
	splat_user_t desc;
	spinlock_t test_lock;
	struct list_head test_list;
} splat_subsystem_t;

#define SPLAT_INFO_BUFFER_SIZE		65536
#define SPLAT_INFO_BUFFER_REDZONE	256

typedef struct splat_info {
	spinlock_t info_lock;
	int info_size;
	char *info_buffer;
	char *info_head;	/* Internal kernel use only */
} splat_info_t;

#define sym2str(sym)			(char *)(#sym)

#define splat_print(file, format, args...)				\
({	splat_info_t *_info_ = (splat_info_t *)file->private_data;	\
	int _rc_;							\
									\
	ASSERT(_info_);							\
	ASSERT(_info_->info_buffer);					\
									\
	spin_lock(&_info_->info_lock);					\
									\
	/* Don't allow the kernel to start a write in the red zone */	\
	if ((int)(_info_->info_head - _info_->info_buffer) >		\
	    (SPLAT_INFO_BUFFER_SIZE - SPLAT_INFO_BUFFER_REDZONE)) {	\
		_rc_ = -EOVERFLOW;					\
	} else {							\
		_rc_ = sprintf(_info_->info_head, format, args);	\
		if (_rc_ >= 0)						\
			_info_->info_head += _rc_;			\
	}								\
									\
	spin_unlock(&_info_->info_lock);				\
	_rc_;								\
})

#define splat_vprint(file, test, format, args...)			\
	splat_print(file, "%*s: " format, SPLAT_NAME_SIZE, test, args)

#define splat_locked_test(lock, test)					\
({									\
	int _rc_;							\
	spin_lock(lock);						\
	_rc_ = (test) ? 1 : 0;						\
	spin_unlock(lock);						\
	_rc_;								\
})

splat_subsystem_t *splat_condvar_init(void);
splat_subsystem_t *splat_kmem_init(void);
splat_subsystem_t *splat_mutex_init(void);
splat_subsystem_t *splat_krng_init(void);
splat_subsystem_t *splat_rwlock_init(void);
splat_subsystem_t *splat_taskq_init(void);
splat_subsystem_t *splat_thread_init(void);
splat_subsystem_t *splat_time_init(void);
splat_subsystem_t *splat_vnode_init(void);
splat_subsystem_t *splat_kobj_init(void);
splat_subsystem_t *splat_atomic_init(void);
splat_subsystem_t *splat_list_init(void);
splat_subsystem_t *splat_generic_init(void);
splat_subsystem_t *splat_cred_init(void);

void splat_condvar_fini(splat_subsystem_t *);
void splat_kmem_fini(splat_subsystem_t *);
void splat_mutex_fini(splat_subsystem_t *);
void splat_krng_fini(splat_subsystem_t *);
void splat_rwlock_fini(splat_subsystem_t *);
void splat_taskq_fini(splat_subsystem_t *);
void splat_thread_fini(splat_subsystem_t *);
void splat_time_fini(splat_subsystem_t *);
void splat_vnode_fini(splat_subsystem_t *);
void splat_kobj_fini(splat_subsystem_t *);
void splat_atomic_fini(splat_subsystem_t *);
void splat_list_fini(splat_subsystem_t *);
void splat_generic_fini(splat_subsystem_t *);
void splat_cred_fini(splat_subsystem_t *);

int splat_condvar_id(void);
int splat_kmem_id(void);
int splat_mutex_id(void);
int splat_krng_id(void);
int splat_rwlock_id(void);
int splat_taskq_id(void);
int splat_thread_id(void);
int splat_time_id(void);
int splat_vnode_id(void);
int splat_kobj_id(void);
int splat_atomic_id(void);
int splat_list_id(void);
int splat_generic_id(void);
int splat_cred_id(void);

#endif /* _SPLAT_INTERNAL_H */
Commit	Line	Data
716154c5 BB	1	/*****************************************************************************\
	2	* Copyright (C) 2007-2010 Lawrence Livermore National Security, LLC.
	3	* Copyright (C) 2007 The Regents of the University of California.
	4	* Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
	5	* Written by Brian Behlendorf <behlendorf1@llnl.gov>.
715f6251	6	* UCRL-CODE-235197
715f6251	7	*
716154c5 BB	8	* This file is part of the SPL, Solaris Porting Layer.
	9	* For details, see <http://github.com/behlendorf/spl/>.
	10	*
	11	* The SPL is free software; you can redistribute it and/or modify it
	12	* under the terms of the GNU General Public License as published by the
	13	* Free Software Foundation; either version 2 of the License, or (at your
	14	* option) any later version.
715f6251	15	*
716154c5	16	* The SPL is distributed in the hope that it will be useful, but WITHOUT
715f6251	17	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	18	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
	19	* for more details.
	20	*
	21	* You should have received a copy of the GNU General Public License along
716154c5 BB	22	* with the SPL. If not, see <http://www.gnu.org/licenses/>.
716154c5 BB	23	\*****************************************************************************/
715f6251	24
7c50328b	25	#ifndef _SPLAT_INTERNAL_H
	26	#define _SPLAT_INTERNAL_H
	27
	28	#include <linux/kernel.h>
	29	#include <linux/module.h>
	30	#include <linux/string.h>
	31	#include <linux/errno.h>
	32	#include <linux/slab.h>
	33	#include <linux/sched.h>
	34	#include <linux/elf.h>
	35	#include <linux/limits.h>
	36	#include <linux/version.h>
	37	#include <linux/vmalloc.h>
	38	#include <linux/module.h>
	39	#include <linux/device.h>
	40	#include <linux/list.h>
ea3e6ca9	41	#include <linux/swap.h>
e811949a	42	#include <linux/delay.h>
86de8532	43
7c50328b	44	#include <asm/ioctls.h>
	45	#include <asm/uaccess.h>
	46	#include <stdarg.h>
	47
23f28c4f	48	#include <sys/callb.h>
	49	#include <sys/condvar.h>
	50	#include <sys/cred.h>
	51	#include <sys/sysmacros.h>
	52	#include <sys/kmem.h>
	53	#include <sys/kstat.h>
	54	#include <sys/mutex.h>
	55	#include <sys/random.h>
	56	#include <sys/rwlock.h>
	57	#include <sys/taskq.h>
	58	#include <sys/thread.h>
	59	#include <sys/time.h>
	60	#include <sys/timer.h>
	61	#include <sys/types.h>
9490c148	62	#include <sys/kobj.h>
9f4c835a	63	#include <sys/atomic.h>
d702c04f	64	#include <sys/list.h>
b871b8cd	65	#include <sys/sunddi.h>
46c685d0	66	#include <linux/cdev.h>
23f28c4f	67
46c685d0	68	#include "spl-device.h"
596e65b4	69	#include "splat-ctl.h"
7c50328b	70
7c50328b	71	#define SPLAT_SUBSYSTEM_INIT(type) \
8d0f1ee9	72	({ splat_subsystem_t *_sub_; \
7c50328b	73	\
8d0f1ee9	74	_sub_ = (splat_subsystem_t *)splat_##type##_init(); \
7c50328b	75	if (_sub_ == NULL) { \
8d0f1ee9	76	printk(KERN_ERR "splat: Error initializing: " #type "\n"); \
7c50328b	77	} else { \
8d0f1ee9	78	spin_lock(&splat_module_lock); \
8d0f1ee9	79	list_add_tail(&(_sub_->subsystem_list), \
7c50328b	80	&splat_module_list); \
8d0f1ee9	81	spin_unlock(&splat_module_lock); \
7c50328b	82	} \
	83	})
	84
	85	#define SPLAT_SUBSYSTEM_FINI(type) \
8d0f1ee9	86	({ splat_subsystem_t _sub_, _tmp_; \
7c50328b	87	int _id_, _flag_ = 0; \
7c50328b	88	\
8d0f1ee9	89	_id_ = splat_##type##_id(); \
8d0f1ee9	90	spin_lock(&splat_module_lock); \
7c50328b	91	list_for_each_entry_safe(_sub_, _tmp_, &splat_module_list, \
	92	subsystem_list) { \
	93	if (_sub_->desc.id == _id_) { \
	94	list_del_init(&(_sub_->subsystem_list)); \
8d0f1ee9	95	spin_unlock(&splat_module_lock); \
8d0f1ee9	96	splat_##type##_fini(_sub_); \
7c50328b	97	spin_lock(&splat_module_lock); \
	98	_flag_ = 1; \
	99	} \
	100	} \
8d0f1ee9	101	spin_unlock(&splat_module_lock); \
7c50328b	102	\
7c50328b	103	if (!_flag_) \
8d0f1ee9	104	printk(KERN_ERR "splat: Error finalizing: " #type "\n"); \
7c50328b	105	})
	106
	107	#define SPLAT_TEST_INIT(sub, n, d, tid, func) \
8d0f1ee9	108	({ splat_test_t *_test_; \
7c50328b	109	\
8d0f1ee9	110	_test_ = (splat_test_t )kmalloc(sizeof(_test_), GFP_KERNEL); \
7c50328b	111	if (_test_ == NULL) { \
8d0f1ee9	112	printk(KERN_ERR "splat: Error initializing: " n "/" #tid" \n");\
7c50328b	113	} else { \
7c50328b	114	memset(_test_, 0, sizeof(*_test_)); \
ac569b72	115	strncpy(_test_->desc.name, n, SPLAT_NAME_SIZE-1); \
ac569b72	116	strncpy(_test_->desc.desc, d, SPLAT_DESC_SIZE-1); \
7c50328b	117	_test_->desc.id = tid; \
	118	_test_->test = func; \
	119	INIT_LIST_HEAD(&(_test_->test_list)); \
	120	spin_lock(&((sub)->test_lock)); \
	121	list_add_tail(&(_test_->test_list),&((sub)->test_list));\
	122	spin_unlock(&((sub)->test_lock)); \
	123	} \
	124	})
	125
	126	#define SPLAT_TEST_FINI(sub, tid) \
8d0f1ee9	127	({ splat_test_t _test_, _tmp_; \
7c50328b	128	int _flag_ = 0; \
	129	\
	130	spin_lock(&((sub)->test_lock)); \
	131	list_for_each_entry_safe(_test_, _tmp_, \
	132	&((sub)->test_list), test_list) { \
	133	if (_test_->desc.id == tid) { \
	134	list_del_init(&(_test_->test_list)); \
	135	_flag_ = 1; \
	136	} \
	137	} \
	138	spin_unlock(&((sub)->test_lock)); \
	139	\
	140	if (!_flag_) \
8d0f1ee9	141	printk(KERN_ERR "splat: Error finalizing: " #tid "\n"); \
7c50328b	142	})
	143
	144	typedef int (splat_test_func_t)(struct file , void *);
	145
	146	typedef struct splat_test {
	147	struct list_head test_list;
	148	splat_user_t desc;
	149	splat_test_func_t test;
	150	} splat_test_t;
	151
	152	typedef struct splat_subsystem {
	153	struct list_head subsystem_list;/* List had to chain entries */
	154	splat_user_t desc;
	155	spinlock_t test_lock;
	156	struct list_head test_list;
	157	} splat_subsystem_t;
	158
	159	#define SPLAT_INFO_BUFFER_SIZE 65536
	160	#define SPLAT_INFO_BUFFER_REDZONE 256
	161
	162	typedef struct splat_info {
	163	spinlock_t info_lock;
	164	int info_size;
	165	char *info_buffer;
	166	char info_head; / Internal kernel use only */
	167	} splat_info_t;
	168
	169	#define sym2str(sym) (char *)(#sym)
	170
	171	#define splat_print(file, format, args...) \
d6a26c6a	172	({ splat_info_t _info_ = (splat_info_t )file->private_data; \
7c50328b	173	int _rc_; \
	174	\
	175	ASSERT(_info_); \
	176	ASSERT(_info_->info_buffer); \
	177	\
	178	spin_lock(&_info_->info_lock); \
	179	\
	180	/* Don't allow the kernel to start a write in the red zone */ \
	181	if ((int)(_info_->info_head - _info_->info_buffer) > \
	182	(SPLAT_INFO_BUFFER_SIZE - SPLAT_INFO_BUFFER_REDZONE)) { \
	183	_rc_ = -EOVERFLOW; \
	184	} else { \
	185	_rc_ = sprintf(_info_->info_head, format, args); \
	186	if (_rc_ >= 0) \
	187	_info_->info_head += _rc_; \
	188	} \
	189	\
	190	spin_unlock(&_info_->info_lock); \
	191	_rc_; \
	192	})
	193
d6a26c6a	194	#define splat_vprint(file, test, format, args...) \
7c50328b	195	splat_print(file, "%*s: " format, SPLAT_NAME_SIZE, test, args)
7c50328b	196
e811949a BB	197	#define splat_locked_test(lock, test) \
	198	({ \
	199	int _rc_; \
	200	spin_lock(lock); \
	201	_rc_ = (test) ? 1 : 0; \
	202	spin_unlock(lock); \
	203	_rc_; \
	204	})
	205
d702c04f BB	206	splat_subsystem_t *splat_condvar_init(void);
	207	splat_subsystem_t *splat_kmem_init(void);
	208	splat_subsystem_t *splat_mutex_init(void);
	209	splat_subsystem_t *splat_krng_init(void);
	210	splat_subsystem_t *splat_rwlock_init(void);
	211	splat_subsystem_t *splat_taskq_init(void);
	212	splat_subsystem_t *splat_thread_init(void);
	213	splat_subsystem_t *splat_time_init(void);
	214	splat_subsystem_t *splat_vnode_init(void);
	215	splat_subsystem_t *splat_kobj_init(void);
	216	splat_subsystem_t *splat_atomic_init(void);
	217	splat_subsystem_t *splat_list_init(void);
b871b8cd	218	splat_subsystem_t *splat_generic_init(void);
ec7d53e9	219	splat_subsystem_t *splat_cred_init(void);
7c50328b	220
	221	void splat_condvar_fini(splat_subsystem_t *);
	222	void splat_kmem_fini(splat_subsystem_t *);
	223	void splat_mutex_fini(splat_subsystem_t *);
	224	void splat_krng_fini(splat_subsystem_t *);
	225	void splat_rwlock_fini(splat_subsystem_t *);
	226	void splat_taskq_fini(splat_subsystem_t *);
	227	void splat_thread_fini(splat_subsystem_t *);
	228	void splat_time_fini(splat_subsystem_t *);
4b171585	229	void splat_vnode_fini(splat_subsystem_t *);
9490c148	230	void splat_kobj_fini(splat_subsystem_t *);
9f4c835a	231	void splat_atomic_fini(splat_subsystem_t *);
d702c04f	232	void splat_list_fini(splat_subsystem_t *);
b871b8cd	233	void splat_generic_fini(splat_subsystem_t *);
ec7d53e9	234	void splat_cred_fini(splat_subsystem_t *);
7c50328b	235
	236	int splat_condvar_id(void);
	237	int splat_kmem_id(void);
	238	int splat_mutex_id(void);
	239	int splat_krng_id(void);
	240	int splat_rwlock_id(void);
	241	int splat_taskq_id(void);
	242	int splat_thread_id(void);
	243	int splat_time_id(void);
4b171585	244	int splat_vnode_id(void);
9490c148	245	int splat_kobj_id(void);
9f4c835a	246	int splat_atomic_id(void);
d702c04f	247	int splat_list_id(void);
b871b8cd	248	int splat_generic_id(void);
ec7d53e9	249	int splat_cred_id(void);
7c50328b	250
7c50328b	251	#endif /* _SPLAT_INTERNAL_H */