ShuriZma
/
xenia-canary
mirror of https://github.com/xenia-canary/xenia-canary.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[Kernel/VFS] Split code into StfsContentPackage / FolderContentPackage classes

This commit is contained in:
emoose 2019-07-23 17:36:32 +01:00
parent ab9dab806d
commit 54f9ce14c4
No known key found for this signature in database
GPG Key ID: 3735C67912F5FF97
5 changed files with 378 additions and 128 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

196
src/xenia/kernel/xam/content_manager.cc
View File

@ -14,6 +14,7 @@
#include "xenia/base/filesystem.h"
#include "xenia/base/string.h"
#include "xenia/kernel/kernel_state.h"
#include "xenia/kernel/xam/content_package.h"
#include "xenia/kernel/xobject.h"
#include "xenia/vfs/devices/host_path_device.h"
#include "xenia/vfs/devices/stfs_container_device.h"
@ -22,44 +23,10 @@ namespace xe {
namespace kernel {
namespace xam {
static const wchar_t* kThumbnailFileName = L"__thumbnail.png";
constexpr const wchar_t* const ContentManager::kStfsHeadersExtension;
static const wchar_t* kGameUserContentDirName = L"profile";
static int content_device_id_ = 0;
ContentPackage::ContentPackage(KernelState* kernel_state, std::string root_name,
const XCONTENT_DATA& data,
std::wstring package_path)
: kernel_state_(kernel_state), root_name_(std::move(root_name)) {
device_path_ = std::string("\\Device\\Content\\") +
std::to_string(++content_device_id_) + "\\";
auto fs = kernel_state_->file_system();
std::unique_ptr<vfs::Device> device;
// If this isn't a folder try mounting as STFS package
// Otherwise mount as a local host path
if (!filesystem::IsFolder(package_path) &&
filesystem::PathExists(package_path)) {
device =
std::make_unique<vfs::StfsContainerDevice>(device_path_, package_path);
} else {
device = std::make_unique<vfs::HostPathDevice>(device_path_, package_path,
false);
}
device->Initialize();
fs->RegisterDevice(std::move(device));
fs->RegisterSymbolicLink(root_name_ + ":", device_path_);
}
ContentPackage::~ContentPackage() {
auto fs = kernel_state_->file_system();
fs->UnregisterSymbolicLink(root_name_ + ":");
fs->UnregisterDevice(device_path_);
}
ContentManager::ContentManager(KernelState* kernel_state,
std::wstring root_path)
: kernel_state_(kernel_state), root_path_(std::move(root_path)) {}
@ -106,12 +73,6 @@ std::wstring ContentManager::ResolvePackagePath(const XCONTENT_DATA& data) {
auto package_root = ResolvePackageRoot(data.content_type);
auto package_path =
xe::join_paths(package_root, xe::to_wstring(data.file_name));
// Add slash to end of path if this is a folder
// (or package doesn't exist, meaning we're creating a new folder)
if (xe::filesystem::IsFolder(package_path) ||
!xe::filesystem::PathExists(package_path)) {
package_path += xe::kPathSeparator;
}
return package_path;
}
@ -119,6 +80,9 @@ std::vector<XCONTENT_DATA> ContentManager::ListContent(uint32_t device_id,
uint32_t content_type) {
std::vector<XCONTENT_DATA> result;
// StfsHeader is a huge class - alloc on heap instead of stack
vfs::StfsHeader* header = new vfs::StfsHeader();
// Search path:
// content_root/title_id/type_name/*
auto package_root = ResolvePackageRoot(content_type);
@ -132,7 +96,7 @@ std::vector<XCONTENT_DATA> ContentManager::ListContent(uint32_t device_id,
auto headers_path = file_info.path + file_info.name;
if (file_info.type == xe::filesystem::FileInfo::Type::kDirectory) {
headers_path = headers_path + L".headers";
headers_path = headers_path + ContentManager::kStfsHeadersExtension;
}
if (xe::filesystem::PathExists(headers_path)) {
@ -141,20 +105,20 @@ std::vector<XCONTENT_DATA> ContentManager::ListContent(uint32_t device_id,
if (file_info.type != xe::filesystem::FileInfo::Type::kDirectory) {
// Not a directory so must be a package, verify size to make sure
if (file_info.total_size <= vfs::StfsHeader::kHeaderLength) {
continue; // Invalid package (maybe .headers file)
continue; // Invalid package (maybe .headers.bin)
}
}
auto map = MappedMemory::Open(headers_path, MappedMemory::Mode::kRead, 0,
vfs::StfsHeader::kHeaderLength);
if (map) {
vfs::StfsHeader header;
header.Read(map->data());
content_data.content_type = static_cast<uint32_t>(header.content_type);
content_data.display_name = header.display_names;
// TODO: select localized display name
// some games may expect different ones depending on language setting.
if (header->Read(map->data())) {
content_data.content_type =
static_cast<uint32_t>(header->content_type);
content_data.display_name = header->display_names;
// TODO: select localized display name
// some games may expect different ones depending on language setting.
}
map->Close();
}
}
@ -162,11 +126,12 @@ std::vector<XCONTENT_DATA> ContentManager::ListContent(uint32_t device_id,
result.emplace_back(std::move(content_data));
}
delete header;
return result;
}
std::unique_ptr<ContentPackage> ContentManager::ResolvePackage(
std::string root_name, const XCONTENT_DATA& data) {
ContentPackage* ContentManager::ResolvePackage(const XCONTENT_DATA& data) {
auto package_path = ResolvePackagePath(data);
if (!xe::filesystem::PathExists(package_path)) {
return nullptr;
@ -174,9 +139,25 @@ std::unique_ptr<ContentPackage> ContentManager::ResolvePackage(
auto global_lock = global_critical_region_.Acquire();
auto package = std::make_unique<ContentPackage>(kernel_state_, root_name,
data, package_path);
return package;
for (auto package : open_packages_) {
if (package->package_path() == package_path) {
return package;
}
}
std::unique_ptr<ContentPackage> package;
// Open as FolderContentPackage if the package is a folder or doesn't exist
if (xe::filesystem::IsFolder(package_path) ||
!xe::filesystem::PathExists(package_path)) {
package = std::make_unique<FolderContentPackage>(kernel_state_, data,
package_path);
} else {
package =
std::make_unique<StfsContentPackage>(kernel_state_, data, package_path);
}
return package.release();
}
bool ContentManager::ContentExists(const XCONTENT_DATA& data) {
@ -188,25 +169,32 @@ X_RESULT ContentManager::CreateContent(std::string root_name,
const XCONTENT_DATA& data) {
auto global_lock = global_critical_region_.Acquire();
if (open_packages_.count(root_name)) {
// Already content open with this root name.
return X_ERROR_ALREADY_EXISTS;
}
auto package_path = ResolvePackagePath(data);
if (xe::filesystem::PathExists(package_path)) {
// Exists, must not!
return X_ERROR_ALREADY_EXISTS;
}
for (auto package : open_packages_) {
if (package->package_path() == package_path) {
return X_ERROR_ALREADY_EXISTS;
}
}
if (!xe::filesystem::CreateFolder(package_path)) {
return X_ERROR_ACCESS_DENIED;
}
auto package = ResolvePackage(root_name, data);
assert_not_null(package);
auto package = ResolvePackage(data);
if (!package) {
return X_ERROR_FUNCTION_FAILED; // Failed to create directory?
}
open_packages_.insert({root_name, package.release()});
if (!package->Mount(root_name)) {
return X_ERROR_DEVICE_NOT_CONNECTED;
}
open_packages_.push_back(package);
return X_ERROR_SUCCESS;
}
@ -215,22 +203,16 @@ X_RESULT ContentManager::OpenContent(std::string root_name,
const XCONTENT_DATA& data) {
auto global_lock = global_critical_region_.Acquire();
if (open_packages_.count(root_name)) {
// Already content open with this root name.
return X_ERROR_ALREADY_EXISTS;
}
auto package_path = ResolvePackagePath(data);
if (!xe::filesystem::PathExists(package_path)) {
// Does not exist, must be created.
auto package = ResolvePackage(data);
if (!package) {
return X_ERROR_FILE_NOT_FOUND;
}
// Open package.
auto package = ResolvePackage(root_name, data);
assert_not_null(package);
if (!package->Mount(root_name)) {
return X_ERROR_DEVICE_NOT_CONNECTED;
}
open_packages_.insert({root_name, package.release()});
open_packages_.push_back(package);
return X_ERROR_SUCCESS;
}
@ -238,67 +220,55 @@ X_RESULT ContentManager::OpenContent(std::string root_name,
X_RESULT ContentManager::CloseContent(std::string root_name) {
auto global_lock = global_critical_region_.Acquire();
auto it = open_packages_.find(root_name);
if (it == open_packages_.end()) {
return X_ERROR_FILE_NOT_FOUND;
for (auto it = open_packages_.begin(); it != open_packages_.end(); ++it) {
auto& root_names = (*it)->root_names();
auto root = std::find(root_names.begin(), root_names.end(), root_name);
if (root != root_names.end()) {
if ((*it)->Unmount(root_name)) {
delete *it;
open_packages_.erase(it);
}
return X_ERROR_SUCCESS;
}
}
auto package = it->second;
open_packages_.erase(it);
delete package;
return X_ERROR_SUCCESS;
return X_ERROR_FILE_NOT_FOUND;
}
X_RESULT ContentManager::GetContentThumbnail(const XCONTENT_DATA& data,
std::vector<uint8_t>* buffer) {
auto global_lock = global_critical_region_.Acquire();
auto package_path = ResolvePackagePath(data);
auto thumb_path = xe::join_paths(package_path, kThumbnailFileName);
if (xe::filesystem::PathExists(thumb_path)) {
auto file = xe::filesystem::OpenFile(thumb_path, "rb");
fseek(file, 0, SEEK_END);
size_t file_len = ftell(file);
fseek(file, 0, SEEK_SET);
buffer->resize(file_len);
fread(const_cast<uint8_t*>(buffer->data()), 1, buffer->size(), file);
fclose(file);
return X_ERROR_SUCCESS;
} else {
auto package = ResolvePackage(data);
if (!package) {
return X_ERROR_FILE_NOT_FOUND;
}
return package->GetThumbnail(buffer);
}
X_RESULT ContentManager::SetContentThumbnail(const XCONTENT_DATA& data,
std::vector<uint8_t> buffer) {
auto global_lock = global_critical_region_.Acquire();
auto package_path = ResolvePackagePath(data);
xe::filesystem::CreateFolder(package_path);
if (xe::filesystem::PathExists(package_path)) {
auto thumb_path = xe::join_paths(package_path, kThumbnailFileName);
auto file = xe::filesystem::OpenFile(thumb_path, "wb");
fwrite(buffer.data(), 1, buffer.size(), file);
fclose(file);
return X_ERROR_SUCCESS;
} else {
auto package = ResolvePackage(data);
if (!package) {
return X_ERROR_FILE_NOT_FOUND;
}
return package->SetThumbnail(buffer);
}
X_RESULT ContentManager::DeleteContent(const XCONTENT_DATA& data) {
auto global_lock = global_critical_region_.Acquire();
auto package_path = ResolvePackagePath(data);
if (xe::filesystem::PathExists(package_path)) {
if (xe::filesystem::IsFolder(package_path)) {
xe::filesystem::DeleteFolder(package_path);
} else {
xe::filesystem::DeleteFile(package_path);
}
return X_ERROR_SUCCESS;
} else {
auto package = ResolvePackage(data);
if (!package) {
return X_ERROR_FILE_NOT_FOUND;
}
return package->Delete();
}
std::wstring ContentManager::ResolveGameUserContentPath() {

22
src/xenia/kernel/xam/content_manager.h
View File

@ -29,6 +29,8 @@ namespace xe {
namespace kernel {
namespace xam {
class ContentPackage;
struct XCONTENT_DATA {
static const size_t kSize = 4 + 4 + 128 * 2 + 42 + 2; // = 306 + 2b padding
uint32_t device_id;
@ -52,28 +54,18 @@ struct XCONTENT_DATA {
}
};
class ContentPackage {
public:
ContentPackage(KernelState* kernel_state, std::string root_name,
const XCONTENT_DATA& data, std::wstring package_path);
~ContentPackage();
private:
KernelState* kernel_state_;
std::string root_name_;
std::string device_path_;
};
class ContentManager {
public:
// Extension to append to folder path when searching for STFS headers
static constexpr const wchar_t* const kStfsHeadersExtension = L".headers.bin";
ContentManager(KernelState* kernel_state, std::wstring root_path);
~ContentManager();
std::vector<XCONTENT_DATA> ListContent(uint32_t device_id,
uint32_t content_type);
std::unique_ptr<ContentPackage> ResolvePackage(std::string root_name,
const XCONTENT_DATA& data);
ContentPackage* ResolvePackage(const XCONTENT_DATA& data);
bool ContentExists(const XCONTENT_DATA& data);
X_RESULT CreateContent(std::string root_name, const XCONTENT_DATA& data);
@ -95,7 +87,7 @@ class ContentManager {
// TODO(benvanik): remove use of global lock, it's bad here!
xe::global_critical_region global_critical_region_;
std::unordered_map<std::string, ContentPackage*> open_packages_;
std::vector<ContentPackage*> open_packages_;
};
} // namespace xam

183
src/xenia/kernel/xam/content_package.cc Normal file
View File

@ -0,0 +1,183 @@
/**
******************************************************************************
* Xenia : Xbox 360 Emulator Research Project *
******************************************************************************
* Copyright 2015 Ben Vanik. All rights reserved. *
* Released under the BSD license - see LICENSE in the root for more details. *
******************************************************************************
*/
#include "xenia/kernel/xam/content_package.h"
#include <string>
#include "xenia/base/filesystem.h"
#include "xenia/base/string.h"
#include "xenia/kernel/kernel_state.h"
#include "xenia/kernel/xobject.h"
#include "xenia/vfs/devices/host_path_device.h"
#include "xenia/vfs/devices/stfs_container_device.h"
namespace xe {
namespace kernel {
namespace xam {
static const wchar_t* kThumbnailFileName = L"__thumbnail.png";
static int content_device_id_ = 0;
ContentPackage::ContentPackage(KernelState* kernel_state,
const XCONTENT_DATA& data,
std::wstring package_path)
: kernel_state_(kernel_state), package_path_(std::move(package_path)) {
device_path_ = std::string("\\Device\\Content\\") +
std::to_string(++content_device_id_) + "\\";
}
ContentPackage::~ContentPackage() { Unmount(); }
bool ContentPackage::Mount(std::string root_name,
std::unique_ptr<vfs::Device> device) {
auto fs = kernel_state_->file_system();
if (device) {
if (!fs->RegisterDevice(std::move(device))) {
return false;
}
}
if (!fs->RegisterSymbolicLink(root_name + ":", device_path_)) {
return false;
}
root_names_.push_back(root_name);
return true;
}
bool ContentPackage::Unmount() {
auto fs = kernel_state_->file_system();
for (auto root_name : root_names_) {
fs->UnregisterSymbolicLink(root_name + ":");
}
root_names_.clear();
fs->UnregisterDevice(device_path_);
device_inited_ = false;
return true;
}
bool ContentPackage::Unmount(std::string root_name) {
auto itr = std::find(root_names_.begin(), root_names_.end(), root_name);
if (itr != root_names_.end()) {
root_names_.erase(itr);
kernel_state_->file_system()->UnregisterSymbolicLink(root_name + ":");
}
// Do a complete device unmount if no root names are left
if (!root_names_.size()) {
return Unmount();
}
return false; // still mounted under a different root_name, so return false
}
bool FolderContentPackage::Mount(std::string root_name) {
std::unique_ptr<vfs::HostPathDevice> device = nullptr;
if (!device_inited_) {
device = std::make_unique<vfs::HostPathDevice>(device_path_, package_path_,
false);
if (!device->Initialize()) {
return false;
}
device_inited_ = true;
}
return ContentPackage::Mount(root_name, std::move(device));
}
X_RESULT FolderContentPackage::GetThumbnail(std::vector<uint8_t>* buffer) {
// TODO: grab thumb from headers.bin file if it exists
auto thumb_path = xe::join_paths(package_path_, kThumbnailFileName);
if (xe::filesystem::PathExists(thumb_path)) {
auto file = xe::filesystem::OpenFile(thumb_path, "rb");
fseek(file, 0, SEEK_END);
size_t file_len = ftell(file);
fseek(file, 0, SEEK_SET);
buffer->resize(file_len);
fread(const_cast<uint8_t*>(buffer->data()), 1, buffer->size(), file);
fclose(file);
return X_ERROR_SUCCESS;
}
return X_ERROR_FILE_NOT_FOUND;
}
X_RESULT FolderContentPackage::SetThumbnail(std::vector<uint8_t> buffer) {
xe::filesystem::CreateFolder(package_path_);
if (xe::filesystem::PathExists(package_path_)) {
auto thumb_path = xe::join_paths(package_path_, kThumbnailFileName);
auto file = xe::filesystem::OpenFile(thumb_path, "wb");
fwrite(buffer.data(), 1, buffer.size(), file);
fclose(file);
return X_ERROR_SUCCESS;
}
return X_ERROR_FILE_NOT_FOUND;
}
X_RESULT FolderContentPackage::Delete() {
// Make sure package isn't in use
Unmount();
if (xe::filesystem::PathExists(package_path_)) {
xe::filesystem::DeleteFolder(package_path_);
return X_ERROR_SUCCESS;
}
return X_ERROR_FILE_NOT_FOUND;
}
bool StfsContentPackage::Mount(std::string root_name) {
std::unique_ptr<vfs::StfsContainerDevice> device = nullptr;
if (!device_inited_) {
device =
std::make_unique<vfs::StfsContainerDevice>(device_path_, package_path_);
if (!device->Initialize()) {
return false;
}
device_ = device.release();
device_inited_ = true;
}
return ContentPackage::Mount(root_name, std::move(device));
}
X_RESULT StfsContentPackage::GetThumbnail(std::vector<uint8_t>* buffer) {
if (!device_ || !device_inited_) {
return X_ERROR_DEVICE_NOT_CONNECTED;
}
auto& header = device_->header();
buffer->resize(header.thumbnail_image_size);
memcpy(buffer->data(), header.thumbnail_image, header.thumbnail_image_size);
return X_ERROR_SUCCESS;
}
X_RESULT StfsContentPackage::SetThumbnail(std::vector<uint8_t> buffer) {
return X_ERROR_FUNCTION_FAILED; // can't write to STFS headers right now
}
X_RESULT StfsContentPackage::Delete() {
// Make sure package isn't in use
Unmount();
if (xe::filesystem::PathExists(package_path_)) {
xe::filesystem::DeleteFile(package_path_);
return X_ERROR_SUCCESS;
}
return X_ERROR_FILE_NOT_FOUND;
}
} // namespace xam
} // namespace kernel
} // namespace xe

103
src/xenia/kernel/xam/content_package.h Normal file
View File

@ -0,0 +1,103 @@
/**
******************************************************************************
* Xenia : Xbox 360 Emulator Research Project *
******************************************************************************
* Copyright 2015 Ben Vanik. All rights reserved. *
* Released under the BSD license - see LICENSE in the root for more details. *
******************************************************************************
*/
#ifndef XENIA_KERNEL_XAM_CONTENT_PACKAGE_H_
#define XENIA_KERNEL_XAM_CONTENT_PACKAGE_H_
#include <memory>
#include <string>
#include <unordered_map>
#include <vector>
#include "xenia/base/memory.h"
#include "xenia/base/mutex.h"
#include "xenia/xbox.h"
namespace xe {
namespace vfs {
class Device;
class StfsContainerDevice;
} // namespace vfs
} // namespace xe
namespace xe {
namespace kernel {
class KernelState;
} // namespace kernel
} // namespace xe
namespace xe {
namespace kernel {
namespace xam {
struct XCONTENT_DATA;
class ContentPackage {
public:
ContentPackage(KernelState* kernel_state, const XCONTENT_DATA& data,
std::wstring package_path);
~ContentPackage();
virtual bool Mount(std::string root_name) = 0;
virtual X_RESULT GetThumbnail(std::vector<uint8_t>* buffer) = 0;
virtual X_RESULT SetThumbnail(std::vector<uint8_t> buffer) = 0;
virtual X_RESULT Delete() = 0;
bool Unmount(); // Unmounts device & all root names - returns true if device
// is unmounted
bool Unmount(
std::string root_name); // Unmounts a single root name, if no root names
// are left mounted the device will be unmounted
// - returns true if device is unmounted
std::wstring package_path() { return package_path_; }
const std::vector<std::string>& root_names() { return root_names_; }
protected:
bool Mount(std::string root_name, std::unique_ptr<vfs::Device> device);
bool device_inited_ = false;
KernelState* kernel_state_;
std::string device_path_;
std::wstring package_path_;
std::vector<std::string> root_names_;
};
class StfsContentPackage : public ContentPackage {
public:
StfsContentPackage(KernelState* kernel_state, const XCONTENT_DATA& data,
std::wstring package_path)
: ContentPackage(kernel_state, data, package_path) {}
bool Mount(std::string root_name);
X_RESULT GetThumbnail(std::vector<uint8_t>* buffer);
X_RESULT SetThumbnail(std::vector<uint8_t> buffer);
X_RESULT Delete();
private:
vfs::StfsContainerDevice* device_ = nullptr;
};
class FolderContentPackage : public ContentPackage {
public:
FolderContentPackage(KernelState* kernel_state, const XCONTENT_DATA& data,
std::wstring package_path)
: ContentPackage(kernel_state, data, package_path) {}
bool Mount(std::string root_name);
X_RESULT GetThumbnail(std::vector<uint8_t>* buffer);
X_RESULT SetThumbnail(std::vector<uint8_t> buffer);
X_RESULT Delete();
};
} // namespace xam
} // namespace kernel
} // namespace xe
#endif // XENIA_KERNEL_XAM_CONTENT_PACKAGE_H_

2
src/xenia/vfs/devices/stfs_container_device.h
View File

@ -183,6 +183,8 @@ class StfsContainerDevice : public Device {
uint32_t sectors_per_allocation_unit() const override { return 1; }
uint32_t bytes_per_sector() const override { return 4 * 1024; }
StfsHeader& header() { return header_; }
private:
enum class Error {
kSuccess = 0,