Merge pull request #6615 from leoetlino/sysconf

SysConf: Migrate to new filesystem interface
This commit is contained in:
Léo Lam
2018-04-14 23:29:25 +02:00
committed by GitHub
18 changed files with 100 additions and 64 deletions

View File

@ -16,6 +16,7 @@ add_library(core
NetPlayServer.cpp
PatchEngine.cpp
State.cpp
SysConf.cpp
TitleDatabase.cpp
WiiRoot.cpp
WiiUtils.cpp

View File

@ -8,7 +8,7 @@
#include <variant>
#include "Common/Config/Config.h"
#include "Common/SysConf.h"
#include "Core/SysConf.h"
namespace Config
{

View File

@ -17,12 +17,13 @@
#include "Common/FileUtil.h"
#include "Common/IniFile.h"
#include "Common/Logging/Log.h"
#include "Common/SysConf.h"
#include "Core/Config/SYSCONFSettings.h"
#include "Core/ConfigLoaders/IsSettingSaveable.h"
#include "Core/Core.h"
#include "Core/IOS/IOS.h"
#include "Core/IOS/USB/Bluetooth/BTBase.h"
#include "Core/SysConf.h"
namespace ConfigLoaders
{
@ -31,7 +32,8 @@ void SaveToSYSCONF(Config::LayerType layer)
if (Core::IsRunning())
return;
SysConf sysconf{Common::FromWhichRoot::FROM_CONFIGURED_ROOT};
IOS::HLE::Kernel ios;
SysConf sysconf{ios.GetFS()};
for (const Config::SYSCONFSetting& setting : Config::SYSCONF_SETTINGS)
{
@ -154,7 +156,8 @@ private:
if (Core::IsRunning())
return;
SysConf sysconf{Common::FromWhichRoot::FROM_CONFIGURED_ROOT};
IOS::HLE::Kernel ios;
SysConf sysconf{ios.GetFS()};
for (const Config::SYSCONFSetting& setting : Config::SYSCONF_SETTINGS)
{
std::visit(

View File

@ -292,6 +292,7 @@
<ClCompile Include="PowerPC\PPCTables.cpp" />
<ClCompile Include="PowerPC\Profiler.cpp" />
<ClCompile Include="State.cpp" />
<ClCompile Include="SysConf.cpp" />
<ClCompile Include="TitleDatabase.cpp" />
<ClCompile Include="WiiRoot.cpp" />
<ClCompile Include="WiiUtils.cpp" />
@ -530,6 +531,7 @@
<ClInclude Include="PowerPC\PPCTables.h" />
<ClInclude Include="PowerPC\Profiler.h" />
<ClInclude Include="State.h" />
<ClInclude Include="SysConf.h" />
<ClInclude Include="Titles.h" />
<ClInclude Include="TitleDatabase.h" />
<ClInclude Include="WiiRoot.h" />

View File

@ -179,6 +179,7 @@
<ClCompile Include="NetPlayServer.cpp" />
<ClCompile Include="PatchEngine.cpp" />
<ClCompile Include="State.cpp" />
<ClCompile Include="SysConf.cpp" />
<ClCompile Include="TitleDatabase.cpp" />
<ClCompile Include="WiiRoot.cpp" />
<ClCompile Include="WiiUtils.cpp" />
@ -912,6 +913,7 @@
<ClInclude Include="NetPlayServer.h" />
<ClInclude Include="PatchEngine.h" />
<ClInclude Include="State.h" />
<ClInclude Include="SysConf.h" />
<ClInclude Include="Titles.h" />
<ClInclude Include="TitleDatabase.h" />
<ClInclude Include="WiiRoot.h" />

View File

@ -28,7 +28,7 @@ FileHandle::FileHandle(FileHandle&& other) : m_fs{other.m_fs}, m_fd{other.m_fd}
FileHandle& FileHandle::operator=(FileHandle&& other)
{
if (*this != other)
if (std::tie(m_fs, m_fd) != std::tie(other.m_fs, other.m_fd))
*this = std::move(other);
return *this;
}
@ -46,6 +46,16 @@ Fd FileHandle::Release()
return fd;
}
Result<u32> FileHandle::Seek(u32 offset, SeekMode mode) const
{
return m_fs->SeekFile(*m_fd, offset, mode);
}
Result<FileStatus> FileHandle::GetStatus() const
{
return m_fs->GetFileStatus(*m_fd);
}
void FileSystem::Init()
{
if (Delete(0, 0, "/tmp") == ResultCode::Success)

View File

@ -108,10 +108,18 @@ public:
FileHandle& operator=(const FileHandle&) = delete;
FileHandle& operator=(FileHandle&&);
operator Fd() const { return m_fd.value(); }
/// Release the FD so that it is not automatically closed.
Fd Release();
template <typename T>
Result<size_t> Read(T* ptr, size_t count) const;
template <typename T>
Result<size_t> Write(const T* ptr, size_t count) const;
Result<u32> Seek(u32 offset, SeekMode mode) const;
Result<FileStatus> GetStatus() const;
private:
FileSystem* m_fs;
std::optional<Fd> m_fd;
@ -140,26 +148,6 @@ public:
/// Get status for a file descriptor.
virtual Result<FileStatus> GetFileStatus(Fd fd) = 0;
template <typename T>
Result<u32> ReadFile(Fd fd, T* ptr, u32 count)
{
const Result<u32> bytes = ReadBytesFromFile(fd, reinterpret_cast<u8*>(ptr), sizeof(T) * count);
if (!bytes)
return bytes.Error();
if (*bytes != sizeof(T) * count)
return ResultCode::ShortRead;
return count;
}
template <typename T>
Result<u32> WriteFile(Fd fd, const T* ptr, u32 count)
{
const auto result = WriteBytesToFile(fd, reinterpret_cast<const u8*>(ptr), sizeof(T) * count);
if (!result)
return result.Error();
return count;
}
/// Create a file with the specified path and metadata.
virtual ResultCode CreateFile(Uid caller_uid, Gid caller_gid, const std::string& path,
FileAttribute attribute, Mode owner_mode, Mode group_mode,
@ -195,6 +183,28 @@ protected:
void Init();
};
template <typename T>
Result<size_t> FileHandle::Read(T* ptr, size_t count) const
{
const Result<u32> bytes = m_fs->ReadBytesFromFile(*m_fd, reinterpret_cast<u8*>(ptr),
static_cast<u32>(sizeof(T) * count));
if (!bytes)
return bytes.Error();
if (*bytes != sizeof(T) * count)
return ResultCode::ShortRead;
return count;
}
template <typename T>
Result<size_t> FileHandle::Write(const T* ptr, size_t count) const
{
const auto result = m_fs->WriteBytesToFile(*m_fd, reinterpret_cast<const u8*>(ptr),
static_cast<u32>(sizeof(T) * count));
if (!result)
return result.Error();
return count;
}
enum class Location
{
Configured,

View File

@ -13,7 +13,7 @@
#include "Common/File.h"
#include "Common/FileUtil.h"
#include "Common/Logging/Log.h"
#include "Common/SysConf.h"
#include "Core/SysConf.h"
namespace IOS
{

View File

@ -15,7 +15,6 @@
#include "Common/MsgHandler.h"
#include "Common/NandPaths.h"
#include "Common/StringUtil.h"
#include "Common/SysConf.h"
#include "Core/Core.h"
#include "Core/CoreTiming.h"
#include "Core/Debugger/Debugger_SymbolMap.h"
@ -25,6 +24,7 @@
#include "Core/Host.h"
#include "Core/IOS/Device.h"
#include "Core/IOS/IOS.h"
#include "Core/SysConf.h"
#include "InputCommon/ControllerInterface/ControllerInterface.h"
namespace IOS
@ -42,8 +42,7 @@ namespace Device
BluetoothEmu::BluetoothEmu(Kernel& ios, const std::string& device_name)
: BluetoothBase(ios, device_name)
{
SysConf sysconf{Core::WantsDeterminism() ? Common::FromWhichRoot::FROM_SESSION_ROOT :
Common::FromWhichRoot::FROM_CONFIGURED_ROOT};
SysConf sysconf{ios.GetFS()};
if (!Core::WantsDeterminism())
BackUpBTInfoSection(&sysconf);

View File

@ -0,0 +1,309 @@
// Copyright 2009 Dolphin Emulator Project
// Licensed under GPLv2+
// Refer to the license.txt file included.
#include "Core/SysConf.h"
#include <algorithm>
#include <array>
#include <cstdio>
#include "Common/CommonPaths.h"
#include "Common/CommonTypes.h"
#include "Common/File.h"
#include "Common/FileUtil.h"
#include "Common/Logging/Log.h"
#include "Common/Swap.h"
#include "Core/IOS/FS/FileSystem.h"
constexpr size_t SYSCONF_SIZE = 0x4000;
static size_t GetNonArrayEntrySize(SysConf::Entry::Type type)
{
switch (type)
{
case SysConf::Entry::Type::Byte:
case SysConf::Entry::Type::ByteBool:
return 1;
case SysConf::Entry::Type::Short:
return 2;
case SysConf::Entry::Type::Long:
return 4;
case SysConf::Entry::Type::LongLong:
return 8;
default:
ASSERT(false);
return 0;
}
}
SysConf::SysConf(std::shared_ptr<IOS::HLE::FS::FileSystem> fs) : m_fs{fs}
{
Load();
}
SysConf::~SysConf()
{
Save();
}
void SysConf::Clear()
{
m_entries.clear();
}
void SysConf::Load()
{
Clear();
const auto file = m_fs->OpenFile(IOS::HLE::FS::Uid{0}, IOS::HLE::FS::Gid{0},
"/shared2/sys/SYSCONF", IOS::HLE::FS::Mode::Read);
if (!file || file->GetStatus()->size != SYSCONF_SIZE || !LoadFromFile(*file))
{
WARN_LOG(CORE, "No valid SYSCONF detected. Creating a new one.");
InsertDefaultEntries();
}
}
bool SysConf::LoadFromFile(const IOS::HLE::FS::FileHandle& file)
{
file.Seek(4, IOS::HLE::FS::SeekMode::Set);
u16 number_of_entries;
file.Read(&number_of_entries, 1);
number_of_entries = Common::swap16(number_of_entries);
std::vector<u16> offsets(number_of_entries);
for (u16& offset : offsets)
{
file.Read(&offset, 1);
offset = Common::swap16(offset);
}
for (const u16 offset : offsets)
{
file.Seek(offset, IOS::HLE::FS::SeekMode::Set);
// Metadata
u8 description = 0;
file.Read(&description, 1);
const Entry::Type type = static_cast<Entry::Type>((description & 0xe0) >> 5);
const u8 name_length = (description & 0x1f) + 1;
std::string name(name_length, '\0');
file.Read(&name[0], name.size());
// Data
std::vector<u8> data;
switch (type)
{
case Entry::Type::BigArray:
{
u16 data_length = 0;
file.Read(&data_length, 1);
// The stored u16 is length - 1, not length.
data.resize(Common::swap16(data_length) + 1);
break;
}
case Entry::Type::SmallArray:
{
u8 data_length = 0;
file.Read(&data_length, 1);
data.resize(data_length + 1);
break;
}
case Entry::Type::Byte:
case Entry::Type::ByteBool:
case Entry::Type::Short:
case Entry::Type::Long:
case Entry::Type::LongLong:
data.resize(GetNonArrayEntrySize(type));
break;
default:
ERROR_LOG(CORE, "Unknown entry type %d in SYSCONF for %s (offset %u)", static_cast<u8>(type),
name.c_str(), offset);
return false;
}
file.Read(data.data(), data.size());
AddEntry({type, name, std::move(data)});
}
return true;
}
template <typename T>
static void AppendToBuffer(std::vector<u8>* vector, T value)
{
const T swapped_value = Common::FromBigEndian(value);
vector->resize(vector->size() + sizeof(T));
std::memcpy(&*(vector->end() - sizeof(T)), &swapped_value, sizeof(T));
}
bool SysConf::Save() const
{
std::vector<u8> buffer;
buffer.reserve(SYSCONF_SIZE);
// Header
constexpr std::array<u8, 4> version{{'S', 'C', 'v', '0'}};
buffer.insert(buffer.end(), version.cbegin(), version.cend());
AppendToBuffer<u16>(&buffer, static_cast<u16>(m_entries.size()));
const size_t entries_begin_offset = buffer.size() + sizeof(u16) * (m_entries.size() + 1);
std::vector<u8> entries;
for (const auto& item : m_entries)
{
// Offset
AppendToBuffer<u16>(&buffer, static_cast<u16>(entries_begin_offset + entries.size()));
// Entry metadata (type and name)
entries.insert(entries.end(),
(static_cast<u8>(item.type) << 5) | (static_cast<u8>(item.name.size()) - 1));
entries.insert(entries.end(), item.name.cbegin(), item.name.cend());
// Entry data
switch (item.type)
{
case Entry::Type::BigArray:
{
const u16 data_size = static_cast<u16>(item.bytes.size());
// length - 1 is stored, not length.
AppendToBuffer<u16>(&entries, data_size - 1);
entries.insert(entries.end(), item.bytes.cbegin(), item.bytes.cbegin() + data_size);
break;
}
case Entry::Type::SmallArray:
{
const u8 data_size = static_cast<u8>(item.bytes.size());
AppendToBuffer<u8>(&entries, data_size - 1);
entries.insert(entries.end(), item.bytes.cbegin(), item.bytes.cbegin() + data_size);
break;
}
default:
entries.insert(entries.end(), item.bytes.cbegin(), item.bytes.cend());
break;
}
}
// Offset for the dummy past-the-end entry.
AppendToBuffer<u16>(&buffer, static_cast<u16>(entries_begin_offset + entries.size()));
// Main data.
buffer.insert(buffer.end(), entries.cbegin(), entries.cend());
// Make sure the buffer size is 0x4000 bytes now and write the footer.
buffer.resize(SYSCONF_SIZE);
constexpr std::array<u8, 4> footer = {{'S', 'C', 'e', 'd'}};
std::copy(footer.cbegin(), footer.cend(), buffer.end() - footer.size());
// Write the new data.
const std::string temp_file = "/tmp/SYSCONF";
constexpr u32 SYSMENU_UID = 0x1000;
constexpr u16 SYSMENU_GID = 1;
constexpr auto rw_mode = IOS::HLE::FS::Mode::ReadWrite;
{
m_fs->CreateFile(SYSMENU_UID, SYSMENU_GID, temp_file, 0, rw_mode, rw_mode, rw_mode);
auto file = m_fs->OpenFile(SYSMENU_UID, SYSMENU_GID, temp_file, IOS::HLE::FS::Mode::Write);
if (!file || !file->Write(buffer.data(), buffer.size()))
return false;
}
m_fs->CreateDirectory(SYSMENU_UID, SYSMENU_GID, "/shared2/sys", 0, rw_mode, rw_mode, rw_mode);
const auto result = m_fs->Rename(SYSMENU_UID, SYSMENU_GID, temp_file, "/shared2/sys/SYSCONF");
return result == IOS::HLE::FS::ResultCode::Success;
}
SysConf::Entry::Entry(Type type_, const std::string& name_) : type(type_), name(name_)
{
if (type != Type::SmallArray && type != Type::BigArray)
bytes.resize(GetNonArrayEntrySize(type));
}
SysConf::Entry::Entry(Type type_, const std::string& name_, const std::vector<u8>& bytes_)
: type(type_), name(name_), bytes(bytes_)
{
}
SysConf::Entry::Entry(Type type_, const std::string& name_, std::vector<u8>&& bytes_)
: type(type_), name(name_), bytes(std::move(bytes_))
{
}
void SysConf::AddEntry(Entry&& entry)
{
m_entries.emplace_back(std::move(entry));
}
SysConf::Entry* SysConf::GetEntry(const std::string& key)
{
const auto iterator = std::find_if(m_entries.begin(), m_entries.end(),
[&key](const auto& entry) { return entry.name == key; });
return iterator != m_entries.end() ? &*iterator : nullptr;
}
const SysConf::Entry* SysConf::GetEntry(const std::string& key) const
{
const auto iterator = std::find_if(m_entries.begin(), m_entries.end(),
[&key](const auto& entry) { return entry.name == key; });
return iterator != m_entries.end() ? &*iterator : nullptr;
}
SysConf::Entry* SysConf::GetOrAddEntry(const std::string& key, Entry::Type type)
{
if (Entry* entry = GetEntry(key))
return entry;
AddEntry({type, key});
return GetEntry(key);
}
void SysConf::RemoveEntry(const std::string& key)
{
m_entries.erase(std::remove_if(m_entries.begin(), m_entries.end(),
[&key](const auto& entry) { return entry.name == key; }),
m_entries.end());
}
void SysConf::InsertDefaultEntries()
{
AddEntry({Entry::Type::BigArray, "BT.DINF", std::vector<u8>(0x460 + 1)});
AddEntry({Entry::Type::BigArray, "BT.CDIF", std::vector<u8>(0x204 + 1)});
AddEntry({Entry::Type::Long, "BT.SENS", {0, 0, 0, 3}});
AddEntry({Entry::Type::Byte, "BT.BAR", {1}});
AddEntry({Entry::Type::Byte, "BT.SPKV", {0x58}});
AddEntry({Entry::Type::Byte, "BT.MOT", {1}});
std::vector<u8> console_nick = {0, 'd', 0, 'o', 0, 'l', 0, 'p', 0, 'h', 0, 'i', 0, 'n'};
// 22 bytes: 2 bytes per character (10 characters maximum),
// 1 for a null terminating character, 1 for the string length
console_nick.resize(22);
console_nick[21] = static_cast<u8>(strlen("dolphin"));
AddEntry({Entry::Type::SmallArray, "IPL.NIK", std::move(console_nick)});
AddEntry({Entry::Type::Byte, "IPL.LNG", {1}});
std::vector<u8> ipl_sadr(0x1007 + 1);
ipl_sadr[0] = 0x6c;
AddEntry({Entry::Type::BigArray, "IPL.SADR", std::move(ipl_sadr)});
std::vector<u8> ipl_pc(0x49 + 1);
ipl_pc[1] = 0x04;
ipl_pc[2] = 0x14;
AddEntry({Entry::Type::SmallArray, "IPL.PC", std::move(ipl_pc)});
AddEntry({Entry::Type::Long, "IPL.CB", {0x0f, 0x11, 0x14, 0xa6}});
AddEntry({Entry::Type::Byte, "IPL.AR", {1}});
AddEntry({Entry::Type::Byte, "IPL.SSV", {1}});
AddEntry({Entry::Type::ByteBool, "IPL.CD", {0}});
AddEntry({Entry::Type::ByteBool, "IPL.CD2", {0}});
AddEntry({Entry::Type::ByteBool, "IPL.EULA", {1}});
AddEntry({Entry::Type::Byte, "IPL.UPT", {2}});
AddEntry({Entry::Type::Byte, "IPL.PGS", {0}});
AddEntry({Entry::Type::Byte, "IPL.E60", {1}});
AddEntry({Entry::Type::Byte, "IPL.DH", {0}});
AddEntry({Entry::Type::Long, "IPL.INC", {0, 0, 0, 8}});
AddEntry({Entry::Type::Long, "IPL.FRC", {0, 0, 0, 0x28}});
AddEntry({Entry::Type::SmallArray, "IPL.IDL", {0, 1}});
AddEntry({Entry::Type::Long, "NET.WCFG", {0, 0, 0, 1}});
AddEntry({Entry::Type::Long, "NET.CTPC", std::vector<u8>(4)});
AddEntry({Entry::Type::Byte, "WWW.RST", {0}});
AddEntry({Entry::Type::ByteBool, "MPLS.MOVIE", {1}});
}

View File

@ -0,0 +1,99 @@
// Copyright 2009 Dolphin Emulator Project
// Licensed under GPLv2+
// Refer to the license.txt file included.
// Utilities to parse and modify a Wii SYSCONF file and its sections.
#pragma once
#include <cstring>
#include <memory>
#include <string>
#include <vector>
#include "Common/Assert.h"
#include "Common/CommonTypes.h"
#include "Common/NandPaths.h"
namespace IOS::HLE::FS
{
class FileHandle;
class FileSystem;
}
class SysConf final
{
public:
explicit SysConf(std::shared_ptr<IOS::HLE::FS::FileSystem> fs);
~SysConf();
void Clear();
void Load();
bool Save() const;
struct Entry
{
enum Type : u8
{
BigArray = 1,
SmallArray = 2,
Byte = 3,
Short = 4,
Long = 5,
LongLong = 6,
// Should really be named Bool, but this conflicts with some random macro. :/
ByteBool = 7,
};
Entry(Type type_, const std::string& name_);
Entry(Type type_, const std::string& name_, const std::vector<u8>& bytes_);
Entry(Type type_, const std::string& name_, std::vector<u8>&& bytes_);
// Intended for use with the non array types.
template <typename T>
T GetData(T default_value) const
{
if (bytes.size() != sizeof(T))
return default_value;
T value;
std::memcpy(&value, bytes.data(), bytes.size());
return value;
}
template <typename T>
void SetData(T value)
{
ASSERT(sizeof(value) == bytes.size());
std::memcpy(bytes.data(), &value, bytes.size());
}
Type type;
std::string name;
std::vector<u8> bytes;
};
void AddEntry(Entry&& entry);
Entry* GetEntry(const std::string& key);
const Entry* GetEntry(const std::string& key) const;
Entry* GetOrAddEntry(const std::string& key, Entry::Type type);
void RemoveEntry(const std::string& key);
// Intended for use with the non array types.
template <typename T>
T GetData(const std::string& key, T default_value) const
{
const Entry* entry = GetEntry(key);
return entry ? entry->GetData(default_value) : default_value;
}
template <typename T>
void SetData(const std::string& key, Entry::Type type, T value)
{
GetOrAddEntry(key, type)->SetData(value);
}
private:
void InsertDefaultEntries();
bool LoadFromFile(const IOS::HLE::FS::FileHandle& file);
std::vector<Entry> m_entries;
std::shared_ptr<IOS::HLE::FS::FileSystem> m_fs;
};

View File

@ -11,10 +11,11 @@
#include "Common/Logging/Log.h"
#include "Common/NandPaths.h"
#include "Common/StringUtil.h"
#include "Common/SysConf.h"
#include "Core/ConfigManager.h"
#include "Core/IOS/IOS.h"
#include "Core/Movie.h"
#include "Core/NetPlayClient.h"
#include "Core/SysConf.h"
namespace Core
{
@ -64,7 +65,7 @@ void InitializeWiiRoot(bool use_temporary)
WARN_LOG(IOS_FS, "Using temporary directory %s for minimal Wii FS", s_temp_wii_root.c_str());
File::SetUserPath(D_SESSION_WIIROOT_IDX, s_temp_wii_root);
// Generate a SYSCONF with default settings for the temporary Wii NAND.
SysConf sysconf{Common::FromWhichRoot::FROM_SESSION_ROOT};
SysConf sysconf{IOS::HLE::Kernel{}.GetFS()};
sysconf.Save();
InitializeDeterministicWiiSaves();

View File

@ -29,13 +29,13 @@
#include "Common/NandPaths.h"
#include "Common/StringUtil.h"
#include "Common/Swap.h"
#include "Common/SysConf.h"
#include "Core/CommonTitles.h"
#include "Core/ConfigManager.h"
#include "Core/IOS/Device.h"
#include "Core/IOS/ES/ES.h"
#include "Core/IOS/ES/Formats.h"
#include "Core/IOS/IOS.h"
#include "Core/SysConf.h"
#include "DiscIO/DiscExtractor.h"
#include "DiscIO/Enums.h"
#include "DiscIO/Filesystem.h"
@ -136,7 +136,7 @@ bool InstallWAD(IOS::HLE::Kernel& ios, const DiscIO::WiiWAD& wad, InstallType in
}
// Delete a previous temporary title, if it exists.
SysConf sysconf{Common::FROM_SESSION_ROOT};
SysConf sysconf{ios.GetFS()};
SysConf::Entry* tid_entry = sysconf.GetOrAddEntry("IPL.TID", SysConf::Entry::Type::LongLong);
if (const u64 previous_temporary_title_id = Common::swap64(tid_entry->GetData<u64>(0)))
ios.GetES()->DeleteTitleContent(previous_temporary_title_id);