xref: /xnu-11417.101.15/iokit/IOKit/IOConditionLock.h (revision e3723e1f17661b24996789d8afc084c0c3303b26)
1*e3723e1fSApple OSS Distributions /*
2*e3723e1fSApple OSS Distributions  * Copyright (c) 1998-2019 Apple Inc. All rights reserved.
3*e3723e1fSApple OSS Distributions  *
4*e3723e1fSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*e3723e1fSApple OSS Distributions  *
6*e3723e1fSApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*e3723e1fSApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*e3723e1fSApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*e3723e1fSApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*e3723e1fSApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*e3723e1fSApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*e3723e1fSApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*e3723e1fSApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*e3723e1fSApple OSS Distributions  *
15*e3723e1fSApple OSS Distributions  * Please obtain a copy of the License at
16*e3723e1fSApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*e3723e1fSApple OSS Distributions  *
18*e3723e1fSApple OSS Distributions  * The Original Code and all software distributed under the License are
19*e3723e1fSApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*e3723e1fSApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*e3723e1fSApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*e3723e1fSApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*e3723e1fSApple OSS Distributions  * Please see the License for the specific language governing rights and
24*e3723e1fSApple OSS Distributions  * limitations under the License.
25*e3723e1fSApple OSS Distributions  *
26*e3723e1fSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*e3723e1fSApple OSS Distributions  */
28*e3723e1fSApple OSS Distributions /* Copyright (c) 1999 Apple Computer, Inc.  All rights reserved.
29*e3723e1fSApple OSS Distributions  * Copyright (c) 1994-1996 NeXT Software, Inc.  All rights reserved.
30*e3723e1fSApple OSS Distributions  */
31*e3723e1fSApple OSS Distributions 
32*e3723e1fSApple OSS Distributions #ifndef _IOKIT_IOCONDITIONLOCK_H
33*e3723e1fSApple OSS Distributions #define _IOKIT_IOCONDITIONLOCK_H
34*e3723e1fSApple OSS Distributions 
35*e3723e1fSApple OSS Distributions #include <libkern/c++/OSPtr.h>
36*e3723e1fSApple OSS Distributions #include <libkern/c++/OSObject.h>
37*e3723e1fSApple OSS Distributions #include <IOKit/IOLib.h>
38*e3723e1fSApple OSS Distributions #include <IOKit/system.h>
39*e3723e1fSApple OSS Distributions 
40*e3723e1fSApple OSS Distributions #include <IOKit/IOLocks.h>
41*e3723e1fSApple OSS Distributions 
42*e3723e1fSApple OSS Distributions class IOConditionLock : public OSObject
43*e3723e1fSApple OSS Distributions {
44*e3723e1fSApple OSS Distributions 	OSDeclareDefaultStructors(IOConditionLock);
45*e3723e1fSApple OSS Distributions 
46*e3723e1fSApple OSS Distributions private:
47*e3723e1fSApple OSS Distributions 	IOLock *            cond_interlock;     // condition var Simple lock
48*e3723e1fSApple OSS Distributions 	volatile int        condition;
49*e3723e1fSApple OSS Distributions 
50*e3723e1fSApple OSS Distributions 	IOLock *            sleep_interlock;    // sleep lock Simple lock
51*e3723e1fSApple OSS Distributions 	unsigned char       interruptible;
52*e3723e1fSApple OSS Distributions 	volatile bool       want_lock;
53*e3723e1fSApple OSS Distributions 	volatile bool       waiting;
54*e3723e1fSApple OSS Distributions 
55*e3723e1fSApple OSS Distributions public:
56*e3723e1fSApple OSS Distributions 	static OSPtr<IOConditionLock> withCondition(int condition, bool inIntr = true);
57*e3723e1fSApple OSS Distributions 	virtual bool initWithCondition(int condition, bool inIntr = true);
58*e3723e1fSApple OSS Distributions 	virtual void free() APPLE_KEXT_OVERRIDE;
59*e3723e1fSApple OSS Distributions 
60*e3723e1fSApple OSS Distributions 	virtual bool tryLock(); // acquire lock, no waiting
61*e3723e1fSApple OSS Distributions 	virtual int  lock();    // acquire lock (enter critical section)
62*e3723e1fSApple OSS Distributions 	virtual void unlock();  // release lock (leave critical section)
63*e3723e1fSApple OSS Distributions 
64*e3723e1fSApple OSS Distributions 	virtual bool getInterruptible() const;
65*e3723e1fSApple OSS Distributions 	virtual int  getCondition() const;
66*e3723e1fSApple OSS Distributions 	virtual int  setCondition(int condition);
67*e3723e1fSApple OSS Distributions 
68*e3723e1fSApple OSS Distributions 	virtual int  lockWhen(int condition);// acquire lock when condition
69*e3723e1fSApple OSS Distributions 	virtual void unlockWith(int condition); // set condition & release lock
70*e3723e1fSApple OSS Distributions };
71*e3723e1fSApple OSS Distributions 
72*e3723e1fSApple OSS Distributions #endif /* _IOKIT_IOCONDITIONLOCK_H */
73