home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 4 / AACD04.ISO / AACD / Programming / Python / Source / Modules / selectmodule.c < prev    next >
Encoding:
C/C++ Source or Header  |  1999-04-26  |  13.6 KB  |  536 lines
  1. /***********************************************************
  2. Copyright 1991-1995 by Stichting Mathematisch Centrum, Amsterdam,
  3. The Netherlands.
  4.  
  5.                         All Rights Reserved
  6.  
  7. Permission to use, copy, modify, and distribute this software and its
  8. documentation for any purpose and without fee is hereby granted,
  9. provided that the above copyright notice appear in all copies and that
  10. both that copyright notice and this permission notice appear in
  11. supporting documentation, and that the names of Stichting Mathematisch
  12. Centrum or CWI or Corporation for National Research Initiatives or
  13. CNRI not be used in advertising or publicity pertaining to
  14. distribution of the software without specific, written prior
  15. permission.
  16.  
  17. While CWI is the initial source for this software, a modified version
  18. is made available by the Corporation for National Research Initiatives
  19. (CNRI) at the Internet address ftp://ftp.python.org.
  20.  
  21. STICHTING MATHEMATISCH CENTRUM AND CNRI DISCLAIM ALL WARRANTIES WITH
  22. REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
  23. MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH
  24. CENTRUM OR CNRI BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
  25. DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
  26. PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  27. TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  28. PERFORMANCE OF THIS SOFTWARE.
  29.  
  30. ******************************************************************/
  31.  
  32. /* select - Module containing unix select(2) call.
  33.    Under Unix, the file descriptors are small integers.
  34.    Under Win32, select only exists for sockets, and sockets may
  35.    have any value except INVALID_SOCKET.
  36.    Under BeOS, we suffer the same dichotomy as Win32; sockets can be anything
  37.    >= 0.
  38. */
  39.  
  40. #include "Python.h"
  41.  
  42. #ifdef HAVE_UNISTD_H
  43. #include <unistd.h>
  44. #endif
  45.  
  46. #ifdef __sgi
  47. /* This is missing from unistd.h */
  48. extern void bzero();
  49. #endif
  50.  
  51. #include <sys/types.h>
  52.  
  53. #if defined(PYOS_OS2)
  54. #include <sys/time.h>
  55. #include <utils.h>
  56. #endif
  57.  
  58. #ifdef MS_WINDOWS
  59. #include <winsock.h>
  60. #else
  61. #ifdef __BEOS__
  62. #include <net/socket.h>
  63. #define SOCKET int
  64. #else
  65. #include "myselect.h" /* Also includes mytime.h */
  66. #define SOCKET int
  67. #endif
  68. #endif
  69.  
  70. static PyObject *SelectError;
  71.  
  72. /* list of Python objects and their file descriptor */
  73. typedef struct {
  74.     PyObject *obj;                 /* owned reference */
  75.     SOCKET fd;
  76.     int sentinel;                 /* -1 == sentinel */
  77. } pylist;
  78.  
  79. #include "protos/selectmodule.h"
  80.  
  81. static void
  82. reap_obj(fd2obj)
  83.     pylist fd2obj[FD_SETSIZE + 3];
  84. {
  85.     int i;
  86.     for (i = 0; i < FD_SETSIZE + 3 && fd2obj[i].sentinel >= 0; i++) {
  87.         Py_XDECREF(fd2obj[i].obj);
  88.         fd2obj[i].obj = NULL;
  89.     }
  90.     fd2obj[0].sentinel = -1;
  91. }
  92.  
  93.  
  94. /* returns -1 and sets the Python exception if an error occurred, otherwise
  95.    returns a number >= 0
  96. */
  97. static int
  98. list2set(list, set, fd2obj)
  99.     PyObject *list;
  100.     fd_set *set;
  101.     pylist fd2obj[FD_SETSIZE + 3];
  102. {
  103.     int i;
  104.     int max = -1;
  105.     int index = 0;
  106.     int len = PyList_Size(list);
  107.     PyObject* o = NULL;
  108.  
  109.     fd2obj[0].obj = (PyObject*)0;         /* set list to zero size */
  110.     FD_ZERO(set);
  111.  
  112.     for (i = 0; i < len; i++)  {
  113.         PyObject *meth;
  114.         SOCKET v;
  115.  
  116.         /* any intervening fileno() calls could decr this refcnt */
  117.         if (!(o = PyList_GetItem(list, i)))
  118.                     return -1;
  119.  
  120.         Py_INCREF(o);
  121.  
  122.         if (PyInt_Check(o)) {
  123.             v = PyInt_AsLong(o);
  124.         }
  125.         else if ((meth = PyObject_GetAttrString(o, "fileno")) != NULL)
  126.         {
  127.             PyObject *fno = PyEval_CallObject(meth, NULL);
  128.             Py_DECREF(meth);
  129.             if (fno == NULL)
  130.                 goto finally;
  131.  
  132.                         if (!PyInt_Check(fno)) {
  133.                 PyErr_SetString(PyExc_TypeError,
  134.                                        "fileno method returned a non-integer");
  135.                 Py_DECREF(fno);
  136.                 goto finally;
  137.                         }
  138.                         v = PyInt_AsLong(fno);
  139.             Py_DECREF(fno);
  140.         }
  141.         else {
  142.             PyErr_SetString(PyExc_TypeError,
  143.             "argument must be an int, or have a fileno() method.");
  144.             goto finally;
  145.         }
  146. #if defined(_MSC_VER) || defined(__BEOS__)
  147.         max = 0;             /* not used for Win32 */
  148. #else  /* !_MSC_VER */
  149.         if (v < 0 || v >= FD_SETSIZE) {
  150.             PyErr_SetString(PyExc_ValueError,
  151.                     "filedescriptor out of range in select()");
  152.             goto finally;
  153.         }
  154.         if (v > max)
  155.             max = v;
  156. #endif /* _MSC_VER */
  157.         FD_SET(v, set);
  158.  
  159.         /* add object and its file descriptor to the list */
  160.         if (index >= FD_SETSIZE) {
  161.             PyErr_SetString(PyExc_ValueError,
  162.                       "too many file descriptors in select()");
  163.             goto finally;
  164.         }
  165.         fd2obj[index].obj = o;
  166.         fd2obj[index].fd = v;
  167.         fd2obj[index].sentinel = 0;
  168.         fd2obj[++index].sentinel = -1;
  169.     }
  170.     return max+1;
  171.  
  172.   finally:
  173.     Py_XDECREF(o);
  174.     return -1;
  175. }
  176.  
  177. /* returns NULL and sets the Python exception if an error occurred */
  178. static PyObject *
  179. set2list(set, fd2obj)
  180.     fd_set *set;
  181.     pylist fd2obj[FD_SETSIZE + 3];
  182. {
  183.     int i, j, count=0;
  184.     PyObject *list, *o;
  185.     SOCKET fd;
  186.  
  187.     for (j = 0; fd2obj[j].sentinel >= 0; j++) {
  188.         if (FD_ISSET(fd2obj[j].fd, set))
  189.             count++;
  190.     }
  191.     list = PyList_New(count);
  192.     if (!list)
  193.         return NULL;
  194.  
  195.     i = 0;
  196.     for (j = 0; fd2obj[j].sentinel >= 0; j++) {
  197.         fd = fd2obj[j].fd;
  198.         if (FD_ISSET(fd, set)) {
  199. #ifndef _MSC_VER
  200.             if (fd > FD_SETSIZE) {
  201.                 PyErr_SetString(PyExc_SystemError,
  202.                "filedescriptor out of range returned in select()");
  203.                 goto finally;
  204.             }
  205. #endif
  206.             o = fd2obj[j].obj;
  207.             fd2obj[j].obj = NULL;
  208.             /* transfer ownership */
  209.             if (PyList_SetItem(list, i, o) < 0)
  210.                 goto finally;
  211.  
  212.             i++;
  213.         }
  214.     }
  215.     return list;
  216.   finally:
  217.     Py_DECREF(list);
  218.     return NULL;
  219. }
  220.  
  221. #if defined(AMITCP) || defined(INET225)
  222. /* Amiga's version of select: WaitSelect()/selectwait() support */
  223. /* (additional 5th parameter: signal waitmask) */
  224. static PyObject *
  225. select_select(self, args)
  226.     PyObject *self;
  227.     PyObject *args;
  228. {
  229. #if defined (MS_WINDOWS) || defined (_AMIGA)
  230.     /* This would be an awful lot of stack space on Windows! */
  231.     pylist *rfd2obj, *wfd2obj, *efd2obj;
  232. #else
  233.     pylist rfd2obj[FD_SETSIZE + 3];
  234.     pylist wfd2obj[FD_SETSIZE + 3];
  235.     pylist efd2obj[FD_SETSIZE + 3];
  236. #endif
  237.     PyObject *ifdlist, *ofdlist, *efdlist;
  238.     PyObject *ret = NULL;
  239.     PyObject *tout = Py_None;
  240.     fd_set ifdset, ofdset, efdset;
  241.     double timeout;
  242.     struct timeval tv, *tvp;
  243.     int seconds;
  244.     int imax, omax, emax, max;
  245.     int n;
  246.     ULONG waitmask=0;
  247.     BOOL do_waitmask = FALSE;
  248.  
  249.     /* convert arguments */
  250.     if (!PyArg_ParseTuple(args, "OOO|Oi",
  251.                   &ifdlist, &ofdlist, &efdlist, &tout, &waitmask))
  252.         return NULL;
  253.  
  254.     if (tout == Py_None)
  255.         tvp = (struct timeval *)0;
  256.     else if (!PyArg_Parse(tout, "d", &timeout)) {
  257.         PyErr_SetString(PyExc_TypeError,
  258.                 "timeout must be a float or None");
  259.         return NULL;
  260.     }
  261.     else {
  262.         seconds = (int)timeout;
  263.         timeout = timeout - (double)seconds;
  264.         tv.tv_sec = seconds;
  265.         tv.tv_usec = (int)(timeout*1000000.0);
  266.         tvp = &tv;
  267.     }
  268.  
  269.     if(waitmask) do_waitmask=TRUE;
  270.  
  271.     /* sanity check first three arguments */
  272.     if (!PyList_Check(ifdlist) ||
  273.         !PyList_Check(ofdlist) ||
  274.         !PyList_Check(efdlist))
  275.     {
  276.         PyErr_SetString(PyExc_TypeError,
  277.                 "arguments 1-3 must be lists");
  278.         return NULL;
  279.     }
  280.  
  281. #if defined(MS_WINDOWS) || defined (_AMIGA)
  282.     /* Allocate memory for the lists */
  283.     rfd2obj = PyMem_NEW(pylist, FD_SETSIZE + 3);
  284.     wfd2obj = PyMem_NEW(pylist, FD_SETSIZE + 3);
  285.     efd2obj = PyMem_NEW(pylist, FD_SETSIZE + 3);
  286.     if (rfd2obj == NULL || wfd2obj == NULL || efd2obj == NULL) {
  287.         PyMem_XDEL(rfd2obj);
  288.         PyMem_XDEL(wfd2obj);
  289.         PyMem_XDEL(efd2obj);
  290.         return NULL;
  291.     }
  292. #endif
  293.     /* Convert lists to fd_sets, and get maximum fd number
  294.      * propagates the Python exception set in list2set()
  295.      */
  296.     rfd2obj[0].sentinel = -1;
  297.     wfd2obj[0].sentinel = -1;
  298.     efd2obj[0].sentinel = -1;
  299.     if ((imax=list2set(ifdlist, &ifdset, rfd2obj)) < 0) 
  300.         goto finally;
  301.     if ((omax=list2set(ofdlist, &ofdset, wfd2obj)) < 0) 
  302.         goto finally;
  303.     if ((emax=list2set(efdlist, &efdset, efd2obj)) < 0) 
  304.         goto finally;
  305.     max = imax;
  306.     if (omax > max) max = omax;
  307.     if (emax > max) max = emax;
  308.  
  309.     Py_BEGIN_ALLOW_THREADS
  310. #ifdef AMITCP
  311.     n = WaitSelect(max, &ifdset, &ofdset, &efdset, tvp, &waitmask);
  312. #else /* INET225 */
  313.     n = selectwait(max, &ifdset, &ofdset, &efdset, tvp, &waitmask);
  314. #endif    
  315.     Py_END_ALLOW_THREADS
  316.  
  317.     if (n < 0) {
  318.         PyErr_SetFromErrno(SelectError);
  319.     }
  320.     else if (n == 0) {
  321.                 /* optimization */
  322.         ifdlist = PyList_New(0);
  323.         if (ifdlist) {
  324.             if(do_waitmask) ret=Py_BuildValue("OOOi", ifdlist, ifdlist, ifdlist, waitmask);
  325.             else ret = Py_BuildValue("OOO", ifdlist, ifdlist, ifdlist);
  326.             Py_DECREF(ifdlist);
  327.         }
  328.     }
  329.     else {
  330.         /* any of these three calls can raise an exception.  it's more
  331.            convenient to test for this after all three calls... but
  332.            is that acceptable?
  333.         */
  334.         ifdlist = set2list(&ifdset, rfd2obj);
  335.         ofdlist = set2list(&ofdset, wfd2obj);
  336.         efdlist = set2list(&efdset, efd2obj);
  337.         if (PyErr_Occurred())
  338.             ret = NULL;
  339.         else
  340.         {
  341.             if(do_waitmask) ret=Py_BuildValue("OOOi", ifdlist, ofdlist, efdlist, waitmask);
  342.             else ret = Py_BuildValue("OOO", ifdlist, ofdlist, efdlist);
  343.         }
  344.  
  345.         Py_DECREF(ifdlist);
  346.         Py_DECREF(ofdlist);
  347.         Py_DECREF(efdlist);
  348.     }
  349.     
  350.   finally:
  351.     reap_obj(rfd2obj);
  352.     reap_obj(wfd2obj);
  353.     reap_obj(efd2obj);
  354. #if defined(MS_WINDOWS) || defined (_AMIGA)
  355.     PyMem_DEL(rfd2obj);
  356.     PyMem_DEL(wfd2obj);
  357.     PyMem_DEL(efd2obj);
  358. #endif
  359.     return ret;
  360. }
  361.  
  362. #else /* ! AMITCP || INET225 */
  363. /* This is the select function for all other platforms */
  364.     
  365. static PyObject *
  366. select_select(self, args)
  367.     PyObject *self;
  368.     PyObject *args;
  369. {
  370. #ifdef MS_WINDOWS
  371.     /* This would be an awful lot of stack space on Windows! */
  372.     pylist *rfd2obj, *wfd2obj, *efd2obj;
  373. #else
  374.     pylist rfd2obj[FD_SETSIZE + 3];
  375.     pylist wfd2obj[FD_SETSIZE + 3];
  376.     pylist efd2obj[FD_SETSIZE + 3];
  377. #endif
  378.     PyObject *ifdlist, *ofdlist, *efdlist;
  379.     PyObject *ret = NULL;
  380.     PyObject *tout = Py_None;
  381.     fd_set ifdset, ofdset, efdset;
  382.     double timeout;
  383.     struct timeval tv, *tvp;
  384.     int seconds;
  385.     int imax, omax, emax, max;
  386.     int n;
  387.  
  388.     /* convert arguments */
  389.     if (!PyArg_ParseTuple(args, "OOO|O",
  390.                   &ifdlist, &ofdlist, &efdlist, &tout))
  391.         return NULL;
  392.  
  393.     if (tout == Py_None)
  394.         tvp = (struct timeval *)0;
  395.     else if (!PyArg_Parse(tout, "d", &timeout)) {
  396.         PyErr_SetString(PyExc_TypeError,
  397.                 "timeout must be a float or None");
  398.         return NULL;
  399.     }
  400.     else {
  401.         seconds = (int)timeout;
  402.         timeout = timeout - (double)seconds;
  403.         tv.tv_sec = seconds;
  404.         tv.tv_usec = (int)(timeout*1000000.0);
  405.         tvp = &tv;
  406.     }
  407.  
  408.     /* sanity check first three arguments */
  409.     if (!PyList_Check(ifdlist) ||
  410.         !PyList_Check(ofdlist) ||
  411.         !PyList_Check(efdlist))
  412.     {
  413.         PyErr_SetString(PyExc_TypeError,
  414.                 "arguments 1-3 must be lists");
  415.         return NULL;
  416.     }
  417.  
  418. #ifdef MS_WINDOWS
  419.     /* Allocate memory for the lists */
  420.     rfd2obj = PyMem_NEW(pylist, FD_SETSIZE + 3);
  421.     wfd2obj = PyMem_NEW(pylist, FD_SETSIZE + 3);
  422.     efd2obj = PyMem_NEW(pylist, FD_SETSIZE + 3);
  423.     if (rfd2obj == NULL || wfd2obj == NULL || efd2obj == NULL) {
  424.         PyMem_XDEL(rfd2obj);
  425.         PyMem_XDEL(wfd2obj);
  426.         PyMem_XDEL(efd2obj);
  427.         return NULL;
  428.     }
  429. #endif
  430.     /* Convert lists to fd_sets, and get maximum fd number
  431.      * propagates the Python exception set in list2set()
  432.      */
  433.     rfd2obj[0].sentinel = -1;
  434.     wfd2obj[0].sentinel = -1;
  435.     efd2obj[0].sentinel = -1;
  436.     if ((imax=list2set(ifdlist, &ifdset, rfd2obj)) < 0) 
  437.         goto finally;
  438.     if ((omax=list2set(ofdlist, &ofdset, wfd2obj)) < 0) 
  439.         goto finally;
  440.     if ((emax=list2set(efdlist, &efdset, efd2obj)) < 0) 
  441.         goto finally;
  442.     max = imax;
  443.     if (omax > max) max = omax;
  444.     if (emax > max) max = emax;
  445.  
  446.     Py_BEGIN_ALLOW_THREADS
  447.     n = select(max, &ifdset, &ofdset, &efdset, tvp);
  448.     Py_END_ALLOW_THREADS
  449.  
  450.     if (n < 0) {
  451.         PyErr_SetFromErrno(SelectError);
  452.     }
  453.     else if (n == 0) {
  454.                 /* optimization */
  455.         ifdlist = PyList_New(0);
  456.         if (ifdlist) {
  457.             ret = Py_BuildValue("OOO", ifdlist, ifdlist, ifdlist);
  458.             Py_DECREF(ifdlist);
  459.         }
  460.     }
  461.     else {
  462.         /* any of these three calls can raise an exception.  it's more
  463.            convenient to test for this after all three calls... but
  464.            is that acceptable?
  465.         */
  466.         ifdlist = set2list(&ifdset, rfd2obj);
  467.         ofdlist = set2list(&ofdset, wfd2obj);
  468.         efdlist = set2list(&efdset, efd2obj);
  469.         if (PyErr_Occurred())
  470.             ret = NULL;
  471.         else
  472.             ret = Py_BuildValue("OOO", ifdlist, ofdlist, efdlist);
  473.  
  474.         Py_DECREF(ifdlist);
  475.         Py_DECREF(ofdlist);
  476.         Py_DECREF(efdlist);
  477.     }
  478.     
  479.   finally:
  480.     reap_obj(rfd2obj);
  481.     reap_obj(wfd2obj);
  482.     reap_obj(efd2obj);
  483. #ifdef MS_WINDOWS
  484.     PyMem_DEL(rfd2obj);
  485.     PyMem_DEL(wfd2obj);
  486.     PyMem_DEL(efd2obj);
  487. #endif
  488.     return ret;
  489. }
  490. #endif /* !AMITCP || INET225 */
  491.  
  492. static char select_doc[] =
  493. "select(rlist, wlist, xlist[, timeout]) -> (rlist, wlist, xlist)\n\
  494. \n\
  495. Wait until one or more file descriptors are ready for some kind of I/O.\n\
  496. The first three arguments are lists of file descriptors to be waited for:\n\
  497. rlist -- wait until ready for reading\n\
  498. wlist -- wait until ready for writing\n\
  499. xlist -- wait for an ``exceptional condition''\n\
  500. If only one kind of condition is required, pass [] for the other lists.\n\
  501. A file descriptor is either a socket or file object, or a small integer\n\
  502. gotten from a fileno() method call on one of those.\n\
  503. \n\
  504. The optional 4th argument specifies a timeout in seconds; it may be\n\
  505. a floating point number to specify fractions of seconds.  If it is absent\n\
  506. or None, the call will never time out.\n\
  507. \n\
  508. The return value is a tuple of three lists corresponding to the first three\n\
  509. arguments; each contains the subset of the corresponding file descriptors\n\
  510. that are ready.\n\
  511. \n\
  512. *** IMPORTANT NOTICE ***\n\
  513. On Windows, only sockets are supported; on Unix, all file descriptors.";
  514.  
  515.  
  516. static PyMethodDef select_methods[] = {
  517.     {"select",    select_select, 1, select_doc},
  518.     {0,      0},                 /* sentinel */
  519. };
  520.  
  521. static char module_doc[] =
  522. "This module supports asynchronous I/O on multiple file descriptors.\n\
  523. \n\
  524. *** IMPORTANT NOTICE ***\n\
  525. On Windows, only sockets are supported; on Unix, all file descriptors.";
  526.  
  527. DL_EXPORT(void)
  528. initselect()
  529. {
  530.     PyObject *m, *d;
  531.     m = Py_InitModule3("select", select_methods, module_doc);
  532.     d = PyModule_GetDict(m);
  533.     SelectError = PyErr_NewException("select.error", NULL, NULL);
  534.     PyDict_SetItemString(d, "error", SelectError);
  535. }
  536.