Annotation of libwww/Library/src/HTEvtLst.c, revision 2.41

2.4       eric        1: /*                                                                  HTEvtLst.c
2.1       frystyk     2: **     EVENT MANAGER
                      3: **
                      4: **     (c) COPYRIGHT MIT 1995.
                      5: **     Please first read the full copyright statement in the file COPYRIGH.
2.41    ! frystyk     6: **     @(#) $Id: HTEvtLst.c,v 2.40 1999/06/23 18:00:53 frystyk Exp $
2.1       frystyk     7: **
                      8: **     Updated HTEvent module 
                      9: **     This new module combines the functions of the old HTEvent module and 
                     10: **     the HTThread module. We retain the old HTThread module, but it
                     11: **     consists of calls to the HTEvent interfaces
                     12: **
                     13: ** Authors:
                     14: **     HFN     Henrik Frystyk <frystyk@w3.org>
                     15: **     CLB     Charlie Brooks <cbrooks@osf.org>
                     16: ** Bugs
                     17: **
                     18: */
                     19: 
                     20: /*   WSAAsyncSelect and windows app stuff need the following definitions:
                     21:  *   WWW_WIN_ASYNC - enable WSAAsyncSelect instead of select
                     22:  *   _WIN23 - win32 libararies - may be window or console app
                     23:  *   _WINSOCKAPI_ - using WINSOCK.DLL - not necessarily the async routines.
                     24:  *   _CONSOLE - the console app for NT
                     25:  *
                     26:  * first pass: EGP - 10/26/95
                     27:  */
                     28: 
                     29: /* Implementation dependent include files */
2.21      frystyk    30: #include "wwwsys.h"
2.1       frystyk    31: #include "WWWUtil.h"
                     32: #include "WWWCore.h"
                     33: #include "HTReqMan.h"
                     34: #include "HTTimer.h"
2.5       eric       35: #include "HTEvent.h"
2.1       frystyk    36: #include "HTEvtLst.h"                                   /* Implemented here */
                     37: 
                     38: /* Type definitions and global variables etc. local to this module */
                     39: #define MILLI_PER_SECOND       1000
2.32      frystyk    40: #define HASH(s)                        ((s) % HT_M_HASH_SIZE) 
2.34      frystyk    41: 
2.32      frystyk    42: #define EVENTS_TO_EXECUTE      10 /* how many to execute in one select loop */
2.1       frystyk    43: 
2.34      frystyk    44: #define HT_FS_BYTES(a)         ((((a)/16)+1) * 4)
2.15      frystyk    45: 
2.3       eric       46: typedef struct {
                     47:     SOCKET     s ;                     /* our socket */
                     48:     HTEvent *  events[HTEvent_TYPES];  /* event parameters for read, write, oob */
2.5       eric       49:     HTTimer *  timeouts[HTEvent_TYPES];
2.3       eric       50: } SockEvents;
                     51: 
2.34      frystyk    52: typedef struct {
                     53:     HTEvent *  event;
                     54:     SOCKET     s;
                     55:     HTEventType        type;
                     56:     HTPriority skipped;
                     57: } EventOrder;
                     58: 
2.3       eric       59: typedef enum {
                     60:     SockEvents_mayCreate,
                     61:     SockEvents_find
                     62: } SockEvents_action;
2.1       frystyk    63: 
2.34      frystyk    64: PRIVATE HTList * HashTable [HT_M_HASH_SIZE]; 
                     65: PRIVATE HTList * EventOrderList = NULL;
2.1       frystyk    66: PRIVATE int HTEndLoop = 0;                    /* If !0 then exit event loop */
2.41    ! frystyk    67: PRIVATE BOOL HTInLoop = NO;
2.1       frystyk    68: 
2.34      frystyk    69: #ifdef WWW_WIN_ASYNC
                     70: #define TIMEOUT        1 /* WM_TIMER id */
                     71: PRIVATE HWND HTSocketWin;
                     72: PRIVATE ATOM HTclass;
                     73: PRIVATE HINSTANCE HTinstance;
                     74: PRIVATE unsigned long HTwinMsg;
                     75: #else /* WWW_WIN_ASYNC */
                     76: PRIVATE fd_set FdArray[HTEvent_TYPES];
                     77: PRIVATE SOCKET MaxSock = 0;                      /* max socket value in use */
                     78: #endif /* !WWW_WIN_ASYNC */
                     79: 
                     80: /* ------------------------------------------------------------------------- */
                     81: /*                             DEBUG FUNCTIONS                              */
2.1       frystyk    82: /* ------------------------------------------------------------------------- */
                     83: 
2.36      frystyk    84: #ifdef HTDEBUG
2.34      frystyk    85: PRIVATE void Event_trace (HTEvent * event)
2.8       frystyk    86: {
2.34      frystyk    87:     if (event) {
2.36      frystyk    88:        HTTRACE(ALL_TRACE, "%8p: %3d %6d %8p %8p %8p" _
                     89:                event _ event->priority _ event->millis _ event->cbf _
                     90:                event->param _ event->request);
2.34      frystyk    91:     }
2.8       frystyk    92: }
                     93: 
2.34      frystyk    94: PRIVATE void Event_traceHead (void)
2.8       frystyk    95: {
2.36      frystyk    96:     HTTRACE(ALL_TRACE, "     event: pri millis  callback   param    request  ");
2.8       frystyk    97: }
                     98: 
2.34      frystyk    99: PRIVATE void Timer_trace (HTTimer * timer)
2.1       frystyk   100: {
2.34      frystyk   101:     if (timer) {
2.36      frystyk   102:        HTTRACE(ALL_TRACE, "%8p: %6d %ld %c %8p" _
                    103:                timer _
                    104:                HTTimer_expiresAbsolute(timer) _
                    105:                HTTimer_expiresRelative(timer) _
                    106:                HTTimer_isRelative(timer) ? 'R' : 'A' _
2.34      frystyk   107:                HTTimer_callback(timer));
2.1       frystyk   108:     }
                    109: }
                    110: 
2.34      frystyk   111: PRIVATE void Timer_traceHead (void)
2.3       eric      112: {
2.36      frystyk   113:     HTTRACE(ALL_TRACE, "     timer: millis expires ?   param   callback  ");
2.3       eric      114: }
2.34      frystyk   115: 
2.1       frystyk   116: /*
                    117: **  A simple debug function that dumps all the socket arrays
                    118: **  as trace messages
                    119: */
2.3       eric      120: PRIVATE void EventList_dump (void)
2.1       frystyk   121: {
2.18      frystyk   122:     int v = 0;
2.3       eric      123:     HTList* cur;
                    124:     SockEvents * pres;
2.36      frystyk   125:     HTTRACE(ALL_TRACE, "Event....... Dumping socket events\n");
                    126:     HTTRACE(ALL_TRACE, "soc ");
2.34      frystyk   127:     Event_traceHead();
2.36      frystyk   128:     HTTRACE(ALL_TRACE, " ");
2.34      frystyk   129:     Timer_traceHead();
2.36      frystyk   130:     HTTRACE(ALL_TRACE, "\n");
2.32      frystyk   131:     for (v = 0; v < HT_M_HASH_SIZE; v++) {
2.3       eric      132:        cur = HashTable[v];
                    133:        while ((pres = (SockEvents *) HTList_nextObject(cur))) {
                    134:            int i;
2.36      frystyk   135:            HTTRACE(ALL_TRACE, "%3d \n" _ pres->s);
2.3       eric      136:            for (i = 0; i < HTEvent_TYPES; i++)
                    137:                if (pres->events[i]) {
                    138:                    static char * names[HTEvent_TYPES] = {"read", "writ", "xcpt"};
2.36      frystyk   139:                    HTTRACE(ALL_TRACE, "%s " _ names[i]);
2.34      frystyk   140:                    Event_trace(pres->events[i]);
2.36      frystyk   141:                    HTTRACE(ALL_TRACE, " ");
2.34      frystyk   142:                    Timer_trace(pres->timeouts[i]);
2.36      frystyk   143:                    HTTRACE(ALL_TRACE, " ");
2.3       eric      144:                }
2.36      frystyk   145:            HTTRACE(ALL_TRACE, "\n");
2.3       eric      146:        }
                    147:     }
2.1       frystyk   148: }
2.37      frystyk   149: 
                    150: PRIVATE void fd_dump (SOCKET maxfs, fd_set * rset, fd_set * wset, fd_set * oset, 
                    151:                      struct timeval * wt)
                    152: {
                    153:     SOCKET cnt;
                    154: 
                    155:     /* Check read set */
                    156:     HTTRACE(THD_TRACE, "............ READ :");
                    157:     for (cnt=0; cnt<=maxfs; cnt++)
                    158:        if (FD_ISSET(cnt, rset)) HTTRACE(THD_TRACE, " %d" _ cnt);
                    159:     HTTRACE(THD_TRACE, "\n");
                    160: 
                    161:     /* Check write set */
                    162:     HTTRACE(THD_TRACE, "............ WRITE:");
                    163:     for (cnt=0; cnt<=maxfs; cnt++)
                    164:        if (FD_ISSET(cnt, wset)) HTTRACE(THD_TRACE, " %d" _ cnt);
                    165:     HTTRACE(THD_TRACE, "\n");
                    166: 
                    167:     /* Check oob set */
                    168:     HTTRACE(THD_TRACE, "............ OOB  :");
                    169:     for (cnt=0; cnt<=maxfs; cnt++)
                    170:        if (FD_ISSET(cnt, oset)) HTTRACE(THD_TRACE, " %d" _ cnt);
                    171:     HTTRACE(THD_TRACE, "\n");
                    172: 
                    173:     if (wt)
2.38      frystyk   174:        HTTRACE(THD_TRACE, "............ Timeout is %ld s, %ld microsecs\n" _
2.37      frystyk   175:                wt->tv_sec _ wt->tv_usec);
                    176: }
2.36      frystyk   177: #endif /* HTDEBUG */
2.1       frystyk   178: 
                    179: /* ------------------------------------------------------------------------- */
2.34      frystyk   180: /*                        EVENT TIMING FUNCTIONS                            */
                    181: /* ------------------------------------------------------------------------- */
                    182: 
                    183: #ifdef WWW_WIN_ASYNC
                    184: PRIVATE BOOL Timer_setWindowsTimer (HTTimer * timer)
                    185: {
                    186:     UINT id;
2.39      frystyk   187:     HWND hwnd = HTEventList_getWinHandle(&id);
                    188:     BOOL status = (SetTimer(hwnd, (UINT)timer, (UINT)HTTimer_getTime(timer), NULL) == 0) ? NO : YES;
                    189:     return status;
2.34      frystyk   190: }
                    191: 
                    192: PRIVATE BOOL Timer_deleteWindowsTimer (HTTimer * timer)
                    193: {
                    194:     UINT id;
2.39      frystyk   195:     HWND hwnd = HTEventList_getWinHandle(&id);
                    196:     BOOL status = (KillTimer(hwnd, (UINT)timer) == 0) ? NO : YES;
                    197:     return status;
2.34      frystyk   198: }
                    199: #endif /* WWW_WIN_ASYNC */
                    200: 
                    201: /*
                    202: **  Event timeout handler
                    203: **  If an event didn't occur before the timeout then call it explicitly
                    204: **  indicating that it timed out.
                    205: */
2.5       eric      206: PRIVATE int EventListTimerHandler (HTTimer * timer, void * param, HTEventType type)
                    207: {
2.11      frystyk   208:     SockEvents * sockp = (SockEvents *) param;
                    209:     HTEvent * event = NULL;
2.34      frystyk   210: 
                    211:     /* Check for read timeout */
                    212:     if (sockp->timeouts[HTEvent_INDEX(HTEvent_READ)] == timer) {
2.5       eric      213:        event = sockp->events[HTEvent_INDEX(HTEvent_READ)];
2.36      frystyk   214:        HTTRACE(THD_TRACE, "Event....... READ timed out on %d.\n" _ sockp->s);
2.5       eric      215:        return (*event->cbf) (sockp->s, event->param, HTEvent_TIMEOUT);
                    216:     }
2.34      frystyk   217: 
                    218:     /* Check for write timeout */
                    219:     if (sockp->timeouts[HTEvent_INDEX(HTEvent_WRITE)] == timer) {
2.5       eric      220:        event = sockp->events[HTEvent_INDEX(HTEvent_WRITE)];
2.36      frystyk   221:        HTTRACE(THD_TRACE, "Event....... WRITE timed out on %d.\n" _ sockp->s);
2.5       eric      222:        return (*event->cbf) (sockp->s, event->param, HTEvent_TIMEOUT);
                    223:     }
2.34      frystyk   224: 
                    225:     /* Check for out-of-band data timeout */
                    226:     if (sockp->timeouts[HTEvent_INDEX(HTEvent_OOB)] == timer) {
2.5       eric      227:        event = sockp->events[HTEvent_INDEX(HTEvent_OOB)];
2.36      frystyk   228:        HTTRACE(THD_TRACE, "Event....... OOB timed out on %d.\n" _ sockp->s);
2.5       eric      229:        return (*event->cbf) (sockp->s, event->param, HTEvent_TIMEOUT);
                    230:     }
2.36      frystyk   231:     HTTRACE(THD_TRACE, "Event....... No event for timer %p with context %p\n" _ timer _ param);
2.5       eric      232:     return HT_ERROR;
                    233: }
                    234: 
2.34      frystyk   235: PUBLIC void CheckSockEvent (HTTimer * timer, HTTimerCallback * cbf, void * param)
                    236: {
                    237:     SockEvents * sockp = (SockEvents *)param;
                    238:     if (cbf == EventListTimerHandler && 
                    239:        sockp->timeouts[0] != timer && 
                    240:        sockp->timeouts[1] != timer && 
                    241:        sockp->timeouts[2] != timer) {
2.36      frystyk   242:        HTDEBUGBREAK("Bad timer %p\n" _ timer);
2.34      frystyk   243:     }
                    244: }
                    245: 
                    246: /* ------------------------------------------------------------------------- */
                    247: /*                          EVENT ORDERING STUFF                            */
2.5       eric      248: /* ------------------------------------------------------------------------- */
2.1       frystyk   249: 
2.34      frystyk   250: PRIVATE SockEvents * SockEvents_get (SOCKET s, SockEvents_action action)
2.2       eric      251: {
2.34      frystyk   252:     long v = HASH(s);
                    253:     HTList* cur;
                    254:     SockEvents * pres;
                    255:     if (HashTable[v] == NULL) HashTable[v] = HTList_new();
                    256:     cur = HashTable[v];
                    257:     while ((pres = (SockEvents *) HTList_nextObject(cur)))
                    258:        if (pres->s == s) return pres;
                    259: 
                    260:     if (action == SockEvents_mayCreate) {
                    261:         if ((pres = (SockEvents *) HT_CALLOC(1, sizeof(SockEvents))) == NULL)
                    262:            HT_OUTOFMEM("HTEventList_register");
                    263:        pres->s = s;
                    264:        HTList_addObject(HashTable[v], (void *)pres);
                    265:        return pres;
                    266:     }
                    267:     return NULL;
2.2       eric      268: }
                    269: 
2.34      frystyk   270: PRIVATE int EventOrder_add (SOCKET s, HTEventType type, ms_t now)
2.2       eric      271: {
                    272:     EventOrder * pres;
                    273:     HTList * cur = EventOrderList;
                    274:     HTList * insertAfter = cur;
2.5       eric      275:     SockEvents * sockp = SockEvents_get(s, SockEvents_find);
                    276:     HTEvent * event;
2.2       eric      277: 
2.5       eric      278:     if (sockp == NULL || (event = sockp->events[HTEvent_INDEX(type)]) == NULL) {
2.36      frystyk   279:        HTTRACE(THD_TRACE, "EventOrder.. no event found for socket %d, type %s.\n" _
                    280:                s _ HTEvent_type2str(type));
2.2       eric      281:        return HT_ERROR;
                    282:     }
                    283: 
2.34      frystyk   284:     /* Fixup the timeout */
2.5       eric      285:     if (sockp->timeouts[HTEvent_INDEX(type)])
                    286:        HTTimer_refresh(sockp->timeouts[HTEvent_INDEX(type)], now);
                    287: 
2.34      frystyk   288:     /* Look to see if it's already here from before */
2.2       eric      289:     while ((pres = (EventOrder *) HTList_nextObject(cur))) {
                    290:        if (pres->s == s && pres->event == event && pres->type == type) {
                    291:            pres->skipped++;
                    292:            return HT_OK;
                    293:        }
                    294:        if (pres->event->priority+pres->skipped > event->priority)
                    295:            insertAfter = cur;
                    296:     }
                    297: 
2.34      frystyk   298:     /* Create a new element */
2.2       eric      299:     if ((pres = (EventOrder *) HT_CALLOC(1, sizeof(EventOrder))) == NULL)
                    300:        HT_OUTOFMEM("EventOrder_add");
                    301:     pres->event = event;
                    302:     pres->s = s;
                    303:     pres->type = type;
                    304:     HTList_addObject(insertAfter, (void *)pres);
                    305:     return HT_OK;
                    306: }
                    307: 
                    308: PUBLIC int EventOrder_executeAndDelete (void) 
                    309: {
2.4       eric      310:     HTList * cur = EventOrderList;
2.2       eric      311:     EventOrder * pres;
                    312:     int i = 0;
2.36      frystyk   313:     HTTRACE(THD_TRACE, "EventOrder.. execute ordered events\n");
2.4       eric      314:     if (cur == NULL) return NO;
2.34      frystyk   315:     while ((pres=(EventOrder *) HTList_removeLastObject(cur)) && i<EVENTS_TO_EXECUTE) {
2.5       eric      316:        HTEvent * event = pres->event;
                    317:        int ret;
2.36      frystyk   318:        HTTRACE(THD_TRACE, "EventList... calling socket %d, request %p handler %p type %s\n" _ 
                    319:                    pres->s _ (void *) event->request _ 
                    320:                    (void *) event->cbf _ HTEvent_type2str(pres->type));
2.5       eric      321:        ret = (*pres->event->cbf)(pres->s, pres->event->param, pres->type);
2.2       eric      322:        HT_FREE(pres);
2.34      frystyk   323:        if (ret != HT_OK) return ret;
2.2       eric      324:        i++;
                    325:     }
                    326:     return HT_OK;
                    327: }
                    328: 
2.41    ! frystyk   329: PRIVATE BOOL EventOrder_clearAll (void)
2.2       eric      330: {
                    331:     HTList * cur = EventOrderList;
                    332:     EventOrder * pres;
2.41    ! frystyk   333:     HTTRACE(THD_TRACE, "EventOrder.. Clearing all ordered events\n");
        !           334:     if (cur) {
        !           335:        while ((pres = (EventOrder *) HTList_nextObject(cur)))
        !           336:            HT_FREE(pres);
        !           337:        return YES;
        !           338:     }
        !           339:     return NO;
        !           340: }
        !           341: 
        !           342: PUBLIC BOOL EventOrder_deleteAll (void) 
        !           343: {
        !           344:     EventOrder_clearAll();
2.2       eric      345:     HTList_delete(EventOrderList);
                    346:     EventOrderList = NULL;
                    347:     return YES;
                    348: }
                    349: 
                    350: /* ------------------------------------------------------------------------- */
2.34      frystyk   351: /*                             EVENT REGISTRATION                           */
                    352: /* ------------------------------------------------------------------------- */
2.1       frystyk   353: 
                    354: /*
2.15      frystyk   355: ** ResetMaxSock - reset the value of the maximum socket in use 
                    356: */
2.17      frystyk   357: #ifndef WWW_WIN_ASYNC
2.15      frystyk   358: PRIVATE void __ResetMaxSock (void)
                    359: {
                    360:     SOCKET cnt;
                    361:     SOCKET t_max = 0;
                    362:     SOCKET old_max = MaxSock;
                    363:     for (cnt = 0 ; cnt <= MaxSock; cnt++) { 
                    364:        if (FD_ISSET(cnt, (FdArray + HTEvent_INDEX(HTEvent_READ))) ||
                    365:            FD_ISSET(cnt, (FdArray + HTEvent_INDEX(HTEvent_WRITE))) ||
                    366:            FD_ISSET(cnt, (FdArray + HTEvent_INDEX(HTEvent_OOB))))
                    367:            if (cnt > t_max) t_max = cnt;
                    368:     }
                    369:     MaxSock = t_max+1;
2.36      frystyk   370:     HTTRACE(THD_TRACE, "Event....... Reset MaxSock from %u to %u\n" _ old_max _ MaxSock);
2.15      frystyk   371:     return;
                    372: }  
2.17      frystyk   373: #endif /* !WWW_WIN_ASYNC */
2.15      frystyk   374: 
2.34      frystyk   375: PRIVATE int EventList_remaining (SockEvents * pres)
2.19      frystyk   376: {
                    377:     int ret = 0;
                    378:     int i;
                    379:     for (i = 0; i < HTEvent_TYPES; i++)
                    380:        if (pres->events[i] != NULL)
                    381:            ret |= 1<<i;
                    382:     return ret;
                    383: }
                    384: 
2.15      frystyk   385: /*
2.1       frystyk   386: **  For a given socket, reqister a request structure, a set of operations, 
                    387: **  a HTEventCallback function, and a priority. For this implementation, 
                    388: **  we allow only a single HTEventCallback function for all operations.
                    389: **  and the priority field is ignored.
                    390: */
                    391: PUBLIC int HTEventList_register (SOCKET s, HTEventType type, HTEvent * event)
                    392: {
2.19      frystyk   393:     int newset = 0;
2.3       eric      394:     SockEvents * sockp;
2.36      frystyk   395:     HTTRACE(THD_TRACE, "Event....... Register socket %d, request %p handler %p type %s at priority %d\n" _ 
                    396:                s _ (void *) event->request _ 
                    397:                (void *) event->cbf _ HTEvent_type2str(type) _ 
2.1       frystyk   398:                (unsigned) event->priority);
2.4       eric      399:     if (s==INVSOC || HTEvent_INDEX(type) >= HTEvent_TYPES)
2.1       frystyk   400:        return 0;
                    401: 
                    402:     /*
                    403:     ** Insert socket into appropriate file descriptor set. We also make sure
                    404:     ** that it is registered in the global set.
                    405:     */
2.36      frystyk   406:     HTTRACE(THD_TRACE, "Event....... Registering socket for %s\n" _ HTEvent_type2str(type));
2.3       eric      407:     sockp = SockEvents_get(s, SockEvents_mayCreate);
                    408:     sockp->s = s;
                    409:     sockp->events[HTEvent_INDEX(type)] = event;
2.19      frystyk   410:     newset = EventList_remaining(sockp);
2.3       eric      411: #ifdef WWW_WIN_ASYNC
2.19      frystyk   412:     if (WSAAsyncSelect(s, HTSocketWin, HTwinMsg, HTEvent_BITS(newset)) < 0) {
2.36      frystyk   413:         HTTRACE(THD_TRACE, "Event....... WSAAsyncSelect returned `%s'!" _ HTErrnoString(socerrno));
2.3       eric      414:        return HT_ERROR;
2.19      frystyk   415:     }
2.3       eric      416: #else /* WWW_WIN_ASYNC */
2.1       frystyk   417:     FD_SET(s, FdArray+HTEvent_INDEX(type));
2.36      frystyk   418: 
                    419:     HTTRACEDATA((char *) FdArray+HTEvent_INDEX(type), 8, "HTEventList_register: (s:%d)" _ s);
                    420: 
2.15      frystyk   421:     if (s > MaxSock) {
                    422:        MaxSock = s ;
2.36      frystyk   423:        HTTRACE(THD_TRACE, "Event....... New value for MaxSock is %d\n" _ MaxSock);
2.15      frystyk   424:     }
2.3       eric      425: #endif /* !WWW_WIN_ASYNC */
2.11      frystyk   426: 
2.1       frystyk   427:     /*
2.11      frystyk   428:     **  If the timeout has been set (relative in millis) then we register 
                    429:     **  a new timeout for this event unless we already have a timer.
2.1       frystyk   430:     */
                    431:     if (event->millis >= 0) {
2.11      frystyk   432:        sockp->timeouts[HTEvent_INDEX(type)] =
                    433:            HTTimer_new(sockp->timeouts[HTEvent_INDEX(type)],
2.22      frystyk   434:                        EventListTimerHandler, sockp, event->millis, YES, YES);
2.1       frystyk   435:     }
                    436: 
                    437:     return HT_OK;
                    438: }
                    439: 
                    440: /*
                    441: ** Remove the registered information for the specified socket for the actions 
                    442: ** specified in ops. if no actions remain after the unregister, the registered
                    443: ** info is deleted, and, if the socket has been registered for notification, 
                    444: ** the HTEventCallback will be invoked.
                    445: */
2.34      frystyk   446: PUBLIC int HTEventList_unregister (SOCKET s, HTEventType type) 
2.1       frystyk   447: {
2.3       eric      448:     long               v = HASH(s);
                    449:     HTList *           cur = HashTable[v];
                    450:     HTList *           last = cur;
                    451:     SockEvents *       pres;
2.9       eric      452:     int                        ret = HT_ERROR;
2.2       eric      453: 
2.9       eric      454:     while (cur && (pres = (SockEvents *) HTList_nextObject(cur))) {
2.2       eric      455:         if (pres->s == s) {
2.19      frystyk   456:            int remaining = 0;
2.1       frystyk   457: 
                    458:            /*
                    459:            **  Unregister the event from this action
                    460:            */
2.2       eric      461:            pres->events[HTEvent_INDEX(type)] = NULL;
2.19      frystyk   462:             remaining = EventList_remaining(pres);
2.1       frystyk   463: 
                    464:            /*
                    465:            **  Check to see of there was a timeout connected with the event.
                    466:            **  If so then delete the timeout as well.
                    467:            */
                    468:            {
2.2       eric      469:                HTTimer * timer = pres->timeouts[HTEvent_INDEX(type)];
2.19      frystyk   470:                 if (timer) HTTimer_delete(timer);
                    471:                 pres->timeouts[HTEvent_INDEX(type)] = NULL;
2.1       frystyk   472:            }
                    473:            
2.18      frystyk   474: #ifdef WWW_WIN_ASYNC
                    475:            if (WSAAsyncSelect(s, HTSocketWin, HTwinMsg, remaining) < 0)
                    476:                ret = HT_ERROR;
                    477: #else /* WWW_WIN_ASYNC */
                    478:            FD_CLR(s, FdArray+HTEvent_INDEX(type));
2.36      frystyk   479: 
                    480:            HTTRACEDATA((char*)FdArray+HTEvent_INDEX(type), 8, "HTEventList_unregister: (s:%d)" _ s);
                    481: 
2.18      frystyk   482: #endif /* !WWW_WIN_ASYNC */
                    483: 
2.1       frystyk   484:            /*
                    485:            **  Check to see if we can delete the action completely. We do this
                    486:            **  if there are no more events registered.
                    487:            */
2.19      frystyk   488:            if (remaining == 0) {
2.9       eric      489:                HTList * doomed = cur;
2.36      frystyk   490:                HTTRACE(THD_TRACE, "Event....... No more events registered for socket %d\n" _ s);
2.15      frystyk   491: 
                    492: #ifndef WWW_WIN_ASYNC
                    493:                /* Check to see if we have to update MaxSock */
2.34      frystyk   494:                if (pres->s >= MaxSock) __ResetMaxSock();
2.15      frystyk   495: #endif /* !WWW_WIN_ASYNC */
                    496: 
2.2       eric      497:                HT_FREE(pres);
2.9       eric      498:                pres = (SockEvents *) HTList_nextObject(cur);
                    499:                HTList_quickRemoveElement(doomed, last);
                    500:            }
                    501:            ret = HT_OK;
2.15      frystyk   502: 
2.36      frystyk   503:            HTTRACE(THD_TRACE, "Event....... Socket %d unregistered for %s\n" _ s _ 
2.18      frystyk   504:                                   HTEvent_type2str(type));
2.15      frystyk   505: 
2.34      frystyk   506:            /* We found the socket and can break */
2.15      frystyk   507:            break;
2.9       eric      508:        }
                    509:        last = cur;
2.1       frystyk   510:     }
2.34      frystyk   511:     if (THD_TRACE) {
                    512:        if (ret == HT_ERROR)
2.36      frystyk   513:            HTTRACE(THD_TRACE, "Event....... Couldn't find socket %d. Can't unregister type %s\n" _
                    514:                    s _ HTEvent_type2str(type));
2.34      frystyk   515:     }
2.9       eric      516:     return ret;
2.1       frystyk   517: }
                    518: 
                    519: /*
                    520: ** Unregister all sockets 
                    521: ** N.B. we just remove them for our internal data structures: it is up to the 
                    522: ** application to actually close the socket. 
                    523: */
2.2       eric      524: PUBLIC int HTEventList_unregisterAll (void) 
2.1       frystyk   525: {
                    526:     int i;
2.36      frystyk   527:     HTTRACE(THD_TRACE, "Unregister.. all sockets\n");
2.32      frystyk   528:     for (i = 0 ; i < HT_M_HASH_SIZE; i++) {
2.2       eric      529:        HTList * cur = HashTable[i];
2.3       eric      530:        SockEvents * pres;
                    531:        while ((pres = (SockEvents *) HTList_nextObject(cur))) {
                    532: #ifdef WWW_WIN_ASYNC
                    533:            WSAAsyncSelect(pres->s, HTSocketWin, HTwinMsg, 0);
                    534: #endif /* WWW_WIN_ASYNC */
2.2       eric      535:            HT_FREE(pres);
2.3       eric      536:        }
2.2       eric      537:        HTList_delete(HashTable[i]);
                    538:        HashTable[i] = NULL;
2.1       frystyk   539:     }
2.34      frystyk   540: 
2.3       eric      541: #ifndef WWW_WIN_ASYNC
                    542:     MaxSock = 0 ;
2.36      frystyk   543:     HTTRACE(THD_TRACE, "Event....... New value for MaxSock is %d\n" _ MaxSock);
2.1       frystyk   544:     FD_ZERO(FdArray+HTEvent_INDEX(HTEvent_READ));
                    545:     FD_ZERO(FdArray+HTEvent_INDEX(HTEvent_WRITE));
                    546:     FD_ZERO(FdArray+HTEvent_INDEX(HTEvent_OOB));
2.3       eric      547: #endif /* !WWW_WIN_ASYNC */
2.34      frystyk   548: 
2.2       eric      549:     EventOrder_deleteAll();
2.1       frystyk   550:     return 0;
                    551: }
                    552: 
                    553: /*
                    554: **  Dispatch the event to the appropriate event handler.
                    555: **  If no event handler is found then just return.
                    556: */
2.5       eric      557: PUBLIC int HTEventList_dispatch (SOCKET s, HTEventType type, ms_t now)
2.1       frystyk   558: {
2.3       eric      559:     SockEvents * sockp = SockEvents_get(s, SockEvents_find);
                    560:     if (sockp) {
                    561:        HTEvent * event = sockp->events[HTEvent_INDEX(type)];
2.1       frystyk   562: 
2.34      frystyk   563:        /* Fixup the timeout */
2.5       eric      564:        if (sockp->timeouts[HTEvent_INDEX(type)])
                    565:            HTTimer_refresh(sockp->timeouts[HTEvent_INDEX(type)], now);
2.34      frystyk   566: 
2.1       frystyk   567:        /*
                    568:        **  If we have found an event object for this event then see
                    569:        **  is we should call it.
                    570:        */
                    571:        if (event && event->priority!=HT_PRIORITY_OFF)
                    572:            return (*event->cbf) (s, event->param, type);
2.36      frystyk   573:        HTTRACE(THD_TRACE, "Dispatch.... Handler %p NOT called\n" _ sockp);
2.1       frystyk   574:        return HT_OK;
                    575:     }
2.36      frystyk   576:     HTTRACE(THD_TRACE, "Dispatch.... Bad socket %d\n" _ s);
2.1       frystyk   577:     return NO;
                    578: }
                    579: 
2.3       eric      580: PUBLIC HTEvent * HTEventList_lookup (SOCKET s, HTEventType type)
                    581: {
                    582:     SockEvents * sockp = NULL;
                    583:     if ((sockp = SockEvents_get(s, SockEvents_find)) == NULL)
                    584:        return NULL;
                    585:     return sockp->events[HTEvent_INDEX(type)];
                    586: }
                    587: 
2.34      frystyk   588: /* ------------------------------------------------------------------------- */
                    589: /*                             THE EVENT LOOP                               */
                    590: /* ------------------------------------------------------------------------- */
                    591: 
                    592: /*
                    593: **  Start eventloop
2.3       eric      594: */
2.34      frystyk   595: PUBLIC int HTEventList_newLoop (void)
2.3       eric      596: {
2.34      frystyk   597:     return HTEventList_loop (NULL);
2.3       eric      598: }
                    599: 
2.34      frystyk   600: /*
                    601: **  Stops the event loop. The function does not guarantee
                    602: **  that all requests have terminated. This is for the app to do
                    603: */
                    604: PUBLIC void HTEventList_stopLoop (void)
2.3       eric      605: {
2.34      frystyk   606:     HTEndLoop = 1;
2.3       eric      607: }
                    608: 
2.34      frystyk   609: /*
                    610: **  There are now two versions of the event loop. The first is if you want
                    611: **  to use async I/O on windows, and the other is if you want to use normal
                    612: **  Unix setup with sockets
2.3       eric      613: */
2.34      frystyk   614: PUBLIC int HTEventList_loop (HTRequest * theRequest)
2.3       eric      615: {
2.34      frystyk   616: #ifdef WWW_WIN_ASYNC
2.3       eric      617: 
                    618:     MSG msg;
2.25      frystyk   619:     int status;
2.30      frystyk   620:     while (!HTEndLoop && GetMessage(&msg,0,0,0)) {
2.3       eric      621:            TranslateMessage(&msg);
                    622:            DispatchMessage(&msg);
                    623:     }
2.25      frystyk   624: 
                    625:     status = HTEndLoop;
                    626:     
                    627:     /* Reset HTEndLoop in case we want to start again */
                    628:     HTEndLoop = 0;
                    629:     
                    630:     return (status == 1 ? HT_OK : HT_ERROR);
2.3       eric      631: 
                    632: #else /* WWW_WIN_ASYNC */
                    633: 
2.1       frystyk   634:     fd_set treadset, twriteset, texceptset;
                    635:     struct timeval waittime, * wt;
                    636:     int active_sockets;
                    637:     int maxfds;
2.5       eric      638:     ms_t timeout;
                    639:     ms_t now;
2.1       frystyk   640:     SOCKET s;
2.5       eric      641:     int status = HT_OK;
2.1       frystyk   642: 
2.41    ! frystyk   643:     /* Check that we don't have multiple loops started at once */
        !           644:     if (HTInLoop) {
        !           645:        HTTRACE(THD_TRACE, "Event Loop.. Already one loop running - exiting\n");
        !           646:        return HT_ERROR;
        !           647:     }
        !           648:     HTInLoop = YES;
        !           649: 
        !           650:     /* Set up list of events - is kept around until EventOrder_deleteAll */
        !           651:     if (!EventOrderList)
        !           652:        EventOrderList = HTList_new();
        !           653:     else
        !           654:        EventOrder_clearAll();
2.2       eric      655: 
2.1       frystyk   656:     /* Don't leave this loop until we leave the application */
2.27      frystyk   657:     while (!HTEndLoop) {
2.1       frystyk   658: 
                    659:         /*
                    660:        **  Timeval struct copy needed for linux, as it set the value to the
                    661:        **  remaining timeout while exiting the select. (and perhaps for
                    662:        **  other OS). Code borrowed from X server.
                    663:        */
                    664:        wt = NULL;
2.5       eric      665:        if ((status = HTTimer_next(&timeout)))
2.40      frystyk   666:            break;
2.5       eric      667:        if (timeout != 0) {
2.1       frystyk   668:            waittime.tv_sec = timeout / MILLI_PER_SECOND;
                    669:            waittime.tv_usec = (timeout % MILLI_PER_SECOND) *
                    670:                (1000000 / MILLI_PER_SECOND);
                    671:            wt = &waittime;
                    672:        }
                    673: 
2.38      frystyk   674:        /*
                    675:        **  Now we copy the current active file descriptors to pass them to select.
                    676:        */
                    677:         treadset = FdArray[HTEvent_INDEX(HTEvent_READ)];
                    678:         twriteset = FdArray[HTEvent_INDEX(HTEvent_WRITE)];
                    679:         texceptset = FdArray[HTEvent_INDEX(HTEvent_OOB)];
                    680: 
                    681:        /* And also get the max socket value */
2.18      frystyk   682:         maxfds = MaxSock; 
                    683: 
2.36      frystyk   684:        HTTRACE(THD_TRACE, "Event Loop.. calling select: maxfds is %d\n" _ maxfds);
2.37      frystyk   685: #ifdef HTDEBUG
                    686:        fd_dump(maxfds, &treadset, &twriteset, &texceptset, wt);
                    687: #endif
2.15      frystyk   688: 
2.1       frystyk   689: #ifdef __hpux 
                    690:         active_sockets = select(maxfds+1, (int *)&treadset, (int *)&twriteset,
                    691:                                (int *)&texceptset, wt);
                    692: #else
                    693:         active_sockets = select(maxfds+1, &treadset, &twriteset, &texceptset, wt);
                    694: #endif
2.2       eric      695: 
2.5       eric      696:        now = HTGetTimeInMillis();
2.18      frystyk   697: 
2.36      frystyk   698:        HTTRACE(THD_TRACE, "Event Loop.. select returns %d\n" _ active_sockets);
2.37      frystyk   699: #ifdef HTDEBUG
                    700:        fd_dump(maxfds, &treadset, &twriteset, &texceptset, wt);
                    701: #endif
2.1       frystyk   702: 
                    703:         if (active_sockets == -1) {
2.20      frystyk   704: #ifdef EINTR
                    705:            if (socerrno == EINTR) {
                    706:                /*
                    707:                ** EINTR     The select() function was interrupted  before  any
                    708:                **           of  the  selected  events  occurred and before the
                    709:                **           timeout interval expired.
                    710:                **
                    711:                **           If SA_RESTART has been set  for  the  interrupting
                    712:                **           signal,  it  is  implementation-dependent  whether
                    713:                **           select() restarts or returns with EINTR.
                    714:                */
2.36      frystyk   715:                HTTRACE(THD_TRACE, "Event Loop.. select was interruted - try again\n");
2.20      frystyk   716:                continue;
                    717:            }
                    718: #endif /* EINTR */
2.28      frystyk   719: #ifdef EBADF
                    720:            if (socerrno == EBADF) {
                    721:                /*
                    722:                ** EBADF     One or more of the file descriptor sets  specified
                    723:                **           a  file  descriptor  that is not a valid open file
                    724:                **           descriptor.
                    725:                */
2.36      frystyk   726:                HTTRACE(THD_TRACE, "Event Loop.. One or more sockets were not through their connect phase - try again\n");
2.28      frystyk   727:                continue;
                    728:            }
                    729: #endif
2.36      frystyk   730:            HTTRACE(THD_TRACE, "Event Loop.. select returned error %d\n" _ socerrno);
                    731: 
                    732: #ifdef HTDEBUG
2.3       eric      733:            EventList_dump();
2.36      frystyk   734: #endif /* HTDEBUG */
                    735: 
2.40      frystyk   736:            status = HT_ERROR;
                    737:            break;
2.1       frystyk   738:         }
                    739: 
                    740:        /*
                    741:        **  We had a timeout so now we check and see if we have a timeout
2.5       eric      742:        **  handler to call. Let HTTimer_next get it.
2.1       frystyk   743:        */ 
2.5       eric      744:        if (active_sockets == 0)
2.1       frystyk   745:            continue;
                    746: 
2.34      frystyk   747:        /* There were active sockets. Determine which fd sets they were in */
2.1       frystyk   748:        for (s = 0 ; s <= maxfds ; s++) { 
                    749:            if (FD_ISSET(s, &texceptset))
2.34      frystyk   750:                if ((status = EventOrder_add(s, HTEvent_OOB, now)) != HT_OK)
2.40      frystyk   751:                    goto stop_loop;
2.1       frystyk   752:            if (FD_ISSET(s, &twriteset))
2.34      frystyk   753:                if ((status = EventOrder_add(s, HTEvent_WRITE, now)) != HT_OK)
2.40      frystyk   754:                    goto stop_loop;
2.1       frystyk   755:            if (FD_ISSET(s, &treadset))
2.34      frystyk   756:                if ((status = EventOrder_add(s, HTEvent_READ, now)) != HT_OK)
2.40      frystyk   757:                    goto stop_loop;
2.1       frystyk   758:        }
2.40      frystyk   759:        if ((status = EventOrder_executeAndDelete()) != HT_OK) break;
2.27      frystyk   760:     };
2.25      frystyk   761: 
                    762:     /* Reset HTEndLoop in case we want to start again */
2.40      frystyk   763:  stop_loop:
2.25      frystyk   764:     HTEndLoop = 0;
2.41    ! frystyk   765:     HTInLoop = NO;
2.40      frystyk   766:     return status;
2.34      frystyk   767: #endif /* !WWW_WIN_ASYNC */
                    768: }
                    769: 
                    770: /* ------------------------------------------------------------------------- */
                    771: /*                  EVENT INITIALIZATION AND TERMINATION                    */
                    772: /* ------------------------------------------------------------------------- */
                    773: 
                    774: #ifdef WWW_WIN_ASYNC
                    775: 
                    776: /* Only responsible for WM_TIMER and WSA_AsyncSelect */        
                    777: PRIVATE LRESULT CALLBACK AsyncWindowProc(HWND hwnd, UINT uMsg, WPARAM wParam, LPARAM lParam)
                    778: {
                    779:     WORD event;
                    780:     SOCKET sock;
                    781:     HTEventType type;
                    782:     ms_t now = HTGetTimeInMillis();
                    783: 
                    784:     /* timeout stuff */
                    785:     if (uMsg == WM_TIMER) {
                    786:        HTTimer_dispatch((HTTimer *)wParam);
                    787:        return (0);
                    788:     }
                    789: 
                    790:     if (uMsg != HTwinMsg)      /* not our async message */
                    791:        return (DefWindowProc(hwnd, uMsg, wParam, lParam));
                    792: 
                    793:     event = LOWORD(lParam);
                    794:     sock = (SOCKET)wParam;
                    795:     switch (event) {
                    796:     case FD_READ: type = HTEvent_READ; break;
                    797:     case FD_WRITE: type = HTEvent_WRITE; break;
                    798:     case FD_ACCEPT: type = HTEvent_ACCEPT; break;
                    799:     case FD_CONNECT: type = HTEvent_CONNECT; break;
                    800:     case FD_OOB: type = HTEvent_OOB; break;
                    801:     case FD_CLOSE: type = HTEvent_CLOSE; break;
2.36      frystyk   802:     default: HTDEBUGBREAK("Unknown event %d\n" _ event);
2.34      frystyk   803:     }
                    804:     if (HTEventList_dispatch((int)sock, type, now) != HT_OK)
                    805:        HTEndLoop = -1;
                    806:     return (0);
                    807: }
2.1       frystyk   808: 
2.34      frystyk   809: /*     HTEventList_get/setWinHandle
                    810: **     --------------------------
                    811: **     Managing the windows handle on Windows
                    812: */
                    813: PUBLIC BOOL HTEventList_setWinHandle (HWND window, unsigned long message)
                    814: {
                    815:     HTSocketWin = window;
                    816:     HTwinMsg = message;
                    817:     return YES;
2.1       frystyk   818: }
                    819: 
2.34      frystyk   820: PUBLIC HWND HTEventList_getWinHandle (unsigned long * pMessage)
                    821: {
                    822:     if (pMessage)
                    823:         *pMessage = HTwinMsg;
                    824:     return (HTSocketWin);
                    825: }
                    826: #endif /* WWW_WIN_ASYNC */
2.12      eric      827: 
2.34      frystyk   828: PUBLIC BOOL HTEventInit (void)
2.12      eric      829: {
2.34      frystyk   830: #ifdef WWW_WIN_ASYNC
                    831:     /*
                    832:     ** We are here starting a hidden window to take care of events from
                    833:     **  the async select() call in the async version of the event loop in
                    834:     ** the Internal event manager (HTEvtLst.c)
                    835:     */
                    836:     static char className[] = "AsyncWindowClass";
                    837:     WNDCLASS wc;
                    838:     OSVERSIONINFO osInfo;
                    839:     
                    840:     wc.style=0;
                    841:     wc.lpfnWndProc=(WNDPROC)AsyncWindowProc;
                    842:     wc.cbClsExtra=0;
                    843:     wc.cbWndExtra=0;
                    844:     wc.hIcon=0;
                    845:     wc.hCursor=0;
                    846:     wc.hbrBackground=0;
                    847:     wc.lpszMenuName=(LPSTR)0;
                    848:     wc.lpszClassName=className;
                    849: 
                    850:     osInfo.dwOSVersionInfoSize = sizeof(osInfo);
                    851:     GetVersionEx(&osInfo);
2.39      frystyk   852: 
                    853:     /* According to Gary Johnson, GetModuleHandle() works for NT as well */
                    854: #if 0
2.34      frystyk   855:     if (osInfo.dwPlatformId == VER_PLATFORM_WIN32s || osInfo.dwPlatformId == VER_PLATFORM_WIN32_WINDOWS)
                    856:        wc.hInstance=GetModuleHandle(NULL); /* 95 and non threaded platforms */
                    857:     else
2.39      frystyk   858:         wc.hInstance=GetCurrentProcess(); /* NT and hopefully everything following */
                    859: #else
                    860:     wc.hInstance=GetModuleHandle(NULL); /* Should work on all win32 stuff */
                    861: #endif
                    862: 
2.34      frystyk   863:     HTinstance = wc.hInstance;
                    864:     HTclass = RegisterClass(&wc);
                    865:     if (!HTclass) {
2.36      frystyk   866:        HTTRACE(THD_TRACE, "HTLibInit.. Can't RegisterClass \"%s\"\n" _ className);
                    867:        return NO;
2.34      frystyk   868:     }
                    869:     if (!(HTSocketWin = CreateWindow(className, "WWW_WIN_ASYNC", WS_POPUP, CW_USEDEFAULT, CW_USEDEFAULT, 
                    870:                                      CW_USEDEFAULT, CW_USEDEFAULT, 0, 0, wc.hInstance,0))) {
2.36      frystyk   871: #ifdef HTDEBUG
2.34      frystyk   872:        char space[50];
2.36      frystyk   873:                HTTRACE(THD_TRACE, "HTLibInit.. Can't Create Window \"WWW_WIN_ASYNC\" - error:");
2.34      frystyk   874:        sprintf(space, "%ld\n", GetLastError());
2.36      frystyk   875:        HTTRACE(THD_TRACE, space);
                    876: #endif /* HTDEBUG */
2.34      frystyk   877:        return NO;
                    878:     }
                    879:     HTwinMsg = WM_USER;  /* use first available message since app uses none */
                    880: 
                    881:     /*  Register platform specific timer handlers for windows */
                    882:     HTTimer_registerSetTimerCallback(Timer_setWindowsTimer);
                    883:     HTTimer_registerDeleteTimerCallback(Timer_deleteWindowsTimer);
                    884: 
                    885: #endif /* WWW_WIN_ASYNC */
                    886: 
                    887: #ifdef _WINSOCKAPI_
                    888:     /*
                    889:     ** Initialise WinSock DLL. This must also be shut down! PMH
                    890:     */
                    891:     {
                    892:         WSADATA            wsadata;
                    893:        if (WSAStartup(DESIRED_WINSOCK_VERSION, &wsadata)) {
2.36      frystyk   894:            HTTRACE(THD_TRACE, "HTEventInit. Can't initialize WinSoc\n");
2.34      frystyk   895:             WSACleanup();
                    896:             return NO;
                    897:         }
                    898:         if (wsadata.wVersion < MINIMUM_WINSOCK_VERSION) {
2.36      frystyk   899:             HTTRACE(THD_TRACE, "HTEventInit. Bad version of WinSoc\n");
2.34      frystyk   900:             WSACleanup();
                    901:             return NO;
                    902:         }
2.36      frystyk   903:        HTTRACE(APP_TRACE, "HTEventInit. Using WinSoc version \"%s\".\n" _ 
2.34      frystyk   904:                    wsadata.szDescription);
2.12      eric      905:     }
2.34      frystyk   906: #endif /* _WINSOCKAPI_ */
                    907: 
                    908:     HTEvent_setRegisterCallback(HTEventList_register);
                    909:     HTEvent_setUnregisterCallback(HTEventList_unregister);
                    910:     return YES;
2.12      eric      911: }
                    912: 
2.34      frystyk   913: PUBLIC BOOL HTEventTerminate (void)
                    914: {
                    915: #ifdef _WINSOCKAPI_
                    916:     WSACleanup();
                    917: #endif /* _WINSOCKAPI_ */
                    918: 
                    919: #ifdef WWW_WIN_ASYNC
                    920:     DestroyWindow(HTSocketWin);
                    921:     UnregisterClass((LPCTSTR)HTclass, HTinstance);
                    922: #endif /* WWW_WIN_ASYNC */
                    923: 
                    924:     return YES;
                    925: }

Webmaster