aboutsummaryrefslogtreecommitdiff
path: root/src/core/file_sys/nup_writer.cpp
blob: 8c7728ed019e552dcc44a41772f2b0d9c2ee1899 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
// SPDX-FileCopyrightText: Copyright 2026 Eden Emulator Project
// SPDX-License-Identifier: GPL-3.0-or-later

#include "core/file_sys/nup_writer.h"

#include <algorithm>
#include <array>
#include <cctype>
#include <charconv>
#include <cstring>
#include <limits>
#include <map>
#include <memory>
#include <optional>
#include <span>
#include <stdexcept>
#include <unordered_map>
#include <unordered_set>
#include <vector>

#include <nlohmann/json.hpp>
#include <openssl/evp.h>
#include <zstd.h>

#include "common/fs/file.h"
#include "common/fs/path_util.h"
#include "core/file_sys/control_metadata.h"
#include "core/file_sys/vfs/vfs_real.h"
#include "core/loader/deconstructed_rom_directory.h"

namespace FileSys::Nup {
namespace {

using Json = nlohmann::json;
namespace fs = std::filesystem;

constexpr std::array<u8, 4> Magic{'N', 'U', 'P', 0x01};
constexpr std::array<u8, 4> TocMagic{'T', 'O', 'C', 0x01};
constexpr u64 SuperblockSize = 0x80;
constexpr u64 TocHeaderSize = 0x30;
constexpr u64 PackageRecordSize = 0x40;
constexpr u64 DirRecordSize = 0x18;
constexpr u64 FileRecordSize = 0x50;
constexpr u64 ExtentAlignment = 16;
constexpr u32 NoDir = 0xFFFFFFFF;

constexpr u8 KindBase = 0;
constexpr u8 KindUpdate = 1;
constexpr u8 KindAddon = 2;
constexpr u8 FlagStandaloneUpdate = 0x01;
constexpr u8 CodecRaw = 0;
constexpr u8 CodecZstd = 1;

constexpr u16 TlvNpdm = 0x0001;
constexpr u16 TlvNacp = 0x0002;
constexpr u16 TlvIcon = 0x0003;
constexpr u16 TlvDisplayVersion = 0x0004;
constexpr u16 TlvTitleName = 0x0005;
constexpr u16 TlvPublisher = 0x0006;
constexpr u16 TlvSourceDump = 0x0008;

constexpr int JournalVersion = 1;
constexpr u64 ProgressStep = 64ULL * 1024 * 1024;
constexpr size_t MaxChunkFiles = 4096;
constexpr size_t ReadBufferSize = 4 * 1024 * 1024;

class PackError : public std::runtime_error {
public:
    PackError(PackResult result_, const std::string& message)
        : std::runtime_error(message), result{result_} {}
    PackResult result;
};

u64 AlignUp(u64 value, u64 alignment) {
    return (value + alignment - 1) / alignment * alignment;
}

std::string ToUtf8(const fs::path& path) {
    const auto u8 = path.generic_u8string();
    return {u8.begin(), u8.end()};
}

fs::path FromUtf8(const std::string& value) {
    return fs::path{std::u8string{value.begin(), value.end()}};
}

std::string Lower(std::string value) {
    std::ranges::transform(value, value.begin(),
                           [](unsigned char c) { return static_cast<char>(std::tolower(c)); });
    return value;
}

fs::path WithSuffix(fs::path path, std::string_view suffix) {
    path += suffix;
    return path;
}

bool IsFile(const fs::path& path) {
    std::error_code ec;
    return fs::is_regular_file(path, ec);
}

fs::path FindDirectory(const fs::path& parent, std::string_view name) {
    std::error_code ec;
    if (parent.empty() || !fs::is_directory(parent, ec)) {
        return {};
    }
    const auto wanted = Lower(std::string{name});
    for (const auto& entry : fs::directory_iterator(parent, ec)) {
        if (entry.is_directory(ec) && Lower(ToUtf8(entry.path().filename())) == wanted) {
            return entry.path();
        }
    }
    return {};
}

std::optional<u64> ParseDecimal(const std::string& name) {
    u64 value{};
    const auto* end = name.data() + name.size();
    const auto [ptr, ec] = std::from_chars(name.data(), end, value);
    if (name.empty() || ec != std::errc{} || ptr != end) {
        return std::nullopt;
    }
    return value;
}

// The exefs folder a dump boots from: the newest updates/<version>, else base, else the root.
// Each must hold main, main.npdm and a romfs folder next to it or under base.
bool HasBootableExeFS(const fs::path& root) {
    const auto bootable = [](const fs::path& exefs) {
        return !exefs.empty() && IsFile(exefs / "main") && IsFile(exefs / "main.npdm");
    };
    fs::path exefs;
    std::optional<u64> best_version;
    if (const auto updates = FindDirectory(root, "updates"); !updates.empty()) {
        std::error_code ec;
        for (const auto& entry : fs::directory_iterator(updates, ec)) {
            const auto version = ParseDecimal(ToUtf8(entry.path().filename()));
            const auto candidate = FindDirectory(entry.path(), "exefs");
            if (version && bootable(candidate) && (!best_version || *version > *best_version)) {
                best_version = version;
                exefs = candidate;
            }
        }
    }
    const auto base = FindDirectory(root, "base");
    if (exefs.empty()) {
        exefs = FindDirectory(base, "exefs");
    }
    if (exefs.empty()) {
        exefs = FindDirectory(root, "exefs");
    }
    if (!bootable(exefs)) {
        return false;
    }
    return !FindDirectory(exefs.parent_path(), "romfs").empty() ||
           !FindDirectory(base, "romfs").empty();
}

std::optional<u64> ParseTitleId(const std::string& name) {
    u64 value{};
    const auto* end = name.data() + name.size();
    const auto [ptr, ec] = std::from_chars(name.data(), end, value, 16);
    if (name.size() != 16 || ec != std::errc{} || ptr != end) {
        return std::nullopt;
    }
    return value;
}

std::string ToHex(std::span<const u8> data) {
    static constexpr char digits[] = "0123456789abcdef";
    std::string out;
    out.reserve(data.size() * 2);
    for (const u8 byte : data) {
        out += digits[byte >> 4];
        out += digits[byte & 0xF];
    }
    return out;
}

std::vector<u8> FromHex(const std::string& hex) {
    if (hex.size() % 2 != 0) {
        throw PackError(PackResult::IoError, "malformed journal");
    }
    std::vector<u8> out(hex.size() / 2);
    for (size_t i = 0; i < out.size(); ++i) {
        const auto [ptr, ec] = std::from_chars(hex.data() + i * 2, hex.data() + i * 2 + 2, out[i], 16);
        if (ec != std::errc{} || ptr != hex.data() + i * 2 + 2) {
            throw PackError(PackResult::IoError, "malformed journal");
        }
    }
    return out;
}

std::vector<u8> ReadWholeFile(const fs::path& path) {
    Common::FS::IOFile in{path, Common::FS::FileAccessMode::Read};
    if (!in.IsOpen()) {
        return {};
    }
    std::vector<u8> data(in.GetSize());
    if (in.ReadSpan(std::span{data}) != data.size()) {
        return {};
    }
    return data;
}

// Same as pack.py: the program ID at ACI0 + 0x10, whatever the NPDM header revision.
std::optional<u64> NpdmProgramId(std::span<const u8> npdm) {
    static constexpr std::array<u8, 4> aci0{'A', 'C', 'I', '0'};
    const auto it = std::search(npdm.begin(), npdm.end(), aci0.begin(), aci0.end());
    const auto offset = static_cast<size_t>(it - npdm.begin());
    if (it == npdm.end() || offset + 0x18 > npdm.size()) {
        return std::nullopt;
    }
    u64 id = 0;
    for (size_t i = 0; i < 8; ++i) {
        id |= static_cast<u64>(npdm[offset + 0x10 + i]) << (8 * i);
    }
    return id;
}

void PutLE(std::vector<u8>& buffer, size_t offset, u64 value, size_t bytes) {
    for (size_t i = 0; i < bytes; ++i) {
        buffer[offset + i] = static_cast<u8>(value >> (8 * i));
    }
}

void PutBytes(std::vector<u8>& buffer, size_t offset, std::span<const u8> bytes) {
    std::memcpy(buffer.data() + offset, bytes.data(), bytes.size());
}

using Digest = std::array<u8, 32>;

class Sha256 {
public:
    Sha256() : ctx{EVP_MD_CTX_new()} {
        if (!ctx) {
            throw PackError(PackResult::IoError, "cannot initialise SHA-256");
        }
        Reset();
    }
    ~Sha256() {
        EVP_MD_CTX_free(ctx);
    }
    Sha256(const Sha256&) = delete;
    Sha256& operator=(const Sha256&) = delete;

    void Reset() {
        if (EVP_DigestInit_ex(ctx, EVP_sha256(), nullptr) != 1) {
            throw PackError(PackResult::IoError, "cannot initialise SHA-256");
        }
    }

    void Update(const void* data, size_t size) {
        EVP_DigestUpdate(ctx, data, size);
    }

    Digest Final() {
        Digest digest{};
        unsigned int length{};
        EVP_DigestFinal_ex(ctx, digest.data(), &length);
        return digest;
    }

private:
    EVP_MD_CTX* ctx;
};

class ZstdContext {
public:
    // Archives must be byte-identical across platforms, so compression is always
    // single-threaded (zstd's multithreaded frames differ) and every frame parameter is set
    // explicitly instead of relying on library defaults.
    explicit ZstdContext(int level) : cctx{ZSTD_createCCtx()} {
        if (!cctx || ZSTD_isError(ZSTD_CCtx_setParameter(cctx, ZSTD_c_compressionLevel, level)) ||
            ZSTD_isError(ZSTD_CCtx_setParameter(cctx, ZSTD_c_nbWorkers, 0)) ||
            ZSTD_isError(ZSTD_CCtx_setParameter(cctx, ZSTD_c_contentSizeFlag, 1)) ||
            ZSTD_isError(ZSTD_CCtx_setParameter(cctx, ZSTD_c_checksumFlag, 0)) ||
            ZSTD_isError(ZSTD_CCtx_setParameter(cctx, ZSTD_c_dictIDFlag, 0))) {
            throw PackError(PackResult::IoError, "cannot initialise zstd");
        }
    }
    ~ZstdContext() {
        ZSTD_freeCCtx(cctx);
    }
    ZstdContext(const ZstdContext&) = delete;
    ZstdContext& operator=(const ZstdContext&) = delete;

    // The pledged size makes zstd record the content size in the frame header, which the
    // format requires.
    void Begin(u64 size) {
        if (ZSTD_isError(ZSTD_CCtx_reset(cctx, ZSTD_reset_session_only)) ||
            ZSTD_isError(ZSTD_CCtx_setPledgedSrcSize(cctx, size))) {
            throw PackError(PackResult::IoError, "cannot start zstd frame");
        }
    }

    ZSTD_CCtx* get() const {
        return cctx;
    }

private:
    ZSTD_CCtx* cctx;
};

// One package and the metadata it is written with. The plan is everything that must survive a
// low-storage run deleting its sources, so it is what the journal stores.
struct PlanPackage {
    u8 kind{};
    u8 flags{};
    u64 title_id{};
    u32 version{};
    std::vector<u8> meta;
};

struct PlanEntry {
    u32 package{};
    std::string path;   // inside the package tree, e.g. "romfs/Data/file.bin"
    std::string source; // relative to the dump root
    bool directory{};
};

struct Plan {
    std::vector<PlanPackage> packages;
    std::vector<PlanEntry> entries;
};

struct Extent {
    u64 size{};
    Digest sha256{};
    u64 offset{};
    u64 stored_size{};
    u8 codec{};
};

struct Layout {
    struct Dir {
        std::string name;
        u32 first_child{};
        u32 child_count{};
    };
    struct File {
        std::string name;
        size_t entry{};
    };
    struct Package {
        u32 root_dir{};
        u32 exefs_dir = NoDir;
        u32 romfs_dir = NoDir;
    };
    std::vector<Dir> dirs;
    std::vector<File> files;
    std::vector<u64> children; // FileTag | file index, or dir index
    std::vector<Package> packages;
    std::string pool;
    std::unordered_map<std::string, u32> pool_index;
    u64 toc_size{};
    u64 blob_offset{};

    static constexpr u64 FileTag = 1ULL << 32;

    u32 Intern(const std::string& name) {
        const auto [it, inserted] = pool_index.try_emplace(name, static_cast<u32>(pool.size()));
        if (inserted) {
            pool += name;
        }
        return it->second;
    }
};

// Children sorted by the bytes of their names: std::string compares as unsigned char.
struct TreeDir {
    struct Child {
        std::unique_ptr<TreeDir> dir;
        size_t file_entry{};
    };
    std::string name;
    std::map<std::string, Child> children;

    TreeDir* Descend(const std::string& component) {
        auto& child = children[component];
        if (!child.dir) {
            child.dir = std::make_unique<TreeDir>();
            child.dir->name = component;
        }
        return child.dir.get();
    }
};

// Lays out nodes as pack.py does: directories in pre-order, each directory's child slots
// contiguous, its files numbered in slot order before its subdirectories are visited.
u32 AssignDir(TreeDir& dir, Layout& layout) {
    const auto id = static_cast<u32>(layout.dirs.size());
    layout.dirs.push_back({dir.name, static_cast<u32>(layout.children.size()),
                           static_cast<u32>(dir.children.size())});
    const size_t slot_base = layout.children.size();
    layout.children.resize(slot_base + dir.children.size());
    size_t slot = slot_base;
    for (auto& [name, child] : dir.children) {
        if (!child.dir) {
            layout.children[slot] = Layout::FileTag | layout.files.size();
            layout.files.push_back({name, child.file_entry});
        }
        ++slot;
    }
    slot = slot_base;
    for (auto& [name, child] : dir.children) {
        if (child.dir) {
            layout.children[slot] = AssignDir(*child.dir, layout);
        }
        ++slot;
    }
    return id;
}

Layout BuildLayout(const Plan& plan) {
    std::vector<TreeDir> roots(plan.packages.size());
    for (size_t i = 0; i < plan.entries.size(); ++i) {
        const auto& entry = plan.entries[i];
        TreeDir* dir = &roots.at(entry.package);
        size_t start = 0;
        while (true) {
            const auto slash = entry.path.find('/', start);
            const auto component = entry.path.substr(start, slash - start);
            if (slash == std::string::npos) {
                if (entry.directory) {
                    dir->Descend(component);
                } else {
                    auto& child = dir->children[component];
                    if (child.dir) {
                        throw PackError(PackResult::InvalidSource,
                                        "a file and a folder share the name " + entry.path);
                    }
                    child.file_entry = i;
                }
                break;
            }
            dir = dir->Descend(component);
            start = slash + 1;
        }
    }

    Layout layout;
    for (auto& root : roots) {
        Layout::Package package;
        package.root_dir = AssignDir(root, layout);
        const auto& root_dir = layout.dirs[package.root_dir];
        for (u32 slot = root_dir.first_child; slot < root_dir.first_child + root_dir.child_count;
             ++slot) {
            const u64 child = layout.children[slot];
            if (child & Layout::FileTag) {
                continue;
            }
            const auto id = static_cast<u32>(child);
            if (layout.dirs[id].name == "exefs") {
                package.exefs_dir = id;
            } else if (layout.dirs[id].name == "romfs") {
                package.romfs_dir = id;
            }
        }
        layout.packages.push_back(package);
    }

    if (layout.dirs.size() + layout.files.size() >= NoDir) {
        throw PackError(PackResult::InvalidSource, "the dump has too many files");
    }
    for (const auto& dir : layout.dirs) {
        layout.Intern(dir.name);
    }
    for (const auto& file : layout.files) {
        layout.Intern(file.name);
    }
    if (layout.pool.size() > std::numeric_limits<u32>::max()) {
        throw PackError(PackResult::InvalidSource, "the dump's file names are too long");
    }

    const u64 unpadded = TocHeaderSize + plan.packages.size() * PackageRecordSize +
                         layout.dirs.size() * DirRecordSize + layout.files.size() * FileRecordSize +
                         layout.children.size() * sizeof(u32) + layout.pool.size();
    layout.toc_size = AlignUp(unpadded, ExtentAlignment);
    layout.blob_offset = AlignUp(SuperblockSize + layout.toc_size, ExtentAlignment);
    return layout;
}

std::vector<u8> SerializeTlvs(std::vector<std::pair<u16, std::vector<u8>>> records) {
    std::ranges::stable_sort(records, {}, &std::pair<u16, std::vector<u8>>::first);
    std::vector<u8> out;
    for (const auto& [type, payload] : records) {
        const size_t at = out.size();
        out.resize(at + 8 + payload.size());
        PutLE(out, at, type, 2);
        PutLE(out, at + 4, payload.size(), 4);
        PutBytes(out, at + 8, payload);
    }
    return out;
}

std::vector<u8> StringBytes(const std::string& value) {
    return {value.begin(), value.end()};
}

// The dump's own loader supplies control data and the display version, the same way a loose
// dump reports them when it boots (control.nacp beside it, else the RomFS's version tag).
std::unique_ptr<Loader::AppLoader_DeconstructedRomDirectory> OpenLoader(
    RealVfsFilesystem& vfs, const fs::path& package_dir) {
    const auto exefs = FindDirectory(package_dir, "exefs");
    if (exefs.empty() || !IsFile(exefs / "main")) {
        return nullptr;
    }
    auto main = vfs.OpenFile(Common::FS::PathToUTF8String(exefs / "main"), OpenMode::Read);
    if (!main) {
        return nullptr;
    }
    return std::make_unique<Loader::AppLoader_DeconstructedRomDirectory>(std::move(main));
}

class Discovery {
public:
    Discovery(const fs::path& dump_root_, std::vector<fs::path> excluded_)
        : dump_root{dump_root_}, excluded{std::move(excluded_)} {}

    Plan Run() {
        const auto base = FindDirectory(dump_root, "base");
        const auto updates = FindDirectory(dump_root, "updates");
        const auto dlc = FindDirectory(dump_root, "dlc");

        std::optional<u64> base_title_id;
        if (!base.empty() && HasContent(base)) {
            base_title_id = AddPackage(KindBase, base, 0, {});
        } else if (updates.empty() && HasContent(dump_root)) {
            base_title_id = AddPackage(KindBase, dump_root, 0, {"base", "updates", "dlc"});
        }

        std::vector<std::pair<u64, fs::path>> versions;
        std::error_code ec;
        if (!updates.empty()) {
            for (const auto& entry : fs::directory_iterator(updates, ec)) {
                const auto version = ParseDecimal(ToUtf8(entry.path().filename()));
                if (version && entry.is_directory(ec) && HasContent(entry.path())) {
                    if (*version > std::numeric_limits<u32>::max()) {
                        throw PackError(PackResult::InvalidSource,
                                        "update version out of range: " + ToUtf8(entry.path()));
                    }
                    versions.emplace_back(*version, entry.path());
                }
            }
        }
        std::ranges::sort(versions);
        const u8 update_flags = base_title_id ? 0 : FlagStandaloneUpdate;
        for (const auto& [version, path] : versions) {
            AddPackage(KindUpdate, path, static_cast<u32>(version), {}, update_flags,
                       base_title_id.value_or(0));
        }

        if (!dlc.empty()) {
            std::vector<std::pair<std::string, fs::path>> addons;
            for (const auto& title : fs::directory_iterator(dlc, ec)) {
                const auto title_name = ToUtf8(title.path().filename());
                if (!ParseTitleId(title_name) || !title.is_directory(ec)) {
                    continue;
                }
                for (const auto& content : fs::directory_iterator(title.path(), ec)) {
                    if (content.is_directory(ec) && HasContent(content.path())) {
                        addons.emplace_back(title_name + "/" + ToUtf8(content.path().filename()),
                                            content.path());
                    }
                }
            }
            std::ranges::sort(addons);
            for (const auto& [name, path] : addons) {
                AddPackage(KindAddon, path, 0, {}, 0, *ParseTitleId(name.substr(0, 16)));
            }
        }

        if (plan.packages.empty()) {
            throw PackError(PackResult::InvalidSource, "no packages found in the dump");
        }
        AddApplicationMetadata();
        for (size_t i = 0; i < plan.packages.size(); ++i) {
            auto& tlvs = package_tlvs[i];
            tlvs.emplace_back(TlvSourceDump, StringBytes(ToUtf8(dump_root.filename())));
            plan.packages[i].meta = SerializeTlvs(std::move(tlvs));
        }
        return std::move(plan);
    }

private:
    static bool HasContent(const fs::path& dir) {
        return !FindDirectory(dir, "exefs").empty() || !FindDirectory(dir, "romfs").empty();
    }

    // Returns the package's title ID: the NPDM program ID, else the folder's or base's.
    u64 AddPackage(u8 kind, const fs::path& dir, u32 version,
                   const std::vector<std::string>& skip, u8 flags = 0, u64 fallback_id = 0) {
        const auto index = static_cast<u32>(plan.packages.size());
        PlanPackage package{kind, flags, fallback_id, version, {}};
        auto& tlvs = package_tlvs.emplace_back();

        const auto exefs = FindDirectory(dir, "exefs");
        const auto romfs = FindDirectory(dir, "romfs");
        fs::path npdm_path = exefs.empty() ? fs::path{} : exefs / "main.npdm";
        if (!IsFile(npdm_path)) {
            npdm_path = dir / "main.npdm";
        }
        if (IsFile(npdm_path)) {
            auto npdm = ReadWholeFile(npdm_path);
            if (const auto id = NpdmProgramId(npdm); kind != KindAddon && id && *id != 0) {
                package.title_id = *id;
            }
            tlvs.emplace_back(TlvNpdm, std::move(npdm));
        }

        if (kind != KindAddon) {
            if (auto loader = OpenLoader(vfs, dir)) {
                std::string display_version;
                if (loader->ReadDisplayVersion(display_version) == Loader::ResultStatus::Success &&
                    !display_version.empty()) {
                    tlvs.emplace_back(TlvDisplayVersion, StringBytes(display_version));
                }
                loaders.emplace_back(index, std::move(loader));
            }
        }
        plan.packages.push_back(std::move(package));

        if (!exefs.empty()) {
            CollectTree(index, exefs, "exefs");
        }
        if (!romfs.empty()) {
            CollectTree(index, romfs, "romfs");
        }
        std::error_code ec;
        for (const auto& entry : fs::directory_iterator(dir, ec)) {
            const auto name = ToUtf8(entry.path().filename());
            const auto lower = Lower(name);
            if (entry.path() == exefs || entry.path() == romfs ||
                std::ranges::find(skip, lower) != skip.end()) {
                continue;
            }
            if (entry.is_directory(ec)) {
                CollectTree(index, entry.path(), "data/" + name);
            } else {
                AddFile(index, entry, "data/" + name);
            }
        }
        return plan.packages.back().title_id;
    }

    // Names, icon and control data belong to the base package, or the first one without a base.
    // Our dumps rarely carry a control folder; when one does, the base's own wins, then updates.
    void AddApplicationMetadata() {
        const auto app = static_cast<u32>(std::distance(
            plan.packages.begin(), std::ranges::find(plan.packages, KindBase, &PlanPackage::kind)));
        const u32 target = app < plan.packages.size() ? app : 0;
        std::ranges::stable_sort(loaders, [target](const auto& a, const auto& b) {
            return (a.first == target) > (b.first == target);
        });

        auto& tlvs = package_tlvs[target];
        bool have_control = false;
        bool have_icon = false;
        for (const auto& [index, loader] : loaders) {
            NACP control;
            if (!have_control &&
                loader->ReadControlData(control) == Loader::ResultStatus::Success) {
                have_control = true;
                tlvs.emplace_back(TlvNacp, control.GetRawBytes());
                if (const auto name = control.GetApplicationName(); !name.empty()) {
                    tlvs.emplace_back(TlvTitleName, StringBytes(name));
                }
                if (const auto publisher = control.GetDeveloperName(); !publisher.empty()) {
                    tlvs.emplace_back(TlvPublisher, StringBytes(publisher));
                }
            }
            std::vector<u8> icon;
            if (!have_icon && loader->ReadIcon(icon) == Loader::ResultStatus::Success &&
                !icon.empty()) {
                have_icon = true;
                tlvs.emplace_back(TlvIcon, std::move(icon));
            }
        }
    }

    bool IsExcluded(const fs::path& path) const {
        const auto normal = fs::absolute(path).lexically_normal();
        return std::ranges::find(excluded, normal) != excluded.end();
    }

    void AddFile(u32 package, const fs::directory_entry& entry, const std::string& path) {
        std::error_code ec;
        if (entry.is_symlink(ec)) {
            throw PackError(PackResult::InvalidSource,
                            "symlinks are not supported: " + ToUtf8(entry.path()));
        }
        if (!entry.is_regular_file(ec)) {
            throw PackError(PackResult::InvalidSource,
                            "unsupported file type: " + ToUtf8(entry.path()));
        }
        // Dump-tool listings are excluded by the spec.
        if (entry.path().filename() == ".listing" || IsExcluded(entry.path())) {
            return;
        }
        plan.entries.push_back({package, path, Relative(entry.path()), false});
    }

    void CollectTree(u32 package, const fs::path& root, const std::string& prefix) {
        plan.entries.push_back({package, prefix, Relative(root), true});
        for (auto it = fs::recursive_directory_iterator(root);
             it != fs::recursive_directory_iterator(); ++it) {
            const auto& entry = *it;
            const auto path = prefix + "/" + ToUtf8(fs::relative(entry.path(), root));
            if (!entry.is_symlink() && entry.is_directory()) {
                plan.entries.push_back({package, path, Relative(entry.path()), true});
            } else {
                AddFile(package, entry, path);
            }
        }
    }

    std::string Relative(const fs::path& path) const {
        return ToUtf8(fs::relative(path, dump_root));
    }

    fs::path dump_root;
    std::vector<fs::path> excluded;
    RealVfsFilesystem vfs;
    Plan plan;
    std::vector<std::vector<std::pair<u16, std::vector<u8>>>> package_tlvs;
    std::vector<std::pair<u32, std::unique_ptr<Loader::AppLoader_DeconstructedRomDirectory>>>
        loaders;
};

Json PlanToJson(const Plan& plan) {
    Json packages = Json::array();
    for (const auto& package : plan.packages) {
        packages.push_back(Json{{"kind", package.kind},
                                {"flags", package.flags},
                                {"title_id", package.title_id},
                                {"version", package.version},
                                {"meta", ToHex(package.meta)}});
    }
    Json entries = Json::array();
    for (const auto& entry : plan.entries) {
        entries.push_back(Json{{"package", entry.package},
                               {"path", entry.path},
                               {"source", entry.source},
                               {"directory", entry.directory}});
    }
    return Json{{"format", "nup-journal"},
                {"version", JournalVersion},
                {"packages", packages},
                {"entries", entries}};
}

Plan PlanFromJson(const Json& json) {
    if (json.at("format") != "nup-journal" || json.at("version") != JournalVersion) {
        throw PackError(PackResult::IoError, "unsupported journal");
    }
    Plan plan;
    for (const auto& package : json.at("packages")) {
        plan.packages.push_back({package.at("kind").get<u8>(), package.at("flags").get<u8>(),
                                 package.at("title_id").get<u64>(),
                                 package.at("version").get<u32>(),
                                 FromHex(package.at("meta").get<std::string>())});
    }
    for (const auto& entry : json.at("entries")) {
        plan.entries.push_back({entry.at("package").get<u32>(), entry.at("path").get<std::string>(),
                                entry.at("source").get<std::string>(),
                                entry.at("directory").get<bool>()});
    }
    return plan;
}

void RemoveFile(const fs::path& path) {
    std::error_code ec;
    fs::remove(path, ec);
}

bool IsEmptyDirectory(const fs::path& path) {
    std::error_code ec;
    return fs::is_directory(path, ec) && fs::is_empty(path, ec) && !ec;
}

void RemoveEmptyTree(const fs::path& root) {
    std::error_code ec;
    std::vector<fs::path> directories;
    for (auto it = fs::recursive_directory_iterator(root, ec);
         !ec && it != fs::recursive_directory_iterator(); it.increment(ec)) {
        if (it->is_directory(ec)) {
            directories.push_back(it->path());
        }
    }
    for (auto it = directories.rbegin(); it != directories.rend(); ++it) {
        if (IsEmptyDirectory(*it)) {
            fs::remove(*it, ec);
        }
    }
    if (IsEmptyDirectory(root)) {
        fs::remove(root, ec);
    }
}

void RemoveEmptyParents(fs::path path, const fs::path& dump_root) {
    while (!path.empty() && path.has_relative_path()) {
        std::error_code ec;
        if (fs::equivalent(path, dump_root, ec) || ec || !IsEmptyDirectory(path)) {
            break;
        }
        fs::remove(path, ec);
        path = path.parent_path();
    }
}

class Packer {
public:
    Packer(const fs::path& dump_root_, const fs::path& archive_, const PackOptions& options_,
           const std::function<void(const PackProgress&)>& progress_,
           const std::atomic_bool* cancel_)
        : dump_root{dump_root_}, archive{archive_}, part{WithSuffix(archive_, ".part")},
          journal{WithSuffix(archive_, ".journal")}, options{options_}, progress_cb{progress_},
          cancel{cancel_} {}

    PackResult Run() {
        std::error_code ec;
        if (fs::exists(archive, ec)) {
            throw PackError(PackResult::IoError, "archive already exists: " + ToUtf8(archive));
        }
        // A journal without a complete plan line was cut short before anything was deleted.
        const bool resume =
            options.delete_sources && HasResumableJournal(archive) && LoadJournal();
        if (resume) {
            OpenForResume();
        } else {
            if (!IsLooseDump(dump_root)) {
                throw PackError(PackResult::InvalidSource,
                                "expected exefs/main, exefs/main.npdm and a romfs folder");
            }
            std::vector<fs::path> excluded;
            for (const auto& path : {archive, part, journal}) {
                excluded.push_back(fs::absolute(path).lexically_normal());
            }
            plan = Discovery{dump_root, std::move(excluded)}.Run();
            layout = BuildLayout(plan);
            OpenNew();
        }
        extents.resize(layout.files.size());
        done.resize(layout.files.size());
        for (const auto& [index, extent] : journaled) {
            extents[index] = extent;
            done[index] = true;
            Remember(extent);
        }
        CountTotals();
        Report();

        for (size_t i = 0; i < layout.files.size(); ++i) {
            if (done[i]) {
                continue;
            }
            PackFile(i);
            if (options.delete_sources &&
                (chunk_bytes >= options.chunk_bytes || chunk.size() >= MaxChunkFiles)) {
                Checkpoint();
            }
        }
        if (options.delete_sources) {
            Checkpoint();
        }

        Finish();
        out.Close();
        fs::rename(part, archive, ec);
        if (ec) {
            throw PackError(PackResult::IoError, "cannot rename archive: " + ec.message());
        }

        if (options.delete_sources) {
            RemoveFile(journal);
            RemoveSourceFolders();
        }
        return PackResult::Success;
    }

    void Abort() {
        out.Close();
        if (!options.delete_sources) {
            RemoveFile(part);
        }
    }

private:
    void OpenNew() {
        RemoveFile(journal);
        out.Open(part, Common::FS::FileAccessMode::Write);
        if (!out.IsOpen()) {
            throw PackError(PackResult::IoError, "cannot create " + ToUtf8(part));
        }
        WriteZeros(layout.blob_offset);
        cursor = layout.blob_offset;
        if (options.delete_sources) {
            AppendJournal(PlanToJson(plan).dump() + '\n');
        }
    }

    bool LoadJournal() {
        const auto contents =
            Common::FS::ReadStringFromFile(journal, Common::FS::FileType::BinaryFile);
        size_t start = 0;
        bool have_plan = false;
        while (start < contents.size()) {
            const auto line_end = contents.find('\n', start);
            if (line_end == std::string::npos) {
                break;
            }
            const auto line = std::string_view{contents}.substr(start, line_end - start);
            start = line_end + 1;
            Json json;
            try {
                json = Json::parse(line);
            } catch (const Json::exception&) {
                // Only the tail can be torn: the journal is synced before sources are deleted.
                break;
            }
            if (!have_plan) {
                plan = PlanFromJson(json);
                layout = BuildLayout(plan);
                resume_end = layout.blob_offset;
                have_plan = true;
                continue;
            }
            const auto index = json.at("file").get<size_t>();
            const auto sha = FromHex(json.at("sha256").get<std::string>());
            if (index >= layout.files.size() || sha.size() != 32) {
                throw PackError(PackResult::IoError, "malformed journal");
            }
            Extent extent{json.at("size").get<u64>(), {}, json.at("offset").get<u64>(),
                          json.at("stored_size").get<u64>(), json.at("codec").get<u8>()};
            std::ranges::copy(sha, extent.sha256.begin());
            resume_end = std::max(resume_end, extent.offset + extent.stored_size);
            journaled.emplace_back(index, extent);
        }
        return have_plan;
    }

    void OpenForResume() {
        const u64 end = resume_end;
        out.Open(part, Common::FS::FileAccessMode::ReadWrite);
        if (!out.IsOpen()) {
            throw PackError(PackResult::IoError, "cannot open " + ToUtf8(part));
        }
        if (out.GetSize() < end) {
            throw PackError(PackResult::IoError, "partial archive is shorter than its journal; "
                                                 "delete " +
                                                     ToUtf8(part) + " and " + ToUtf8(journal) +
                                                     " to start over");
        }
        if (!out.SetSize(end) || !out.Seek(static_cast<s64>(end))) {
            throw PackError(PackResult::IoError, "cannot truncate " + ToUtf8(part));
        }
        cursor = end;

        // Journaled before an interruption, but the delete never happened.
        for (const auto& [index, extent] : journaled) {
            RemoveFile(SourceOf(index));
        }
    }

    fs::path SourceOf(size_t file_index) const {
        return dump_root / FromUtf8(plan.entries[layout.files[file_index].entry].source);
    }

    void CountTotals() {
        for (size_t i = 0; i < layout.files.size(); ++i) {
            ++progress.files_total;
            if (done[i]) {
                progress.bytes_total += extents[i].size;
                progress.bytes_done += extents[i].size;
                ++progress.files_done;
            } else {
                std::error_code ec;
                const auto size = fs::file_size(SourceOf(i), ec);
                if (ec) {
                    throw PackError(PackResult::InvalidSource,
                                    "missing source file: " + ToUtf8(SourceOf(i)));
                }
                progress.bytes_total += size;
            }
        }
    }

    void Remember(const Extent& extent) {
        if (extent.size == 0) {
            return;
        }
        sizes_seen.insert(extent.size);
        by_hash.try_emplace(extent.sha256, extent);
    }

    bool Cancelled() const {
        return cancel && cancel->load();
    }

    void WriteZeros(u64 count) {
        static constexpr std::array<u8, 4096> zeros{};
        while (count > 0) {
            const auto n = static_cast<size_t>(std::min<u64>(count, zeros.size()));
            Write(zeros.data(), n);
            count -= n;
        }
    }

    void Write(const u8* data, size_t size) {
        if (out.WriteSpan(std::span<const u8>{data, size}) != size) {
            throw PackError(PackResult::IoError, "write failed, the disk may be full");
        }
    }

    void AddProgress(u64 bytes) {
        progress.bytes_done += bytes;
        if (progress.bytes_done - last_report >= ProgressStep) {
            Report();
        }
    }

    // Reads the whole source through `sink`, checking that it still has the expected size. A file
    // read more than once (hashed for dedup, or compressed and then stored raw) counts once.
    template <typename Sink>
    void ReadSource(Common::FS::IOFile& in, u64 size, Sink&& sink) {
        if (!in.Seek(0)) {
            throw PackError(PackResult::IoError, "cannot seek source");
        }
        buffer.resize(ReadBufferSize);
        u64 total = 0;
        while (true) {
            if (Cancelled()) {
                throw PackError(PackResult::Cancelled, "cancelled");
            }
            const auto read = in.ReadSpan(std::span{buffer});
            if (read == 0) {
                break;
            }
            total += read;
            if (total > size) {
                break;
            }
            if (total > file_counted) {
                AddProgress(total - file_counted);
                file_counted = total;
            }
            if (!sink(buffer.data(), read)) {
                return;
            }
        }
        if (total != size) {
            throw PackError(PackResult::IoError, "a source file changed while packing");
        }
    }

    Digest HashSource(Common::FS::IOFile& in, u64 size) {
        hash.Reset();
        ReadSource(in, size, [this](const u8* data, size_t n) {
            hash.Update(data, n);
            return true;
        });
        return hash.Final();
    }

    ZstdContext& Compressor() {
        if (!compressor) {
            compressor = std::make_unique<ZstdContext>(options.zstd_level);
        }
        return *compressor;
    }

    // Streams one zstd frame into the archive. Gives up (returns false) as soon as the output is
    // no smaller than the input.
    bool WriteCompressed(Common::FS::IOFile& in, u64 size, u64& stored) {
        auto& zstd = Compressor();
        zstd.Begin(size);
        out_buffer.resize(ZSTD_CStreamOutSize());
        stored = 0;
        bool fits = true;
        const auto drain = [&](ZSTD_inBuffer& input, ZSTD_EndDirective mode) {
            while (true) {
                ZSTD_outBuffer output{out_buffer.data(), out_buffer.size(), 0};
                const size_t remaining = ZSTD_compressStream2(zstd.get(), &output, &input, mode);
                if (ZSTD_isError(remaining)) {
                    throw PackError(PackResult::IoError,
                                    std::string{"zstd: "} + ZSTD_getErrorName(remaining));
                }
                stored += output.pos;
                if (stored >= size) {
                    return false;
                }
                Write(out_buffer.data(), output.pos);
                const bool finished = mode == ZSTD_e_end ? remaining == 0
                                                         : input.pos == input.size;
                if (finished) {
                    return true;
                }
            }
        };
        hash.Reset();
        ReadSource(in, size, [&](const u8* data, size_t n) {
            hash.Update(data, n);
            ZSTD_inBuffer input{data, n, 0};
            fits = drain(input, ZSTD_e_continue);
            return fits;
        });
        if (!fits) {
            return false;
        }
        ZSTD_inBuffer empty{nullptr, 0, 0};
        return drain(empty, ZSTD_e_end);
    }

    void PackFile(size_t index) {
        const auto source = SourceOf(index);
        Common::FS::IOFile in{source, Common::FS::FileAccessMode::Read};
        if (!in.IsOpen()) {
            throw PackError(PackResult::IoError, "cannot read " + ToUtf8(source));
        }
        Extent extent;
        extent.size = in.GetSize();
        file_counted = 0;

        std::optional<Digest> known_hash;
        if (extent.size == 0) {
            known_hash = HashSource(in, 0);
        } else if (sizes_seen.contains(extent.size)) {
            // Only a file whose size matches an earlier extent can be a duplicate; hash it before
            // writing anything so the shared extent costs no output.
            known_hash = HashSource(in, extent.size);
            if (const auto it = by_hash.find(*known_hash);
                it != by_hash.end() && it->second.size == extent.size) {
                extent = it->second;
                Complete(index, extent);
                return;
            }
        }

        if (extent.size == 0) {
            extent.sha256 = *known_hash;
            Complete(index, extent);
            return;
        }

        const u64 start = AlignUp(cursor, ExtentAlignment);
        Seek(cursor);
        WriteZeros(start - cursor);
        extent.offset = start;

        bool compressed = false;
        if (extent.size <= options.raw_threshold && options.zstd_level > 0) {
            u64 stored = 0;
            compressed = WriteCompressed(in, extent.size, stored);
            if (compressed) {
                extent.codec = CodecZstd;
                extent.stored_size = stored;
                extent.sha256 = hash.Final();
            }
        }
        if (!compressed) {
            Seek(start);
            hash.Reset();
            ReadSource(in, extent.size, [this](const u8* data, size_t n) {
                hash.Update(data, n);
                Write(data, n);
                return true;
            });
            extent.codec = CodecRaw;
            extent.stored_size = extent.size;
            extent.sha256 = hash.Final();
        }
        cursor = start + extent.stored_size;
        Remember(extent);
        Complete(index, extent);
    }

    void Seek(u64 offset) {
        if (!out.Seek(static_cast<s64>(offset))) {
            throw PackError(PackResult::IoError, "cannot seek " + ToUtf8(part));
        }
    }

    void Complete(size_t index, const Extent& extent) {
        extents[index] = extent;
        done[index] = true;
        if (options.delete_sources) {
            chunk.push_back(index);
            chunk_bytes += extent.size;
        }
        ++progress.files_done;
        Report();
    }

    void AppendJournal(const std::string& lines) {
        Common::FS::IOFile log{journal, Common::FS::FileAccessMode::Append};
        if (!log.IsOpen() || log.WriteString(lines) != lines.size() || !log.Commit()) {
            throw PackError(PackResult::IoError, "cannot write " + ToUtf8(journal));
        }
    }

    // Archive data first, then the journal, then the deletes, so an interruption loses nothing.
    void Checkpoint() {
        if (chunk.empty()) {
            return;
        }
        if (!out.Commit()) {
            throw PackError(PackResult::IoError, "cannot sync " + ToUtf8(part));
        }
        std::string lines;
        for (const auto index : chunk) {
            const auto& extent = extents[index];
            lines += Json{{"file", index},
                          {"size", extent.size},
                          {"sha256", ToHex(extent.sha256)},
                          {"offset", extent.offset},
                          {"stored_size", extent.stored_size},
                          {"codec", extent.codec}}
                         .dump();
            lines += '\n';
        }
        AppendJournal(lines);
        for (const auto index : chunk) {
            RemoveFile(SourceOf(index));
        }
        chunk.clear();
        chunk_bytes = 0;
    }

    void Finish() {
        // Meta blocks follow the last extent, as pack.py writes them.
        Seek(cursor);
        std::vector<std::pair<u64, u32>> meta;
        for (const auto& package : plan.packages) {
            if (package.meta.size() > std::numeric_limits<u32>::max()) {
                throw PackError(PackResult::IoError, "package metadata is too large");
            }
            meta.emplace_back(package.meta.empty() ? 0 : cursor,
                              static_cast<u32>(package.meta.size()));
            Write(package.meta.data(), package.meta.size());
            cursor += package.meta.size();
        }
        const u64 file_size = cursor;

        const auto toc = BuildToc(meta);
        std::array<u8, 32> toc_hash{};
        unsigned int hash_length{};
        EVP_Digest(toc.data(), toc.size(), toc_hash.data(), &hash_length, EVP_sha256(), nullptr);

        // UUID: SHA-256 over title_id (u64), version (u32) and kind (u8) of each package.
        Sha256 uuid_hash;
        for (const auto& package : plan.packages) {
            std::vector<u8> identity(13);
            PutLE(identity, 0, package.title_id, 8);
            PutLE(identity, 8, package.version, 4);
            identity[12] = package.kind;
            uuid_hash.Update(identity.data(), identity.size());
        }
        const auto uuid = uuid_hash.Final();

        std::vector<u8> super(SuperblockSize);
        PutBytes(super, 0x00, Magic);
        PutLE(super, 0x04, SuperblockSize, 2);
        PutLE(super, 0x06, 1, 2);
        PutLE(super, 0x08, SuperblockSize, 8);
        PutLE(super, 0x10, toc.size(), 8);
        PutBytes(super, 0x18, toc_hash);
        PutLE(super, 0x38, layout.blob_offset, 8);
        PutLE(super, 0x40, file_size, 8);
        PutLE(super, 0x48, plan.packages.size(), 4);
        PutBytes(super, 0x50, std::span{uuid}.first(16));

        Seek(0);
        Write(super.data(), super.size());
        Write(toc.data(), toc.size());
        if (!out.SetSize(file_size) || !out.Commit()) {
            throw PackError(PackResult::IoError, "cannot finish " + ToUtf8(part));
        }
    }

    // Every field is written little-endian at its documented offset. The package record is
    // 0x40 bytes with 20 reserved bytes at 0x2C, as NupContainer reads it.
    std::vector<u8> BuildToc(const std::vector<std::pair<u64, u32>>& meta) const {
        std::vector<u8> toc(layout.toc_size);
        const u64 dir_count = layout.dirs.size();
        PutBytes(toc, 0x00, TocMagic);
        PutLE(toc, 0x04, plan.packages.size(), 4);
        PutLE(toc, 0x08, dir_count, 8);
        PutLE(toc, 0x10, layout.files.size(), 8);

        size_t pos = TocHeaderSize;
        for (size_t i = 0; i < plan.packages.size(); ++i) {
            const auto& package = plan.packages[i];
            const auto& record = layout.packages[i];
            PutLE(toc, pos + 0x00, package.title_id, 8);
            PutLE(toc, pos + 0x08, record.root_dir, 4);
            PutLE(toc, pos + 0x0C, record.exefs_dir, 4);
            PutLE(toc, pos + 0x10, record.romfs_dir, 4);
            PutLE(toc, pos + 0x14, package.version, 4);
            toc[pos + 0x18] = package.kind;
            toc[pos + 0x19] = package.flags;
            PutLE(toc, pos + 0x20, meta[i].first, 8);
            PutLE(toc, pos + 0x28, meta[i].second, 4);
            pos += PackageRecordSize;
        }
        for (const auto& dir : layout.dirs) {
            PutLE(toc, pos + 0x00, layout.pool_index.at(dir.name), 4);
            PutLE(toc, pos + 0x04, dir.name.size(), 4);
            PutLE(toc, pos + 0x08, dir.first_child, 4);
            PutLE(toc, pos + 0x0C, dir.child_count, 4);
            pos += DirRecordSize;
        }
        for (size_t i = 0; i < layout.files.size(); ++i) {
            const auto& file = layout.files[i];
            const auto& extent = extents[i];
            PutLE(toc, pos + 0x00, layout.pool_index.at(file.name), 4);
            PutLE(toc, pos + 0x04, file.name.size(), 4);
            PutLE(toc, pos + 0x08, extent.size, 8);
            // Empty files have no extent: offset, size and codec are all zero.
            if (extent.size != 0) {
                PutLE(toc, pos + 0x10, extent.offset, 8);
                PutLE(toc, pos + 0x18, extent.stored_size, 8);
                toc[pos + 0x40] = extent.codec;
            }
            PutBytes(toc, pos + 0x20, extent.sha256);
            pos += FileRecordSize;
        }
        for (const u64 child : layout.children) {
            const u64 id = (child & Layout::FileTag) ? dir_count + static_cast<u32>(child) : child;
            PutLE(toc, pos, id, 4);
            pos += sizeof(u32);
        }
        PutLE(toc, 0x18, pos, 8);
        PutLE(toc, 0x20, layout.pool.size(), 8);
        std::memcpy(toc.data() + pos, layout.pool.data(), layout.pool.size());
        return toc;
    }

    void RemoveSourceFolders() {
        for (const auto& entry : plan.entries) {
            const auto depth = std::ranges::count(entry.path, '/');
            const bool top = entry.directory &&
                             (depth == 0 || (depth == 1 && entry.path.starts_with("data/")));
            if (top) {
                const auto source = dump_root / FromUtf8(entry.source);
                RemoveEmptyTree(source);
                RemoveEmptyParents(source.parent_path(), dump_root);
            }
        }
    }

    void Report() {
        last_report = progress.bytes_done;
        if (progress_cb) {
            progress_cb(progress);
        }
    }

    fs::path dump_root;
    fs::path archive;
    fs::path part;
    fs::path journal;
    PackOptions options;
    std::function<void(const PackProgress&)> progress_cb;
    const std::atomic_bool* cancel;

    Plan plan;
    Layout layout;
    std::vector<Extent> extents;
    std::vector<bool> done;
    std::vector<std::pair<size_t, Extent>> journaled;

    struct DigestHash {
        size_t operator()(const Digest& digest) const {
            size_t value;
            std::memcpy(&value, digest.data(), sizeof(value));
            return value;
        }
    };
    std::unordered_map<Digest, Extent, DigestHash> by_hash;
    std::unordered_set<u64> sizes_seen;

    Common::FS::IOFile out;
    u64 cursor = 0;
    u64 resume_end = 0;
    std::vector<size_t> chunk;
    u64 chunk_bytes = 0;
    std::vector<u8> buffer;
    std::vector<u8> out_buffer;
    Sha256 hash;
    std::unique_ptr<ZstdContext> compressor;
    PackProgress progress{};
    u64 last_report = 0;
    u64 file_counted = 0;
};

} // namespace

bool IsLooseDump(const fs::path& dir) {
    return HasBootableExeFS(dir);
}

std::optional<fs::path> DumpRootFromMain(const fs::path& main) {
    // The Qt game list stores the exefs folder rather than exefs/main.
    std::error_code ec;
    const auto exefs = fs::is_directory(main, ec) ? main : main.parent_path();
    if (Lower(ToUtf8(exefs.filename())) != "exefs") {
        return std::nullopt;
    }
    auto root = exefs.parent_path();
    const auto name = Lower(ToUtf8(root.filename()));
    if (name == "base") {
        root = root.parent_path();
    } else if (ParseDecimal(name) && Lower(ToUtf8(root.parent_path().filename())) == "updates") {
        root = root.parent_path().parent_path();
    }
    if (!IsLooseDump(root)) {
        return std::nullopt;
    }
    return root;
}

fs::path DefaultArchivePath(const fs::path& dump_root) {
    auto root = dump_root;
    if (!root.has_filename()) {
        root = root.parent_path();
    }
    return root.parent_path() / (root.filename().u8string() + u8".nup");
}

bool HasResumableJournal(const fs::path& archive) {
    std::error_code ec;
    return fs::exists(WithSuffix(archive, ".part"), ec) &&
           fs::exists(WithSuffix(archive, ".journal"), ec);
}

PackResult PackDump(const fs::path& dump_root, const fs::path& archive, const PackOptions& options,
                    const std::function<void(const PackProgress&)>& progress,
                    const std::atomic_bool* cancel, std::string* error_out) {
    Packer packer{dump_root, archive, options, progress, cancel};
    try {
        return packer.Run();
    } catch (const PackError& e) {
        packer.Abort();
        if (error_out) {
            *error_out = e.what();
        }
        return e.result;
    } catch (const std::exception& e) {
        packer.Abort();
        if (error_out) {
            *error_out = e.what();
        }
        return PackResult::IoError;
    }
}

} // namespace FileSys::Nup