Annotation of libwww/Library/src/HTHost.c, revision 2.57
2.1 frystyk 1: /* HTHost.c
2: ** REMOTE HOST INFORMATION
3: **
4: ** (c) COPYRIGHT MIT 1995.
5: ** Please first read the full copyright statement in the file COPYRIGH.
2.57 ! frystyk 6: ** @(#) $Id: HTHost.c,v 2.56 1999/01/22 14:01:24 frystyk Exp $
2.1 frystyk 7: **
8: ** This object manages the information that we know about a remote host.
9: ** This can for example be what type of host it is, and what version
10: ** it is using. We also keep track of persistent connections
11: **
12: ** April 96 HFN Written
13: */
14:
15: /* Library include files */
2.44 frystyk 16: #include "wwwsys.h"
2.1 frystyk 17: #include "WWWUtil.h"
18: #include "HTParse.h"
19: #include "HTAlert.h"
20: #include "HTError.h"
21: #include "HTNetMan.h"
22: #include "HTTrans.h"
2.13 frystyk 23: #include "HTTPUtil.h"
24: #include "HTTCP.h"
2.1 frystyk 25: #include "HTHost.h" /* Implemented here */
2.13 frystyk 26: #include "HTHstMan.h"
2.1 frystyk 27:
2.48 frystyk 28: #define HOST_OBJECT_TTL 43200L /* Default host timeout is 12 h */
2.29 frystyk 29:
2.48 frystyk 30: #define TCP_IDLE_PASSIVE 120L /* Passive TTL in s on an idle connection */
31: #define TCP_IDLE_ACTIVE 60000L /* Active TTL in ms on an idle connection */
2.29 frystyk 32:
2.45 frystyk 33: #define MAX_PIPES 50 /* maximum number of pipelined requests */
2.50 frystyk 34: #define MAX_HOST_RECOVER 1 /* Max number of auto recovery */
2.32 frystyk 35: #define DEFAULT_DELAY 30 /* Default write flush delay in ms */
2.1 frystyk 36:
2.13 frystyk 37: struct _HTInputStream {
38: const HTInputStreamClass * isa;
2.1 frystyk 39: };
40:
2.13 frystyk 41: PRIVATE int HostEvent(SOCKET soc, void * pVoid, HTEventType type);
42:
43: /* Type definitions and global variables etc. local to this module */
2.48 frystyk 44: PRIVATE time_t HostTimeout = HOST_OBJECT_TTL; /* Timeout for host objects */
2.53 frystyk 45: PRIVATE time_t HTPassiveTimeout = TCP_IDLE_PASSIVE; /* Passive timeout in s */
46: PRIVATE ms_t HTActiveTimeout = TCP_IDLE_ACTIVE; /* Active timeout in ms */
2.1 frystyk 47:
2.8 frystyk 48: PRIVATE HTList ** HostTable = NULL;
49: PRIVATE HTList * PendHost = NULL; /* List of pending host elements */
2.1 frystyk 50:
2.40 kahan 51: /* JK: New functions for interruption the automatic pending request
52: activation */
53: PRIVATE HTHost_ActivateRequestCallback * ActivateReqCBF = NULL;
54: PRIVATE int HTHost_ActivateRequest (HTNet *net);
55: PRIVATE BOOL DoPendingReqLaunch = YES; /* controls automatic activation
56: of pending requests */
57:
2.13 frystyk 58: PRIVATE int EventTimeout = -1; /* Global Host event timeout */
59:
2.36 frystyk 60: PRIVATE ms_t WriteDelay = DEFAULT_DELAY; /* Delay in ms */
2.26 frystyk 61:
2.45 frystyk 62: PRIVATE int MaxPipelinedRequests = MAX_PIPES;
63:
2.1 frystyk 64: /* ------------------------------------------------------------------------- */
65:
66: PRIVATE void free_object (HTHost * me)
67: {
68: if (me) {
2.30 frystyk 69: int i;
2.1 frystyk 70: HT_FREE(me->hostname);
71: HT_FREE(me->type);
2.12 frystyk 72: HT_FREE(me->server);
73: HT_FREE(me->user_agent);
74: HT_FREE(me->range_units);
2.30 frystyk 75:
76: /* Delete the channel (if any) */
2.3 eric 77: if (me->channel) {
2.5 eric 78: HTChannel_delete(me->channel, HT_OK);
2.3 eric 79: me->channel = NULL;
80: }
2.30 frystyk 81:
82: /* Unregister the events */
2.18 eric 83: for (i = 0; i < HTEvent_TYPES; i++)
84: HTEvent_delete(me->events[i]);
2.30 frystyk 85:
86: /* Delete the timer (if any) */
87: if (me->timer) HTTimer_delete(me->timer);
88:
89: /* Delete the queues */
2.8 frystyk 90: HTList_delete(me->pipeline);
91: HTList_delete(me->pending);
2.1 frystyk 92: HT_FREE(me);
93: }
94: }
95:
96: PRIVATE BOOL delete_object (HTList * list, HTHost * me)
97: {
2.2 frystyk 98: if (CORE_TRACE) HTTrace("Host info... object %p from list %p\n", me, list);
2.1 frystyk 99: HTList_removeObject(list, (void *) me);
100: free_object(me);
101: return YES;
102: }
103:
2.13 frystyk 104: PRIVATE BOOL isLastInPipe (HTHost * host, HTNet * net)
105: {
106: return HTList_lastObject(host->pipeline) == net;
107: }
108:
2.51 frystyk 109: PRIVATE BOOL killPipeline (HTHost * host, HTEventType type)
2.48 frystyk 110: {
111: if (host) {
112: int piped = HTList_count(host->pipeline);
113: int pending = HTList_count(host->pending);
114: int cnt;
115:
2.51 frystyk 116: if (CORE_TRACE)
117: HTTrace("Host kill... Pipeline due to %s event\n", HTEvent_type2str(type));
118:
2.48 frystyk 119: /* Terminate all net objects in pending queue */
120: for (cnt=0; cnt<pending; cnt++) {
121: HTNet * net = HTList_removeLastObject(host->pending);
2.56 frystyk 122: if (net) {
123: if (CORE_TRACE)
124: HTTrace("Host kill... Terminating net object %p from pending queue\n", net);
125: net->registeredFor = 0;
126: (*net->event.cbf)(HTChannel_socket(host->channel), net->event.param, type);
127: }
2.48 frystyk 128: }
129:
130: /* Terminate all net objects in pipeline */
131: if (piped >= 1) {
132:
133: /*
134: ** Terminte all net objects in the pipeline
135: */
136: for (cnt=0; cnt<piped; cnt++) {
137: HTNet * net = HTList_firstObject(host->pipeline);
2.56 frystyk 138: if (net) {
139: if (CORE_TRACE)
140: HTTrace("Host kill... Terminating net object %p from pipe line\n", net);
141: net->registeredFor = 0;
142: (*net->event.cbf)(HTChannel_socket(host->channel), net->event.param, type);
143: }
2.48 frystyk 144: }
145: }
146: return YES;
147: }
148: return NO;
149: }
150:
151: /*
2.51 frystyk 152: ** Silently close an idle persistent connection after
2.53 frystyk 153: ** HTActiveTimeout secs
2.51 frystyk 154: */
155: PRIVATE int IdleTimeoutEvent (HTTimer * timer, void * param, HTEventType type)
156: {
157: HTHost * host = (HTHost *) param;
158: SOCKET sockfd = HTChannel_socket(host->channel);
159: int result = HostEvent (sockfd, host, HTEvent_CLOSE);
160: HTTimer_delete(timer);
161: host->timer = NULL;
162: return result;
163: }
164:
165: /*
2.13 frystyk 166: ** HostEvent - host event manager - recieves events from the event
167: ** manager and dispatches them to the client net objects by calling the
168: ** net object's cbf.
169: **
170: */
171: PRIVATE int HostEvent (SOCKET soc, void * pVoid, HTEventType type)
172: {
173: HTHost * host = (HTHost *)pVoid;
174:
2.18 eric 175: if (type == HTEvent_READ || type == HTEvent_CLOSE) {
2.13 frystyk 176: HTNet * targetNet;
177:
178: /* call the first net object */
179: do {
180: int ret;
2.49 frystyk 181:
182: /* netscape and apache servers can do a lazy close well after usage
183: * of previous socket has been dispensed by the library,
184: * the section below makes sure the event does not get miss attributed
185: */
186: if (HTChannel_socket(host->channel) != soc) {
187: if (CORE_TRACE)
188: HTTrace("Host Event.. wild socket %d type = %s real socket is %d\n", soc,
189: type == HTEvent_CLOSE ? "Event_Close" : "Event_Read",
190: HTChannel_socket(host->channel));
191: return HT_OK;
192: }
193:
2.13 frystyk 194: targetNet = (HTNet *)HTList_firstObject(host->pipeline);
195: if (targetNet) {
196: if (CORE_TRACE)
2.28 frystyk 197: HTTrace("Host Event.. READ passed to `%s\'\n",
198: HTAnchor_physical(HTRequest_anchor(HTNet_request(targetNet))));
2.13 frystyk 199: if ((ret = (*targetNet->event.cbf)(HTChannel_socket(host->channel),
200: targetNet->event.param, type)) != HT_OK)
201: return ret;
202: }
203: if (targetNet == NULL && host->remainingRead > 0) {
2.31 frystyk 204: if (CORE_TRACE)
205: HTTrace("HostEvent... Error: %d bytes left to read and nowhere to put them\n",
206: host->remainingRead);
2.13 frystyk 207: host->remainingRead = 0;
208: /*
209: ** Fall through to close the channel
210: */
211: }
212: /* call pipelined net object to eat all the data in the channel */
213: } while (host->remainingRead > 0);
214:
215: /* last target net should have set remainingRead to 0 */
216: if (targetNet)
217: return HT_OK;
218:
219: /* If there was notargetNet, it should be a close */
2.28 frystyk 220: if (CORE_TRACE)
221: HTTrace("Host Event.. host %p `%s\' closed connection.\n",
222: host, host->hostname);
2.13 frystyk 223:
224: /* Is there garbage in the channel? Let's check: */
225: {
226: char buf[256];
227: int ret;
2.28 frystyk 228: memset(buf, '\0', sizeof(buf));
2.48 frystyk 229: while ((ret = NETREAD(HTChannel_socket(host->channel), buf, sizeof(buf)-1)) > 0) {
2.28 frystyk 230: if (CORE_TRACE)
231: HTTrace("Host Event.. Host %p `%s\' had %d extraneous bytes: `%s\'\n",
232: host, host->hostname, ret, buf);
233: memset(buf, '\0', sizeof(buf));
234: }
2.13 frystyk 235: }
236: HTHost_clearChannel(host, HT_OK);
2.28 frystyk 237: return HT_OK; /* extra garbage does not constitute an application error */
2.13 frystyk 238:
2.18 eric 239: } else if (type == HTEvent_WRITE || type == HTEvent_CONNECT) {
2.13 frystyk 240: HTNet * targetNet = (HTNet *)HTList_lastObject(host->pipeline);
241: if (targetNet) {
242: if (CORE_TRACE)
2.28 frystyk 243: HTTrace("Host Event.. WRITE passed to `%s\'\n",
244: HTAnchor_physical(HTRequest_anchor(HTNet_request(targetNet))));
2.13 frystyk 245: return (*targetNet->event.cbf)(HTChannel_socket(host->channel), targetNet->event.param, type);
246: }
2.56 frystyk 247: if (CORE_TRACE)
248: HTTrace("Host Event Host %p (`%s\') dispatched with event %s but doesn't have a target - %d requests made, %d requests in pipe, %d pending\n",
249: host,
250: host ? host->hostname : "<null>",
251: HTEvent_type2str(type),
252: host ? host->reqsMade : -1,
253: HTList_count(host->pipeline),
254: HTList_count(host->pending));
2.55 frystyk 255: #if 0
256: HTDebugBreak(__FILE__, __LINE__, "Host Event.. Host %p (`%s\') dispatched with event %d\n",
257: host, host ? host->hostname : "<null>", type);
2.13 frystyk 258: return HT_ERROR;
2.55 frystyk 259: #else
260: return HT_OK;
261: #endif
2.14 frystyk 262: } else if (type == HTEvent_TIMEOUT) {
2.51 frystyk 263: killPipeline(host, HTEvent_TIMEOUT);
2.14 frystyk 264: } else {
2.44 frystyk 265: HTTrace("Don't know how to handle OOB data from `%s\'?\n",
266: host->hostname);
2.14 frystyk 267: }
2.13 frystyk 268: return HT_OK;
269: }
270:
2.1 frystyk 271: /*
272: ** Search the host info cache for a host object or create a new one
273: ** and add it. Examples of host names are
274: **
275: ** www.w3.org
276: ** www.foo.com:8000
277: ** 18.52.0.18
278: **
279: ** Returns Host object or NULL if error. You may get back an already
280: ** existing host object - you're not guaranteed a new one each time.
281: */
2.15 eric 282: PUBLIC HTHost * HTHost_new (char * host, u_short u_port)
2.1 frystyk 283: {
284: HTList * list = NULL; /* Current list in cache */
285: HTHost * pres = NULL;
2.13 frystyk 286: int hash = 0;
2.1 frystyk 287: if (!host) {
2.2 frystyk 288: if (CORE_TRACE) HTTrace("Host info... Bad argument\n");
2.1 frystyk 289: return NULL;
290: }
291:
292: /* Find a hash for this host */
293: {
294: char *ptr;
295: for (ptr=host; *ptr; ptr++)
2.13 frystyk 296: hash = (int) ((hash * 3 + (*(unsigned char *) ptr)) % HOST_HASH_SIZE);
2.1 frystyk 297: if (!HostTable) {
2.13 frystyk 298: if ((HostTable = (HTList **) HT_CALLOC(HOST_HASH_SIZE,
2.1 frystyk 299: sizeof(HTList *))) == NULL)
300: HT_OUTOFMEM("HTHost_find");
301: }
302: if (!HostTable[hash]) HostTable[hash] = HTList_new();
303: list = HostTable[hash];
304: }
305:
306: /* Search the cache */
307: {
308: HTList * cur = list;
309: while ((pres = (HTHost *) HTList_nextObject(cur))) {
2.15 eric 310: if (!strcmp(pres->hostname, host) && u_port == pres->u_port) {
2.8 frystyk 311: if (HTHost_isIdle(pres) && time(NULL)>pres->ntime+HostTimeout){
2.2 frystyk 312: if (CORE_TRACE)
2.1 frystyk 313: HTTrace("Host info... Collecting host info %p\n",pres);
314: delete_object(list, pres);
315: pres = NULL;
316: }
317: break;
318: }
319: }
320: }
321:
2.8 frystyk 322: /* If not found then create new Host object, else use existing one */
2.1 frystyk 323: if (pres) {
324: if (pres->channel) {
2.32 frystyk 325:
326: /*
327: ** If we have a TTL for this TCP connection then
328: ** check that we haven't passed it.
329: */
330: if (pres->expires > 0) {
331: time_t t = time(NULL);
2.51 frystyk 332: if (HTHost_isIdle(pres) && pres->expires < t) {
2.32 frystyk 333: if (CORE_TRACE)
334: HTTrace("Host info... Persistent channel %p gotten cold\n",
335: pres->channel);
2.48 frystyk 336: HTHost_clearChannel(pres, HT_OK);
2.32 frystyk 337: } else {
2.53 frystyk 338: pres->expires = t + HTPassiveTimeout;
2.32 frystyk 339: if (CORE_TRACE)
340: HTTrace("Host info... REUSING CHANNEL %p\n",pres->channel);
341: }
342: }
2.55 frystyk 343: } else {
344: if (CORE_TRACE)
345: HTTrace("Host info... Found Host %p with no active channel\n", pres);
2.1 frystyk 346: }
347: } else {
348: if ((pres = (HTHost *) HT_CALLOC(1, sizeof(HTHost))) == NULL)
349: HT_OUTOFMEM("HTHost_add");
2.13 frystyk 350: pres->hash = hash;
2.1 frystyk 351: StrAllocCopy(pres->hostname, host);
2.15 eric 352: pres->u_port = u_port;
2.1 frystyk 353: pres->ntime = time(NULL);
2.8 frystyk 354: pres->mode = HT_TP_SINGLE;
2.26 frystyk 355: pres->delay = WriteDelay;
2.18 eric 356: {
2.26 frystyk 357: int i;
358: for (i = 0; i < HTEvent_TYPES; i++)
359: pres->events[i]= HTEvent_new(HostEvent, pres, HT_PRIORITY_MAX, EventTimeout);
2.18 eric 360: }
2.2 frystyk 361: if (CORE_TRACE)
2.24 frystyk 362: HTTrace("Host info... added `%s\' with host %p to list %p\n",
363: host, pres, list);
2.1 frystyk 364: HTList_addObject(list, (void *) pres);
365: }
366: return pres;
2.9 frystyk 367: }
368:
2.15 eric 369: PUBLIC HTHost * HTHost_newWParse (HTRequest * request, char * url, u_short u_port)
2.13 frystyk 370: {
2.32 frystyk 371: char * port;
372: char * fullhost = NULL;
373: char * parsedHost = NULL;
374: SockA * sin;
375: HTHost * me;
376: char * proxy = HTRequest_proxy(request);
2.13 frystyk 377:
2.32 frystyk 378: fullhost = HTParse(proxy ? proxy : url, "", PARSE_HOST);
2.13 frystyk 379:
380: /* If there's an @ then use the stuff after it as a hostname */
2.32 frystyk 381: if (fullhost) {
382: char * at_sign;
383: if ((at_sign = strchr(fullhost, '@')) != NULL)
384: parsedHost = at_sign+1;
385: else
386: parsedHost = fullhost;
387: }
388: if (!parsedHost || !*parsedHost) {
389: HTRequest_addError(request, ERR_FATAL, NO, HTERR_NO_HOST,
2.52 frystyk 390: NULL, 0, "HTHost_newWParse");
2.32 frystyk 391: HT_FREE(fullhost);
392: return NULL;
393: }
2.55 frystyk 394:
395: /* See if the default port should be overridden */
396: if ((port = strchr(parsedHost, ':')) != NULL) {
2.32 frystyk 397: *port++ = '\0';
2.55 frystyk 398: if (*port && isdigit((int) *port)) u_port = (u_short) atol(port);
2.32 frystyk 399: }
2.55 frystyk 400: if (PROT_TRACE)
401: HTTrace("HTHost parse Looking up `%s\' on port %u\n", parsedHost, u_port);
402:
2.32 frystyk 403: /* Find information about this host */
404: if ((me = HTHost_new(parsedHost, u_port)) == NULL) {
2.52 frystyk 405: if (PROT_TRACE)HTTrace("HTHost parse Can't get host info\n");
2.32 frystyk 406: me->tcpstate = TCP_ERROR;
407: return NULL;
408: }
409: sin = &me->sock_addr;
410: memset((void *) sin, '\0', sizeof(SockA));
2.13 frystyk 411: #ifdef DECNET
2.32 frystyk 412: sin->sdn_family = AF_DECnet;
413: net->sock_addr.sdn_objnum = port ? (unsigned char)(strtol(port, (char **) 0, 10)) : DNP_OBJ;
2.13 frystyk 414: #else /* Internet */
2.32 frystyk 415: sin->sin_family = AF_INET;
416: sin->sin_port = htons(u_port);
2.13 frystyk 417: #endif
2.32 frystyk 418: HT_FREE(fullhost); /* parsedHost points into fullhost */
419: return me;
2.13 frystyk 420: }
421:
2.9 frystyk 422: /*
423: ** Search the host info cache for a host object. Examples of host names:
424: **
425: ** www.w3.org
426: ** www.foo.com:8000
427: ** 18.52.0.18
428: **
429: ** Returns Host object or NULL if not found.
430: */
431: PUBLIC HTHost * HTHost_find (char * host)
432: {
433: HTList * list = NULL; /* Current list in cache */
434: HTHost * pres = NULL;
435: if (CORE_TRACE)
436: HTTrace("Host info... Looking for `%s\'\n", host ? host : "<null>");
437:
438: /* Find a hash for this host */
439: if (host && HostTable) {
440: int hash = 0;
441: char *ptr;
442: for (ptr=host; *ptr; ptr++)
2.13 frystyk 443: hash = (int) ((hash * 3 + (*(unsigned char *) ptr)) % HOST_HASH_SIZE);
2.9 frystyk 444: if (!HostTable[hash]) return NULL;
445: list = HostTable[hash];
446:
447: /* Search the cache */
448: {
449: HTList * cur = list;
450: while ((pres = (HTHost *) HTList_nextObject(cur))) {
451: if (!strcmp(pres->hostname, host)) {
452: if (time(NULL) > pres->ntime + HostTimeout) {
453: if (CORE_TRACE)
454: HTTrace("Host info... Collecting host %p\n", pres);
455: delete_object(list, pres);
456: pres = NULL;
457: } else {
458: if (CORE_TRACE)
459: HTTrace("Host info... Found `%s\'\n", host);
460: }
461: return pres;
462: }
463: }
464: }
465: }
466: return NULL;
2.1 frystyk 467: }
468:
469: /*
2.8 frystyk 470: ** Get and set the hostname of the remote host
471: */
472: PUBLIC char * HTHost_name (HTHost * host)
473: {
474: return host ? host->hostname : NULL;
475: }
476:
477: /*
2.1 frystyk 478: ** Get and set the type class of the remote host
479: */
480: PUBLIC char * HTHost_class (HTHost * host)
481: {
482: return host ? host->type : NULL;
483: }
484:
485: PUBLIC void HTHost_setClass (HTHost * host, char * s_class)
486: {
487: if (host && s_class) StrAllocCopy(host->type, s_class);
488: }
489:
490: /*
491: ** Get and set the version of the remote host
492: */
493: PUBLIC int HTHost_version (HTHost *host)
494: {
495: return host ? host->version : 0;
496: }
497:
498: PUBLIC void HTHost_setVersion (HTHost * host, int version)
499: {
500: if (host) host->version = version;
501: }
502:
503: /*
2.53 frystyk 504: ** Get and set the passive timeout for persistent entries.
2.1 frystyk 505: */
2.53 frystyk 506: PUBLIC BOOL HTHost_setPersistTimeout (time_t timeout)
2.1 frystyk 507: {
2.53 frystyk 508: if (timeout > 0) {
509: HTPassiveTimeout = timeout;
510: return YES;
511: }
512: return NO;
513: }
514:
515: PUBLIC time_t HTHost_persistTimeout (void)
516: {
517: return HTPassiveTimeout;
518: }
519:
520: /*
521: ** Get and set the active timeout for persistent entries.
522: */
523: PUBLIC BOOL HTHost_setActiveTimeout (ms_t timeout)
524: {
525: if (timeout > 1000) {
526: HTActiveTimeout = timeout;
527: return YES;
528: }
529: return NO;
2.1 frystyk 530: }
531:
2.53 frystyk 532: PUBLIC ms_t HTHost_activeTimeout (void)
2.1 frystyk 533: {
2.53 frystyk 534: return HTActiveTimeout;
2.1 frystyk 535: }
536:
537: /* Persistent Connection Expiration
538: ** --------------------------------
539: ** Should normally not be used. If, then use calendar time.
540: */
541: PUBLIC void HTHost_setPersistExpires (HTHost * host, time_t expires)
542: {
543: if (host) host->expires = expires;
544: }
545:
546: PUBLIC time_t HTHost_persistExpires (HTHost * host)
547: {
548: return host ? host->expires : -1;
549: }
550:
2.22 eric 551: PUBLIC void HTHost_setReqsPerConnection (HTHost * host, int reqs)
552: {
553: if (host) host->reqsPerConnection = reqs;
554: }
555:
556: PUBLIC int HTHost_reqsPerConnection (HTHost * host)
557: {
558: return host ? host->reqsPerConnection : -1;
559: }
560:
561: PUBLIC void HTHost_setReqsMade (HTHost * host, int reqs)
562: {
563: if (host) host->reqsMade = reqs;
564: }
565:
566: PUBLIC int HTHost_reqsMade (HTHost * host)
567: {
568: return host ? host->reqsMade : -1;
569: }
570:
2.1 frystyk 571: /*
2.6 frystyk 572: ** Public methods for this host
573: */
574: PUBLIC HTMethod HTHost_publicMethods (HTHost * me)
575: {
576: return me ? me->methods : METHOD_INVALID;
577: }
578:
579: PUBLIC void HTHost_setPublicMethods (HTHost * me, HTMethod methodset)
580: {
581: if (me) me->methods = methodset;
582: }
583:
584: PUBLIC void HTHost_appendPublicMethods (HTHost * me, HTMethod methodset)
585: {
586: if (me) me->methods |= methodset;
587: }
588:
589: /*
590: ** Get and set the server name of the remote host
591: */
592: PUBLIC char * HTHost_server (HTHost * host)
593: {
594: return host ? host->server : NULL;
595: }
596:
597: PUBLIC BOOL HTHost_setServer (HTHost * host, const char * server)
598: {
599: if (host && server) {
600: StrAllocCopy(host->server, server);
601: return YES;
602: }
603: return NO;
604: }
605:
606: /*
607: ** Get and set the userAgent name of the remote host
608: */
609: PUBLIC char * HTHost_userAgent (HTHost * host)
610: {
611: return host ? host->user_agent : NULL;
612: }
613:
614: PUBLIC BOOL HTHost_setUserAgent (HTHost * host, const char * userAgent)
615: {
616: if (host && userAgent) {
617: StrAllocCopy(host->user_agent, userAgent);
618: return YES;
2.12 frystyk 619: }
620: return NO;
621: }
622:
623: /*
624: ** Get and set acceptable range units
625: */
626: PUBLIC char * HTHost_rangeUnits (HTHost * host)
627: {
628: return host ? host->range_units : NULL;
629: }
630:
631: PUBLIC BOOL HTHost_setRangeUnits (HTHost * host, const char * units)
632: {
633: if (host && units) {
634: StrAllocCopy(host->range_units, units);
635: return YES;
636: }
637: return NO;
638: }
639:
640: /*
641: ** Checks whether a specific range unit is OK. We always say
642: ** YES except if we have a specific statement from the server that
643: ** it doesn't understand byte ranges - that is - it has sent "none"
644: ** in a "Accept-Range" response header
645: */
646: PUBLIC BOOL HTHost_isRangeUnitAcceptable (HTHost * host, const char * unit)
647: {
648: if (host && unit) {
649: #if 0
650: if (host->range_units) {
651: char * start = strcasestr(host->range_units, "none");
652:
653: /*
654: ** Check that "none" is infact a token. It could be part of some
655: ** other valid string, so we'd better check for it.
656: */
657: if (start) {
658:
659:
660: }
661: return NO;
662: }
663: #endif
664: return strcasecomp(unit, "bytes") ? NO : YES;
2.6 frystyk 665: }
666: return NO;
667: }
668:
2.1 frystyk 669: /*
670: ** As soon as we know that this host accepts persistent connections,
671: ** we associated the channel with the host.
672: ** We don't want more than MaxSockets-2 connections to be persistent in
673: ** order to avoid deadlock.
674: */
2.13 frystyk 675: PUBLIC BOOL HTHost_setPersistent (HTHost * host,
676: BOOL persistent,
677: HTTransportMode mode)
2.1 frystyk 678: {
2.13 frystyk 679: if (!host) return NO;
680:
681: if (!persistent) {
682: /*
683: ** We use the HT_IGNORE status code as we don't want to free
684: ** the stream at this point in time. The situation we want to
685: ** avoid is that we free the channel from within the stream pipe.
686: ** This will lead to an infinite look having the stream freing
687: ** itself.
688: */
2.30 frystyk 689: host->persistent = NO;
2.13 frystyk 690: return HTHost_clearChannel(host, HT_IGNORE);
691: }
692:
2.18 eric 693: /*
694: ** Set the host persistent if not already. Also update the mode to
695: ** the new one - it may have changed
696: */
697: HTHost_setMode(host, mode);
698: if (!host->persistent) {
2.13 frystyk 699: SOCKET sockfd = HTChannel_socket(host->channel);
2.8 frystyk 700: if (sockfd != INVSOC && HTNet_availablePersistentSockets() > 0) {
2.13 frystyk 701: host->persistent = YES;
2.53 frystyk 702: host->expires = time(NULL) + HTPassiveTimeout; /* Default timeout */
2.13 frystyk 703: HTChannel_setHost(host->channel, host);
2.8 frystyk 704: HTNet_increasePersistentSocket();
2.2 frystyk 705: if (CORE_TRACE)
2.1 frystyk 706: HTTrace("Host info... added host %p as persistent\n", host);
707: return YES;
708: } else {
2.2 frystyk 709: if (CORE_TRACE)
710: HTTrace("Host info... no room for persistent socket %d\n",
2.7 frystyk 711: sockfd);
2.18 eric 712: return NO;
2.1 frystyk 713: }
2.18 eric 714: } else {
715: if (CORE_TRACE) HTTrace("Host info... %p already persistent\n", host);
716: return YES;
2.1 frystyk 717: }
718: return NO;
719: }
720:
721: /*
2.13 frystyk 722: ** Check whether we have a persistent channel or not
723: */
724: PUBLIC BOOL HTHost_isPersistent (HTHost * host)
725: {
726: return host && host->persistent;
727: }
728:
729: /*
2.1 frystyk 730: ** Find persistent channel associated with this host.
731: */
732: PUBLIC HTChannel * HTHost_channel (HTHost * host)
733: {
734: return host ? host->channel : NULL;
735: }
736:
2.30 frystyk 737:
2.1 frystyk 738: /*
2.30 frystyk 739: ** Check whether we have got a "close" notification, for example in the
740: ** connection header
741: */
742: PUBLIC BOOL HTHost_setCloseNotification (HTHost * host, BOOL mode)
743: {
744: if (host) {
745: host->close_notification = mode;
2.37 frystyk 746: return YES;
2.30 frystyk 747: }
748: return NO;
749: }
750:
751: PUBLIC BOOL HTHost_closeNotification (HTHost * host)
752: {
753: return host && host->close_notification;
754: }
755:
756: /*
2.1 frystyk 757: ** Clear the persistent entry by deleting the channel object. Note that
758: ** the channel object is only deleted if it's not used anymore.
759: */
2.8 frystyk 760: PUBLIC BOOL HTHost_clearChannel (HTHost * host, int status)
2.1 frystyk 761: {
762: if (host && host->channel) {
2.8 frystyk 763: HTChannel_setHost(host->channel, NULL);
2.10 frystyk 764:
2.13 frystyk 765: HTEvent_unregister(HTChannel_socket(host->channel), HTEvent_READ);
766: HTEvent_unregister(HTChannel_socket(host->channel), HTEvent_WRITE);
2.18 eric 767: host->registeredFor = 0;
2.13 frystyk 768:
2.10 frystyk 769: /*
770: ** We don't want to recursively delete ourselves so if we are
771: ** called from within the stream pipe then don't delete the channel
772: ** at this point
773: */
2.8 frystyk 774: HTChannel_delete(host->channel, status);
2.18 eric 775: host->expires = 0;
2.1 frystyk 776: host->channel = NULL;
2.22 eric 777: host->tcpstate = TCP_BEGIN;
778: host->reqsMade = 0;
2.32 frystyk 779: if (HTHost_isPersistent(host)) {
780: HTNet_decreasePersistentSocket();
781: host->persistent = NO;
782: }
783: host->close_notification = NO;
2.45 frystyk 784: host->broken_pipe = NO;
2.32 frystyk 785: host->mode = HT_TP_SINGLE;
786:
2.28 frystyk 787: if (CORE_TRACE) HTTrace("Host info... removed host %p as persistent\n", host);
2.32 frystyk 788:
789: if (!HTList_isEmpty(host->pending)) {
790: if (CORE_TRACE)
2.45 frystyk 791: HTTrace("Host has %d object(s) pending - attempting launch\n", HTList_count(host->pending));
2.32 frystyk 792: HTHost_launchPending(host);
793: }
2.1 frystyk 794: return YES;
795: }
796: return NO;
797: }
798:
2.37 frystyk 799: PUBLIC BOOL HTHost_doRecover (HTHost * host)
800: {
801: return host ? host->do_recover : NO;
802: }
803:
2.1 frystyk 804: /*
2.18 eric 805: ** Move all entries in the pipeline and move the rest to the pending
806: ** queue. They will get launched at a later point in time.
807: */
808: PUBLIC BOOL HTHost_recoverPipe (HTHost * host)
809: {
810: if (host) {
811: int piped = HTList_count(host->pipeline);
812: if (piped > 0) {
813: int cnt;
2.24 frystyk 814: host->recovered++;
2.18 eric 815: if (CORE_TRACE)
2.24 frystyk 816: HTTrace("Host recovered %d times. Moving %d Net objects from pipe line to pending queue\n",
817: host->recovered, piped);
2.18 eric 818:
819: /*
820: ** Unregister this host for all events
821: */
822: HTEvent_unregister(HTChannel_socket(host->channel), HTEvent_READ);
823: HTEvent_unregister(HTChannel_socket(host->channel), HTEvent_WRITE);
824: host->registeredFor = 0;
825:
826: /*
827: ** Set new mode to single until we know what is going on
828: */
829: host->mode = HT_TP_SINGLE;
830:
831: /*
832: ** Move all net objects from the net object to the pending queue.
833: */
834: if (!host->pending) host->pending = HTList_new();
835: for (cnt=0; cnt<piped; cnt++) {
836: HTNet * net = HTList_removeLastObject(host->pipeline);
837: if (CORE_TRACE) HTTrace("Host recover Resetting net object %p\n", net);
838: net->registeredFor = 0;
839: (*net->event.cbf)(HTChannel_socket(host->channel), net->event.param, HTEvent_RESET);
840: HTList_appendObject(host->pending, net);
2.57 ! frystyk 841: host->lock = net;
2.18 eric 842: }
2.37 frystyk 843:
2.18 eric 844: HTChannel_setSemaphore(host->channel, 0);
845: HTHost_clearChannel(host, HT_INTERRUPTED);
2.37 frystyk 846: host->do_recover = NO;
2.18 eric 847: }
2.24 frystyk 848: return YES;
2.18 eric 849: }
850: return NO;
851: }
852:
853: /*
2.51 frystyk 854: ** Terminate a pipeline prematurely, for example because of timeout,
855: ** interruption, etc.
856: */
857: PUBLIC BOOL HTHost_killPipe (HTHost * host)
858: {
859: return killPipeline(host, HTEvent_CLOSE);
860: }
861:
862: /*
2.8 frystyk 863: ** Handle the connection mode. The mode may change mode in the
864: ** middle of a connection.
865: */
866: PUBLIC HTTransportMode HTHost_mode (HTHost * host, BOOL * active)
867: {
868: return host ? host->mode : HT_TP_SINGLE;
869: }
870:
871: /*
872: ** If the new mode is lower than the old mode then adjust the pipeline
873: ** accordingly. That is, if we are going into single mode then move
874: ** all entries in the pipeline and move the rest to the pending
875: ** queue. They will get launched at a later point in time.
876: */
877: PUBLIC BOOL HTHost_setMode (HTHost * host, HTTransportMode mode)
878: {
879: if (host) {
880: /*
881: ** Check the new mode and see if we must adjust the queues.
882: */
883: if (mode == HT_TP_SINGLE && host->mode > mode) {
884: int piped = HTList_count(host->pipeline);
885: if (piped > 0) {
886: int cnt;
887: if (CORE_TRACE)
888: HTTrace("Host info... Moving %d Net objects from pipe line to pending queue\n", piped);
889: if (!host->pending) host->pending = HTList_new();
890: for (cnt=0; cnt<piped; cnt++) {
2.18 eric 891: HTNet * net = HTList_removeLastObject(host->pipeline);
892: if (CORE_TRACE) HTTrace("Host info... Resetting net object %p\n", net);
2.13 frystyk 893: (*net->event.cbf)(HTChannel_socket(host->channel), net->event.param, HTEvent_RESET);
2.8 frystyk 894: HTList_appendObject(host->pending, net);
895: }
2.18 eric 896: HTChannel_setSemaphore(host->channel, 0);
897: HTHost_clearChannel(host, HT_INTERRUPTED);
2.8 frystyk 898: }
2.24 frystyk 899: }
900:
901: /*
902: ** If we know that this host is bad then we don't allow anything than
903: ** single mode. We can't recover connections for the rest of our life
904: */
905: if (mode == HT_TP_PIPELINE && host->recovered > MAX_HOST_RECOVER) {
906: if (PROT_TRACE)
907: HTTrace("Host info... %p is bad for pipelining so we won't do it!!!\n",
908: host);
909: } else {
910: host->mode = mode;
911: if (PROT_TRACE)
912: HTTrace("Host info... New mode is %d for host %p\n", host->mode, host);
913: }
2.8 frystyk 914: }
915: return NO;
916: }
917:
918: /*
919: ** Check whether a host is idle meaning if it is ready for a new
920: ** request which depends on the mode of the host. If the host is
921: ** idle, i.e. ready for use then return YES else NO. If the host supports
922: ** persistent connections then still only return idle if no requests are
923: ** ongoing.
924: */
925: PUBLIC BOOL HTHost_isIdle (HTHost * host)
926: {
2.32 frystyk 927: return (host && HTList_isEmpty(host->pipeline));
2.8 frystyk 928: }
929:
2.13 frystyk 930: PRIVATE BOOL _roomInPipe (HTHost * host)
931: {
932: int count;
2.34 frystyk 933: if (!host ||
934: (host->reqsPerConnection && host->reqsMade >= host->reqsPerConnection) ||
2.45 frystyk 935: HTHost_closeNotification(host) || host->broken_pipe)
2.32 frystyk 936: return NO;
2.13 frystyk 937: count = HTList_count(host->pipeline);
938: switch (host->mode) {
939: case HT_TP_SINGLE:
940: return count <= 0;
941: case HT_TP_PIPELINE:
2.51 frystyk 942: return (host->recovered < MAX_HOST_RECOVER) ?
943: (count < MaxPipelinedRequests) : (count <= 0);
2.13 frystyk 944: case HT_TP_INTERLEAVE:
945: return YES;
946: }
947: return NO;
948: }
949:
2.8 frystyk 950: /*
951: ** Add a net object to the host object. If the host
952: ** is idle then add to active list (pipeline) else add
953: ** it to the pending list
954: ** Return HT_PENDING if we must pend, HT_OK, or HT_ERROR
955: */
956: PUBLIC int HTHost_addNet (HTHost * host, HTNet * net)
957: {
958: if (host && net) {
959: int status = HT_OK;
2.32 frystyk 960: BOOL doit = (host->doit==net);
2.8 frystyk 961:
2.18 eric 962: /*
963: ** If we don't have a socket already then check to see if we can get
964: ** one. Otherwise we put the host object into our pending queue.
2.52 frystyk 965: */
2.18 eric 966: if (!host->channel && HTNet_availableSockets() <= 0) {
2.56 frystyk 967:
968: /* Create list for pending Host objects */
2.8 frystyk 969: if (!PendHost) PendHost = HTList_new();
2.56 frystyk 970:
971: /* Add the host object ad pending if not already */
972: if (HTList_indexOf(PendHost, host) < 0) HTList_addObject(PendHost, host);
973:
974: /*
975: ** Add the Net object to the Host object. If it is the current Net
976: ** obejct holding the lock then add it to the beginning of the list.
977: ** Otherwise add it to the end
978: */
2.52 frystyk 979: if (!host->pending) host->pending = HTList_new();
2.56 frystyk 980: if (host->lock == net)
981: HTList_appendObject(host->pending, net);
982: else
983: HTList_addObject(host->pending, net);
984:
2.52 frystyk 985: if (CORE_TRACE)
2.55 frystyk 986: HTTrace("Host info... Added Net %p (request %p) as pending on pending Host %p, %d requests made, %d requests in pipe, %d pending\n",
987: net, net->request, host, host->reqsMade,
988: HTList_count(host->pipeline), HTList_count(host->pending));
2.52 frystyk 989: return HT_PENDING;
2.8 frystyk 990: }
991:
2.45 frystyk 992: #if 0
2.18 eric 993: /*
2.45 frystyk 994: ** First check whether the net object is already on either queue.
995: ** Do NOT add extra copies of the HTNet object to
996: ** the pipeline or pending list (if it's already on the list).
997: */
998: if (HTList_indexOf(host->pipeline, net) >= 0) {
999: if (CORE_TRACE)
1000: HTTrace("Host info... The Net %p (request %p) is already in pipe,"
1001: " %d requests made, %d requests in pipe, %d pending\n",
1002: net, net->request, host->reqsMade,
1003: HTList_count(host->pipeline),
1004: HTList_count(host->pending));
1005: HTDebugBreak(__FILE__, __LINE__,
1006: "Net object %p registered multiple times in pipeline\n",
1007: net);
1008: return HT_OK;
1009: }
2.44 frystyk 1010:
2.45 frystyk 1011: if (HTList_indexOf(host->pending, net) >= 0) {
1012: if (CORE_TRACE)
1013: HTTrace("Host info... The Net %p (request %p) already pending,"
1014: " %d requests made, %d requests in pipe, %d pending\n",
1015: net, net->request, host->reqsMade,
1016: HTList_count(host->pipeline),
1017: HTList_count(host->pending));
1018: HTDebugBreak(__FILE__, __LINE__,
1019: "Net object %p registered multiple times in pending queue\n",
1020: net);
1021:
1022: return HT_PENDING;
1023: }
1024: #endif
2.44 frystyk 1025:
1026: /*
2.18 eric 1027: ** Add net object to either active or pending queue.
1028: */
2.44 frystyk 1029: if (_roomInPipe(host) && (HTList_isEmpty(host->pending) || doit)) {
2.32 frystyk 1030: if (doit) host->doit = NULL;
2.8 frystyk 1031: if (!host->pipeline) host->pipeline = HTList_new();
1032: HTList_addObject(host->pipeline, net);
2.32 frystyk 1033: host->reqsMade++;
1034: if (CORE_TRACE)
2.55 frystyk 1035: HTTrace("Host info... Added Net %p (request %p) to pipe on Host %p, %d requests made, %d requests in pipe, %d pending\n",
1036: net, net->request, host, host->reqsMade,
1037: HTList_count(host->pipeline), HTList_count(host->pending));
2.18 eric 1038:
2.13 frystyk 1039: /*
2.30 frystyk 1040: ** If we have been idle then make sure we delete the timer
2.13 frystyk 1041: */
2.30 frystyk 1042: if (host->timer) {
1043: HTTimer_delete(host->timer);
1044: host->timer = NULL;
1045: }
2.40 kahan 1046:
1047: /*JK: New CBF function
1048: ** Call any user-defined callback to say the request will
1049: ** be processed.
1050: */
1051: HTHost_ActivateRequest (net);
2.30 frystyk 1052:
2.8 frystyk 1053: } else {
1054: if (!host->pending) host->pending = HTList_new();
2.44 frystyk 1055: HTList_addObject(host->pending, net);
2.32 frystyk 1056: if (CORE_TRACE)
2.55 frystyk 1057: HTTrace("Host info... Added Net %p (request %p) as pending on Host %p, %d requests made, %d requests in pipe, %d pending\n",
2.56 frystyk 1058: net, net->request,
1059: host, host->reqsMade,
2.55 frystyk 1060: HTList_count(host->pipeline), HTList_count(host->pending));
2.8 frystyk 1061: status = HT_PENDING;
1062: }
1063: return status;
1064: }
1065: return HT_ERROR;
1066: }
1067:
2.51 frystyk 1068: PRIVATE BOOL HTHost_free (HTHost * host, int status)
2.13 frystyk 1069: {
2.32 frystyk 1070: if (host->channel) {
2.13 frystyk 1071:
2.32 frystyk 1072: /* Check if we should keep the socket open */
1073: if (HTHost_isPersistent(host)) {
2.48 frystyk 1074: int piped = HTList_count(host->pipeline);
2.37 frystyk 1075: if (HTHost_closeNotification(host)) {
1076: if (CORE_TRACE)
1077: HTTrace("Host Object. got close notifiation on socket %d\n",
1078: HTChannel_socket(host->channel));
1079:
1080: /*
1081: ** If more than a single element (this one) in the pipe
1082: ** then we have to recover gracefully
1083: */
1084: if (piped > 1) {
1085: host->reqsPerConnection = host->reqsMade - piped;
1086: if (CORE_TRACE)
1087: HTTrace("%d requests made, %d in pipe, max %d requests pr connection\n",
1088: host->reqsMade, piped, host->reqsPerConnection);
1089: host->do_recover = YES;
2.38 frystyk 1090: HTChannel_delete(host->channel, status);
1091: } else {
1092: HTChannel_setSemaphore(host->channel, 0);
1093: HTHost_clearChannel(host, status);
2.37 frystyk 1094: }
2.48 frystyk 1095: } else if (piped<=1 && host->reqsMade==host->reqsPerConnection) {
2.37 frystyk 1096: if (CORE_TRACE) HTTrace("Host Object. closing persistent socket %d\n",
1097: HTChannel_socket(host->channel));
2.32 frystyk 1098:
1099: /*
1100: ** By lowering the semaphore we make sure that the channel
1101: ** is gonna be deleted
1102: */
1103: HTChannel_setSemaphore(host->channel, 0);
1104: HTHost_clearChannel(host, status);
1105:
1106: } else {
2.56 frystyk 1107: if (CORE_TRACE) HTTrace("Host Object. keeping persistent socket %d\n",
1108: HTChannel_socket(host->channel));
1109: if (HTChannel_delete(host->channel, status))
1110: HTDebugBreak(__FILE__, __LINE__, "Host Event.. Channel unexpected deleted from host %p (%s)\n", host, host->hostname);
2.32 frystyk 1111:
1112: /*
1113: ** If connection is idle then set a timer so that we close the
1114: ** connection if idle too long
1115: */
2.48 frystyk 1116: if (piped<=1 && HTList_isEmpty(host->pending) && !host->timer) {
1117: host->timer = HTTimer_new(NULL, IdleTimeoutEvent,
2.53 frystyk 1118: host, HTActiveTimeout, YES, NO);
2.32 frystyk 1119: if (PROT_TRACE) HTTrace("Host........ Object %p going idle...\n", host);
1120: }
1121: }
1122: return YES;
1123: } else {
2.33 frystyk 1124: if (CORE_TRACE) HTTrace("Host Object. closing socket %d\n", HTChannel_socket(host->channel));
2.47 frystyk 1125: HTChannel_setSemaphore(host->channel, 0);
2.41 frystyk 1126: HTHost_clearChannel(host, status);
2.32 frystyk 1127: }
2.13 frystyk 1128: }
2.32 frystyk 1129: return NO;
2.13 frystyk 1130: }
1131:
2.51 frystyk 1132: PUBLIC BOOL HTHost_deleteNet (HTHost * host, HTNet * net, int status)
2.8 frystyk 1133: {
1134: if (host && net) {
2.44 frystyk 1135: if (CORE_TRACE) HTTrace("Host info... Remove %p from pipe\n", net);
2.51 frystyk 1136:
1137: /* If the Net object is in the pipeline then also update the channel */
1138: if (host->pipeline && HTList_indexOf(host->pipeline, net) >= 0) {
1139: HTHost_free(host, status);
1140: HTList_removeObjectAll(host->pipeline, net);
1141: }
1142:
2.44 frystyk 1143: HTList_removeObjectAll(host->pending, net); /* just to make sure */
2.8 frystyk 1144: return YES;
1145: }
1146: return NO;
1147: }
1148:
1149: /*
1150: ** Handle pending host objects.
1151: ** There are two ways we can end up with pending reqyests:
1152: ** 1) If we are out of sockets then register new host objects as pending.
1153: ** 2) If we are pending on a connection then register new net objects as
1154: ** pending
1155: ** This set of functions handles pending host objects and can start new
1156: ** requests as resources get available
1157: */
1158:
1159: /*
1160: ** Check this host object for any pending requests and return the next
1161: ** registered Net object.
1162: */
1163: PUBLIC HTNet * HTHost_nextPendingNet (HTHost * host)
1164: {
1165: HTNet * net = NULL;
2.32 frystyk 1166: if (host && host->pending) {
2.18 eric 1167: /*JK 23/Sep/96 Bug correction. Associated the following lines to the
1168: **above if. There was a missing pair of brackets.
1169: */
1170: if ((net = (HTNet *) HTList_removeFirstObject(host->pending)) != NULL) {
2.32 frystyk 1171: if (CORE_TRACE)
2.56 frystyk 1172: HTTrace("Host info... Popping %p from pending net queue on host %p\n",
1173: net, host);
2.33 frystyk 1174: #if 0
1175: {
1176: HTRequest * request = HTNet_request(net);
1177: char * uri = HTAnchor_address((HTAnchor *) HTRequest_anchor(request));
1178: fprintf(stderr, "Popping '%s'\n", uri);
1179: }
1180: #endif
2.32 frystyk 1181: host->doit = net;
2.18 eric 1182: }
2.8 frystyk 1183: }
1184: return net;
1185: }
1186:
1187: /*
2.13 frystyk 1188: ** Return the current list of pending host objects waiting for a socket
2.8 frystyk 1189: */
1190: PUBLIC HTHost * HTHost_nextPendingHost (void)
1191: {
1192: HTHost * host = NULL;
1193: if (PendHost) {
1194: if ((host = (HTHost *) HTList_removeFirstObject(PendHost)) != NULL)
1195: if (PROT_TRACE)
2.32 frystyk 1196: HTTrace("Host info... Popping %p from pending host queue\n",
2.8 frystyk 1197: host);
1198: }
1199: return host;
1200: }
1201:
1202: /*
1203: ** Start the next pending request if any. First we look for pending
1204: ** requests for the same host and then we check for any other pending
1205: ** hosts
1206: */
1207: PUBLIC BOOL HTHost_launchPending (HTHost * host)
1208: {
2.52 frystyk 1209: HTNet * net = NULL;
2.8 frystyk 1210: if (!host) {
1211: if (PROT_TRACE) HTTrace("Host info... Bad arguments\n");
1212: return NO;
1213: }
1214:
1215: /*
2.52 frystyk 1216: ** In pipeline we can only have one doing writing at a time.
1217: ** We therefore check that there are no other Net object
1218: ** registered for write
2.8 frystyk 1219: */
2.52 frystyk 1220: if (host->mode == HT_TP_PIPELINE) {
1221: net = (HTNet *) HTList_lastObject(host->pipeline);
1222: if (net && net->registeredFor == HTEvent_WRITE)
1223: return NO;
1224: }
2.8 frystyk 1225:
2.52 frystyk 1226: /*
1227: ** Check the current Host object for pending Net objects
1228: */
1229: if (_roomInPipe(host) && DoPendingReqLaunch &&
1230: (net = HTHost_nextPendingNet(host))) {
1231: HTHost_ActivateRequest(net);
1232: if (CORE_TRACE)
1233: HTTrace("Launch pending net object %p with %d reqs in pipe (%d reqs made)\n",
1234: net, HTList_count(host->pipeline), host->reqsMade);
1235: return HTNet_execute(net, HTEvent_WRITE);
1236: }
2.13 frystyk 1237:
2.52 frystyk 1238: /*
1239: ** Check for other pending Host objects
1240: */
1241: if (DoPendingReqLaunch && HTNet_availableSockets() > 0) {
1242: HTHost * pending = HTHost_nextPendingHost();
1243: if (pending && (net = HTHost_nextPendingNet(pending))) {
1244: if (!pending->pipeline) pending->pipeline = HTList_new();
1245: HTList_addObject(pending->pipeline, net);
1246: host->reqsMade++;
1247: if (CORE_TRACE)
1248: HTTrace("Launch pending host object %p, net %p with %d reqs in pipe (%d reqs made)\n",
1249: pending, net, HTList_count(pending->pipeline), pending->reqsMade);
1250: HTHost_ActivateRequest(net);
1251: return HTNet_execute(net, HTEvent_WRITE);
2.8 frystyk 1252: }
2.52 frystyk 1253: }
1254: return YES;
2.13 frystyk 1255: }
1256:
1257: PUBLIC HTNet * HTHost_firstNet (HTHost * host)
1258: {
1259: return (HTNet *) HTList_firstObject(host->pipeline);
1260: }
1261:
1262: /*
1263: ** The host event manager keeps track of the state of it's client engines
1264: ** (typically HTTPEvent), accepting multiple blocks on read or write from
1265: ** multiple pipelined engines. It then registers its own engine
1266: ** (HostEvent) with the event manager.
1267: */
1268: PUBLIC int HTHost_connect (HTHost * host, HTNet * net, char * url, HTProtocolId port)
1269: {
2.42 frystyk 1270: HTRequest * request = HTNet_request(net);
2.52 frystyk 1271: int status = HT_OK;
2.42 frystyk 1272: if (!host) {
1273: HTProtocol * protocol = HTNet_protocol(net);
1274: if ((host = HTHost_newWParse(request, url, HTProtocol_id(protocol))) == NULL)
2.45 frystyk 1275: return HT_ERROR;
2.52 frystyk 1276:
1277: /*
1278: ** If not already locked and without a channel
2.55 frystyk 1279: ** then lock the darn thing with the first Net object
1280: ** pending.
2.52 frystyk 1281: */
1282: if (!host->lock && !host->channel) {
2.55 frystyk 1283: HTNet * next_pending = NULL;
2.42 frystyk 1284: host->forceWriteFlush = YES;
2.55 frystyk 1285: host->lock = (next_pending = HTList_firstObject(host->pending)) ?
1286: next_pending : net;
1287: if (CORE_TRACE) HTTrace("Host connect Grabbing lock on Host %p with %p\n", host, host->lock);
2.42 frystyk 1288: }
1289: HTNet_setHost(net, host);
1290: }
1291:
1292: if (!host->lock || (host->lock && host->lock == net)) {
1293: status = HTDoConnect(net, url, port);
2.55 frystyk 1294: if (status == HT_PENDING)
1295: return HT_WOULD_BLOCK;
1296: else if (status == HT_WOULD_BLOCK) {
2.42 frystyk 1297: host->lock = net;
2.52 frystyk 1298: return status;
2.55 frystyk 1299: } else {
1300:
1301: /*
1302: ** See if there is already a new pending request that should
1303: ** take over the current lock
1304: */
1305: HTNet * next_pending = NULL;
1306: if ((next_pending = HTList_firstObject(host->pending))) {
1307: if (CORE_TRACE) HTTrace("Host connect Changing lock on Host %p to %p\n",
1308: host, next_pending);
1309: host->lock = next_pending;
1310: } else {
1311: if (CORE_TRACE) HTTrace("Host connect Unlocking Host %p\n", host);
1312: host->lock = NULL;
1313: }
1314: return status;
2.42 frystyk 1315: }
1316: } else {
2.55 frystyk 1317: if (CORE_TRACE)
1318: HTTrace("Host connect Host %p already locked with %p\n", host, host->lock);
2.42 frystyk 1319: if ((status = HTHost_addNet(host, net)) == HT_PENDING) {
1320: return HT_PENDING;
1321: }
2.54 frystyk 1322: }
1323: return HT_ERROR; /* @@@ - some more deletion and stuff here? */
1324: }
1325:
1326: PUBLIC int HTHost_accept (HTHost * host, HTNet * net, HTNet ** accepted,
1327: char * url, HTProtocolId port)
1328: {
1329: HTRequest * request = HTNet_request(net);
1330: int status = HT_OK;
1331: if (!host) {
1332: HTProtocol * protocol = HTNet_protocol(net);
1333: if ((host = HTHost_newWParse(request, url, HTProtocol_id(protocol))) == NULL)
1334: return HT_ERROR;
1335: else {
1336: SockA *sin = &host->sock_addr;
1337: sin->sin_addr.s_addr = INADDR_ANY;
1338: }
1339:
1340: /*
1341: ** If not already locked and without a channel
1342: ** then lock the darn thing
1343: */
1344: if (!host->lock && !host->channel) {
1345: host->forceWriteFlush = YES;
1346: host->lock = net;
1347: }
1348: HTNet_setHost(net, host);
1349:
1350: /*
1351: ** Start listening on the socket
1352: */
1353: {
1354: status = HTDoListen(net, port, INVSOC, HT_BACKLOG);
1355: if (status != HT_OK) {
1356: if (CORE_TRACE) HTTrace("Listen...... On Host %p resulted in %d\n", host, status);
1357: return HT_ERROR;
1358: }
1359: }
1360: }
1361:
1362: if (!host->lock || (host->lock && host->lock == net)) {
1363: status = HTDoAccept(net, accepted);
1364: if (status == HT_OK) {
1365:
1366: /* Add the new accepted Net object to the pipeline */
1367: HTList_appendObject(host->pipeline, *accepted);
1368:
1369: /* Unlock the accept object */
1370: host->lock = NULL;
1371:
1372: return HT_OK;
1373: }
1374: if (status == HT_WOULD_BLOCK) {
1375: host->lock = net;
1376: return status;
1377: }
1378: if (status == HT_PENDING) return HT_WOULD_BLOCK;
2.42 frystyk 1379: }
2.13 frystyk 1380: return HT_ERROR; /* @@@ - some more deletion and stuff here? */
1381: }
1382:
1383: /*
1384: ** Rules: SINGLE: one element in pipe, either reading or writing
1385: ** PIPE: n element in pipe, n-1 reading, 1 writing
1386: */
1387: PUBLIC int HTHost_register (HTHost * host, HTNet * net, HTEventType type)
1388: {
2.40 kahan 1389: HTEvent *event;
1390:
2.13 frystyk 1391: if (host && net) {
1392:
2.28 frystyk 1393: if (type == HTEvent_CLOSE) {
2.13 frystyk 1394:
2.28 frystyk 1395: /*
1396: ** Unregister this host for all events
1397: */
1398: HTEvent_unregister(HTChannel_socket(host->channel), HTEvent_READ);
1399: HTEvent_unregister(HTChannel_socket(host->channel), HTEvent_WRITE);
1400: host->registeredFor = 0;
2.13 frystyk 1401: return YES;
2.28 frystyk 1402:
1403: } else {
1404:
1405: /* net object may already be registered */
1406: if (HTEvent_BITS(type) & net->registeredFor)
1407: return NO;
1408: net->registeredFor ^= HTEvent_BITS(type);
1409:
1410: /* host object may already be registered */
1411: if (host->registeredFor & HTEvent_BITS(type))
1412: return YES;
1413: host->registeredFor ^= HTEvent_BITS(type);
2.46 frystyk 1414:
1415: #ifdef WWW_WIN_ASYNC
1416: /* Make sure we are registered for CLOSE on windows */
1417: event = *(host->events+HTEvent_INDEX(HTEvent_CLOSE));
1418: HTEvent_register(HTChannel_socket(host->channel), HTEvent_CLOSE, event);
1419: #endif /* WWW_WIN_ASYNC */
1420:
1421: /* JK: register a request in the event structure */
2.40 kahan 1422: event = *(host->events+HTEvent_INDEX(type));
1423: event->request = HTNet_request (net);
2.28 frystyk 1424: return HTEvent_register(HTChannel_socket(host->channel),
2.40 kahan 1425: type, event);
2.28 frystyk 1426: }
2.52 frystyk 1427:
1428: return YES;
2.13 frystyk 1429: }
2.52 frystyk 1430: if ("HTHost req.. Bad arguments\n");
2.13 frystyk 1431: return NO;
1432: }
1433:
1434: PUBLIC int HTHost_unregister (HTHost * host, HTNet * net, HTEventType type)
1435: {
1436: if (host && net) {
1437:
2.28 frystyk 1438: /* net object may not be registered */
2.13 frystyk 1439: if (!(HTEvent_BITS(type) & net->registeredFor))
1440: return NO;
1441: net->registeredFor ^= HTEvent_BITS(type);
1442:
2.28 frystyk 1443: /* host object may not be registered */
2.13 frystyk 1444: if (!(host->registeredFor & HTEvent_BITS(type)))
1445: return YES;
1446: host->registeredFor ^= HTEvent_BITS(type);
1447:
1448: /* stay registered for READ to catch a socket close */
1449: /* WRITE and CONNECT can be unregistered, though */
1450: if ((type == HTEvent_WRITE && isLastInPipe(host, net)) ||
1451: type == HTEvent_CONNECT)
1452: /* if we are blocked downstream, shut down the whole pipe */
1453: HTEvent_unregister(HTChannel_socket(host->channel), type);
1454: return YES;
1455: }
1456: return NO;
1457: }
1458:
1459: /*
1460: ** The reader tells HostEvent that it's stream did not finish the data
1461: */
1462: PUBLIC BOOL HTHost_setRemainingRead (HTHost * host, size_t remaining)
1463: {
1464: if (host == NULL) return NO;
1465: host->remainingRead = remaining;
2.20 frystyk 1466: if (PROT_TRACE) HTTrace("Host........ %d bytes remaining \n", remaining);
2.45 frystyk 1467: if (host->broken_pipe && remaining == 0) {
1468: if (PROT_TRACE) HTTrace("Host........ Emtied out connection\n");
1469: }
2.13 frystyk 1470: return YES;
1471: }
1472:
2.32 frystyk 1473: PUBLIC size_t HTHost_remainingRead (HTHost * host)
1474: {
1475: return host ? host->remainingRead : -1;
1476: }
1477:
2.13 frystyk 1478: PUBLIC SockA * HTHost_getSockAddr (HTHost * host)
1479: {
1480: if (!host) return NULL;
1481: return &host->sock_addr;
1482: }
1483:
1484: PUBLIC BOOL HTHost_setHome (HTHost * host, int home)
1485: {
1486: if (!host) return NO;
1487: host->home = home;
1488: return YES;
1489: }
1490:
1491: PUBLIC int HTHost_home (HTHost * host)
1492: {
1493: if (!host) return 0;
1494: return host->home;
1495: }
1496:
2.27 frystyk 1497: PUBLIC BOOL HTHost_setRetry (HTHost * host, int retry)
1498: {
1499: if (!host) return NO;
1500: host->retry = retry;
1501: return YES;
1502: }
1503:
1504: PUBLIC BOOL HTHost_decreaseRetry (HTHost * host)
1505: {
2.44 frystyk 1506: if (!host) return NO;
1507:
1508: if (host->retry > 0) host->retry--;
1509: return YES;
1510:
2.27 frystyk 1511: }
1512:
1513: PUBLIC int HTHost_retry (HTHost * host)
1514: {
1515: if (!host) return 0;
1516: return host->retry;
1517: }
1518:
2.13 frystyk 1519: #if 0 /* Is a macro right now */
2.21 frystyk 1520: PRIVATE BOOL HTHost_setDNS5 (HTHost * host, HTdns * dns)
2.13 frystyk 1521: {
1522: if (!host) return NO;
1523: host->dns = dns;
1524: return YES;
1525: }
1526: #endif
1527:
1528: PUBLIC BOOL HTHost_setChannel (HTHost * host, HTChannel * channel)
1529: {
1530: if (!host) return NO;
1531: host->channel = channel;
1532: return YES;
1533: }
1534:
1535: PUBLIC HTNet * HTHost_getReadNet(HTHost * host)
1536: {
2.38 frystyk 1537: return host ? (HTNet *) HTList_firstObject(host->pipeline) : NULL;
2.13 frystyk 1538: }
1539:
1540: PUBLIC HTNet * HTHost_getWriteNet(HTHost * host)
1541: {
1542: return host ? (HTNet *) HTList_lastObject(host->pipeline) : NULL;
1543: }
1544:
1545: /*
1546: ** Create the input stream and bind it to the channel
1547: ** Please read the description in the HTIOStream module for the parameters
1548: */
1549: PUBLIC HTInputStream * HTHost_getInput (HTHost * host, HTTransport * tp,
1550: void * param, int mode)
1551: {
1552: if (host && host->channel && tp) {
1553: HTChannel * ch = host->channel;
1554: HTInputStream * input = (*tp->input_new)(host, ch, param, mode);
1555: HTChannel_setInput(ch, input);
1556: return HTChannel_getChannelIStream(ch);
1557: }
2.24 frystyk 1558: if (CORE_TRACE) HTTrace("Host Object. Can't create input stream\n");
2.13 frystyk 1559: return NULL;
1560: }
1561:
1562: PUBLIC HTOutputStream * HTHost_getOutput (HTHost * host, HTTransport * tp,
1563: void * param, int mode)
1564: {
1565: if (host && host->channel && tp) {
1566: HTChannel * ch = host->channel;
1567: HTOutputStream * output = (*tp->output_new)(host, ch, param, mode);
1568: HTChannel_setOutput(ch, output);
1569: return output;
1570: }
2.24 frystyk 1571: if (CORE_TRACE) HTTrace("Host Object. Can't create output stream\n");
2.13 frystyk 1572: return NULL;
1573: }
1574:
1575: PUBLIC HTOutputStream * HTHost_output (HTHost * host, HTNet * net)
1576: {
1577: if (host && host->channel && net) {
1578: HTOutputStream * output = HTChannel_output(host->channel);
1579: return output;
1580: }
1581: return NULL;
1582: }
1583:
1584: PUBLIC int HTHost_read(HTHost * host, HTNet * net)
1585: {
1586: HTInputStream * input = HTChannel_input(host->channel);
1587: if (net != HTHost_getReadNet(host)) {
1588: HTHost_register(host, net, HTEvent_READ);
1589: return HT_WOULD_BLOCK;
1590: }
2.17 frystyk 1591:
1592: /*
1593: ** If there is no input channel then this can either mean that
1594: ** we have lost the channel or an error occurred. We return
1595: ** HT_CLOSED as this is a sign to the caller that we don't
1596: ** have a channel
1597: */
1598: return input ? (*input->isa->read)(input) : HT_CLOSED;
2.13 frystyk 1599: }
1600:
1601: PUBLIC BOOL HTHost_setConsumed(HTHost * host, size_t bytes)
1602: {
1603: HTInputStream * input;
1604: if (!host || !host->channel) return NO;
1605: if ((input = HTChannel_input(host->channel)) == NULL)
1606: return NO;
2.32 frystyk 1607: if (CORE_TRACE)
2.20 frystyk 1608: HTTrace("Host........ passing %d bytes as consumed to %p\n", bytes, input);
2.13 frystyk 1609: return (*input->isa->consumed)(input, bytes);
1610: }
1611:
1612: PUBLIC int HTHost_hash (HTHost * host)
1613: {
1614: return host ? host->hash : -1;
1615: }
1616:
2.26 frystyk 1617: PUBLIC BOOL HTHost_setWriteDelay (HTHost * host, ms_t delay)
2.13 frystyk 1618: {
2.26 frystyk 1619: if (host && delay >= 0) {
1620: host->delay = delay;
1621: return YES;
1622: }
1623: return NO;
1624: }
1625:
1626: PUBLIC ms_t HTHost_writeDelay (HTHost * host)
1627: {
1628: return host ? host->delay : 0;
1629: }
1630:
1631: PUBLIC int HTHost_findWriteDelay (HTHost * host, ms_t lastFlushTime, int buffSize)
1632: {
2.35 frystyk 1633: #if 0
2.15 eric 1634: unsigned short mtu;
2.18 eric 1635: int ret = -1;
2.15 eric 1636: int socket = HTChannel_socket(host->channel);
2.18 eric 1637: #ifndef WWW_MSWINDOWS
2.15 eric 1638: ret = ioctl(socket, 666, (unsigned long)&mtu);
2.18 eric 1639: #endif /* WWW_MSWINDOWS */
2.15 eric 1640: if ((ret == 0 && buffSize >= mtu) || host->forceWriteFlush)
2.13 frystyk 1641: return 0;
2.26 frystyk 1642: return host->delay;
2.35 frystyk 1643: #else
1644: return host->forceWriteFlush ? 0 : host->delay;
1645: #endif
2.13 frystyk 1646: }
1647:
2.26 frystyk 1648: PUBLIC BOOL HTHost_setDefaultWriteDelay (ms_t delay)
1649: {
1650: if (delay >= 0) {
1651: WriteDelay = delay;
1652: if (CORE_TRACE) HTTrace("Host........ Default write delay is %d ms\n", delay);
1653: return YES;
1654: }
1655: return NO;
1656: }
1657:
1658: PUBLIC ms_t HTHost_defaultWriteDelay (void)
1659: {
1660: return WriteDelay;
1661: }
1662:
2.13 frystyk 1663: PUBLIC int HTHost_forceFlush(HTHost * host)
1664: {
2.35 frystyk 1665: HTNet * targetNet = (HTNet *) HTList_lastObject(host->pipeline);
2.13 frystyk 1666: int ret;
2.35 frystyk 1667: if (targetNet == NULL) return HT_ERROR;
2.13 frystyk 1668: if (CORE_TRACE)
2.28 frystyk 1669: HTTrace("Host Event.. FLUSH passed to `%s\'\n",
1670: HTAnchor_physical(HTRequest_anchor(HTNet_request(targetNet))));
2.13 frystyk 1671: host->forceWriteFlush = YES;
1672: ret = (*targetNet->event.cbf)(HTChannel_socket(host->channel), targetNet->event.param, HTEvent_FLUSH);
2.35 frystyk 1673: host->forceWriteFlush = NO;
2.13 frystyk 1674: return ret;
2.39 frystyk 1675: }
1676:
1677: /*
1678: ** Context pointer to be used as a user defined context
1679: */
1680: PUBLIC void HTHost_setContext (HTHost * me, void * context)
1681: {
2.40 kahan 1682: if (me) me->context = context;
2.39 frystyk 1683: }
1684:
1685: PUBLIC void * HTHost_context (HTHost * me)
1686: {
2.40 kahan 1687: return me ? me->context : NULL;
2.1 frystyk 1688: }
2.11 kahan 1689:
2.13 frystyk 1690: PUBLIC int HTHost_eventTimeout (void)
1691: {
1692: return EventTimeout;
1693: }
2.11 kahan 1694:
2.13 frystyk 1695: PUBLIC void HTHost_setEventTimeout (int millis)
1696: {
1697: EventTimeout = millis;
1698: if (CORE_TRACE) HTTrace("Host........ Setting event timeout to %d ms\n", millis);
1699: }
2.40 kahan 1700:
2.45 frystyk 1701: PUBLIC BOOL HTHost_setMaxPipelinedRequests (int max)
1702: {
1703: if (max > 1) {
1704: MaxPipelinedRequests = max;
1705: return YES;
1706: }
1707: return NO;
1708: }
2.40 kahan 1709:
2.45 frystyk 1710: PUBLIC int HTHost_maxPipelinedRequests (void)
2.40 kahan 1711: {
2.45 frystyk 1712: return MaxPipelinedRequests;
1713: }
1714:
1715: PUBLIC void HTHost_setActivateRequestCallback (HTHost_ActivateRequestCallback * cbf)
1716: {
1717: if (CORE_TRACE) HTTrace("HTHost...... Registering %p\n", cbf);
2.40 kahan 1718: ActivateReqCBF = cbf;
1719: }
1720:
2.45 frystyk 1721: PRIVATE int HTHost_ActivateRequest (HTNet * net)
2.40 kahan 1722: {
2.45 frystyk 1723: HTRequest * request = NULL;
1724: if (!ActivateReqCBF) {
1725: if (CORE_TRACE)
1726: HTTrace("HTHost...... No ActivateRequest callback handler registered\n");
1727: return HT_ERROR;
1728: }
1729: request = HTNet_request(net);
1730: return (*ActivateReqCBF)(request);
2.40 kahan 1731: }
1732:
1733: PUBLIC void HTHost_disable_PendingReqLaunch (void)
1734: {
2.45 frystyk 1735: DoPendingReqLaunch = NO;
2.40 kahan 1736: }
1737:
1738: PUBLIC void HTHost_enable_PendingReqLaunch (void)
1739: {
2.45 frystyk 1740: DoPendingReqLaunch = YES;
2.40 kahan 1741: }
1742:
Webmaster