aboutsummaryrefslogtreecommitdiff
path: root/src/core/hle
diff options
context:
space:
mode:
Diffstat (limited to 'src/core/hle')
-rw-r--r--src/core/hle/kernel/archive.cpp227
-rw-r--r--src/core/hle/kernel/archive.h24
-rw-r--r--src/core/hle/kernel/kernel.h1
-rw-r--r--src/core/hle/service/fs.cpp197
4 files changed, 429 insertions, 20 deletions
diff --git a/src/core/hle/kernel/archive.cpp b/src/core/hle/kernel/archive.cpp
index 20536f40f..a7fa661d6 100644
--- a/src/core/hle/kernel/archive.cpp
+++ b/src/core/hle/kernel/archive.cpp
@@ -3,9 +3,12 @@
// Refer to the license.txt file included.
#include "common/common_types.h"
+#include "common/file_util.h"
#include "common/math_util.h"
#include "core/file_sys/archive.h"
+#include "core/file_sys/archive_sdmc.h"
+#include "core/file_sys/directory.h"
#include "core/hle/service/service.h"
#include "core/hle/kernel/archive.h"
@@ -29,6 +32,14 @@ enum class FileCommand : u32 {
Flush = 0x08090000,
};
+// Command to access directory
+enum class DirectoryCommand : u32 {
+ Dummy1 = 0x000100C6,
+ Control = 0x040100C4,
+ Read = 0x08010042,
+ Close = 0x08020000,
+};
+
class Archive : public Object {
public:
std::string GetTypeName() const { return "Archive"; }
@@ -85,6 +96,13 @@ public:
backend->SetSize(cmd_buff[1] | ((u64)cmd_buff[2] << 32));
break;
}
+ case FileCommand::Close:
+ {
+ DEBUG_LOG(KERNEL, "Close %s %s", GetTypeName().c_str(), GetName().c_str());
+ Kernel::g_object_pool.Destroy<Archive>(GetHandle());
+ CloseArchive(backend->GetIdCode());
+ break;
+ }
// Unknown command...
default:
{
@@ -108,6 +126,153 @@ public:
}
};
+class File : public Object {
+public:
+ std::string GetTypeName() const { return "File"; }
+ std::string GetName() const { return path; }
+
+ static Kernel::HandleType GetStaticHandleType() { return HandleType::File; }
+ Kernel::HandleType GetHandleType() const { return HandleType::File; }
+
+ std::string path; ///< Path of the file
+ std::unique_ptr<FileSys::File> backend; ///< File backend interface
+
+ /**
+ * Synchronize kernel object
+ * @param wait Boolean wait set if current thread should wait as a result of sync operation
+ * @return Result of operation, 0 on success, otherwise error code
+ */
+ Result SyncRequest(bool* wait) {
+ u32* cmd_buff = Service::GetCommandBuffer();
+ FileCommand cmd = static_cast<FileCommand>(cmd_buff[0]);
+ switch (cmd) {
+
+ // Read from file...
+ case FileCommand::Read:
+ {
+ u64 offset = cmd_buff[1] | ((u64) cmd_buff[2]) << 32;
+ u32 length = cmd_buff[3];
+ u32 address = cmd_buff[5];
+ DEBUG_LOG(KERNEL, "Read %s %s: offset=0x%x length=%d address=0x%x",
+ GetTypeName().c_str(), GetName().c_str(), offset, length, address);
+ cmd_buff[2] = backend->Read(offset, length, Memory::GetPointer(address));
+ break;
+ }
+
+ // Write to file...
+ case FileCommand::Write:
+ {
+ u64 offset = cmd_buff[1] | ((u64) cmd_buff[2]) << 32;
+ u32 length = cmd_buff[3];
+ u32 flush = cmd_buff[4];
+ u32 address = cmd_buff[6];
+ DEBUG_LOG(KERNEL, "Write %s %s: offset=0x%x length=%d address=0x%x, flush=0x%x",
+ GetTypeName().c_str(), GetName().c_str(), offset, length, address, flush);
+ cmd_buff[2] = backend->Write(offset, length, flush, Memory::GetPointer(address));
+ break;
+ }
+
+ case FileCommand::GetSize:
+ {
+ DEBUG_LOG(KERNEL, "GetSize %s %s", GetTypeName().c_str(), GetName().c_str());
+ u64 size = backend->GetSize();
+ cmd_buff[2] = (u32)size;
+ cmd_buff[3] = size >> 32;
+ break;
+ }
+
+ case FileCommand::Close:
+ {
+ DEBUG_LOG(KERNEL, "Close %s %s", GetTypeName().c_str(), GetName().c_str());
+ Kernel::g_object_pool.Destroy<File>(GetHandle());
+ break;
+ }
+
+ // Unknown command...
+ default:
+ ERROR_LOG(KERNEL, "Unknown command=0x%08X!", cmd);
+ cmd_buff[1] = -1; // TODO(Link Mauve): use the correct error code for that.
+ return -1;
+ }
+ cmd_buff[1] = 0; // No error
+ return 0;
+ }
+
+ /**
+ * Wait for kernel object to synchronize
+ * @param wait Boolean wait set if current thread should wait as a result of sync operation
+ * @return Result of operation, 0 on success, otherwise error code
+ */
+ Result WaitSynchronization(bool* wait) {
+ // TODO(bunnei): ImplementMe
+ ERROR_LOG(OSHLE, "(UNIMPLEMENTED)");
+ return 0;
+ }
+};
+
+class Directory : public Object {
+public:
+ std::string GetTypeName() const { return "Directory"; }
+ std::string GetName() const { return path; }
+
+ static Kernel::HandleType GetStaticHandleType() { return HandleType::Directory; }
+ Kernel::HandleType GetHandleType() const { return HandleType::Directory; }
+
+ std::string path; ///< Path of the directory
+ std::unique_ptr<FileSys::Directory> backend; ///< File backend interface
+
+ /**
+ * Synchronize kernel object
+ * @param wait Boolean wait set if current thread should wait as a result of sync operation
+ * @return Result of operation, 0 on success, otherwise error code
+ */
+ Result SyncRequest(bool* wait) {
+ u32* cmd_buff = Service::GetCommandBuffer();
+ DirectoryCommand cmd = static_cast<DirectoryCommand>(cmd_buff[0]);
+ switch (cmd) {
+
+ // Read from directory...
+ case DirectoryCommand::Read:
+ {
+ u32 count = cmd_buff[1];
+ u32 address = cmd_buff[3];
+ FileSys::Entry* entries = reinterpret_cast<FileSys::Entry*>(Memory::GetPointer(address));
+ DEBUG_LOG(KERNEL, "Read %s %s: count=%d", GetTypeName().c_str(), GetName().c_str(), count);
+
+ // Number of entries actually read
+ cmd_buff[2] = backend->Read(count, entries);
+ break;
+ }
+
+ case DirectoryCommand::Close:
+ {
+ DEBUG_LOG(KERNEL, "Close %s %s", GetTypeName().c_str(), GetName().c_str());
+ Kernel::g_object_pool.Destroy<Directory>(GetHandle());
+ break;
+ }
+
+ // Unknown command...
+ default:
+ ERROR_LOG(KERNEL, "Unknown command=0x%08X!", cmd);
+ cmd_buff[1] = -1; // TODO(Link Mauve): use the correct error code for that.
+ return -1;
+ }
+ cmd_buff[1] = 0; // No error
+ return 0;
+ }
+
+ /**
+ * Wait for kernel object to synchronize
+ * @param wait Boolean wait set if current thread should wait as a result of sync operation
+ * @return Result of operation, 0 on success, otherwise error code
+ */
+ Result WaitSynchronization(bool* wait) {
+ // TODO(bunnei): ImplementMe
+ ERROR_LOG(OSHLE, "(UNIMPLEMENTED)");
+ return 0;
+ }
+};
+
////////////////////////////////////////////////////////////////////////////////////////////////////
std::map<FileSys::Archive::IdCode, Handle> g_archive_map; ///< Map of file archives by IdCode
@@ -126,6 +291,21 @@ Handle OpenArchive(FileSys::Archive::IdCode id_code) {
}
/**
+ * Closes an archive
+ * @param id_code IdCode of the archive to open
+ * @return Result of operation, 0 on success, otherwise error code
+ */
+Result CloseArchive(FileSys::Archive::IdCode id_code) {
+ if (1 != g_archive_map.erase(id_code)) {
+ ERROR_LOG(KERNEL, "Cannot close archive %d", (int) id_code);
+ return -1;
+ }
+
+ INFO_LOG(KERNEL, "Closed archive %d", (int) id_code);
+ return 0;
+}
+
+/**
* Mounts an archive
* @param archive Pointer to the archive to mount
* @return Result of operation, 0 on success, otherwise error code
@@ -171,9 +351,56 @@ Handle CreateArchive(FileSys::Archive* backend, const std::string& name) {
return handle;
}
+/**
+ * Open a File from an Archive
+ * @param archive_handle Handle to an open Archive object
+ * @param path Path to the File inside of the Archive
+ * @param mode Mode under which to open the File
+ * @return Opened File object
+ */
+Handle OpenFileFromArchive(Handle archive_handle, const std::string& path, const FileSys::Mode mode) {
+ File* file = new File;
+ Handle handle = Kernel::g_object_pool.Create(file);
+
+ Archive* archive = Kernel::g_object_pool.GetFast<Archive>(archive_handle);
+ file->path = path;
+ file->backend = archive->backend->OpenFile(path, mode);
+
+ return handle;
+}
+
+/**
+ * Open a Directory from an Archive
+ * @param archive_handle Handle to an open Archive object
+ * @param path Path to the Directory inside of the Archive
+ * @return Opened Directory object
+ */
+Handle OpenDirectoryFromArchive(Handle archive_handle, const std::string& path) {
+ Directory* directory = new Directory;
+ Handle handle = Kernel::g_object_pool.Create(directory);
+
+ Archive* archive = Kernel::g_object_pool.GetFast<Archive>(archive_handle);
+ directory->path = path;
+ directory->backend = archive->backend->OpenDirectory(path);
+
+ return handle;
+}
+
/// Initialize archives
void ArchiveInit() {
g_archive_map.clear();
+
+ // TODO(Link Mauve): Add the other archive types (see here for the known types:
+ // http://3dbrew.org/wiki/FS:OpenArchive#Archive_idcodes). Currently the only half-finished
+ // archive type is SDMC, so it is the only one getting exposed.
+
+ // TODO(Link Mauve): don't assume the path separator is '/'.
+ std::string sdmc_directory = FileUtil::GetCurrentDir() + "/userdata/sdmc";
+ auto archive = new FileSys::Archive_SDMC(sdmc_directory);
+ if (archive->Initialize())
+ CreateArchive(archive, "SDMC");
+ else
+ ERROR_LOG(KERNEL, "Can't instantiate SDMC archive with path %s", sdmc_directory.c_str());
}
/// Shutdown archives
diff --git a/src/core/hle/kernel/archive.h b/src/core/hle/kernel/archive.h
index 3758e7061..593861f8e 100644
--- a/src/core/hle/kernel/archive.h
+++ b/src/core/hle/kernel/archive.h
@@ -22,6 +22,13 @@ namespace Kernel {
Handle OpenArchive(FileSys::Archive::IdCode id_code);
/**
+ * Closes an archive
+ * @param id_code IdCode of the archive to open
+ * @return true if it worked fine
+ */
+Result CloseArchive(FileSys::Archive::IdCode id_code);
+
+/**
* Creates an Archive
* @param backend File system backend interface to the archive
* @param name Optional name of Archive
@@ -29,6 +36,23 @@ Handle OpenArchive(FileSys::Archive::IdCode id_code);
*/
Handle CreateArchive(FileSys::Archive* backend, const std::string& name);
+/**
+ * Open a File from an Archive
+ * @param archive_handle Handle to an open Archive object
+ * @param path Path to the File inside of the Archive
+ * @param mode Mode under which to open the File
+ * @return Opened File object
+ */
+Handle OpenFileFromArchive(Handle handle, const std::string& name, const FileSys::Mode mode);
+
+/**
+ * Open a Directory from an Archive
+ * @param archive_handle Handle to an open Archive object
+ * @param path Path to the Directory inside of the Archive
+ * @return Opened Directory object
+ */
+Handle OpenDirectoryFromArchive(Handle handle, const std::string& name);
+
/// Initialize archives
void ArchiveInit();
diff --git a/src/core/hle/kernel/kernel.h b/src/core/hle/kernel/kernel.h
index 0e7e5ff68..867d1b89c 100644
--- a/src/core/hle/kernel/kernel.h
+++ b/src/core/hle/kernel/kernel.h
@@ -32,6 +32,7 @@ enum class HandleType : u32 {
File = 10,
Semaphore = 11,
Archive = 12,
+ Directory = 13,
};
enum {
diff --git a/src/core/hle/service/fs.cpp b/src/core/hle/service/fs.cpp
index 9e1998b0f..8469d9840 100644
--- a/src/core/hle/service/fs.cpp
+++ b/src/core/hle/service/fs.cpp
@@ -12,35 +12,192 @@
namespace FS_User {
+// Command to access archive file
+enum class LowPathType : u32 {
+ Invalid = 0,
+ Empty = 1,
+ Binary = 2,
+ Char = 3,
+ Wchar = 4
+};
+
+std::string GetStringFromCmdBuff(const u32 pointer, const u32 size) {
+ auto data = reinterpret_cast<const char*>(Memory::GetPointer(pointer));
+ return std::string(data, size - 1);
+}
+
+// We currently return 0 for success and -1 for failure in cmd_buff[1]. -1 was chosen because it
+// puts all the sections of the http://3dbrew.org/wiki/Error_codes to something non-zero, to make
+// sure we don't mislead the application into thinking something worked.
+
void Initialize(Service::Interface* self) {
u32* cmd_buff = Service::GetCommandBuffer();
- cmd_buff[1] = 0; // No error
+
+ // TODO(Link Mauve): check the behavior when cmd_buff[1] isn't 32, as per
+ // http://3dbrew.org/wiki/FS:Initialize#Request
+ cmd_buff[1] = 0;
+
+ DEBUG_LOG(KERNEL, "called");
+}
+
+void OpenFile(Service::Interface* self) {
+ u32* cmd_buff = Service::GetCommandBuffer();
+
+ u32 transaction = cmd_buff[1];
+ // TODO(Link Mauve): cmd_buff[2], aka archive handle lower word, isn't used according to
+ // 3dmoo's or ctrulib's implementations. Triple check if it's really the case.
+ Handle archive_handle = static_cast<Handle>(cmd_buff[3]);
+ LowPathType type = static_cast<LowPathType>(cmd_buff[4]);
+ u32 size = cmd_buff[5];
+ FileSys::Mode mode; mode.hex = cmd_buff[6];
+ u32 attributes = cmd_buff[7]; // TODO(Link Mauve): do something with those attributes.
+ u32 pointer = cmd_buff[9];
+
+ if (type != LowPathType::Char) {
+ ERROR_LOG(KERNEL, "file LowPath type other than char is currently unsupported");
+ cmd_buff[1] = -1;
+ return;
+ }
+
+ std::string file_name = GetStringFromCmdBuff(pointer, size);
+
+ DEBUG_LOG(KERNEL, "type=%d size=%d mode=%d attrs=%d data=%s", type, size, mode, attributes, file_name.c_str());
+
+ Handle handle = Kernel::OpenFileFromArchive(archive_handle, file_name, mode);
+ if (handle) {
+ cmd_buff[1] = 0;
+ cmd_buff[3] = handle;
+ } else {
+ ERROR_LOG(KERNEL, "failed to get a handle for file %s", file_name.c_str());
+ // TODO(Link Mauve): check for the actual error values, this one was just chosen arbitrarily.
+ cmd_buff[1] = -1;
+ }
+
DEBUG_LOG(KERNEL, "called");
}
void OpenFileDirectly(Service::Interface* self) {
u32* cmd_buff = Service::GetCommandBuffer();
- FileSys::Archive::IdCode arch_id = static_cast<FileSys::Archive::IdCode>(cmd_buff[2]);
-
- // TODO(bunnei): Properly implement use of these...
- //u32 transaction = cmd_buff[1];
- //u32 arch_lowpath_type = cmd_buff[3];
- //u32 arch_lowpath_sz = cmd_buff[4];
- //u32 file_lowpath_type = cmd_buff[5];
- //u32 file_lowpath_sz = cmd_buff[6];
- //u32 flags = cmd_buff[7];
- //u32 attr = cmd_buff[8];
- //u32 arch_lowpath_desc = cmd_buff[9];
- //u32 arch_lowpath_ptr = cmd_buff[10];
- //u32 file_lowpath_desc = cmd_buff[11];
- //u32 file_lowpath_ptr = cmd_buff[12];
+ u32 transaction = cmd_buff[1];
+ auto archive_id = static_cast<FileSys::Archive::IdCode>(cmd_buff[2]);
+ LowPathType archive_type = static_cast<LowPathType>(cmd_buff[3]);
+ u32 archive_size = cmd_buff[4];
+ LowPathType type = static_cast<LowPathType>(cmd_buff[5]);
+ u32 size = cmd_buff[6];
+ FileSys::Mode mode; mode.hex = cmd_buff[7];
+ u32 attributes = cmd_buff[8]; // TODO(Link Mauve): do something with those attributes.
+ u32 archive_pointer = cmd_buff[10];
+ u32 pointer = cmd_buff[12];
+
+ if (archive_type != LowPathType::Empty) {
+ ERROR_LOG(KERNEL, "archive LowPath type other than empty is currently unsupported");
+ cmd_buff[1] = -1;
+ return;
+ }
+
+ if (type != LowPathType::Char) {
+ ERROR_LOG(KERNEL, "file LowPath type other than char is currently unsupported");
+ cmd_buff[1] = -1;
+ return;
+ }
+
+ std::string archive_name = GetStringFromCmdBuff(archive_pointer, archive_size);
+ std::string file_name = GetStringFromCmdBuff(pointer, size);
+
+ DEBUG_LOG(KERNEL, "archive_type=%d archive_size=%d archive_data=%s"
+ "file_type=%d file_size=%d file_mode=%d file_attrs=%d file_data=%s",
+ archive_type, archive_size, archive_name.c_str(),
+ type, size, mode, attributes, file_name.c_str());
+
+ // TODO(Link Mauve): check if we should even get a handle for the archive, and don't leak it.
+ Handle archive_handle = Kernel::OpenArchive(archive_id);
+ if (archive_handle) {
+ cmd_buff[1] = 0;
+ // cmd_buff[2] isn't used according to 3dmoo's implementation.
+ cmd_buff[3] = archive_handle;
+ } else {
+ ERROR_LOG(KERNEL, "failed to get a handle for archive %s", archive_name.c_str());
+ // TODO(Link Mauve): check for the actual error values, this one was just chosen arbitrarily.
+ cmd_buff[1] = -1;
+ return;
+ }
+
+ Handle handle = Kernel::OpenFileFromArchive(archive_handle, file_name, mode);
+ if (handle) {
+ cmd_buff[1] = 0;
+ cmd_buff[3] = handle;
+ } else {
+ ERROR_LOG(KERNEL, "failed to get a handle for file %s", file_name.c_str());
+ // TODO(Link Mauve): check for the actual error values, this one was just chosen arbitrarily.
+ cmd_buff[1] = -1;
+ }
+
+ DEBUG_LOG(KERNEL, "called");
+}
+
+void OpenDirectory(Service::Interface* self) {
+ u32* cmd_buff = Service::GetCommandBuffer();
+
+ // TODO(Link Mauve): cmd_buff[2], aka archive handle lower word, isn't used according to
+ // 3dmoo's or ctrulib's implementations. Triple check if it's really the case.
+ Handle archive_handle = static_cast<Handle>(cmd_buff[2]);
+ LowPathType type = static_cast<LowPathType>(cmd_buff[3]);
+ u32 size = cmd_buff[4];
+ u32 pointer = cmd_buff[6];
+
+ if (type != LowPathType::Char) {
+ ERROR_LOG(KERNEL, "directory LowPath type other than char is currently unsupported");
+ cmd_buff[1] = -1;
+ return;
+ }
+
+ std::string dir_name = GetStringFromCmdBuff(pointer, size);
+
+ DEBUG_LOG(KERNEL, "type=%d size=%d data=%s", type, size, dir_name.c_str());
+
+ Handle handle = Kernel::OpenDirectoryFromArchive(archive_handle, dir_name);
+ if (handle) {
+ cmd_buff[1] = 0;
+ cmd_buff[3] = handle;
+ } else {
+ ERROR_LOG(KERNEL, "failed to get a handle for directory %s", dir_name.c_str());
+ // TODO(Link Mauve): check for the actual error values, this one was just chosen arbitrarily.
+ cmd_buff[1] = -1;
+ }
+
+ DEBUG_LOG(KERNEL, "called");
+}
+
+void OpenArchive(Service::Interface* self) {
+ u32* cmd_buff = Service::GetCommandBuffer();
+
+ auto arch_id = static_cast<FileSys::Archive::IdCode>(cmd_buff[1]);
+ LowPathType type = static_cast<LowPathType>(cmd_buff[2]);
+ u32 size = cmd_buff[3];
+ u32 pointer = cmd_buff[5];
+
+ if (type != LowPathType::Empty) {
+ ERROR_LOG(KERNEL, "archive LowPath type other than empty is currently unsupported");
+ cmd_buff[1] = -1;
+ return;
+ }
+
+ std::string archive_name = GetStringFromCmdBuff(pointer, size);
+
+ DEBUG_LOG(KERNEL, "type=%d size=%d data=%s", type, size, archive_name.c_str());
Handle handle = Kernel::OpenArchive(arch_id);
- if (0 != handle) {
- cmd_buff[1] = 0; // No error
+ if (handle) {
+ cmd_buff[1] = 0;
+ // cmd_buff[2] isn't used according to 3dmoo's implementation.
cmd_buff[3] = handle;
+ } else {
+ ERROR_LOG(KERNEL, "failed to get a handle for archive %s", archive_name.c_str());
+ // TODO(Link Mauve): check for the actual error values, this one was just chosen arbitrarily.
+ cmd_buff[1] = -1;
}
+
DEBUG_LOG(KERNEL, "called");
}
@@ -48,7 +205,7 @@ const Interface::FunctionInfo FunctionTable[] = {
{0x000100C6, nullptr, "Dummy1"},
{0x040100C4, nullptr, "Control"},
{0x08010002, Initialize, "Initialize"},
- {0x080201C2, nullptr, "OpenFile"},
+ {0x080201C2, OpenFile, "OpenFile"},
{0x08030204, OpenFileDirectly, "OpenFileDirectly"},
{0x08040142, nullptr, "DeleteFile"},
{0x08050244, nullptr, "RenameFile"},
@@ -57,8 +214,8 @@ const Interface::FunctionInfo FunctionTable[] = {
{0x08080202, nullptr, "CreateFile"},
{0x08090182, nullptr, "CreateDirectory"},
{0x080A0244, nullptr, "RenameDirectory"},
- {0x080B0102, nullptr, "OpenDirectory"},
- {0x080C00C2, nullptr, "OpenArchive"},
+ {0x080B0102, OpenDirectory, "OpenDirectory"},
+ {0x080C00C2, OpenArchive, "OpenArchive"},
{0x080D0144, nullptr, "ControlArchive"},
{0x080E0080, nullptr, "CloseArchive"},
{0x080F0180, nullptr, "FormatThisUserSaveData"},
generated by cgit v1.2.3 (git 2.25.1) at 2026-01-03 12:20:59 +0000