2 * DEBUG: section 5 Socket Functions
3 * AUTHOR: Harvest Derived
5 * SQUID Web Proxy Cache http://www.squid-cache.org/
6 * ----------------------------------------------------------
8 * Squid is the result of efforts by numerous individuals from
9 * the Internet community; see the CONTRIBUTORS file for full
10 * details. Many organizations have provided support for Squid's
11 * development; see the SPONSORS file for full details. Squid is
12 * Copyrighted (C) 2001 by the Regents of the University of
13 * California; see the COPYRIGHT file for full details. Squid
14 * incorporates software developed and/or copyrighted by other
15 * sources; see the CREDITS file for full details.
17 * This program is free software; you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation; either version 2 of the License, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program; if not, write to the Free Software
29 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
32 * Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
36 #include "StoreIOBuffer.h"
42 #include "ConnectionDetail.h"
45 #include "SquidTime.h"
46 #include "CommCalls.h"
47 #include "DescriptorSet.h"
48 #include "icmp/net_db.h"
49 #include "ip/IpAddress.h"
50 #include "ip/IpIntercept.h"
52 #if defined(_SQUID_CYGWIN_)
53 #include <sys/ioctl.h>
55 #ifdef HAVE_NETINET_TCP_H
56 #include <netinet/tcp.h>
60 * New C-like simple comm code. This stuff is a mess and doesn't really buy us anything.
69 static void commStopHalfClosedMonitor(int fd
);
70 static IOCB commHalfClosedReader
;
73 struct comm_io_callback_t
{
76 AsyncCall::Pointer callback
;
84 bool active() const { return callback
!= NULL
; }
89 comm_io_callback_t readcb
;
90 comm_io_callback_t writecb
;
92 typedef struct _comm_fd comm_fd_t
;
93 comm_fd_t
*commfd_table
;
95 // TODO: make this a comm_io_callback_t method?
97 commio_has_callback(int fd
, iocb_type type
, comm_io_callback_t
*ccb
)
99 assert(ccb
->fd
== fd
);
100 assert(ccb
->type
== type
);
101 return ccb
->active();
105 * Configure comm_io_callback_t for I/O
107 * @param fd filedescriptor
108 * @param ccb comm io callback
110 * @param cbdata callback data (must be cbdata'ed)
111 * @param buf buffer, if applicable
112 * @param freefunc freefunc, if applicable
113 * @param size buffer size
116 commio_set_callback(int fd
, iocb_type type
, comm_io_callback_t
*ccb
,
117 AsyncCall::Pointer
&cb
, char *buf
, FREE
*freefunc
, int size
)
119 assert(!ccb
->active());
120 assert(ccb
->type
== type
);
125 ccb
->freefunc
= freefunc
;
131 // Schedule the callback call and clear the callback
133 commio_finish_callback(int fd
, comm_io_callback_t
*ccb
, comm_err_t code
, int xerrno
)
135 debugs(5, 3, "commio_finish_callback: called for FD " << fd
<< " (" <<
136 code
<< ", " << xerrno
<< ")");
137 assert(ccb
->active());
138 assert(ccb
->fd
== fd
);
140 ccb
->xerrno
= xerrno
;
142 comm_io_callback_t cb
= *ccb
;
144 /* We've got a copy; blow away the real one */
145 /* XXX duplicate code from commio_cancel_callback! */
147 ccb
->callback
= NULL
; // cb has it
155 if (cb
.callback
!= NULL
) {
156 typedef CommIoCbParams Params
;
157 Params
¶ms
= GetCommParams
<Params
>(cb
.callback
);
160 params
.size
= cb
.offset
;
161 params
.flag
= cb
.errcode
;
162 params
.xerrno
= cb
.xerrno
;
163 ScheduleCallHere(cb
.callback
);
169 * Cancel the given callback
171 * Remember that the data is cbdataRef'ed.
173 // TODO: make this a comm_io_callback_t method
175 commio_cancel_callback(int fd
, comm_io_callback_t
*ccb
)
177 debugs(5, 3, "commio_cancel_callback: called for FD " << fd
);
178 assert(ccb
->fd
== fd
);
179 assert(ccb
->active());
182 ccb
->callback
= NULL
;
186 * Call the given comm callback; assumes the callback is valid.
188 * @param ccb io completion callback
191 commio_call_callback(comm_io_callback_t
*ccb
)
195 class ConnectStateData
199 void *operator new (size_t);
200 void operator delete (void *);
201 static void Connect (int fd
, void *me
);
203 void callCallback(comm_err_t status
, int xerrno
);
206 // defaults given by client
208 u_short default_port
;
209 IpAddress default_addr
;
210 // NP: CANNOT store the default addr:port together as it gets set/reset differently.
212 DnsLookupDetails dns
; ///< host lookup details
214 AsyncCall::Pointer callback
;
223 int commRetryConnect();
224 CBDATA_CLASS(ConnectStateData
);
229 static DescriptorSet
*TheHalfClosed
= NULL
; /// the set of half-closed FDs
230 static bool WillCheckHalfClosed
= false; /// true if check is scheduled
231 static EVH commHalfClosedCheck
;
232 static void commPlanHalfClosedCheck();
234 static comm_err_t
commBind(int s
, struct addrinfo
&);
235 static void commSetReuseAddr(int);
236 static void commSetNoLinger(int);
238 static void commSetTcpNoDelay(int);
240 static void commSetTcpRcvbuf(int, int);
241 static PF commConnectFree
;
242 static PF commHandleWrite
;
243 static IPH commConnectDnsHandle
;
245 static PF comm_accept_try
;
251 AcceptFD(int aFd
= -1): fd(aFd
), theCallback(0), mayAcceptMore(false) {}
253 void subscribe(AsyncCall::Pointer
&call
);
255 void notify(int newfd
, comm_err_t
, int xerrno
, const ConnectionDetail
&);
262 AsyncCall::Pointer theCallback
;
272 char const *close_file
;
276 typedef struct _fd_debug_t fd_debug_t
;
278 static MemAllocator
*conn_close_pool
= NULL
;
279 AcceptFD
*fdc_table
= NULL
; // TODO: rename. And use Vector<>?
280 fd_debug_t
*fdd_table
= NULL
;
285 return fd_table
[fd
].flags
.open
!= 0;
291 * If the read attempt succeeds or fails, call the callback.
292 * Else, wait for another IO notification.
295 commHandleRead(int fd
, void *data
)
297 comm_io_callback_t
*ccb
= (comm_io_callback_t
*) data
;
299 assert(data
== COMMIO_FD_READCB(fd
));
300 assert(commio_has_callback(fd
, IOCB_READ
, ccb
));
302 statCounter
.syscalls
.sock
.reads
++;
305 retval
= FD_READ_METHOD(fd
, ccb
->buf
, ccb
->size
);
306 debugs(5, 3, "comm_read_try: FD " << fd
<< ", size " << ccb
->size
<< ", retval " << retval
<< ", errno " << errno
);
308 if (retval
< 0 && !ignoreErrno(errno
)) {
309 debugs(5, 3, "comm_read_try: scheduling COMM_ERROR");
311 commio_finish_callback(fd
, ccb
, COMM_ERROR
, errno
);
315 /* See if we read anything */
316 /* Note - read 0 == socket EOF, which is a valid read */
318 fd_bytes(fd
, retval
, FD_READ
);
319 ccb
->offset
= retval
;
320 commio_finish_callback(fd
, ccb
, COMM_OK
, errno
);
324 /* Nope, register for some more IO */
325 commSetSelect(fd
, COMM_SELECT_READ
, commHandleRead
, data
, 0);
329 * Queue a read. handler/handler_data are called when the read
330 * completes, on error, or on file descriptor close.
333 comm_read(int fd
, char *buf
, int size
, IOCB
*handler
, void *handler_data
)
335 AsyncCall::Pointer call
= commCbCall(5,4, "SomeCommReadHandler",
336 CommIoCbPtrFun(handler
, handler_data
));
337 comm_read(fd
, buf
, size
, call
);
341 comm_read(int fd
, char *buf
, int size
, AsyncCall::Pointer
&callback
)
343 debugs(5, 5, "comm_read, queueing read for FD " << fd
<< "; asynCall " << callback
);
345 /* Make sure we are open and not closing */
347 assert(!fd_table
[fd
].closing());
348 comm_io_callback_t
*ccb
= COMMIO_FD_READCB(fd
);
350 // Make sure we are either not reading or just passively monitoring.
351 // Active/passive conflicts are OK and simply cancel passive monitoring.
353 // if the assertion below fails, we have an active comm_read conflict
354 assert(fd_table
[fd
].halfClosedReader
!= NULL
);
355 commStopHalfClosedMonitor(fd
);
356 assert(!ccb
->active());
360 commio_set_callback(fd
, IOCB_READ
, ccb
, callback
, (char *)buf
, NULL
, size
);
361 commSetSelect(fd
, COMM_SELECT_READ
, commHandleRead
, ccb
, 0);
365 * Empty the read buffers
367 * This is a magical routine that empties the read buffers.
368 * Under some platforms (Linux) if a buffer has data in it before
369 * you call close(), the socket will hang and take quite a while
373 comm_empty_os_read_buffers(int fd
)
376 /* prevent those nasty RST packets */
377 char buf
[SQUID_TCP_SO_RCVBUF
];
379 if (fd_table
[fd
].flags
.nonblocking
== 1) {
380 while (FD_READ_METHOD(fd
, buf
, SQUID_TCP_SO_RCVBUF
) > 0) {};
387 * Return whether the FD has a pending completed callback.
390 comm_has_pending_read_callback(int fd
)
393 // XXX: We do not know whether there is a read callback scheduled.
394 // This is used for pconn management that should probably be more
395 // tightly integrated into comm to minimize the chance that a
396 // closing pconn socket will be used for a new transaction.
400 // Does comm check this fd for read readiness?
401 // Note that when comm is not monitoring, there can be a pending callback
402 // call, which may resume comm monitoring once fired.
404 comm_monitors_read(int fd
)
407 // Being active is usually the same as monitoring because we always
408 // start monitoring the FD when we configure comm_io_callback_t for I/O
409 // and we usually configure comm_io_callback_t for I/O when we starting
410 // monitoring a FD for reading. TODO: replace with commio_has_callback
411 return COMMIO_FD_READCB(fd
)->active();
415 * Cancel a pending read. Assert that we have the right parameters,
416 * and that there are no pending read events!
418 * XXX: We do not assert that there are no pending read events and
419 * with async calls it becomes even more difficult.
420 * The whole interface should be reworked to do callback->cancel()
421 * instead of searching for places where the callback may be stored and
422 * updating the state of those places.
424 * AHC Don't call the comm handlers?
427 comm_read_cancel(int fd
, IOCB
*callback
, void *data
)
430 debugs(5, 4, "comm_read_cancel fails: FD " << fd
<< " closed");
434 comm_io_callback_t
*cb
= COMMIO_FD_READCB(fd
);
435 // TODO: is "active" == "monitors FD"?
437 debugs(5, 4, "comm_read_cancel fails: FD " << fd
<< " inactive");
441 typedef CommCbFunPtrCallT
<CommIoCbPtrFun
> Call
;
442 Call
*call
= dynamic_cast<Call
*>(cb
->callback
.getRaw());
444 debugs(5, 4, "comm_read_cancel fails: FD " << fd
<< " lacks callback");
448 call
->cancel("old comm_read_cancel");
450 typedef CommIoCbParams Params
;
451 const Params
¶ms
= GetCommParams
<Params
>(cb
->callback
);
453 /* Ok, we can be reasonably sure we won't lose any data here! */
454 assert(call
->dialer
.handler
== callback
);
455 assert(params
.data
== data
);
457 /* Delete the callback */
458 commio_cancel_callback(fd
, cb
);
460 /* And the IO event */
461 commSetSelect(fd
, COMM_SELECT_READ
, NULL
, NULL
, 0);
465 comm_read_cancel(int fd
, AsyncCall::Pointer
&callback
)
467 callback
->cancel("comm_read_cancel");
470 debugs(5, 4, "comm_read_cancel fails: FD " << fd
<< " closed");
474 comm_io_callback_t
*cb
= COMMIO_FD_READCB(fd
);
477 debugs(5, 4, "comm_read_cancel fails: FD " << fd
<< " inactive");
481 AsyncCall::Pointer call
= cb
->callback
;
482 assert(call
!= NULL
); // XXX: should never fail (active() checks for callback==NULL)
484 /* Ok, we can be reasonably sure we won't lose any data here! */
485 assert(call
== callback
);
487 /* Delete the callback */
488 commio_cancel_callback(fd
, cb
);
490 /* And the IO event */
491 commSetSelect(fd
, COMM_SELECT_READ
, NULL
, NULL
, 0);
496 * synchronous wrapper around udp socket functions
499 comm_udp_recvfrom(int fd
, void *buf
, size_t len
, int flags
, IpAddress
&from
)
501 statCounter
.syscalls
.sock
.recvfroms
++;
503 struct addrinfo
*AI
= NULL
;
505 debugs(5,8, "comm_udp_recvfrom: FD " << fd
<< " from " << from
);
507 assert( NULL
== AI
);
509 from
.InitAddrInfo(AI
);
511 x
= recvfrom(fd
, buf
, len
, flags
, AI
->ai_addr
, &AI
->ai_addrlen
);
515 from
.FreeAddrInfo(AI
);
521 comm_udp_recv(int fd
, void *buf
, size_t len
, int flags
)
524 return comm_udp_recvfrom(fd
, buf
, len
, flags
, nul
);
528 comm_udp_send(int s
, const void *buf
, size_t len
, int flags
)
530 return send(s
, buf
, len
, flags
);
535 comm_has_incomplete_write(int fd
)
538 return COMMIO_FD_WRITECB(fd
)->active();
542 * Queue a write. handler/handler_data are called when the write fully
543 * completes, on error, or on file descriptor close.
546 /* Return the local port associated with fd. */
548 comm_local_port(int fd
)
551 struct addrinfo
*addr
= NULL
;
552 fde
*F
= &fd_table
[fd
];
554 /* If the fd is closed already, just return */
556 if (!F
->flags
.open
) {
557 debugs(5, 0, "comm_local_port: FD " << fd
<< " has been closed.");
561 if (F
->local_addr
.GetPort())
562 return F
->local_addr
.GetPort();
565 if (F
->sock_family
== AF_INET
)
569 temp
.InitAddrInfo(addr
);
571 if (getsockname(fd
, addr
->ai_addr
, &(addr
->ai_addrlen
)) ) {
572 debugs(50, 1, "comm_local_port: Failed to retrieve TCP/UDP port number for socket: FD " << fd
<< ": " << xstrerror());
573 temp
.FreeAddrInfo(addr
);
578 temp
.FreeAddrInfo(addr
);
580 F
->local_addr
.SetPort(temp
.GetPort());
582 #if 0 // seems to undo comm_open actions on the FD ...
583 // grab default socket information for this address
584 temp
.GetAddrInfo(addr
);
586 F
->sock_family
= addr
->ai_family
;
588 temp
.FreeAddrInfo(addr
);
591 debugs(5, 6, "comm_local_port: FD " << fd
<< ": port " << F
->local_addr
.GetPort() << "(family=" << F
->sock_family
<< ")");
592 return F
->local_addr
.GetPort();
596 commBind(int s
, struct addrinfo
&inaddr
)
598 statCounter
.syscalls
.sock
.binds
++;
600 if (bind(s
, inaddr
.ai_addr
, inaddr
.ai_addrlen
) == 0) {
601 debugs(50, 6, "commBind: bind socket FD " << s
<< " to " << fd_table
[s
].local_addr
);
605 debugs(50, 0, "commBind: Cannot bind socket FD " << s
<< " to " << fd_table
[s
].local_addr
<< ": " << xstrerror());
611 * Create a socket. Default is blocking, stream (TCP) socket. IO_TYPE
612 * is OR of flags specified in comm.h. Defaults TOS
615 comm_open(int sock_type
,
621 return comm_openex(sock_type
, proto
, addr
, flags
, 0, note
);
625 comm_open_listener(int sock_type
,
633 /* all listener sockets require bind() */
634 flags
|= COMM_DOBIND
;
636 /* attempt native enabled port. */
637 sock
= comm_openex(sock_type
, proto
, addr
, flags
, 0, note
);
640 /* under IPv6 there is the possibility IPv6 is present but disabled. */
641 /* try again as IPv4-native */
642 if ( sock
< 0 && addr
.IsIPv6() && addr
.SetIPv4() ) {
643 /* attempt to open this IPv4-only. */
644 sock
= comm_openex(sock_type
, proto
, addr
, flags
, 0, note
);
645 debugs(50, 2, HERE
<< "attempt open " << note
<< " socket on: " << addr
);
653 limitError(int const anErrno
)
655 return anErrno
== ENFILE
|| anErrno
== EMFILE
;
659 comm_set_tos(int fd
, int tos
)
662 int x
= setsockopt(fd
, IPPROTO_IP
, IP_TOS
, (char *) &tos
, sizeof(int));
664 debugs(50, 1, "comm_set_tos: setsockopt(IP_TOS) on FD " << fd
<< ": " << xstrerror());
667 debugs(50, 0, "WARNING: setsockopt(IP_TOS) not supported on this platform");
673 comm_set_v6only(int fd
, int tos
)
676 if (setsockopt(fd
, IPPROTO_IPV6
, IPV6_V6ONLY
, (char *) &tos
, sizeof(int)) < 0) {
677 debugs(50, 1, "comm_open: setsockopt(IPV6_V6ONLY) " << (tos
?"ON":"OFF") << " for FD " << fd
<< ": " << xstrerror());
680 debugs(50, 0, "WARNING: comm_open: setsockopt(IPV6_V6ONLY) not supported on this platform");
685 * Set the socket IP_TRANSPARENT option for Linux TPROXY v4 support.
688 comm_set_transparent(int fd
)
690 #if defined(IP_TRANSPARENT)
692 if (setsockopt(fd
, SOL_IP
, IP_TRANSPARENT
, (char *) &tos
, sizeof(int)) < 0) {
693 debugs(50, DBG_IMPORTANT
, "comm_open: setsockopt(IP_TRANSPARENT) on FD " << fd
<< ": " << xstrerror());
695 /* mark the socket as having transparent options */
696 fd_table
[fd
].flags
.transparent
= 1;
699 debugs(50, DBG_CRITICAL
, "WARNING: comm_open: setsockopt(IP_TRANSPARENT) not supported on this platform");
704 * Create a socket. Default is blocking, stream (TCP) socket. IO_TYPE
705 * is OR of flags specified in defines.h:COMM_*
708 comm_openex(int sock_type
,
718 struct addrinfo
*AI
= NULL
;
720 PROF_start(comm_open
);
721 /* Create socket for accepting new connections. */
722 statCounter
.syscalls
.sock
.sockets
++;
724 /* Setup the socket addrinfo details for use */
725 addr
.GetAddrInfo(AI
);
726 AI
->ai_socktype
= sock_type
;
727 AI
->ai_protocol
= proto
;
729 debugs(50, 3, "comm_openex: Attempt open socket for: " << addr
);
731 if ((new_socket
= socket(AI
->ai_family
, AI
->ai_socktype
, AI
->ai_protocol
)) < 0) {
732 /* Increase the number of reserved fd's if calls to socket()
733 * are failing because the open file table is full. This
734 * limits the number of simultaneous clients */
736 if (limitError(errno
)) {
737 debugs(50, DBG_IMPORTANT
, "comm_open: socket failure: " << xstrerror());
740 debugs(50, DBG_CRITICAL
, "comm_open: socket failure: " << xstrerror());
743 addr
.FreeAddrInfo(AI
);
745 PROF_stop(comm_open
);
749 debugs(50, 3, "comm_openex: Opened socket FD " << new_socket
<< " : family=" << AI
->ai_family
<< ", type=" << AI
->ai_socktype
<< ", protocol=" << AI
->ai_protocol
);
751 /* set TOS if needed */
752 if (TOS
&& comm_set_tos(new_socket
, TOS
) ) {
756 #if IPV6_SPECIAL_SPLITSTACK
759 comm_set_v6only(new_socket
, 1);
763 #if IPV6_SPECIAL_V4MAPPED
765 /* Windows Vista supports Dual-Sockets. BUT defaults them to V6ONLY. Turn it OFF. */
766 /* Other OS may have this administratively disabled for general use. Same deal. */
768 comm_set_v6only(new_socket
, 0);
773 debugs(5, 5, "comm_open: FD " << new_socket
<< " is a new socket");
775 assert(!isOpen(new_socket
));
776 fd_open(new_socket
, FD_SOCKET
, note
);
778 fdd_table
[new_socket
].close_file
= NULL
;
780 fdd_table
[new_socket
].close_line
= 0;
782 F
= &fd_table
[new_socket
];
784 F
->local_addr
= addr
;
788 F
->sock_family
= AI
->ai_family
;
790 if (!(flags
& COMM_NOCLOEXEC
))
791 commSetCloseOnExec(new_socket
);
793 if ((flags
& COMM_REUSEADDR
))
794 commSetReuseAddr(new_socket
);
796 if (addr
.GetPort() > (u_short
) 0) {
798 if (sock_type
!= SOCK_DGRAM
)
800 commSetNoLinger(new_socket
);
803 commSetReuseAddr(new_socket
);
806 /* MUST be done before binding or face OS Error: "(99) Cannot assign requested address"... */
807 if ((flags
& COMM_TRANSPARENT
)) {
808 comm_set_transparent(new_socket
);
811 if ( (flags
& COMM_DOBIND
) || addr
.GetPort() > 0 || !addr
.IsAnyAddr() ) {
812 if ( !(flags
& COMM_DOBIND
) && addr
.IsAnyAddr() )
813 debugs(5,1,"WARNING: Squid is attempting to bind() port " << addr
<< " without being a listener.");
814 if ( addr
.IsNoAddr() )
815 debugs(5,0,"CRITICAL: Squid is attempting to bind() port " << addr
<< "!!");
817 if (commBind(new_socket
, *AI
) != COMM_OK
) {
818 comm_close(new_socket
);
819 addr
.FreeAddrInfo(AI
);
821 PROF_stop(comm_open
);
825 addr
.FreeAddrInfo(AI
);
827 if (flags
& COMM_NONBLOCKING
)
828 if (commSetNonBlocking(new_socket
) == COMM_ERROR
) {
830 PROF_stop(comm_open
);
834 if (sock_type
== SOCK_STREAM
)
835 commSetTcpNoDelay(new_socket
);
839 if (Config
.tcpRcvBufsz
> 0 && sock_type
== SOCK_STREAM
)
840 commSetTcpRcvbuf(new_socket
, Config
.tcpRcvBufsz
);
842 PROF_stop(comm_open
);
847 CBDATA_CLASS_INIT(ConnectStateData
);
850 ConnectStateData::operator new (size_t size
)
852 CBDATA_INIT_TYPE(ConnectStateData
);
853 return cbdataAlloc(ConnectStateData
);
857 ConnectStateData::operator delete (void *address
)
865 commConnectStart(int fd
, const char *host
, u_short port
, AsyncCall::Pointer
&cb
)
867 debugs(cb
->debugSection
, cb
->debugLevel
, "commConnectStart: FD " << fd
<<
868 ", cb " << cb
<< ", " << host
<< ":" << port
); // TODO: just print *cb
870 ConnectStateData
*cs
;
871 cs
= new ConnectStateData
;
873 cs
->host
= xstrdup(host
);
874 cs
->default_port
= port
;
877 comm_add_close_handler(fd
, commConnectFree
, cs
);
878 ipcache_nbgethostbyname(host
, commConnectDnsHandle
, cs
);
881 // TODO: Remove this and similar callback registration functions by replacing
882 // (callback,data) parameters with an AsyncCall so that we do not have to use
883 // a generic call name and debug level when creating an AsyncCall. This will
884 // also cut the number of callback registration routines in half.
886 commConnectStart(int fd
, const char *host
, u_short port
, CNCB
* callback
, void *data
)
888 debugs(5, 5, "commConnectStart: FD " << fd
<< ", data " << data
<< ", " << host
<< ":" << port
);
889 AsyncCall::Pointer call
= commCbCall(5,3,
890 "SomeCommConnectHandler", CommConnectCbPtrFun(callback
, data
));
891 commConnectStart(fd
, host
, port
, call
);
895 commConnectDnsHandle(const ipcache_addrs
*ia
, const DnsLookupDetails
&details
, void *data
)
897 ConnectStateData
*cs
= (ConnectStateData
*)data
;
901 debugs(5, 3, "commConnectDnsHandle: Unknown host: " << cs
->host
);
902 cs
->callCallback(COMM_ERR_DNS
, 0);
906 assert(ia
->cur
< ia
->count
);
908 cs
->default_addr
= ia
->in_addrs
[ia
->cur
];
910 if (Config
.onoff
.balance_on_multiple_ip
)
911 ipcacheCycleAddr(cs
->host
, NULL
);
913 cs
->addrcount
= ia
->count
;
915 cs
->connstart
= squid_curtime
;
921 ConnectStateData::callCallback(comm_err_t status
, int xerrno
)
923 debugs(5, 3, "commConnectCallback: FD " << fd
);
925 comm_remove_close_handler(fd
, commConnectFree
, this);
926 commSetTimeout(fd
, -1, NULL
, NULL
);
928 typedef CommConnectCbParams Params
;
929 Params
¶ms
= GetCommParams
<Params
>(callback
);
932 params
.flag
= status
;
933 params
.xerrno
= xerrno
;
934 ScheduleCallHere(callback
);
937 commConnectFree(fd
, this);
941 commConnectFree(int fd
, void *data
)
943 ConnectStateData
*cs
= (ConnectStateData
*)data
;
944 debugs(5, 3, "commConnectFree: FD " << fd
);
945 // delete cs->callback;
952 copyFDFlags(int to
, fde
*F
)
954 if (F
->flags
.close_on_exec
)
955 commSetCloseOnExec(to
);
957 if (F
->flags
.nonblocking
)
958 commSetNonBlocking(to
);
962 if (F
->flags
.nodelay
)
963 commSetTcpNoDelay(to
);
967 if (Config
.tcpRcvBufsz
> 0)
968 commSetTcpRcvbuf(to
, Config
.tcpRcvBufsz
);
971 /* Reset FD so that we can connect() again */
973 ConnectStateData::commResetFD()
975 struct addrinfo
*AI
= NULL
;
977 int new_family
= AF_UNSPEC
;
979 // XXX: do we have to check this?
981 // if (!cbdataReferenceValid(callback.data))
984 statCounter
.syscalls
.sock
.sockets
++;
986 /* setup a bare-bones addrinfo */
987 /* TODO INET6: for WinXP we may need to check the local_addr type and setup the family properly. */
989 new_family
= AI
->ai_family
;
991 int fd2
= socket(AI
->ai_family
, AI
->ai_socktype
, AI
->ai_protocol
);
993 nul
.FreeAddrInfo(AI
);
996 debugs(5, DBG_CRITICAL
, HERE
<< "WARNING: FD " << fd2
<< " socket failed to allocate: " << xstrerror());
998 if (ENFILE
== errno
|| EMFILE
== errno
)
1004 #ifdef _SQUID_MSWIN_
1006 /* On Windows dup2() can't work correctly on Sockets, the */
1007 /* workaround is to close the destination Socket before call them. */
1012 if (dup2(fd2
, fd
) < 0) {
1013 debugs(5, DBG_CRITICAL
, HERE
<< "WARNING: dup2(FD " << fd2
<< ", FD " << fd
<< ") failed: " << xstrerror());
1015 if (ENFILE
== errno
|| EMFILE
== errno
)
1022 commResetSelect(fd
);
1025 fde
*F
= &fd_table
[fd
];
1027 debugs(50, 3, "commResetFD: Reset socket FD " << fd
<< "->" << fd2
<< " : family=" << new_family
);
1029 /* INET6: copy the new sockets family type to the FDE table */
1030 fd_table
[fd
].sock_family
= new_family
;
1032 fd_table
[fd
].flags
.called_connect
= 0;
1034 * yuck, this has assumptions about comm_open() arguments for
1035 * the original socket
1038 /* MUST be done before binding or face OS Error: "(99) Cannot assign requested address"... */
1039 if ( F
->flags
.transparent
) {
1040 comm_set_transparent(fd
);
1044 F
->local_addr
.GetAddrInfo(AI
);
1046 if (commBind(fd
, *AI
) != COMM_OK
) {
1047 debugs(5, DBG_CRITICAL
, "WARNING: Reset of FD " << fd
<< " for " << F
->local_addr
<< " failed to bind: " << xstrerror());
1048 F
->local_addr
.FreeAddrInfo(AI
);
1051 F
->local_addr
.FreeAddrInfo(AI
);
1054 comm_set_tos(fd
, F
->tos
);
1056 #if IPV6_SPECIAL_SPLITSTACK
1057 if ( F
->local_addr
.IsIPv6() )
1058 comm_set_v6only(fd
, 1);
1067 ConnectStateData::commRetryConnect()
1069 assert(addrcount
> 0);
1071 if (addrcount
== 1) {
1072 if (tries
>= Config
.retry
.maxtries
)
1075 if (squid_curtime
- connstart
> Config
.Timeout
.connect
)
1078 if (tries
> addrcount
)
1082 return commResetFD();
1086 commReconnect(void *data
)
1088 ConnectStateData
*cs
= (ConnectStateData
*)data
;
1089 ipcache_nbgethostbyname(cs
->host
, commConnectDnsHandle
, cs
);
1092 /** Connect SOCK to specified DEST_PORT at DEST_HOST. */
1094 ConnectStateData::Connect(int fd
, void *me
)
1096 ConnectStateData
*cs
= (ConnectStateData
*)me
;
1097 assert (cs
->fd
== fd
);
1102 ConnectStateData::defaults()
1105 S
.SetPort(default_port
);
1109 ConnectStateData::connect()
1114 debugs(5,5, HERE
<< "to " << S
);
1116 switch (comm_connect_addr(fd
, S
) ) {
1118 case COMM_INPROGRESS
:
1119 debugs(5, 5, HERE
<< "FD " << fd
<< ": COMM_INPROGRESS");
1120 commSetSelect(fd
, COMM_SELECT_WRITE
, ConnectStateData::Connect
, this, 0);
1124 debugs(5, 5, HERE
<< "FD " << fd
<< ": COMM_OK - connected");
1125 ipcacheMarkGoodAddr(host
, S
);
1126 callCallback(COMM_OK
, 0);
1130 case COMM_ERR_PROTOCOL
:
1131 /* problem using the desired protocol over this socket.
1132 * count the connection attempt, reset the socket, and immediately try again */
1140 debugs(5, 5, HERE
"FD " << fd
<< ": * - try again");
1142 ipcacheMarkBadAddr(host
, S
);
1145 if (Config
.onoff
.test_reachability
)
1146 netdbDeleteAddrNetwork(S
);
1149 if (commRetryConnect()) {
1150 eventAdd("commReconnect", commReconnect
, this, this->addrcount
== 1 ? 0.05 : 0.0, 0);
1152 debugs(5, 5, HERE
<< "FD " << fd
<< ": * - ERR tried too many times already.");
1153 callCallback(COMM_ERR_CONNECT
, errno
);
1159 commSetTimeout_old(int fd, int timeout, PF * handler, void *data)
1161 debugs(5, 3, HERE << "FD " << fd << " timeout " << timeout);
1163 assert(fd < Squid_MaxFD);
1164 fde *F = &fd_table[fd];
1165 assert(F->flags.open);
1168 cbdataReferenceDone(F->timeout_data);
1169 F->timeout_handler = NULL;
1173 cbdataReferenceDone(F->timeout_data);
1174 F->timeout_handler = handler;
1175 F->timeout_data = cbdataReference(data);
1178 F->timeout = squid_curtime + (time_t) timeout;
1186 commSetTimeout(int fd
, int timeout
, PF
* handler
, void *data
)
1188 AsyncCall::Pointer call
;
1189 debugs(5, 3, HERE
<< "FD " << fd
<< " timeout " << timeout
);
1190 if (handler
!= NULL
)
1191 call
=commCbCall(5,4, "SomeTimeoutHandler", CommTimeoutCbPtrFun(handler
, data
));
1194 return commSetTimeout(fd
, timeout
, call
);
1198 int commSetTimeout(int fd
, int timeout
, AsyncCall::Pointer
&callback
)
1200 debugs(5, 3, HERE
<< "FD " << fd
<< " timeout " << timeout
);
1202 assert(fd
< Squid_MaxFD
);
1203 fde
*F
= &fd_table
[fd
];
1204 assert(F
->flags
.open
);
1207 F
->timeoutHandler
= NULL
;
1210 if (callback
!= NULL
) {
1211 typedef CommTimeoutCbParams Params
;
1212 Params
¶ms
= GetCommParams
<Params
>(callback
);
1214 F
->timeoutHandler
= callback
;
1217 F
->timeout
= squid_curtime
+ (time_t) timeout
;
1225 comm_connect_addr(int sock
, const IpAddress
&address
)
1227 comm_err_t status
= COMM_OK
;
1228 fde
*F
= &fd_table
[sock
];
1232 struct addrinfo
*AI
= NULL
;
1233 PROF_start(comm_connect_addr
);
1235 assert(address
.GetPort() != 0);
1237 debugs(5, 9, "comm_connect_addr: connecting socket " << sock
<< " to " << address
<< " (want family: " << F
->sock_family
<< ")");
1239 /* BUG 2222 FIX: reset the FD when its found to be IPv4 in IPv6 mode */
1240 /* inverse case of IPv4 failing to connect on IPv6 socket is handeld post-connect.
1241 * this case must presently be handled here since the GetAddrInfo asserts on bad mappings.
1242 * eventually we want it to throw a Must() that gets handled there instead of this if.
1243 * NP: because commresetFD is private to ConnStateData we have to return an error and
1244 * trust its handled properly.
1247 if (F
->sock_family
== AF_INET
&& !address
.IsIPv4()) {
1248 return COMM_ERR_PROTOCOL
;
1252 address
.GetAddrInfo(AI
, F
->sock_family
);
1254 /* Establish connection. */
1257 if (!F
->flags
.called_connect
) {
1258 F
->flags
.called_connect
= 1;
1259 statCounter
.syscalls
.sock
.connects
++;
1261 x
= connect(sock
, AI
->ai_addr
, AI
->ai_addrlen
);
1263 // XXX: ICAP code refuses callbacks during a pending comm_ call
1264 // Async calls development will fix this.
1267 errno
= EINPROGRESS
;
1271 debugs(5,5, "comm_connect_addr: sock=" << sock
<< ", addrinfo( " <<
1272 " flags=" << AI
->ai_flags
<<
1273 ", family=" << AI
->ai_family
<<
1274 ", socktype=" << AI
->ai_socktype
<<
1275 ", protocol=" << AI
->ai_protocol
<<
1276 ", &addr=" << AI
->ai_addr
<<
1277 ", addrlen=" << AI
->ai_addrlen
<<
1279 debugs(5, 9, "connect FD " << sock
<< ": (" << x
<< ") " << xstrerror());
1280 debugs(14,9, "connecting to: " << address
);
1283 #if defined(_SQUID_NEWSOS6_)
1284 /* Makoto MATSUSHITA <matusita@ics.es.osaka-u.ac.jp> */
1286 connect(sock
, AI
->ai_addr
, AI
->ai_addrlen
);
1288 if (errno
== EINVAL
) {
1289 errlen
= sizeof(err
);
1290 x
= getsockopt(sock
, SOL_SOCKET
, SO_ERROR
, &err
, &errlen
);
1297 errlen
= sizeof(err
);
1299 x
= getsockopt(sock
, SOL_SOCKET
, SO_ERROR
, &err
, &errlen
);
1304 #if defined(_SQUID_SOLARIS_)
1306 * Solaris 2.4's socket emulation doesn't allow you
1307 * to determine the error from a failed non-blocking
1308 * connect and just returns EPIPE. Create a fake
1309 * error message for connect. -- fenner@parc.xerox.com
1311 if (x
< 0 && errno
== EPIPE
)
1319 /* Squid seems to be working fine without this code. With this code,
1320 * we leak memory on many connect requests because of EINPROGRESS.
1321 * If you find that this code is needed, please file a bug report. */
1323 #ifdef _SQUID_LINUX_
1325 * Linux Debian replaces our allocated AI pointer with garbage when
1326 * connect() fails. This leads to segmentation faults deallocating
1327 * the system-allocated memory when we go to clean up our pointer.
1328 * HACK: is to leak the memory returned since we can't deallocate.
1336 address
.FreeAddrInfo(AI
);
1338 PROF_stop(comm_connect_addr
);
1340 if (errno
== 0 || errno
== EISCONN
)
1342 else if (ignoreErrno(errno
))
1343 status
= COMM_INPROGRESS
;
1346 if ( F
->sock_family
== AF_INET6
&& address
.IsIPv4() ) {
1348 /* failover to trying IPv4-only link if an IPv6 one fails */
1349 /* to catch the edge case of apps listening on IPv4-localhost */
1350 F
->sock_family
= AF_INET
;
1351 int res
= comm_connect_addr(sock
, address
);
1353 /* if that fails too, undo our temporary socktype hack so the repeat works properly. */
1354 if (res
== COMM_ERROR
)
1355 F
->sock_family
= AF_INET6
;
1362 address
.NtoA(F
->ipaddr
, MAX_IPSTRLEN
);
1364 F
->remote_port
= address
.GetPort(); /* remote_port is HS */
1366 if (status
== COMM_OK
) {
1367 debugs(5, 10, "comm_connect_addr: FD " << sock
<< " connected to " << address
);
1368 } else if (status
== COMM_INPROGRESS
) {
1369 debugs(5, 10, "comm_connect_addr: FD " << sock
<< " connection pending");
1375 /* Wait for an incoming connection on FD. FD should be a socket returned
1376 * from comm_listen. */
1378 comm_old_accept(int fd
, ConnectionDetail
&details
)
1380 PROF_start(comm_accept
);
1381 statCounter
.syscalls
.sock
.accepts
++;
1383 struct addrinfo
*gai
= NULL
;
1384 details
.me
.InitAddrInfo(gai
);
1386 if ((sock
= accept(fd
, gai
->ai_addr
, &gai
->ai_addrlen
)) < 0) {
1388 details
.me
.FreeAddrInfo(gai
);
1390 PROF_stop(comm_accept
);
1392 if (ignoreErrno(errno
)) {
1393 debugs(50, 5, "comm_old_accept: FD " << fd
<< ": " << xstrerror());
1394 return COMM_NOMESSAGE
;
1395 } else if (ENFILE
== errno
|| EMFILE
== errno
) {
1396 debugs(50, 3, "comm_old_accept: FD " << fd
<< ": " << xstrerror());
1399 debugs(50, 1, "comm_old_accept: FD " << fd
<< ": " << xstrerror());
1404 details
.peer
= *gai
;
1406 details
.me
.InitAddrInfo(gai
);
1408 details
.me
.SetEmpty();
1409 getsockname(sock
, gai
->ai_addr
, &gai
->ai_addrlen
);
1412 commSetCloseOnExec(sock
);
1415 fd_open(sock
, FD_SOCKET
, "HTTP Request");
1416 fdd_table
[sock
].close_file
= NULL
;
1417 fdd_table
[sock
].close_line
= 0;
1418 fde
*F
= &fd_table
[sock
];
1419 details
.peer
.NtoA(F
->ipaddr
,MAX_IPSTRLEN
);
1420 F
->remote_port
= details
.peer
.GetPort();
1421 F
->local_addr
.SetPort(details
.me
.GetPort());
1423 F
->sock_family
= AF_INET
;
1425 F
->sock_family
= details
.me
.IsIPv4()?AF_INET
:AF_INET6
;
1427 details
.me
.FreeAddrInfo(gai
);
1429 commSetNonBlocking(sock
);
1431 /* IFF the socket is (tproxy) transparent, pass the flag down to allow spoofing */
1432 F
->flags
.transparent
= fd_table
[fd
].flags
.transparent
;
1434 PROF_stop(comm_accept
);
1439 commCallCloseHandlers(int fd
)
1441 fde
*F
= &fd_table
[fd
];
1442 debugs(5, 5, "commCallCloseHandlers: FD " << fd
);
1444 while (F
->closeHandler
!= NULL
) {
1445 AsyncCall::Pointer call
= F
->closeHandler
;
1446 F
->closeHandler
= call
->Next();
1447 call
->setNext(NULL
);
1448 // If call is not canceled schedule it for execution else ignore it
1449 if (!call
->canceled()) {
1450 debugs(5, 5, "commCallCloseHandlers: ch->handler=" << call
);
1451 typedef CommCloseCbParams Params
;
1452 Params
¶ms
= GetCommParams
<Params
>(call
);
1454 ScheduleCallHere(call
);
1461 commLingerClose(int fd
, void *unused
)
1463 LOCAL_ARRAY(char, buf
, 1024);
1465 n
= FD_READ_METHOD(fd
, buf
, 1024);
1468 debugs(5, 3, "commLingerClose: FD " << fd
<< " read: " << xstrerror());
1474 commLingerTimeout(int fd
, void *unused
)
1476 debugs(5, 3, "commLingerTimeout: FD " << fd
);
1481 * Inspired by apache
1484 comm_lingering_close(int fd
)
1488 if (fd_table
[fd
].ssl
)
1489 ssl_shutdown_method(fd
);
1493 if (shutdown(fd
, 1) < 0) {
1498 fd_note(fd
, "lingering close");
1499 commSetTimeout(fd
, 10, commLingerTimeout
, NULL
);
1500 commSetSelect(fd
, COMM_SELECT_READ
, commLingerClose
, NULL
, 0);
1506 * enable linger with time of 0 so that when the socket is
1507 * closed, TCP generates a RESET
1510 comm_reset_close(int fd
)
1517 if (setsockopt(fd
, SOL_SOCKET
, SO_LINGER
, (char *) &L
, sizeof(L
)) < 0)
1518 debugs(50, 0, "commResetTCPClose: FD " << fd
<< ": " << xstrerror());
1524 comm_close_start(int fd
, void *data
)
1527 fde
*F
= &fd_table
[fd
];
1529 ssl_shutdown_method(fd
);
1537 comm_close_complete(int fd
, void *data
)
1540 fde
*F
= &fd_table
[fd
];
1548 fd_close(fd
); /* update fdstat */
1552 fdc_table
[fd
] = AcceptFD(fd
);
1554 statCounter
.syscalls
.sock
.closes
++;
1556 /* When an fd closes, give accept() a chance, if need be */
1558 if (fdNFree() >= RESERVED_FD
)
1559 AcceptLimiter::Instance().kick();
1564 * Close the socket fd.
1566 * + call write handlers with ERR_CLOSING
1567 * + call read handlers with ERR_CLOSING
1568 * + call closing handlers
1570 * NOTE: COMM_ERR_CLOSING will NOT be called for CommReads' sitting in a
1571 * DeferredReadManager.
1574 _comm_close(int fd
, char const *file
, int line
)
1576 debugs(5, 3, "comm_close: start closing FD " << fd
);
1578 assert(fd
< Squid_MaxFD
);
1580 fde
*F
= &fd_table
[fd
];
1581 fdd_table
[fd
].close_file
= file
;
1582 fdd_table
[fd
].close_line
= line
;
1587 /* XXX: is this obsolete behind F->closing() ? */
1588 if ( (shutting_down
|| reconfiguring
) && (!F
->flags
.open
|| F
->type
== FD_FILE
))
1591 /* The following fails because ipc.c is doing calls to pipe() to create sockets! */
1594 assert(F
->type
!= FD_FILE
);
1596 PROF_start(comm_close
);
1598 F
->flags
.close_request
= 1;
1600 AsyncCall::Pointer startCall
=commCbCall(5,4, "comm_close_start",
1601 CommCloseCbPtrFun(comm_close_start
, NULL
));
1602 typedef CommCloseCbParams Params
;
1603 Params
&startParams
= GetCommParams
<Params
>(startCall
);
1604 startParams
.fd
= fd
;
1605 ScheduleCallHere(startCall
);
1607 // a half-closed fd may lack a reader, so we stop monitoring explicitly
1608 if (commHasHalfClosedMonitor(fd
))
1609 commStopHalfClosedMonitor(fd
);
1610 commSetTimeout(fd
, -1, NULL
, NULL
);
1612 // notify read/write handlers
1613 if (commio_has_callback(fd
, IOCB_WRITE
, COMMIO_FD_WRITECB(fd
))) {
1614 commio_finish_callback(fd
, COMMIO_FD_WRITECB(fd
), COMM_ERR_CLOSING
, errno
);
1616 if (commio_has_callback(fd
, IOCB_READ
, COMMIO_FD_READCB(fd
))) {
1617 commio_finish_callback(fd
, COMMIO_FD_READCB(fd
), COMM_ERR_CLOSING
, errno
);
1620 // notify accept handlers
1621 fdc_table
[fd
].notify(-1, COMM_ERR_CLOSING
, 0, ConnectionDetail());
1623 commCallCloseHandlers(fd
);
1626 F
->pconn
.pool
->count(F
->pconn
.uses
);
1628 comm_empty_os_read_buffers(fd
);
1631 AsyncCall::Pointer completeCall
=commCbCall(5,4, "comm_close_complete",
1632 CommCloseCbPtrFun(comm_close_complete
, NULL
));
1633 Params
&completeParams
= GetCommParams
<Params
>(completeCall
);
1634 completeParams
.fd
= fd
;
1635 // must use async call to wait for all callbacks
1636 // scheduled before comm_close() to finish
1637 ScheduleCallHere(completeCall
);
1639 PROF_stop(comm_close
);
1642 /* Send a udp datagram to specified TO_ADDR. */
1644 comm_udp_sendto(int fd
,
1645 const IpAddress
&to_addr
,
1650 struct addrinfo
*AI
= NULL
;
1652 PROF_start(comm_udp_sendto
);
1653 statCounter
.syscalls
.sock
.sendtos
++;
1655 debugs(50, 3, "comm_udp_sendto: Attempt to send UDP packet to " << to_addr
<<
1656 " using FD " << fd
<< " using Port " << comm_local_port(fd
) );
1658 /* BUG: something in the above macro appears to occasionally be setting AI to garbage. */
1659 /* AYJ: 2007-08-27 : or was it because I wasn't then setting 'fd_table[fd].sock_family' to fill properly. */
1660 assert( NULL
== AI
);
1662 to_addr
.GetAddrInfo(AI
, fd_table
[fd
].sock_family
);
1664 x
= sendto(fd
, buf
, len
, 0, AI
->ai_addr
, AI
->ai_addrlen
);
1666 to_addr
.FreeAddrInfo(AI
);
1668 PROF_stop(comm_udp_sendto
);
1673 #ifdef _SQUID_LINUX_
1675 if (ECONNREFUSED
!= errno
)
1678 debugs(50, 1, "comm_udp_sendto: FD " << fd
<< ", (family=" << fd_table
[fd
].sock_family
<< ") " << to_addr
<< ": " << xstrerror());
1684 comm_add_close_handler(int fd
, PF
* handler
, void *data
)
1686 debugs(5, 5, "comm_add_close_handler: FD " << fd
<< ", handler=" <<
1687 handler
<< ", data=" << data
);
1689 AsyncCall::Pointer call
=commCbCall(5,4, "SomeCloseHandler",
1690 CommCloseCbPtrFun(handler
, data
));
1691 comm_add_close_handler(fd
, call
);
1695 comm_add_close_handler(int fd
, AsyncCall::Pointer
&call
)
1697 debugs(5, 5, "comm_add_close_handler: FD " << fd
<< ", AsyncCall=" << call
);
1699 /*TODO:Check for a similar scheduled AsyncCall*/
1700 // for (c = fd_table[fd].closeHandler; c; c = c->next)
1701 // assert(c->handler != handler || c->data != data);
1703 call
->setNext(fd_table
[fd
].closeHandler
);
1705 fd_table
[fd
].closeHandler
= call
;
1709 // remove function-based close handler
1711 comm_remove_close_handler(int fd
, PF
* handler
, void *data
)
1713 assert (isOpen(fd
));
1714 /* Find handler in list */
1715 debugs(5, 5, "comm_remove_close_handler: FD " << fd
<< ", handler=" <<
1716 handler
<< ", data=" << data
);
1718 AsyncCall::Pointer p
;
1719 for (p
= fd_table
[fd
].closeHandler
; p
!= NULL
; p
= p
->Next()) {
1720 typedef CommCbFunPtrCallT
<CommCloseCbPtrFun
> Call
;
1721 const Call
*call
= dynamic_cast<const Call
*>(p
.getRaw());
1722 if (!call
) // method callbacks have their own comm_remove_close_handler
1725 typedef CommCloseCbParams Params
;
1726 const Params
¶ms
= GetCommParams
<Params
>(p
);
1727 if (call
->dialer
.handler
== handler
&& params
.data
== data
)
1728 break; /* This is our handler */
1731 // comm_close removes all close handlers so our handler may be gone
1733 p
->cancel("comm_remove_close_handler");
1734 // TODO: should we remove the handler from the close handlers list?
1737 // remove method-based close handler
1739 comm_remove_close_handler(int fd
, AsyncCall::Pointer
&call
)
1741 assert (isOpen(fd
));
1742 debugs(5, 5, "comm_remove_close_handler: FD " << fd
<< ", AsyncCall=" << call
);
1744 // comm_close removes all close handlers so our handler may be gone
1745 // TODO: should we remove the handler from the close handlers list?
1747 // Check to see if really exist the given AsyncCall in comm_close handlers
1748 // TODO: optimize: this slow code is only needed for the assert() below
1749 AsyncCall::Pointer p
;
1750 for (p
= fd_table
[fd
].closeHandler
; p
!= NULL
&& p
!= call
; p
= p
->Next());
1754 call
->cancel("comm_remove_close_handler");
1758 commSetNoLinger(int fd
)
1762 L
.l_onoff
= 0; /* off */
1765 if (setsockopt(fd
, SOL_SOCKET
, SO_LINGER
, (char *) &L
, sizeof(L
)) < 0)
1766 debugs(50, 0, "commSetNoLinger: FD " << fd
<< ": " << xstrerror());
1768 fd_table
[fd
].flags
.nolinger
= 1;
1772 commSetReuseAddr(int fd
)
1776 if (setsockopt(fd
, SOL_SOCKET
, SO_REUSEADDR
, (char *) &on
, sizeof(on
)) < 0)
1777 debugs(50, 1, "commSetReuseAddr: FD " << fd
<< ": " << xstrerror());
1781 commSetTcpRcvbuf(int fd
, int size
)
1783 if (setsockopt(fd
, SOL_SOCKET
, SO_RCVBUF
, (char *) &size
, sizeof(size
)) < 0)
1784 debugs(50, 1, "commSetTcpRcvbuf: FD " << fd
<< ", SIZE " << size
<< ": " << xstrerror());
1785 if (setsockopt(fd
, SOL_SOCKET
, SO_SNDBUF
, (char *) &size
, sizeof(size
)) < 0)
1786 debugs(50, 1, "commSetTcpRcvbuf: FD " << fd
<< ", SIZE " << size
<< ": " << xstrerror());
1787 #ifdef TCP_WINDOW_CLAMP
1788 if (setsockopt(fd
, SOL_TCP
, TCP_WINDOW_CLAMP
, (char *) &size
, sizeof(size
)) < 0)
1789 debugs(50, 1, "commSetTcpRcvbuf: FD " << fd
<< ", SIZE " << size
<< ": " << xstrerror());
1794 commSetNonBlocking(int fd
)
1796 #ifndef _SQUID_MSWIN_
1800 #ifdef _SQUID_WIN32_
1802 int nonblocking
= TRUE
;
1804 #ifdef _SQUID_CYGWIN_
1806 if (fd_table
[fd
].type
!= FD_PIPE
) {
1809 if (ioctl(fd
, FIONBIO
, &nonblocking
) < 0) {
1810 debugs(50, 0, "commSetNonBlocking: FD " << fd
<< ": " << xstrerror() << " " << fd_table
[fd
].type
);
1814 #ifdef _SQUID_CYGWIN_
1819 #ifndef _SQUID_MSWIN_
1821 if ((flags
= fcntl(fd
, F_GETFL
, dummy
)) < 0) {
1822 debugs(50, 0, "FD " << fd
<< ": fcntl F_GETFL: " << xstrerror());
1826 if (fcntl(fd
, F_SETFL
, flags
| SQUID_NONBLOCK
) < 0) {
1827 debugs(50, 0, "commSetNonBlocking: FD " << fd
<< ": " << xstrerror());
1832 #ifdef _SQUID_CYGWIN_
1837 fd_table
[fd
].flags
.nonblocking
= 1;
1843 commUnsetNonBlocking(int fd
)
1845 #ifdef _SQUID_MSWIN_
1846 int nonblocking
= FALSE
;
1848 if (ioctlsocket(fd
, FIONBIO
, (unsigned long *) &nonblocking
) < 0) {
1853 if ((flags
= fcntl(fd
, F_GETFL
, dummy
)) < 0) {
1854 debugs(50, 0, "FD " << fd
<< ": fcntl F_GETFL: " << xstrerror());
1858 if (fcntl(fd
, F_SETFL
, flags
& (~SQUID_NONBLOCK
)) < 0) {
1860 debugs(50, 0, "commUnsetNonBlocking: FD " << fd
<< ": " << xstrerror());
1864 fd_table
[fd
].flags
.nonblocking
= 0;
1869 commSetCloseOnExec(int fd
)
1875 if ((flags
= fcntl(fd
, F_GETFL
, dummy
)) < 0) {
1876 debugs(50, 0, "FD " << fd
<< ": fcntl F_GETFL: " << xstrerror());
1880 if (fcntl(fd
, F_SETFD
, flags
| FD_CLOEXEC
) < 0)
1881 debugs(50, 0, "FD " << fd
<< ": set close-on-exec failed: " << xstrerror());
1883 fd_table
[fd
].flags
.close_on_exec
= 1;
1890 commSetTcpNoDelay(int fd
)
1894 if (setsockopt(fd
, IPPROTO_TCP
, TCP_NODELAY
, (char *) &on
, sizeof(on
)) < 0)
1895 debugs(50, 1, "commSetTcpNoDelay: FD " << fd
<< ": " << xstrerror());
1897 fd_table
[fd
].flags
.nodelay
= 1;
1903 commSetTcpKeepalive(int fd
, int idle
, int interval
, int timeout
)
1907 if (timeout
&& interval
) {
1908 int count
= (timeout
+ interval
- 1) / interval
;
1909 if (setsockopt(fd
, IPPROTO_TCP
, TCP_KEEPCNT
, &count
, sizeof(on
)) < 0)
1910 debugs(5, 1, "commSetKeepalive: FD " << fd
<< ": " << xstrerror());
1915 if (setsockopt(fd
, IPPROTO_TCP
, TCP_KEEPIDLE
, &idle
, sizeof(on
)) < 0)
1916 debugs(5, 1, "commSetKeepalive: FD " << fd
<< ": " << xstrerror());
1919 #ifdef TCP_KEEPINTVL
1921 if (setsockopt(fd
, IPPROTO_TCP
, TCP_KEEPINTVL
, &interval
, sizeof(on
)) < 0)
1922 debugs(5, 1, "commSetKeepalive: FD " << fd
<< ": " << xstrerror());
1925 if (setsockopt(fd
, SOL_SOCKET
, SO_KEEPALIVE
, (char *) &on
, sizeof(on
)) < 0)
1926 debugs(5, 1, "commSetKeepalive: FD " << fd
<< ": " << xstrerror());
1932 fd_table
=(fde
*) xcalloc(Squid_MaxFD
, sizeof(fde
));
1933 fdd_table
= (fd_debug_t
*)xcalloc(Squid_MaxFD
, sizeof(fd_debug_t
));
1935 fdc_table
= new AcceptFD
[Squid_MaxFD
];
1936 for (int pos
= 0; pos
< Squid_MaxFD
; ++pos
) {
1937 fdc_table
[pos
] = AcceptFD(pos
);
1940 commfd_table
= (comm_fd_t
*) xcalloc(Squid_MaxFD
, sizeof(comm_fd_t
));
1941 for (int pos
= 0; pos
< Squid_MaxFD
; pos
++) {
1942 commfd_table
[pos
].fd
= pos
;
1943 commfd_table
[pos
].readcb
.fd
= pos
;
1944 commfd_table
[pos
].readcb
.type
= IOCB_READ
;
1945 commfd_table
[pos
].writecb
.fd
= pos
;
1946 commfd_table
[pos
].writecb
.type
= IOCB_WRITE
;
1949 /* XXX account fd_table */
1950 /* Keep a few file descriptors free so that we don't run out of FD's
1951 * after accepting a client but before it opens a socket or a file.
1952 * Since Squid_MaxFD can be as high as several thousand, don't waste them */
1953 RESERVED_FD
= min(100, Squid_MaxFD
/ 4);
1955 conn_close_pool
= memPoolCreate("close_handler", sizeof(close_handler
));
1957 TheHalfClosed
= new DescriptorSet
;
1963 delete TheHalfClosed
;
1964 TheHalfClosed
= NULL
;
1966 safe_free(fd_table
);
1967 safe_free(fdd_table
);
1972 safe_free(commfd_table
);
1977 commHandleWrite(int fd
, void *data
)
1979 comm_io_callback_t
*state
= (comm_io_callback_t
*)data
;
1983 assert(state
== COMMIO_FD_WRITECB(fd
));
1985 PROF_start(commHandleWrite
);
1986 debugs(5, 5, "commHandleWrite: FD " << fd
<< ": off " <<
1987 (long int) state
->offset
<< ", sz " << (long int) state
->size
<< ".");
1989 nleft
= state
->size
- state
->offset
;
1990 len
= FD_WRITE_METHOD(fd
, state
->buf
+ state
->offset
, nleft
);
1991 debugs(5, 5, "commHandleWrite: write() returns " << len
);
1992 fd_bytes(fd
, len
, FD_WRITE
);
1993 statCounter
.syscalls
.sock
.writes
++;
1994 // After each successful partial write,
1995 // reset fde::writeStart to the current time.
1996 fd_table
[fd
].writeStart
= squid_curtime
;
1999 /* Note we even call write if nleft == 0 */
2003 debugs(5, 1, "commHandleWrite: FD " << fd
<< ": write failure: connection closed with " << nleft
<< " bytes remaining.");
2005 commio_finish_callback(fd
, COMMIO_FD_WRITECB(fd
), nleft
? COMM_ERROR
: COMM_OK
, errno
);
2006 } else if (len
< 0) {
2009 if (fd_table
[fd
].flags
.socket_eof
) {
2010 debugs(50, 2, "commHandleWrite: FD " << fd
<< ": write failure: " << xstrerror() << ".");
2011 commio_finish_callback(fd
, COMMIO_FD_WRITECB(fd
), nleft
? COMM_ERROR
: COMM_OK
, errno
);
2012 } else if (ignoreErrno(errno
)) {
2013 debugs(50, 10, "commHandleWrite: FD " << fd
<< ": write failure: " << xstrerror() << ".");
2020 debugs(50, 2, "commHandleWrite: FD " << fd
<< ": write failure: " << xstrerror() << ".");
2021 commio_finish_callback(fd
, COMMIO_FD_WRITECB(fd
), nleft
? COMM_ERROR
: COMM_OK
, errno
);
2024 /* A successful write, continue */
2025 state
->offset
+= len
;
2027 if (state
->offset
< state
->size
) {
2028 /* Not done, reinstall the write handler and write some more */
2035 commio_finish_callback(fd
, COMMIO_FD_WRITECB(fd
), nleft
? COMM_OK
: COMM_ERROR
, errno
);
2039 PROF_stop(commHandleWrite
);
2043 * Queue a write. handler/handler_data are called when the write
2044 * completes, on error, or on file descriptor close.
2046 * free_func is used to free the passed buffer when the write has completed.
2049 comm_write(int fd
, const char *buf
, int size
, IOCB
* handler
, void *handler_data
, FREE
* free_func
)
2051 AsyncCall::Pointer call
= commCbCall(5,5, "SomeCommWriteHander",
2052 CommIoCbPtrFun(handler
, handler_data
));
2054 comm_write(fd
, buf
, size
, call
, free_func
);
2058 comm_write(int fd
, const char *buf
, int size
, AsyncCall::Pointer
&callback
, FREE
* free_func
)
2060 debugs(5, 5, "comm_write: FD " << fd
<< ": sz " << size
<< ": asynCall " << callback
);
2062 /* Make sure we are open, not closing, and not writing */
2064 assert(!fd_table
[fd
].closing());
2065 comm_io_callback_t
*ccb
= COMMIO_FD_WRITECB(fd
);
2066 assert(!ccb
->active());
2068 fd_table
[fd
].writeStart
= squid_curtime
;
2069 /* Queue the write */
2070 commio_set_callback(fd
, IOCB_WRITE
, ccb
, callback
,
2071 (char *)buf
, free_func
, size
);
2072 commSetSelect(fd
, COMM_SELECT_WRITE
, commHandleWrite
, ccb
, 0);
2076 /* a wrapper around comm_write to allow for MemBuf to be comm_written in a snap */
2078 comm_write_mbuf(int fd
, MemBuf
*mb
, IOCB
* handler
, void *handler_data
)
2080 comm_write(fd
, mb
->buf
, mb
->size
, handler
, handler_data
, mb
->freeFunc());
2084 comm_write_mbuf(int fd
, MemBuf
*mb
, AsyncCall::Pointer
&callback
)
2086 comm_write(fd
, mb
->buf
, mb
->size
, callback
, mb
->freeFunc());
2091 * hm, this might be too general-purpose for all the places we'd
2095 ignoreErrno(int ierrno
)
2102 #if EAGAIN != EWOULDBLOCK
2125 commCloseAllSockets(void)
2130 for (fd
= 0; fd
<= Biggest_FD
; fd
++) {
2136 if (F
->type
!= FD_SOCKET
)
2139 if (F
->flags
.ipc
) /* don't close inter-process sockets */
2142 if (F
->timeoutHandler
!= NULL
) {
2143 AsyncCall::Pointer callback
= F
->timeoutHandler
;
2144 F
->timeoutHandler
= NULL
;
2145 debugs(5, 5, "commCloseAllSockets: FD " << fd
<< ": Calling timeout handler");
2146 ScheduleCallHere(callback
);
2148 debugs(5, 5, "commCloseAllSockets: FD " << fd
<< ": calling comm_close()");
2155 AlreadyTimedOut(fde
*F
)
2160 if (F
->timeout
== 0)
2163 if (F
->timeout
> squid_curtime
)
2170 writeTimedOut(int fd
)
2172 if (!commio_has_callback(fd
, IOCB_WRITE
, COMMIO_FD_WRITECB(fd
)))
2175 if ((squid_curtime
- fd_table
[fd
].writeStart
) < Config
.Timeout
.write
)
2186 AsyncCall::Pointer callback
;
2188 for (fd
= 0; fd
<= Biggest_FD
; fd
++) {
2191 if (writeTimedOut(fd
)) {
2192 // We have an active write callback and we are timed out
2193 commio_finish_callback(fd
, COMMIO_FD_WRITECB(fd
), COMM_ERROR
, ETIMEDOUT
);
2195 else if (AlreadyTimedOut(F
))
2198 debugs(5, 5, "checkTimeouts: FD " << fd
<< " Expired");
2200 if (F
->timeoutHandler
!= NULL
) {
2201 debugs(5, 5, "checkTimeouts: FD " << fd
<< ": Call timeout handler");
2202 callback
= F
->timeoutHandler
;
2203 F
->timeoutHandler
= NULL
;
2204 ScheduleCallHere(callback
);
2206 debugs(5, 5, "checkTimeouts: FD " << fd
<< ": Forcing comm_close()");
2213 * New-style listen and accept routines
2215 * Listen simply registers our interest in an FD for listening,
2216 * and accept takes a callback to call when an FD has been
2220 comm_listen(int sock
)
2224 if ((x
= listen(sock
, Squid_MaxFD
>> 2)) < 0) {
2225 debugs(50, 0, "comm_listen: listen(" << (Squid_MaxFD
>> 2) << ", " << sock
<< "): " << xstrerror());
2229 if (Config
.accept_filter
&& strcmp(Config
.accept_filter
, "none") != 0) {
2230 #ifdef SO_ACCEPTFILTER
2231 struct accept_filter_arg afa
;
2232 bzero(&afa
, sizeof(afa
));
2233 debugs(5, DBG_CRITICAL
, "Installing accept filter '" << Config
.accept_filter
<< "' on FD " << sock
);
2234 xstrncpy(afa
.af_name
, Config
.accept_filter
, sizeof(afa
.af_name
));
2235 x
= setsockopt(sock
, SOL_SOCKET
, SO_ACCEPTFILTER
, &afa
, sizeof(afa
));
2237 debugs(5, 0, "SO_ACCEPTFILTER '" << Config
.accept_filter
<< "': '" << xstrerror());
2238 #elif defined(TCP_DEFER_ACCEPT)
2240 if (strncmp(Config
.accept_filter
, "data=", 5) == 0)
2241 seconds
= atoi(Config
.accept_filter
+ 5);
2242 x
= setsockopt(sock
, IPPROTO_TCP
, TCP_DEFER_ACCEPT
, &seconds
, sizeof(seconds
));
2244 debugs(5, 0, "TCP_DEFER_ACCEPT '" << Config
.accept_filter
<< "': '" << xstrerror());
2246 debugs(5, 0, "accept_filter not supported on your OS");
2254 comm_accept(int fd
, IOACB
*handler
, void *handler_data
)
2256 debugs(5, 5, "comm_accept: FD " << fd
<< " handler: " << (void*)handler
);
2259 AsyncCall::Pointer call
= commCbCall(5,5, "SomeCommAcceptHandler",
2260 CommAcceptCbPtrFun(handler
, handler_data
));
2261 fdc_table
[fd
].subscribe(call
);
2265 comm_accept(int fd
, AsyncCall::Pointer
&call
)
2267 debugs(5, 5, "comm_accept: FD " << fd
<< " AsyncCall: " << call
);
2270 fdc_table
[fd
].subscribe(call
);
2273 // Called when somebody wants to be notified when our socket accepts new
2274 // connection. We do not probe the FD until there is such interest.
2276 AcceptFD::subscribe(AsyncCall::Pointer
&call
)
2278 /* make sure we're not pending! */
2279 assert(!theCallback
);
2283 mayAcceptMore
= true; // even if we failed to accept last time
2289 commSetSelect(fd
, COMM_SELECT_READ
, comm_accept_try
, NULL
, 0);
2293 AcceptFD::acceptOne()
2295 // If there is no callback and we accept, we will leak the accepted FD.
2296 // When we are running out of FDs, there is often no callback.
2298 debugs(5, 5, "AcceptFD::acceptOne orphaned: FD " << fd
);
2299 // XXX: can we remove this and similar "just in case" calls and
2300 // either listen always or listen only when there is a callback?
2301 if (!AcceptLimiter::Instance().deferring())
2302 commSetSelect(fd
, COMM_SELECT_READ
, comm_accept_try
, NULL
, 0);
2307 * We don't worry about running low on FDs here. Instead,
2308 * httpAccept() will use AcceptLimiter if we reach the limit
2312 /* Accept a new connection */
2313 ConnectionDetail connDetails
;
2314 int newfd
= comm_old_accept(fd
, connDetails
);
2316 /* Check for errors */
2319 assert(theCallback
!= NULL
);
2321 if (newfd
== COMM_NOMESSAGE
) {
2322 /* register interest again */
2323 debugs(5, 5, HERE
<< "try later: FD " << fd
<<
2324 " handler: " << *theCallback
);
2325 commSetSelect(fd
, COMM_SELECT_READ
, comm_accept_try
, NULL
, 0);
2329 // A non-recoverable error; notify the caller */
2330 notify(-1, COMM_ERROR
, errno
, connDetails
);
2334 assert(theCallback
!= NULL
);
2335 debugs(5, 5, "AcceptFD::acceptOne accepted: FD " << fd
<<
2336 " newfd: " << newfd
<< " from: " << connDetails
.peer
<<
2337 " handler: " << *theCallback
);
2338 notify(newfd
, COMM_OK
, 0, connDetails
);
2343 AcceptFD::acceptNext()
2345 mayAcceptMore
= acceptOne();
2349 AcceptFD::notify(int newfd
, comm_err_t errcode
, int xerrno
, const ConnectionDetail
&connDetails
)
2351 if (theCallback
!= NULL
) {
2352 typedef CommAcceptCbParams Params
;
2353 Params
¶ms
= GetCommParams
<Params
>(theCallback
);
2356 params
.details
= connDetails
;
2357 params
.flag
= errcode
;
2358 params
.xerrno
= xerrno
;
2359 ScheduleCallHere(theCallback
);
2365 * This callback is called whenever a filedescriptor is ready
2366 * to dupe itself and fob off an accept()ed connection
2369 comm_accept_try(int fd
, void *)
2372 fdc_table
[fd
].acceptNext();
2375 void CommIO::Initialise()
2377 /* Initialize done pipe signal */
2379 if (pipe(DonePipe
)) {}
2380 DoneFD
= DonePipe
[1];
2381 DoneReadFD
= DonePipe
[0];
2382 fd_open(DoneReadFD
, FD_PIPE
, "async-io completetion event: main");
2383 fd_open(DoneFD
, FD_PIPE
, "async-io completetion event: threads");
2384 commSetNonBlocking(DoneReadFD
);
2385 commSetNonBlocking(DoneFD
);
2386 commSetSelect(DoneReadFD
, COMM_SELECT_READ
, NULLFDHandler
, NULL
, 0);
2390 void CommIO::NotifyIOClose()
2392 /* Close done pipe signal */
2397 fd_close(DoneReadFD
);
2398 Initialised
= false;
2401 bool CommIO::Initialised
= false;
2402 bool CommIO::DoneSignalled
= false;
2403 int CommIO::DoneFD
= -1;
2404 int CommIO::DoneReadFD
= -1;
2410 FD_READ_METHOD(DoneReadFD
, buf
, sizeof(buf
));
2414 CommIO::NULLFDHandler(int fd
, void *data
)
2417 commSetSelect(fd
, COMM_SELECT_READ
, NULLFDHandler
, NULL
, 0);
2421 CommIO::ResetNotifications()
2423 if (DoneSignalled
) {
2425 DoneSignalled
= false;
2429 AcceptLimiter
AcceptLimiter::Instance_
;
2431 AcceptLimiter
&AcceptLimiter::Instance()
2437 AcceptLimiter::deferring() const
2439 return deferred
.size() > 0;
2443 AcceptLimiter::defer (int fd
, Acceptor::AcceptorFunction
*aFunc
, void *data
)
2445 debugs(5, 5, "AcceptLimiter::defer: FD " << fd
<< " handler: " << (void*)aFunc
);
2447 temp
.theFunction
= aFunc
;
2449 temp
.theData
= data
;
2450 deferred
.push_back(temp
);
2454 AcceptLimiter::kick()
2459 /* Yes, this means the first on is the last off....
2460 * If the list container was a little more friendly, we could sensibly us it.
2462 Acceptor temp
= deferred
.pop_back();
2464 comm_accept (temp
.acceptFD
, temp
.theFunction
, temp
.theData
);
2467 /// Start waiting for a possibly half-closed connection to close
2468 // by scheduling a read callback to a monitoring handler that
2469 // will close the connection on read errors.
2471 commStartHalfClosedMonitor(int fd
)
2473 debugs(5, 5, HERE
<< "adding FD " << fd
<< " to " << *TheHalfClosed
);
2475 assert(!commHasHalfClosedMonitor(fd
));
2476 (void)TheHalfClosed
->add(fd
); // could also assert the result
2477 commPlanHalfClosedCheck(); // may schedule check if we added the first FD
2482 commPlanHalfClosedCheck()
2484 if (!WillCheckHalfClosed
&& !TheHalfClosed
->empty()) {
2485 eventAdd("commHalfClosedCheck", &commHalfClosedCheck
, NULL
, 1.0, 1);
2486 WillCheckHalfClosed
= true;
2490 /// iterates over all descriptors that may need half-closed tests and
2491 /// calls comm_read for those that do; re-schedules the check if needed
2494 commHalfClosedCheck(void *)
2496 debugs(5, 5, HERE
<< "checking " << *TheHalfClosed
);
2498 typedef DescriptorSet::const_iterator DSCI
;
2499 const DSCI end
= TheHalfClosed
->end();
2500 for (DSCI i
= TheHalfClosed
->begin(); i
!= end
; ++i
) {
2502 if (!fd_table
[fd
].halfClosedReader
) { // not reading already
2503 AsyncCall::Pointer call
= commCbCall(5,4, "commHalfClosedReader",
2504 CommIoCbPtrFun(&commHalfClosedReader
, NULL
));
2505 comm_read(fd
, NULL
, 0, call
);
2506 fd_table
[fd
].halfClosedReader
= call
;
2510 WillCheckHalfClosed
= false; // as far as we know
2511 commPlanHalfClosedCheck(); // may need to check again
2514 /// checks whether we are waiting for possibly half-closed connection to close
2515 // We are monitoring if the read handler for the fd is the monitoring handler.
2517 commHasHalfClosedMonitor(int fd
)
2519 return TheHalfClosed
->has(fd
);
2522 /// stop waiting for possibly half-closed connection to close
2524 commStopHalfClosedMonitor(int const fd
)
2526 debugs(5, 5, HERE
<< "removing FD " << fd
<< " from " << *TheHalfClosed
);
2528 // cancel the read if one was scheduled
2529 AsyncCall::Pointer reader
= fd_table
[fd
].halfClosedReader
;
2531 comm_read_cancel(fd
, reader
);
2532 fd_table
[fd
].halfClosedReader
= NULL
;
2534 TheHalfClosed
->del(fd
);
2537 /// I/O handler for the possibly half-closed connection monitoring code
2539 commHalfClosedReader(int fd
, char *, size_t size
, comm_err_t flag
, int, void *)
2541 // there cannot be more data coming in on half-closed connections
2543 assert(commHasHalfClosedMonitor(fd
)); // or we would have canceled the read
2545 fd_table
[fd
].halfClosedReader
= NULL
; // done reading, for now
2547 // nothing to do if fd is being closed
2548 if (flag
== COMM_ERR_CLOSING
)
2551 // if read failed, close the connection
2552 if (flag
!= COMM_OK
) {
2553 debugs(5, 3, "commHalfClosedReader: closing FD " << fd
);
2558 // continue waiting for close or error
2559 commPlanHalfClosedCheck(); // make sure this fd will be checked again
2563 CommRead::CommRead() : fd(-1), buf(NULL
), len(0), callback(NULL
) {}
2565 CommRead::CommRead(int fd_
, char *buf_
, int len_
, AsyncCall::Pointer
&callback_
)
2566 : fd(fd_
), buf(buf_
), len(len_
), callback(callback_
) {}
2568 DeferredRead::DeferredRead () : theReader(NULL
), theContext(NULL
), theRead(), cancelled(false) {}
2570 DeferredRead::DeferredRead (DeferrableRead
*aReader
, void *data
, CommRead
const &aRead
) : theReader(aReader
), theContext (data
), theRead(aRead
), cancelled(false) {}
2572 DeferredReadManager::~DeferredReadManager()
2575 assert (deferredReads
.empty());
2578 /* explicit instantiation required for some systems */
2580 /// \cond AUTODOCS-IGNORE
2581 template cbdata_type CbDataList
<DeferredRead
>::CBDATA_CbDataList
;
2585 DeferredReadManager::delayRead(DeferredRead
const &aRead
)
2587 debugs(5, 3, "Adding deferred read on FD " << aRead
.theRead
.fd
);
2588 CbDataList
<DeferredRead
> *temp
= deferredReads
.push_back(aRead
);
2590 // We have to use a global function as a closer and point to temp
2591 // instead of "this" because DeferredReadManager is not a job and
2592 // is not even cbdata protected
2593 AsyncCall::Pointer closer
= commCbCall(5,4,
2594 "DeferredReadManager::CloseHandler",
2595 CommCloseCbPtrFun(&CloseHandler
, temp
));
2596 comm_add_close_handler(aRead
.theRead
.fd
, closer
);
2597 temp
->element
.closer
= closer
; // remeber so that we can cancel
2601 DeferredReadManager::CloseHandler(int fd
, void *thecbdata
)
2603 if (!cbdataReferenceValid (thecbdata
))
2606 CbDataList
<DeferredRead
> *temp
= (CbDataList
<DeferredRead
> *)thecbdata
;
2608 temp
->element
.closer
= NULL
;
2609 temp
->element
.markCancelled();
2613 DeferredReadManager::popHead(CbDataListContainer
<DeferredRead
> &deferredReads
)
2615 assert (!deferredReads
.empty());
2617 DeferredRead
&read
= deferredReads
.head
->element
;
2618 if (!read
.cancelled
) {
2619 comm_remove_close_handler(read
.theRead
.fd
, read
.closer
);
2623 DeferredRead result
= deferredReads
.pop_front();
2629 DeferredReadManager::kickReads(int const count
)
2631 /* if we had CbDataList::size() we could consolidate this and flushReads */
2638 size_t remaining
= count
;
2640 while (!deferredReads
.empty() && remaining
) {
2641 DeferredRead aRead
= popHead(deferredReads
);
2644 if (!aRead
.cancelled
)
2650 DeferredReadManager::flushReads()
2652 CbDataListContainer
<DeferredRead
> reads
;
2653 reads
= deferredReads
;
2654 deferredReads
= CbDataListContainer
<DeferredRead
>();
2656 // XXX: For fairness this SHOULD randomize the order
2657 while (!reads
.empty()) {
2658 DeferredRead aRead
= popHead(reads
);
2664 DeferredReadManager::kickARead(DeferredRead
const &aRead
)
2666 if (aRead
.cancelled
)
2669 if (aRead
.theRead
.fd
>=0 && fd_table
[aRead
.theRead
.fd
].closing())
2672 debugs(5, 3, "Kicking deferred read on FD " << aRead
.theRead
.fd
);
2674 aRead
.theReader(aRead
.theContext
, aRead
.theRead
);
2678 DeferredRead::markCancelled()
2683 ConnectionDetail::ConnectionDetail() : me(), peer()
2688 CommSelectEngine::checkEvents(int timeout
)
2690 static time_t last_timeout
= 0;
2692 /* No, this shouldn't be here. But it shouldn't be in each comm handler. -adrian */
2693 if (squid_curtime
> last_timeout
) {
2694 last_timeout
= squid_curtime
;
2698 switch (comm_select(timeout
)) {
2714 fatal_dump("comm.cc: Internal error -- this should never happen.");