troposphere: add haze MTP server (#2095)

* troposphere: add haze MTP server * haze: adjust banner, new lines between class sections, single-statement if * haze: remove additional newlines between sections * haze: avoid use of reference out parameter * haze: console_main_loop: style * haze: event_reactor, file_system_proxy, ptp: style * haze: ptp_data_builder, ptp_object_database, ptp_object_heap, results, usb_session: style * haze: event_reactor, ptp_data_parser, async_usb_server, ptp_object_database, ptp_object_heap: style * haze: ptp_responder: style * haze: usb_session: style * haze: use svc defs from vapours * haze: misc comments * haze: fix pointer overflow check * haze: fix copy paste error * haze: use alignment, invalidate cached use values in console * haze: fix stray hex constant * haze: misc style * haze: fixes for windows * haze: add GetObjectPropsSupported, GetObjectPropDesc, GetObjectPropValue * haze: add SetObjectPropValue * haze: improve object database API * haze: improve WriteVariableLengthData readability * haze: fix directory renames on windows * haze: ptp_object_database: fix collation * haze: event_reactor: fix size validation * haze: ptp_responder: improve documentation * haze: ptp_responder: avoid unnecessary fs interaction in GetObjectPropValue * haze: ptp_responder: fix object deletion on windows * haze: tear down sessions on suspension * haze: prefer more specific data types * haze: misc * haze: fix usb 3.0 support * haze: improve host-to-device file transfer performance * haze: report device serial * haze: move static_assert to requires, fix alignment
2023-04-17 17:08:05 -04:00
parent e9b28ab4b1
commit 3b662122f9
26 changed files with 3674 additions and 1 deletions
--- a/troposphere/haze/include/haze/ptp_object_database.hpp
+++ b/troposphere/haze/include/haze/ptp_object_database.hpp
@@ -0,0 +1,107 @@
+/*
+ * 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 <http://www.gnu.org/licenses/>.
+ */
+#pragma once
+
+#include <haze/common.hpp>
+#include <haze/ptp_object_heap.hpp>
+#include <vapours/util.hpp>
+
+namespace haze {
+
+    struct PtpObject {
+        public:
+            util::IntrusiveRedBlackTreeNode m_name_node;
+            util::IntrusiveRedBlackTreeNode m_object_id_node;
+            u32 m_parent_id;
+            u32 m_object_id;
+            char m_name[];
+        public:
+            const char *GetName()  const { return m_name; }
+            u32 GetParentId()      const { return m_parent_id; }
+            u32 GetObjectId()      const { return m_object_id; }
+        public:
+            bool GetIsRegistered() const { return m_object_id != 0; }
+            void Register(u32 object_id) { m_object_id = object_id; }
+            void Unregister()            { m_object_id = 0; }
+        public:
+            struct NameComparator {
+                struct RedBlackKeyType {
+                    const char *m_name;
+
+                    constexpr RedBlackKeyType(const char *name) : m_name(name) { /* ... */ }
+
+                    constexpr const char *GetName() const {
+                        return m_name;
+                    }
+                };
+
+                template<typename T> requires (std::same_as<T, PtpObject> || std::same_as<T, RedBlackKeyType>)
+                static constexpr int Compare(const T &lhs, const PtpObject &rhs) {
+                    /* All SD card filesystems supported by fs are case-insensitive and case-preserving. */
+                    /* Account for that in collation here. */
+                    return strcasecmp(lhs.GetName(), rhs.GetName());
+                }
+            };
+
+            struct ObjectIdComparator {
+                struct RedBlackKeyType {
+                    u32 m_object_id;
+
+                    constexpr RedBlackKeyType(u32 object_id) : m_object_id(object_id) { /* ... */ }
+
+                    constexpr u32 GetObjectId() const {
+                        return m_object_id;
+                    }
+                };
+
+                template<typename T> requires (std::same_as<T, PtpObject> || std::same_as<T, RedBlackKeyType>)
+                static constexpr int Compare(const T &lhs, const PtpObject &rhs) {
+                    return lhs.GetObjectId() - rhs.GetObjectId();
+                }
+            };
+    };
+
+    class PtpObjectDatabase {
+        private:
+            using ObjectNameTreeTraits = util::IntrusiveRedBlackTreeMemberTraitsDeferredAssert<&PtpObject::m_name_node>;
+            using ObjectNameTree       = ObjectNameTreeTraits::TreeType<PtpObject::NameComparator>;
+
+            using ObjectIdTreeTraits   = util::IntrusiveRedBlackTreeMemberTraitsDeferredAssert<&PtpObject::m_object_id_node>;
+            using ObjectIdTree         = ObjectIdTreeTraits::TreeType<PtpObject::ObjectIdComparator>;
+
+            PtpObjectHeap *m_object_heap;
+            ObjectNameTree m_name_tree;
+            ObjectIdTree m_object_id_tree;
+            u32 m_next_object_id;
+        public:
+            constexpr explicit PtpObjectDatabase() : m_object_heap(), m_name_tree(), m_object_id_tree(), m_next_object_id() { /* ... */ }
+
+            void Initialize(PtpObjectHeap *object_heap);
+            void Finalize();
+        public:
+            /* Object database API. */
+            Result CreateOrFindObject(const char *parent_name, const char *name, u32 parent_id, PtpObject **out_object);
+            void RegisterObject(PtpObject *object, u32 desired_id = 0);
+            void UnregisterObject(PtpObject *object);
+            void DeleteObject(PtpObject *obj);
+
+            Result CreateAndRegisterObjectId(const char *parent_name, const char *name, u32 parent_id, u32 *out_object_id);
+        public:
+            PtpObject *GetObjectById(u32 object_id);
+            PtpObject *GetObjectByName(const char *name);
+    };
+
+}