IPv4Socket.cpp 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903
  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/StringBuilder.h>
  8. #include <AK/StringView.h>
  9. #include <Kernel/API/Ioctl.h>
  10. #include <Kernel/API/POSIX/errno.h>
  11. #include <Kernel/Debug.h>
  12. #include <Kernel/FileSystem/OpenFileDescription.h>
  13. #include <Kernel/Net/ARP.h>
  14. #include <Kernel/Net/ICMP.h>
  15. #include <Kernel/Net/IPv4.h>
  16. #include <Kernel/Net/IPv4Socket.h>
  17. #include <Kernel/Net/NetworkAdapter.h>
  18. #include <Kernel/Net/NetworkingManagement.h>
  19. #include <Kernel/Net/Routing.h>
  20. #include <Kernel/Net/TCP.h>
  21. #include <Kernel/Net/TCPSocket.h>
  22. #include <Kernel/Net/UDP.h>
  23. #include <Kernel/Net/UDPSocket.h>
  24. #include <Kernel/Process.h>
  25. #include <Kernel/UnixTypes.h>
  26. namespace Kernel {
  27. static Singleton<MutexProtected<IPv4Socket::List>> s_all_sockets;
  28. using BlockFlags = Thread::OpenFileDescriptionBlocker::BlockFlags;
  29. MutexProtected<IPv4Socket::List>& IPv4Socket::all_sockets()
  30. {
  31. return *s_all_sockets;
  32. }
  33. ErrorOr<NonnullOwnPtr<DoubleBuffer>> IPv4Socket::try_create_receive_buffer()
  34. {
  35. return DoubleBuffer::try_create("IPv4Socket: Receive buffer"sv, 256 * KiB);
  36. }
  37. ErrorOr<NonnullRefPtr<Socket>> IPv4Socket::create(int type, int protocol)
  38. {
  39. auto receive_buffer = TRY(IPv4Socket::try_create_receive_buffer());
  40. if (type == SOCK_STREAM)
  41. return TRY(TCPSocket::try_create(protocol, move(receive_buffer)));
  42. if (type == SOCK_DGRAM)
  43. return TRY(UDPSocket::try_create(protocol, move(receive_buffer)));
  44. if (type == SOCK_RAW) {
  45. auto raw_socket = adopt_ref_if_nonnull(new (nothrow) IPv4Socket(type, protocol, move(receive_buffer), {}));
  46. if (raw_socket)
  47. return raw_socket.release_nonnull();
  48. return ENOMEM;
  49. }
  50. return EINVAL;
  51. }
  52. IPv4Socket::IPv4Socket(int type, int protocol, NonnullOwnPtr<DoubleBuffer> receive_buffer, OwnPtr<KBuffer> optional_scratch_buffer)
  53. : Socket(AF_INET, type, protocol)
  54. , m_receive_buffer(move(receive_buffer))
  55. , m_scratch_buffer(move(optional_scratch_buffer))
  56. {
  57. dbgln_if(IPV4_SOCKET_DEBUG, "IPv4Socket({}) created with type={}, protocol={}", this, type, protocol);
  58. m_buffer_mode = type == SOCK_STREAM ? BufferMode::Bytes : BufferMode::Packets;
  59. if (m_buffer_mode == BufferMode::Bytes) {
  60. VERIFY(m_scratch_buffer);
  61. }
  62. all_sockets().with_exclusive([&](auto& table) {
  63. table.append(*this);
  64. });
  65. }
  66. IPv4Socket::~IPv4Socket()
  67. {
  68. all_sockets().with_exclusive([&](auto& table) {
  69. table.remove(*this);
  70. });
  71. }
  72. void IPv4Socket::get_local_address(sockaddr* address, socklen_t* address_size)
  73. {
  74. sockaddr_in local_address = { AF_INET, htons(m_local_port), { m_local_address.to_in_addr_t() }, { 0 } };
  75. memcpy(address, &local_address, min(static_cast<size_t>(*address_size), sizeof(sockaddr_in)));
  76. *address_size = sizeof(sockaddr_in);
  77. }
  78. void IPv4Socket::get_peer_address(sockaddr* address, socklen_t* address_size)
  79. {
  80. sockaddr_in peer_address = { AF_INET, htons(m_peer_port), { m_peer_address.to_in_addr_t() }, { 0 } };
  81. memcpy(address, &peer_address, min(static_cast<size_t>(*address_size), sizeof(sockaddr_in)));
  82. *address_size = sizeof(sockaddr_in);
  83. }
  84. ErrorOr<void> IPv4Socket::bind(Credentials const& credentials, Userspace<sockaddr const*> user_address, socklen_t address_size)
  85. {
  86. VERIFY(setup_state() == SetupState::Unstarted);
  87. if (address_size != sizeof(sockaddr_in))
  88. return set_so_error(EINVAL);
  89. sockaddr_in address {};
  90. SOCKET_TRY(copy_from_user(&address, user_address, sizeof(sockaddr_in)));
  91. if (address.sin_family != AF_INET)
  92. return set_so_error(EINVAL);
  93. auto requested_local_port = ntohs(address.sin_port);
  94. if (!credentials.is_superuser()) {
  95. if (requested_local_port > 0 && requested_local_port < 1024) {
  96. dbgln("UID {} attempted to bind {} to port {}", credentials.uid(), class_name(), requested_local_port);
  97. return set_so_error(EACCES);
  98. }
  99. }
  100. m_local_address = IPv4Address((u8 const*)&address.sin_addr.s_addr);
  101. m_local_port = requested_local_port;
  102. dbgln_if(IPV4_SOCKET_DEBUG, "IPv4Socket::bind {}({}) to {}:{}", class_name(), this, m_local_address, m_local_port);
  103. return protocol_bind();
  104. }
  105. ErrorOr<void> IPv4Socket::listen(size_t backlog)
  106. {
  107. MutexLocker locker(mutex());
  108. auto result = allocate_local_port_if_needed();
  109. if (result.error_or_port.is_error() && result.error_or_port.error().code() != ENOPROTOOPT)
  110. return result.error_or_port.release_error();
  111. set_backlog(backlog);
  112. set_role(Role::Listener);
  113. evaluate_block_conditions();
  114. dbgln_if(IPV4_SOCKET_DEBUG, "IPv4Socket({}) listening with backlog={}", this, backlog);
  115. return protocol_listen(result.did_allocate);
  116. }
  117. ErrorOr<void> IPv4Socket::connect(Credentials const&, OpenFileDescription& description, Userspace<sockaddr const*> address, socklen_t address_size)
  118. {
  119. if (address_size != sizeof(sockaddr_in))
  120. return set_so_error(EINVAL);
  121. u16 sa_family_copy;
  122. auto* user_address = reinterpret_cast<sockaddr const*>(address.unsafe_userspace_ptr());
  123. SOCKET_TRY(copy_from_user(&sa_family_copy, &user_address->sa_family, sizeof(u16)));
  124. if (sa_family_copy != AF_INET)
  125. return set_so_error(EINVAL);
  126. if (m_role == Role::Connected)
  127. return set_so_error(EISCONN);
  128. sockaddr_in safe_address {};
  129. SOCKET_TRY(copy_from_user(&safe_address, (sockaddr_in const*)user_address, sizeof(sockaddr_in)));
  130. m_peer_address = IPv4Address((u8 const*)&safe_address.sin_addr.s_addr);
  131. if (m_peer_address == IPv4Address { 0, 0, 0, 0 })
  132. m_peer_address = IPv4Address { 127, 0, 0, 1 };
  133. m_peer_port = ntohs(safe_address.sin_port);
  134. return protocol_connect(description);
  135. }
  136. bool IPv4Socket::can_read(OpenFileDescription const&, u64) const
  137. {
  138. if (m_role == Role::Listener)
  139. return can_accept();
  140. if (protocol_is_disconnected())
  141. return true;
  142. return m_can_read;
  143. }
  144. bool IPv4Socket::can_write(OpenFileDescription const&, u64) const
  145. {
  146. return true;
  147. }
  148. PortAllocationResult IPv4Socket::allocate_local_port_if_needed()
  149. {
  150. MutexLocker locker(mutex());
  151. if (m_local_port)
  152. return { m_local_port, false };
  153. auto port_or_error = protocol_allocate_local_port();
  154. if (port_or_error.is_error())
  155. return { port_or_error.release_error(), false };
  156. m_local_port = port_or_error.release_value();
  157. return { m_local_port, true };
  158. }
  159. ErrorOr<size_t> IPv4Socket::sendto(OpenFileDescription&, UserOrKernelBuffer const& data, size_t data_length, [[maybe_unused]] int flags, Userspace<sockaddr const*> addr, socklen_t addr_length)
  160. {
  161. MutexLocker locker(mutex());
  162. if (addr && addr_length != sizeof(sockaddr_in))
  163. return set_so_error(EINVAL);
  164. if (addr) {
  165. sockaddr_in ia {};
  166. SOCKET_TRY(copy_from_user(&ia, Userspace<sockaddr_in const*>(addr.ptr())));
  167. if (ia.sin_family != AF_INET) {
  168. dmesgln("sendto: Bad address family: {} is not AF_INET", ia.sin_family);
  169. return set_so_error(EAFNOSUPPORT);
  170. }
  171. m_peer_address = IPv4Address((u8 const*)&ia.sin_addr.s_addr);
  172. m_peer_port = ntohs(ia.sin_port);
  173. }
  174. if (!is_connected() && m_peer_address.is_zero())
  175. return set_so_error(EPIPE);
  176. auto allow_using_gateway = ((flags & MSG_DONTROUTE) || m_routing_disabled) ? AllowUsingGateway::No : AllowUsingGateway::Yes;
  177. auto adapter = bound_interface().with([](auto& bound_device) -> RefPtr<NetworkAdapter> { return bound_device; });
  178. auto routing_decision = route_to(m_peer_address, m_local_address, adapter, allow_using_gateway);
  179. if (routing_decision.is_zero())
  180. return set_so_error(EHOSTUNREACH);
  181. if (m_local_address.to_u32() == 0)
  182. m_local_address = routing_decision.adapter->ipv4_address();
  183. if (auto result = allocate_local_port_if_needed(); result.error_or_port.is_error() && result.error_or_port.error().code() != ENOPROTOOPT)
  184. return result.error_or_port.release_error();
  185. dbgln_if(IPV4_SOCKET_DEBUG, "sendto: destination={}:{}", m_peer_address, m_peer_port);
  186. if (type() == SOCK_RAW) {
  187. auto ipv4_payload_offset = routing_decision.adapter->ipv4_payload_offset();
  188. data_length = min(data_length, routing_decision.adapter->mtu() - ipv4_payload_offset);
  189. auto packet = routing_decision.adapter->acquire_packet_buffer(ipv4_payload_offset + data_length);
  190. if (!packet)
  191. return set_so_error(ENOMEM);
  192. routing_decision.adapter->fill_in_ipv4_header(*packet, local_address(), routing_decision.next_hop,
  193. m_peer_address, (IPv4Protocol)protocol(), data_length, m_type_of_service, m_ttl);
  194. if (auto result = data.read(packet->buffer->data() + ipv4_payload_offset, data_length); result.is_error()) {
  195. routing_decision.adapter->release_packet_buffer(*packet);
  196. return set_so_error(result.release_error());
  197. }
  198. routing_decision.adapter->send_packet(packet->bytes());
  199. routing_decision.adapter->release_packet_buffer(*packet);
  200. return data_length;
  201. }
  202. auto nsent_or_error = protocol_send(data, data_length);
  203. if (!nsent_or_error.is_error())
  204. Thread::current()->did_ipv4_socket_write(nsent_or_error.value());
  205. return nsent_or_error;
  206. }
  207. ErrorOr<size_t> IPv4Socket::receive_byte_buffered(OpenFileDescription& description, UserOrKernelBuffer& buffer, size_t buffer_length, int flags, Userspace<sockaddr*>, Userspace<socklen_t*>, bool blocking)
  208. {
  209. MutexLocker locker(mutex());
  210. VERIFY(m_receive_buffer);
  211. if (m_receive_buffer->is_empty()) {
  212. if (protocol_is_disconnected())
  213. return 0;
  214. if (!blocking)
  215. return set_so_error(EAGAIN);
  216. locker.unlock();
  217. auto unblocked_flags = BlockFlags::None;
  218. auto res = Thread::current()->block<Thread::ReadBlocker>({}, description, unblocked_flags);
  219. locker.lock();
  220. if (!has_flag(unblocked_flags, BlockFlags::Read)) {
  221. if (res.was_interrupted())
  222. return set_so_error(EINTR);
  223. // Unblocked due to timeout.
  224. return set_so_error(EAGAIN);
  225. }
  226. }
  227. ErrorOr<size_t> nreceived_or_error { 0 };
  228. if (flags & MSG_PEEK)
  229. nreceived_or_error = m_receive_buffer->peek(buffer, buffer_length);
  230. else
  231. nreceived_or_error = m_receive_buffer->read(buffer, buffer_length);
  232. if (!nreceived_or_error.is_error() && nreceived_or_error.value() > 0 && !(flags & MSG_PEEK))
  233. Thread::current()->did_ipv4_socket_read(nreceived_or_error.value());
  234. set_can_read(!m_receive_buffer->is_empty());
  235. return nreceived_or_error;
  236. }
  237. ErrorOr<size_t> IPv4Socket::receive_packet_buffered(OpenFileDescription& description, UserOrKernelBuffer& buffer, size_t buffer_length, int flags, Userspace<sockaddr*> addr, Userspace<socklen_t*> addr_length, Time& packet_timestamp, bool blocking)
  238. {
  239. MutexLocker locker(mutex());
  240. ReceivedPacket taken_packet;
  241. ReceivedPacket* packet { nullptr };
  242. {
  243. if (m_receive_queue.is_empty()) {
  244. // FIXME: Shouldn't this return ENOTCONN instead of EOF?
  245. // But if so, we still need to deliver at least one EOF read to userspace.. right?
  246. if (protocol_is_disconnected())
  247. return 0;
  248. if (!blocking)
  249. return set_so_error(EAGAIN);
  250. }
  251. if (!m_receive_queue.is_empty()) {
  252. if (flags & MSG_PEEK) {
  253. packet = &m_receive_queue.first();
  254. } else {
  255. taken_packet = m_receive_queue.take_first();
  256. packet = &taken_packet;
  257. }
  258. set_can_read(!m_receive_queue.is_empty());
  259. dbgln_if(IPV4_SOCKET_DEBUG, "IPv4Socket({}): recvfrom without blocking {} bytes, packets in queue: {}",
  260. this,
  261. packet->data->size(),
  262. m_receive_queue.size());
  263. }
  264. }
  265. if (!packet) {
  266. if (protocol_is_disconnected()) {
  267. dbgln("IPv4Socket({}) is protocol-disconnected, returning 0 in recvfrom!", this);
  268. return 0;
  269. }
  270. locker.unlock();
  271. auto unblocked_flags = BlockFlags::None;
  272. auto res = Thread::current()->block<Thread::ReadBlocker>({}, description, unblocked_flags);
  273. locker.lock();
  274. if (!has_flag(unblocked_flags, BlockFlags::Read)) {
  275. if (res.was_interrupted())
  276. return set_so_error(EINTR);
  277. // Unblocked due to timeout.
  278. return set_so_error(EAGAIN);
  279. }
  280. VERIFY(m_can_read);
  281. VERIFY(!m_receive_queue.is_empty());
  282. if (flags & MSG_PEEK) {
  283. packet = &m_receive_queue.first();
  284. } else {
  285. taken_packet = m_receive_queue.take_first();
  286. packet = &taken_packet;
  287. }
  288. set_can_read(!m_receive_queue.is_empty());
  289. dbgln_if(IPV4_SOCKET_DEBUG, "IPv4Socket({}): recvfrom with blocking {} bytes, packets in queue: {}",
  290. this,
  291. packet->data->size(),
  292. m_receive_queue.size());
  293. }
  294. VERIFY(packet->data);
  295. packet_timestamp = packet->timestamp;
  296. if (addr) {
  297. dbgln_if(IPV4_SOCKET_DEBUG, "Incoming packet is from: {}:{}", packet->peer_address, packet->peer_port);
  298. sockaddr_in out_addr {};
  299. memcpy(&out_addr.sin_addr, &packet->peer_address, sizeof(IPv4Address));
  300. out_addr.sin_port = htons(packet->peer_port);
  301. out_addr.sin_family = AF_INET;
  302. Userspace<sockaddr_in*> dest_addr = addr.ptr();
  303. SOCKET_TRY(copy_to_user(dest_addr, &out_addr));
  304. socklen_t out_length = sizeof(sockaddr_in);
  305. VERIFY(addr_length);
  306. SOCKET_TRY(copy_to_user(addr_length, &out_length));
  307. }
  308. if (type() == SOCK_RAW) {
  309. size_t bytes_written = min(packet->data->size(), buffer_length);
  310. SOCKET_TRY(buffer.write(packet->data->data(), bytes_written));
  311. return bytes_written;
  312. }
  313. return protocol_receive(packet->data->bytes(), buffer, buffer_length, flags);
  314. }
  315. ErrorOr<size_t> IPv4Socket::recvfrom(OpenFileDescription& description, UserOrKernelBuffer& buffer, size_t buffer_length, int flags, Userspace<sockaddr*> user_addr, Userspace<socklen_t*> user_addr_length, Time& packet_timestamp, bool blocking)
  316. {
  317. if (user_addr_length) {
  318. socklen_t addr_length;
  319. SOCKET_TRY(copy_from_user(&addr_length, user_addr_length.unsafe_userspace_ptr()));
  320. if (addr_length < sizeof(sockaddr_in))
  321. return set_so_error(EINVAL);
  322. }
  323. dbgln_if(IPV4_SOCKET_DEBUG, "recvfrom: type={}, local_port={}", type(), local_port());
  324. ErrorOr<size_t> total_nreceived = 0;
  325. do {
  326. auto offset_buffer = buffer.offset(total_nreceived.value());
  327. auto offset_buffer_length = buffer_length - total_nreceived.value();
  328. ErrorOr<size_t> nreceived = 0;
  329. if (buffer_mode() == BufferMode::Bytes)
  330. nreceived = receive_byte_buffered(description, offset_buffer, offset_buffer_length, flags, user_addr, user_addr_length, blocking);
  331. else
  332. nreceived = receive_packet_buffered(description, offset_buffer, offset_buffer_length, flags, user_addr, user_addr_length, packet_timestamp, blocking);
  333. if (nreceived.is_error())
  334. total_nreceived = move(nreceived);
  335. else
  336. total_nreceived.value() += nreceived.value();
  337. } while ((flags & MSG_WAITALL) && !total_nreceived.is_error() && total_nreceived.value() < buffer_length);
  338. if (!total_nreceived.is_error())
  339. Thread::current()->did_ipv4_socket_read(total_nreceived.value());
  340. return total_nreceived;
  341. }
  342. bool IPv4Socket::did_receive(IPv4Address const& source_address, u16 source_port, ReadonlyBytes packet, Time const& packet_timestamp)
  343. {
  344. MutexLocker locker(mutex());
  345. if (is_shut_down_for_reading())
  346. return false;
  347. auto packet_size = packet.size();
  348. if (buffer_mode() == BufferMode::Bytes) {
  349. VERIFY(m_receive_buffer);
  350. size_t space_in_receive_buffer = m_receive_buffer->space_for_writing();
  351. if (packet_size > space_in_receive_buffer) {
  352. dbgln("IPv4Socket({}): did_receive refusing packet since buffer is full.", this);
  353. VERIFY(m_can_read);
  354. return false;
  355. }
  356. auto scratch_buffer = UserOrKernelBuffer::for_kernel_buffer(m_scratch_buffer->data());
  357. auto nreceived_or_error = protocol_receive(packet, scratch_buffer, m_scratch_buffer->size(), 0);
  358. if (nreceived_or_error.is_error())
  359. return false;
  360. auto nwritten_or_error = m_receive_buffer->write(scratch_buffer, nreceived_or_error.value());
  361. if (nwritten_or_error.is_error())
  362. return false;
  363. set_can_read(!m_receive_buffer->is_empty());
  364. } else {
  365. if (m_receive_queue.size() > 2000) {
  366. dbgln("IPv4Socket({}): did_receive refusing packet since queue is full.", this);
  367. return false;
  368. }
  369. auto data_or_error = KBuffer::try_create_with_bytes("IPv4Socket: Packet buffer"sv, packet);
  370. if (data_or_error.is_error()) {
  371. dbgln("IPv4Socket: did_receive unable to allocate storage for incoming packet.");
  372. return false;
  373. }
  374. auto result = m_receive_queue.try_append({ source_address, source_port, packet_timestamp, data_or_error.release_value() });
  375. if (result.is_error()) {
  376. dbgln("IPv4Socket: Dropped incoming packet because appending to the receive queue failed.");
  377. return false;
  378. }
  379. set_can_read(true);
  380. }
  381. m_bytes_received += packet_size;
  382. if constexpr (IPV4_SOCKET_DEBUG) {
  383. if (buffer_mode() == BufferMode::Bytes)
  384. dbgln("IPv4Socket({}): did_receive {} bytes, total_received={}", this, packet_size, m_bytes_received);
  385. else
  386. dbgln("IPv4Socket({}): did_receive {} bytes, total_received={}, packets in queue: {}",
  387. this,
  388. packet_size,
  389. m_bytes_received,
  390. m_receive_queue.size());
  391. }
  392. return true;
  393. }
  394. ErrorOr<NonnullOwnPtr<KString>> IPv4Socket::pseudo_path(OpenFileDescription const&) const
  395. {
  396. if (m_role == Role::None)
  397. return KString::try_create("socket"sv);
  398. StringBuilder builder;
  399. TRY(builder.try_append("socket:"sv));
  400. TRY(builder.try_appendff("{}:{}", TRY(m_local_address.to_string()), m_local_port));
  401. if (m_role == Role::Accepted || m_role == Role::Connected)
  402. TRY(builder.try_appendff(" / {}:{}", TRY(m_peer_address.to_string()), m_peer_port));
  403. switch (m_role) {
  404. case Role::Listener:
  405. TRY(builder.try_append(" (listening)"sv));
  406. break;
  407. case Role::Accepted:
  408. TRY(builder.try_append(" (accepted)"sv));
  409. break;
  410. case Role::Connected:
  411. TRY(builder.try_append(" (connected)"sv));
  412. break;
  413. case Role::Connecting:
  414. TRY(builder.try_append(" (connecting)"sv));
  415. break;
  416. default:
  417. VERIFY_NOT_REACHED();
  418. }
  419. return KString::try_create(builder.string_view());
  420. }
  421. ErrorOr<void> IPv4Socket::setsockopt(int level, int option, Userspace<void const*> user_value, socklen_t user_value_size)
  422. {
  423. if (level != IPPROTO_IP)
  424. return Socket::setsockopt(level, option, user_value, user_value_size);
  425. MutexLocker locker(mutex());
  426. switch (option) {
  427. case IP_TTL: {
  428. if (user_value_size < sizeof(int))
  429. return EINVAL;
  430. int value;
  431. TRY(copy_from_user(&value, static_ptr_cast<int const*>(user_value)));
  432. if (value < 0 || value > 255)
  433. return EINVAL;
  434. m_ttl = value;
  435. return {};
  436. }
  437. case IP_TOS: {
  438. if (user_value_size < sizeof(int))
  439. return EINVAL;
  440. int value;
  441. TRY(copy_from_user(&value, static_ptr_cast<int const*>(user_value)));
  442. if (value < 0 || value > 255)
  443. return EINVAL;
  444. m_type_of_service = value;
  445. return {};
  446. }
  447. case IP_MULTICAST_LOOP: {
  448. if (user_value_size != 1)
  449. return EINVAL;
  450. u8 value;
  451. TRY(copy_from_user(&value, static_ptr_cast<u8 const*>(user_value)));
  452. if (value != 0 && value != 1)
  453. return EINVAL;
  454. m_multicast_loop = value;
  455. return {};
  456. }
  457. case IP_ADD_MEMBERSHIP: {
  458. if (user_value_size != sizeof(ip_mreq))
  459. return EINVAL;
  460. ip_mreq mreq;
  461. TRY(copy_from_user(&mreq, static_ptr_cast<ip_mreq const*>(user_value)));
  462. if (mreq.imr_interface.s_addr != INADDR_ANY)
  463. return ENOTSUP;
  464. IPv4Address address { (u8 const*)&mreq.imr_multiaddr.s_addr };
  465. if (!m_multicast_memberships.contains_slow(address))
  466. m_multicast_memberships.append(address);
  467. return {};
  468. }
  469. case IP_DROP_MEMBERSHIP: {
  470. if (user_value_size != sizeof(ip_mreq))
  471. return EINVAL;
  472. ip_mreq mreq;
  473. TRY(copy_from_user(&mreq, static_ptr_cast<ip_mreq const*>(user_value)));
  474. if (mreq.imr_interface.s_addr != INADDR_ANY)
  475. return ENOTSUP;
  476. IPv4Address address { (u8 const*)&mreq.imr_multiaddr.s_addr };
  477. m_multicast_memberships.remove_first_matching([&address](auto& a) { return a == address; });
  478. return {};
  479. }
  480. default:
  481. return ENOPROTOOPT;
  482. }
  483. }
  484. ErrorOr<void> IPv4Socket::getsockopt(OpenFileDescription& description, int level, int option, Userspace<void*> value, Userspace<socklen_t*> value_size)
  485. {
  486. if (level != IPPROTO_IP)
  487. return Socket::getsockopt(description, level, option, value, value_size);
  488. MutexLocker locker(mutex());
  489. socklen_t size;
  490. TRY(copy_from_user(&size, value_size.unsafe_userspace_ptr()));
  491. switch (option) {
  492. case IP_TTL: {
  493. if (size < sizeof(int))
  494. return EINVAL;
  495. int ttl = m_ttl;
  496. TRY(copy_to_user(static_ptr_cast<int*>(value), (int*)&ttl));
  497. size = sizeof(int);
  498. return copy_to_user(value_size, &size);
  499. }
  500. case IP_TOS: {
  501. if (size < sizeof(int))
  502. return EINVAL;
  503. int type_of_service = m_type_of_service;
  504. TRY(copy_to_user(static_ptr_cast<int*>(value), (int*)&type_of_service));
  505. size = sizeof(int);
  506. return copy_to_user(value_size, &size);
  507. }
  508. case IP_MULTICAST_LOOP: {
  509. if (size < 1)
  510. return EINVAL;
  511. TRY(copy_to_user(static_ptr_cast<u8*>(value), (u8 const*)&m_multicast_loop));
  512. size = 1;
  513. return copy_to_user(value_size, &size);
  514. }
  515. default:
  516. return ENOPROTOOPT;
  517. }
  518. }
  519. ErrorOr<void> IPv4Socket::ioctl(OpenFileDescription&, unsigned request, Userspace<void*> arg)
  520. {
  521. TRY(Process::current().require_promise(Pledge::inet));
  522. MutexLocker locker(mutex());
  523. auto ioctl_route = [request, arg]() -> ErrorOr<void> {
  524. auto user_route = static_ptr_cast<rtentry*>(arg);
  525. rtentry route;
  526. TRY(copy_from_user(&route, user_route));
  527. Userspace<const char*> user_rt_dev((FlatPtr)route.rt_dev);
  528. auto ifname = TRY(try_copy_kstring_from_user(user_rt_dev, IFNAMSIZ));
  529. auto adapter = NetworkingManagement::the().lookup_by_name(ifname->view());
  530. if (!adapter)
  531. return ENODEV;
  532. switch (request) {
  533. case SIOCADDRT: {
  534. auto current_process_credentials = Process::current().credentials();
  535. if (!current_process_credentials->is_superuser())
  536. return EPERM;
  537. if (route.rt_gateway.sa_family != AF_INET)
  538. return EAFNOSUPPORT;
  539. if (!(route.rt_flags & RTF_UP))
  540. return EINVAL; // FIXME: Find the correct value to return
  541. auto destination = IPv4Address(((sockaddr_in&)route.rt_dst).sin_addr.s_addr);
  542. auto gateway = IPv4Address(((sockaddr_in&)route.rt_gateway).sin_addr.s_addr);
  543. auto genmask = IPv4Address(((sockaddr_in&)route.rt_genmask).sin_addr.s_addr);
  544. return update_routing_table(destination, gateway, genmask, route.rt_flags, adapter, UpdateTable::Set);
  545. }
  546. case SIOCDELRT:
  547. auto current_process_credentials = Process::current().credentials();
  548. if (!current_process_credentials->is_superuser())
  549. return EPERM;
  550. if (route.rt_gateway.sa_family != AF_INET)
  551. return EAFNOSUPPORT;
  552. auto destination = IPv4Address(((sockaddr_in&)route.rt_dst).sin_addr.s_addr);
  553. auto gateway = IPv4Address(((sockaddr_in&)route.rt_gateway).sin_addr.s_addr);
  554. auto genmask = IPv4Address(((sockaddr_in&)route.rt_genmask).sin_addr.s_addr);
  555. return update_routing_table(destination, gateway, genmask, route.rt_flags, adapter, UpdateTable::Delete);
  556. }
  557. return EINVAL;
  558. };
  559. auto ioctl_arp = [request, arg]() -> ErrorOr<void> {
  560. auto user_req = static_ptr_cast<arpreq*>(arg);
  561. arpreq arp_req;
  562. TRY(copy_from_user(&arp_req, user_req));
  563. auto current_process_credentials = Process::current().credentials();
  564. switch (request) {
  565. case SIOCSARP:
  566. if (!current_process_credentials->is_superuser())
  567. return EPERM;
  568. if (arp_req.arp_pa.sa_family != AF_INET)
  569. return EAFNOSUPPORT;
  570. update_arp_table(IPv4Address(((sockaddr_in&)arp_req.arp_pa).sin_addr.s_addr), *(MACAddress*)&arp_req.arp_ha.sa_data[0], UpdateTable::Set);
  571. return {};
  572. case SIOCDARP:
  573. if (!current_process_credentials->is_superuser())
  574. return EPERM;
  575. if (arp_req.arp_pa.sa_family != AF_INET)
  576. return EAFNOSUPPORT;
  577. update_arp_table(IPv4Address(((sockaddr_in&)arp_req.arp_pa).sin_addr.s_addr), *(MACAddress*)&arp_req.arp_ha.sa_data[0], UpdateTable::Delete);
  578. return {};
  579. }
  580. return EINVAL;
  581. };
  582. auto ioctl_interface = [request, arg]() -> ErrorOr<void> {
  583. auto user_ifr = static_ptr_cast<ifreq*>(arg);
  584. ifreq ifr;
  585. TRY(copy_from_user(&ifr, user_ifr));
  586. if (request == SIOCGIFNAME) {
  587. // NOTE: Network devices are 1-indexed since index 0 denotes an invalid device
  588. if (ifr.ifr_index == 0)
  589. return EINVAL;
  590. size_t index = 1;
  591. Optional<StringView> result {};
  592. NetworkingManagement::the().for_each([&ifr, &index, &result](auto& adapter) {
  593. if (index == ifr.ifr_index)
  594. result = adapter.name();
  595. ++index;
  596. });
  597. if (result.has_value()) {
  598. auto name = result.release_value();
  599. auto succ = name.copy_characters_to_buffer(ifr.ifr_name, IFNAMSIZ);
  600. if (!succ) {
  601. return EFAULT;
  602. }
  603. return copy_to_user(user_ifr, &ifr);
  604. }
  605. return ENODEV;
  606. }
  607. char namebuf[IFNAMSIZ + 1];
  608. memcpy(namebuf, ifr.ifr_name, IFNAMSIZ);
  609. namebuf[sizeof(namebuf) - 1] = '\0';
  610. if (request == SIOCGIFINDEX) {
  611. StringView name { namebuf, strlen(namebuf) };
  612. size_t index = 1;
  613. Optional<size_t> result {};
  614. NetworkingManagement::the().for_each([&name, &index, &result](auto& adapter) {
  615. if (adapter.name() == name)
  616. result = index;
  617. ++index;
  618. });
  619. if (result.has_value()) {
  620. ifr.ifr_index = result.release_value();
  621. return copy_to_user(user_ifr, &ifr);
  622. }
  623. return ENODEV;
  624. }
  625. auto adapter = NetworkingManagement::the().lookup_by_name({ namebuf, strlen(namebuf) });
  626. if (!adapter)
  627. return ENODEV;
  628. auto current_process_credentials = Process::current().credentials();
  629. switch (request) {
  630. case SIOCSIFADDR:
  631. if (!current_process_credentials->is_superuser())
  632. return EPERM;
  633. if (ifr.ifr_addr.sa_family != AF_INET)
  634. return EAFNOSUPPORT;
  635. adapter->set_ipv4_address(IPv4Address(((sockaddr_in&)ifr.ifr_addr).sin_addr.s_addr));
  636. return {};
  637. case SIOCSIFNETMASK:
  638. if (!current_process_credentials->is_superuser())
  639. return EPERM;
  640. if (ifr.ifr_addr.sa_family != AF_INET)
  641. return EAFNOSUPPORT;
  642. adapter->set_ipv4_netmask(IPv4Address(((sockaddr_in&)ifr.ifr_netmask).sin_addr.s_addr));
  643. return {};
  644. case SIOCGIFADDR: {
  645. auto ip4_addr = adapter->ipv4_address().to_u32();
  646. auto& socket_address_in = reinterpret_cast<sockaddr_in&>(ifr.ifr_addr);
  647. socket_address_in.sin_family = AF_INET;
  648. socket_address_in.sin_addr.s_addr = ip4_addr;
  649. return copy_to_user(user_ifr, &ifr);
  650. }
  651. case SIOCGIFNETMASK: {
  652. auto ip4_netmask = adapter->ipv4_netmask().to_u32();
  653. auto& socket_address_in = reinterpret_cast<sockaddr_in&>(ifr.ifr_addr);
  654. socket_address_in.sin_family = AF_INET;
  655. // NOTE: NOT ifr_netmask.
  656. socket_address_in.sin_addr.s_addr = ip4_netmask;
  657. return copy_to_user(user_ifr, &ifr);
  658. }
  659. case SIOCGIFHWADDR: {
  660. auto mac_address = adapter->mac_address();
  661. switch (adapter->adapter_type()) {
  662. case NetworkAdapter::Type::Loopback:
  663. ifr.ifr_hwaddr.sa_family = ARPHRD_LOOPBACK;
  664. break;
  665. case NetworkAdapter::Type::Ethernet:
  666. ifr.ifr_hwaddr.sa_family = ARPHRD_ETHER;
  667. break;
  668. default:
  669. VERIFY_NOT_REACHED();
  670. }
  671. mac_address.copy_to(Bytes { ifr.ifr_hwaddr.sa_data, sizeof(ifr.ifr_hwaddr.sa_data) });
  672. return copy_to_user(user_ifr, &ifr);
  673. }
  674. case SIOCGIFBRDADDR: {
  675. // Broadcast address is basically the reverse of the netmask, i.e.
  676. // instead of zeroing out the end, you OR with 1 instead.
  677. auto ip4_netmask = adapter->ipv4_netmask().to_u32();
  678. auto broadcast_addr = adapter->ipv4_address().to_u32() | ~ip4_netmask;
  679. auto& socket_address_in = reinterpret_cast<sockaddr_in&>(ifr.ifr_addr);
  680. socket_address_in.sin_family = AF_INET;
  681. socket_address_in.sin_addr.s_addr = broadcast_addr;
  682. return copy_to_user(user_ifr, &ifr);
  683. }
  684. case SIOCGIFMTU: {
  685. auto ip4_metric = adapter->mtu();
  686. ifr.ifr_addr.sa_family = AF_INET;
  687. ifr.ifr_metric = ip4_metric;
  688. return copy_to_user(user_ifr, &ifr);
  689. }
  690. case SIOCGIFFLAGS: {
  691. // FIXME: stub!
  692. constexpr short flags = 1;
  693. ifr.ifr_addr.sa_family = AF_INET;
  694. ifr.ifr_flags = flags;
  695. return copy_to_user(user_ifr, &ifr);
  696. }
  697. case SIOCGIFCONF: {
  698. // FIXME: stub!
  699. return EINVAL;
  700. }
  701. }
  702. return EINVAL;
  703. };
  704. switch (request) {
  705. case SIOCSIFADDR:
  706. case SIOCSIFNETMASK:
  707. case SIOCGIFADDR:
  708. case SIOCGIFHWADDR:
  709. case SIOCGIFNETMASK:
  710. case SIOCGIFBRDADDR:
  711. case SIOCGIFMTU:
  712. case SIOCGIFFLAGS:
  713. case SIOCGIFCONF:
  714. case SIOCGIFNAME:
  715. case SIOCGIFINDEX:
  716. return ioctl_interface();
  717. case SIOCADDRT:
  718. case SIOCDELRT:
  719. return ioctl_route();
  720. case SIOCSARP:
  721. case SIOCDARP:
  722. return ioctl_arp();
  723. case FIONREAD: {
  724. int readable = 0;
  725. if (buffer_mode() == BufferMode::Bytes) {
  726. readable = static_cast<int>(m_receive_buffer->immediately_readable());
  727. } else {
  728. if (m_receive_queue.size() != 0u) {
  729. readable = static_cast<int>(TRY(protocol_size(m_receive_queue.first().data->bytes())));
  730. }
  731. }
  732. return copy_to_user(static_ptr_cast<int*>(arg), &readable);
  733. }
  734. }
  735. return EINVAL;
  736. }
  737. ErrorOr<void> IPv4Socket::close()
  738. {
  739. [[maybe_unused]] auto rc = shutdown(SHUT_RDWR);
  740. return {};
  741. }
  742. void IPv4Socket::shut_down_for_reading()
  743. {
  744. Socket::shut_down_for_reading();
  745. set_can_read(true);
  746. }
  747. void IPv4Socket::set_can_read(bool value)
  748. {
  749. m_can_read = value;
  750. if (value)
  751. evaluate_block_conditions();
  752. }
  753. void IPv4Socket::drop_receive_buffer()
  754. {
  755. m_receive_buffer = nullptr;
  756. }
  757. }