Atmosphere/stratosphere/loader/source/ldr_nso.hpp

/*
 * Copyright (c) 2018-2019 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 <switch.h>
#include <cstdio>

#include "ldr_content_management.hpp" /* for ExternalContentSource */

#define MAGIC_NSO0 0x304F534E
#define NSO_NUM_MAX 13

class NsoUtils {
    public:
        struct NsoSegment {
            u32 file_offset;
            u32 dst_offset;
            u32 decomp_size;
            u32 align_or_total_size;
        };
        
        struct NsoHeader {
            u32 magic;
            u32 _0x4;
            u32 _0x8;
            u32 flags;
            NsoSegment segments[3];
            u8 build_id[0x20];
            u32 compressed_sizes[3];
            u8 _0x6C[0x24];
            u64 dynstr_extents;
            u64 dynsym_extents;
            u8 section_hashes[3][0x20];
        };
        
        struct NsoLoadExtents {
            u64 base_address;
            u64 total_size;
            u64 args_address;
            u64 args_size;
            u64 nso_addresses[NSO_NUM_MAX];
            u64 nso_sizes[NSO_NUM_MAX];
        };
        
        struct NsoArgument {
            u32 allocated_space;
            u32 args_size;
            u8  _0x8[0x18];
            u8  arguments[];
        };
        
        
        static_assert(sizeof(NsoHeader) == 0x100, "Incorrectly defined NsoHeader!");
        
        static const char *GetNsoFileName(unsigned int index) {
            switch (index) {
                case 0:
                    return "rtld";
                case 1:
                    return "main";
                case 2:
                    return "subsdk0";
                case 3:
                    return "subsdk1";
                case 4:
                    return "subsdk2";
                case 5:
                    return "subsdk3";
                case 6:
                    return "subsdk4";
                case 7:
                    return "subsdk5";
                case 8:
                    return "subsdk6";
                case 9:
                    return "subsdk7";
                case 10:
                    return "subsdk8";
                case 11:
                    return "subsdk9";
                case 12:
                    return "sdk";
                default:
                    /* TODO: Panic. */
                    return "?";
            }
        }

        static FILE *OpenNsoFromECS(unsigned int index, ContentManagement::ExternalContentSource *ecs);
        static FILE *OpenNsoFromHBL(unsigned int index);
        static FILE *OpenNsoFromExeFS(unsigned int index);
        static FILE *OpenNsoFromSdCard(unsigned int index, u64 title_id);
        static bool CheckNsoStubbed(unsigned int index, u64 title_id);
        static FILE *OpenNso(unsigned int index, u64 title_id);
        
        static bool IsNsoPresent(unsigned int index);
        static unsigned char *GetNsoBuildId(unsigned int index);
        static Result LoadNsoHeaders(u64 title_id);
        static Result ValidateNsoLoadSet();
        static Result CalculateNsoLoadExtents(u32 addspace_type, u32 args_size, NsoLoadExtents *extents);
        
        static Result LoadNsoSegment(u64 title_id, unsigned int index, unsigned int segment, FILE *f_nso, u8 *map_base, u8 *map_end);
        static Result LoadNsosIntoProcessMemory(Handle process_h, u64 title_id, NsoLoadExtents *extents, u8 *args, u32 args_size);
};