blob: 4a4c0a36ba923323bcd21c57b24e9f3341ba591f [file] [log] [blame]
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001/*
2 * Copyright 2004 The WebRTC Project Authors. All rights reserved.
3 *
4 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
9 */
10
11#if defined(_MSC_VER) && _MSC_VER < 1300
12#pragma warning(disable:4786)
13#endif
14
15#include <assert.h>
16
pbos@webrtc.org27e58982014-10-07 17:56:53 +000017#ifdef MEMORY_SANITIZER
18#include <sanitizer/msan_interface.h>
19#endif
20
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000021#if defined(WEBRTC_POSIX)
22#include <string.h>
23#include <errno.h>
24#include <fcntl.h>
25#include <sys/time.h>
26#include <sys/select.h>
27#include <unistd.h>
28#include <signal.h>
29#endif
30
31#if defined(WEBRTC_WIN)
32#define WIN32_LEAN_AND_MEAN
33#include <windows.h>
34#include <winsock2.h>
35#include <ws2tcpip.h>
36#undef SetPort
37#endif
38
39#include <algorithm>
40#include <map>
41
tfarina5237aaf2015-11-10 23:44:30 -080042#include "webrtc/base/arraysize.h"
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000043#include "webrtc/base/basictypes.h"
44#include "webrtc/base/byteorder.h"
45#include "webrtc/base/common.h"
46#include "webrtc/base/logging.h"
47#include "webrtc/base/nethelpers.h"
48#include "webrtc/base/physicalsocketserver.h"
49#include "webrtc/base/timeutils.h"
50#include "webrtc/base/winping.h"
51#include "webrtc/base/win32socketinit.h"
52
53// stm: this will tell us if we are on OSX
54#ifdef HAVE_CONFIG_H
55#include "config.h"
56#endif
57
58#if defined(WEBRTC_POSIX)
59#include <netinet/tcp.h> // for TCP_NODELAY
60#define IP_MTU 14 // Until this is integrated from linux/in.h to netinet/in.h
61typedef void* SockOptArg;
62#endif // WEBRTC_POSIX
63
64#if defined(WEBRTC_WIN)
65typedef char* SockOptArg;
66#endif
67
68namespace rtc {
69
70#if defined(WEBRTC_WIN)
71// Standard MTUs, from RFC 1191
Peter Boström0c4e06b2015-10-07 12:23:21 +020072const uint16_t PACKET_MAXIMUMS[] = {
73 65535, // Theoretical maximum, Hyperchannel
74 32000, // Nothing
75 17914, // 16Mb IBM Token Ring
76 8166, // IEEE 802.4
77 // 4464, // IEEE 802.5 (4Mb max)
78 4352, // FDDI
79 // 2048, // Wideband Network
80 2002, // IEEE 802.5 (4Mb recommended)
81 // 1536, // Expermental Ethernet Networks
82 // 1500, // Ethernet, Point-to-Point (default)
83 1492, // IEEE 802.3
84 1006, // SLIP, ARPANET
85 // 576, // X.25 Networks
86 // 544, // DEC IP Portal
87 // 512, // NETBIOS
88 508, // IEEE 802/Source-Rt Bridge, ARCNET
89 296, // Point-to-Point (low delay)
90 68, // Official minimum
91 0, // End of list marker
henrike@webrtc.orgf0488722014-05-13 18:00:26 +000092};
93
94static const int IP_HEADER_SIZE = 20u;
95static const int IPV6_HEADER_SIZE = 40u;
96static const int ICMP_HEADER_SIZE = 8u;
97static const int ICMP_PING_TIMEOUT_MILLIS = 10000u;
98#endif
99
100class PhysicalSocket : public AsyncSocket, public sigslot::has_slots<> {
101 public:
102 PhysicalSocket(PhysicalSocketServer* ss, SOCKET s = INVALID_SOCKET)
103 : ss_(ss), s_(s), enabled_events_(0), error_(0),
104 state_((s == INVALID_SOCKET) ? CS_CLOSED : CS_CONNECTED),
105 resolver_(NULL) {
106#if defined(WEBRTC_WIN)
107 // EnsureWinsockInit() ensures that winsock is initialized. The default
108 // version of this function doesn't do anything because winsock is
109 // initialized by constructor of a static object. If neccessary libjingle
110 // users can link it with a different version of this function by replacing
111 // win32socketinit.cc. See win32socketinit.cc for more details.
112 EnsureWinsockInit();
113#endif
114 if (s_ != INVALID_SOCKET) {
115 enabled_events_ = DE_READ | DE_WRITE;
116
117 int type = SOCK_STREAM;
118 socklen_t len = sizeof(type);
119 VERIFY(0 == getsockopt(s_, SOL_SOCKET, SO_TYPE, (SockOptArg)&type, &len));
120 udp_ = (SOCK_DGRAM == type);
121 }
122 }
123
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000124 ~PhysicalSocket() override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000125 Close();
126 }
127
128 // Creates the underlying OS socket (same as the "socket" function).
129 virtual bool Create(int family, int type) {
130 Close();
131 s_ = ::socket(family, type, 0);
132 udp_ = (SOCK_DGRAM == type);
133 UpdateLastError();
134 if (udp_)
135 enabled_events_ = DE_READ | DE_WRITE;
136 return s_ != INVALID_SOCKET;
137 }
138
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000139 SocketAddress GetLocalAddress() const override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000140 sockaddr_storage addr_storage = {0};
141 socklen_t addrlen = sizeof(addr_storage);
142 sockaddr* addr = reinterpret_cast<sockaddr*>(&addr_storage);
143 int result = ::getsockname(s_, addr, &addrlen);
144 SocketAddress address;
145 if (result >= 0) {
146 SocketAddressFromSockAddrStorage(addr_storage, &address);
147 } else {
148 LOG(LS_WARNING) << "GetLocalAddress: unable to get local addr, socket="
149 << s_;
150 }
151 return address;
152 }
153
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000154 SocketAddress GetRemoteAddress() const override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000155 sockaddr_storage addr_storage = {0};
156 socklen_t addrlen = sizeof(addr_storage);
157 sockaddr* addr = reinterpret_cast<sockaddr*>(&addr_storage);
158 int result = ::getpeername(s_, addr, &addrlen);
159 SocketAddress address;
160 if (result >= 0) {
161 SocketAddressFromSockAddrStorage(addr_storage, &address);
162 } else {
163 LOG(LS_WARNING) << "GetRemoteAddress: unable to get remote addr, socket="
164 << s_;
165 }
166 return address;
167 }
168
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000169 int Bind(const SocketAddress& bind_addr) override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000170 sockaddr_storage addr_storage;
171 size_t len = bind_addr.ToSockAddrStorage(&addr_storage);
172 sockaddr* addr = reinterpret_cast<sockaddr*>(&addr_storage);
173 int err = ::bind(s_, addr, static_cast<int>(len));
174 UpdateLastError();
tfarinaa41ab932015-10-30 16:08:48 -0700175#if !defined(NDEBUG)
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000176 if (0 == err) {
177 dbg_addr_ = "Bound @ ";
178 dbg_addr_.append(GetLocalAddress().ToString());
179 }
tfarinaa41ab932015-10-30 16:08:48 -0700180#endif
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000181 return err;
182 }
183
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000184 int Connect(const SocketAddress& addr) override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000185 // TODO: Implicit creation is required to reconnect...
186 // ...but should we make it more explicit?
187 if (state_ != CS_CLOSED) {
188 SetError(EALREADY);
189 return SOCKET_ERROR;
190 }
tfarina20a34612015-11-02 16:20:22 -0800191 if (addr.IsUnresolvedIP()) {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000192 LOG(LS_VERBOSE) << "Resolving addr in PhysicalSocket::Connect";
193 resolver_ = new AsyncResolver();
194 resolver_->SignalDone.connect(this, &PhysicalSocket::OnResolveResult);
195 resolver_->Start(addr);
196 state_ = CS_CONNECTING;
197 return 0;
198 }
199
200 return DoConnect(addr);
201 }
202
203 int DoConnect(const SocketAddress& connect_addr) {
204 if ((s_ == INVALID_SOCKET) &&
205 !Create(connect_addr.family(), SOCK_STREAM)) {
206 return SOCKET_ERROR;
207 }
208 sockaddr_storage addr_storage;
209 size_t len = connect_addr.ToSockAddrStorage(&addr_storage);
210 sockaddr* addr = reinterpret_cast<sockaddr*>(&addr_storage);
211 int err = ::connect(s_, addr, static_cast<int>(len));
212 UpdateLastError();
213 if (err == 0) {
214 state_ = CS_CONNECTED;
215 } else if (IsBlockingError(GetError())) {
216 state_ = CS_CONNECTING;
217 enabled_events_ |= DE_CONNECT;
218 } else {
219 return SOCKET_ERROR;
220 }
221
222 enabled_events_ |= DE_READ | DE_WRITE;
223 return 0;
224 }
225
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000226 int GetError() const override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000227 CritScope cs(&crit_);
228 return error_;
229 }
230
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000231 void SetError(int error) override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000232 CritScope cs(&crit_);
233 error_ = error;
234 }
235
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000236 ConnState GetState() const override { return state_; }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000237
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000238 int GetOption(Option opt, int* value) override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000239 int slevel;
240 int sopt;
241 if (TranslateOption(opt, &slevel, &sopt) == -1)
242 return -1;
243 socklen_t optlen = sizeof(*value);
244 int ret = ::getsockopt(s_, slevel, sopt, (SockOptArg)value, &optlen);
245 if (ret != -1 && opt == OPT_DONTFRAGMENT) {
246#if defined(WEBRTC_LINUX) && !defined(WEBRTC_ANDROID)
247 *value = (*value != IP_PMTUDISC_DONT) ? 1 : 0;
248#endif
249 }
250 return ret;
251 }
252
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000253 int SetOption(Option opt, int value) override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000254 int slevel;
255 int sopt;
256 if (TranslateOption(opt, &slevel, &sopt) == -1)
257 return -1;
258 if (opt == OPT_DONTFRAGMENT) {
259#if defined(WEBRTC_LINUX) && !defined(WEBRTC_ANDROID)
260 value = (value) ? IP_PMTUDISC_DO : IP_PMTUDISC_DONT;
261#endif
262 }
263 return ::setsockopt(s_, slevel, sopt, (SockOptArg)&value, sizeof(value));
264 }
265
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000266 int Send(const void* pv, size_t cb) override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000267 int sent = ::send(s_, reinterpret_cast<const char *>(pv), (int)cb,
268#if defined(WEBRTC_LINUX) && !defined(WEBRTC_ANDROID)
269 // Suppress SIGPIPE. Without this, attempting to send on a socket whose
270 // other end is closed will result in a SIGPIPE signal being raised to
271 // our process, which by default will terminate the process, which we
272 // don't want. By specifying this flag, we'll just get the error EPIPE
273 // instead and can handle the error gracefully.
274 MSG_NOSIGNAL
275#else
276 0
277#endif
278 );
279 UpdateLastError();
280 MaybeRemapSendError();
281 // We have seen minidumps where this may be false.
282 ASSERT(sent <= static_cast<int>(cb));
283 if ((sent < 0) && IsBlockingError(GetError())) {
284 enabled_events_ |= DE_WRITE;
285 }
286 return sent;
287 }
288
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000289 int SendTo(const void* buffer,
290 size_t length,
291 const SocketAddress& addr) override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000292 sockaddr_storage saddr;
293 size_t len = addr.ToSockAddrStorage(&saddr);
294 int sent = ::sendto(
295 s_, static_cast<const char *>(buffer), static_cast<int>(length),
296#if defined(WEBRTC_LINUX) && !defined(WEBRTC_ANDROID)
297 // Suppress SIGPIPE. See above for explanation.
298 MSG_NOSIGNAL,
299#else
300 0,
301#endif
302 reinterpret_cast<sockaddr*>(&saddr), static_cast<int>(len));
303 UpdateLastError();
304 MaybeRemapSendError();
305 // We have seen minidumps where this may be false.
306 ASSERT(sent <= static_cast<int>(length));
307 if ((sent < 0) && IsBlockingError(GetError())) {
308 enabled_events_ |= DE_WRITE;
309 }
310 return sent;
311 }
312
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000313 int Recv(void* buffer, size_t length) override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000314 int received = ::recv(s_, static_cast<char*>(buffer),
315 static_cast<int>(length), 0);
316 if ((received == 0) && (length != 0)) {
317 // Note: on graceful shutdown, recv can return 0. In this case, we
318 // pretend it is blocking, and then signal close, so that simplifying
319 // assumptions can be made about Recv.
320 LOG(LS_WARNING) << "EOF from socket; deferring close event";
321 // Must turn this back on so that the select() loop will notice the close
322 // event.
323 enabled_events_ |= DE_READ;
324 SetError(EWOULDBLOCK);
325 return SOCKET_ERROR;
326 }
327 UpdateLastError();
328 int error = GetError();
329 bool success = (received >= 0) || IsBlockingError(error);
330 if (udp_ || success) {
331 enabled_events_ |= DE_READ;
332 }
333 if (!success) {
334 LOG_F(LS_VERBOSE) << "Error = " << error;
335 }
336 return received;
337 }
338
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000339 int RecvFrom(void* buffer, size_t length, SocketAddress* out_addr) override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000340 sockaddr_storage addr_storage;
341 socklen_t addr_len = sizeof(addr_storage);
342 sockaddr* addr = reinterpret_cast<sockaddr*>(&addr_storage);
343 int received = ::recvfrom(s_, static_cast<char*>(buffer),
344 static_cast<int>(length), 0, addr, &addr_len);
345 UpdateLastError();
346 if ((received >= 0) && (out_addr != NULL))
347 SocketAddressFromSockAddrStorage(addr_storage, out_addr);
348 int error = GetError();
349 bool success = (received >= 0) || IsBlockingError(error);
350 if (udp_ || success) {
351 enabled_events_ |= DE_READ;
352 }
353 if (!success) {
354 LOG_F(LS_VERBOSE) << "Error = " << error;
355 }
356 return received;
357 }
358
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000359 int Listen(int backlog) override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000360 int err = ::listen(s_, backlog);
361 UpdateLastError();
362 if (err == 0) {
363 state_ = CS_CONNECTING;
364 enabled_events_ |= DE_ACCEPT;
tfarinaa41ab932015-10-30 16:08:48 -0700365#if !defined(NDEBUG)
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000366 dbg_addr_ = "Listening @ ";
367 dbg_addr_.append(GetLocalAddress().ToString());
tfarinaa41ab932015-10-30 16:08:48 -0700368#endif
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000369 }
370 return err;
371 }
372
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000373 AsyncSocket* Accept(SocketAddress* out_addr) override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000374 sockaddr_storage addr_storage;
375 socklen_t addr_len = sizeof(addr_storage);
376 sockaddr* addr = reinterpret_cast<sockaddr*>(&addr_storage);
377 SOCKET s = ::accept(s_, addr, &addr_len);
378 UpdateLastError();
379 if (s == INVALID_SOCKET)
380 return NULL;
381 enabled_events_ |= DE_ACCEPT;
382 if (out_addr != NULL)
383 SocketAddressFromSockAddrStorage(addr_storage, out_addr);
384 return ss_->WrapSocket(s);
385 }
386
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000387 int Close() override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000388 if (s_ == INVALID_SOCKET)
389 return 0;
390 int err = ::closesocket(s_);
391 UpdateLastError();
392 s_ = INVALID_SOCKET;
393 state_ = CS_CLOSED;
394 enabled_events_ = 0;
395 if (resolver_) {
396 resolver_->Destroy(false);
397 resolver_ = NULL;
398 }
399 return err;
400 }
401
Peter Boström0c4e06b2015-10-07 12:23:21 +0200402 int EstimateMTU(uint16_t* mtu) override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000403 SocketAddress addr = GetRemoteAddress();
tfarina8ac544e2015-10-08 07:15:44 -0700404 if (addr.IsAnyIP()) {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000405 SetError(ENOTCONN);
406 return -1;
407 }
408
409#if defined(WEBRTC_WIN)
410 // Gets the interface MTU (TTL=1) for the interface used to reach |addr|.
411 WinPing ping;
412 if (!ping.IsValid()) {
413 SetError(EINVAL); // can't think of a better error ID
414 return -1;
415 }
416 int header_size = ICMP_HEADER_SIZE;
417 if (addr.family() == AF_INET6) {
418 header_size += IPV6_HEADER_SIZE;
419 } else if (addr.family() == AF_INET) {
420 header_size += IP_HEADER_SIZE;
421 }
422
423 for (int level = 0; PACKET_MAXIMUMS[level + 1] > 0; ++level) {
Peter Boström0c4e06b2015-10-07 12:23:21 +0200424 int32_t size = PACKET_MAXIMUMS[level] - header_size;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000425 WinPing::PingResult result = ping.Ping(addr.ipaddr(), size,
426 ICMP_PING_TIMEOUT_MILLIS,
427 1, false);
428 if (result == WinPing::PING_FAIL) {
429 SetError(EINVAL); // can't think of a better error ID
430 return -1;
431 } else if (result != WinPing::PING_TOO_LARGE) {
432 *mtu = PACKET_MAXIMUMS[level];
433 return 0;
434 }
435 }
436
437 ASSERT(false);
438 return -1;
439#elif defined(WEBRTC_MAC)
440 // No simple way to do this on Mac OS X.
441 // SIOCGIFMTU would work if we knew which interface would be used, but
442 // figuring that out is pretty complicated. For now we'll return an error
443 // and let the caller pick a default MTU.
444 SetError(EINVAL);
445 return -1;
446#elif defined(WEBRTC_LINUX)
447 // Gets the path MTU.
448 int value;
449 socklen_t vlen = sizeof(value);
450 int err = getsockopt(s_, IPPROTO_IP, IP_MTU, &value, &vlen);
451 if (err < 0) {
452 UpdateLastError();
453 return err;
454 }
455
456 ASSERT((0 <= value) && (value <= 65536));
457 *mtu = value;
458 return 0;
459#elif defined(__native_client__)
460 // Most socket operations, including this, will fail in NaCl's sandbox.
461 error_ = EACCES;
462 return -1;
463#endif
464 }
465
466 SocketServer* socketserver() { return ss_; }
467
468 protected:
469 void OnResolveResult(AsyncResolverInterface* resolver) {
470 if (resolver != resolver_) {
471 return;
472 }
473
474 int error = resolver_->GetError();
475 if (error == 0) {
476 error = DoConnect(resolver_->address());
477 } else {
478 Close();
479 }
480
481 if (error) {
482 SetError(error);
483 SignalCloseEvent(this, error);
484 }
485 }
486
487 void UpdateLastError() {
488 SetError(LAST_SYSTEM_ERROR);
489 }
490
491 void MaybeRemapSendError() {
492#if defined(WEBRTC_MAC)
493 // https://developer.apple.com/library/mac/documentation/Darwin/
494 // Reference/ManPages/man2/sendto.2.html
495 // ENOBUFS - The output queue for a network interface is full.
496 // This generally indicates that the interface has stopped sending,
497 // but may be caused by transient congestion.
498 if (GetError() == ENOBUFS) {
499 SetError(EWOULDBLOCK);
500 }
501#endif
502 }
503
504 static int TranslateOption(Option opt, int* slevel, int* sopt) {
505 switch (opt) {
506 case OPT_DONTFRAGMENT:
507#if defined(WEBRTC_WIN)
508 *slevel = IPPROTO_IP;
509 *sopt = IP_DONTFRAGMENT;
510 break;
511#elif defined(WEBRTC_MAC) || defined(BSD) || defined(__native_client__)
512 LOG(LS_WARNING) << "Socket::OPT_DONTFRAGMENT not supported.";
513 return -1;
514#elif defined(WEBRTC_POSIX)
515 *slevel = IPPROTO_IP;
516 *sopt = IP_MTU_DISCOVER;
517 break;
518#endif
519 case OPT_RCVBUF:
520 *slevel = SOL_SOCKET;
521 *sopt = SO_RCVBUF;
522 break;
523 case OPT_SNDBUF:
524 *slevel = SOL_SOCKET;
525 *sopt = SO_SNDBUF;
526 break;
527 case OPT_NODELAY:
528 *slevel = IPPROTO_TCP;
529 *sopt = TCP_NODELAY;
530 break;
531 case OPT_DSCP:
532 LOG(LS_WARNING) << "Socket::OPT_DSCP not supported.";
533 return -1;
534 case OPT_RTP_SENDTIME_EXTN_ID:
535 return -1; // No logging is necessary as this not a OS socket option.
536 default:
537 ASSERT(false);
538 return -1;
539 }
540 return 0;
541 }
542
543 PhysicalSocketServer* ss_;
544 SOCKET s_;
Peter Boström0c4e06b2015-10-07 12:23:21 +0200545 uint8_t enabled_events_;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000546 bool udp_;
547 int error_;
548 // Protects |error_| that is accessed from different threads.
549 mutable CriticalSection crit_;
550 ConnState state_;
551 AsyncResolver* resolver_;
552
tfarinaa41ab932015-10-30 16:08:48 -0700553#if !defined(NDEBUG)
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000554 std::string dbg_addr_;
tfarinaa41ab932015-10-30 16:08:48 -0700555#endif
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000556};
557
558#if defined(WEBRTC_POSIX)
559class EventDispatcher : public Dispatcher {
560 public:
561 EventDispatcher(PhysicalSocketServer* ss) : ss_(ss), fSignaled_(false) {
562 if (pipe(afd_) < 0)
563 LOG(LERROR) << "pipe failed";
564 ss_->Add(this);
565 }
566
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000567 ~EventDispatcher() override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000568 ss_->Remove(this);
569 close(afd_[0]);
570 close(afd_[1]);
571 }
572
573 virtual void Signal() {
574 CritScope cs(&crit_);
575 if (!fSignaled_) {
Peter Boström0c4e06b2015-10-07 12:23:21 +0200576 const uint8_t b[1] = {0};
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000577 if (VERIFY(1 == write(afd_[1], b, sizeof(b)))) {
578 fSignaled_ = true;
579 }
580 }
581 }
582
Peter Boström0c4e06b2015-10-07 12:23:21 +0200583 uint32_t GetRequestedEvents() override { return DE_READ; }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000584
Peter Boström0c4e06b2015-10-07 12:23:21 +0200585 void OnPreEvent(uint32_t ff) override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000586 // It is not possible to perfectly emulate an auto-resetting event with
587 // pipes. This simulates it by resetting before the event is handled.
588
589 CritScope cs(&crit_);
590 if (fSignaled_) {
Peter Boström0c4e06b2015-10-07 12:23:21 +0200591 uint8_t b[4]; // Allow for reading more than 1 byte, but expect 1.
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000592 VERIFY(1 == read(afd_[0], b, sizeof(b)));
593 fSignaled_ = false;
594 }
595 }
596
Peter Boström0c4e06b2015-10-07 12:23:21 +0200597 void OnEvent(uint32_t ff, int err) override { ASSERT(false); }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000598
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000599 int GetDescriptor() override { return afd_[0]; }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000600
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000601 bool IsDescriptorClosed() override { return false; }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000602
603 private:
604 PhysicalSocketServer *ss_;
605 int afd_[2];
606 bool fSignaled_;
607 CriticalSection crit_;
608};
609
610// These two classes use the self-pipe trick to deliver POSIX signals to our
611// select loop. This is the only safe, reliable, cross-platform way to do
612// non-trivial things with a POSIX signal in an event-driven program (until
613// proper pselect() implementations become ubiquitous).
614
615class PosixSignalHandler {
616 public:
617 // POSIX only specifies 32 signals, but in principle the system might have
618 // more and the programmer might choose to use them, so we size our array
619 // for 128.
620 static const int kNumPosixSignals = 128;
621
622 // There is just a single global instance. (Signal handlers do not get any
623 // sort of user-defined void * parameter, so they can't access anything that
624 // isn't global.)
625 static PosixSignalHandler* Instance() {
Andrew MacDonald469c2c02015-05-22 17:50:26 -0700626 RTC_DEFINE_STATIC_LOCAL(PosixSignalHandler, instance, ());
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000627 return &instance;
628 }
629
630 // Returns true if the given signal number is set.
631 bool IsSignalSet(int signum) const {
tfarina5237aaf2015-11-10 23:44:30 -0800632 ASSERT(signum < static_cast<int>(arraysize(received_signal_)));
633 if (signum < static_cast<int>(arraysize(received_signal_))) {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000634 return received_signal_[signum];
635 } else {
636 return false;
637 }
638 }
639
640 // Clears the given signal number.
641 void ClearSignal(int signum) {
tfarina5237aaf2015-11-10 23:44:30 -0800642 ASSERT(signum < static_cast<int>(arraysize(received_signal_)));
643 if (signum < static_cast<int>(arraysize(received_signal_))) {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000644 received_signal_[signum] = false;
645 }
646 }
647
648 // Returns the file descriptor to monitor for signal events.
649 int GetDescriptor() const {
650 return afd_[0];
651 }
652
653 // This is called directly from our real signal handler, so it must be
654 // signal-handler-safe. That means it cannot assume anything about the
655 // user-level state of the process, since the handler could be executed at any
656 // time on any thread.
657 void OnPosixSignalReceived(int signum) {
tfarina5237aaf2015-11-10 23:44:30 -0800658 if (signum >= static_cast<int>(arraysize(received_signal_))) {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000659 // We don't have space in our array for this.
660 return;
661 }
662 // Set a flag saying we've seen this signal.
663 received_signal_[signum] = true;
664 // Notify application code that we got a signal.
Peter Boström0c4e06b2015-10-07 12:23:21 +0200665 const uint8_t b[1] = {0};
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000666 if (-1 == write(afd_[1], b, sizeof(b))) {
667 // Nothing we can do here. If there's an error somehow then there's
668 // nothing we can safely do from a signal handler.
669 // No, we can't even safely log it.
670 // But, we still have to check the return value here. Otherwise,
671 // GCC 4.4.1 complains ignoring return value. Even (void) doesn't help.
672 return;
673 }
674 }
675
676 private:
677 PosixSignalHandler() {
678 if (pipe(afd_) < 0) {
679 LOG_ERR(LS_ERROR) << "pipe failed";
680 return;
681 }
682 if (fcntl(afd_[0], F_SETFL, O_NONBLOCK) < 0) {
683 LOG_ERR(LS_WARNING) << "fcntl #1 failed";
684 }
685 if (fcntl(afd_[1], F_SETFL, O_NONBLOCK) < 0) {
686 LOG_ERR(LS_WARNING) << "fcntl #2 failed";
687 }
688 memset(const_cast<void *>(static_cast<volatile void *>(received_signal_)),
689 0,
690 sizeof(received_signal_));
691 }
692
693 ~PosixSignalHandler() {
694 int fd1 = afd_[0];
695 int fd2 = afd_[1];
696 // We clobber the stored file descriptor numbers here or else in principle
697 // a signal that happens to be delivered during application termination
698 // could erroneously write a zero byte to an unrelated file handle in
699 // OnPosixSignalReceived() if some other file happens to be opened later
700 // during shutdown and happens to be given the same file descriptor number
701 // as our pipe had. Unfortunately even with this precaution there is still a
702 // race where that could occur if said signal happens to be handled
703 // concurrently with this code and happens to have already read the value of
704 // afd_[1] from memory before we clobber it, but that's unlikely.
705 afd_[0] = -1;
706 afd_[1] = -1;
707 close(fd1);
708 close(fd2);
709 }
710
711 int afd_[2];
712 // These are boolean flags that will be set in our signal handler and read
713 // and cleared from Wait(). There is a race involved in this, but it is
714 // benign. The signal handler sets the flag before signaling the pipe, so
715 // we'll never end up blocking in select() while a flag is still true.
716 // However, if two of the same signal arrive close to each other then it's
717 // possible that the second time the handler may set the flag while it's still
718 // true, meaning that signal will be missed. But the first occurrence of it
719 // will still be handled, so this isn't a problem.
720 // Volatile is not necessary here for correctness, but this data _is_ volatile
721 // so I've marked it as such.
Peter Boström0c4e06b2015-10-07 12:23:21 +0200722 volatile uint8_t received_signal_[kNumPosixSignals];
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000723};
724
725class PosixSignalDispatcher : public Dispatcher {
726 public:
727 PosixSignalDispatcher(PhysicalSocketServer *owner) : owner_(owner) {
728 owner_->Add(this);
729 }
730
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000731 ~PosixSignalDispatcher() override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000732 owner_->Remove(this);
733 }
734
Peter Boström0c4e06b2015-10-07 12:23:21 +0200735 uint32_t GetRequestedEvents() override { return DE_READ; }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000736
Peter Boström0c4e06b2015-10-07 12:23:21 +0200737 void OnPreEvent(uint32_t ff) override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000738 // Events might get grouped if signals come very fast, so we read out up to
739 // 16 bytes to make sure we keep the pipe empty.
Peter Boström0c4e06b2015-10-07 12:23:21 +0200740 uint8_t b[16];
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000741 ssize_t ret = read(GetDescriptor(), b, sizeof(b));
742 if (ret < 0) {
743 LOG_ERR(LS_WARNING) << "Error in read()";
744 } else if (ret == 0) {
745 LOG(LS_WARNING) << "Should have read at least one byte";
746 }
747 }
748
Peter Boström0c4e06b2015-10-07 12:23:21 +0200749 void OnEvent(uint32_t ff, int err) override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000750 for (int signum = 0; signum < PosixSignalHandler::kNumPosixSignals;
751 ++signum) {
752 if (PosixSignalHandler::Instance()->IsSignalSet(signum)) {
753 PosixSignalHandler::Instance()->ClearSignal(signum);
754 HandlerMap::iterator i = handlers_.find(signum);
755 if (i == handlers_.end()) {
756 // This can happen if a signal is delivered to our process at around
757 // the same time as we unset our handler for it. It is not an error
758 // condition, but it's unusual enough to be worth logging.
759 LOG(LS_INFO) << "Received signal with no handler: " << signum;
760 } else {
761 // Otherwise, execute our handler.
762 (*i->second)(signum);
763 }
764 }
765 }
766 }
767
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000768 int GetDescriptor() override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000769 return PosixSignalHandler::Instance()->GetDescriptor();
770 }
771
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000772 bool IsDescriptorClosed() override { return false; }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000773
774 void SetHandler(int signum, void (*handler)(int)) {
775 handlers_[signum] = handler;
776 }
777
778 void ClearHandler(int signum) {
779 handlers_.erase(signum);
780 }
781
782 bool HasHandlers() {
783 return !handlers_.empty();
784 }
785
786 private:
787 typedef std::map<int, void (*)(int)> HandlerMap;
788
789 HandlerMap handlers_;
790 // Our owner.
791 PhysicalSocketServer *owner_;
792};
793
794class SocketDispatcher : public Dispatcher, public PhysicalSocket {
795 public:
796 explicit SocketDispatcher(PhysicalSocketServer *ss) : PhysicalSocket(ss) {
797 }
798 SocketDispatcher(SOCKET s, PhysicalSocketServer *ss) : PhysicalSocket(ss, s) {
799 }
800
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000801 ~SocketDispatcher() override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000802 Close();
803 }
804
805 bool Initialize() {
806 ss_->Add(this);
807 fcntl(s_, F_SETFL, fcntl(s_, F_GETFL, 0) | O_NONBLOCK);
808 return true;
809 }
810
811 virtual bool Create(int type) {
812 return Create(AF_INET, type);
813 }
814
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000815 bool Create(int family, int type) override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000816 // Change the socket to be non-blocking.
817 if (!PhysicalSocket::Create(family, type))
818 return false;
819
820 return Initialize();
821 }
822
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000823 int GetDescriptor() override { return s_; }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000824
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000825 bool IsDescriptorClosed() override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000826 // We don't have a reliable way of distinguishing end-of-stream
827 // from readability. So test on each readable call. Is this
828 // inefficient? Probably.
829 char ch;
830 ssize_t res = ::recv(s_, &ch, 1, MSG_PEEK);
831 if (res > 0) {
832 // Data available, so not closed.
833 return false;
834 } else if (res == 0) {
835 // EOF, so closed.
836 return true;
837 } else { // error
838 switch (errno) {
839 // Returned if we've already closed s_.
840 case EBADF:
841 // Returned during ungraceful peer shutdown.
842 case ECONNRESET:
843 return true;
844 default:
845 // Assume that all other errors are just blocking errors, meaning the
846 // connection is still good but we just can't read from it right now.
847 // This should only happen when connecting (and at most once), because
848 // in all other cases this function is only called if the file
849 // descriptor is already known to be in the readable state. However,
850 // it's not necessary a problem if we spuriously interpret a
851 // "connection lost"-type error as a blocking error, because typically
852 // the next recv() will get EOF, so we'll still eventually notice that
853 // the socket is closed.
854 LOG_ERR(LS_WARNING) << "Assuming benign blocking error";
855 return false;
856 }
857 }
858 }
859
Peter Boström0c4e06b2015-10-07 12:23:21 +0200860 uint32_t GetRequestedEvents() override { return enabled_events_; }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000861
Peter Boström0c4e06b2015-10-07 12:23:21 +0200862 void OnPreEvent(uint32_t ff) override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000863 if ((ff & DE_CONNECT) != 0)
864 state_ = CS_CONNECTED;
865 if ((ff & DE_CLOSE) != 0)
866 state_ = CS_CLOSED;
867 }
868
Peter Boström0c4e06b2015-10-07 12:23:21 +0200869 void OnEvent(uint32_t ff, int err) override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000870 // Make sure we deliver connect/accept first. Otherwise, consumers may see
871 // something like a READ followed by a CONNECT, which would be odd.
872 if ((ff & DE_CONNECT) != 0) {
873 enabled_events_ &= ~DE_CONNECT;
874 SignalConnectEvent(this);
875 }
876 if ((ff & DE_ACCEPT) != 0) {
877 enabled_events_ &= ~DE_ACCEPT;
878 SignalReadEvent(this);
879 }
880 if ((ff & DE_READ) != 0) {
881 enabled_events_ &= ~DE_READ;
882 SignalReadEvent(this);
883 }
884 if ((ff & DE_WRITE) != 0) {
885 enabled_events_ &= ~DE_WRITE;
886 SignalWriteEvent(this);
887 }
888 if ((ff & DE_CLOSE) != 0) {
889 // The socket is now dead to us, so stop checking it.
890 enabled_events_ = 0;
891 SignalCloseEvent(this, err);
892 }
893 }
894
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000895 int Close() override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000896 if (s_ == INVALID_SOCKET)
897 return 0;
898
899 ss_->Remove(this);
900 return PhysicalSocket::Close();
901 }
902};
903
904class FileDispatcher: public Dispatcher, public AsyncFile {
905 public:
906 FileDispatcher(int fd, PhysicalSocketServer *ss) : ss_(ss), fd_(fd) {
907 set_readable(true);
908
909 ss_->Add(this);
910
911 fcntl(fd_, F_SETFL, fcntl(fd_, F_GETFL, 0) | O_NONBLOCK);
912 }
913
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000914 ~FileDispatcher() override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000915 ss_->Remove(this);
916 }
917
918 SocketServer* socketserver() { return ss_; }
919
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000920 int GetDescriptor() override { return fd_; }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000921
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000922 bool IsDescriptorClosed() override { return false; }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000923
Peter Boström0c4e06b2015-10-07 12:23:21 +0200924 uint32_t GetRequestedEvents() override { return flags_; }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000925
Peter Boström0c4e06b2015-10-07 12:23:21 +0200926 void OnPreEvent(uint32_t ff) override {}
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000927
Peter Boström0c4e06b2015-10-07 12:23:21 +0200928 void OnEvent(uint32_t ff, int err) override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000929 if ((ff & DE_READ) != 0)
930 SignalReadEvent(this);
931 if ((ff & DE_WRITE) != 0)
932 SignalWriteEvent(this);
933 if ((ff & DE_CLOSE) != 0)
934 SignalCloseEvent(this, err);
935 }
936
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000937 bool readable() override { return (flags_ & DE_READ) != 0; }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000938
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000939 void set_readable(bool value) override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000940 flags_ = value ? (flags_ | DE_READ) : (flags_ & ~DE_READ);
941 }
942
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000943 bool writable() override { return (flags_ & DE_WRITE) != 0; }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000944
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +0000945 void set_writable(bool value) override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000946 flags_ = value ? (flags_ | DE_WRITE) : (flags_ & ~DE_WRITE);
947 }
948
949 private:
950 PhysicalSocketServer* ss_;
951 int fd_;
952 int flags_;
953};
954
955AsyncFile* PhysicalSocketServer::CreateFile(int fd) {
956 return new FileDispatcher(fd, this);
957}
958
959#endif // WEBRTC_POSIX
960
961#if defined(WEBRTC_WIN)
Peter Boström0c4e06b2015-10-07 12:23:21 +0200962static uint32_t FlagsToEvents(uint32_t events) {
963 uint32_t ffFD = FD_CLOSE;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000964 if (events & DE_READ)
965 ffFD |= FD_READ;
966 if (events & DE_WRITE)
967 ffFD |= FD_WRITE;
968 if (events & DE_CONNECT)
969 ffFD |= FD_CONNECT;
970 if (events & DE_ACCEPT)
971 ffFD |= FD_ACCEPT;
972 return ffFD;
973}
974
975class EventDispatcher : public Dispatcher {
976 public:
977 EventDispatcher(PhysicalSocketServer *ss) : ss_(ss) {
978 hev_ = WSACreateEvent();
979 if (hev_) {
980 ss_->Add(this);
981 }
982 }
983
984 ~EventDispatcher() {
985 if (hev_ != NULL) {
986 ss_->Remove(this);
987 WSACloseEvent(hev_);
988 hev_ = NULL;
989 }
990 }
991
992 virtual void Signal() {
993 if (hev_ != NULL)
994 WSASetEvent(hev_);
995 }
996
Peter Boström0c4e06b2015-10-07 12:23:21 +0200997 virtual uint32_t GetRequestedEvents() { return 0; }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +0000998
Peter Boström0c4e06b2015-10-07 12:23:21 +0200999 virtual void OnPreEvent(uint32_t ff) { WSAResetEvent(hev_); }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001000
Peter Boström0c4e06b2015-10-07 12:23:21 +02001001 virtual void OnEvent(uint32_t ff, int err) {}
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001002
1003 virtual WSAEVENT GetWSAEvent() {
1004 return hev_;
1005 }
1006
1007 virtual SOCKET GetSocket() {
1008 return INVALID_SOCKET;
1009 }
1010
1011 virtual bool CheckSignalClose() { return false; }
1012
1013private:
1014 PhysicalSocketServer* ss_;
1015 WSAEVENT hev_;
1016};
1017
1018class SocketDispatcher : public Dispatcher, public PhysicalSocket {
1019 public:
1020 static int next_id_;
1021 int id_;
1022 bool signal_close_;
1023 int signal_err_;
1024
1025 SocketDispatcher(PhysicalSocketServer* ss)
1026 : PhysicalSocket(ss),
1027 id_(0),
1028 signal_close_(false) {
1029 }
1030
1031 SocketDispatcher(SOCKET s, PhysicalSocketServer* ss)
1032 : PhysicalSocket(ss, s),
1033 id_(0),
1034 signal_close_(false) {
1035 }
1036
1037 virtual ~SocketDispatcher() {
1038 Close();
1039 }
1040
1041 bool Initialize() {
1042 ASSERT(s_ != INVALID_SOCKET);
1043 // Must be a non-blocking
1044 u_long argp = 1;
1045 ioctlsocket(s_, FIONBIO, &argp);
1046 ss_->Add(this);
1047 return true;
1048 }
1049
1050 virtual bool Create(int type) {
1051 return Create(AF_INET, type);
1052 }
1053
1054 virtual bool Create(int family, int type) {
1055 // Create socket
1056 if (!PhysicalSocket::Create(family, type))
1057 return false;
1058
1059 if (!Initialize())
1060 return false;
1061
1062 do { id_ = ++next_id_; } while (id_ == 0);
1063 return true;
1064 }
1065
1066 virtual int Close() {
1067 if (s_ == INVALID_SOCKET)
1068 return 0;
1069
1070 id_ = 0;
1071 signal_close_ = false;
1072 ss_->Remove(this);
1073 return PhysicalSocket::Close();
1074 }
1075
Peter Boström0c4e06b2015-10-07 12:23:21 +02001076 virtual uint32_t GetRequestedEvents() { return enabled_events_; }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001077
Peter Boström0c4e06b2015-10-07 12:23:21 +02001078 virtual void OnPreEvent(uint32_t ff) {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001079 if ((ff & DE_CONNECT) != 0)
1080 state_ = CS_CONNECTED;
1081 // We set CS_CLOSED from CheckSignalClose.
1082 }
1083
Peter Boström0c4e06b2015-10-07 12:23:21 +02001084 virtual void OnEvent(uint32_t ff, int err) {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001085 int cache_id = id_;
1086 // Make sure we deliver connect/accept first. Otherwise, consumers may see
1087 // something like a READ followed by a CONNECT, which would be odd.
1088 if (((ff & DE_CONNECT) != 0) && (id_ == cache_id)) {
1089 if (ff != DE_CONNECT)
1090 LOG(LS_VERBOSE) << "Signalled with DE_CONNECT: " << ff;
1091 enabled_events_ &= ~DE_CONNECT;
tfarinaa41ab932015-10-30 16:08:48 -07001092#if !defined(NDEBUG)
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001093 dbg_addr_ = "Connected @ ";
1094 dbg_addr_.append(GetRemoteAddress().ToString());
tfarinaa41ab932015-10-30 16:08:48 -07001095#endif
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001096 SignalConnectEvent(this);
1097 }
1098 if (((ff & DE_ACCEPT) != 0) && (id_ == cache_id)) {
1099 enabled_events_ &= ~DE_ACCEPT;
1100 SignalReadEvent(this);
1101 }
1102 if ((ff & DE_READ) != 0) {
1103 enabled_events_ &= ~DE_READ;
1104 SignalReadEvent(this);
1105 }
1106 if (((ff & DE_WRITE) != 0) && (id_ == cache_id)) {
1107 enabled_events_ &= ~DE_WRITE;
1108 SignalWriteEvent(this);
1109 }
1110 if (((ff & DE_CLOSE) != 0) && (id_ == cache_id)) {
1111 signal_close_ = true;
1112 signal_err_ = err;
1113 }
1114 }
1115
1116 virtual WSAEVENT GetWSAEvent() {
1117 return WSA_INVALID_EVENT;
1118 }
1119
1120 virtual SOCKET GetSocket() {
1121 return s_;
1122 }
1123
1124 virtual bool CheckSignalClose() {
1125 if (!signal_close_)
1126 return false;
1127
1128 char ch;
1129 if (recv(s_, &ch, 1, MSG_PEEK) > 0)
1130 return false;
1131
1132 state_ = CS_CLOSED;
1133 signal_close_ = false;
1134 SignalCloseEvent(this, signal_err_);
1135 return true;
1136 }
1137};
1138
1139int SocketDispatcher::next_id_ = 0;
1140
1141#endif // WEBRTC_WIN
1142
1143// Sets the value of a boolean value to false when signaled.
1144class Signaler : public EventDispatcher {
1145 public:
1146 Signaler(PhysicalSocketServer* ss, bool* pf)
1147 : EventDispatcher(ss), pf_(pf) {
1148 }
kwiberg@webrtc.org67186fe2015-03-09 22:21:53 +00001149 ~Signaler() override { }
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001150
Peter Boström0c4e06b2015-10-07 12:23:21 +02001151 void OnEvent(uint32_t ff, int err) override {
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001152 if (pf_)
1153 *pf_ = false;
1154 }
1155
1156 private:
1157 bool *pf_;
1158};
1159
1160PhysicalSocketServer::PhysicalSocketServer()
1161 : fWait_(false) {
1162 signal_wakeup_ = new Signaler(this, &fWait_);
1163#if defined(WEBRTC_WIN)
1164 socket_ev_ = WSACreateEvent();
1165#endif
1166}
1167
1168PhysicalSocketServer::~PhysicalSocketServer() {
1169#if defined(WEBRTC_WIN)
1170 WSACloseEvent(socket_ev_);
1171#endif
1172#if defined(WEBRTC_POSIX)
1173 signal_dispatcher_.reset();
1174#endif
1175 delete signal_wakeup_;
1176 ASSERT(dispatchers_.empty());
1177}
1178
1179void PhysicalSocketServer::WakeUp() {
1180 signal_wakeup_->Signal();
1181}
1182
1183Socket* PhysicalSocketServer::CreateSocket(int type) {
1184 return CreateSocket(AF_INET, type);
1185}
1186
1187Socket* PhysicalSocketServer::CreateSocket(int family, int type) {
1188 PhysicalSocket* socket = new PhysicalSocket(this);
1189 if (socket->Create(family, type)) {
1190 return socket;
1191 } else {
1192 delete socket;
1193 return 0;
1194 }
1195}
1196
1197AsyncSocket* PhysicalSocketServer::CreateAsyncSocket(int type) {
1198 return CreateAsyncSocket(AF_INET, type);
1199}
1200
1201AsyncSocket* PhysicalSocketServer::CreateAsyncSocket(int family, int type) {
1202 SocketDispatcher* dispatcher = new SocketDispatcher(this);
1203 if (dispatcher->Create(family, type)) {
1204 return dispatcher;
1205 } else {
1206 delete dispatcher;
1207 return 0;
1208 }
1209}
1210
1211AsyncSocket* PhysicalSocketServer::WrapSocket(SOCKET s) {
1212 SocketDispatcher* dispatcher = new SocketDispatcher(s, this);
1213 if (dispatcher->Initialize()) {
1214 return dispatcher;
1215 } else {
1216 delete dispatcher;
1217 return 0;
1218 }
1219}
1220
1221void PhysicalSocketServer::Add(Dispatcher *pdispatcher) {
1222 CritScope cs(&crit_);
1223 // Prevent duplicates. This can cause dead dispatchers to stick around.
1224 DispatcherList::iterator pos = std::find(dispatchers_.begin(),
1225 dispatchers_.end(),
1226 pdispatcher);
1227 if (pos != dispatchers_.end())
1228 return;
1229 dispatchers_.push_back(pdispatcher);
1230}
1231
1232void PhysicalSocketServer::Remove(Dispatcher *pdispatcher) {
1233 CritScope cs(&crit_);
1234 DispatcherList::iterator pos = std::find(dispatchers_.begin(),
1235 dispatchers_.end(),
1236 pdispatcher);
1237 // We silently ignore duplicate calls to Add, so we should silently ignore
1238 // the (expected) symmetric calls to Remove. Note that this may still hide
1239 // a real issue, so we at least log a warning about it.
1240 if (pos == dispatchers_.end()) {
1241 LOG(LS_WARNING) << "PhysicalSocketServer asked to remove a unknown "
1242 << "dispatcher, potentially from a duplicate call to Add.";
1243 return;
1244 }
1245 size_t index = pos - dispatchers_.begin();
1246 dispatchers_.erase(pos);
1247 for (IteratorList::iterator it = iterators_.begin(); it != iterators_.end();
1248 ++it) {
1249 if (index < **it) {
1250 --**it;
1251 }
1252 }
1253}
1254
1255#if defined(WEBRTC_POSIX)
1256bool PhysicalSocketServer::Wait(int cmsWait, bool process_io) {
1257 // Calculate timing information
1258
1259 struct timeval *ptvWait = NULL;
1260 struct timeval tvWait;
1261 struct timeval tvStop;
1262 if (cmsWait != kForever) {
1263 // Calculate wait timeval
1264 tvWait.tv_sec = cmsWait / 1000;
1265 tvWait.tv_usec = (cmsWait % 1000) * 1000;
1266 ptvWait = &tvWait;
1267
1268 // Calculate when to return in a timeval
1269 gettimeofday(&tvStop, NULL);
1270 tvStop.tv_sec += tvWait.tv_sec;
1271 tvStop.tv_usec += tvWait.tv_usec;
1272 if (tvStop.tv_usec >= 1000000) {
1273 tvStop.tv_usec -= 1000000;
1274 tvStop.tv_sec += 1;
1275 }
1276 }
1277
1278 // Zero all fd_sets. Don't need to do this inside the loop since
1279 // select() zeros the descriptors not signaled
1280
1281 fd_set fdsRead;
1282 FD_ZERO(&fdsRead);
1283 fd_set fdsWrite;
1284 FD_ZERO(&fdsWrite);
pbos@webrtc.org27e58982014-10-07 17:56:53 +00001285 // Explicitly unpoison these FDs on MemorySanitizer which doesn't handle the
1286 // inline assembly in FD_ZERO.
1287 // http://crbug.com/344505
1288#ifdef MEMORY_SANITIZER
1289 __msan_unpoison(&fdsRead, sizeof(fdsRead));
1290 __msan_unpoison(&fdsWrite, sizeof(fdsWrite));
1291#endif
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001292
1293 fWait_ = true;
1294
1295 while (fWait_) {
1296 int fdmax = -1;
1297 {
1298 CritScope cr(&crit_);
1299 for (size_t i = 0; i < dispatchers_.size(); ++i) {
1300 // Query dispatchers for read and write wait state
1301 Dispatcher *pdispatcher = dispatchers_[i];
1302 ASSERT(pdispatcher);
1303 if (!process_io && (pdispatcher != signal_wakeup_))
1304 continue;
1305 int fd = pdispatcher->GetDescriptor();
1306 if (fd > fdmax)
1307 fdmax = fd;
1308
Peter Boström0c4e06b2015-10-07 12:23:21 +02001309 uint32_t ff = pdispatcher->GetRequestedEvents();
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001310 if (ff & (DE_READ | DE_ACCEPT))
1311 FD_SET(fd, &fdsRead);
1312 if (ff & (DE_WRITE | DE_CONNECT))
1313 FD_SET(fd, &fdsWrite);
1314 }
1315 }
1316
1317 // Wait then call handlers as appropriate
1318 // < 0 means error
1319 // 0 means timeout
1320 // > 0 means count of descriptors ready
1321 int n = select(fdmax + 1, &fdsRead, &fdsWrite, NULL, ptvWait);
1322
1323 // If error, return error.
1324 if (n < 0) {
1325 if (errno != EINTR) {
1326 LOG_E(LS_ERROR, EN, errno) << "select";
1327 return false;
1328 }
1329 // Else ignore the error and keep going. If this EINTR was for one of the
1330 // signals managed by this PhysicalSocketServer, the
1331 // PosixSignalDeliveryDispatcher will be in the signaled state in the next
1332 // iteration.
1333 } else if (n == 0) {
1334 // If timeout, return success
1335 return true;
1336 } else {
1337 // We have signaled descriptors
1338 CritScope cr(&crit_);
1339 for (size_t i = 0; i < dispatchers_.size(); ++i) {
1340 Dispatcher *pdispatcher = dispatchers_[i];
1341 int fd = pdispatcher->GetDescriptor();
Peter Boström0c4e06b2015-10-07 12:23:21 +02001342 uint32_t ff = 0;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001343 int errcode = 0;
1344
1345 // Reap any error code, which can be signaled through reads or writes.
1346 // TODO: Should we set errcode if getsockopt fails?
1347 if (FD_ISSET(fd, &fdsRead) || FD_ISSET(fd, &fdsWrite)) {
1348 socklen_t len = sizeof(errcode);
1349 ::getsockopt(fd, SOL_SOCKET, SO_ERROR, &errcode, &len);
1350 }
1351
1352 // Check readable descriptors. If we're waiting on an accept, signal
1353 // that. Otherwise we're waiting for data, check to see if we're
1354 // readable or really closed.
1355 // TODO: Only peek at TCP descriptors.
1356 if (FD_ISSET(fd, &fdsRead)) {
1357 FD_CLR(fd, &fdsRead);
1358 if (pdispatcher->GetRequestedEvents() & DE_ACCEPT) {
1359 ff |= DE_ACCEPT;
1360 } else if (errcode || pdispatcher->IsDescriptorClosed()) {
1361 ff |= DE_CLOSE;
1362 } else {
1363 ff |= DE_READ;
1364 }
1365 }
1366
1367 // Check writable descriptors. If we're waiting on a connect, detect
1368 // success versus failure by the reaped error code.
1369 if (FD_ISSET(fd, &fdsWrite)) {
1370 FD_CLR(fd, &fdsWrite);
1371 if (pdispatcher->GetRequestedEvents() & DE_CONNECT) {
1372 if (!errcode) {
1373 ff |= DE_CONNECT;
1374 } else {
1375 ff |= DE_CLOSE;
1376 }
1377 } else {
1378 ff |= DE_WRITE;
1379 }
1380 }
1381
1382 // Tell the descriptor about the event.
1383 if (ff != 0) {
1384 pdispatcher->OnPreEvent(ff);
1385 pdispatcher->OnEvent(ff, errcode);
1386 }
1387 }
1388 }
1389
1390 // Recalc the time remaining to wait. Doing it here means it doesn't get
1391 // calced twice the first time through the loop
1392 if (ptvWait) {
1393 ptvWait->tv_sec = 0;
1394 ptvWait->tv_usec = 0;
1395 struct timeval tvT;
1396 gettimeofday(&tvT, NULL);
1397 if ((tvStop.tv_sec > tvT.tv_sec)
1398 || ((tvStop.tv_sec == tvT.tv_sec)
1399 && (tvStop.tv_usec > tvT.tv_usec))) {
1400 ptvWait->tv_sec = tvStop.tv_sec - tvT.tv_sec;
1401 ptvWait->tv_usec = tvStop.tv_usec - tvT.tv_usec;
1402 if (ptvWait->tv_usec < 0) {
1403 ASSERT(ptvWait->tv_sec > 0);
1404 ptvWait->tv_usec += 1000000;
1405 ptvWait->tv_sec -= 1;
1406 }
1407 }
1408 }
1409 }
1410
1411 return true;
1412}
1413
1414static void GlobalSignalHandler(int signum) {
1415 PosixSignalHandler::Instance()->OnPosixSignalReceived(signum);
1416}
1417
1418bool PhysicalSocketServer::SetPosixSignalHandler(int signum,
1419 void (*handler)(int)) {
1420 // If handler is SIG_IGN or SIG_DFL then clear our user-level handler,
1421 // otherwise set one.
1422 if (handler == SIG_IGN || handler == SIG_DFL) {
1423 if (!InstallSignal(signum, handler)) {
1424 return false;
1425 }
1426 if (signal_dispatcher_) {
1427 signal_dispatcher_->ClearHandler(signum);
1428 if (!signal_dispatcher_->HasHandlers()) {
1429 signal_dispatcher_.reset();
1430 }
1431 }
1432 } else {
1433 if (!signal_dispatcher_) {
1434 signal_dispatcher_.reset(new PosixSignalDispatcher(this));
1435 }
1436 signal_dispatcher_->SetHandler(signum, handler);
1437 if (!InstallSignal(signum, &GlobalSignalHandler)) {
1438 return false;
1439 }
1440 }
1441 return true;
1442}
1443
1444Dispatcher* PhysicalSocketServer::signal_dispatcher() {
1445 return signal_dispatcher_.get();
1446}
1447
1448bool PhysicalSocketServer::InstallSignal(int signum, void (*handler)(int)) {
1449 struct sigaction act;
1450 // It doesn't really matter what we set this mask to.
1451 if (sigemptyset(&act.sa_mask) != 0) {
1452 LOG_ERR(LS_ERROR) << "Couldn't set mask";
1453 return false;
1454 }
1455 act.sa_handler = handler;
1456#if !defined(__native_client__)
1457 // Use SA_RESTART so that our syscalls don't get EINTR, since we don't need it
1458 // and it's a nuisance. Though some syscalls still return EINTR and there's no
1459 // real standard for which ones. :(
1460 act.sa_flags = SA_RESTART;
1461#else
1462 act.sa_flags = 0;
1463#endif
1464 if (sigaction(signum, &act, NULL) != 0) {
1465 LOG_ERR(LS_ERROR) << "Couldn't set sigaction";
1466 return false;
1467 }
1468 return true;
1469}
1470#endif // WEBRTC_POSIX
1471
1472#if defined(WEBRTC_WIN)
1473bool PhysicalSocketServer::Wait(int cmsWait, bool process_io) {
1474 int cmsTotal = cmsWait;
1475 int cmsElapsed = 0;
Peter Boström0c4e06b2015-10-07 12:23:21 +02001476 uint32_t msStart = Time();
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001477
1478 fWait_ = true;
1479 while (fWait_) {
1480 std::vector<WSAEVENT> events;
1481 std::vector<Dispatcher *> event_owners;
1482
1483 events.push_back(socket_ev_);
1484
1485 {
1486 CritScope cr(&crit_);
1487 size_t i = 0;
1488 iterators_.push_back(&i);
1489 // Don't track dispatchers_.size(), because we want to pick up any new
1490 // dispatchers that were added while processing the loop.
1491 while (i < dispatchers_.size()) {
1492 Dispatcher* disp = dispatchers_[i++];
1493 if (!process_io && (disp != signal_wakeup_))
1494 continue;
1495 SOCKET s = disp->GetSocket();
1496 if (disp->CheckSignalClose()) {
1497 // We just signalled close, don't poll this socket
1498 } else if (s != INVALID_SOCKET) {
1499 WSAEventSelect(s,
1500 events[0],
1501 FlagsToEvents(disp->GetRequestedEvents()));
1502 } else {
1503 events.push_back(disp->GetWSAEvent());
1504 event_owners.push_back(disp);
1505 }
1506 }
1507 ASSERT(iterators_.back() == &i);
1508 iterators_.pop_back();
1509 }
1510
1511 // Which is shorter, the delay wait or the asked wait?
1512
1513 int cmsNext;
1514 if (cmsWait == kForever) {
1515 cmsNext = cmsWait;
1516 } else {
andresp@webrtc.orgff689be2015-02-12 11:54:26 +00001517 cmsNext = std::max(0, cmsTotal - cmsElapsed);
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001518 }
1519
1520 // Wait for one of the events to signal
1521 DWORD dw = WSAWaitForMultipleEvents(static_cast<DWORD>(events.size()),
1522 &events[0],
1523 false,
1524 cmsNext,
1525 false);
1526
1527 if (dw == WSA_WAIT_FAILED) {
1528 // Failed?
1529 // TODO: need a better strategy than this!
1530 WSAGetLastError();
1531 ASSERT(false);
1532 return false;
1533 } else if (dw == WSA_WAIT_TIMEOUT) {
1534 // Timeout?
1535 return true;
1536 } else {
1537 // Figure out which one it is and call it
1538 CritScope cr(&crit_);
1539 int index = dw - WSA_WAIT_EVENT_0;
1540 if (index > 0) {
1541 --index; // The first event is the socket event
1542 event_owners[index]->OnPreEvent(0);
1543 event_owners[index]->OnEvent(0, 0);
1544 } else if (process_io) {
1545 size_t i = 0, end = dispatchers_.size();
1546 iterators_.push_back(&i);
1547 iterators_.push_back(&end); // Don't iterate over new dispatchers.
1548 while (i < end) {
1549 Dispatcher* disp = dispatchers_[i++];
1550 SOCKET s = disp->GetSocket();
1551 if (s == INVALID_SOCKET)
1552 continue;
1553
1554 WSANETWORKEVENTS wsaEvents;
1555 int err = WSAEnumNetworkEvents(s, events[0], &wsaEvents);
1556 if (err == 0) {
1557
1558#if LOGGING
1559 {
1560 if ((wsaEvents.lNetworkEvents & FD_READ) &&
1561 wsaEvents.iErrorCode[FD_READ_BIT] != 0) {
1562 LOG(WARNING) << "PhysicalSocketServer got FD_READ_BIT error "
1563 << wsaEvents.iErrorCode[FD_READ_BIT];
1564 }
1565 if ((wsaEvents.lNetworkEvents & FD_WRITE) &&
1566 wsaEvents.iErrorCode[FD_WRITE_BIT] != 0) {
1567 LOG(WARNING) << "PhysicalSocketServer got FD_WRITE_BIT error "
1568 << wsaEvents.iErrorCode[FD_WRITE_BIT];
1569 }
1570 if ((wsaEvents.lNetworkEvents & FD_CONNECT) &&
1571 wsaEvents.iErrorCode[FD_CONNECT_BIT] != 0) {
1572 LOG(WARNING) << "PhysicalSocketServer got FD_CONNECT_BIT error "
1573 << wsaEvents.iErrorCode[FD_CONNECT_BIT];
1574 }
1575 if ((wsaEvents.lNetworkEvents & FD_ACCEPT) &&
1576 wsaEvents.iErrorCode[FD_ACCEPT_BIT] != 0) {
1577 LOG(WARNING) << "PhysicalSocketServer got FD_ACCEPT_BIT error "
1578 << wsaEvents.iErrorCode[FD_ACCEPT_BIT];
1579 }
1580 if ((wsaEvents.lNetworkEvents & FD_CLOSE) &&
1581 wsaEvents.iErrorCode[FD_CLOSE_BIT] != 0) {
1582 LOG(WARNING) << "PhysicalSocketServer got FD_CLOSE_BIT error "
1583 << wsaEvents.iErrorCode[FD_CLOSE_BIT];
1584 }
1585 }
1586#endif
Peter Boström0c4e06b2015-10-07 12:23:21 +02001587 uint32_t ff = 0;
henrike@webrtc.orgf0488722014-05-13 18:00:26 +00001588 int errcode = 0;
1589 if (wsaEvents.lNetworkEvents & FD_READ)
1590 ff |= DE_READ;
1591 if (wsaEvents.lNetworkEvents & FD_WRITE)
1592 ff |= DE_WRITE;
1593 if (wsaEvents.lNetworkEvents & FD_CONNECT) {
1594 if (wsaEvents.iErrorCode[FD_CONNECT_BIT] == 0) {
1595 ff |= DE_CONNECT;
1596 } else {
1597 ff |= DE_CLOSE;
1598 errcode = wsaEvents.iErrorCode[FD_CONNECT_BIT];
1599 }
1600 }
1601 if (wsaEvents.lNetworkEvents & FD_ACCEPT)
1602 ff |= DE_ACCEPT;
1603 if (wsaEvents.lNetworkEvents & FD_CLOSE) {
1604 ff |= DE_CLOSE;
1605 errcode = wsaEvents.iErrorCode[FD_CLOSE_BIT];
1606 }
1607 if (ff != 0) {
1608 disp->OnPreEvent(ff);
1609 disp->OnEvent(ff, errcode);
1610 }
1611 }
1612 }
1613 ASSERT(iterators_.back() == &end);
1614 iterators_.pop_back();
1615 ASSERT(iterators_.back() == &i);
1616 iterators_.pop_back();
1617 }
1618
1619 // Reset the network event until new activity occurs
1620 WSAResetEvent(socket_ev_);
1621 }
1622
1623 // Break?
1624 if (!fWait_)
1625 break;
1626 cmsElapsed = TimeSince(msStart);
1627 if ((cmsWait != kForever) && (cmsElapsed >= cmsWait)) {
1628 break;
1629 }
1630 }
1631
1632 // Done
1633 return true;
1634}
1635#endif // WEBRTC_WIN
1636
1637} // namespace rtc