/* * Copyright (c) Atmosphère-NX * * This program is free software; you can redistribute it and/or modify it * under the terms and conditions of the GNU General Public License, * version 2, as published by the Free Software Foundation. * * This program is distributed in the hope it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for * more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ #pragma once #include #include #include #include #include namespace ams::tipc { /* TODO: Put this in a better header. */ constexpr inline u16 MethodId_Invalid = 0x0; constexpr inline u16 MethodId_CloseSession = 0xF; class ObjectManagerBase { protected: struct Entry { util::TypedStorage object; os::MultiWaitHolderType multi_wait_holder; }; private: os::SdkMutex m_mutex{}; Entry *m_entries_start{}; Entry *m_entries_end{}; os::MultiWaitType *m_multi_wait{}; private: Entry *FindEntry(tipc::NativeHandle handle) { for (Entry *cur = m_entries_start; cur != m_entries_end; ++cur) { if (GetReference(cur->object).GetHandle() == handle) { return cur; } } return nullptr; } Entry *FindEntry(os::MultiWaitHolderType *holder) { for (Entry *cur = m_entries_start; cur != m_entries_end; ++cur) { if (std::addressof(cur->multi_wait_holder) == holder) { return cur; } } return nullptr; } public: constexpr ObjectManagerBase() = default; void InitializeImpl(os::MultiWaitType *multi_wait, Entry *entries, size_t max_objects) { /* Set our multi wait. */ m_multi_wait = multi_wait; /* Setup entry pointers. */ m_entries_start = entries; m_entries_end = entries + max_objects; /* Construct all entries. */ for (size_t i = 0; i < max_objects; ++i) { util::ConstructAt(m_entries_start[i].object); } } void AddObject(ObjectHolder &object) { /* Lock ourselves. */ std::scoped_lock lk(m_mutex); /* Find an empty entry. */ auto *entry = this->FindEntry(tipc::InvalidNativeHandle); AMS_ABORT_UNLESS(entry != nullptr); /* Set the entry's object. */ GetReference(entry->object) = object; /* Setup the entry's holder. */ os::InitializeMultiWaitHolder(std::addressof(entry->multi_wait_holder), object.GetHandle()); os::LinkMultiWaitHolder(m_multi_wait, std::addressof(entry->multi_wait_holder)); } void CloseObject(tipc::NativeHandle handle) { /* Lock ourselves. */ std::scoped_lock lk(m_mutex); /* Find the matching entry. */ auto *entry = this->FindEntry(handle); AMS_ABORT_UNLESS(entry != nullptr); /* Finalize the entry's holder. */ os::UnlinkMultiWaitHolder(std::addressof(entry->multi_wait_holder)); os::FinalizeMultiWaitHolder(std::addressof(entry->multi_wait_holder)); /* Destroy the object. */ GetReference(entry->object).Destroy(); } Result ReplyAndReceive(os::MultiWaitHolderType **out_holder, ObjectHolder *out_object, tipc::NativeHandle reply_target, os::MultiWaitType *multi_wait) { /* Declare signaled holder for processing ahead of time. */ os::MultiWaitHolderType *signaled_holder; /* Reply and receive until we get a newly signaled target. */ Result result = os::SdkReplyAndReceive(out_holder, reply_target, multi_wait); for (signaled_holder = *out_holder; signaled_holder == nullptr; signaled_holder = *out_holder) { result = os::SdkReplyAndReceive(out_holder, tipc::InvalidNativeHandle, multi_wait); } /* Find the entry matching the signaled holder. */ if (auto *entry = this->FindEntry(signaled_holder); entry != nullptr) { /* Get the output object. */ *out_object = GetReference(entry->object); *out_holder = nullptr; return result; } else { R_SUCCEED(); } } void Reply(tipc::NativeHandle reply_target) { return tipc::impl::Reply(reply_target); } Result ProcessRequest(ObjectHolder &object) { /* Get the message buffer. */ const MessageBuffer message_buffer(tipc::GetMessageBuffer()); /* Get the method id. */ const auto method_id = MessageBuffer::MessageHeader(message_buffer).GetTag(); /* Process for the method id. */ { /* Ensure that if we fail, we clean up any handles that get sent our way. */ ON_RESULT_FAILURE { const MessageBuffer::MessageHeader message_header(message_buffer); const MessageBuffer::SpecialHeader special_header(message_buffer, message_header); /* Determine the offset to the start of handles. */ auto offset = message_buffer.GetSpecialDataIndex(message_header, special_header); if (special_header.GetHasProcessId()) { offset += sizeof(u64) / sizeof(u32); } /* Close all copy handles. */ for (auto i = 0; i < special_header.GetCopyHandleCount(); ++i) { tipc::impl::CloseHandle(message_buffer.GetHandle(offset)); offset += sizeof(typename std::remove_reference::type) / sizeof(u32); } }; /* Check that the method id is valid. */ R_UNLESS(method_id != MethodId_Invalid, tipc::ResultInvalidMethod()); /* Process the request. */ if (method_id != MethodId_CloseSession) { /* Process the generic method for the object. */ R_TRY(object.GetObject()->ProcessRequest()); } else { /* Validate that the close request is of valid format. */ using CloseSessionCommandMeta = impl::CommandMetaInfo>; using CloseSessionProcessor = impl::CommandProcessor; R_TRY(CloseSessionProcessor::ValidateCommandFormat(message_buffer)); } } /* If we were asked to close the object, do so. */ if (method_id == MethodId_CloseSession) { /* Get the object handle. */ const auto handle = object.GetHandle(); /* Close the object itself. */ this->CloseObject(handle); /* Close the object's handle. */ /* NOTE: Nintendo does not check that this succeeds. */ R_ABORT_UNLESS(tipc::impl::CloseHandle(handle)); /* Return an error to signify we closed the object. */ R_THROW(tipc::ResultSessionClosed()); } /* We successfully processed, so we don't need to clean up handles. */ R_SUCCEED(); } }; template class ObjectManager : public ObjectManagerBase { private: Entry m_entries_storage[MaxObjects]{}; public: constexpr ObjectManager() = default; void Initialize(os::MultiWaitType *multi_wait) { this->InitializeImpl(multi_wait, m_entries_storage, MaxObjects); } }; }