2018-01-18 11:35:03 -08:00
|
|
|
// Copyright 2018 yuzu emulator team
|
|
|
|
// Licensed under GPLv2 or any later version
|
|
|
|
// Refer to the license.txt file included.
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
services/bsd: Implement most of bsd:s
This implements: Socket, Poll, Accept, Bind, Connect, GetPeerName,
GetSockName, Listen, Fcntl, SetSockOpt, Shutdown, Recv, RecvFrom,
Send, SendTo, Write, and Close
The implementation was done referencing: SwIPC, switchbrew, testing
with libnx and inspecting its code, general information about bsd
sockets online, and analysing official software.
Not everything from these service calls is implemented, but everything
that is not implemented will be logged in some way.
2020-07-11 18:37:47 -07:00
|
|
|
#include <memory>
|
|
|
|
#include <string_view>
|
|
|
|
#include <vector>
|
|
|
|
|
2020-07-11 18:26:24 -07:00
|
|
|
#include "common/common_types.h"
|
2018-01-18 11:35:03 -08:00
|
|
|
#include "core/hle/kernel/hle_ipc.h"
|
|
|
|
#include "core/hle/service/service.h"
|
services/bsd: Implement most of bsd:s
This implements: Socket, Poll, Accept, Bind, Connect, GetPeerName,
GetSockName, Listen, Fcntl, SetSockOpt, Shutdown, Recv, RecvFrom,
Send, SendTo, Write, and Close
The implementation was done referencing: SwIPC, switchbrew, testing
with libnx and inspecting its code, general information about bsd
sockets online, and analysing official software.
Not everything from these service calls is implemented, but everything
that is not implemented will be logged in some way.
2020-07-11 18:37:47 -07:00
|
|
|
#include "core/hle/service/sockets/blocking_worker.h"
|
2020-07-11 18:26:24 -07:00
|
|
|
#include "core/hle/service/sockets/sockets.h"
|
2018-01-18 11:35:03 -08:00
|
|
|
|
services/bsd: Implement most of bsd:s
This implements: Socket, Poll, Accept, Bind, Connect, GetPeerName,
GetSockName, Listen, Fcntl, SetSockOpt, Shutdown, Recv, RecvFrom,
Send, SendTo, Write, and Close
The implementation was done referencing: SwIPC, switchbrew, testing
with libnx and inspecting its code, general information about bsd
sockets online, and analysing official software.
Not everything from these service calls is implemented, but everything
that is not implemented will be logged in some way.
2020-07-11 18:37:47 -07:00
|
|
|
namespace Core {
|
|
|
|
class System;
|
|
|
|
}
|
|
|
|
|
|
|
|
namespace Network {
|
|
|
|
class Socket;
|
|
|
|
}
|
|
|
|
|
2018-04-19 18:41:44 -07:00
|
|
|
namespace Service::Sockets {
|
2018-01-18 11:35:03 -08:00
|
|
|
|
2018-03-25 02:41:00 -07:00
|
|
|
class BSD final : public ServiceFramework<BSD> {
|
2018-01-18 11:35:03 -08:00
|
|
|
public:
|
2020-11-26 12:19:08 -08:00
|
|
|
explicit BSD(Core::System& system_, const char* name);
|
hle/service: Default constructors and destructors in the cpp file where applicable
When a destructor isn't defaulted into a cpp file, it can cause the use
of forward declarations to seemingly fail to compile for non-obvious
reasons. It also allows inlining of the construction/destruction logic
all over the place where a constructor or destructor is invoked, which
can lead to code bloat. This isn't so much a worry here, given the
services won't be created and destroyed frequently.
The cause of the above mentioned non-obvious errors can be demonstrated
as follows:
------- Demonstrative example, if you know how the described error happens, skip forwards -------
Assume we have the following in the header, which we'll call "thing.h":
\#include <memory>
// Forward declaration. For example purposes, assume the definition
// of Object is in some header named "object.h"
class Object;
class Thing {
public:
// assume no constructors or destructors are specified here,
// or the constructors/destructors are defined as:
//
// Thing() = default;
// ~Thing() = default;
//
// ... Some interface member functions would be defined here
private:
std::shared_ptr<Object> obj;
};
If this header is included in a cpp file, (which we'll call "main.cpp"),
this will result in a compilation error, because even though no
destructor is specified, the destructor will still need to be generated by
the compiler because std::shared_ptr's destructor is *not* trivial (in
other words, it does something other than nothing), as std::shared_ptr's
destructor needs to do two things:
1. Decrement the shared reference count of the object being pointed to,
and if the reference count decrements to zero,
2. Free the Object instance's memory (aka deallocate the memory it's
pointing to).
And so the compiler generates the code for the destructor doing this inside main.cpp.
Now, keep in mind, the Object forward declaration is not a complete type. All it
does is tell the compiler "a type named Object exists" and allows us to
use the name in certain situations to avoid a header dependency. So the
compiler needs to generate destruction code for Object, but the compiler
doesn't know *how* to destruct it. A forward declaration doesn't tell
the compiler anything about Object's constructor or destructor. So, the
compiler will issue an error in this case because it's undefined
behavior to try and deallocate (or construct) an incomplete type and
std::shared_ptr and std::unique_ptr make sure this isn't the case
internally.
Now, if we had defaulted the destructor in "thing.cpp", where we also
include "object.h", this would never be an issue, as the destructor
would only have its code generated in one place, and it would be in a
place where the full class definition of Object would be visible to the
compiler.
---------------------- End example ----------------------------
Given these service classes are more than certainly going to change in
the future, this defaults the constructors and destructors into the
relevant cpp files to make the construction and destruction of all of
the services consistent and unlikely to run into cases where forward
declarations are indirectly causing compilation errors. It also has the
plus of avoiding the need to rebuild several services if destruction
logic changes, since it would only be necessary to recompile the single
cpp file.
2018-09-10 18:20:52 -07:00
|
|
|
~BSD() override;
|
2018-01-18 11:35:03 -08:00
|
|
|
|
|
|
|
private:
|
services/bsd: Implement most of bsd:s
This implements: Socket, Poll, Accept, Bind, Connect, GetPeerName,
GetSockName, Listen, Fcntl, SetSockOpt, Shutdown, Recv, RecvFrom,
Send, SendTo, Write, and Close
The implementation was done referencing: SwIPC, switchbrew, testing
with libnx and inspecting its code, general information about bsd
sockets online, and analysing official software.
Not everything from these service calls is implemented, but everything
that is not implemented will be logged in some way.
2020-07-11 18:37:47 -07:00
|
|
|
/// Maximum number of file descriptors
|
|
|
|
static constexpr size_t MAX_FD = 128;
|
|
|
|
|
|
|
|
struct FileDescriptor {
|
|
|
|
std::unique_ptr<Network::Socket> socket;
|
|
|
|
s32 flags = 0;
|
|
|
|
bool is_connection_based = false;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct PollWork {
|
|
|
|
void Execute(BSD* bsd);
|
|
|
|
void Response(Kernel::HLERequestContext& ctx);
|
|
|
|
|
|
|
|
s32 nfds;
|
|
|
|
s32 timeout;
|
|
|
|
std::vector<u8> read_buffer;
|
|
|
|
std::vector<u8> write_buffer;
|
|
|
|
s32 ret{};
|
|
|
|
Errno bsd_errno{};
|
|
|
|
};
|
|
|
|
|
|
|
|
struct AcceptWork {
|
|
|
|
void Execute(BSD* bsd);
|
|
|
|
void Response(Kernel::HLERequestContext& ctx);
|
|
|
|
|
|
|
|
s32 fd;
|
|
|
|
std::vector<u8> write_buffer;
|
|
|
|
s32 ret{};
|
|
|
|
Errno bsd_errno{};
|
|
|
|
};
|
|
|
|
|
|
|
|
struct ConnectWork {
|
|
|
|
void Execute(BSD* bsd);
|
|
|
|
void Response(Kernel::HLERequestContext& ctx);
|
|
|
|
|
|
|
|
s32 fd;
|
|
|
|
std::vector<u8> addr;
|
|
|
|
Errno bsd_errno{};
|
|
|
|
};
|
|
|
|
|
|
|
|
struct RecvWork {
|
|
|
|
void Execute(BSD* bsd);
|
|
|
|
void Response(Kernel::HLERequestContext& ctx);
|
|
|
|
|
|
|
|
s32 fd;
|
|
|
|
u32 flags;
|
|
|
|
std::vector<u8> message;
|
|
|
|
s32 ret{};
|
|
|
|
Errno bsd_errno{};
|
|
|
|
};
|
|
|
|
|
|
|
|
struct RecvFromWork {
|
|
|
|
void Execute(BSD* bsd);
|
|
|
|
void Response(Kernel::HLERequestContext& ctx);
|
|
|
|
|
|
|
|
s32 fd;
|
|
|
|
u32 flags;
|
|
|
|
std::vector<u8> message;
|
|
|
|
std::vector<u8> addr;
|
|
|
|
s32 ret{};
|
|
|
|
Errno bsd_errno{};
|
|
|
|
};
|
|
|
|
|
|
|
|
struct SendWork {
|
|
|
|
void Execute(BSD* bsd);
|
|
|
|
void Response(Kernel::HLERequestContext& ctx);
|
|
|
|
|
|
|
|
s32 fd;
|
|
|
|
u32 flags;
|
|
|
|
std::vector<u8> message;
|
|
|
|
s32 ret{};
|
|
|
|
Errno bsd_errno{};
|
|
|
|
};
|
|
|
|
|
|
|
|
struct SendToWork {
|
|
|
|
void Execute(BSD* bsd);
|
|
|
|
void Response(Kernel::HLERequestContext& ctx);
|
|
|
|
|
|
|
|
s32 fd;
|
|
|
|
u32 flags;
|
|
|
|
std::vector<u8> message;
|
|
|
|
std::vector<u8> addr;
|
|
|
|
s32 ret{};
|
|
|
|
Errno bsd_errno{};
|
|
|
|
};
|
|
|
|
|
2018-01-18 11:35:03 -08:00
|
|
|
void RegisterClient(Kernel::HLERequestContext& ctx);
|
2018-02-22 02:04:23 -08:00
|
|
|
void StartMonitoring(Kernel::HLERequestContext& ctx);
|
2018-01-18 11:35:03 -08:00
|
|
|
void Socket(Kernel::HLERequestContext& ctx);
|
2020-01-24 21:47:15 -08:00
|
|
|
void Select(Kernel::HLERequestContext& ctx);
|
services/bsd: Implement most of bsd:s
This implements: Socket, Poll, Accept, Bind, Connect, GetPeerName,
GetSockName, Listen, Fcntl, SetSockOpt, Shutdown, Recv, RecvFrom,
Send, SendTo, Write, and Close
The implementation was done referencing: SwIPC, switchbrew, testing
with libnx and inspecting its code, general information about bsd
sockets online, and analysing official software.
Not everything from these service calls is implemented, but everything
that is not implemented will be logged in some way.
2020-07-11 18:37:47 -07:00
|
|
|
void Poll(Kernel::HLERequestContext& ctx);
|
|
|
|
void Accept(Kernel::HLERequestContext& ctx);
|
2020-01-24 21:47:15 -08:00
|
|
|
void Bind(Kernel::HLERequestContext& ctx);
|
2018-01-18 11:35:03 -08:00
|
|
|
void Connect(Kernel::HLERequestContext& ctx);
|
services/bsd: Implement most of bsd:s
This implements: Socket, Poll, Accept, Bind, Connect, GetPeerName,
GetSockName, Listen, Fcntl, SetSockOpt, Shutdown, Recv, RecvFrom,
Send, SendTo, Write, and Close
The implementation was done referencing: SwIPC, switchbrew, testing
with libnx and inspecting its code, general information about bsd
sockets online, and analysing official software.
Not everything from these service calls is implemented, but everything
that is not implemented will be logged in some way.
2020-07-11 18:37:47 -07:00
|
|
|
void GetPeerName(Kernel::HLERequestContext& ctx);
|
|
|
|
void GetSockName(Kernel::HLERequestContext& ctx);
|
2020-01-24 21:47:15 -08:00
|
|
|
void Listen(Kernel::HLERequestContext& ctx);
|
services/bsd: Implement most of bsd:s
This implements: Socket, Poll, Accept, Bind, Connect, GetPeerName,
GetSockName, Listen, Fcntl, SetSockOpt, Shutdown, Recv, RecvFrom,
Send, SendTo, Write, and Close
The implementation was done referencing: SwIPC, switchbrew, testing
with libnx and inspecting its code, general information about bsd
sockets online, and analysing official software.
Not everything from these service calls is implemented, but everything
that is not implemented will be logged in some way.
2020-07-11 18:37:47 -07:00
|
|
|
void Fcntl(Kernel::HLERequestContext& ctx);
|
2020-01-24 21:47:15 -08:00
|
|
|
void SetSockOpt(Kernel::HLERequestContext& ctx);
|
services/bsd: Implement most of bsd:s
This implements: Socket, Poll, Accept, Bind, Connect, GetPeerName,
GetSockName, Listen, Fcntl, SetSockOpt, Shutdown, Recv, RecvFrom,
Send, SendTo, Write, and Close
The implementation was done referencing: SwIPC, switchbrew, testing
with libnx and inspecting its code, general information about bsd
sockets online, and analysing official software.
Not everything from these service calls is implemented, but everything
that is not implemented will be logged in some way.
2020-07-11 18:37:47 -07:00
|
|
|
void Shutdown(Kernel::HLERequestContext& ctx);
|
|
|
|
void Recv(Kernel::HLERequestContext& ctx);
|
|
|
|
void RecvFrom(Kernel::HLERequestContext& ctx);
|
|
|
|
void Send(Kernel::HLERequestContext& ctx);
|
2018-01-18 11:35:03 -08:00
|
|
|
void SendTo(Kernel::HLERequestContext& ctx);
|
services/bsd: Implement most of bsd:s
This implements: Socket, Poll, Accept, Bind, Connect, GetPeerName,
GetSockName, Listen, Fcntl, SetSockOpt, Shutdown, Recv, RecvFrom,
Send, SendTo, Write, and Close
The implementation was done referencing: SwIPC, switchbrew, testing
with libnx and inspecting its code, general information about bsd
sockets online, and analysing official software.
Not everything from these service calls is implemented, but everything
that is not implemented will be logged in some way.
2020-07-11 18:37:47 -07:00
|
|
|
void Write(Kernel::HLERequestContext& ctx);
|
2018-01-29 22:29:47 -08:00
|
|
|
void Close(Kernel::HLERequestContext& ctx);
|
2018-01-18 11:35:03 -08:00
|
|
|
|
services/bsd: Implement most of bsd:s
This implements: Socket, Poll, Accept, Bind, Connect, GetPeerName,
GetSockName, Listen, Fcntl, SetSockOpt, Shutdown, Recv, RecvFrom,
Send, SendTo, Write, and Close
The implementation was done referencing: SwIPC, switchbrew, testing
with libnx and inspecting its code, general information about bsd
sockets online, and analysing official software.
Not everything from these service calls is implemented, but everything
that is not implemented will be logged in some way.
2020-07-11 18:37:47 -07:00
|
|
|
template <typename Work>
|
|
|
|
void ExecuteWork(Kernel::HLERequestContext& ctx, std::string_view sleep_reason,
|
|
|
|
bool is_blocking, Work work);
|
|
|
|
|
|
|
|
std::pair<s32, Errno> SocketImpl(Domain domain, Type type, Protocol protocol);
|
|
|
|
std::pair<s32, Errno> PollImpl(std::vector<u8>& write_buffer, std::vector<u8> read_buffer,
|
|
|
|
s32 nfds, s32 timeout);
|
|
|
|
std::pair<s32, Errno> AcceptImpl(s32 fd, std::vector<u8>& write_buffer);
|
|
|
|
Errno BindImpl(s32 fd, const std::vector<u8>& addr);
|
|
|
|
Errno ConnectImpl(s32 fd, const std::vector<u8>& addr);
|
|
|
|
Errno GetPeerNameImpl(s32 fd, std::vector<u8>& write_buffer);
|
|
|
|
Errno GetSockNameImpl(s32 fd, std::vector<u8>& write_buffer);
|
|
|
|
Errno ListenImpl(s32 fd, s32 backlog);
|
|
|
|
std::pair<s32, Errno> FcntlImpl(s32 fd, FcntlCmd cmd, s32 arg);
|
|
|
|
Errno SetSockOptImpl(s32 fd, u32 level, OptName optname, size_t optlen, const void* optval);
|
|
|
|
Errno ShutdownImpl(s32 fd, s32 how);
|
|
|
|
std::pair<s32, Errno> RecvImpl(s32 fd, u32 flags, std::vector<u8>& message);
|
|
|
|
std::pair<s32, Errno> RecvFromImpl(s32 fd, u32 flags, std::vector<u8>& message,
|
|
|
|
std::vector<u8>& addr);
|
|
|
|
std::pair<s32, Errno> SendImpl(s32 fd, u32 flags, const std::vector<u8>& message);
|
|
|
|
std::pair<s32, Errno> SendToImpl(s32 fd, u32 flags, const std::vector<u8>& message,
|
|
|
|
const std::vector<u8>& addr);
|
|
|
|
Errno CloseImpl(s32 fd);
|
|
|
|
|
|
|
|
s32 FindFreeFileDescriptorHandle() noexcept;
|
|
|
|
bool IsFileDescriptorValid(s32 fd) const noexcept;
|
|
|
|
bool IsBlockingSocket(s32 fd) const noexcept;
|
|
|
|
|
|
|
|
void BuildErrnoResponse(Kernel::HLERequestContext& ctx, Errno bsd_errno) const noexcept;
|
|
|
|
|
|
|
|
std::array<std::optional<FileDescriptor>, MAX_FD> file_descriptors;
|
|
|
|
|
|
|
|
BlockingWorkerPool<BSD, PollWork, AcceptWork, ConnectWork, RecvWork, RecvFromWork, SendWork,
|
|
|
|
SendToWork>
|
|
|
|
worker_pool;
|
2018-01-18 11:35:03 -08:00
|
|
|
};
|
|
|
|
|
2018-07-25 21:55:33 -07:00
|
|
|
class BSDCFG final : public ServiceFramework<BSDCFG> {
|
|
|
|
public:
|
2020-11-26 12:19:08 -08:00
|
|
|
explicit BSDCFG(Core::System& system_);
|
hle/service: Default constructors and destructors in the cpp file where applicable
When a destructor isn't defaulted into a cpp file, it can cause the use
of forward declarations to seemingly fail to compile for non-obvious
reasons. It also allows inlining of the construction/destruction logic
all over the place where a constructor or destructor is invoked, which
can lead to code bloat. This isn't so much a worry here, given the
services won't be created and destroyed frequently.
The cause of the above mentioned non-obvious errors can be demonstrated
as follows:
------- Demonstrative example, if you know how the described error happens, skip forwards -------
Assume we have the following in the header, which we'll call "thing.h":
\#include <memory>
// Forward declaration. For example purposes, assume the definition
// of Object is in some header named "object.h"
class Object;
class Thing {
public:
// assume no constructors or destructors are specified here,
// or the constructors/destructors are defined as:
//
// Thing() = default;
// ~Thing() = default;
//
// ... Some interface member functions would be defined here
private:
std::shared_ptr<Object> obj;
};
If this header is included in a cpp file, (which we'll call "main.cpp"),
this will result in a compilation error, because even though no
destructor is specified, the destructor will still need to be generated by
the compiler because std::shared_ptr's destructor is *not* trivial (in
other words, it does something other than nothing), as std::shared_ptr's
destructor needs to do two things:
1. Decrement the shared reference count of the object being pointed to,
and if the reference count decrements to zero,
2. Free the Object instance's memory (aka deallocate the memory it's
pointing to).
And so the compiler generates the code for the destructor doing this inside main.cpp.
Now, keep in mind, the Object forward declaration is not a complete type. All it
does is tell the compiler "a type named Object exists" and allows us to
use the name in certain situations to avoid a header dependency. So the
compiler needs to generate destruction code for Object, but the compiler
doesn't know *how* to destruct it. A forward declaration doesn't tell
the compiler anything about Object's constructor or destructor. So, the
compiler will issue an error in this case because it's undefined
behavior to try and deallocate (or construct) an incomplete type and
std::shared_ptr and std::unique_ptr make sure this isn't the case
internally.
Now, if we had defaulted the destructor in "thing.cpp", where we also
include "object.h", this would never be an issue, as the destructor
would only have its code generated in one place, and it would be in a
place where the full class definition of Object would be visible to the
compiler.
---------------------- End example ----------------------------
Given these service classes are more than certainly going to change in
the future, this defaults the constructors and destructors into the
relevant cpp files to make the construction and destruction of all of
the services consistent and unlikely to run into cases where forward
declarations are indirectly causing compilation errors. It also has the
plus of avoiding the need to rebuild several services if destruction
logic changes, since it would only be necessary to recompile the single
cpp file.
2018-09-10 18:20:52 -07:00
|
|
|
~BSDCFG() override;
|
2018-07-25 21:55:33 -07:00
|
|
|
};
|
|
|
|
|
2018-04-19 18:41:44 -07:00
|
|
|
} // namespace Service::Sockets
|