xref: /onnv-gate/usr/src/uts/common/sys/poll.h (revision 0:68f95e015346)
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 /*	Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T	*/
23*0Sstevel@tonic-gate /*	  All Rights Reserved  	*/
24*0Sstevel@tonic-gate 
25*0Sstevel@tonic-gate 
26*0Sstevel@tonic-gate /*
27*0Sstevel@tonic-gate  * Copyright (c) 1995, 1998 by Sun Microsystems, Inc.
28*0Sstevel@tonic-gate  * All rights reserved.
29*0Sstevel@tonic-gate  */
30*0Sstevel@tonic-gate 
31*0Sstevel@tonic-gate #ifndef _SYS_POLL_H
32*0Sstevel@tonic-gate #define	_SYS_POLL_H
33*0Sstevel@tonic-gate 
34*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"	/* SVr4.0 11.9 */
35*0Sstevel@tonic-gate 
36*0Sstevel@tonic-gate #ifdef	__cplusplus
37*0Sstevel@tonic-gate extern "C" {
38*0Sstevel@tonic-gate #endif
39*0Sstevel@tonic-gate 
40*0Sstevel@tonic-gate /*
41*0Sstevel@tonic-gate  * Structure of file descriptor/event pairs supplied in
42*0Sstevel@tonic-gate  * the poll arrays.
43*0Sstevel@tonic-gate  */
44*0Sstevel@tonic-gate typedef struct pollfd {
45*0Sstevel@tonic-gate 	int fd;				/* file desc to poll */
46*0Sstevel@tonic-gate 	short events;			/* events of interest on fd */
47*0Sstevel@tonic-gate 	short revents;			/* events that occurred on fd */
48*0Sstevel@tonic-gate } pollfd_t;
49*0Sstevel@tonic-gate 
50*0Sstevel@tonic-gate typedef unsigned long	nfds_t;
51*0Sstevel@tonic-gate 
52*0Sstevel@tonic-gate /*
53*0Sstevel@tonic-gate  * Testable select events
54*0Sstevel@tonic-gate  */
55*0Sstevel@tonic-gate #define	POLLIN		0x0001		/* fd is readable */
56*0Sstevel@tonic-gate #define	POLLPRI		0x0002		/* high priority info at fd */
57*0Sstevel@tonic-gate #define	POLLOUT		0x0004		/* fd is writeable (won't block) */
58*0Sstevel@tonic-gate #define	POLLRDNORM	0x0040		/* normal data is readable */
59*0Sstevel@tonic-gate #define	POLLWRNORM	POLLOUT
60*0Sstevel@tonic-gate #define	POLLRDBAND	0x0080		/* out-of-band data is readable */
61*0Sstevel@tonic-gate #define	POLLWRBAND	0x0100		/* out-of-band data is writeable */
62*0Sstevel@tonic-gate 
63*0Sstevel@tonic-gate #define	POLLNORM	POLLRDNORM
64*0Sstevel@tonic-gate 
65*0Sstevel@tonic-gate /*
66*0Sstevel@tonic-gate  * Non-testable poll events (may not be specified in events field,
67*0Sstevel@tonic-gate  * but may be returned in revents field).
68*0Sstevel@tonic-gate  */
69*0Sstevel@tonic-gate #define	POLLERR		0x0008		/* fd has error condition */
70*0Sstevel@tonic-gate #define	POLLHUP		0x0010		/* fd has been hung up on */
71*0Sstevel@tonic-gate #define	POLLNVAL	0x0020		/* invalid pollfd entry */
72*0Sstevel@tonic-gate 
73*0Sstevel@tonic-gate #define	POLLREMOVE	0x0800	/* remove a cached poll fd from /dev/poll */
74*0Sstevel@tonic-gate 
75*0Sstevel@tonic-gate #ifdef _KERNEL
76*0Sstevel@tonic-gate 
77*0Sstevel@tonic-gate /*
78*0Sstevel@tonic-gate  * Additional private poll flags supported only by strpoll().
79*0Sstevel@tonic-gate  * Must be bit-wise distinct from the above POLL flags.
80*0Sstevel@tonic-gate  */
81*0Sstevel@tonic-gate #define	POLLRDDATA	0x0200	/* Wait for M_DATA; ignore M_PROTO only msgs */
82*0Sstevel@tonic-gate #define	POLLNOERR	0x0400	/* Ignore POLLERR conditions */
83*0Sstevel@tonic-gate 
84*0Sstevel@tonic-gate #define	POLLCLOSED	0x8000	/* a (cached) poll fd has been closed */
85*0Sstevel@tonic-gate 
86*0Sstevel@tonic-gate #endif /* _KERNEL */
87*0Sstevel@tonic-gate 
88*0Sstevel@tonic-gate #if defined(_KERNEL) || defined(_KMEMUSER)
89*0Sstevel@tonic-gate 
90*0Sstevel@tonic-gate #include <sys/thread.h>
91*0Sstevel@tonic-gate 
92*0Sstevel@tonic-gate /*
93*0Sstevel@tonic-gate  * XXX We are forced to use a forward reference here because including
94*0Sstevel@tonic-gate  * file.h here will break i386 build. The real solution is to fix the
95*0Sstevel@tonic-gate  * broken parts in usr/src/stand/lib/fs.
96*0Sstevel@tonic-gate  */
97*0Sstevel@tonic-gate struct fpollinfo;
98*0Sstevel@tonic-gate 
99*0Sstevel@tonic-gate /*
100*0Sstevel@tonic-gate  * Poll list head structure.  A pointer to this is passed to
101*0Sstevel@tonic-gate  * pollwakeup() from the caller indicating an event has occurred.
102*0Sstevel@tonic-gate  * Only the ph_list field is used, but for DDI compliance, we can't
103*0Sstevel@tonic-gate  * change the size of the structure.
104*0Sstevel@tonic-gate  */
105*0Sstevel@tonic-gate typedef struct pollhead {
106*0Sstevel@tonic-gate 	struct polldat		*ph_list;	/* list of pollers */
107*0Sstevel@tonic-gate 	void			*ph_pad1;	/* unused -- see above */
108*0Sstevel@tonic-gate 	short			ph_pad2;	/* unused -- see above */
109*0Sstevel@tonic-gate } pollhead_t;
110*0Sstevel@tonic-gate 
111*0Sstevel@tonic-gate #if defined(_KERNEL)
112*0Sstevel@tonic-gate 
113*0Sstevel@tonic-gate /*
114*0Sstevel@tonic-gate  * Routine called to notify a process of the occurrence
115*0Sstevel@tonic-gate  * of an event.
116*0Sstevel@tonic-gate  */
117*0Sstevel@tonic-gate extern void pollwakeup(pollhead_t *, short);
118*0Sstevel@tonic-gate 
119*0Sstevel@tonic-gate /*
120*0Sstevel@tonic-gate  * Internal routines.
121*0Sstevel@tonic-gate  */
122*0Sstevel@tonic-gate extern void polllock(pollhead_t *, kmutex_t *);
123*0Sstevel@tonic-gate extern int pollunlock(void);
124*0Sstevel@tonic-gate extern void pollrelock(int);
125*0Sstevel@tonic-gate extern void pollcleanup(void);
126*0Sstevel@tonic-gate extern void pollblockexit(struct fpollinfo *);
127*0Sstevel@tonic-gate extern void pollcacheclean(struct fpollinfo *, int);
128*0Sstevel@tonic-gate 
129*0Sstevel@tonic-gate /*
130*0Sstevel@tonic-gate  * public poll head interface:
131*0Sstevel@tonic-gate  *
132*0Sstevel@tonic-gate  *  pollhead_clean      clean up all polldats on a pollhead list
133*0Sstevel@tonic-gate  */
134*0Sstevel@tonic-gate extern void pollhead_clean(pollhead_t *);
135*0Sstevel@tonic-gate 
136*0Sstevel@tonic-gate #endif /* defined(_KERNEL) */
137*0Sstevel@tonic-gate 
138*0Sstevel@tonic-gate #endif /* defined(_KERNEL) || defined(_KMEMUSER) */
139*0Sstevel@tonic-gate 
140*0Sstevel@tonic-gate #if !defined(_KERNEL)
141*0Sstevel@tonic-gate #if defined(__STDC__)
142*0Sstevel@tonic-gate int poll(struct pollfd *, nfds_t, int);
143*0Sstevel@tonic-gate #else
144*0Sstevel@tonic-gate int poll();
145*0Sstevel@tonic-gate #endif /* __STDC__ */
146*0Sstevel@tonic-gate #endif /* !_KERNEL */
147*0Sstevel@tonic-gate 
148*0Sstevel@tonic-gate #ifdef	__cplusplus
149*0Sstevel@tonic-gate }
150*0Sstevel@tonic-gate #endif
151*0Sstevel@tonic-gate 
152*0Sstevel@tonic-gate #endif	/* _SYS_POLL_H */
153