205 lines
8.5 KiB
C
205 lines
8.5 KiB
C
/*
|
|
* pfs.h
|
|
*
|
|
* Copyright (c) 2020-2024, DarkMatterCore <pabloacurielz@gmail.com>.
|
|
*
|
|
* This file is part of nxdumptool (https://github.com/DarkMatterCore/nxdumptool).
|
|
*
|
|
* nxdumptool is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* nxdumptool is distributed in the hope that 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 <https://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#ifndef __PFS_H__
|
|
#define __PFS_H__
|
|
|
|
#include "nca_storage.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#define PFS0_MAGIC 0x50465330 /* "PFS0". */
|
|
|
|
typedef struct {
|
|
u32 magic; ///< "PFS0".
|
|
u32 entry_count;
|
|
u32 name_table_size;
|
|
u8 reserved[0x4];
|
|
} PartitionFileSystemHeader;
|
|
|
|
NXDT_ASSERT(PartitionFileSystemHeader, 0x10);
|
|
|
|
typedef struct {
|
|
u64 offset;
|
|
u64 size;
|
|
u32 name_offset;
|
|
u8 reserved[0x4];
|
|
} PartitionFileSystemEntry;
|
|
|
|
NXDT_ASSERT(PartitionFileSystemEntry, 0x18);
|
|
|
|
/// Used with Partition FS sections from NCAs.
|
|
typedef struct {
|
|
NcaStorageContext storage_ctx; ///< Used to read NCA FS section data.
|
|
NcaFsSectionContext *nca_fs_ctx; ///< Same as storage_ctx.nca_fs_ctx. Placed here for convenience.
|
|
u64 offset; ///< Partition offset (relative to the start of the NCA FS section).
|
|
u64 size; ///< Partition size.
|
|
bool is_exefs; ///< ExeFS flag.
|
|
u64 header_size; ///< Full header size.
|
|
u8 *header; ///< PartitionFileSystemHeader + (PartitionFileSystemEntry * entry_count) + Name Table.
|
|
} PartitionFileSystemContext;
|
|
|
|
/// Used to generate Partition FS images (e.g. NSPs).
|
|
typedef struct {
|
|
PartitionFileSystemHeader header; ///< Partition FS header. Holds the entry count and name table size.
|
|
PartitionFileSystemEntry *entries; ///< Partition FS entries.
|
|
char *name_table; ///< Name table.
|
|
u64 fs_size; ///< Partition FS data size. Updated each time a new entry is added.
|
|
} PartitionFileSystemImageContext;
|
|
|
|
/// Initializes a Partition FS context.
|
|
bool pfsInitializeContext(PartitionFileSystemContext *out, NcaFsSectionContext *nca_fs_ctx);
|
|
|
|
/// Reads raw partition data using a Partition FS context.
|
|
/// Input offset must be relative to the start of the Partition FS.
|
|
bool pfsReadPartitionData(PartitionFileSystemContext *ctx, void *out, u64 read_size, u64 offset);
|
|
|
|
/// Reads data from a previously retrieved PartitionFileSystemEntry using a Partition FS context.
|
|
/// Input offset must be relative to the start of the Partition FS entry.
|
|
bool pfsReadEntryData(PartitionFileSystemContext *ctx, PartitionFileSystemEntry *fs_entry, void *out, u64 read_size, u64 offset);
|
|
|
|
/// Retrieves a Partition FS entry index by its name.
|
|
bool pfsGetEntryIndexByName(PartitionFileSystemContext *ctx, const char *name, u32 *out_idx);
|
|
|
|
/// Calculates the extracted Partition FS size.
|
|
bool pfsGetTotalDataSize(PartitionFileSystemContext *ctx, u64 *out_size);
|
|
|
|
/// Generates HierarchicalSha256 FS section patch data using a Partition FS context + entry, which can be used to seamlessly replace NCA data.
|
|
/// Input offset must be relative to the start of the Partition FS entry data.
|
|
/// This function shares the same limitations as ncaGenerateHierarchicalSha256Patch().
|
|
/// Use the pfsWriteEntryPatchToMemoryBuffer() wrapper to write patch data generated by this function.
|
|
bool pfsGenerateEntryPatch(PartitionFileSystemContext *ctx, PartitionFileSystemEntry *fs_entry, const void *data, u64 data_size, u64 data_offset, NcaHierarchicalSha256Patch *out);
|
|
|
|
/// Adds a new Partition FS entry to an existing PartitionFileSystemImageContext, using the provided entry name and size.
|
|
/// If 'out_entry_idx' is a valid pointer, the index to the new Partition FS entry will be saved to it.
|
|
bool pfsAddEntryInformationToImageContext(PartitionFileSystemImageContext *ctx, const char *entry_name, u64 entry_size, u32 *out_entry_idx);
|
|
|
|
/// Updates the name from a Partition FS entry in an existing PartitionFileSystemImageContext, using an entry index and the new entry name.
|
|
bool pfsUpdateEntryNameFromImageContext(PartitionFileSystemImageContext *ctx, u32 entry_idx, const char *new_entry_name);
|
|
|
|
/// Generates a full Partition FS header from an existing PartitionFileSystemImageContext and writes it to the provided memory buffer.
|
|
bool pfsWriteImageContextHeaderToMemoryBuffer(PartitionFileSystemImageContext *ctx, void *buf, u64 buf_size, u64 *out_header_size);
|
|
|
|
/// Miscellaneous functions.
|
|
|
|
NX_INLINE void pfsFreeContext(PartitionFileSystemContext *ctx)
|
|
{
|
|
if (!ctx) return;
|
|
ncaStorageFreeContext(&(ctx->storage_ctx));
|
|
if (ctx->header) free(ctx->header);
|
|
memset(ctx, 0, sizeof(PartitionFileSystemContext));
|
|
}
|
|
|
|
/// Checks if the provided PartitionFileSystemContext is valid.
|
|
NX_INLINE bool pfsIsValidContext(PartitionFileSystemContext *ctx)
|
|
{
|
|
return (ctx && ncaStorageIsValidContext(&(ctx->storage_ctx)) && ctx->nca_fs_ctx == ctx->storage_ctx.nca_fs_ctx && \
|
|
ctx->storage_ctx.base_storage_type == NcaStorageBaseStorageType_Regular && ctx->size && ctx->header_size && ctx->header);
|
|
}
|
|
|
|
NX_INLINE u32 pfsGetEntryCount(PartitionFileSystemContext *ctx)
|
|
{
|
|
return (pfsIsValidContext(ctx) ? ((PartitionFileSystemHeader*)ctx->header)->entry_count : 0);
|
|
}
|
|
|
|
NX_INLINE PartitionFileSystemEntry *pfsGetEntryByIndex(PartitionFileSystemContext *ctx, u32 idx)
|
|
{
|
|
return (idx < pfsGetEntryCount(ctx) ? (PartitionFileSystemEntry*)(ctx->header + sizeof(PartitionFileSystemHeader) + (idx * sizeof(PartitionFileSystemEntry))) : NULL);
|
|
}
|
|
|
|
NX_INLINE char *pfsGetNameTable(PartitionFileSystemContext *ctx)
|
|
{
|
|
u32 entry_count = pfsGetEntryCount(ctx);
|
|
return (entry_count ? (char*)(ctx->header + sizeof(PartitionFileSystemHeader) + (entry_count * sizeof(PartitionFileSystemEntry))) : NULL);
|
|
}
|
|
|
|
NX_INLINE char *pfsGetEntryName(PartitionFileSystemContext *ctx, PartitionFileSystemEntry *fs_entry)
|
|
{
|
|
char *name_table = pfsGetNameTable(ctx);
|
|
if (!name_table || !fs_entry || fs_entry->name_offset >= ((PartitionFileSystemHeader*)ctx->header)->name_table_size || !name_table[fs_entry->name_offset]) return NULL;
|
|
return (name_table + fs_entry->name_offset);
|
|
}
|
|
|
|
NX_INLINE char *pfsGetEntryNameByIndex(PartitionFileSystemContext *ctx, u32 idx)
|
|
{
|
|
PartitionFileSystemEntry *fs_entry = pfsGetEntryByIndex(ctx, idx);
|
|
char *name_table = pfsGetNameTable(ctx);
|
|
return ((fs_entry && name_table) ? (name_table + fs_entry->name_offset) : NULL);
|
|
}
|
|
|
|
NX_INLINE PartitionFileSystemEntry *pfsGetEntryByName(PartitionFileSystemContext *ctx, const char *name)
|
|
{
|
|
u32 idx = 0;
|
|
return (pfsGetEntryIndexByName(ctx, name, &idx) ? pfsGetEntryByIndex(ctx, idx) : NULL);
|
|
}
|
|
|
|
NX_INLINE void pfsWriteEntryPatchToMemoryBuffer(PartitionFileSystemContext *ctx, NcaHierarchicalSha256Patch *patch, void *buf, u64 buf_size, u64 buf_offset)
|
|
{
|
|
if (!pfsIsValidContext(ctx)) return;
|
|
ncaWriteHierarchicalSha256PatchToMemoryBuffer(ctx->nca_fs_ctx->nca_ctx, patch, buf, buf_size, buf_offset);
|
|
}
|
|
|
|
NX_INLINE void pfsFreeEntryPatch(NcaHierarchicalSha256Patch *patch)
|
|
{
|
|
ncaFreeHierarchicalSha256Patch(patch);
|
|
}
|
|
|
|
NX_INLINE void pfsFreeImageContext(PartitionFileSystemImageContext *ctx)
|
|
{
|
|
if (!ctx) return;
|
|
if (ctx->entries) free(ctx->entries);
|
|
if (ctx->name_table) free(ctx->name_table);
|
|
memset(ctx, 0, sizeof(PartitionFileSystemImageContext));
|
|
}
|
|
|
|
NX_INLINE void pfsInitializeImageContext(PartitionFileSystemImageContext *ctx)
|
|
{
|
|
if (!ctx) return;
|
|
pfsFreeImageContext(ctx);
|
|
ctx->header.magic = __builtin_bswap32(PFS0_MAGIC);
|
|
}
|
|
|
|
NX_INLINE u32 pfsGetEntryCountFromImageContext(PartitionFileSystemImageContext *ctx)
|
|
{
|
|
return (ctx ? ctx->header.entry_count : 0);
|
|
}
|
|
|
|
NX_INLINE PartitionFileSystemEntry *pfsGetEntryByIndexFromImageContext(PartitionFileSystemImageContext *ctx, u32 idx)
|
|
{
|
|
return (idx < pfsGetEntryCountFromImageContext(ctx) ? &(ctx->entries[idx]) : NULL);
|
|
}
|
|
|
|
NX_INLINE char *pfsGetEntryNameByIndexFromImageContext(PartitionFileSystemImageContext *ctx, u32 idx)
|
|
{
|
|
PartitionFileSystemEntry *fs_entry = pfsGetEntryByIndexFromImageContext(ctx, idx);
|
|
return ((fs_entry && ctx->name_table) ? (ctx->name_table + fs_entry->name_offset) : NULL);
|
|
}
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __PFS_H__ */
|