mirror of
https://github.com/Atmosphere-NX/Atmosphere.git
synced 2025-10-31 11:15:51 +01:00
a50d6a2696
* ncm: Implement InstallTaskDataBase and FileInstallTaskData * ncm: minor bugfixes * ncm: Implemented MemoryInstallTaskData * ncm: more std * ncm: begin implementing install task base * ncm: move protected funcs * ncm: fix recursive include * ncm: more install task progress * ncm install task: implement IncrementProgress and update UpdateThroughputMeasurement * ncm: more work * ncm client: more progress * ncm client: more progress * ncm client: finish implementing GetContentMetaInfoList * ncm client: more progress * ncm client: finished InstallTaskBase * ncm client: implement PackageInstallTaskBase * ncm client: fixes * ncm: improve accuracy * ncm client: implement PackageInstallTask * ncm client: implement PackageSystemUpdateTask * ncm client: minor name tweaks * ncm client: implement SubmissionPackageInstallTask * ncm client: add missing this to SubmissionPackageInstallTask * ncm client: add missing nullptr check to SubmissionPackageInstallTask destructor * ncm client: SubmissionPackageInstallTask fixes * ncm: fix forward declarations * ncm client: added simplified funcs * ncm: cleanup client code * ncm: fix bug introduced by cleanup * ncm: fix typo * ncm: implement correct ReadVariationContentMetaInfoList behavior * ncm: correct InstallContentMetaWriter ctor * ncm: correct conversion of content meta header types Co-authored-by: Michael Scire <SciresM@gmail.com>
372 lines
15 KiB
C++
372 lines
15 KiB
C++
/*
|
|
* Copyright (c) 2018-2020 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 <stratosphere/ncm/ncm_content_meta_id.hpp>
|
|
#include <stratosphere/ncm/ncm_content_meta_key.hpp>
|
|
#include <stratosphere/ncm/ncm_content_info.hpp>
|
|
#include <stratosphere/ncm/ncm_content_info_data.hpp>
|
|
#include <stratosphere/ncm/ncm_firmware_variation.hpp>
|
|
#include <stratosphere/ncm/ncm_storage_id.hpp>
|
|
|
|
namespace ams::ncm {
|
|
|
|
enum ContentMetaAttribute : u8 {
|
|
ContentMetaAttribute_None = (0 << 0),
|
|
ContentMetaAttribute_IncludesExFatDriver = (1 << 0),
|
|
ContentMetaAttribute_Rebootless = (1 << 1),
|
|
};
|
|
|
|
struct ContentMetaInfo {
|
|
u64 id;
|
|
u32 version;
|
|
ContentMetaType type;
|
|
u8 attributes;
|
|
u8 padding[2];
|
|
|
|
static constexpr ContentMetaInfo Make(u64 id, u32 version, ContentMetaType type, u8 attributes) {
|
|
return {
|
|
.id = id,
|
|
.version = version,
|
|
.type = type,
|
|
.attributes = attributes,
|
|
};
|
|
}
|
|
|
|
constexpr ContentMetaKey ToKey() {
|
|
return ContentMetaKey::Make(this->id, this->version, this->type);
|
|
}
|
|
};
|
|
|
|
static_assert(sizeof(ContentMetaInfo) == 0x10);
|
|
|
|
struct ContentMetaHeader {
|
|
u16 extended_header_size;
|
|
u16 content_count;
|
|
u16 content_meta_count;
|
|
u8 attributes;
|
|
StorageId storage_id;
|
|
};
|
|
|
|
static_assert(sizeof(ContentMetaHeader) == 0x8);
|
|
|
|
struct PackagedContentMetaHeader {
|
|
u64 id;
|
|
u32 version;
|
|
ContentMetaType type;
|
|
u8 reserved_0D;
|
|
u16 extended_header_size;
|
|
u16 content_count;
|
|
u16 content_meta_count;
|
|
u8 attributes;
|
|
u8 storage_id;
|
|
ContentInstallType install_type;
|
|
bool committed;
|
|
u32 required_download_system_version;
|
|
u8 reserved_1C[4];
|
|
};
|
|
static_assert(sizeof(PackagedContentMetaHeader) == 0x20);
|
|
static_assert(OFFSETOF(PackagedContentMetaHeader, reserved_0D) == 0x0D);
|
|
static_assert(OFFSETOF(PackagedContentMetaHeader, reserved_1C) == 0x1C);
|
|
|
|
using InstallContentMetaHeader = PackagedContentMetaHeader;
|
|
|
|
struct ApplicationMetaExtendedHeader {
|
|
PatchId patch_id;
|
|
u32 required_system_version;
|
|
u32 required_application_version;
|
|
};
|
|
|
|
struct PatchMetaExtendedHeader {
|
|
ApplicationId application_id;
|
|
u32 required_system_version;
|
|
u32 extended_data_size;
|
|
u8 reserved[0x8];
|
|
};
|
|
|
|
struct AddOnContentMetaExtendedHeader {
|
|
ApplicationId application_id;
|
|
u32 required_application_version;
|
|
u32 padding;
|
|
};
|
|
|
|
struct DeltaMetaExtendedHeader {
|
|
ApplicationId application_id;
|
|
u32 extended_data_size;
|
|
u32 padding;
|
|
};
|
|
|
|
struct SystemUpdateMetaExtendedHeader {
|
|
u32 extended_data_size;
|
|
};
|
|
|
|
template<typename ContentMetaHeaderType, typename ContentInfoType>
|
|
class ContentMetaAccessor {
|
|
public:
|
|
using HeaderType = ContentMetaHeaderType;
|
|
using InfoType = ContentInfoType;
|
|
private:
|
|
void *data;
|
|
const size_t size;
|
|
bool is_header_valid;
|
|
private:
|
|
static size_t GetExtendedHeaderSize(ContentMetaType type) {
|
|
switch (type) {
|
|
case ContentMetaType::Application: return sizeof(ApplicationMetaExtendedHeader);
|
|
case ContentMetaType::Patch: return sizeof(PatchMetaExtendedHeader);
|
|
case ContentMetaType::AddOnContent: return sizeof(AddOnContentMetaExtendedHeader);
|
|
case ContentMetaType::Delta: return sizeof(DeltaMetaExtendedHeader);
|
|
default: return 0;
|
|
}
|
|
}
|
|
protected:
|
|
constexpr ContentMetaAccessor(const void *d, size_t sz) : data(const_cast<void *>(d)), size(sz), is_header_valid(true) { /* ... */ }
|
|
constexpr ContentMetaAccessor(void *d, size_t sz) : data(d), size(sz), is_header_valid(false) { /* ... */ }
|
|
|
|
template<class NewHeaderType, class NewInfoType>
|
|
static constexpr size_t CalculateSizeImpl(size_t ext_header_size, size_t content_count, size_t content_meta_count, size_t extended_data_size, bool has_digest) {
|
|
return sizeof(NewHeaderType) + ext_header_size + content_count * sizeof(NewInfoType) + content_meta_count * sizeof(ContentMetaInfo) + extended_data_size + (has_digest ? sizeof(Digest) : 0);
|
|
}
|
|
|
|
static constexpr size_t CalculateSize(ContentMetaType type, size_t content_count, size_t content_meta_count, size_t extended_data_size, bool has_digest = false) {
|
|
return CalculateSizeImpl<ContentMetaHeaderType, ContentInfoType>(GetExtendedHeaderSize(type), content_count, content_meta_count, extended_data_size, has_digest);
|
|
}
|
|
|
|
uintptr_t GetExtendedHeaderAddress() const {
|
|
return reinterpret_cast<uintptr_t>(this->data) + sizeof(HeaderType);
|
|
}
|
|
|
|
uintptr_t GetContentInfoStartAddress() const {
|
|
return this->GetExtendedHeaderAddress() + this->GetExtendedHeaderSize();
|
|
}
|
|
|
|
uintptr_t GetContentInfoAddress(size_t i) const {
|
|
return this->GetContentInfoStartAddress() + i * sizeof(InfoType);
|
|
}
|
|
|
|
uintptr_t GetContentMetaInfoStartAddress() const {
|
|
return this->GetContentInfoAddress(this->GetContentCount());
|
|
}
|
|
|
|
uintptr_t GetContentMetaInfoAddress(size_t i) const {
|
|
return this->GetContentMetaInfoStartAddress() + i * sizeof(ContentMetaInfo);
|
|
}
|
|
|
|
uintptr_t GetExtendedDataAddress() const {
|
|
return this->GetContentMetaInfoAddress(this->GetContentMetaCount());
|
|
}
|
|
|
|
uintptr_t GetDigestAddress() const {
|
|
return this->GetExtendedDataAddress() + this->GetExtendedDataSize();
|
|
}
|
|
|
|
InfoType *GetWritableContentInfo(size_t i) const {
|
|
AMS_ABORT_UNLESS(i < this->GetContentCount());
|
|
|
|
return reinterpret_cast<InfoType *>(this->GetContentInfoAddress(i));
|
|
}
|
|
|
|
InfoType *GetWritableContentInfo(ContentType type) const {
|
|
InfoType *found = nullptr;
|
|
for (size_t i = 0; i < this->GetContentCount(); i++) {
|
|
/* We want to find the info with the lowest id offset and the correct type. */
|
|
InfoType *info = this->GetWritableContentInfo(i);
|
|
if (info->GetType() == type && (found == nullptr || info->GetIdOffset() < found->GetIdOffset())) {
|
|
found = info;
|
|
}
|
|
}
|
|
return found;
|
|
}
|
|
|
|
InfoType *GetWritableContentInfo(ContentType type, u8 id_ofs) const {
|
|
for (size_t i = 0; i < this->GetContentCount(); i++) {
|
|
/* We want to find the info with the correct id offset and the correct type. */
|
|
if (InfoType *info = this->GetWritableContentInfo(i); info->GetType() == type && info->GetIdOffset() == id_ofs) {
|
|
return info;
|
|
}
|
|
}
|
|
return nullptr;
|
|
}
|
|
|
|
s64 CalculateContentRequiredSize() const {
|
|
s64 required_size = 0;
|
|
for (size_t i = 0; i < this->GetContentCount(); i++) {
|
|
required_size += CalculateRequiredSize(this->GetContentInfo(i)->info.GetSize());
|
|
}
|
|
return required_size;
|
|
}
|
|
|
|
void SetStorageId(StorageId storage_id) {
|
|
this->GetWritableHeader()->storage_id = static_cast<u8>(storage_id);
|
|
}
|
|
|
|
public:
|
|
const void *GetData() const {
|
|
return this->data;
|
|
}
|
|
|
|
size_t GetSize() const {
|
|
return this->size;
|
|
}
|
|
|
|
HeaderType *GetWritableHeader() const {
|
|
AMS_ABORT_UNLESS(this->is_header_valid);
|
|
return reinterpret_cast<HeaderType *>(this->data);
|
|
}
|
|
|
|
const HeaderType *GetHeader() const {
|
|
AMS_ABORT_UNLESS(this->is_header_valid);
|
|
return static_cast<const HeaderType *>(this->data);
|
|
}
|
|
|
|
ContentMetaKey GetKey() const {
|
|
auto header = this->GetHeader();
|
|
return ContentMetaKey::Make(header->id, header->version, header->type, header->install_type);
|
|
}
|
|
|
|
size_t GetExtendedHeaderSize() const {
|
|
return this->GetHeader()->extended_header_size;
|
|
}
|
|
|
|
template<typename ExtendedHeaderType>
|
|
const ExtendedHeaderType *GetExtendedHeader() const {
|
|
return reinterpret_cast<const ExtendedHeaderType *>(this->GetExtendedHeaderAddress());
|
|
}
|
|
|
|
size_t GetContentCount() const {
|
|
return this->GetHeader()->content_count;
|
|
}
|
|
|
|
const InfoType *GetContentInfo(size_t i) const {
|
|
AMS_ABORT_UNLESS(i < this->GetContentCount());
|
|
|
|
return this->GetWritableContentInfo(i);
|
|
}
|
|
|
|
const InfoType *GetContentInfo(ContentType type) const {
|
|
return this->GetWritableContentInfo(type);
|
|
}
|
|
|
|
const InfoType *GetContentInfo(ContentType type, u8 id_ofs) const {
|
|
return this->GetWritableContentInfo(type, id_ofs);
|
|
}
|
|
|
|
size_t GetContentMetaCount() const {
|
|
return this->GetHeader()->content_meta_count;
|
|
}
|
|
|
|
const ContentMetaInfo *GetContentMetaInfo(size_t i) const {
|
|
AMS_ABORT_UNLESS(i < this->GetContentMetaCount());
|
|
|
|
return reinterpret_cast<const ContentMetaInfo *>(this->GetContentMetaInfoAddress(i));
|
|
}
|
|
|
|
size_t GetExtendedDataSize() const {
|
|
switch (this->GetHeader()->type) {
|
|
case ContentMetaType::Patch: return this->GetExtendedHeader<PatchMetaExtendedHeader>()->extended_data_size;
|
|
case ContentMetaType::Delta: return this->GetExtendedHeader<DeltaMetaExtendedHeader>()->extended_data_size;
|
|
case ContentMetaType::SystemUpdate: return this->GetExtendedHeaderSize() == 0 ? 0 : this->GetExtendedHeader<SystemUpdateMetaExtendedHeader>()->extended_data_size;
|
|
default: return 0;
|
|
}
|
|
}
|
|
|
|
const void *GetExtendedData() const {
|
|
return reinterpret_cast<const void *>(this->GetExtendedDataAddress());
|
|
}
|
|
|
|
const Digest *GetDigest() const {
|
|
return reinterpret_cast<Digest *>(this->GetDigestAddress());
|
|
}
|
|
|
|
bool HasContent(const ContentId &id) const {
|
|
for (size_t i = 0; i < this->GetContentCount(); i++) {
|
|
if (id == this->GetContentInfo(i)->GetId()) {
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
StorageId GetStorageId() const {
|
|
return static_cast<StorageId>(this->GetHeader()->storage_id);
|
|
}
|
|
|
|
std::optional<ApplicationId> GetApplicationId(const ContentMetaKey &key) const {
|
|
switch (key.type) {
|
|
case ContentMetaType::Application: return ApplicationId{ key.id };
|
|
case ContentMetaType::Patch: return this->GetExtendedHeader<PatchMetaExtendedHeader>()->application_id;
|
|
case ContentMetaType::AddOnContent: return this->GetExtendedHeader<AddOnContentMetaExtendedHeader>()->application_id;
|
|
case ContentMetaType::Delta: return this->GetExtendedHeader<DeltaMetaExtendedHeader>()->application_id;
|
|
default: return std::nullopt;
|
|
}
|
|
}
|
|
|
|
std::optional<ApplicationId> GetApplicationId() const {
|
|
return this->GetApplicationId(this->GetKey());
|
|
}
|
|
};
|
|
|
|
class ContentMetaReader : public ContentMetaAccessor<ContentMetaHeader, ContentInfo> {
|
|
public:
|
|
constexpr ContentMetaReader(const void *data, size_t size) : ContentMetaAccessor(data, size) { /* ... */ }
|
|
|
|
using ContentMetaAccessor::CalculateSize;
|
|
};
|
|
|
|
class PackagedContentMetaReader : public ContentMetaAccessor<PackagedContentMetaHeader, PackagedContentInfo> {
|
|
public:
|
|
constexpr PackagedContentMetaReader(const void *data, size_t size) : ContentMetaAccessor(data, size) { /* ... */ }
|
|
|
|
size_t CalculateConvertInstallContentMetaSize() const;
|
|
void ConvertToInstallContentMeta(void *dst, size_t size, const InstallContentInfo &meta);
|
|
|
|
size_t CalculateConvertContentMetaSize() const;
|
|
void ConvertToContentMeta(void *dst, size_t size, const ContentInfo &meta);
|
|
|
|
Result CalculateConvertFragmentOnlyInstallContentMetaSize(size_t *out_size, u32 source_version) const;
|
|
Result ConvertToFragmentOnlyInstallContentMeta(void *dst, size_t size, const InstallContentInfo &content_info, u32 source_version);
|
|
|
|
size_t CountDeltaFragments() const;
|
|
|
|
static constexpr size_t CalculateSize(ContentMetaType type, size_t content_count, size_t content_meta_count, size_t extended_data_size) {
|
|
return ContentMetaAccessor::CalculateSize(type, content_count, content_meta_count, extended_data_size, true);
|
|
}
|
|
};
|
|
|
|
class InstallContentMetaReader : public ContentMetaAccessor<InstallContentMetaHeader, InstallContentInfo> {
|
|
public:
|
|
constexpr InstallContentMetaReader(const void *data, size_t size) : ContentMetaAccessor(data, size) { /* ... */ }
|
|
|
|
using ContentMetaAccessor::CalculateSize;
|
|
using ContentMetaAccessor::CalculateContentRequiredSize;
|
|
using ContentMetaAccessor::GetStorageId;
|
|
|
|
size_t CalculateConvertSize() const;
|
|
|
|
void ConvertToContentMeta(void *dst, size_t size) const;
|
|
};
|
|
|
|
class InstallContentMetaWriter : public ContentMetaAccessor<InstallContentMetaHeader, InstallContentInfo> {
|
|
public:
|
|
InstallContentMetaWriter(const void *data, size_t size) : ContentMetaAccessor(data, size) { /* ... */ }
|
|
|
|
using ContentMetaAccessor::CalculateSize;
|
|
using ContentMetaAccessor::CalculateContentRequiredSize;
|
|
using ContentMetaAccessor::GetWritableContentInfo;
|
|
using ContentMetaAccessor::SetStorageId;
|
|
};
|
|
|
|
}
|