xref: /onnv-gate/usr/src/uts/common/sys/log.h (revision 0)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright 2003 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate /*	Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T */
28*0Sstevel@tonic-gate /*	  All Rights Reserved	*/
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #ifndef _SYS_LOG_H
31*0Sstevel@tonic-gate #define	_SYS_LOG_H
32*0Sstevel@tonic-gate 
33*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
34*0Sstevel@tonic-gate 
35*0Sstevel@tonic-gate #include <sys/types.h>
36*0Sstevel@tonic-gate #include <sys/strlog.h>
37*0Sstevel@tonic-gate #include <sys/stream.h>
38*0Sstevel@tonic-gate 
39*0Sstevel@tonic-gate #ifdef	__cplusplus
40*0Sstevel@tonic-gate extern "C" {
41*0Sstevel@tonic-gate #endif
42*0Sstevel@tonic-gate 
43*0Sstevel@tonic-gate #define	LOG_CONSMIN	0		/* /dev/conslog minor */
44*0Sstevel@tonic-gate #define	LOG_LOGMIN	5		/* /dev/log clone-open minor */
45*0Sstevel@tonic-gate #define	LOG_BACKLOG	LOG_LOGMIN	/* console backlog queue */
46*0Sstevel@tonic-gate 
47*0Sstevel@tonic-gate #define	LOG_LOGMINIDX	0		/* index of smallest /dev/log clone */
48*0Sstevel@tonic-gate #define	LOG_LOGMAXIDX	15		/* up to 16 /dev/log clones */
49*0Sstevel@tonic-gate #define	LOG_NUMCLONES	(LOG_LOGMAXIDX - LOG_LOGMINIDX + 1)
50*0Sstevel@tonic-gate 
51*0Sstevel@tonic-gate #define	LOG_MID		44		/* module ID */
52*0Sstevel@tonic-gate #define	LOG_MINPS	0		/* min packet size */
53*0Sstevel@tonic-gate #define	LOG_MAXPS	1024		/* max packet size */
54*0Sstevel@tonic-gate #define	LOG_LOWAT	2048		/* threshold for backenable */
55*0Sstevel@tonic-gate #define	LOG_HIWAT	1048576		/* threshold for tossing messages */
56*0Sstevel@tonic-gate 
57*0Sstevel@tonic-gate #define	LOG_MAGIC	0xf00d4109U	/* "food for log" - unsent msg magic */
58*0Sstevel@tonic-gate #define	LOG_RECENTSIZE	8192		/* queue of most recent messages */
59*0Sstevel@tonic-gate #define	LOG_MINFREE	4096		/* message cache low water mark */
60*0Sstevel@tonic-gate #define	LOG_MAXFREE	8192		/* message cache high water mark */
61*0Sstevel@tonic-gate 
62*0Sstevel@tonic-gate typedef struct log log_t;
63*0Sstevel@tonic-gate typedef int (log_filter_t)(log_t *, log_ctl_t *);
64*0Sstevel@tonic-gate 
65*0Sstevel@tonic-gate struct log {
66*0Sstevel@tonic-gate 	queue_t		*log_q;		/* message queue */
67*0Sstevel@tonic-gate 	log_filter_t	*log_wanted;	/* message filter */
68*0Sstevel@tonic-gate 	mblk_t		*log_data;	/* parameters for filter */
69*0Sstevel@tonic-gate 	uint16_t	log_flags;	/* message type (e.g. SL_CONSOLE) */
70*0Sstevel@tonic-gate 	short		log_inuse;	/* is this log device open? */
71*0Sstevel@tonic-gate 	int		log_overflow;	/* messages lost due to QFULL */
72*0Sstevel@tonic-gate 	zoneid_t	log_zoneid;	/* zone id of log */
73*0Sstevel@tonic-gate 	minor_t		log_minor;	/* minor number of associated device */
74*0Sstevel@tonic-gate };
75*0Sstevel@tonic-gate 
76*0Sstevel@tonic-gate typedef struct log_zone {
77*0Sstevel@tonic-gate 	log_t lz_clones[LOG_NUMCLONES];
78*0Sstevel@tonic-gate 	uint16_t lz_active;	/* active types (OR of all log_flags fields) */
79*0Sstevel@tonic-gate } log_zone_t;
80*0Sstevel@tonic-gate 
81*0Sstevel@tonic-gate #define	LOG_MSGSIZE	200
82*0Sstevel@tonic-gate 
83*0Sstevel@tonic-gate typedef struct log_dump {
84*0Sstevel@tonic-gate 	uint32_t	ld_magic;	/* LOG_MAGIC */
85*0Sstevel@tonic-gate 	uint32_t	ld_msgsize;	/* MBLKL(mp->b_cont) */
86*0Sstevel@tonic-gate 	uint32_t	ld_csum;	/* checksum32(log_ctl) */
87*0Sstevel@tonic-gate 	uint32_t	ld_msum;	/* checksum32(message text) */
88*0Sstevel@tonic-gate 	/*
89*0Sstevel@tonic-gate 	 * log_ctl and message text follow here -- see dump_messages()
90*0Sstevel@tonic-gate 	 */
91*0Sstevel@tonic-gate } log_dump_t;
92*0Sstevel@tonic-gate 
93*0Sstevel@tonic-gate #ifdef _KERNEL
94*0Sstevel@tonic-gate 
95*0Sstevel@tonic-gate /* global zone variables */
96*0Sstevel@tonic-gate extern log_zone_t log_global;
97*0Sstevel@tonic-gate extern queue_t *log_consq;	/* primary console reader queue */
98*0Sstevel@tonic-gate extern queue_t *log_backlogq;	/* console backlog queue */
99*0Sstevel@tonic-gate extern queue_t *log_intrq;	/* pending high-level interrupt message queue */
100*0Sstevel@tonic-gate 
101*0Sstevel@tonic-gate extern log_filter_t log_error;
102*0Sstevel@tonic-gate extern log_filter_t log_trace;
103*0Sstevel@tonic-gate extern log_filter_t log_console;
104*0Sstevel@tonic-gate 
105*0Sstevel@tonic-gate extern void log_init(void);
106*0Sstevel@tonic-gate extern void log_enter(void);
107*0Sstevel@tonic-gate extern void log_exit(void);
108*0Sstevel@tonic-gate extern void log_update(log_t *, queue_t *, short, log_filter_t);
109*0Sstevel@tonic-gate extern mblk_t *log_makemsg(int, int, int, int, int, void *, size_t, int);
110*0Sstevel@tonic-gate extern void log_freemsg(mblk_t *);
111*0Sstevel@tonic-gate extern void log_sendmsg(mblk_t *, zoneid_t);
112*0Sstevel@tonic-gate extern void log_flushq(queue_t *);
113*0Sstevel@tonic-gate extern void log_printq(queue_t *);
114*0Sstevel@tonic-gate extern log_t *log_alloc(minor_t);
115*0Sstevel@tonic-gate 
116*0Sstevel@tonic-gate #endif	/* _KERNEL */
117*0Sstevel@tonic-gate 
118*0Sstevel@tonic-gate #ifdef	__cplusplus
119*0Sstevel@tonic-gate }
120*0Sstevel@tonic-gate #endif
121*0Sstevel@tonic-gate 
122*0Sstevel@tonic-gate #endif	/* _SYS_LOG_H */
123