henrike@webrtc.org | f048872 | 2014-05-13 18:00:26 +0000 | [diff] [blame] | 1 | /* |
| 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 | |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 11 | #ifndef RTC_BASE_VIRTUALSOCKETSERVER_H_ |
| 12 | #define RTC_BASE_VIRTUALSOCKETSERVER_H_ |
henrike@webrtc.org | f048872 | 2014-05-13 18:00:26 +0000 | [diff] [blame] | 13 | |
Henrik Kjellander | ec78f1c | 2017-06-29 07:52:50 +0200 | [diff] [blame] | 14 | #include <deque> |
| 15 | #include <map> |
henrike@webrtc.org | f048872 | 2014-05-13 18:00:26 +0000 | [diff] [blame] | 16 | |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 17 | #include "rtc_base/checks.h" |
| 18 | #include "rtc_base/constructormagic.h" |
| 19 | #include "rtc_base/event.h" |
| 20 | #include "rtc_base/fakeclock.h" |
| 21 | #include "rtc_base/messagequeue.h" |
| 22 | #include "rtc_base/socketserver.h" |
Henrik Kjellander | ec78f1c | 2017-06-29 07:52:50 +0200 | [diff] [blame] | 23 | |
| 24 | namespace rtc { |
| 25 | |
| 26 | class Packet; |
| 27 | class VirtualSocket; |
| 28 | class SocketAddressPair; |
| 29 | |
| 30 | // Simulates a network in the same manner as a loopback interface. The |
| 31 | // interface can create as many addresses as you want. All of the sockets |
| 32 | // created by this network will be able to communicate with one another, unless |
| 33 | // they are bound to addresses from incompatible families. |
| 34 | class VirtualSocketServer : public SocketServer, public sigslot::has_slots<> { |
| 35 | public: |
| 36 | VirtualSocketServer(); |
| 37 | // This constructor needs to be used if the test uses a fake clock and |
| 38 | // ProcessMessagesUntilIdle, since ProcessMessagesUntilIdle needs a way of |
| 39 | // advancing time. |
| 40 | explicit VirtualSocketServer(FakeClock* fake_clock); |
| 41 | ~VirtualSocketServer() override; |
| 42 | |
| 43 | // The default route indicates which local address to use when a socket is |
| 44 | // bound to the 'any' address, e.g. 0.0.0.0. |
| 45 | IPAddress GetDefaultRoute(int family); |
| 46 | void SetDefaultRoute(const IPAddress& from_addr); |
| 47 | |
| 48 | // Limits the network bandwidth (maximum bytes per second). Zero means that |
| 49 | // all sends occur instantly. Defaults to 0. |
| 50 | uint32_t bandwidth() const { return bandwidth_; } |
| 51 | void set_bandwidth(uint32_t bandwidth) { bandwidth_ = bandwidth; } |
| 52 | |
| 53 | // Limits the amount of data which can be in flight on the network without |
| 54 | // packet loss (on a per sender basis). Defaults to 64 KB. |
| 55 | uint32_t network_capacity() const { return network_capacity_; } |
| 56 | void set_network_capacity(uint32_t capacity) { network_capacity_ = capacity; } |
| 57 | |
| 58 | // The amount of data which can be buffered by tcp on the sender's side |
| 59 | uint32_t send_buffer_capacity() const { return send_buffer_capacity_; } |
| 60 | void set_send_buffer_capacity(uint32_t capacity) { |
| 61 | send_buffer_capacity_ = capacity; |
| 62 | } |
| 63 | |
| 64 | // The amount of data which can be buffered by tcp on the receiver's side |
| 65 | uint32_t recv_buffer_capacity() const { return recv_buffer_capacity_; } |
| 66 | void set_recv_buffer_capacity(uint32_t capacity) { |
| 67 | recv_buffer_capacity_ = capacity; |
| 68 | } |
| 69 | |
| 70 | // Controls the (transit) delay for packets sent in the network. This does |
| 71 | // not inclue the time required to sit in the send queue. Both of these |
| 72 | // values are measured in milliseconds. Defaults to no delay. |
| 73 | uint32_t delay_mean() const { return delay_mean_; } |
| 74 | uint32_t delay_stddev() const { return delay_stddev_; } |
| 75 | uint32_t delay_samples() const { return delay_samples_; } |
| 76 | void set_delay_mean(uint32_t delay_mean) { delay_mean_ = delay_mean; } |
| 77 | void set_delay_stddev(uint32_t delay_stddev) { delay_stddev_ = delay_stddev; } |
| 78 | void set_delay_samples(uint32_t delay_samples) { |
| 79 | delay_samples_ = delay_samples; |
| 80 | } |
| 81 | |
| 82 | // If the (transit) delay parameters are modified, this method should be |
| 83 | // called to recompute the new distribution. |
| 84 | void UpdateDelayDistribution(); |
| 85 | |
| 86 | // Controls the (uniform) probability that any sent packet is dropped. This |
| 87 | // is separate from calculations to drop based on queue size. |
| 88 | double drop_probability() { return drop_prob_; } |
| 89 | void set_drop_probability(double drop_prob) { |
| 90 | RTC_DCHECK_GE(drop_prob, 0.0); |
| 91 | RTC_DCHECK_LE(drop_prob, 1.0); |
| 92 | drop_prob_ = drop_prob; |
| 93 | } |
| 94 | |
| 95 | // If |blocked| is true, subsequent attempts to send will result in -1 being |
| 96 | // returned, with the socket error set to EWOULDBLOCK. |
| 97 | // |
| 98 | // If this method is later called with |blocked| set to false, any sockets |
| 99 | // that previously failed to send with EWOULDBLOCK will emit SignalWriteEvent. |
| 100 | // |
| 101 | // This can be used to simulate the send buffer on a network interface being |
| 102 | // full, and test functionality related to EWOULDBLOCK/SignalWriteEvent. |
| 103 | void SetSendingBlocked(bool blocked); |
| 104 | |
| 105 | // SocketFactory: |
| 106 | Socket* CreateSocket(int type) override; |
| 107 | Socket* CreateSocket(int family, int type) override; |
| 108 | |
| 109 | AsyncSocket* CreateAsyncSocket(int type) override; |
| 110 | AsyncSocket* CreateAsyncSocket(int family, int type) override; |
| 111 | |
| 112 | // SocketServer: |
| 113 | void SetMessageQueue(MessageQueue* queue) override; |
| 114 | bool Wait(int cms, bool process_io) override; |
| 115 | void WakeUp() override; |
| 116 | |
| 117 | void SetDelayOnAddress(const rtc::SocketAddress& address, int delay_ms) { |
| 118 | delay_by_ip_[address.ipaddr()] = delay_ms; |
| 119 | } |
| 120 | |
deadbeef | 5c3c104 | 2017-08-04 15:01:57 -0700 | [diff] [blame] | 121 | // Used by TurnPortTest and TcpPortTest (for example), to mimic a case where |
| 122 | // a proxy returns the local host address instead of the original one the |
| 123 | // port was bound against. Please see WebRTC issue 3927 for more detail. |
| 124 | // |
| 125 | // If SetAlternativeLocalAddress(A, B) is called, then when something |
| 126 | // attempts to bind a socket to address A, it will get a socket bound to |
| 127 | // address B instead. |
| 128 | void SetAlternativeLocalAddress(const rtc::IPAddress& address, |
| 129 | const rtc::IPAddress& alternative); |
| 130 | |
Henrik Kjellander | ec78f1c | 2017-06-29 07:52:50 +0200 | [diff] [blame] | 131 | typedef std::pair<double, double> Point; |
| 132 | typedef std::vector<Point> Function; |
| 133 | |
| 134 | static Function* CreateDistribution(uint32_t mean, |
| 135 | uint32_t stddev, |
| 136 | uint32_t samples); |
| 137 | |
| 138 | // Similar to Thread::ProcessMessages, but it only processes messages until |
| 139 | // there are no immediate messages or pending network traffic. Returns false |
| 140 | // if Thread::Stop() was called. |
| 141 | bool ProcessMessagesUntilIdle(); |
| 142 | |
| 143 | // Sets the next port number to use for testing. |
| 144 | void SetNextPortForTesting(uint16_t port); |
| 145 | |
| 146 | // Close a pair of Tcp connections by addresses. Both connections will have |
| 147 | // its own OnClose invoked. |
| 148 | bool CloseTcpConnections(const SocketAddress& addr_local, |
| 149 | const SocketAddress& addr_remote); |
| 150 | |
| 151 | // For testing purpose only. Fired when a client socket is created. |
| 152 | sigslot::signal1<VirtualSocket*> SignalSocketCreated; |
| 153 | |
| 154 | protected: |
| 155 | // Returns a new IP not used before in this network. |
| 156 | IPAddress GetNextIP(int family); |
| 157 | uint16_t GetNextPort(); |
| 158 | |
| 159 | VirtualSocket* CreateSocketInternal(int family, int type); |
| 160 | |
| 161 | // Binds the given socket to addr, assigning and IP and Port if necessary |
| 162 | int Bind(VirtualSocket* socket, SocketAddress* addr); |
| 163 | |
| 164 | // Binds the given socket to the given (fully-defined) address. |
| 165 | int Bind(VirtualSocket* socket, const SocketAddress& addr); |
| 166 | |
| 167 | // Find the socket bound to the given address |
| 168 | VirtualSocket* LookupBinding(const SocketAddress& addr); |
| 169 | |
| 170 | int Unbind(const SocketAddress& addr, VirtualSocket* socket); |
| 171 | |
| 172 | // Adds a mapping between this socket pair and the socket. |
| 173 | void AddConnection(const SocketAddress& client, |
| 174 | const SocketAddress& server, |
| 175 | VirtualSocket* socket); |
| 176 | |
| 177 | // Find the socket pair corresponding to this server address. |
| 178 | VirtualSocket* LookupConnection(const SocketAddress& client, |
| 179 | const SocketAddress& server); |
| 180 | |
| 181 | void RemoveConnection(const SocketAddress& client, |
| 182 | const SocketAddress& server); |
| 183 | |
| 184 | // Connects the given socket to the socket at the given address |
| 185 | int Connect(VirtualSocket* socket, const SocketAddress& remote_addr, |
| 186 | bool use_delay); |
| 187 | |
| 188 | // Sends a disconnect message to the socket at the given address |
| 189 | bool Disconnect(VirtualSocket* socket); |
| 190 | |
| 191 | // Sends the given packet to the socket at the given address (if one exists). |
| 192 | int SendUdp(VirtualSocket* socket, const char* data, size_t data_size, |
| 193 | const SocketAddress& remote_addr); |
| 194 | |
| 195 | // Moves as much data as possible from the sender's buffer to the network |
| 196 | void SendTcp(VirtualSocket* socket); |
| 197 | |
| 198 | // Places a packet on the network. |
| 199 | void AddPacketToNetwork(VirtualSocket* socket, |
| 200 | VirtualSocket* recipient, |
| 201 | int64_t cur_time, |
| 202 | const char* data, |
| 203 | size_t data_size, |
| 204 | size_t header_size, |
| 205 | bool ordered); |
| 206 | |
| 207 | // Removes stale packets from the network |
| 208 | void PurgeNetworkPackets(VirtualSocket* socket, int64_t cur_time); |
| 209 | |
| 210 | // Computes the number of milliseconds required to send a packet of this size. |
| 211 | uint32_t SendDelay(uint32_t size); |
| 212 | |
| 213 | // If the delay has been set for the address of the socket, returns the set |
| 214 | // delay. Otherwise, returns a random transit delay chosen from the |
| 215 | // appropriate distribution. |
| 216 | uint32_t GetTransitDelay(Socket* socket); |
| 217 | |
| 218 | // Basic operations on functions. Those that return a function also take |
| 219 | // ownership of the function given (and hence, may modify or delete it). |
| 220 | static Function* Accumulate(Function* f); |
| 221 | static Function* Invert(Function* f); |
| 222 | static Function* Resample(Function* f, |
| 223 | double x1, |
| 224 | double x2, |
| 225 | uint32_t samples); |
| 226 | static double Evaluate(Function* f, double x); |
| 227 | |
| 228 | // Null out our message queue if it goes away. Necessary in the case where |
| 229 | // our lifetime is greater than that of the thread we are using, since we |
| 230 | // try to send Close messages for all connected sockets when we shutdown. |
| 231 | void OnMessageQueueDestroyed() { msg_queue_ = nullptr; } |
| 232 | |
| 233 | // Determine if two sockets should be able to communicate. |
| 234 | // We don't (currently) specify an address family for sockets; instead, |
| 235 | // the currently bound address is used to infer the address family. |
| 236 | // Any socket that is not explicitly bound to an IPv4 address is assumed to be |
| 237 | // dual-stack capable. |
| 238 | // This function tests if two addresses can communicate, as well as the |
| 239 | // sockets to which they may be bound (the addresses may or may not yet be |
| 240 | // bound to the sockets). |
| 241 | // First the addresses are tested (after normalization): |
| 242 | // If both have the same family, then communication is OK. |
| 243 | // If only one is IPv4 then false, unless the other is bound to ::. |
| 244 | // This applies even if the IPv4 address is 0.0.0.0. |
| 245 | // The socket arguments are optional; the sockets are checked to see if they |
| 246 | // were explicitly bound to IPv6-any ('::'), and if so communication is |
| 247 | // permitted. |
| 248 | // NB: This scheme doesn't permit non-dualstack IPv6 sockets. |
| 249 | static bool CanInteractWith(VirtualSocket* local, VirtualSocket* remote); |
| 250 | |
| 251 | private: |
| 252 | friend class VirtualSocket; |
| 253 | |
| 254 | // Sending was previously blocked, but now isn't. |
| 255 | sigslot::signal0<> SignalReadyToSend; |
| 256 | |
| 257 | typedef std::map<SocketAddress, VirtualSocket*> AddressMap; |
| 258 | typedef std::map<SocketAddressPair, VirtualSocket*> ConnectionMap; |
| 259 | |
| 260 | // May be null if the test doesn't use a fake clock, or it does but doesn't |
| 261 | // use ProcessMessagesUntilIdle. |
| 262 | FakeClock* fake_clock_ = nullptr; |
| 263 | |
| 264 | // Used to implement Wait/WakeUp. |
| 265 | Event wakeup_; |
| 266 | MessageQueue* msg_queue_; |
| 267 | bool stop_on_idle_; |
| 268 | in_addr next_ipv4_; |
| 269 | in6_addr next_ipv6_; |
| 270 | uint16_t next_port_; |
| 271 | AddressMap* bindings_; |
| 272 | ConnectionMap* connections_; |
| 273 | |
| 274 | IPAddress default_route_v4_; |
| 275 | IPAddress default_route_v6_; |
| 276 | |
| 277 | uint32_t bandwidth_; |
| 278 | uint32_t network_capacity_; |
| 279 | uint32_t send_buffer_capacity_; |
| 280 | uint32_t recv_buffer_capacity_; |
| 281 | uint32_t delay_mean_; |
| 282 | uint32_t delay_stddev_; |
| 283 | uint32_t delay_samples_; |
| 284 | |
| 285 | std::map<rtc::IPAddress, int> delay_by_ip_; |
deadbeef | 5c3c104 | 2017-08-04 15:01:57 -0700 | [diff] [blame] | 286 | std::map<rtc::IPAddress, rtc::IPAddress> alternative_address_mapping_; |
Henrik Kjellander | ec78f1c | 2017-06-29 07:52:50 +0200 | [diff] [blame] | 287 | std::unique_ptr<Function> delay_dist_; |
| 288 | |
| 289 | CriticalSection delay_crit_; |
| 290 | |
| 291 | double drop_prob_; |
| 292 | bool sending_blocked_ = false; |
| 293 | RTC_DISALLOW_COPY_AND_ASSIGN(VirtualSocketServer); |
| 294 | }; |
| 295 | |
| 296 | // Implements the socket interface using the virtual network. Packets are |
| 297 | // passed as messages using the message queue of the socket server. |
| 298 | class VirtualSocket : public AsyncSocket, |
| 299 | public MessageHandler, |
| 300 | public sigslot::has_slots<> { |
| 301 | public: |
| 302 | VirtualSocket(VirtualSocketServer* server, int family, int type, bool async); |
| 303 | ~VirtualSocket() override; |
| 304 | |
| 305 | SocketAddress GetLocalAddress() const override; |
| 306 | SocketAddress GetRemoteAddress() const override; |
| 307 | |
Henrik Kjellander | ec78f1c | 2017-06-29 07:52:50 +0200 | [diff] [blame] | 308 | int Bind(const SocketAddress& addr) override; |
| 309 | int Connect(const SocketAddress& addr) override; |
| 310 | int Close() override; |
| 311 | int Send(const void* pv, size_t cb) override; |
| 312 | int SendTo(const void* pv, size_t cb, const SocketAddress& addr) override; |
| 313 | int Recv(void* pv, size_t cb, int64_t* timestamp) override; |
| 314 | int RecvFrom(void* pv, |
| 315 | size_t cb, |
| 316 | SocketAddress* paddr, |
| 317 | int64_t* timestamp) override; |
| 318 | int Listen(int backlog) override; |
| 319 | VirtualSocket* Accept(SocketAddress* paddr) override; |
| 320 | |
| 321 | int GetError() const override; |
| 322 | void SetError(int error) override; |
| 323 | ConnState GetState() const override; |
| 324 | int GetOption(Option opt, int* value) override; |
| 325 | int SetOption(Option opt, int value) override; |
| 326 | void OnMessage(Message* pmsg) override; |
| 327 | |
| 328 | bool was_any() { return was_any_; } |
| 329 | void set_was_any(bool was_any) { was_any_ = was_any; } |
| 330 | |
| 331 | // For testing purpose only. Fired when client socket is bound to an address. |
| 332 | sigslot::signal2<VirtualSocket*, const SocketAddress&> SignalAddressReady; |
| 333 | |
| 334 | private: |
| 335 | struct NetworkEntry { |
| 336 | size_t size; |
| 337 | int64_t done_time; |
| 338 | }; |
| 339 | |
| 340 | typedef std::deque<SocketAddress> ListenQueue; |
| 341 | typedef std::deque<NetworkEntry> NetworkQueue; |
| 342 | typedef std::vector<char> SendBuffer; |
| 343 | typedef std::list<Packet*> RecvBuffer; |
| 344 | typedef std::map<Option, int> OptionsMap; |
| 345 | |
| 346 | int InitiateConnect(const SocketAddress& addr, bool use_delay); |
| 347 | void CompleteConnect(const SocketAddress& addr, bool notify); |
| 348 | int SendUdp(const void* pv, size_t cb, const SocketAddress& addr); |
| 349 | int SendTcp(const void* pv, size_t cb); |
| 350 | |
| 351 | // Used by server sockets to set the local address without binding. |
| 352 | void SetLocalAddress(const SocketAddress& addr); |
| 353 | |
| 354 | void OnSocketServerReadyToSend(); |
| 355 | |
| 356 | VirtualSocketServer* server_; |
| 357 | int type_; |
| 358 | bool async_; |
| 359 | ConnState state_; |
| 360 | int error_; |
| 361 | SocketAddress local_addr_; |
Henrik Kjellander | ec78f1c | 2017-06-29 07:52:50 +0200 | [diff] [blame] | 362 | SocketAddress remote_addr_; |
| 363 | |
| 364 | // Pending sockets which can be Accepted |
| 365 | ListenQueue* listen_queue_; |
| 366 | |
| 367 | // Data which tcp has buffered for sending |
| 368 | SendBuffer send_buffer_; |
| 369 | // Set to false if the last attempt to send resulted in EWOULDBLOCK. |
| 370 | // Set back to true when the socket can send again. |
| 371 | bool ready_to_send_ = true; |
| 372 | |
| 373 | // Critical section to protect the recv_buffer and queue_ |
| 374 | CriticalSection crit_; |
| 375 | |
| 376 | // Network model that enforces bandwidth and capacity constraints |
| 377 | NetworkQueue network_; |
| 378 | size_t network_size_; |
| 379 | // The scheduled delivery time of the last packet sent on this socket. |
| 380 | // It is used to ensure ordered delivery of packets sent on this socket. |
| 381 | int64_t last_delivery_time_ = 0; |
| 382 | |
| 383 | // Data which has been received from the network |
| 384 | RecvBuffer recv_buffer_; |
| 385 | // The amount of data which is in flight or in recv_buffer_ |
| 386 | size_t recv_buffer_size_; |
| 387 | |
| 388 | // Is this socket bound? |
| 389 | bool bound_; |
| 390 | |
| 391 | // When we bind a socket to Any, VSS's Bind gives it another address. For |
| 392 | // dual-stack sockets, we want to distinguish between sockets that were |
| 393 | // explicitly given a particular address and sockets that had one picked |
| 394 | // for them by VSS. |
| 395 | bool was_any_; |
| 396 | |
| 397 | // Store the options that are set |
| 398 | OptionsMap options_map_; |
| 399 | |
| 400 | friend class VirtualSocketServer; |
| 401 | }; |
| 402 | |
| 403 | } // namespace rtc |
henrike@webrtc.org | f048872 | 2014-05-13 18:00:26 +0000 | [diff] [blame] | 404 | |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 405 | #endif // RTC_BASE_VIRTUALSOCKETSERVER_H_ |