TCPSocket.cpp 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683
  1. /*
  2. * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #include <AK/Singleton.h>
  7. #include <AK/Time.h>
  8. #include <Kernel/Debug.h>
  9. #include <Kernel/Devices/Generic/RandomDevice.h>
  10. #include <Kernel/FileSystem/OpenFileDescription.h>
  11. #include <Kernel/Locking/MutexProtected.h>
  12. #include <Kernel/Net/EthernetFrameHeader.h>
  13. #include <Kernel/Net/IPv4.h>
  14. #include <Kernel/Net/NetworkAdapter.h>
  15. #include <Kernel/Net/NetworkingManagement.h>
  16. #include <Kernel/Net/Routing.h>
  17. #include <Kernel/Net/TCP.h>
  18. #include <Kernel/Net/TCPSocket.h>
  19. #include <Kernel/Security/Random.h>
  20. #include <Kernel/Tasks/Process.h>
  21. #include <Kernel/Time/TimeManagement.h>
  22. namespace Kernel {
  23. void TCPSocket::for_each(Function<void(TCPSocket const&)> callback)
  24. {
  25. sockets_by_tuple().for_each_shared([&](auto const& it) {
  26. callback(*it.value);
  27. });
  28. }
  29. ErrorOr<void> TCPSocket::try_for_each(Function<ErrorOr<void>(TCPSocket const&)> callback)
  30. {
  31. return sockets_by_tuple().with_shared([&](auto const& sockets) -> ErrorOr<void> {
  32. for (auto& it : sockets)
  33. TRY(callback(*it.value));
  34. return {};
  35. });
  36. }
  37. bool TCPSocket::unref() const
  38. {
  39. bool did_hit_zero = sockets_by_tuple().with_exclusive([&](auto& table) {
  40. if (deref_base())
  41. return false;
  42. table.remove(tuple());
  43. const_cast<TCPSocket&>(*this).revoke_weak_ptrs();
  44. return true;
  45. });
  46. if (did_hit_zero) {
  47. const_cast<TCPSocket&>(*this).will_be_destroyed();
  48. delete this;
  49. }
  50. return did_hit_zero;
  51. }
  52. void TCPSocket::set_state(State new_state)
  53. {
  54. dbgln_if(TCP_SOCKET_DEBUG, "TCPSocket({}) state moving from {} to {}", this, to_string(m_state), to_string(new_state));
  55. auto was_disconnected = protocol_is_disconnected();
  56. auto previous_role = m_role;
  57. m_state = new_state;
  58. if (new_state == State::Established && m_direction == Direction::Outgoing) {
  59. set_role(Role::Connected);
  60. clear_so_error();
  61. }
  62. if (new_state == State::TimeWait) {
  63. // Once we hit TimeWait, we are only holding the socket in case there
  64. // are packets on the way which we wouldn't want a new socket to get hit
  65. // with, so there's no point in keeping the receive buffer around.
  66. drop_receive_buffer();
  67. }
  68. if (new_state == State::Closed) {
  69. closing_sockets().with_exclusive([&](auto& table) {
  70. table.remove(tuple());
  71. });
  72. if (m_originator)
  73. release_to_originator();
  74. }
  75. if (previous_role != m_role || was_disconnected != protocol_is_disconnected())
  76. evaluate_block_conditions();
  77. }
  78. static Singleton<MutexProtected<HashMap<IPv4SocketTuple, RefPtr<TCPSocket>>>> s_socket_closing;
  79. MutexProtected<HashMap<IPv4SocketTuple, RefPtr<TCPSocket>>>& TCPSocket::closing_sockets()
  80. {
  81. return *s_socket_closing;
  82. }
  83. static Singleton<MutexProtected<HashMap<IPv4SocketTuple, TCPSocket*>>> s_socket_tuples;
  84. MutexProtected<HashMap<IPv4SocketTuple, TCPSocket*>>& TCPSocket::sockets_by_tuple()
  85. {
  86. return *s_socket_tuples;
  87. }
  88. RefPtr<TCPSocket> TCPSocket::from_tuple(IPv4SocketTuple const& tuple)
  89. {
  90. return sockets_by_tuple().with_shared([&](auto const& table) -> RefPtr<TCPSocket> {
  91. auto exact_match = table.get(tuple);
  92. if (exact_match.has_value())
  93. return { *exact_match.value() };
  94. auto address_tuple = IPv4SocketTuple(tuple.local_address(), tuple.local_port(), IPv4Address(), 0);
  95. auto address_match = table.get(address_tuple);
  96. if (address_match.has_value())
  97. return { *address_match.value() };
  98. auto wildcard_tuple = IPv4SocketTuple(IPv4Address(), tuple.local_port(), IPv4Address(), 0);
  99. auto wildcard_match = table.get(wildcard_tuple);
  100. if (wildcard_match.has_value())
  101. return { *wildcard_match.value() };
  102. return {};
  103. });
  104. }
  105. ErrorOr<NonnullRefPtr<TCPSocket>> TCPSocket::try_create_client(IPv4Address const& new_local_address, u16 new_local_port, IPv4Address const& new_peer_address, u16 new_peer_port)
  106. {
  107. auto tuple = IPv4SocketTuple(new_local_address, new_local_port, new_peer_address, new_peer_port);
  108. return sockets_by_tuple().with_exclusive([&](auto& table) -> ErrorOr<NonnullRefPtr<TCPSocket>> {
  109. if (table.contains(tuple))
  110. return EEXIST;
  111. auto receive_buffer = TRY(try_create_receive_buffer());
  112. auto client = TRY(TCPSocket::try_create(protocol(), move(receive_buffer)));
  113. client->set_setup_state(SetupState::InProgress);
  114. client->set_local_address(new_local_address);
  115. client->set_local_port(new_local_port);
  116. client->set_peer_address(new_peer_address);
  117. client->set_peer_port(new_peer_port);
  118. client->set_bound(true);
  119. client->set_direction(Direction::Incoming);
  120. client->set_originator(*this);
  121. m_pending_release_for_accept.set(tuple, client);
  122. table.set(tuple, client);
  123. return { move(client) };
  124. });
  125. }
  126. void TCPSocket::release_to_originator()
  127. {
  128. VERIFY(!!m_originator);
  129. m_originator.strong_ref()->release_for_accept(*this);
  130. m_originator.clear();
  131. }
  132. void TCPSocket::release_for_accept(NonnullRefPtr<TCPSocket> socket)
  133. {
  134. VERIFY(m_pending_release_for_accept.contains(socket->tuple()));
  135. m_pending_release_for_accept.remove(socket->tuple());
  136. // FIXME: Should we observe this error somehow?
  137. [[maybe_unused]] auto rc = queue_connection_from(move(socket));
  138. }
  139. TCPSocket::TCPSocket(int protocol, NonnullOwnPtr<DoubleBuffer> receive_buffer, NonnullOwnPtr<KBuffer> scratch_buffer)
  140. : IPv4Socket(SOCK_STREAM, protocol, move(receive_buffer), move(scratch_buffer))
  141. , m_last_ack_sent_time(TimeManagement::the().monotonic_time())
  142. , m_last_retransmit_time(TimeManagement::the().monotonic_time())
  143. {
  144. }
  145. TCPSocket::~TCPSocket()
  146. {
  147. dequeue_for_retransmit();
  148. dbgln_if(TCP_SOCKET_DEBUG, "~TCPSocket in state {}", to_string(state()));
  149. }
  150. ErrorOr<NonnullRefPtr<TCPSocket>> TCPSocket::try_create(int protocol, NonnullOwnPtr<DoubleBuffer> receive_buffer)
  151. {
  152. // Note: Scratch buffer is only used for SOCK_STREAM sockets.
  153. auto scratch_buffer = TRY(KBuffer::try_create_with_size("TCPSocket: Scratch buffer"sv, 65536));
  154. return adopt_nonnull_ref_or_enomem(new (nothrow) TCPSocket(protocol, move(receive_buffer), move(scratch_buffer)));
  155. }
  156. ErrorOr<size_t> TCPSocket::protocol_size(ReadonlyBytes raw_ipv4_packet)
  157. {
  158. auto& ipv4_packet = *reinterpret_cast<IPv4Packet const*>(raw_ipv4_packet.data());
  159. auto& tcp_packet = *static_cast<TCPPacket const*>(ipv4_packet.payload());
  160. return raw_ipv4_packet.size() - sizeof(IPv4Packet) - tcp_packet.header_size();
  161. }
  162. ErrorOr<size_t> TCPSocket::protocol_receive(ReadonlyBytes raw_ipv4_packet, UserOrKernelBuffer& buffer, size_t buffer_size, [[maybe_unused]] int flags)
  163. {
  164. auto& ipv4_packet = *reinterpret_cast<IPv4Packet const*>(raw_ipv4_packet.data());
  165. auto& tcp_packet = *static_cast<TCPPacket const*>(ipv4_packet.payload());
  166. size_t payload_size = raw_ipv4_packet.size() - sizeof(IPv4Packet) - tcp_packet.header_size();
  167. dbgln_if(TCP_SOCKET_DEBUG, "payload_size {}, will it fit in {}?", payload_size, buffer_size);
  168. VERIFY(buffer_size >= payload_size);
  169. SOCKET_TRY(buffer.write(tcp_packet.payload(), payload_size));
  170. return payload_size;
  171. }
  172. ErrorOr<size_t> TCPSocket::protocol_send(UserOrKernelBuffer const& data, size_t data_length)
  173. {
  174. auto adapter = bound_interface().with([](auto& bound_device) -> RefPtr<NetworkAdapter> { return bound_device; });
  175. RoutingDecision routing_decision = route_to(peer_address(), local_address(), adapter);
  176. if (routing_decision.is_zero())
  177. return set_so_error(EHOSTUNREACH);
  178. size_t mss = routing_decision.adapter->mtu() - sizeof(IPv4Packet) - sizeof(TCPPacket);
  179. // RFC 896 (Nagle’s algorithm): https://www.ietf.org/rfc/rfc0896
  180. // "The solution is to inhibit the sending of new TCP segments when
  181. // new outgoing data arrives from the user if any previously
  182. // transmitted data on the connection remains unacknowledged. This
  183. // inhibition is to be unconditional; no timers, tests for size of
  184. // data received, or other conditions are required."
  185. // FIXME: Make this configurable via TCP_NODELAY.
  186. auto has_unacked_data = m_unacked_packets.with_shared([&](auto const& packets) { return packets.size > 0; });
  187. if (has_unacked_data && data_length < mss)
  188. return 0;
  189. data_length = min(data_length, mss);
  190. TRY(send_tcp_packet(TCPFlags::PSH | TCPFlags::ACK, &data, data_length, &routing_decision));
  191. return data_length;
  192. }
  193. ErrorOr<void> TCPSocket::send_ack(bool allow_duplicate)
  194. {
  195. if (!allow_duplicate && m_last_ack_number_sent == m_ack_number)
  196. return {};
  197. return send_tcp_packet(TCPFlags::ACK);
  198. }
  199. ErrorOr<void> TCPSocket::send_tcp_packet(u16 flags, UserOrKernelBuffer const* payload, size_t payload_size, RoutingDecision* user_routing_decision)
  200. {
  201. auto adapter = bound_interface().with([](auto& bound_device) -> RefPtr<NetworkAdapter> { return bound_device; });
  202. RoutingDecision routing_decision = user_routing_decision ? *user_routing_decision : route_to(peer_address(), local_address(), adapter);
  203. if (routing_decision.is_zero())
  204. return set_so_error(EHOSTUNREACH);
  205. auto ipv4_payload_offset = routing_decision.adapter->ipv4_payload_offset();
  206. bool const has_mss_option = flags == TCPFlags::SYN;
  207. const size_t options_size = has_mss_option ? sizeof(TCPOptionMSS) : 0;
  208. const size_t tcp_header_size = sizeof(TCPPacket) + options_size;
  209. const size_t buffer_size = ipv4_payload_offset + tcp_header_size + payload_size;
  210. auto packet = routing_decision.adapter->acquire_packet_buffer(buffer_size);
  211. if (!packet)
  212. return set_so_error(ENOMEM);
  213. routing_decision.adapter->fill_in_ipv4_header(*packet, local_address(),
  214. routing_decision.next_hop, peer_address(), IPv4Protocol::TCP,
  215. buffer_size - ipv4_payload_offset, type_of_service(), ttl());
  216. memset(packet->buffer->data() + ipv4_payload_offset, 0, sizeof(TCPPacket));
  217. auto& tcp_packet = *(TCPPacket*)(packet->buffer->data() + ipv4_payload_offset);
  218. VERIFY(local_port());
  219. tcp_packet.set_source_port(local_port());
  220. tcp_packet.set_destination_port(peer_port());
  221. tcp_packet.set_window_size(NumericLimits<u16>::max());
  222. tcp_packet.set_sequence_number(m_sequence_number);
  223. tcp_packet.set_data_offset(tcp_header_size / sizeof(u32));
  224. tcp_packet.set_flags(flags);
  225. if (payload) {
  226. if (auto result = payload->read(tcp_packet.payload(), payload_size); result.is_error()) {
  227. routing_decision.adapter->release_packet_buffer(*packet);
  228. return set_so_error(result.release_error());
  229. }
  230. }
  231. if (flags & TCPFlags::ACK) {
  232. m_last_ack_number_sent = m_ack_number;
  233. m_last_ack_sent_time = TimeManagement::the().monotonic_time();
  234. tcp_packet.set_ack_number(m_ack_number);
  235. }
  236. if (flags & TCPFlags::SYN) {
  237. ++m_sequence_number;
  238. } else {
  239. m_sequence_number += payload_size;
  240. }
  241. if (has_mss_option) {
  242. u16 mss = routing_decision.adapter->mtu() - sizeof(IPv4Packet) - sizeof(TCPPacket);
  243. TCPOptionMSS mss_option { mss };
  244. VERIFY(packet->buffer->size() >= ipv4_payload_offset + sizeof(TCPPacket) + sizeof(mss_option));
  245. memcpy(packet->buffer->data() + ipv4_payload_offset + sizeof(TCPPacket), &mss_option, sizeof(mss_option));
  246. }
  247. tcp_packet.set_checksum(compute_tcp_checksum(local_address(), peer_address(), tcp_packet, payload_size));
  248. bool expect_ack { tcp_packet.has_syn() || payload_size > 0 };
  249. if (expect_ack) {
  250. bool append_failed { false };
  251. m_unacked_packets.with_exclusive([&](auto& unacked_packets) {
  252. auto result = unacked_packets.packets.try_append({ m_sequence_number, packet, ipv4_payload_offset, *routing_decision.adapter });
  253. if (result.is_error()) {
  254. dbgln("TCPSocket: Dropped outbound packet because try_append() failed");
  255. append_failed = true;
  256. return;
  257. }
  258. unacked_packets.size += payload_size;
  259. enqueue_for_retransmit();
  260. });
  261. if (append_failed)
  262. return set_so_error(ENOMEM);
  263. }
  264. m_packets_out++;
  265. m_bytes_out += buffer_size;
  266. routing_decision.adapter->send_packet(packet->bytes());
  267. if (!expect_ack)
  268. routing_decision.adapter->release_packet_buffer(*packet);
  269. return {};
  270. }
  271. void TCPSocket::receive_tcp_packet(TCPPacket const& packet, u16 size)
  272. {
  273. if (packet.has_ack()) {
  274. u32 ack_number = packet.ack_number();
  275. dbgln_if(TCP_SOCKET_DEBUG, "TCPSocket: receive_tcp_packet: {}", ack_number);
  276. int removed = 0;
  277. m_unacked_packets.with_exclusive([&](auto& unacked_packets) {
  278. while (!unacked_packets.packets.is_empty()) {
  279. auto& packet = unacked_packets.packets.first();
  280. dbgln_if(TCP_SOCKET_DEBUG, "TCPSocket: iterate: {}", packet.ack_number);
  281. if (packet.ack_number <= ack_number) {
  282. auto old_adapter = packet.adapter.strong_ref();
  283. if (old_adapter)
  284. old_adapter->release_packet_buffer(*packet.buffer);
  285. TCPPacket& tcp_packet = *(TCPPacket*)(packet.buffer->buffer->data() + packet.ipv4_payload_offset);
  286. if (m_send_window_size != tcp_packet.window_size()) {
  287. m_send_window_size = tcp_packet.window_size();
  288. }
  289. auto payload_size = packet.buffer->buffer->data() + packet.buffer->buffer->size() - (u8*)tcp_packet.payload();
  290. unacked_packets.size -= payload_size;
  291. evaluate_block_conditions();
  292. unacked_packets.packets.take_first();
  293. removed++;
  294. } else {
  295. break;
  296. }
  297. }
  298. if (unacked_packets.packets.is_empty()) {
  299. m_retransmit_attempts = 0;
  300. dequeue_for_retransmit();
  301. }
  302. dbgln_if(TCP_SOCKET_DEBUG, "TCPSocket: receive_tcp_packet acknowledged {} packets", removed);
  303. });
  304. }
  305. m_packets_in++;
  306. m_bytes_in += packet.header_size() + size;
  307. }
  308. bool TCPSocket::should_delay_next_ack() const
  309. {
  310. // FIXME: We don't know the MSS here so make a reasonable guess.
  311. const size_t mss = 1500;
  312. // RFC 1122 says we should send an ACK for every two full-sized segments.
  313. if (m_ack_number >= m_last_ack_number_sent + 2 * mss)
  314. return false;
  315. // RFC 1122 says we should not delay ACKs for more than 500 milliseconds.
  316. if (TimeManagement::the().monotonic_time(TimePrecision::Precise) >= m_last_ack_sent_time + Duration::from_milliseconds(500))
  317. return false;
  318. return true;
  319. }
  320. NetworkOrdered<u16> TCPSocket::compute_tcp_checksum(IPv4Address const& source, IPv4Address const& destination, TCPPacket const& packet, u16 payload_size)
  321. {
  322. union PseudoHeader {
  323. struct [[gnu::packed]] {
  324. IPv4Address source;
  325. IPv4Address destination;
  326. u8 zero;
  327. u8 protocol;
  328. NetworkOrdered<u16> payload_size;
  329. } header;
  330. u16 raw[6];
  331. };
  332. static_assert(sizeof(PseudoHeader) == 12);
  333. Checked<u16> packet_size = packet.header_size();
  334. packet_size += payload_size;
  335. VERIFY(!packet_size.has_overflow());
  336. PseudoHeader pseudo_header { .header = { source, destination, 0, (u8)IPv4Protocol::TCP, packet_size.value() } };
  337. u32 checksum = 0;
  338. auto* raw_pseudo_header = pseudo_header.raw;
  339. for (size_t i = 0; i < sizeof(pseudo_header) / sizeof(u16); ++i) {
  340. checksum += AK::convert_between_host_and_network_endian(raw_pseudo_header[i]);
  341. if (checksum > 0xffff)
  342. checksum = (checksum >> 16) + (checksum & 0xffff);
  343. }
  344. auto* raw_packet = bit_cast<u16*>(&packet);
  345. for (size_t i = 0; i < packet.header_size() / sizeof(u16); ++i) {
  346. checksum += AK::convert_between_host_and_network_endian(raw_packet[i]);
  347. if (checksum > 0xffff)
  348. checksum = (checksum >> 16) + (checksum & 0xffff);
  349. }
  350. VERIFY(packet.data_offset() * 4 == packet.header_size());
  351. auto* raw_payload = bit_cast<u16*>(packet.payload());
  352. for (size_t i = 0; i < payload_size / sizeof(u16); ++i) {
  353. checksum += AK::convert_between_host_and_network_endian(raw_payload[i]);
  354. if (checksum > 0xffff)
  355. checksum = (checksum >> 16) + (checksum & 0xffff);
  356. }
  357. if (payload_size & 1) {
  358. u16 expanded_byte = ((u8 const*)packet.payload())[payload_size - 1] << 8;
  359. checksum += expanded_byte;
  360. if (checksum > 0xffff)
  361. checksum = (checksum >> 16) + (checksum & 0xffff);
  362. }
  363. return ~(checksum & 0xffff);
  364. }
  365. ErrorOr<void> TCPSocket::protocol_bind()
  366. {
  367. dbgln_if(TCP_SOCKET_DEBUG, "TCPSocket::protocol_bind(), local_port() is {}", local_port());
  368. // Check that we do have the address we're trying to bind to.
  369. TRY(m_adapter.with([this](auto& adapter) -> ErrorOr<void> {
  370. if (has_specific_local_address() && !adapter) {
  371. adapter = NetworkingManagement::the().from_ipv4_address(local_address());
  372. if (!adapter)
  373. return set_so_error(EADDRNOTAVAIL);
  374. }
  375. return {};
  376. }));
  377. if (local_port() == 0) {
  378. // Allocate an unused ephemeral port.
  379. constexpr u16 first_ephemeral_port = 32768;
  380. constexpr u16 last_ephemeral_port = 60999;
  381. constexpr u16 ephemeral_port_range_size = last_ephemeral_port - first_ephemeral_port;
  382. u16 first_scan_port = first_ephemeral_port + get_good_random<u16>() % ephemeral_port_range_size;
  383. return sockets_by_tuple().with_exclusive([&](auto& table) -> ErrorOr<void> {
  384. u16 port = first_scan_port;
  385. while (true) {
  386. IPv4SocketTuple proposed_tuple(local_address(), port, peer_address(), peer_port());
  387. auto it = table.find(proposed_tuple);
  388. if (it == table.end()) {
  389. set_local_port(port);
  390. table.set(proposed_tuple, this);
  391. dbgln_if(TCP_SOCKET_DEBUG, "...allocated port {}, tuple {}", port, proposed_tuple.to_string());
  392. return {};
  393. }
  394. ++port;
  395. if (port > last_ephemeral_port)
  396. port = first_ephemeral_port;
  397. if (port == first_scan_port)
  398. break;
  399. }
  400. return set_so_error(EADDRINUSE);
  401. });
  402. } else {
  403. // Verify that the user-supplied port is not already used by someone else.
  404. bool ok = sockets_by_tuple().with_exclusive([&](auto& table) -> bool {
  405. if (table.contains(tuple()))
  406. return false;
  407. table.set(tuple(), this);
  408. return true;
  409. });
  410. if (!ok)
  411. return set_so_error(EADDRINUSE);
  412. return {};
  413. }
  414. }
  415. ErrorOr<void> TCPSocket::protocol_listen()
  416. {
  417. set_direction(Direction::Passive);
  418. set_state(State::Listen);
  419. set_setup_state(SetupState::Completed);
  420. return {};
  421. }
  422. ErrorOr<void> TCPSocket::protocol_connect(OpenFileDescription& description)
  423. {
  424. MutexLocker locker(mutex());
  425. auto routing_decision = route_to(peer_address(), local_address());
  426. if (routing_decision.is_zero())
  427. return set_so_error(EHOSTUNREACH);
  428. if (!has_specific_local_address())
  429. set_local_address(routing_decision.adapter->ipv4_address());
  430. TRY(ensure_bound());
  431. m_sequence_number = get_good_random<u32>();
  432. m_ack_number = 0;
  433. set_setup_state(SetupState::InProgress);
  434. TRY(send_tcp_packet(TCPFlags::SYN));
  435. m_state = State::SynSent;
  436. set_role(Role::Connecting);
  437. m_direction = Direction::Outgoing;
  438. evaluate_block_conditions();
  439. if (description.is_blocking()) {
  440. locker.unlock();
  441. auto unblock_flags = Thread::FileBlocker::BlockFlags::None;
  442. if (Thread::current()->block<Thread::ConnectBlocker>({}, description, unblock_flags).was_interrupted())
  443. return set_so_error(EINTR);
  444. locker.lock();
  445. VERIFY(setup_state() == SetupState::Completed);
  446. if (has_error()) { // TODO: check unblock_flags
  447. set_role(Role::None);
  448. if (error() == TCPSocket::Error::RetransmitTimeout)
  449. return set_so_error(ETIMEDOUT);
  450. else
  451. return set_so_error(ECONNREFUSED);
  452. }
  453. return {};
  454. }
  455. return set_so_error(EINPROGRESS);
  456. }
  457. bool TCPSocket::protocol_is_disconnected() const
  458. {
  459. switch (m_state) {
  460. case State::Closed:
  461. case State::CloseWait:
  462. case State::LastAck:
  463. case State::FinWait1:
  464. case State::FinWait2:
  465. case State::Closing:
  466. case State::TimeWait:
  467. return true;
  468. default:
  469. return false;
  470. }
  471. }
  472. void TCPSocket::shut_down_for_writing()
  473. {
  474. if (state() == State::Established) {
  475. dbgln_if(TCP_SOCKET_DEBUG, " Sending FIN from Established and moving into FinWait1");
  476. (void)send_tcp_packet(TCPFlags::FIN | TCPFlags::ACK);
  477. set_state(State::FinWait1);
  478. } else {
  479. dbgln(" Shutting down TCPSocket for writing but not moving to FinWait1 since state is {}", to_string(state()));
  480. }
  481. }
  482. ErrorOr<void> TCPSocket::close()
  483. {
  484. MutexLocker locker(mutex());
  485. auto result = IPv4Socket::close();
  486. if (state() == State::CloseWait) {
  487. dbgln_if(TCP_SOCKET_DEBUG, " Sending FIN from CloseWait and moving into LastAck");
  488. [[maybe_unused]] auto rc = send_tcp_packet(TCPFlags::FIN | TCPFlags::ACK);
  489. set_state(State::LastAck);
  490. }
  491. if (state() != State::Closed && state() != State::Listen)
  492. closing_sockets().with_exclusive([&](auto& table) {
  493. table.set(tuple(), *this);
  494. });
  495. return result;
  496. }
  497. static Singleton<MutexProtected<TCPSocket::RetransmitList>> s_sockets_for_retransmit;
  498. MutexProtected<TCPSocket::RetransmitList>& TCPSocket::sockets_for_retransmit()
  499. {
  500. return *s_sockets_for_retransmit;
  501. }
  502. void TCPSocket::enqueue_for_retransmit()
  503. {
  504. sockets_for_retransmit().with_exclusive([&](auto& list) {
  505. list.append(*this);
  506. });
  507. }
  508. void TCPSocket::dequeue_for_retransmit()
  509. {
  510. sockets_for_retransmit().with_exclusive([&](auto& list) {
  511. list.remove(*this);
  512. });
  513. }
  514. void TCPSocket::retransmit_packets()
  515. {
  516. auto now = TimeManagement::the().monotonic_time();
  517. // RFC6298 says we should have at least one second between retransmits. According to
  518. // RFC1122 we must do exponential backoff - even for SYN packets.
  519. i64 retransmit_interval = 1;
  520. for (decltype(m_retransmit_attempts) i = 0; i < m_retransmit_attempts; i++)
  521. retransmit_interval *= 2;
  522. if (m_last_retransmit_time > now - Duration::from_seconds(retransmit_interval))
  523. return;
  524. dbgln_if(TCP_SOCKET_DEBUG, "TCPSocket({}) handling retransmit", this);
  525. m_last_retransmit_time = now;
  526. ++m_retransmit_attempts;
  527. if (m_retransmit_attempts > maximum_retransmits) {
  528. set_state(TCPSocket::State::Closed);
  529. set_error(TCPSocket::Error::RetransmitTimeout);
  530. set_setup_state(Socket::SetupState::Completed);
  531. return;
  532. }
  533. auto adapter = bound_interface().with([](auto& bound_device) -> RefPtr<NetworkAdapter> { return bound_device; });
  534. auto routing_decision = route_to(peer_address(), local_address(), adapter);
  535. if (routing_decision.is_zero())
  536. return;
  537. m_unacked_packets.with_exclusive([&](auto& unacked_packets) {
  538. for (auto& packet : unacked_packets.packets) {
  539. packet.tx_counter++;
  540. if constexpr (TCP_SOCKET_DEBUG) {
  541. auto& tcp_packet = *(const TCPPacket*)(packet.buffer->buffer->data() + packet.ipv4_payload_offset);
  542. dbgln("Sending TCP packet from {}:{} to {}:{} with ({}{}{}{}) seq_no={}, ack_no={}, tx_counter={}",
  543. local_address(), local_port(),
  544. peer_address(), peer_port(),
  545. (tcp_packet.has_syn() ? "SYN " : ""),
  546. (tcp_packet.has_ack() ? "ACK " : ""),
  547. (tcp_packet.has_fin() ? "FIN " : ""),
  548. (tcp_packet.has_rst() ? "RST " : ""),
  549. tcp_packet.sequence_number(),
  550. tcp_packet.ack_number(),
  551. packet.tx_counter);
  552. }
  553. size_t ipv4_payload_offset = routing_decision.adapter->ipv4_payload_offset();
  554. if (ipv4_payload_offset != packet.ipv4_payload_offset) {
  555. // FIXME: Add support for this. This can happen if after a route change
  556. // we ended up on another adapter which doesn't have the same layer 2 type
  557. // like the previous adapter.
  558. VERIFY_NOT_REACHED();
  559. }
  560. auto packet_buffer = packet.buffer->bytes();
  561. routing_decision.adapter->fill_in_ipv4_header(*packet.buffer,
  562. local_address(), routing_decision.next_hop, peer_address(),
  563. IPv4Protocol::TCP, packet_buffer.size() - ipv4_payload_offset, type_of_service(), ttl());
  564. routing_decision.adapter->send_packet(packet_buffer);
  565. m_packets_out++;
  566. m_bytes_out += packet_buffer.size();
  567. }
  568. });
  569. }
  570. bool TCPSocket::can_write(OpenFileDescription const& file_description, u64 size) const
  571. {
  572. if (!IPv4Socket::can_write(file_description, size))
  573. return false;
  574. if (m_state == State::SynSent || m_state == State::SynReceived)
  575. return false;
  576. if (!file_description.is_blocking())
  577. return true;
  578. return m_unacked_packets.with_shared([&](auto& unacked_packets) {
  579. return unacked_packets.size + size <= m_send_window_size;
  580. });
  581. }
  582. }