Home | History | Annotate | Download | only in fm
      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 /*
     23  * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
     24  * Use is subject to license terms.
     25  */
     26 
     27 #ifndef	_SYS_FM_UTIL_H
     28 #define	_SYS_FM_UTIL_H
     29 
     30 #pragma ident	"%Z%%M%	%I%	%E% SMI"
     31 
     32 #ifdef	__cplusplus
     33 extern "C" {
     34 #endif
     35 
     36 #include <sys/nvpair.h>
     37 #include <sys/errorq.h>
     38 
     39 /*
     40  * Shared user/kernel definitions for class length, error channel name,
     41  * and kernel event publisher string.
     42  */
     43 #define	FM_MAX_CLASS 100
     44 #define	FM_ERROR_CHAN	"com.sun:fm:error"
     45 #define	FM_PUB		"fm"
     46 
     47 /*
     48  * ereport dump device transport support
     49  *
     50  * Ereports are written out to the dump device at a proscribed offset from the
     51  * end, similar to in-transit log messages.  The ereports are represented as a
     52  * erpt_dump_t header followed by ed_size bytes of packed native nvlist data.
     53  *
     54  * NOTE: All of these constants and the header must be defined so they have the
     55  * same representation for *both* 32-bit and 64-bit producers and consumers.
     56  */
     57 #define	ERPT_MAGIC	0xf00d4eddU
     58 #define	ERPT_MAX_ERRS	16
     59 #define	ERPT_DATA_SZ	(6 * 1024)
     60 #define	ERPT_EVCH_MAX	256
     61 #define	ERPT_HIWAT	64
     62 
     63 typedef struct erpt_dump {
     64 	uint32_t ed_magic;	/* ERPT_MAGIC or zero to indicate end */
     65 	uint32_t ed_chksum;	/* checksum32() of packed nvlist data */
     66 	uint32_t ed_size;	/* ereport (nvl) fixed buf size */
     67 	uint32_t ed_pad;	/* reserved for future use */
     68 	hrtime_t ed_hrt_nsec;	/* hrtime of this ereport */
     69 	hrtime_t ed_hrt_base;	/* hrtime sample corresponding to ed_tod_base */
     70 	struct {
     71 		uint64_t sec;	/* seconds since gettimeofday() Epoch */
     72 		uint64_t nsec;	/* nanoseconds past ed_tod_base.sec */
     73 	} ed_tod_base;
     74 } erpt_dump_t;
     75 
     76 #ifdef _KERNEL
     77 #include <sys/systm.h>
     78 
     79 #define	FM_STK_DEPTH	20	/* maximum stack depth */
     80 #define	FM_SYM_SZ	64	/* maximum symbol size */
     81 #define	FM_ERR_PIL	2	/* PIL for ereport_errorq drain processing */
     82 
     83 #define	FM_EREPORT_PAYLOAD_NAME_STACK		"stack"
     84 
     85 extern errorq_t *ereport_errorq;
     86 extern void *ereport_dumpbuf;
     87 extern size_t ereport_dumplen;
     88 
     89 extern void fm_init(void);
     90 extern void fm_nvprint(nvlist_t *);
     91 extern void fm_panic(const char *, ...);
     92 extern void fm_banner(void);
     93 
     94 extern void fm_ereport_dump(void);
     95 extern void fm_ereport_post(nvlist_t *, int);
     96 
     97 extern void fm_payload_stack_add(nvlist_t *, const pc_t *, int);
     98 
     99 #endif  /* _KERNEL */
    100 
    101 #ifdef	__cplusplus
    102 }
    103 #endif
    104 
    105 #endif /* _SYS_FM_UTIL_H */
    106