blob: aae08d5b817142c2bb2c5db10d9c550b2c9770ed [file] [log] [blame]
Guido van Rossum4f0fbf81996-06-12 04:22:53 +00001/* select - Module containing unix select(2) call.
Barry Warsawe4ac0aa1996-12-12 00:04:35 +00002 Under Unix, the file descriptors are small integers.
3 Under Win32, select only exists for sockets, and sockets may
4 have any value except INVALID_SOCKET.
Guido van Rossumbcc20741998-08-04 22:53:56 +00005 Under BeOS, we suffer the same dichotomy as Win32; sockets can be anything
6 >= 0.
Guido van Rossum4f0fbf81996-06-12 04:22:53 +00007*/
Guido van Rossumed233a51992-06-23 09:07:03 +00008
Barry Warsawe4ac0aa1996-12-12 00:04:35 +00009#include "Python.h"
Christian Heimes0e9ab5f2008-03-21 23:49:44 +000010#include <structmember.h>
Guido van Rossumed233a51992-06-23 09:07:03 +000011
Ronald Oussoren32fd16e2006-04-23 12:36:23 +000012#ifdef __APPLE__
13 /* Perform runtime testing for a broken poll on OSX to make it easier
14 * to use the same binary on multiple releases of the OS.
15 */
16#undef HAVE_BROKEN_POLL
17#endif
18
Tim Petersd92dfe02000-12-12 01:18:41 +000019/* Windows #defines FD_SETSIZE to 64 if FD_SETSIZE isn't already defined.
20 64 is too small (too many people have bumped into that limit).
21 Here we boost it.
22 Users who want even more than the boosted limit should #define
23 FD_SETSIZE higher before this; e.g., via compiler /D switch.
24*/
25#if defined(MS_WINDOWS) && !defined(FD_SETSIZE)
26#define FD_SETSIZE 512
27#endif
28
Andrew M. Kuchling737fbb32001-07-14 20:54:37 +000029#if defined(HAVE_POLL_H)
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +000030#include <poll.h>
Andrew M. Kuchling737fbb32001-07-14 20:54:37 +000031#elif defined(HAVE_SYS_POLL_H)
32#include <sys/poll.h>
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +000033#endif
Guido van Rossuma376cc51996-12-05 23:43:35 +000034
Guido van Rossum37273171996-12-09 18:47:43 +000035#ifdef __sgi
36/* This is missing from unistd.h */
Thomas Woutersbd4bc4e2000-07-22 23:57:55 +000037extern void bzero(void *, int);
Guido van Rossum37273171996-12-09 18:47:43 +000038#endif
39
Martin v. Löwis0e8bd7e2006-06-10 12:23:46 +000040#ifdef HAVE_SYS_TYPES_H
Guido van Rossumb6775db1994-08-01 11:34:53 +000041#include <sys/types.h>
Guido van Rossumff7e83d1999-08-27 20:39:37 +000042#endif
Guido van Rossum4f0fbf81996-06-12 04:22:53 +000043
Andrew MacIntyre7bf68332002-03-03 02:59:16 +000044#if defined(PYOS_OS2) && !defined(PYCC_GCC)
Guido van Rossum8e9ebfd1997-11-22 21:53:48 +000045#include <sys/time.h>
46#include <utils.h>
47#endif
48
Guido van Rossum6f489d91996-06-28 20:15:15 +000049#ifdef MS_WINDOWS
Neal Norwitz2a30cd02006-07-10 01:18:57 +000050# include <winsock.h>
Guido van Rossum4f0fbf81996-06-12 04:22:53 +000051#else
Neal Norwitz2a30cd02006-07-10 01:18:57 +000052# define SOCKET int
53# ifdef __BEOS__
54# include <net/socket.h>
55# elif defined(__VMS)
56# include <socket.h>
57# endif
Guido van Rossumbcc20741998-08-04 22:53:56 +000058#endif
Guido van Rossumed233a51992-06-23 09:07:03 +000059
Barry Warsawe4ac0aa1996-12-12 00:04:35 +000060static PyObject *SelectError;
Guido van Rossumed233a51992-06-23 09:07:03 +000061
Barry Warsawc1cb3601996-12-12 22:16:21 +000062/* list of Python objects and their file descriptor */
63typedef struct {
64 PyObject *obj; /* owned reference */
Guido van Rossum4f0fbf81996-06-12 04:22:53 +000065 SOCKET fd;
Barry Warsawc1cb3601996-12-12 22:16:21 +000066 int sentinel; /* -1 == sentinel */
Guido van Rossum4f0fbf81996-06-12 04:22:53 +000067} pylist;
68
Barry Warsawc1cb3601996-12-12 22:16:21 +000069static void
Tim Peters4b046c22001-08-16 21:59:46 +000070reap_obj(pylist fd2obj[FD_SETSIZE + 1])
Barry Warsawc1cb3601996-12-12 22:16:21 +000071{
72 int i;
Tim Peters4b046c22001-08-16 21:59:46 +000073 for (i = 0; i < FD_SETSIZE + 1 && fd2obj[i].sentinel >= 0; i++) {
Barry Warsawc1cb3601996-12-12 22:16:21 +000074 Py_XDECREF(fd2obj[i].obj);
75 fd2obj[i].obj = NULL;
76 }
77 fd2obj[0].sentinel = -1;
78}
79
80
Barry Warsawe4ac0aa1996-12-12 00:04:35 +000081/* returns -1 and sets the Python exception if an error occurred, otherwise
82 returns a number >= 0
83*/
Guido van Rossum4f0fbf81996-06-12 04:22:53 +000084static int
Brett Cannon62dba4c2003-09-10 19:37:42 +000085seq2set(PyObject *seq, fd_set *set, pylist fd2obj[FD_SETSIZE + 1])
Guido van Rossumed233a51992-06-23 09:07:03 +000086{
Barry Warsawc1cb3601996-12-12 22:16:21 +000087 int i;
88 int max = -1;
89 int index = 0;
Brett Cannon62dba4c2003-09-10 19:37:42 +000090 int len = -1;
91 PyObject* fast_seq = NULL;
Barry Warsawc1cb3601996-12-12 22:16:21 +000092 PyObject* o = NULL;
Guido van Rossum07432c01995-03-29 16:47:45 +000093
Barry Warsawe4ac0aa1996-12-12 00:04:35 +000094 fd2obj[0].obj = (PyObject*)0; /* set list to zero size */
Barry Warsawe4ac0aa1996-12-12 00:04:35 +000095 FD_ZERO(set);
Barry Warsawc1cb3601996-12-12 22:16:21 +000096
Brett Cannon62dba4c2003-09-10 19:37:42 +000097 fast_seq=PySequence_Fast(seq, "arguments 1-3 must be sequences");
98 if (!fast_seq)
99 return -1;
100
101 len = PySequence_Fast_GET_SIZE(fast_seq);
102
Barry Warsawc1cb3601996-12-12 22:16:21 +0000103 for (i = 0; i < len; i++) {
Barry Warsawc1cb3601996-12-12 22:16:21 +0000104 SOCKET v;
105
106 /* any intervening fileno() calls could decr this refcnt */
Brett Cannon62dba4c2003-09-10 19:37:42 +0000107 if (!(o = PySequence_Fast_GET_ITEM(fast_seq, i)))
Barry Warsaw529fcfe1996-12-16 18:15:34 +0000108 return -1;
Barry Warsaw24c4b3d1996-12-13 23:22:42 +0000109
Barry Warsawc1cb3601996-12-12 22:16:21 +0000110 Py_INCREF(o);
Andrew M. Kuchling9f28a032000-07-13 23:59:35 +0000111 v = PyObject_AsFileDescriptor( o );
112 if (v == -1) goto finally;
Barry Warsawc1cb3601996-12-12 22:16:21 +0000113
Guido van Rossum947a0fa2000-01-14 16:33:09 +0000114#if defined(_MSC_VER)
Barry Warsawc1cb3601996-12-12 22:16:21 +0000115 max = 0; /* not used for Win32 */
116#else /* !_MSC_VER */
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000117 if (v < 0 || v >= FD_SETSIZE) {
Barry Warsawc1cb3601996-12-12 22:16:21 +0000118 PyErr_SetString(PyExc_ValueError,
119 "filedescriptor out of range in select()");
120 goto finally;
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000121 }
122 if (v > max)
123 max = v;
Barry Warsawc1cb3601996-12-12 22:16:21 +0000124#endif /* _MSC_VER */
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000125 FD_SET(v, set);
Barry Warsawc1cb3601996-12-12 22:16:21 +0000126
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000127 /* add object and its file descriptor to the list */
128 if (index >= FD_SETSIZE) {
Barry Warsawc1cb3601996-12-12 22:16:21 +0000129 PyErr_SetString(PyExc_ValueError,
130 "too many file descriptors in select()");
131 goto finally;
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000132 }
133 fd2obj[index].obj = o;
134 fd2obj[index].fd = v;
Barry Warsawc1cb3601996-12-12 22:16:21 +0000135 fd2obj[index].sentinel = 0;
136 fd2obj[++index].sentinel = -1;
Guido van Rossum4f0fbf81996-06-12 04:22:53 +0000137 }
Brett Cannon62dba4c2003-09-10 19:37:42 +0000138 Py_DECREF(fast_seq);
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000139 return max+1;
Barry Warsawc1cb3601996-12-12 22:16:21 +0000140
141 finally:
142 Py_XDECREF(o);
Brett Cannon62dba4c2003-09-10 19:37:42 +0000143 Py_DECREF(fast_seq);
Barry Warsawc1cb3601996-12-12 22:16:21 +0000144 return -1;
Guido van Rossumed233a51992-06-23 09:07:03 +0000145}
146
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000147/* returns NULL and sets the Python exception if an error occurred */
148static PyObject *
Tim Peters4b046c22001-08-16 21:59:46 +0000149set2list(fd_set *set, pylist fd2obj[FD_SETSIZE + 1])
Guido van Rossumed233a51992-06-23 09:07:03 +0000150{
Barry Warsawc1cb3601996-12-12 22:16:21 +0000151 int i, j, count=0;
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000152 PyObject *list, *o;
153 SOCKET fd;
Guido van Rossumed233a51992-06-23 09:07:03 +0000154
Barry Warsawc1cb3601996-12-12 22:16:21 +0000155 for (j = 0; fd2obj[j].sentinel >= 0; j++) {
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000156 if (FD_ISSET(fd2obj[j].fd, set))
Barry Warsawc1cb3601996-12-12 22:16:21 +0000157 count++;
158 }
159 list = PyList_New(count);
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000160 if (!list)
161 return NULL;
162
Barry Warsawc1cb3601996-12-12 22:16:21 +0000163 i = 0;
164 for (j = 0; fd2obj[j].sentinel >= 0; j++) {
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000165 fd = fd2obj[j].fd;
166 if (FD_ISSET(fd, set)) {
Guido van Rossum4f0fbf81996-06-12 04:22:53 +0000167#ifndef _MSC_VER
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000168 if (fd > FD_SETSIZE) {
169 PyErr_SetString(PyExc_SystemError,
170 "filedescriptor out of range returned in select()");
Barry Warsawc1cb3601996-12-12 22:16:21 +0000171 goto finally;
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000172 }
Guido van Rossum4f0fbf81996-06-12 04:22:53 +0000173#endif
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000174 o = fd2obj[j].obj;
Barry Warsawc1cb3601996-12-12 22:16:21 +0000175 fd2obj[j].obj = NULL;
176 /* transfer ownership */
177 if (PyList_SetItem(list, i, o) < 0)
178 goto finally;
179
180 i++;
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000181 }
182 }
183 return list;
Barry Warsawc1cb3601996-12-12 22:16:21 +0000184 finally:
185 Py_DECREF(list);
186 return NULL;
Guido van Rossumed233a51992-06-23 09:07:03 +0000187}
Barry Warsawc1cb3601996-12-12 22:16:21 +0000188
Barry Warsawb44740f2001-08-16 16:52:59 +0000189#undef SELECT_USES_HEAP
190#if FD_SETSIZE > 1024
191#define SELECT_USES_HEAP
192#endif /* FD_SETSIZE > 1024 */
193
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000194static PyObject *
Peter Schneider-Kamp41c36ff2000-07-10 12:29:26 +0000195select_select(PyObject *self, PyObject *args)
Guido van Rossumed233a51992-06-23 09:07:03 +0000196{
Barry Warsawb44740f2001-08-16 16:52:59 +0000197#ifdef SELECT_USES_HEAP
Guido van Rossumd20781b1998-07-02 02:53:36 +0000198 pylist *rfd2obj, *wfd2obj, *efd2obj;
Barry Warsawb44740f2001-08-16 16:52:59 +0000199#else /* !SELECT_USES_HEAP */
Tim Peters4b046c22001-08-16 21:59:46 +0000200 /* XXX: All this should probably be implemented as follows:
Barry Warsawb44740f2001-08-16 16:52:59 +0000201 * - find the highest descriptor we're interested in
202 * - add one
203 * - that's the size
204 * See: Stevens, APitUE, $12.5.1
205 */
Tim Peters4b046c22001-08-16 21:59:46 +0000206 pylist rfd2obj[FD_SETSIZE + 1];
207 pylist wfd2obj[FD_SETSIZE + 1];
208 pylist efd2obj[FD_SETSIZE + 1];
Barry Warsawb44740f2001-08-16 16:52:59 +0000209#endif /* SELECT_USES_HEAP */
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000210 PyObject *ifdlist, *ofdlist, *efdlist;
Barry Warsawc1cb3601996-12-12 22:16:21 +0000211 PyObject *ret = NULL;
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000212 PyObject *tout = Py_None;
213 fd_set ifdset, ofdset, efdset;
214 double timeout;
215 struct timeval tv, *tvp;
Guido van Rossum3262e162000-06-28 21:18:13 +0000216 long seconds;
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000217 int imax, omax, emax, max;
218 int n;
Guido van Rossumed233a51992-06-23 09:07:03 +0000219
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000220 /* convert arguments */
Georg Brandl96a8c392006-05-29 21:04:52 +0000221 if (!PyArg_UnpackTuple(args, "select", 3, 4,
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000222 &ifdlist, &ofdlist, &efdlist, &tout))
223 return NULL;
Guido van Rossumed233a51992-06-23 09:07:03 +0000224
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000225 if (tout == Py_None)
226 tvp = (struct timeval *)0;
Neal Norwitz77c72bb2002-07-28 15:12:10 +0000227 else if (!PyNumber_Check(tout)) {
Barry Warsawc1cb3601996-12-12 22:16:21 +0000228 PyErr_SetString(PyExc_TypeError,
229 "timeout must be a float or None");
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000230 return NULL;
Barry Warsawc1cb3601996-12-12 22:16:21 +0000231 }
Guido van Rossumc7a22701993-11-01 16:27:16 +0000232 else {
Neil Schemenauer47ec6c02002-11-18 16:02:29 +0000233 timeout = PyFloat_AsDouble(tout);
234 if (timeout == -1 && PyErr_Occurred())
Neal Norwitz77c72bb2002-07-28 15:12:10 +0000235 return NULL;
Guido van Rossum3262e162000-06-28 21:18:13 +0000236 if (timeout > (double)LONG_MAX) {
Barry Warsaw2f704552001-08-16 16:55:10 +0000237 PyErr_SetString(PyExc_OverflowError,
238 "timeout period too long");
Guido van Rossum3262e162000-06-28 21:18:13 +0000239 return NULL;
240 }
241 seconds = (long)timeout;
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000242 timeout = timeout - (double)seconds;
243 tv.tv_sec = seconds;
Christian Heimes0e9ab5f2008-03-21 23:49:44 +0000244 tv.tv_usec = (long)(timeout * 1E6);
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000245 tvp = &tv;
Guido van Rossumc7a22701993-11-01 16:27:16 +0000246 }
Guido van Rossumed233a51992-06-23 09:07:03 +0000247
Guido van Rossumed233a51992-06-23 09:07:03 +0000248
Barry Warsawb44740f2001-08-16 16:52:59 +0000249#ifdef SELECT_USES_HEAP
Guido van Rossumd20781b1998-07-02 02:53:36 +0000250 /* Allocate memory for the lists */
Tim Peters4b046c22001-08-16 21:59:46 +0000251 rfd2obj = PyMem_NEW(pylist, FD_SETSIZE + 1);
252 wfd2obj = PyMem_NEW(pylist, FD_SETSIZE + 1);
253 efd2obj = PyMem_NEW(pylist, FD_SETSIZE + 1);
Guido van Rossumd20781b1998-07-02 02:53:36 +0000254 if (rfd2obj == NULL || wfd2obj == NULL || efd2obj == NULL) {
Guido van Rossumb18618d2000-05-03 23:44:39 +0000255 if (rfd2obj) PyMem_DEL(rfd2obj);
256 if (wfd2obj) PyMem_DEL(wfd2obj);
257 if (efd2obj) PyMem_DEL(efd2obj);
Tim Peters5f322d32003-02-11 17:18:58 +0000258 return PyErr_NoMemory();
Guido van Rossumd20781b1998-07-02 02:53:36 +0000259 }
Barry Warsawb44740f2001-08-16 16:52:59 +0000260#endif /* SELECT_USES_HEAP */
Brett Cannon62dba4c2003-09-10 19:37:42 +0000261 /* Convert sequences to fd_sets, and get maximum fd number
262 * propagates the Python exception set in seq2set()
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000263 */
Barry Warsawc1cb3601996-12-12 22:16:21 +0000264 rfd2obj[0].sentinel = -1;
265 wfd2obj[0].sentinel = -1;
266 efd2obj[0].sentinel = -1;
Brett Cannon62dba4c2003-09-10 19:37:42 +0000267 if ((imax=seq2set(ifdlist, &ifdset, rfd2obj)) < 0)
Barry Warsawc1cb3601996-12-12 22:16:21 +0000268 goto finally;
Brett Cannon62dba4c2003-09-10 19:37:42 +0000269 if ((omax=seq2set(ofdlist, &ofdset, wfd2obj)) < 0)
Barry Warsawc1cb3601996-12-12 22:16:21 +0000270 goto finally;
Brett Cannon62dba4c2003-09-10 19:37:42 +0000271 if ((emax=seq2set(efdlist, &efdset, efd2obj)) < 0)
Barry Warsawc1cb3601996-12-12 22:16:21 +0000272 goto finally;
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000273 max = imax;
274 if (omax > max) max = omax;
275 if (emax > max) max = emax;
Guido van Rossumed233a51992-06-23 09:07:03 +0000276
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000277 Py_BEGIN_ALLOW_THREADS
278 n = select(max, &ifdset, &ofdset, &efdset, tvp);
279 Py_END_ALLOW_THREADS
Guido van Rossumed233a51992-06-23 09:07:03 +0000280
Thomas Heller106f4c72002-09-24 16:51:00 +0000281#ifdef MS_WINDOWS
282 if (n == SOCKET_ERROR) {
283 PyErr_SetExcFromWindowsErr(SelectError, WSAGetLastError());
284 }
285#else
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000286 if (n < 0) {
287 PyErr_SetFromErrno(SelectError);
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000288 }
Thomas Heller106f4c72002-09-24 16:51:00 +0000289#endif
Barry Warsawc1cb3601996-12-12 22:16:21 +0000290 else if (n == 0) {
291 /* optimization */
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000292 ifdlist = PyList_New(0);
Barry Warsawc1cb3601996-12-12 22:16:21 +0000293 if (ifdlist) {
Raymond Hettinger8ae46892003-10-12 19:09:37 +0000294 ret = PyTuple_Pack(3, ifdlist, ifdlist, ifdlist);
Barry Warsawc1cb3601996-12-12 22:16:21 +0000295 Py_DECREF(ifdlist);
296 }
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000297 }
Barry Warsawc1cb3601996-12-12 22:16:21 +0000298 else {
299 /* any of these three calls can raise an exception. it's more
300 convenient to test for this after all three calls... but
301 is that acceptable?
302 */
303 ifdlist = set2list(&ifdset, rfd2obj);
304 ofdlist = set2list(&ofdset, wfd2obj);
305 efdlist = set2list(&efdset, efd2obj);
306 if (PyErr_Occurred())
307 ret = NULL;
308 else
Raymond Hettinger8ae46892003-10-12 19:09:37 +0000309 ret = PyTuple_Pack(3, ifdlist, ofdlist, efdlist);
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000310
Barry Warsawc1cb3601996-12-12 22:16:21 +0000311 Py_DECREF(ifdlist);
312 Py_DECREF(ofdlist);
313 Py_DECREF(efdlist);
314 }
315
316 finally:
317 reap_obj(rfd2obj);
318 reap_obj(wfd2obj);
319 reap_obj(efd2obj);
Barry Warsawb44740f2001-08-16 16:52:59 +0000320#ifdef SELECT_USES_HEAP
Guido van Rossumd20781b1998-07-02 02:53:36 +0000321 PyMem_DEL(rfd2obj);
322 PyMem_DEL(wfd2obj);
323 PyMem_DEL(efd2obj);
Barry Warsawb44740f2001-08-16 16:52:59 +0000324#endif /* SELECT_USES_HEAP */
Barry Warsawe4ac0aa1996-12-12 00:04:35 +0000325 return ret;
Guido van Rossumed233a51992-06-23 09:07:03 +0000326}
327
Nicholas Bastine62c5c82004-03-21 23:45:42 +0000328#if defined(HAVE_POLL) && !defined(HAVE_BROKEN_POLL)
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000329/*
330 * poll() support
331 */
332
333typedef struct {
334 PyObject_HEAD
335 PyObject *dict;
336 int ufd_uptodate;
337 int ufd_len;
338 struct pollfd *ufds;
339} pollObject;
340
Jeremy Hylton938ace62002-07-17 16:30:39 +0000341static PyTypeObject poll_Type;
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000342
343/* Update the malloc'ed array of pollfds to match the dictionary
344 contained within a pollObject. Return 1 on success, 0 on an error.
345*/
346
347static int
348update_ufd_array(pollObject *self)
349{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000350 Py_ssize_t i, pos;
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000351 PyObject *key, *value;
Gregory P. Smith0470bab2008-07-22 04:46:32 +0000352 struct pollfd *old_ufds = self->ufds;
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000353
354 self->ufd_len = PyDict_Size(self->dict);
Gregory P. Smith0470bab2008-07-22 04:46:32 +0000355 PyMem_RESIZE(self->ufds, struct pollfd, self->ufd_len);
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000356 if (self->ufds == NULL) {
Gregory P. Smith0470bab2008-07-22 04:46:32 +0000357 self->ufds = old_ufds;
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000358 PyErr_NoMemory();
359 return 0;
360 }
361
362 i = pos = 0;
Fred Drakedff3a372001-07-19 21:29:49 +0000363 while (PyDict_Next(self->dict, &pos, &key, &value)) {
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000364 self->ufds[i].fd = PyInt_AsLong(key);
Fred Drakedff3a372001-07-19 21:29:49 +0000365 self->ufds[i].events = (short)PyInt_AsLong(value);
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000366 i++;
367 }
368 self->ufd_uptodate = 1;
369 return 1;
370}
371
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000372PyDoc_STRVAR(poll_register_doc,
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000373"register(fd [, eventmask] ) -> None\n\n\
374Register a file descriptor with the polling object.\n\
Barry Warsaw2f704552001-08-16 16:55:10 +0000375fd -- either an integer, or an object with a fileno() method returning an\n\
376 int.\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000377events -- an optional bitmask describing the type of events to check for");
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000378
379static PyObject *
380poll_register(pollObject *self, PyObject *args)
381{
382 PyObject *o, *key, *value;
383 int fd, events = POLLIN | POLLPRI | POLLOUT;
Guido van Rossuma0dfc852001-10-25 20:18:35 +0000384 int err;
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000385
Fred Drake7b87f852001-05-21 03:29:05 +0000386 if (!PyArg_ParseTuple(args, "O|i:register", &o, &events)) {
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000387 return NULL;
388 }
389
390 fd = PyObject_AsFileDescriptor(o);
391 if (fd == -1) return NULL;
392
393 /* Add entry to the internal dictionary: the key is the
394 file descriptor, and the value is the event mask. */
Guido van Rossuma0dfc852001-10-25 20:18:35 +0000395 key = PyInt_FromLong(fd);
396 if (key == NULL)
397 return NULL;
398 value = PyInt_FromLong(events);
399 if (value == NULL) {
400 Py_DECREF(key);
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000401 return NULL;
402 }
Guido van Rossuma0dfc852001-10-25 20:18:35 +0000403 err = PyDict_SetItem(self->dict, key, value);
404 Py_DECREF(key);
405 Py_DECREF(value);
406 if (err < 0)
407 return NULL;
408
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000409 self->ufd_uptodate = 0;
Christian Heimes0e9ab5f2008-03-21 23:49:44 +0000410
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000411 Py_INCREF(Py_None);
412 return Py_None;
413}
414
Christian Heimes0e9ab5f2008-03-21 23:49:44 +0000415PyDoc_STRVAR(poll_modify_doc,
416"modify(fd, eventmask) -> None\n\n\
Andrew M. Kuchlinga8c3f2b2008-03-26 00:16:50 +0000417Modify an already registered file descriptor.\n\
Christian Heimes0e9ab5f2008-03-21 23:49:44 +0000418fd -- either an integer, or an object with a fileno() method returning an\n\
419 int.\n\
420events -- an optional bitmask describing the type of events to check for");
421
422static PyObject *
423poll_modify(pollObject *self, PyObject *args)
424{
425 PyObject *o, *key, *value;
426 int fd, events;
427 int err;
428
429 if (!PyArg_ParseTuple(args, "Oi:modify", &o, &events)) {
430 return NULL;
431 }
432
433 fd = PyObject_AsFileDescriptor(o);
434 if (fd == -1) return NULL;
435
436 /* Modify registered fd */
437 key = PyInt_FromLong(fd);
438 if (key == NULL)
439 return NULL;
440 if (PyDict_GetItem(self->dict, key) == NULL) {
441 errno = ENOENT;
442 PyErr_SetFromErrno(PyExc_IOError);
443 return NULL;
444 }
445 value = PyInt_FromLong(events);
446 if (value == NULL) {
447 Py_DECREF(key);
448 return NULL;
449 }
450 err = PyDict_SetItem(self->dict, key, value);
451 Py_DECREF(key);
452 Py_DECREF(value);
453 if (err < 0)
454 return NULL;
455
456 self->ufd_uptodate = 0;
457
458 Py_INCREF(Py_None);
459 return Py_None;
460}
461
462
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000463PyDoc_STRVAR(poll_unregister_doc,
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000464"unregister(fd) -> None\n\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000465Remove a file descriptor being tracked by the polling object.");
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000466
467static PyObject *
Georg Brandl96a8c392006-05-29 21:04:52 +0000468poll_unregister(pollObject *self, PyObject *o)
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000469{
Georg Brandl96a8c392006-05-29 21:04:52 +0000470 PyObject *key;
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000471 int fd;
472
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000473 fd = PyObject_AsFileDescriptor( o );
474 if (fd == -1)
475 return NULL;
476
477 /* Check whether the fd is already in the array */
478 key = PyInt_FromLong(fd);
479 if (key == NULL)
480 return NULL;
481
482 if (PyDict_DelItem(self->dict, key) == -1) {
483 Py_DECREF(key);
484 /* This will simply raise the KeyError set by PyDict_DelItem
485 if the file descriptor isn't registered. */
486 return NULL;
487 }
488
489 Py_DECREF(key);
490 self->ufd_uptodate = 0;
491
492 Py_INCREF(Py_None);
493 return Py_None;
494}
495
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000496PyDoc_STRVAR(poll_poll_doc,
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000497"poll( [timeout] ) -> list of (fd, event) 2-tuples\n\n\
498Polls the set of registered file descriptors, returning a list containing \n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000499any descriptors that have events or errors to report.");
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000500
501static PyObject *
502poll_poll(pollObject *self, PyObject *args)
503{
504 PyObject *result_list = NULL, *tout = NULL;
505 int timeout = 0, poll_result, i, j;
506 PyObject *value = NULL, *num = NULL;
507
Georg Brandl96a8c392006-05-29 21:04:52 +0000508 if (!PyArg_UnpackTuple(args, "poll", 0, 1, &tout)) {
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000509 return NULL;
510 }
511
512 /* Check values for timeout */
513 if (tout == NULL || tout == Py_None)
514 timeout = -1;
Neal Norwitz77c72bb2002-07-28 15:12:10 +0000515 else if (!PyNumber_Check(tout)) {
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000516 PyErr_SetString(PyExc_TypeError,
517 "timeout must be an integer or None");
518 return NULL;
519 }
Neal Norwitz77c72bb2002-07-28 15:12:10 +0000520 else {
521 tout = PyNumber_Int(tout);
522 if (!tout)
523 return NULL;
Walter Dörwald08c4cc42002-11-12 11:42:20 +0000524 timeout = PyInt_AsLong(tout);
Neal Norwitz77c72bb2002-07-28 15:12:10 +0000525 Py_DECREF(tout);
Neal Norwitz0f46bbf2005-11-03 05:00:25 +0000526 if (timeout == -1 && PyErr_Occurred())
527 return NULL;
Neal Norwitz77c72bb2002-07-28 15:12:10 +0000528 }
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000529
530 /* Ensure the ufd array is up to date */
531 if (!self->ufd_uptodate)
532 if (update_ufd_array(self) == 0)
533 return NULL;
534
535 /* call poll() */
Christian Heimes0e9ab5f2008-03-21 23:49:44 +0000536 Py_BEGIN_ALLOW_THREADS
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000537 poll_result = poll(self->ufds, self->ufd_len, timeout);
Christian Heimes0e9ab5f2008-03-21 23:49:44 +0000538 Py_END_ALLOW_THREADS
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000539
540 if (poll_result < 0) {
541 PyErr_SetFromErrno(SelectError);
542 return NULL;
543 }
544
545 /* build the result list */
546
547 result_list = PyList_New(poll_result);
548 if (!result_list)
549 return NULL;
550 else {
551 for (i = 0, j = 0; j < poll_result; j++) {
552 /* skip to the next fired descriptor */
553 while (!self->ufds[i].revents) {
554 i++;
555 }
556 /* if we hit a NULL return, set value to NULL
557 and break out of loop; code at end will
558 clean up result_list */
559 value = PyTuple_New(2);
560 if (value == NULL)
561 goto error;
562 num = PyInt_FromLong(self->ufds[i].fd);
563 if (num == NULL) {
564 Py_DECREF(value);
565 goto error;
566 }
567 PyTuple_SET_ITEM(value, 0, num);
568
Andrew M. Kuchlinge5dd1622004-08-07 17:21:27 +0000569 /* The &0xffff is a workaround for AIX. 'revents'
570 is a 16-bit short, and IBM assigned POLLNVAL
571 to be 0x8000, so the conversion to int results
572 in a negative number. See SF bug #923315. */
573 num = PyInt_FromLong(self->ufds[i].revents & 0xffff);
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000574 if (num == NULL) {
575 Py_DECREF(value);
576 goto error;
577 }
578 PyTuple_SET_ITEM(value, 1, num);
579 if ((PyList_SetItem(result_list, j, value)) == -1) {
580 Py_DECREF(value);
581 goto error;
582 }
583 i++;
584 }
585 }
586 return result_list;
587
588 error:
589 Py_DECREF(result_list);
590 return NULL;
591}
592
593static PyMethodDef poll_methods[] = {
594 {"register", (PyCFunction)poll_register,
595 METH_VARARGS, poll_register_doc},
Christian Heimes0e9ab5f2008-03-21 23:49:44 +0000596 {"modify", (PyCFunction)poll_modify,
597 METH_VARARGS, poll_modify_doc},
598 {"unregister", (PyCFunction)poll_unregister,
Georg Brandl96a8c392006-05-29 21:04:52 +0000599 METH_O, poll_unregister_doc},
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000600 {"poll", (PyCFunction)poll_poll,
601 METH_VARARGS, poll_poll_doc},
602 {NULL, NULL} /* sentinel */
603};
604
605static pollObject *
Fred Drake8ce159a2000-08-31 05:18:54 +0000606newPollObject(void)
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000607{
608 pollObject *self;
609 self = PyObject_New(pollObject, &poll_Type);
610 if (self == NULL)
611 return NULL;
612 /* ufd_uptodate is a Boolean, denoting whether the
613 array pointed to by ufds matches the contents of the dictionary. */
614 self->ufd_uptodate = 0;
615 self->ufds = NULL;
616 self->dict = PyDict_New();
617 if (self->dict == NULL) {
618 Py_DECREF(self);
619 return NULL;
620 }
621 return self;
622}
623
624static void
625poll_dealloc(pollObject *self)
626{
627 if (self->ufds != NULL)
628 PyMem_DEL(self->ufds);
629 Py_XDECREF(self->dict);
630 PyObject_Del(self);
631}
632
633static PyObject *
634poll_getattr(pollObject *self, char *name)
635{
636 return Py_FindMethod(poll_methods, (PyObject *)self, name);
637}
638
Tim Peters0c322792002-07-17 16:49:03 +0000639static PyTypeObject poll_Type = {
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000640 /* The ob_type field must be initialized in the module init function
641 * to be portable to Windows without using C++. */
Martin v. Löwis68192102007-07-21 06:55:02 +0000642 PyVarObject_HEAD_INIT(NULL, 0)
Guido van Rossum14648392001-12-08 18:02:58 +0000643 "select.poll", /*tp_name*/
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000644 sizeof(pollObject), /*tp_basicsize*/
645 0, /*tp_itemsize*/
646 /* methods */
647 (destructor)poll_dealloc, /*tp_dealloc*/
648 0, /*tp_print*/
649 (getattrfunc)poll_getattr, /*tp_getattr*/
650 0, /*tp_setattr*/
651 0, /*tp_compare*/
652 0, /*tp_repr*/
653 0, /*tp_as_number*/
654 0, /*tp_as_sequence*/
655 0, /*tp_as_mapping*/
656 0, /*tp_hash*/
657};
658
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000659PyDoc_STRVAR(poll_doc,
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000660"Returns a polling object, which supports registering and\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000661unregistering file descriptors, and then polling them for I/O events.");
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000662
663static PyObject *
Georg Brandl96a8c392006-05-29 21:04:52 +0000664select_poll(PyObject *self, PyObject *unused)
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000665{
Georg Brandl96a8c392006-05-29 21:04:52 +0000666 return (PyObject *)newPollObject();
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000667}
Ronald Oussoren32fd16e2006-04-23 12:36:23 +0000668
669#ifdef __APPLE__
670/*
671 * On some systems poll() sets errno on invalid file descriptors. We test
672 * for this at runtime because this bug may be fixed or introduced between
673 * OS releases.
674 */
675static int select_have_broken_poll(void)
676{
677 int poll_test;
678 int filedes[2];
679
680 struct pollfd poll_struct = { 0, POLLIN|POLLPRI|POLLOUT, 0 };
681
682 /* Create a file descriptor to make invalid */
683 if (pipe(filedes) < 0) {
684 return 1;
685 }
686 poll_struct.fd = filedes[0];
687 close(filedes[0]);
688 close(filedes[1]);
689 poll_test = poll(&poll_struct, 1, 0);
690 if (poll_test < 0) {
691 return 1;
692 } else if (poll_test == 0 && poll_struct.revents != POLLNVAL) {
693 return 1;
694 }
695 return 0;
696}
697#endif /* __APPLE__ */
698
699#endif /* HAVE_POLL */
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +0000700
Christian Heimes0e9ab5f2008-03-21 23:49:44 +0000701#ifdef HAVE_EPOLL
702/* **************************************************************************
703 * epoll interface for Linux 2.6
704 *
705 * Written by Christian Heimes
706 * Inspired by Twisted's _epoll.pyx and select.poll()
707 */
708
709#ifdef HAVE_SYS_EPOLL_H
710#include <sys/epoll.h>
711#endif
712
713typedef struct {
714 PyObject_HEAD
715 SOCKET epfd; /* epoll control file descriptor */
716} pyEpoll_Object;
717
718static PyTypeObject pyEpoll_Type;
719#define pyepoll_CHECK(op) (PyObject_TypeCheck((op), &pyEpoll_Type))
720
721static PyObject *
722pyepoll_err_closed(void)
723{
724 PyErr_SetString(PyExc_ValueError, "I/O operation on closed epoll fd");
725 return NULL;
726}
727
728static int
729pyepoll_internal_close(pyEpoll_Object *self)
730{
731 int save_errno = 0;
732 if (self->epfd >= 0) {
733 int epfd = self->epfd;
734 self->epfd = -1;
735 Py_BEGIN_ALLOW_THREADS
736 if (close(epfd) < 0)
737 save_errno = errno;
738 Py_END_ALLOW_THREADS
739 }
740 return save_errno;
741}
742
743static PyObject *
744newPyEpoll_Object(PyTypeObject *type, int sizehint, SOCKET fd)
745{
746 pyEpoll_Object *self;
747
748 if (sizehint == -1) {
749 sizehint = FD_SETSIZE-1;
750 }
751 else if (sizehint < 1) {
752 PyErr_Format(PyExc_ValueError,
753 "sizehint must be greater zero, got %d",
754 sizehint);
755 return NULL;
756 }
757
758 assert(type != NULL && type->tp_alloc != NULL);
759 self = (pyEpoll_Object *) type->tp_alloc(type, 0);
760 if (self == NULL)
761 return NULL;
762
763 if (fd == -1) {
764 Py_BEGIN_ALLOW_THREADS
765 self->epfd = epoll_create(sizehint);
766 Py_END_ALLOW_THREADS
767 }
768 else {
769 self->epfd = fd;
770 }
771 if (self->epfd < 0) {
772 Py_DECREF(self);
773 PyErr_SetFromErrno(PyExc_IOError);
774 return NULL;
775 }
776 return (PyObject *)self;
777}
778
779
780static PyObject *
781pyepoll_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
782{
783 int sizehint = -1;
784 static char *kwlist[] = {"sizehint", NULL};
785
786 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|i:epoll", kwlist,
787 &sizehint))
788 return NULL;
789
790 return newPyEpoll_Object(type, sizehint, -1);
791}
792
793
794static void
795pyepoll_dealloc(pyEpoll_Object *self)
796{
797 (void)pyepoll_internal_close(self);
798 Py_TYPE(self)->tp_free(self);
799}
800
801static PyObject*
802pyepoll_close(pyEpoll_Object *self)
803{
804 errno = pyepoll_internal_close(self);
805 if (errno < 0) {
806 PyErr_SetFromErrno(PyExc_IOError);
807 return NULL;
808 }
809 Py_RETURN_NONE;
810}
811
812PyDoc_STRVAR(pyepoll_close_doc,
813"close() -> None\n\
814\n\
815Close the epoll control file descriptor. Further operations on the epoll\n\
816object will raise an exception.");
817
818static PyObject*
819pyepoll_get_closed(pyEpoll_Object *self)
820{
821 if (self->epfd < 0)
822 Py_RETURN_TRUE;
823 else
824 Py_RETURN_FALSE;
825}
826
827static PyObject*
828pyepoll_fileno(pyEpoll_Object *self)
829{
830 if (self->epfd < 0)
831 return pyepoll_err_closed();
832 return PyInt_FromLong(self->epfd);
833}
834
835PyDoc_STRVAR(pyepoll_fileno_doc,
836"fileno() -> int\n\
837\n\
838Return the epoll control file descriptor.");
839
840static PyObject*
841pyepoll_fromfd(PyObject *cls, PyObject *args)
842{
843 SOCKET fd;
844
845 if (!PyArg_ParseTuple(args, "i:fromfd", &fd))
846 return NULL;
847
848 return newPyEpoll_Object((PyTypeObject*)cls, -1, fd);
849}
850
851PyDoc_STRVAR(pyepoll_fromfd_doc,
852"fromfd(fd) -> epoll\n\
853\n\
854Create an epoll object from a given control fd.");
855
856static PyObject *
857pyepoll_internal_ctl(int epfd, int op, PyObject *pfd, unsigned int events)
858{
859 struct epoll_event ev;
860 int result;
861 int fd;
862
863 if (epfd < 0)
864 return pyepoll_err_closed();
865
866 fd = PyObject_AsFileDescriptor(pfd);
867 if (fd == -1) {
868 return NULL;
869 }
870
871 switch(op) {
872 case EPOLL_CTL_ADD:
873 case EPOLL_CTL_MOD:
874 ev.events = events;
875 ev.data.fd = fd;
876 Py_BEGIN_ALLOW_THREADS
877 result = epoll_ctl(epfd, op, fd, &ev);
878 Py_END_ALLOW_THREADS
879 break;
880 case EPOLL_CTL_DEL:
881 /* In kernel versions before 2.6.9, the EPOLL_CTL_DEL
882 * operation required a non-NULL pointer in event, even
883 * though this argument is ignored. */
884 Py_BEGIN_ALLOW_THREADS
885 result = epoll_ctl(epfd, op, fd, &ev);
886 if (errno == EBADF) {
887 /* fd already closed */
888 result = 0;
889 errno = 0;
890 }
891 Py_END_ALLOW_THREADS
892 break;
893 default:
894 result = -1;
895 errno = EINVAL;
896 }
897
898 if (result < 0) {
899 PyErr_SetFromErrno(PyExc_IOError);
900 return NULL;
901 }
902 Py_RETURN_NONE;
903}
904
905static PyObject *
906pyepoll_register(pyEpoll_Object *self, PyObject *args, PyObject *kwds)
907{
908 PyObject *pfd;
909 unsigned int events = EPOLLIN | EPOLLOUT | EPOLLPRI;
910 static char *kwlist[] = {"fd", "eventmask", NULL};
911
912 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|I:register", kwlist,
913 &pfd, &events)) {
914 return NULL;
915 }
916
917 return pyepoll_internal_ctl(self->epfd, EPOLL_CTL_ADD, pfd, events);
918}
919
920PyDoc_STRVAR(pyepoll_register_doc,
921"register(fd[, eventmask]) -> bool\n\
922\n\
Andrew M. Kuchlinga8c3f2b2008-03-26 00:16:50 +0000923Registers a new fd or modifies an already registered fd. register() returns\n\
Christian Heimes0e9ab5f2008-03-21 23:49:44 +0000924True if a new fd was registered or False if the event mask for fd was modified.\n\
Andrew M. Kuchlinga8c3f2b2008-03-26 00:16:50 +0000925fd is the target file descriptor of the operation.\n\
926events is a bit set composed of the various EPOLL constants; the default\n\
Christian Heimes0e9ab5f2008-03-21 23:49:44 +0000927is EPOLL_IN | EPOLL_OUT | EPOLL_PRI.\n\
928\n\
929The epoll interface supports all file descriptors that support poll.");
930
931static PyObject *
932pyepoll_modify(pyEpoll_Object *self, PyObject *args, PyObject *kwds)
933{
934 PyObject *pfd;
935 unsigned int events;
936 static char *kwlist[] = {"fd", "eventmask", NULL};
937
938 if (!PyArg_ParseTupleAndKeywords(args, kwds, "OI:modify", kwlist,
939 &pfd, &events)) {
940 return NULL;
941 }
942
943 return pyepoll_internal_ctl(self->epfd, EPOLL_CTL_MOD, pfd, events);
944}
945
946PyDoc_STRVAR(pyepoll_modify_doc,
947"modify(fd, eventmask) -> None\n\
948\n\
949fd is the target file descriptor of the operation\n\
950events is a bit set composed of the various EPOLL constants");
951
952static PyObject *
953pyepoll_unregister(pyEpoll_Object *self, PyObject *args, PyObject *kwds)
954{
955 PyObject *pfd;
956 static char *kwlist[] = {"fd", NULL};
957
958 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O:unregister", kwlist,
959 &pfd)) {
960 return NULL;
961 }
962
963 return pyepoll_internal_ctl(self->epfd, EPOLL_CTL_DEL, pfd, 0);
964}
965
966PyDoc_STRVAR(pyepoll_unregister_doc,
967"unregister(fd) -> None\n\
968\n\
969fd is the target file descriptor of the operation.");
970
971static PyObject *
972pyepoll_poll(pyEpoll_Object *self, PyObject *args, PyObject *kwds)
973{
974 double dtimeout = -1.;
975 int timeout;
976 int maxevents = -1;
977 int nfds, i;
978 PyObject *elist = NULL, *etuple = NULL;
979 struct epoll_event *evs = NULL;
980 static char *kwlist[] = {"timeout", "maxevents", NULL};
981
982 if (self->epfd < 0)
983 return pyepoll_err_closed();
984
985 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|di:poll", kwlist,
986 &dtimeout, &maxevents)) {
987 return NULL;
988 }
989
990 if (dtimeout < 0) {
991 timeout = -1;
992 }
993 else if (dtimeout * 1000.0 > INT_MAX) {
994 PyErr_SetString(PyExc_OverflowError,
995 "timeout is too large");
Georg Brandl018a3622008-03-26 12:57:47 +0000996 return NULL;
Christian Heimes0e9ab5f2008-03-21 23:49:44 +0000997 }
998 else {
999 timeout = (int)(dtimeout * 1000.0);
1000 }
1001
1002 if (maxevents == -1) {
1003 maxevents = FD_SETSIZE-1;
1004 }
1005 else if (maxevents < 1) {
1006 PyErr_Format(PyExc_ValueError,
1007 "maxevents must be greater than 0, got %d",
1008 maxevents);
1009 return NULL;
1010 }
1011
1012 evs = PyMem_New(struct epoll_event, maxevents);
1013 if (evs == NULL) {
1014 Py_DECREF(self);
1015 PyErr_NoMemory();
1016 return NULL;
1017 }
1018
1019 Py_BEGIN_ALLOW_THREADS
1020 nfds = epoll_wait(self->epfd, evs, maxevents, timeout);
1021 Py_END_ALLOW_THREADS
1022 if (nfds < 0) {
1023 PyErr_SetFromErrno(PyExc_IOError);
1024 goto error;
1025 }
1026
1027 elist = PyList_New(nfds);
1028 if (elist == NULL) {
1029 goto error;
1030 }
1031
1032 for (i = 0; i < nfds; i++) {
Georg Brandl018a3622008-03-26 12:57:47 +00001033 etuple = Py_BuildValue("iI", evs[i].data.fd, evs[i].events);
Christian Heimes0e9ab5f2008-03-21 23:49:44 +00001034 if (etuple == NULL) {
Georg Brandl018a3622008-03-26 12:57:47 +00001035 Py_CLEAR(elist);
Christian Heimes0e9ab5f2008-03-21 23:49:44 +00001036 goto error;
1037 }
1038 PyList_SET_ITEM(elist, i, etuple);
1039 }
1040
Georg Brandl018a3622008-03-26 12:57:47 +00001041 error:
Christian Heimes0e9ab5f2008-03-21 23:49:44 +00001042 PyMem_Free(evs);
1043 return elist;
1044}
1045
1046PyDoc_STRVAR(pyepoll_poll_doc,
1047"poll([timeout=-1[, maxevents=-1]]) -> [(fd, events), (...)]\n\
1048\n\
1049Wait for events on the epoll file descriptor for a maximum time of timeout\n\
1050in seconds (as float). -1 makes poll wait indefinitely.\n\
1051Up to maxevents are returned to the caller.");
1052
1053static PyMethodDef pyepoll_methods[] = {
1054 {"fromfd", (PyCFunction)pyepoll_fromfd,
1055 METH_VARARGS | METH_CLASS, pyepoll_fromfd_doc},
1056 {"close", (PyCFunction)pyepoll_close, METH_NOARGS,
1057 pyepoll_close_doc},
1058 {"fileno", (PyCFunction)pyepoll_fileno, METH_NOARGS,
1059 pyepoll_fileno_doc},
1060 {"modify", (PyCFunction)pyepoll_modify,
1061 METH_VARARGS | METH_KEYWORDS, pyepoll_modify_doc},
1062 {"register", (PyCFunction)pyepoll_register,
1063 METH_VARARGS | METH_KEYWORDS, pyepoll_register_doc},
1064 {"unregister", (PyCFunction)pyepoll_unregister,
1065 METH_VARARGS | METH_KEYWORDS, pyepoll_unregister_doc},
1066 {"poll", (PyCFunction)pyepoll_poll,
1067 METH_VARARGS | METH_KEYWORDS, pyepoll_poll_doc},
1068 {NULL, NULL},
1069};
1070
1071static PyGetSetDef pyepoll_getsetlist[] = {
1072 {"closed", (getter)pyepoll_get_closed, NULL,
1073 "True if the epoll handler is closed"},
1074 {0},
1075};
1076
1077PyDoc_STRVAR(pyepoll_doc,
1078"select.epoll([sizehint=-1])\n\
1079\n\
1080Returns an epolling object\n\
1081\n\
1082sizehint must be a positive integer or -1 for the default size. The\n\
1083sizehint is used to optimize internal data structures. It doesn't limit\n\
1084the maximum number of monitored events.");
1085
1086static PyTypeObject pyEpoll_Type = {
1087 PyVarObject_HEAD_INIT(NULL, 0)
1088 "select.epoll", /* tp_name */
1089 sizeof(pyEpoll_Object), /* tp_basicsize */
1090 0, /* tp_itemsize */
1091 (destructor)pyepoll_dealloc, /* tp_dealloc */
1092 0, /* tp_print */
1093 0, /* tp_getattr */
1094 0, /* tp_setattr */
1095 0, /* tp_compare */
1096 0, /* tp_repr */
1097 0, /* tp_as_number */
1098 0, /* tp_as_sequence */
1099 0, /* tp_as_mapping */
1100 0, /* tp_hash */
1101 0, /* tp_call */
1102 0, /* tp_str */
1103 PyObject_GenericGetAttr, /* tp_getattro */
1104 0, /* tp_setattro */
1105 0, /* tp_as_buffer */
1106 Py_TPFLAGS_DEFAULT, /* tp_flags */
1107 pyepoll_doc, /* tp_doc */
1108 0, /* tp_traverse */
1109 0, /* tp_clear */
1110 0, /* tp_richcompare */
1111 0, /* tp_weaklistoffset */
1112 0, /* tp_iter */
1113 0, /* tp_iternext */
1114 pyepoll_methods, /* tp_methods */
1115 0, /* tp_members */
1116 pyepoll_getsetlist, /* tp_getset */
1117 0, /* tp_base */
1118 0, /* tp_dict */
1119 0, /* tp_descr_get */
1120 0, /* tp_descr_set */
1121 0, /* tp_dictoffset */
1122 0, /* tp_init */
1123 0, /* tp_alloc */
1124 pyepoll_new, /* tp_new */
1125 0, /* tp_free */
1126};
1127
1128#endif /* HAVE_EPOLL */
1129
1130#ifdef HAVE_KQUEUE
1131/* **************************************************************************
1132 * kqueue interface for BSD
1133 *
1134 * Copyright (c) 2000 Doug White, 2006 James Knight, 2007 Christian Heimes
1135 * All rights reserved.
1136 *
1137 * Redistribution and use in source and binary forms, with or without
1138 * modification, are permitted provided that the following conditions
1139 * are met:
1140 * 1. Redistributions of source code must retain the above copyright
1141 * notice, this list of conditions and the following disclaimer.
1142 * 2. Redistributions in binary form must reproduce the above copyright
1143 * notice, this list of conditions and the following disclaimer in the
1144 * documentation and/or other materials provided with the distribution.
1145 *
1146 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
1147 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1148 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1149 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
1150 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
1151 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
1152 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
1153 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
1154 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
1155 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
1156 * SUCH DAMAGE.
1157 */
1158
1159#ifdef HAVE_SYS_EVENT_H
1160#include <sys/event.h>
1161#endif
1162
1163PyDoc_STRVAR(kqueue_event_doc,
Georg Brandlfa1ffb62009-12-29 21:09:17 +00001164"kevent(ident, filter=KQ_FILTER_READ, flags=KQ_EV_ADD, fflags=0, data=0, udata=0)\n\
Christian Heimes0e9ab5f2008-03-21 23:49:44 +00001165\n\
1166This object is the equivalent of the struct kevent for the C API.\n\
1167\n\
1168See the kqueue manpage for more detailed information about the meaning\n\
1169of the arguments.\n\
1170\n\
1171One minor note: while you might hope that udata could store a\n\
1172reference to a python object, it cannot, because it is impossible to\n\
1173keep a proper reference count of the object once it's passed into the\n\
1174kernel. Therefore, I have restricted it to only storing an integer. I\n\
1175recommend ignoring it and simply using the 'ident' field to key off\n\
1176of. You could also set up a dictionary on the python side to store a\n\
1177udata->object mapping.");
1178
1179typedef struct {
1180 PyObject_HEAD
1181 struct kevent e;
1182} kqueue_event_Object;
1183
1184static PyTypeObject kqueue_event_Type;
1185
1186#define kqueue_event_Check(op) (PyObject_TypeCheck((op), &kqueue_event_Type))
1187
1188typedef struct {
1189 PyObject_HEAD
1190 SOCKET kqfd; /* kqueue control fd */
1191} kqueue_queue_Object;
1192
1193static PyTypeObject kqueue_queue_Type;
1194
1195#define kqueue_queue_Check(op) (PyObject_TypeCheck((op), &kqueue_queue_Type))
1196
Antoine Pitrou323b9da2009-11-04 19:25:14 +00001197#if (SIZEOF_UINTPTR_T != SIZEOF_VOID_P)
1198# error uintptr_t does not match void *!
1199#elif (SIZEOF_UINTPTR_T == SIZEOF_LONG_LONG)
1200# define T_UINTPTRT T_ULONGLONG
1201# define T_INTPTRT T_LONGLONG
1202# define PyLong_AsUintptr_t PyLong_AsUnsignedLongLong
1203# define UINTPTRT_FMT_UNIT "K"
1204# define INTPTRT_FMT_UNIT "L"
1205#elif (SIZEOF_UINTPTR_T == SIZEOF_LONG)
1206# define T_UINTPTRT T_ULONG
1207# define T_INTPTRT T_LONG
1208# define PyLong_AsUintptr_t PyLong_AsUnsignedLong
1209# define UINTPTRT_FMT_UNIT "k"
1210# define INTPTRT_FMT_UNIT "l"
1211#elif (SIZEOF_UINTPTR_T == SIZEOF_INT)
1212# define T_UINTPTRT T_UINT
1213# define T_INTPTRT T_INT
1214# define PyLong_AsUintptr_t PyLong_AsUnsignedLong
1215# define UINTPTRT_FMT_UNIT "I"
1216# define INTPTRT_FMT_UNIT "i"
1217#else
1218# error uintptr_t does not match int, long, or long long!
1219#endif
1220
Christian Heimes0e9ab5f2008-03-21 23:49:44 +00001221/* Unfortunately, we can't store python objects in udata, because
1222 * kevents in the kernel can be removed without warning, which would
1223 * forever lose the refcount on the object stored with it.
1224 */
1225
1226#define KQ_OFF(x) offsetof(kqueue_event_Object, x)
1227static struct PyMemberDef kqueue_event_members[] = {
Antoine Pitrou323b9da2009-11-04 19:25:14 +00001228 {"ident", T_UINTPTRT, KQ_OFF(e.ident)},
Christian Heimes0e9ab5f2008-03-21 23:49:44 +00001229 {"filter", T_SHORT, KQ_OFF(e.filter)},
1230 {"flags", T_USHORT, KQ_OFF(e.flags)},
1231 {"fflags", T_UINT, KQ_OFF(e.fflags)},
Antoine Pitrou323b9da2009-11-04 19:25:14 +00001232 {"data", T_INTPTRT, KQ_OFF(e.data)},
1233 {"udata", T_UINTPTRT, KQ_OFF(e.udata)},
Christian Heimes0e9ab5f2008-03-21 23:49:44 +00001234 {NULL} /* Sentinel */
1235};
1236#undef KQ_OFF
1237
1238static PyObject *
Georg Brandlea370a92010-02-23 21:48:57 +00001239
Christian Heimes0e9ab5f2008-03-21 23:49:44 +00001240kqueue_event_repr(kqueue_event_Object *s)
1241{
1242 char buf[1024];
1243 PyOS_snprintf(
1244 buf, sizeof(buf),
Antoine Pitrou323b9da2009-11-04 19:25:14 +00001245 "<select.kevent ident=%zu filter=%d flags=0x%x fflags=0x%x "
1246 "data=0x%zd udata=%p>",
1247 (size_t)(s->e.ident), s->e.filter, s->e.flags,
1248 s->e.fflags, (Py_ssize_t)(s->e.data), s->e.udata);
Gregory P. Smithdd96db62008-06-09 04:58:54 +00001249 return PyString_FromString(buf);
Christian Heimes0e9ab5f2008-03-21 23:49:44 +00001250}
1251
1252static int
1253kqueue_event_init(kqueue_event_Object *self, PyObject *args, PyObject *kwds)
1254{
1255 PyObject *pfd;
1256 static char *kwlist[] = {"ident", "filter", "flags", "fflags",
1257 "data", "udata", NULL};
Antoine Pitrou323b9da2009-11-04 19:25:14 +00001258 static char *fmt = "O|hhi" INTPTRT_FMT_UNIT UINTPTRT_FMT_UNIT ":kevent";
Christian Heimes0e9ab5f2008-03-21 23:49:44 +00001259
1260 EV_SET(&(self->e), 0, EVFILT_READ, EV_ADD, 0, 0, 0); /* defaults */
1261
Antoine Pitrou323b9da2009-11-04 19:25:14 +00001262 if (!PyArg_ParseTupleAndKeywords(args, kwds, fmt, kwlist,
Christian Heimes0e9ab5f2008-03-21 23:49:44 +00001263 &pfd, &(self->e.filter), &(self->e.flags),
1264 &(self->e.fflags), &(self->e.data), &(self->e.udata))) {
1265 return -1;
1266 }
1267
Antoine Pitrou323b9da2009-11-04 19:25:14 +00001268 if (PyLong_Check(pfd)) {
1269 self->e.ident = PyLong_AsUintptr_t(pfd);
1270 }
1271 else {
1272 self->e.ident = PyObject_AsFileDescriptor(pfd);
1273 }
1274 if (PyErr_Occurred()) {
Christian Heimes0e9ab5f2008-03-21 23:49:44 +00001275 return -1;
1276 }
1277 return 0;
1278}
1279
1280static PyObject *
1281kqueue_event_richcompare(kqueue_event_Object *s, kqueue_event_Object *o,
1282 int op)
1283{
Antoine Pitrou323b9da2009-11-04 19:25:14 +00001284 Py_intptr_t result = 0;
Christian Heimes0e9ab5f2008-03-21 23:49:44 +00001285
1286 if (!kqueue_event_Check(o)) {
1287 if (op == Py_EQ || op == Py_NE) {
1288 PyObject *res = op == Py_EQ ? Py_False : Py_True;
1289 Py_INCREF(res);
1290 return res;
1291 }
1292 PyErr_Format(PyExc_TypeError,
1293 "can't compare %.200s to %.200s",
1294 Py_TYPE(s)->tp_name, Py_TYPE(o)->tp_name);
1295 return NULL;
1296 }
1297 if (((result = s->e.ident - o->e.ident) == 0) &&
1298 ((result = s->e.filter - o->e.filter) == 0) &&
1299 ((result = s->e.flags - o->e.flags) == 0) &&
1300 ((result = s->e.fflags - o->e.fflags) == 0) &&
1301 ((result = s->e.data - o->e.data) == 0) &&
1302 ((result = s->e.udata - o->e.udata) == 0)
1303 ) {
1304 result = 0;
1305 }
1306
1307 switch (op) {
1308 case Py_EQ:
1309 result = (result == 0);
1310 break;
1311 case Py_NE:
1312 result = (result != 0);
1313 break;
1314 case Py_LE:
1315 result = (result <= 0);
1316 break;
1317 case Py_GE:
1318 result = (result >= 0);
1319 break;
1320 case Py_LT:
1321 result = (result < 0);
1322 break;
1323 case Py_GT:
1324 result = (result > 0);
1325 break;
1326 }
Antoine Pitrou323b9da2009-11-04 19:25:14 +00001327 return PyBool_FromLong((long)result);
Christian Heimes0e9ab5f2008-03-21 23:49:44 +00001328}
1329
1330static PyTypeObject kqueue_event_Type = {
1331 PyVarObject_HEAD_INIT(NULL, 0)
1332 "select.kevent", /* tp_name */
1333 sizeof(kqueue_event_Object), /* tp_basicsize */
1334 0, /* tp_itemsize */
1335 0, /* tp_dealloc */
1336 0, /* tp_print */
1337 0, /* tp_getattr */
1338 0, /* tp_setattr */
1339 0, /* tp_compare */
1340 (reprfunc)kqueue_event_repr, /* tp_repr */
1341 0, /* tp_as_number */
1342 0, /* tp_as_sequence */
1343 0, /* tp_as_mapping */
1344 0, /* tp_hash */
1345 0, /* tp_call */
1346 0, /* tp_str */
1347 0, /* tp_getattro */
1348 0, /* tp_setattro */
1349 0, /* tp_as_buffer */
1350 Py_TPFLAGS_DEFAULT, /* tp_flags */
1351 kqueue_event_doc, /* tp_doc */
1352 0, /* tp_traverse */
1353 0, /* tp_clear */
1354 (richcmpfunc)kqueue_event_richcompare, /* tp_richcompare */
1355 0, /* tp_weaklistoffset */
1356 0, /* tp_iter */
1357 0, /* tp_iternext */
1358 0, /* tp_methods */
1359 kqueue_event_members, /* tp_members */
1360 0, /* tp_getset */
1361 0, /* tp_base */
1362 0, /* tp_dict */
1363 0, /* tp_descr_get */
1364 0, /* tp_descr_set */
1365 0, /* tp_dictoffset */
1366 (initproc)kqueue_event_init, /* tp_init */
1367 0, /* tp_alloc */
1368 0, /* tp_new */
1369 0, /* tp_free */
1370};
1371
1372static PyObject *
1373kqueue_queue_err_closed(void)
1374{
1375 PyErr_SetString(PyExc_ValueError, "I/O operation on closed kqueue fd");
1376 return NULL;
1377}
1378
1379static int
1380kqueue_queue_internal_close(kqueue_queue_Object *self)
1381{
1382 int save_errno = 0;
1383 if (self->kqfd >= 0) {
1384 int kqfd = self->kqfd;
1385 self->kqfd = -1;
1386 Py_BEGIN_ALLOW_THREADS
1387 if (close(kqfd) < 0)
1388 save_errno = errno;
1389 Py_END_ALLOW_THREADS
1390 }
1391 return save_errno;
1392}
1393
1394static PyObject *
1395newKqueue_Object(PyTypeObject *type, SOCKET fd)
1396{
1397 kqueue_queue_Object *self;
1398 assert(type != NULL && type->tp_alloc != NULL);
1399 self = (kqueue_queue_Object *) type->tp_alloc(type, 0);
1400 if (self == NULL) {
1401 return NULL;
1402 }
1403
1404 if (fd == -1) {
1405 Py_BEGIN_ALLOW_THREADS
1406 self->kqfd = kqueue();
1407 Py_END_ALLOW_THREADS
1408 }
1409 else {
1410 self->kqfd = fd;
1411 }
1412 if (self->kqfd < 0) {
1413 Py_DECREF(self);
1414 PyErr_SetFromErrno(PyExc_IOError);
1415 return NULL;
1416 }
1417 return (PyObject *)self;
1418}
1419
1420static PyObject *
1421kqueue_queue_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
1422{
1423
1424 if ((args != NULL && PyObject_Size(args)) ||
1425 (kwds != NULL && PyObject_Size(kwds))) {
1426 PyErr_SetString(PyExc_ValueError,
1427 "select.kqueue doesn't accept arguments");
1428 return NULL;
1429 }
1430
1431 return newKqueue_Object(type, -1);
1432}
1433
1434static void
1435kqueue_queue_dealloc(kqueue_queue_Object *self)
1436{
1437 kqueue_queue_internal_close(self);
1438 Py_TYPE(self)->tp_free(self);
1439}
1440
1441static PyObject*
1442kqueue_queue_close(kqueue_queue_Object *self)
1443{
1444 errno = kqueue_queue_internal_close(self);
1445 if (errno < 0) {
1446 PyErr_SetFromErrno(PyExc_IOError);
1447 return NULL;
1448 }
1449 Py_RETURN_NONE;
1450}
1451
1452PyDoc_STRVAR(kqueue_queue_close_doc,
1453"close() -> None\n\
1454\n\
1455Close the kqueue control file descriptor. Further operations on the kqueue\n\
1456object will raise an exception.");
1457
1458static PyObject*
1459kqueue_queue_get_closed(kqueue_queue_Object *self)
1460{
1461 if (self->kqfd < 0)
1462 Py_RETURN_TRUE;
1463 else
1464 Py_RETURN_FALSE;
1465}
1466
1467static PyObject*
1468kqueue_queue_fileno(kqueue_queue_Object *self)
1469{
1470 if (self->kqfd < 0)
1471 return kqueue_queue_err_closed();
1472 return PyInt_FromLong(self->kqfd);
1473}
1474
1475PyDoc_STRVAR(kqueue_queue_fileno_doc,
1476"fileno() -> int\n\
1477\n\
1478Return the kqueue control file descriptor.");
1479
1480static PyObject*
1481kqueue_queue_fromfd(PyObject *cls, PyObject *args)
1482{
1483 SOCKET fd;
1484
1485 if (!PyArg_ParseTuple(args, "i:fromfd", &fd))
1486 return NULL;
1487
1488 return newKqueue_Object((PyTypeObject*)cls, fd);
1489}
1490
1491PyDoc_STRVAR(kqueue_queue_fromfd_doc,
1492"fromfd(fd) -> kqueue\n\
1493\n\
1494Create a kqueue object from a given control fd.");
1495
1496static PyObject *
1497kqueue_queue_control(kqueue_queue_Object *self, PyObject *args)
1498{
1499 int nevents = 0;
1500 int gotevents = 0;
1501 int nchanges = 0;
1502 int i = 0;
1503 PyObject *otimeout = NULL;
1504 PyObject *ch = NULL;
1505 PyObject *it = NULL, *ei = NULL;
1506 PyObject *result = NULL;
1507 struct kevent *evl = NULL;
1508 struct kevent *chl = NULL;
1509 struct timespec timeoutspec;
1510 struct timespec *ptimeoutspec;
1511
1512 if (self->kqfd < 0)
1513 return kqueue_queue_err_closed();
1514
1515 if (!PyArg_ParseTuple(args, "Oi|O:control", &ch, &nevents, &otimeout))
1516 return NULL;
1517
1518 if (nevents < 0) {
1519 PyErr_Format(PyExc_ValueError,
1520 "Length of eventlist must be 0 or positive, got %d",
Georg Brandld77faaf2009-07-16 07:18:07 +00001521 nevents);
Christian Heimes0e9ab5f2008-03-21 23:49:44 +00001522 return NULL;
1523 }
1524
Christian Heimes0e9ab5f2008-03-21 23:49:44 +00001525 if (otimeout == Py_None || otimeout == NULL) {
1526 ptimeoutspec = NULL;
1527 }
1528 else if (PyNumber_Check(otimeout)) {
1529 double timeout;
1530 long seconds;
1531
1532 timeout = PyFloat_AsDouble(otimeout);
1533 if (timeout == -1 && PyErr_Occurred())
1534 return NULL;
1535 if (timeout > (double)LONG_MAX) {
1536 PyErr_SetString(PyExc_OverflowError,
1537 "timeout period too long");
1538 return NULL;
1539 }
1540 if (timeout < 0) {
1541 PyErr_SetString(PyExc_ValueError,
1542 "timeout must be positive or None");
1543 return NULL;
1544 }
1545
1546 seconds = (long)timeout;
1547 timeout = timeout - (double)seconds;
1548 timeoutspec.tv_sec = seconds;
1549 timeoutspec.tv_nsec = (long)(timeout * 1E9);
1550 ptimeoutspec = &timeoutspec;
1551 }
1552 else {
1553 PyErr_Format(PyExc_TypeError,
1554 "timeout argument must be an number "
1555 "or None, got %.200s",
1556 Py_TYPE(otimeout)->tp_name);
1557 return NULL;
1558 }
1559
Georg Brandlea370a92010-02-23 21:48:57 +00001560 if (ch != NULL && ch != Py_None) {
1561 it = PyObject_GetIter(ch);
1562 if (it == NULL) {
1563 PyErr_SetString(PyExc_TypeError,
1564 "changelist is not iterable");
1565 return NULL;
1566 }
1567 nchanges = PyObject_Size(ch);
1568 if (nchanges < 0) {
1569 goto error;
1570 }
1571
Christian Heimes0e9ab5f2008-03-21 23:49:44 +00001572 chl = PyMem_New(struct kevent, nchanges);
1573 if (chl == NULL) {
1574 PyErr_NoMemory();
Georg Brandlea370a92010-02-23 21:48:57 +00001575 goto error;
Christian Heimes0e9ab5f2008-03-21 23:49:44 +00001576 }
Georg Brandld77faaf2009-07-16 07:18:07 +00001577 i = 0;
Christian Heimes0e9ab5f2008-03-21 23:49:44 +00001578 while ((ei = PyIter_Next(it)) != NULL) {
1579 if (!kqueue_event_Check(ei)) {
1580 Py_DECREF(ei);
1581 PyErr_SetString(PyExc_TypeError,
1582 "changelist must be an iterable of "
1583 "select.kevent objects");
1584 goto error;
1585 } else {
Georg Brandld77faaf2009-07-16 07:18:07 +00001586 chl[i++] = ((kqueue_event_Object *)ei)->e;
Christian Heimes0e9ab5f2008-03-21 23:49:44 +00001587 }
1588 Py_DECREF(ei);
1589 }
1590 }
1591 Py_CLEAR(it);
1592
1593 /* event list */
1594 if (nevents) {
1595 evl = PyMem_New(struct kevent, nevents);
1596 if (evl == NULL) {
1597 PyErr_NoMemory();
Georg Brandlea370a92010-02-23 21:48:57 +00001598 goto error;
Christian Heimes0e9ab5f2008-03-21 23:49:44 +00001599 }
1600 }
1601
1602 Py_BEGIN_ALLOW_THREADS
1603 gotevents = kevent(self->kqfd, chl, nchanges,
1604 evl, nevents, ptimeoutspec);
1605 Py_END_ALLOW_THREADS
1606
1607 if (gotevents == -1) {
1608 PyErr_SetFromErrno(PyExc_OSError);
1609 goto error;
1610 }
1611
1612 result = PyList_New(gotevents);
1613 if (result == NULL) {
1614 goto error;
1615 }
1616
Georg Brandld77faaf2009-07-16 07:18:07 +00001617 for (i = 0; i < gotevents; i++) {
Christian Heimes0e9ab5f2008-03-21 23:49:44 +00001618 kqueue_event_Object *ch;
1619
1620 ch = PyObject_New(kqueue_event_Object, &kqueue_event_Type);
1621 if (ch == NULL) {
1622 goto error;
1623 }
1624 ch->e = evl[i];
1625 PyList_SET_ITEM(result, i, (PyObject *)ch);
1626 }
1627 PyMem_Free(chl);
1628 PyMem_Free(evl);
1629 return result;
1630
1631 error:
1632 PyMem_Free(chl);
1633 PyMem_Free(evl);
1634 Py_XDECREF(result);
1635 Py_XDECREF(it);
1636 return NULL;
1637}
1638
1639PyDoc_STRVAR(kqueue_queue_control_doc,
Georg Brandl2f3bd832008-09-21 07:14:44 +00001640"control(changelist, max_events[, timeout=None]) -> eventlist\n\
Christian Heimes0e9ab5f2008-03-21 23:49:44 +00001641\n\
1642Calls the kernel kevent function.\n\
1643- changelist must be a list of kevent objects describing the changes\n\
1644 to be made to the kernel's watch list or None.\n\
1645- max_events lets you specify the maximum number of events that the\n\
1646 kernel will return.\n\
1647- timeout is the maximum time to wait in seconds, or else None,\n\
1648 to wait forever. timeout accepts floats for smaller timeouts, too.");
1649
1650
1651static PyMethodDef kqueue_queue_methods[] = {
1652 {"fromfd", (PyCFunction)kqueue_queue_fromfd,
1653 METH_VARARGS | METH_CLASS, kqueue_queue_fromfd_doc},
1654 {"close", (PyCFunction)kqueue_queue_close, METH_NOARGS,
1655 kqueue_queue_close_doc},
1656 {"fileno", (PyCFunction)kqueue_queue_fileno, METH_NOARGS,
1657 kqueue_queue_fileno_doc},
1658 {"control", (PyCFunction)kqueue_queue_control,
1659 METH_VARARGS , kqueue_queue_control_doc},
1660 {NULL, NULL},
1661};
1662
1663static PyGetSetDef kqueue_queue_getsetlist[] = {
1664 {"closed", (getter)kqueue_queue_get_closed, NULL,
1665 "True if the kqueue handler is closed"},
1666 {0},
1667};
1668
1669PyDoc_STRVAR(kqueue_queue_doc,
1670"Kqueue syscall wrapper.\n\
1671\n\
1672For example, to start watching a socket for input:\n\
1673>>> kq = kqueue()\n\
1674>>> sock = socket()\n\
1675>>> sock.connect((host, port))\n\
1676>>> kq.control([kevent(sock, KQ_FILTER_WRITE, KQ_EV_ADD)], 0)\n\
1677\n\
1678To wait one second for it to become writeable:\n\
1679>>> kq.control(None, 1, 1000)\n\
1680\n\
1681To stop listening:\n\
1682>>> kq.control([kevent(sock, KQ_FILTER_WRITE, KQ_EV_DELETE)], 0)");
1683
1684static PyTypeObject kqueue_queue_Type = {
1685 PyVarObject_HEAD_INIT(NULL, 0)
1686 "select.kqueue", /* tp_name */
1687 sizeof(kqueue_queue_Object), /* tp_basicsize */
1688 0, /* tp_itemsize */
1689 (destructor)kqueue_queue_dealloc, /* tp_dealloc */
1690 0, /* tp_print */
1691 0, /* tp_getattr */
1692 0, /* tp_setattr */
1693 0, /* tp_compare */
1694 0, /* tp_repr */
1695 0, /* tp_as_number */
1696 0, /* tp_as_sequence */
1697 0, /* tp_as_mapping */
1698 0, /* tp_hash */
1699 0, /* tp_call */
1700 0, /* tp_str */
1701 0, /* tp_getattro */
1702 0, /* tp_setattro */
1703 0, /* tp_as_buffer */
1704 Py_TPFLAGS_DEFAULT, /* tp_flags */
1705 kqueue_queue_doc, /* tp_doc */
1706 0, /* tp_traverse */
1707 0, /* tp_clear */
1708 0, /* tp_richcompare */
1709 0, /* tp_weaklistoffset */
1710 0, /* tp_iter */
1711 0, /* tp_iternext */
1712 kqueue_queue_methods, /* tp_methods */
1713 0, /* tp_members */
1714 kqueue_queue_getsetlist, /* tp_getset */
1715 0, /* tp_base */
1716 0, /* tp_dict */
1717 0, /* tp_descr_get */
1718 0, /* tp_descr_set */
1719 0, /* tp_dictoffset */
1720 0, /* tp_init */
1721 0, /* tp_alloc */
1722 kqueue_queue_new, /* tp_new */
1723 0, /* tp_free */
1724};
1725
1726#endif /* HAVE_KQUEUE */
1727/* ************************************************************************ */
1728
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001729PyDoc_STRVAR(select_doc,
Guido van Rossum1d8fb2d1998-06-28 16:54:49 +00001730"select(rlist, wlist, xlist[, timeout]) -> (rlist, wlist, xlist)\n\
1731\n\
1732Wait until one or more file descriptors are ready for some kind of I/O.\n\
Brett Cannon62dba4c2003-09-10 19:37:42 +00001733The first three arguments are sequences of file descriptors to be waited for:\n\
Guido van Rossum1d8fb2d1998-06-28 16:54:49 +00001734rlist -- wait until ready for reading\n\
1735wlist -- wait until ready for writing\n\
1736xlist -- wait for an ``exceptional condition''\n\
1737If only one kind of condition is required, pass [] for the other lists.\n\
1738A file descriptor is either a socket or file object, or a small integer\n\
1739gotten from a fileno() method call on one of those.\n\
1740\n\
1741The optional 4th argument specifies a timeout in seconds; it may be\n\
1742a floating point number to specify fractions of seconds. If it is absent\n\
1743or None, the call will never time out.\n\
1744\n\
1745The return value is a tuple of three lists corresponding to the first three\n\
1746arguments; each contains the subset of the corresponding file descriptors\n\
1747that are ready.\n\
1748\n\
1749*** IMPORTANT NOTICE ***\n\
Christian Heimes0e9ab5f2008-03-21 23:49:44 +00001750On Windows and OpenVMS, only sockets are supported; on Unix, all file\n\
Andrew M. Kuchlinga8c3f2b2008-03-26 00:16:50 +00001751descriptors can be used.");
Guido van Rossum1d8fb2d1998-06-28 16:54:49 +00001752
Barry Warsawe4ac0aa1996-12-12 00:04:35 +00001753static PyMethodDef select_methods[] = {
Christian Heimes0e9ab5f2008-03-21 23:49:44 +00001754 {"select", select_select, METH_VARARGS, select_doc},
1755#ifdef HAVE_POLL
1756 {"poll", select_poll, METH_NOARGS, poll_doc},
Ronald Oussoren32fd16e2006-04-23 12:36:23 +00001757#endif /* HAVE_POLL */
Christian Heimes0e9ab5f2008-03-21 23:49:44 +00001758 {0, 0}, /* sentinel */
Guido van Rossumed233a51992-06-23 09:07:03 +00001759};
1760
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001761PyDoc_STRVAR(module_doc,
Guido van Rossum1d8fb2d1998-06-28 16:54:49 +00001762"This module supports asynchronous I/O on multiple file descriptors.\n\
1763\n\
1764*** IMPORTANT NOTICE ***\n\
Neal Norwitz2a30cd02006-07-10 01:18:57 +00001765On Windows and OpenVMS, only sockets are supported; on Unix, all file descriptors.");
Guido van Rossumed233a51992-06-23 09:07:03 +00001766
Mark Hammond62b1ab12002-07-23 06:31:15 +00001767PyMODINIT_FUNC
Thomas Woutersf3f33dc2000-07-21 06:00:07 +00001768initselect(void)
Guido van Rossumed233a51992-06-23 09:07:03 +00001769{
Fred Drake4baedc12002-04-01 14:53:37 +00001770 PyObject *m;
Guido van Rossum1d8fb2d1998-06-28 16:54:49 +00001771 m = Py_InitModule3("select", select_methods, module_doc);
Neal Norwitz1ac754f2006-01-19 06:09:39 +00001772 if (m == NULL)
1773 return;
Fred Drake4baedc12002-04-01 14:53:37 +00001774
Guido van Rossum0cb96de1997-10-01 04:29:29 +00001775 SelectError = PyErr_NewException("select.error", NULL, NULL);
Fred Drake4baedc12002-04-01 14:53:37 +00001776 Py_INCREF(SelectError);
1777 PyModule_AddObject(m, "error", SelectError);
Ronald Oussoren32fd16e2006-04-23 12:36:23 +00001778
Amaury Forgeot d'Arcce32eb72009-07-09 22:37:22 +00001779#ifdef PIPE_BUF
Gregory P. Smith9d36fd22009-07-03 20:48:31 +00001780 PyModule_AddIntConstant(m, "PIPE_BUF", PIPE_BUF);
Amaury Forgeot d'Arcce32eb72009-07-09 22:37:22 +00001781#endif
Gregory P. Smith9d36fd22009-07-03 20:48:31 +00001782
Christian Heimes0e9ab5f2008-03-21 23:49:44 +00001783#if defined(HAVE_POLL)
Ronald Oussoren32fd16e2006-04-23 12:36:23 +00001784#ifdef __APPLE__
1785 if (select_have_broken_poll()) {
1786 if (PyObject_DelAttrString(m, "poll") == -1) {
1787 PyErr_Clear();
1788 }
1789 } else {
1790#else
1791 {
1792#endif
Christian Heimese93237d2007-12-19 02:37:44 +00001793 Py_TYPE(&poll_Type) = &PyType_Type;
Ronald Oussoren32fd16e2006-04-23 12:36:23 +00001794 PyModule_AddIntConstant(m, "POLLIN", POLLIN);
1795 PyModule_AddIntConstant(m, "POLLPRI", POLLPRI);
1796 PyModule_AddIntConstant(m, "POLLOUT", POLLOUT);
1797 PyModule_AddIntConstant(m, "POLLERR", POLLERR);
1798 PyModule_AddIntConstant(m, "POLLHUP", POLLHUP);
1799 PyModule_AddIntConstant(m, "POLLNVAL", POLLNVAL);
Andrew M. Kuchlingcf96dc82000-08-25 01:15:33 +00001800
Andrew M. Kuchling36d97eb2000-09-28 21:33:44 +00001801#ifdef POLLRDNORM
Ronald Oussoren32fd16e2006-04-23 12:36:23 +00001802 PyModule_AddIntConstant(m, "POLLRDNORM", POLLRDNORM);
Andrew M. Kuchling36d97eb2000-09-28 21:33:44 +00001803#endif
1804#ifdef POLLRDBAND
Ronald Oussoren32fd16e2006-04-23 12:36:23 +00001805 PyModule_AddIntConstant(m, "POLLRDBAND", POLLRDBAND);
Andrew M. Kuchling36d97eb2000-09-28 21:33:44 +00001806#endif
1807#ifdef POLLWRNORM
Ronald Oussoren32fd16e2006-04-23 12:36:23 +00001808 PyModule_AddIntConstant(m, "POLLWRNORM", POLLWRNORM);
Andrew M. Kuchling36d97eb2000-09-28 21:33:44 +00001809#endif
1810#ifdef POLLWRBAND
Ronald Oussoren32fd16e2006-04-23 12:36:23 +00001811 PyModule_AddIntConstant(m, "POLLWRBAND", POLLWRBAND);
Andrew M. Kuchling36d97eb2000-09-28 21:33:44 +00001812#endif
Sjoerd Mullender239f8362000-08-25 13:59:18 +00001813#ifdef POLLMSG
Ronald Oussoren32fd16e2006-04-23 12:36:23 +00001814 PyModule_AddIntConstant(m, "POLLMSG", POLLMSG);
Sjoerd Mullender239f8362000-08-25 13:59:18 +00001815#endif
Ronald Oussoren32fd16e2006-04-23 12:36:23 +00001816 }
1817#endif /* HAVE_POLL */
Christian Heimes0e9ab5f2008-03-21 23:49:44 +00001818
1819#ifdef HAVE_EPOLL
1820 Py_TYPE(&pyEpoll_Type) = &PyType_Type;
1821 if (PyType_Ready(&pyEpoll_Type) < 0)
1822 return;
1823
1824 Py_INCREF(&pyEpoll_Type);
1825 PyModule_AddObject(m, "epoll", (PyObject *) &pyEpoll_Type);
1826
1827 PyModule_AddIntConstant(m, "EPOLLIN", EPOLLIN);
1828 PyModule_AddIntConstant(m, "EPOLLOUT", EPOLLOUT);
1829 PyModule_AddIntConstant(m, "EPOLLPRI", EPOLLPRI);
1830 PyModule_AddIntConstant(m, "EPOLLERR", EPOLLERR);
1831 PyModule_AddIntConstant(m, "EPOLLHUP", EPOLLHUP);
1832 PyModule_AddIntConstant(m, "EPOLLET", EPOLLET);
1833#ifdef EPOLLONESHOT
1834 /* Kernel 2.6.2+ */
1835 PyModule_AddIntConstant(m, "EPOLLONESHOT", EPOLLONESHOT);
1836#endif
1837 /* PyModule_AddIntConstant(m, "EPOLL_RDHUP", EPOLLRDHUP); */
1838 PyModule_AddIntConstant(m, "EPOLLRDNORM", EPOLLRDNORM);
1839 PyModule_AddIntConstant(m, "EPOLLRDBAND", EPOLLRDBAND);
1840 PyModule_AddIntConstant(m, "EPOLLWRNORM", EPOLLWRNORM);
1841 PyModule_AddIntConstant(m, "EPOLLWRBAND", EPOLLWRBAND);
1842 PyModule_AddIntConstant(m, "EPOLLMSG", EPOLLMSG);
1843#endif /* HAVE_EPOLL */
1844
1845#ifdef HAVE_KQUEUE
1846 kqueue_event_Type.tp_new = PyType_GenericNew;
1847 Py_TYPE(&kqueue_event_Type) = &PyType_Type;
1848 if(PyType_Ready(&kqueue_event_Type) < 0)
1849 return;
1850
1851 Py_INCREF(&kqueue_event_Type);
1852 PyModule_AddObject(m, "kevent", (PyObject *)&kqueue_event_Type);
1853
1854 Py_TYPE(&kqueue_queue_Type) = &PyType_Type;
1855 if(PyType_Ready(&kqueue_queue_Type) < 0)
1856 return;
1857 Py_INCREF(&kqueue_queue_Type);
1858 PyModule_AddObject(m, "kqueue", (PyObject *)&kqueue_queue_Type);
1859
1860 /* event filters */
1861 PyModule_AddIntConstant(m, "KQ_FILTER_READ", EVFILT_READ);
1862 PyModule_AddIntConstant(m, "KQ_FILTER_WRITE", EVFILT_WRITE);
1863 PyModule_AddIntConstant(m, "KQ_FILTER_AIO", EVFILT_AIO);
1864 PyModule_AddIntConstant(m, "KQ_FILTER_VNODE", EVFILT_VNODE);
1865 PyModule_AddIntConstant(m, "KQ_FILTER_PROC", EVFILT_PROC);
1866#ifdef EVFILT_NETDEV
1867 PyModule_AddIntConstant(m, "KQ_FILTER_NETDEV", EVFILT_NETDEV);
1868#endif
1869 PyModule_AddIntConstant(m, "KQ_FILTER_SIGNAL", EVFILT_SIGNAL);
1870 PyModule_AddIntConstant(m, "KQ_FILTER_TIMER", EVFILT_TIMER);
1871
1872 /* event flags */
1873 PyModule_AddIntConstant(m, "KQ_EV_ADD", EV_ADD);
1874 PyModule_AddIntConstant(m, "KQ_EV_DELETE", EV_DELETE);
1875 PyModule_AddIntConstant(m, "KQ_EV_ENABLE", EV_ENABLE);
1876 PyModule_AddIntConstant(m, "KQ_EV_DISABLE", EV_DISABLE);
1877 PyModule_AddIntConstant(m, "KQ_EV_ONESHOT", EV_ONESHOT);
1878 PyModule_AddIntConstant(m, "KQ_EV_CLEAR", EV_CLEAR);
1879
1880 PyModule_AddIntConstant(m, "KQ_EV_SYSFLAGS", EV_SYSFLAGS);
1881 PyModule_AddIntConstant(m, "KQ_EV_FLAG1", EV_FLAG1);
1882
1883 PyModule_AddIntConstant(m, "KQ_EV_EOF", EV_EOF);
1884 PyModule_AddIntConstant(m, "KQ_EV_ERROR", EV_ERROR);
1885
1886 /* READ WRITE filter flag */
1887 PyModule_AddIntConstant(m, "KQ_NOTE_LOWAT", NOTE_LOWAT);
1888
1889 /* VNODE filter flags */
1890 PyModule_AddIntConstant(m, "KQ_NOTE_DELETE", NOTE_DELETE);
1891 PyModule_AddIntConstant(m, "KQ_NOTE_WRITE", NOTE_WRITE);
1892 PyModule_AddIntConstant(m, "KQ_NOTE_EXTEND", NOTE_EXTEND);
1893 PyModule_AddIntConstant(m, "KQ_NOTE_ATTRIB", NOTE_ATTRIB);
1894 PyModule_AddIntConstant(m, "KQ_NOTE_LINK", NOTE_LINK);
1895 PyModule_AddIntConstant(m, "KQ_NOTE_RENAME", NOTE_RENAME);
1896 PyModule_AddIntConstant(m, "KQ_NOTE_REVOKE", NOTE_REVOKE);
1897
1898 /* PROC filter flags */
1899 PyModule_AddIntConstant(m, "KQ_NOTE_EXIT", NOTE_EXIT);
1900 PyModule_AddIntConstant(m, "KQ_NOTE_FORK", NOTE_FORK);
1901 PyModule_AddIntConstant(m, "KQ_NOTE_EXEC", NOTE_EXEC);
1902 PyModule_AddIntConstant(m, "KQ_NOTE_PCTRLMASK", NOTE_PCTRLMASK);
1903 PyModule_AddIntConstant(m, "KQ_NOTE_PDATAMASK", NOTE_PDATAMASK);
1904
1905 PyModule_AddIntConstant(m, "KQ_NOTE_TRACK", NOTE_TRACK);
1906 PyModule_AddIntConstant(m, "KQ_NOTE_CHILD", NOTE_CHILD);
1907 PyModule_AddIntConstant(m, "KQ_NOTE_TRACKERR", NOTE_TRACKERR);
1908
1909 /* NETDEV filter flags */
1910#ifdef EVFILT_NETDEV
1911 PyModule_AddIntConstant(m, "KQ_NOTE_LINKUP", NOTE_LINKUP);
1912 PyModule_AddIntConstant(m, "KQ_NOTE_LINKDOWN", NOTE_LINKDOWN);
1913 PyModule_AddIntConstant(m, "KQ_NOTE_LINKINV", NOTE_LINKINV);
1914#endif
1915
1916#endif /* HAVE_KQUEUE */
Guido van Rossumed233a51992-06-23 09:07:03 +00001917}