xref: /illumos-gate/usr/src/uts/common/sys/log.h (revision 64b8fdd9)
17c478bd9Sstevel@tonic-gate /*
27c478bd9Sstevel@tonic-gate  * CDDL HEADER START
37c478bd9Sstevel@tonic-gate  *
47c478bd9Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5281888b3Sjbeck  * Common Development and Distribution License, Version 1.0 only
6281888b3Sjbeck  * (the "License").  You may not use this file except in compliance
7281888b3Sjbeck  * with the License.
87c478bd9Sstevel@tonic-gate  *
97c478bd9Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
107c478bd9Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
117c478bd9Sstevel@tonic-gate  * See the License for the specific language governing permissions
127c478bd9Sstevel@tonic-gate  * and limitations under the License.
137c478bd9Sstevel@tonic-gate  *
147c478bd9Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
157c478bd9Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
167c478bd9Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
177c478bd9Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
187c478bd9Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
197c478bd9Sstevel@tonic-gate  *
207c478bd9Sstevel@tonic-gate  * CDDL HEADER END
217c478bd9Sstevel@tonic-gate  */
227c478bd9Sstevel@tonic-gate /*
23281888b3Sjbeck  * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
247c478bd9Sstevel@tonic-gate  * Use is subject to license terms.
257c478bd9Sstevel@tonic-gate  */
267c478bd9Sstevel@tonic-gate 
277c478bd9Sstevel@tonic-gate /*	Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T */
287c478bd9Sstevel@tonic-gate /*	  All Rights Reserved	*/
297c478bd9Sstevel@tonic-gate 
307c478bd9Sstevel@tonic-gate #ifndef _SYS_LOG_H
317c478bd9Sstevel@tonic-gate #define	_SYS_LOG_H
327c478bd9Sstevel@tonic-gate 
337c478bd9Sstevel@tonic-gate #include <sys/types.h>
347c478bd9Sstevel@tonic-gate #include <sys/strlog.h>
357c478bd9Sstevel@tonic-gate #include <sys/stream.h>
367c478bd9Sstevel@tonic-gate 
377c478bd9Sstevel@tonic-gate #ifdef	__cplusplus
387c478bd9Sstevel@tonic-gate extern "C" {
397c478bd9Sstevel@tonic-gate #endif
407c478bd9Sstevel@tonic-gate 
417c478bd9Sstevel@tonic-gate #define	LOG_CONSMIN	0		/* /dev/conslog minor */
42068ccd7aSns #define	LOG_LOGMIN	5		/* /dev/log minor */
437c478bd9Sstevel@tonic-gate #define	LOG_BACKLOG	LOG_LOGMIN	/* console backlog queue */
447c478bd9Sstevel@tonic-gate 
457c478bd9Sstevel@tonic-gate #define	LOG_LOGMINIDX	0		/* index of smallest /dev/log clone */
467c478bd9Sstevel@tonic-gate #define	LOG_LOGMAXIDX	15		/* up to 16 /dev/log clones */
477c478bd9Sstevel@tonic-gate #define	LOG_NUMCLONES	(LOG_LOGMAXIDX - LOG_LOGMINIDX + 1)
487c478bd9Sstevel@tonic-gate 
497c478bd9Sstevel@tonic-gate #define	LOG_MID		44		/* module ID */
507c478bd9Sstevel@tonic-gate #define	LOG_MINPS	0		/* min packet size */
517c478bd9Sstevel@tonic-gate #define	LOG_MAXPS	1024		/* max packet size */
527c478bd9Sstevel@tonic-gate #define	LOG_LOWAT	2048		/* threshold for backenable */
537c478bd9Sstevel@tonic-gate #define	LOG_HIWAT	1048576		/* threshold for tossing messages */
547c478bd9Sstevel@tonic-gate 
557c478bd9Sstevel@tonic-gate #define	LOG_MAGIC	0xf00d4109U	/* "food for log" - unsent msg magic */
56*64b8fdd9SNick Ewins #define	LOG_RECENTSIZE	65536		/* queue of most recent messages */
577c478bd9Sstevel@tonic-gate #define	LOG_MINFREE	4096		/* message cache low water mark */
587c478bd9Sstevel@tonic-gate #define	LOG_MAXFREE	8192		/* message cache high water mark */
597c478bd9Sstevel@tonic-gate 
607c478bd9Sstevel@tonic-gate typedef struct log log_t;
617c478bd9Sstevel@tonic-gate typedef int (log_filter_t)(log_t *, log_ctl_t *);
627c478bd9Sstevel@tonic-gate 
637c478bd9Sstevel@tonic-gate struct log {
647c478bd9Sstevel@tonic-gate 	queue_t		*log_q;		/* message queue */
657c478bd9Sstevel@tonic-gate 	log_filter_t	*log_wanted;	/* message filter */
667c478bd9Sstevel@tonic-gate 	mblk_t		*log_data;	/* parameters for filter */
677c478bd9Sstevel@tonic-gate 	uint16_t	log_flags;	/* message type (e.g. SL_CONSOLE) */
687c478bd9Sstevel@tonic-gate 	short		log_inuse;	/* is this log device open? */
697c478bd9Sstevel@tonic-gate 	int		log_overflow;	/* messages lost due to QFULL */
707c478bd9Sstevel@tonic-gate 	zoneid_t	log_zoneid;	/* zone id of log */
71068ccd7aSns 	major_t		log_major;	/* device type */
727c478bd9Sstevel@tonic-gate 	minor_t		log_minor;	/* minor number of associated device */
737c478bd9Sstevel@tonic-gate };
747c478bd9Sstevel@tonic-gate 
75068ccd7aSns /* Array of /dev/log minor devices */
767c478bd9Sstevel@tonic-gate typedef struct log_zone {
777c478bd9Sstevel@tonic-gate 	log_t lz_clones[LOG_NUMCLONES];
787c478bd9Sstevel@tonic-gate 	uint16_t lz_active;	/* active types (OR of all log_flags fields) */
797c478bd9Sstevel@tonic-gate } log_zone_t;
807c478bd9Sstevel@tonic-gate 
817c478bd9Sstevel@tonic-gate #define	LOG_MSGSIZE	200
827c478bd9Sstevel@tonic-gate 
837c478bd9Sstevel@tonic-gate typedef struct log_dump {
847c478bd9Sstevel@tonic-gate 	uint32_t	ld_magic;	/* LOG_MAGIC */
857c478bd9Sstevel@tonic-gate 	uint32_t	ld_msgsize;	/* MBLKL(mp->b_cont) */
867c478bd9Sstevel@tonic-gate 	uint32_t	ld_csum;	/* checksum32(log_ctl) */
877c478bd9Sstevel@tonic-gate 	uint32_t	ld_msum;	/* checksum32(message text) */
887c478bd9Sstevel@tonic-gate 	/*
897c478bd9Sstevel@tonic-gate 	 * log_ctl and message text follow here -- see dump_messages()
907c478bd9Sstevel@tonic-gate 	 */
917c478bd9Sstevel@tonic-gate } log_dump_t;
927c478bd9Sstevel@tonic-gate 
937c478bd9Sstevel@tonic-gate #ifdef _KERNEL
947c478bd9Sstevel@tonic-gate 
957c478bd9Sstevel@tonic-gate /* global zone variables */
967c478bd9Sstevel@tonic-gate extern log_zone_t log_global;
977c478bd9Sstevel@tonic-gate extern queue_t *log_consq;	/* primary console reader queue */
987c478bd9Sstevel@tonic-gate extern queue_t *log_backlogq;	/* console backlog queue */
997c478bd9Sstevel@tonic-gate extern queue_t *log_intrq;	/* pending high-level interrupt message queue */
1007c478bd9Sstevel@tonic-gate 
1017c478bd9Sstevel@tonic-gate extern log_filter_t log_error;
1027c478bd9Sstevel@tonic-gate extern log_filter_t log_trace;
1037c478bd9Sstevel@tonic-gate extern log_filter_t log_console;
1047c478bd9Sstevel@tonic-gate 
1057c478bd9Sstevel@tonic-gate extern void log_init(void);
1067c478bd9Sstevel@tonic-gate extern void log_enter(void);
1077c478bd9Sstevel@tonic-gate extern void log_exit(void);
1087c478bd9Sstevel@tonic-gate extern void log_update(log_t *, queue_t *, short, log_filter_t);
1097c478bd9Sstevel@tonic-gate extern mblk_t *log_makemsg(int, int, int, int, int, void *, size_t, int);
1107c478bd9Sstevel@tonic-gate extern void log_freemsg(mblk_t *);
1117c478bd9Sstevel@tonic-gate extern void log_sendmsg(mblk_t *, zoneid_t);
1127c478bd9Sstevel@tonic-gate extern void log_flushq(queue_t *);
1137c478bd9Sstevel@tonic-gate extern void log_printq(queue_t *);
1147c478bd9Sstevel@tonic-gate extern log_t *log_alloc(minor_t);
115068ccd7aSns extern void log_free(log_t *);
1167c478bd9Sstevel@tonic-gate 
1177c478bd9Sstevel@tonic-gate #endif	/* _KERNEL */
1187c478bd9Sstevel@tonic-gate 
1197c478bd9Sstevel@tonic-gate #ifdef	__cplusplus
1207c478bd9Sstevel@tonic-gate }
1217c478bd9Sstevel@tonic-gate #endif
1227c478bd9Sstevel@tonic-gate 
1237c478bd9Sstevel@tonic-gate #endif	/* _SYS_LOG_H */
124