mirror of
https://github.com/RGBCube/serenity
synced 2025-05-29 17:25:10 +00:00
cf271183b4
This has several benefits: 1) We no longer just blindly derefence a null pointer in various places 2) We will get nicer runtime error messages if the current process does turn out to be null in the call location 3) GCC no longer complains about possible nullptr dereferences when compiling without KUBSAN
506 lines
16 KiB
C++
506 lines
16 KiB
C++
/*
|
|
* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
|
|
*
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
|
*/
|
|
|
|
#include <AK/Singleton.h>
|
|
#include <AK/StringBuilder.h>
|
|
#include <Kernel/Debug.h>
|
|
#include <Kernel/FileSystem/FileDescription.h>
|
|
#include <Kernel/FileSystem/VirtualFileSystem.h>
|
|
#include <Kernel/Locking/Mutex.h>
|
|
#include <Kernel/Locking/ProtectedValue.h>
|
|
#include <Kernel/Net/LocalSocket.h>
|
|
#include <Kernel/Process.h>
|
|
#include <Kernel/StdLib.h>
|
|
#include <Kernel/UnixTypes.h>
|
|
#include <LibC/errno_numbers.h>
|
|
|
|
namespace Kernel {
|
|
|
|
static Singleton<ProtectedValue<LocalSocket::List>> s_list;
|
|
|
|
static ProtectedValue<LocalSocket::List>& all_sockets()
|
|
{
|
|
return *s_list;
|
|
}
|
|
|
|
void LocalSocket::for_each(Function<void(const LocalSocket&)> callback)
|
|
{
|
|
all_sockets().for_each_shared([&](const auto& socket) {
|
|
callback(socket);
|
|
});
|
|
}
|
|
|
|
KResultOr<NonnullRefPtr<Socket>> LocalSocket::create(int type)
|
|
{
|
|
auto client_buffer = DoubleBuffer::try_create();
|
|
if (!client_buffer)
|
|
return ENOMEM;
|
|
auto server_buffer = DoubleBuffer::try_create();
|
|
if (!server_buffer)
|
|
return ENOMEM;
|
|
auto socket = adopt_ref_if_nonnull(new (nothrow) LocalSocket(type, client_buffer.release_nonnull(), server_buffer.release_nonnull()));
|
|
if (socket)
|
|
return socket.release_nonnull();
|
|
return ENOMEM;
|
|
}
|
|
|
|
KResultOr<SocketPair> LocalSocket::create_connected_pair(int type)
|
|
{
|
|
auto socket_or_error = LocalSocket::create(type);
|
|
if (socket_or_error.is_error())
|
|
return socket_or_error.error();
|
|
|
|
auto socket = static_ptr_cast<LocalSocket>(socket_or_error.release_value());
|
|
auto description1_result = FileDescription::create(*socket);
|
|
if (description1_result.is_error())
|
|
return description1_result.error();
|
|
|
|
socket->m_address.sun_family = AF_LOCAL;
|
|
memcpy(socket->m_address.sun_path, "[socketpair]", 13);
|
|
|
|
auto& process = Process::current();
|
|
socket->m_acceptor = { process.pid().value(), process.uid(), process.gid() };
|
|
|
|
socket->set_connected(true);
|
|
socket->set_connect_side_role(Role::Connected);
|
|
socket->m_role = Role::Accepted;
|
|
|
|
auto description2_result = FileDescription::create(*socket);
|
|
if (description2_result.is_error())
|
|
return description2_result.error();
|
|
|
|
return SocketPair { description1_result.release_value(), description2_result.release_value() };
|
|
}
|
|
|
|
LocalSocket::LocalSocket(int type, NonnullOwnPtr<DoubleBuffer> client_buffer, NonnullOwnPtr<DoubleBuffer> server_buffer)
|
|
: Socket(AF_LOCAL, type, 0)
|
|
, m_for_client(move(client_buffer))
|
|
, m_for_server(move(server_buffer))
|
|
{
|
|
auto& current_process = Process::current();
|
|
m_prebind_uid = current_process.euid();
|
|
m_prebind_gid = current_process.egid();
|
|
m_prebind_mode = 0666;
|
|
|
|
m_for_client->set_unblock_callback([this]() {
|
|
evaluate_block_conditions();
|
|
});
|
|
m_for_server->set_unblock_callback([this]() {
|
|
evaluate_block_conditions();
|
|
});
|
|
|
|
all_sockets().with_exclusive([&](auto& list) {
|
|
list.append(*this);
|
|
});
|
|
|
|
dbgln_if(LOCAL_SOCKET_DEBUG, "LocalSocket({}) created with type={}", this, type);
|
|
}
|
|
|
|
LocalSocket::~LocalSocket()
|
|
{
|
|
all_sockets().with_exclusive([&](auto& list) {
|
|
list.remove(*this);
|
|
});
|
|
}
|
|
|
|
void LocalSocket::get_local_address(sockaddr* address, socklen_t* address_size)
|
|
{
|
|
size_t bytes_to_copy = min(static_cast<size_t>(*address_size), sizeof(sockaddr_un));
|
|
memcpy(address, &m_address, bytes_to_copy);
|
|
*address_size = sizeof(sockaddr_un);
|
|
}
|
|
|
|
void LocalSocket::get_peer_address(sockaddr* address, socklen_t* address_size)
|
|
{
|
|
get_local_address(address, address_size);
|
|
}
|
|
|
|
KResult LocalSocket::bind(Userspace<const sockaddr*> user_address, socklen_t address_size)
|
|
{
|
|
VERIFY(setup_state() == SetupState::Unstarted);
|
|
if (address_size != sizeof(sockaddr_un))
|
|
return set_so_error(EINVAL);
|
|
|
|
sockaddr_un address;
|
|
if (!copy_from_user(&address, user_address, sizeof(sockaddr_un)))
|
|
return set_so_error(EFAULT);
|
|
|
|
if (address.sun_family != AF_LOCAL)
|
|
return set_so_error(EINVAL);
|
|
|
|
auto path = String(address.sun_path, strnlen(address.sun_path, sizeof(address.sun_path)));
|
|
|
|
dbgln_if(LOCAL_SOCKET_DEBUG, "LocalSocket({}) bind({})", this, path);
|
|
|
|
mode_t mode = S_IFSOCK | (m_prebind_mode & 0777);
|
|
UidAndGid owner { m_prebind_uid, m_prebind_gid };
|
|
auto result = VirtualFileSystem::the().open(path, O_CREAT | O_EXCL | O_NOFOLLOW_NOERROR, mode, Process::current().current_directory(), owner);
|
|
if (result.is_error()) {
|
|
if (result.error() == EEXIST)
|
|
return set_so_error(EADDRINUSE);
|
|
return result.error();
|
|
}
|
|
|
|
auto file = move(result.value());
|
|
|
|
VERIFY(file->inode());
|
|
if (!file->inode()->bind_socket(*this))
|
|
return set_so_error(EADDRINUSE);
|
|
|
|
m_file = move(file);
|
|
|
|
m_address = address;
|
|
m_bound = true;
|
|
return KSuccess;
|
|
}
|
|
|
|
KResult LocalSocket::connect(FileDescription& description, Userspace<const sockaddr*> address, socklen_t address_size, ShouldBlock)
|
|
{
|
|
VERIFY(!m_bound);
|
|
if (address_size != sizeof(sockaddr_un))
|
|
return set_so_error(EINVAL);
|
|
u16 sa_family_copy;
|
|
auto* user_address = reinterpret_cast<const sockaddr*>(address.unsafe_userspace_ptr());
|
|
if (!copy_from_user(&sa_family_copy, &user_address->sa_family, sizeof(u16)))
|
|
return set_so_error(EFAULT);
|
|
if (sa_family_copy != AF_LOCAL)
|
|
return set_so_error(EINVAL);
|
|
if (is_connected())
|
|
return set_so_error(EISCONN);
|
|
|
|
const auto& local_address = *reinterpret_cast<const sockaddr_un*>(user_address);
|
|
char safe_address[sizeof(local_address.sun_path) + 1] = { 0 };
|
|
if (!copy_from_user(&safe_address[0], &local_address.sun_path[0], sizeof(safe_address) - 1))
|
|
return set_so_error(EFAULT);
|
|
safe_address[sizeof(safe_address) - 1] = '\0';
|
|
|
|
dbgln_if(LOCAL_SOCKET_DEBUG, "LocalSocket({}) connect({})", this, safe_address);
|
|
|
|
auto description_or_error = VirtualFileSystem::the().open(safe_address, O_RDWR, 0, Process::current().current_directory());
|
|
if (description_or_error.is_error())
|
|
return set_so_error(ECONNREFUSED);
|
|
|
|
m_file = move(description_or_error.value());
|
|
|
|
VERIFY(m_file->inode());
|
|
if (!m_file->inode()->socket())
|
|
return set_so_error(ECONNREFUSED);
|
|
|
|
m_address.sun_family = sa_family_copy;
|
|
memcpy(m_address.sun_path, safe_address, sizeof(m_address.sun_path));
|
|
|
|
VERIFY(m_connect_side_fd == &description);
|
|
set_connect_side_role(Role::Connecting);
|
|
|
|
auto peer = m_file->inode()->socket();
|
|
auto result = peer->queue_connection_from(*this);
|
|
if (result.is_error()) {
|
|
set_connect_side_role(Role::None);
|
|
return result;
|
|
}
|
|
|
|
if (is_connected()) {
|
|
set_connect_side_role(Role::Connected);
|
|
return KSuccess;
|
|
}
|
|
|
|
auto unblock_flags = Thread::FileDescriptionBlocker::BlockFlags::None;
|
|
if (Thread::current()->block<Thread::ConnectBlocker>({}, description, unblock_flags).was_interrupted()) {
|
|
set_connect_side_role(Role::None);
|
|
return set_so_error(EINTR);
|
|
}
|
|
|
|
dbgln_if(LOCAL_SOCKET_DEBUG, "LocalSocket({}) connect({}) status is {}", this, safe_address, to_string(setup_state()));
|
|
|
|
if (!has_flag(unblock_flags, Thread::FileDescriptionBlocker::BlockFlags::Connect)) {
|
|
set_connect_side_role(Role::None);
|
|
return set_so_error(ECONNREFUSED);
|
|
}
|
|
set_connect_side_role(Role::Connected);
|
|
return KSuccess;
|
|
}
|
|
|
|
KResult LocalSocket::listen(size_t backlog)
|
|
{
|
|
MutexLocker locker(lock());
|
|
if (type() != SOCK_STREAM)
|
|
return set_so_error(EOPNOTSUPP);
|
|
set_backlog(backlog);
|
|
auto previous_role = m_role;
|
|
m_role = Role::Listener;
|
|
set_connect_side_role(Role::Listener, previous_role != m_role);
|
|
|
|
dbgln_if(LOCAL_SOCKET_DEBUG, "LocalSocket({}) listening with backlog={}", this, backlog);
|
|
|
|
return KSuccess;
|
|
}
|
|
|
|
KResult LocalSocket::attach(FileDescription& description)
|
|
{
|
|
VERIFY(!m_accept_side_fd_open);
|
|
if (m_connect_side_role == Role::None) {
|
|
VERIFY(m_connect_side_fd == nullptr);
|
|
m_connect_side_fd = &description;
|
|
} else {
|
|
VERIFY(m_connect_side_fd != &description);
|
|
m_accept_side_fd_open = true;
|
|
}
|
|
|
|
evaluate_block_conditions();
|
|
return KSuccess;
|
|
}
|
|
|
|
void LocalSocket::detach(FileDescription& description)
|
|
{
|
|
if (m_connect_side_fd == &description) {
|
|
m_connect_side_fd = nullptr;
|
|
} else {
|
|
VERIFY(m_accept_side_fd_open);
|
|
m_accept_side_fd_open = false;
|
|
}
|
|
|
|
evaluate_block_conditions();
|
|
}
|
|
|
|
bool LocalSocket::can_read(const FileDescription& description, size_t) const
|
|
{
|
|
auto role = this->role(description);
|
|
if (role == Role::Listener)
|
|
return can_accept();
|
|
if (role == Role::Accepted)
|
|
return !has_attached_peer(description) || !m_for_server->is_empty();
|
|
if (role == Role::Connected)
|
|
return !has_attached_peer(description) || !m_for_client->is_empty();
|
|
return false;
|
|
}
|
|
|
|
bool LocalSocket::has_attached_peer(const FileDescription& description) const
|
|
{
|
|
auto role = this->role(description);
|
|
if (role == Role::Accepted)
|
|
return m_connect_side_fd != nullptr;
|
|
if (role == Role::Connected)
|
|
return m_accept_side_fd_open;
|
|
VERIFY_NOT_REACHED();
|
|
}
|
|
|
|
bool LocalSocket::can_write(const FileDescription& description, size_t) const
|
|
{
|
|
auto role = this->role(description);
|
|
if (role == Role::Accepted)
|
|
return !has_attached_peer(description) || m_for_client->space_for_writing();
|
|
if (role == Role::Connected)
|
|
return !has_attached_peer(description) || m_for_server->space_for_writing();
|
|
return false;
|
|
}
|
|
|
|
KResultOr<size_t> LocalSocket::sendto(FileDescription& description, const UserOrKernelBuffer& data, size_t data_size, int, Userspace<const sockaddr*>, socklen_t)
|
|
{
|
|
if (!has_attached_peer(description))
|
|
return set_so_error(EPIPE);
|
|
auto* socket_buffer = send_buffer_for(description);
|
|
if (!socket_buffer)
|
|
return set_so_error(EINVAL);
|
|
auto nwritten_or_error = socket_buffer->write(data, data_size);
|
|
if (!nwritten_or_error.is_error() && nwritten_or_error.value() > 0)
|
|
Thread::current()->did_unix_socket_write(nwritten_or_error.value());
|
|
return nwritten_or_error;
|
|
}
|
|
|
|
DoubleBuffer* LocalSocket::receive_buffer_for(FileDescription& description)
|
|
{
|
|
auto role = this->role(description);
|
|
if (role == Role::Accepted)
|
|
return m_for_server.ptr();
|
|
if (role == Role::Connected)
|
|
return m_for_client.ptr();
|
|
return nullptr;
|
|
}
|
|
|
|
DoubleBuffer* LocalSocket::send_buffer_for(FileDescription& description)
|
|
{
|
|
auto role = this->role(description);
|
|
if (role == Role::Connected)
|
|
return m_for_server.ptr();
|
|
if (role == Role::Accepted)
|
|
return m_for_client.ptr();
|
|
return nullptr;
|
|
}
|
|
|
|
KResultOr<size_t> LocalSocket::recvfrom(FileDescription& description, UserOrKernelBuffer& buffer, size_t buffer_size, int, Userspace<sockaddr*>, Userspace<socklen_t*>, Time&)
|
|
{
|
|
auto* socket_buffer = receive_buffer_for(description);
|
|
if (!socket_buffer)
|
|
return set_so_error(EINVAL);
|
|
if (!description.is_blocking()) {
|
|
if (socket_buffer->is_empty()) {
|
|
if (!has_attached_peer(description))
|
|
return 0;
|
|
return set_so_error(EAGAIN);
|
|
}
|
|
} else if (!can_read(description, 0)) {
|
|
auto unblock_flags = Thread::FileDescriptionBlocker::BlockFlags::None;
|
|
if (Thread::current()->block<Thread::ReadBlocker>({}, description, unblock_flags).was_interrupted())
|
|
return set_so_error(EINTR);
|
|
}
|
|
if (!has_attached_peer(description) && socket_buffer->is_empty())
|
|
return 0;
|
|
VERIFY(!socket_buffer->is_empty());
|
|
auto nread_or_error = socket_buffer->read(buffer, buffer_size);
|
|
if (!nread_or_error.is_error() && nread_or_error.value() > 0)
|
|
Thread::current()->did_unix_socket_read(nread_or_error.value());
|
|
return nread_or_error;
|
|
}
|
|
|
|
StringView LocalSocket::socket_path() const
|
|
{
|
|
size_t len = strnlen(m_address.sun_path, sizeof(m_address.sun_path));
|
|
return { m_address.sun_path, len };
|
|
}
|
|
|
|
String LocalSocket::absolute_path(const FileDescription& description) const
|
|
{
|
|
StringBuilder builder;
|
|
builder.append("socket:");
|
|
builder.append(socket_path());
|
|
|
|
switch (role(description)) {
|
|
case Role::Listener:
|
|
builder.append(" (listening)");
|
|
break;
|
|
case Role::Accepted:
|
|
builder.appendff(" (accepted from pid {})", origin_pid());
|
|
break;
|
|
case Role::Connected:
|
|
builder.appendff(" (connected to pid {})", acceptor_pid());
|
|
break;
|
|
case Role::Connecting:
|
|
builder.append(" (connecting)");
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
|
|
return builder.to_string();
|
|
}
|
|
|
|
KResult LocalSocket::getsockopt(FileDescription& description, int level, int option, Userspace<void*> value, Userspace<socklen_t*> value_size)
|
|
{
|
|
if (level != SOL_SOCKET)
|
|
return Socket::getsockopt(description, level, option, value, value_size);
|
|
|
|
socklen_t size;
|
|
if (!copy_from_user(&size, value_size.unsafe_userspace_ptr()))
|
|
return EFAULT;
|
|
|
|
switch (option) {
|
|
case SO_SNDBUF:
|
|
TODO();
|
|
case SO_RCVBUF:
|
|
TODO();
|
|
case SO_PEERCRED: {
|
|
if (size < sizeof(ucred))
|
|
return EINVAL;
|
|
switch (role(description)) {
|
|
case Role::Accepted:
|
|
if (!copy_to_user(static_ptr_cast<ucred*>(value), &m_origin))
|
|
return EFAULT;
|
|
size = sizeof(ucred);
|
|
if (!copy_to_user(value_size, &size))
|
|
return EFAULT;
|
|
return KSuccess;
|
|
case Role::Connected:
|
|
if (!copy_to_user(static_ptr_cast<ucred*>(value), &m_acceptor))
|
|
return EFAULT;
|
|
size = sizeof(ucred);
|
|
if (!copy_to_user(value_size, &size))
|
|
return EFAULT;
|
|
return KSuccess;
|
|
case Role::Connecting:
|
|
return ENOTCONN;
|
|
default:
|
|
return EINVAL;
|
|
}
|
|
break;
|
|
}
|
|
default:
|
|
return Socket::getsockopt(description, level, option, value, value_size);
|
|
}
|
|
}
|
|
|
|
KResult LocalSocket::chmod(FileDescription&, mode_t mode)
|
|
{
|
|
if (m_file)
|
|
return m_file->chmod(mode);
|
|
|
|
m_prebind_mode = mode & 0777;
|
|
return KSuccess;
|
|
}
|
|
|
|
KResult LocalSocket::chown(FileDescription&, uid_t uid, gid_t gid)
|
|
{
|
|
if (m_file)
|
|
return m_file->chown(uid, gid);
|
|
|
|
auto& current_process = Process::current();
|
|
if (!current_process.is_superuser() && (current_process.euid() != uid || !current_process.in_group(gid)))
|
|
return set_so_error(EPERM);
|
|
|
|
m_prebind_uid = uid;
|
|
m_prebind_gid = gid;
|
|
return KSuccess;
|
|
}
|
|
|
|
NonnullRefPtrVector<FileDescription>& LocalSocket::recvfd_queue_for(const FileDescription& description)
|
|
{
|
|
auto role = this->role(description);
|
|
if (role == Role::Connected)
|
|
return m_fds_for_client;
|
|
if (role == Role::Accepted)
|
|
return m_fds_for_server;
|
|
VERIFY_NOT_REACHED();
|
|
}
|
|
|
|
NonnullRefPtrVector<FileDescription>& LocalSocket::sendfd_queue_for(const FileDescription& description)
|
|
{
|
|
auto role = this->role(description);
|
|
if (role == Role::Connected)
|
|
return m_fds_for_server;
|
|
if (role == Role::Accepted)
|
|
return m_fds_for_client;
|
|
VERIFY_NOT_REACHED();
|
|
}
|
|
|
|
KResult LocalSocket::sendfd(const FileDescription& socket_description, FileDescription& passing_description)
|
|
{
|
|
MutexLocker locker(lock());
|
|
auto role = this->role(socket_description);
|
|
if (role != Role::Connected && role != Role::Accepted)
|
|
return set_so_error(EINVAL);
|
|
auto& queue = sendfd_queue_for(socket_description);
|
|
// FIXME: Figure out how we should limit this properly.
|
|
if (queue.size() > 128)
|
|
return set_so_error(EBUSY);
|
|
if (!queue.try_append(move(passing_description)))
|
|
return set_so_error(ENOMEM);
|
|
return KSuccess;
|
|
}
|
|
|
|
KResultOr<NonnullRefPtr<FileDescription>> LocalSocket::recvfd(const FileDescription& socket_description)
|
|
{
|
|
MutexLocker locker(lock());
|
|
auto role = this->role(socket_description);
|
|
if (role != Role::Connected && role != Role::Accepted)
|
|
return set_so_error(EINVAL);
|
|
auto& queue = recvfd_queue_for(socket_description);
|
|
if (queue.is_empty()) {
|
|
// FIXME: Figure out the perfect error code for this.
|
|
return set_so_error(EAGAIN);
|
|
}
|
|
return queue.take_first();
|
|
}
|
|
|
|
}
|