[mirror_zfs.git] / module / zfs / include / sys / fm / util.h

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
 */

#ifndef	_SYS_FM_UTIL_H
#define	_SYS_FM_UTIL_H

#ifdef	__cplusplus
extern "C" {
#endif

#include <sys/nvpair.h>
#include <sys/errorq.h>

/*
 * Shared user/kernel definitions for class length, error channel name,
 * and kernel event publisher string.
 */
#define	FM_MAX_CLASS 100
#define	FM_ERROR_CHAN	"com.sun:fm:error"
#define	FM_PUB		"fm"

/*
 * ereport dump device transport support
 *
 * Ereports are written out to the dump device at a proscribed offset from the
 * end, similar to in-transit log messages.  The ereports are represented as a
 * erpt_dump_t header followed by ed_size bytes of packed native nvlist data.
 *
 * NOTE: All of these constants and the header must be defined so they have the
 * same representation for *both* 32-bit and 64-bit producers and consumers.
 */
#define	ERPT_MAGIC	0xf00d4eddU
#define	ERPT_MAX_ERRS	16
#define	ERPT_DATA_SZ	(6 * 1024)
#define	ERPT_EVCH_MAX	256
#define	ERPT_HIWAT	64

typedef struct erpt_dump {
	uint32_t ed_magic;	/* ERPT_MAGIC or zero to indicate end */
	uint32_t ed_chksum;	/* checksum32() of packed nvlist data */
	uint32_t ed_size;	/* ereport (nvl) fixed buf size */
	uint32_t ed_pad;	/* reserved for future use */
	hrtime_t ed_hrt_nsec;	/* hrtime of this ereport */
	hrtime_t ed_hrt_base;	/* hrtime sample corresponding to ed_tod_base */
	struct {
		uint64_t sec;	/* seconds since gettimeofday() Epoch */
		uint64_t nsec;	/* nanoseconds past ed_tod_base.sec */
	} ed_tod_base;
} erpt_dump_t;

#ifdef _KERNEL
#include <sys/systm.h>

#define	FM_STK_DEPTH	20	/* maximum stack depth */
#define	FM_SYM_SZ	64	/* maximum symbol size */
#define	FM_ERR_PIL	2	/* PIL for ereport_errorq drain processing */

#define	FM_EREPORT_PAYLOAD_NAME_STACK		"stack"

extern errorq_t *ereport_errorq;
extern void *ereport_dumpbuf;
extern size_t ereport_dumplen;

extern void fm_init(void);
extern void fm_nvprint(nvlist_t *);
extern void fm_panic(const char *, ...);
extern void fm_banner(void);

extern void fm_ereport_dump(void);
extern void fm_ereport_post(nvlist_t *, int);

extern void fm_payload_stack_add(nvlist_t *, const pc_t *, int);

extern int is_fm_panic();
#endif  /* _KERNEL */

#ifdef	__cplusplus
}
#endif

#endif /* _SYS_FM_UTIL_H */
Commit	Line	Data
fa42225a BB	1	/*
	2	* CDDL HEADER START
	3	*
	4	* The contents of this file are subject to the terms of the
	5	* Common Development and Distribution License (the "License").
	6	* You may not use this file except in compliance with the License.
	7	*
	8	* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
	9	* or http://www.opensolaris.org/os/licensing.
	10	* See the License for the specific language governing permissions
	11	* and limitations under the License.
	12	*
	13	* When distributing Covered Code, include this CDDL HEADER in each
	14	* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
	15	* If applicable, add the following below this CDDL HEADER, with the
	16	* fields enclosed by brackets "[]" replaced with your own identifying
	17	* information: Portions Copyright [yyyy] [name of copyright owner]
	18	*
	19	* CDDL HEADER END
	20	*/
	21
	22	/*
572e2857	23	* Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
fa42225a BB	24	*/
	25
	26	#ifndef _SYS_FM_UTIL_H
	27	#define _SYS_FM_UTIL_H
	28
fa42225a BB	29	#ifdef __cplusplus
	30	extern "C" {
	31	#endif
	32
	33	#include <sys/nvpair.h>
	34	#include <sys/errorq.h>
	35
	36	/*
	37	* Shared user/kernel definitions for class length, error channel name,
	38	* and kernel event publisher string.
	39	*/
	40	#define FM_MAX_CLASS 100
	41	#define FM_ERROR_CHAN "com.sun:fm:error"
	42	#define FM_PUB "fm"
	43
	44	/*
	45	* ereport dump device transport support
	46	*
	47	* Ereports are written out to the dump device at a proscribed offset from the
	48	* end, similar to in-transit log messages. The ereports are represented as a
	49	* erpt_dump_t header followed by ed_size bytes of packed native nvlist data.
	50	*
	51	* NOTE: All of these constants and the header must be defined so they have the
	52	* same representation for both 32-bit and 64-bit producers and consumers.
	53	*/
	54	#define ERPT_MAGIC 0xf00d4eddU
	55	#define ERPT_MAX_ERRS 16
	56	#define ERPT_DATA_SZ (6 * 1024)
	57	#define ERPT_EVCH_MAX 256
	58	#define ERPT_HIWAT 64
	59
	60	typedef struct erpt_dump {
	61	uint32_t ed_magic; /* ERPT_MAGIC or zero to indicate end */
	62	uint32_t ed_chksum; /* checksum32() of packed nvlist data */
	63	uint32_t ed_size; /* ereport (nvl) fixed buf size */
	64	uint32_t ed_pad; /* reserved for future use */
	65	hrtime_t ed_hrt_nsec; /* hrtime of this ereport */
	66	hrtime_t ed_hrt_base; /* hrtime sample corresponding to ed_tod_base */
	67	struct {
	68	uint64_t sec; /* seconds since gettimeofday() Epoch */
	69	uint64_t nsec; /* nanoseconds past ed_tod_base.sec */
	70	} ed_tod_base;
	71	} erpt_dump_t;
	72
	73	#ifdef _KERNEL
	74	#include <sys/systm.h>
	75
	76	#define FM_STK_DEPTH 20 /* maximum stack depth */
	77	#define FM_SYM_SZ 64 /* maximum symbol size */
	78	#define FM_ERR_PIL 2 /* PIL for ereport_errorq drain processing */
	79
	80	#define FM_EREPORT_PAYLOAD_NAME_STACK "stack"
	81
	82	extern errorq_t *ereport_errorq;
	83	extern void *ereport_dumpbuf;
	84	extern size_t ereport_dumplen;
	85
	86	extern void fm_init(void);
	87	extern void fm_nvprint(nvlist_t *);
	88	extern void fm_panic(const char *, ...);
	89	extern void fm_banner(void);
	90
	91	extern void fm_ereport_dump(void);
	92	extern void fm_ereport_post(nvlist_t *, int);
93
94	extern void fm_payload_stack_add(nvlist_t , const pc_t , int);
95
572e2857	96	extern int is_fm_panic();
fa42225a BB	97	#endif /* _KERNEL */
	98
	99	#ifdef __cplusplus
	100	}
	101	#endif
	102
	103	#endif /* _SYS_FM_UTIL_H */