1*7c478bd9Sstevel@tonic-gate /* 2*7c478bd9Sstevel@tonic-gate * CDDL HEADER START 3*7c478bd9Sstevel@tonic-gate * 4*7c478bd9Sstevel@tonic-gate * The contents of this file are subject to the terms of the 5*7c478bd9Sstevel@tonic-gate * Common Development and Distribution License, Version 1.0 only 6*7c478bd9Sstevel@tonic-gate * (the "License"). You may not use this file except in compliance 7*7c478bd9Sstevel@tonic-gate * with the License. 8*7c478bd9Sstevel@tonic-gate * 9*7c478bd9Sstevel@tonic-gate * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 10*7c478bd9Sstevel@tonic-gate * or http://www.opensolaris.org/os/licensing. 11*7c478bd9Sstevel@tonic-gate * See the License for the specific language governing permissions 12*7c478bd9Sstevel@tonic-gate * and limitations under the License. 13*7c478bd9Sstevel@tonic-gate * 14*7c478bd9Sstevel@tonic-gate * When distributing Covered Code, include this CDDL HEADER in each 15*7c478bd9Sstevel@tonic-gate * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 16*7c478bd9Sstevel@tonic-gate * If applicable, add the following below this CDDL HEADER, with the 17*7c478bd9Sstevel@tonic-gate * fields enclosed by brackets "[]" replaced with your own identifying 18*7c478bd9Sstevel@tonic-gate * information: Portions Copyright [yyyy] [name of copyright owner] 19*7c478bd9Sstevel@tonic-gate * 20*7c478bd9Sstevel@tonic-gate * CDDL HEADER END 21*7c478bd9Sstevel@tonic-gate */ 22*7c478bd9Sstevel@tonic-gate /* 23*7c478bd9Sstevel@tonic-gate * Copyright (c) 1991-1998 by Sun Microsystems, Inc. 24*7c478bd9Sstevel@tonic-gate * All rights reserved. 25*7c478bd9Sstevel@tonic-gate */ 26*7c478bd9Sstevel@tonic-gate 27*7c478bd9Sstevel@tonic-gate #ifndef _SYS_MUTEX_H 28*7c478bd9Sstevel@tonic-gate #define _SYS_MUTEX_H 29*7c478bd9Sstevel@tonic-gate 30*7c478bd9Sstevel@tonic-gate #pragma ident "%Z%%M% %I% %E% SMI" 31*7c478bd9Sstevel@tonic-gate 32*7c478bd9Sstevel@tonic-gate #ifndef _ASM 33*7c478bd9Sstevel@tonic-gate #include <sys/types.h> 34*7c478bd9Sstevel@tonic-gate #endif 35*7c478bd9Sstevel@tonic-gate 36*7c478bd9Sstevel@tonic-gate #ifdef __cplusplus 37*7c478bd9Sstevel@tonic-gate extern "C" { 38*7c478bd9Sstevel@tonic-gate #endif 39*7c478bd9Sstevel@tonic-gate 40*7c478bd9Sstevel@tonic-gate #ifndef _ASM 41*7c478bd9Sstevel@tonic-gate 42*7c478bd9Sstevel@tonic-gate /* 43*7c478bd9Sstevel@tonic-gate * Public interface to mutual exclusion locks. See mutex(9F) for details. 44*7c478bd9Sstevel@tonic-gate * 45*7c478bd9Sstevel@tonic-gate * The basic mutex type is MUTEX_ADAPTIVE, which is expected to be used 46*7c478bd9Sstevel@tonic-gate * in almost all of the kernel. MUTEX_SPIN provides interrupt blocking 47*7c478bd9Sstevel@tonic-gate * and must be used in interrupt handlers above LOCK_LEVEL. The iblock 48*7c478bd9Sstevel@tonic-gate * cookie argument to mutex_init() encodes the interrupt level to block. 49*7c478bd9Sstevel@tonic-gate * The iblock cookie must be NULL for adaptive locks. 50*7c478bd9Sstevel@tonic-gate * 51*7c478bd9Sstevel@tonic-gate * MUTEX_DEFAULT is the type usually specified (except in drivers) to 52*7c478bd9Sstevel@tonic-gate * mutex_init(). It is identical to MUTEX_ADAPTIVE. 53*7c478bd9Sstevel@tonic-gate * 54*7c478bd9Sstevel@tonic-gate * MUTEX_DRIVER is always used by drivers. mutex_init() converts this to 55*7c478bd9Sstevel@tonic-gate * either MUTEX_ADAPTIVE or MUTEX_SPIN depending on the iblock cookie. 56*7c478bd9Sstevel@tonic-gate * 57*7c478bd9Sstevel@tonic-gate * Mutex statistics can be gathered on the fly, without rebooting or 58*7c478bd9Sstevel@tonic-gate * recompiling the kernel, via the lockstat driver (lockstat(7D)). 59*7c478bd9Sstevel@tonic-gate */ 60*7c478bd9Sstevel@tonic-gate typedef enum { 61*7c478bd9Sstevel@tonic-gate MUTEX_ADAPTIVE = 0, /* spin if owner is running, otherwise block */ 62*7c478bd9Sstevel@tonic-gate MUTEX_SPIN = 1, /* block interrupts and spin */ 63*7c478bd9Sstevel@tonic-gate MUTEX_DRIVER = 4, /* driver (DDI) mutex */ 64*7c478bd9Sstevel@tonic-gate MUTEX_DEFAULT = 6 /* kernel default mutex */ 65*7c478bd9Sstevel@tonic-gate } kmutex_type_t; 66*7c478bd9Sstevel@tonic-gate 67*7c478bd9Sstevel@tonic-gate typedef struct mutex { 68*7c478bd9Sstevel@tonic-gate #ifdef _LP64 69*7c478bd9Sstevel@tonic-gate void *_opaque[1]; 70*7c478bd9Sstevel@tonic-gate #else 71*7c478bd9Sstevel@tonic-gate void *_opaque[2]; 72*7c478bd9Sstevel@tonic-gate #endif 73*7c478bd9Sstevel@tonic-gate } kmutex_t; 74*7c478bd9Sstevel@tonic-gate 75*7c478bd9Sstevel@tonic-gate #ifdef _KERNEL 76*7c478bd9Sstevel@tonic-gate 77*7c478bd9Sstevel@tonic-gate #define MUTEX_HELD(x) (mutex_owned(x)) 78*7c478bd9Sstevel@tonic-gate #define MUTEX_NOT_HELD(x) (!mutex_owned(x) || panicstr) 79*7c478bd9Sstevel@tonic-gate 80*7c478bd9Sstevel@tonic-gate extern void mutex_init(kmutex_t *, char *, kmutex_type_t, void *); 81*7c478bd9Sstevel@tonic-gate extern void mutex_destroy(kmutex_t *); 82*7c478bd9Sstevel@tonic-gate extern void mutex_enter(kmutex_t *); 83*7c478bd9Sstevel@tonic-gate extern int mutex_tryenter(kmutex_t *); 84*7c478bd9Sstevel@tonic-gate extern void mutex_exit(kmutex_t *); 85*7c478bd9Sstevel@tonic-gate extern int mutex_owned(kmutex_t *); 86*7c478bd9Sstevel@tonic-gate extern struct _kthread *mutex_owner(kmutex_t *); 87*7c478bd9Sstevel@tonic-gate 88*7c478bd9Sstevel@tonic-gate #endif /* _KERNEL */ 89*7c478bd9Sstevel@tonic-gate 90*7c478bd9Sstevel@tonic-gate #endif /* _ASM */ 91*7c478bd9Sstevel@tonic-gate 92*7c478bd9Sstevel@tonic-gate #ifdef __cplusplus 93*7c478bd9Sstevel@tonic-gate } 94*7c478bd9Sstevel@tonic-gate #endif 95*7c478bd9Sstevel@tonic-gate 96*7c478bd9Sstevel@tonic-gate #endif /* _SYS_MUTEX_H */ 97