2014-12-14 06:30:11 +01:00
|
|
|
// Copyright 2014 Citra Emulator Project
|
2014-12-17 06:38:14 +01:00
|
|
|
// Licensed under GPLv2 or any later version
|
2014-12-14 06:30:11 +01:00
|
|
|
// Refer to the license.txt file included.
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
2017-02-20 03:37:14 +01:00
|
|
|
#include <memory>
|
2015-06-21 14:40:28 +02:00
|
|
|
#include <string>
|
2019-08-11 23:29:00 +02:00
|
|
|
#include <boost/serialization/export.hpp>
|
2015-06-21 14:40:28 +02:00
|
|
|
#include "common/assert.h"
|
|
|
|
#include "common/common_types.h"
|
2018-11-08 19:53:20 +01:00
|
|
|
#include "core/hle/kernel/ipc.h"
|
2018-08-02 04:40:00 +02:00
|
|
|
#include "core/hle/kernel/object.h"
|
2019-08-11 23:29:00 +02:00
|
|
|
#include "core/hle/kernel/session.h"
|
2017-05-30 00:45:30 +02:00
|
|
|
#include "core/hle/kernel/wait_object.h"
|
2015-06-21 14:40:28 +02:00
|
|
|
#include "core/hle/result.h"
|
2015-05-13 03:38:29 +02:00
|
|
|
#include "core/memory.h"
|
2014-12-14 06:30:11 +01:00
|
|
|
|
|
|
|
namespace Kernel {
|
|
|
|
|
2016-06-15 01:03:30 +02:00
|
|
|
class ClientSession;
|
2017-01-05 05:23:17 +01:00
|
|
|
class ClientPort;
|
|
|
|
class ServerSession;
|
2017-06-08 09:33:57 +02:00
|
|
|
class Session;
|
2017-06-05 06:52:19 +02:00
|
|
|
class SessionRequestHandler;
|
2017-05-30 01:45:42 +02:00
|
|
|
class Thread;
|
2016-06-15 01:03:30 +02:00
|
|
|
|
2014-12-14 06:30:11 +01:00
|
|
|
/**
|
2016-06-15 01:03:30 +02:00
|
|
|
* Kernel object representing the server endpoint of an IPC session. Sessions are the basic CTR-OS
|
2014-12-14 06:30:11 +01:00
|
|
|
* primitive for communication between different processes, and are used to implement service calls
|
|
|
|
* to the various system services.
|
|
|
|
*
|
|
|
|
* To make a service call, the client must write the command header and parameters to the buffer
|
|
|
|
* located at offset 0x80 of the TLS (Thread-Local Storage) area, then execute a SendSyncRequest
|
2016-12-14 18:33:49 +01:00
|
|
|
* SVC call with its ClientSession handle. The kernel will read the command header, using it to
|
|
|
|
* marshall the parameters to the process at the server endpoint of the session.
|
|
|
|
* After the server replies to the request, the response is marshalled back to the caller's
|
|
|
|
* TLS buffer and control is transferred back to it.
|
2014-12-14 06:30:11 +01:00
|
|
|
*/
|
2016-12-05 17:02:08 +01:00
|
|
|
class ServerSession final : public WaitObject {
|
2014-12-14 06:30:11 +01:00
|
|
|
public:
|
2019-03-23 21:04:19 +01:00
|
|
|
~ServerSession() override;
|
2019-12-27 19:52:33 +01:00
|
|
|
explicit ServerSession(KernelSystem& kernel);
|
2019-03-23 21:04:19 +01:00
|
|
|
|
2017-10-02 05:17:50 +02:00
|
|
|
std::string GetName() const override {
|
|
|
|
return name;
|
|
|
|
}
|
2016-12-01 05:28:31 +01:00
|
|
|
std::string GetTypeName() const override {
|
|
|
|
return "ServerSession";
|
|
|
|
}
|
2014-12-14 06:30:11 +01:00
|
|
|
|
2019-04-11 22:30:52 +02:00
|
|
|
static constexpr HandleType HANDLE_TYPE = HandleType::ServerSession;
|
2016-12-01 05:28:31 +01:00
|
|
|
HandleType GetHandleType() const override {
|
|
|
|
return HANDLE_TYPE;
|
|
|
|
}
|
2016-06-15 01:03:30 +02:00
|
|
|
|
2017-06-06 07:39:26 +02:00
|
|
|
/**
|
|
|
|
* Sets the HLE handler for the session. This handler will be called to service IPC requests
|
|
|
|
* instead of the regular IPC machinery. (The regular IPC machinery is currently not
|
|
|
|
* implemented.)
|
|
|
|
*/
|
|
|
|
void SetHleHandler(std::shared_ptr<SessionRequestHandler> hle_handler_) {
|
|
|
|
hle_handler = std::move(hle_handler_);
|
|
|
|
}
|
2014-12-14 06:30:11 +01:00
|
|
|
|
|
|
|
/**
|
2016-06-15 01:03:30 +02:00
|
|
|
* Handle a sync request from the emulated application.
|
2017-06-21 00:33:28 +02:00
|
|
|
* @param thread Thread that initiated the request.
|
2016-06-15 01:03:30 +02:00
|
|
|
* @returns ResultCode from the operation.
|
2014-12-14 06:30:11 +01:00
|
|
|
*/
|
2019-03-23 21:04:19 +01:00
|
|
|
ResultCode HandleSyncRequest(std::shared_ptr<Thread> thread);
|
2015-01-19 02:40:53 +01:00
|
|
|
|
Port various minor changes from yuzu PRs (#4725)
* common/thread: Remove unused functions
Many of these functions are carried over from Dolphin (where they aren't
used anymore). Given these have no use (and we really shouldn't be
screwing around with OS-specific thread scheduler handling from the
emulator, these can be removed.
The function for setting the thread name is left, however, since it can
have debugging utility usages.
* input_common/sdl: Use a type alias to shorten declaration of GetPollers
Just makes the definitions a little bit more tidy.
* input_common/sdl: Correct return values within implementations of GetPollers()
In both cases, we weren't actually returning anything, which is
undefined behavior.
* yuzu/debugger/graphics_surface: Fill in missing surface format listings
Fills in the missing surface types that were marked as unknown. The
order corresponds with the TextureFormat enum within
video_core/texture.h.
We also don't need to all of these strings as translatable (only the
first string, as it's an English word).
* yuzu/debugger/graphics_surface: Clean up connection overload deduction
We can utilize qOverload with the signal connections to make the
function deducing a little less ugly.
* yuzu/debugger/graphics_surface: Tidy up SaveSurface
- Use QStringLiteral where applicable.
- Use const where applicable
- Remove unnecessary precondition check (we already assert the pixbuf
being non null)
* yuzu/debugger/graphics_surface: Display error messages for file I/O errors
* core: Add missing override specifiers where applicable
Applies the override specifier where applicable. In the case of
destructors that are defaulted in their definition, they can
simply be removed.
This also removes the unnecessary inclusions being done in audin_u and
audrec_u, given their close proximity.
* kernel/thread: Make parameter of GetWaitObjectIndex() const qualified
The pointed to member is never actually modified, so it can be made
const.
* kernel/thread: Avoid sign conversion within GetCommandBufferAddress()
Previously this was performing a u64 + int sign conversion. When dealing
with addresses, we should generally be keeping the arithmetic in the
same signedness type.
This also gets rid of the static lifetime of the constant, as there's no
need to make a trivial type like this potentially live for the entire
duration of the program.
* kernel/codeset: Make CodeSet's memory data member a regular std::vector
The use of a shared_ptr is an implementation detail of the VMManager
itself when mapping memory. Because of that, we shouldn't require all
users of the CodeSet to have to allocate the shared_ptr ahead of time.
It's intended that CodeSet simply pass in the required direct data, and
that the memory manager takes care of it from that point on.
This means we just do the shared pointer allocation in a single place,
when loading modules, as opposed to in each loader.
* kernel/wait_object: Make ShouldWait() take thread members by pointer-to-const
Given this is intended as a querying function, it doesn't make sense to
allow the implementer to modify the state of the given thread.
2019-05-01 14:28:49 +02:00
|
|
|
bool ShouldWait(const Thread* thread) const override;
|
2015-01-20 23:41:12 +01:00
|
|
|
|
2017-01-01 22:53:22 +01:00
|
|
|
void Acquire(Thread* thread) override;
|
2015-01-20 23:41:12 +01:00
|
|
|
|
2017-01-05 05:23:17 +01:00
|
|
|
std::string name; ///< The name of this session (optional)
|
|
|
|
std::shared_ptr<Session> parent; ///< The parent session, which links to the client endpoint.
|
2017-06-05 06:52:19 +02:00
|
|
|
std::shared_ptr<SessionRequestHandler>
|
2016-12-14 18:33:49 +01:00
|
|
|
hle_handler; ///< This session's HLE request handler (optional)
|
2016-12-05 17:02:08 +01:00
|
|
|
|
2017-06-21 00:33:28 +02:00
|
|
|
/// List of threads that are pending a response after a sync request. This list is processed in
|
|
|
|
/// a LIFO manner, thus, the last request will be dispatched first.
|
|
|
|
/// TODO(Subv): Verify if this is indeed processed in LIFO using a hardware test.
|
2019-03-23 21:04:19 +01:00
|
|
|
std::vector<std::shared_ptr<Thread>> pending_requesting_threads;
|
2017-06-21 00:33:28 +02:00
|
|
|
|
|
|
|
/// Thread whose request is currently being handled. A request is considered "handled" when a
|
|
|
|
/// response is sent via svcReplyAndReceive.
|
|
|
|
/// TODO(Subv): Find a better name for this.
|
2019-03-23 21:04:19 +01:00
|
|
|
std::shared_ptr<Thread> currently_handling;
|
2017-06-21 00:33:28 +02:00
|
|
|
|
2018-11-08 19:53:20 +01:00
|
|
|
/// A temporary list holding mapped buffer info from IPC request, used for during IPC reply
|
|
|
|
std::vector<MappedBufferContext> mapped_buffer_context;
|
|
|
|
|
2016-12-05 17:02:08 +01:00
|
|
|
private:
|
|
|
|
/**
|
|
|
|
* Creates a server session. The server session can have an optional HLE handler,
|
|
|
|
* which will be invoked to handle the IPC requests that this session receives.
|
2018-10-13 22:11:20 +02:00
|
|
|
* @param kernel The kernel instance to create the server session on
|
2016-12-05 17:02:08 +01:00
|
|
|
* @param name Optional name of the server session.
|
|
|
|
* @return The created server session
|
|
|
|
*/
|
2019-03-23 21:04:19 +01:00
|
|
|
static ResultVal<std::shared_ptr<ServerSession>> Create(KernelSystem& kernel,
|
|
|
|
std::string name = "Unknown");
|
2018-10-13 22:11:20 +02:00
|
|
|
|
|
|
|
friend class KernelSystem;
|
2019-02-02 21:18:01 +01:00
|
|
|
KernelSystem& kernel;
|
2019-08-11 23:29:00 +02:00
|
|
|
|
|
|
|
friend class boost::serialization::access;
|
|
|
|
template <class Archive>
|
2020-03-31 18:54:28 +02:00
|
|
|
void serialize(Archive& ar, const unsigned int file_version);
|
2014-12-14 06:30:11 +01:00
|
|
|
};
|
2016-12-09 18:52:12 +01:00
|
|
|
|
2017-10-02 05:17:50 +02:00
|
|
|
} // namespace Kernel
|
2019-08-11 23:29:00 +02:00
|
|
|
|
|
|
|
BOOST_CLASS_EXPORT_KEY(Kernel::ServerSession)
|
2019-12-27 19:52:33 +01:00
|
|
|
CONSTRUCT_KERNEL_OBJECT(Kernel::ServerSession)
|