/*
 * Copyright (c) 2005 The DragonFly Project.  All rights reserved.
 * 
 * This code is derived from software contributed to The DragonFly Project
 * by Matthew Dillon <dillon@backplane.com>
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name of The DragonFly Project nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific, prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * 
 * $DragonFly: src/sys/sys/ktr.h,v 1.9 2006/05/20 02:42:13 dillon Exp $
 */
/*
 * Generic Kernel trace buffer support.  
 *
 */

#ifndef _SYS_KTR_H_
#define	_SYS_KTR_H_

#ifndef _SYS_TYPES_H_
#include <sys/types.h>
#endif

#ifdef _KERNEL
#include "opt_ktr.h"
#endif

#if !defined(KTR_ALL)
#define KTR_ALL		0
#endif

#define	KTR_BUFSIZE	48
#define KTR_VERSION	3

#ifndef LOCORE

struct ktr_info {
	const char *kf_name;	/* human-interpreted subsystem name */
	int32_t *kf_master_enable; /* the master enable variable */
	const char *kf_format;	/* data format */
	int kf_data_size;	/* relevance of the data buffer */
};

struct ktr_entry {
	u_int64_t ktr_timestamp;
	struct ktr_info *ktr_info;
	const	char *ktr_file;
	void	*ktr_caller1;
	void	*ktr_caller2;
	int32_t	ktr_line;
	int32_t ktr_unused;
	int32_t	ktr_data[KTR_BUFSIZE / sizeof(int32_t)];
};

void	ktr_log(struct ktr_info *info, const char *file, int line, ...);
void	ktr_log_ptr(struct ktr_info *info, const char *file, int line, const void *ptr);
void    cpu_ktr_caller(struct ktr_entry *ktr);

/*
 * Take advantage of constant integer optimizations by the compiler
 * to optimize-out disabled code at compile-time.  If KTR_ENABLE_<name>
 * is 0, the compiler avoids generating all related code when KTR is enabled.
 */

#ifdef KTR

SYSCTL_DECL(_debug_ktr);

#define KTR_INFO_MASTER(master)						    \
	    SYSCTL_NODE(_debug_ktr, OID_AUTO, master, CTLFLAG_RW, 0, "");   \
	    int ktr_ ## master ## _enable = -1;				    \
	    SYSCTL_INT(_debug_ktr, OID_AUTO, master ## _enable, CTLFLAG_RW, \
			&ktr_ ## master ## _enable, 0, "")

#define KTR_INFO_MASTER_EXTERN(master)					\
	    SYSCTL_DECL(_debug_ktr_ ## master);				\
	    extern int ktr_ ## master ## _enable			\

/*
 * This creates a read-only sysctl so the user knows what the mask
 * definitions are and a number of static const int's which are used
 * by the compiler to optimize the trace logging at compile-time and
 * run-time.
 */
#define KTR_INFO(compile, master, name, maskbit, format, datasize)	\
	    static const int ktr_ ## master ## _ ## name ## _mask =	\
		1 << maskbit;						\
	    static const int ktr_ ## master ## _ ## name ## _enable =	\
		compile;						\
	    static int ktr_ ## master ## _ ## name ## _mask_ro =	\
		1 << maskbit;						\
	    SYSCTL_INT(_debug_ktr_ ## master, OID_AUTO, name ## _mask,	\
		CTLFLAG_RD, &ktr_ ## master ## _ ## name ## _mask_ro,	\
		0, "");							\
	    static struct ktr_info ktr_info_ ## master ## _ ## name = { \
		#master "_" #name,					\
		&ktr_ ## master ## _enable,				\
		format,							\
		datasize }

#define KTR_LOG(name, args...)						\
	    if (ktr_ ## name ## _enable &&				\
	      (ktr_ ## name ## _mask & *ktr_info_ ## name .kf_master_enable)) \
	    ktr_log(&ktr_info_ ## name, __FILE__, __LINE__, ##args)

#define KTR_LOG_PTR(name, ptr)						\
	    if (ktr_ ## name ## _enable &&				\
	      (ktr_ ## name ## _mask & *ktr_info_ ## name .kf_master_enable)) \
	    ktr_log_ptr(&ktr_info_ ## name, __FILE__, __LINE__, ptr)

#else

#define KTR_INFO_MASTER(master)						\
	    const static int ktr_ ## master ## _enable = 0

#define KTR_INFO_MASTER_EXTERN(master)					\
	    const static int ktr_ ## master ## _enable = 0

#define KTR_INFO(compile, master, name, maskbit, format, datasize)	\
	    static const int ktr_ ## master ## _ ## name ## _mask =	\
		1 << maskbit

#define KTR_LOG(info, args...)
#define KTR_LOG_PTR(info, ptr)

#endif

#endif /* !LOCORE */
#endif /* !_SYS_KTR_H_ */