Improve bootimg const correctness

This commit is contained in:
topjohnwu 2023-06-03 05:10:22 -07:00
parent 2a654e5d7f
commit 305e8b3d14
4 changed files with 99 additions and 79 deletions

View File

@ -9,13 +9,9 @@
#include "bootimg.hpp" #include "bootimg.hpp"
#include "magiskboot.hpp" #include "magiskboot.hpp"
#include "compress.hpp" #include "compress.hpp"
#include "boot-rs.hpp"
using namespace std; using namespace std;
uint32_t dyn_img_hdr::j32 = 0;
uint64_t dyn_img_hdr::j64 = 0;
#define PADDING 15 #define PADDING 15
static void decompress(format_t type, int fd, const void *in, size_t size) { static void decompress(format_t type, int fd, const void *in, size_t size) {
@ -50,10 +46,10 @@ static size_t restore(int fd, const char *filename) {
return size; return size;
} }
void dyn_img_hdr::print() { void dyn_img_hdr::print() const {
uint32_t ver = header_version(); uint32_t ver = header_version();
fprintf(stderr, "%-*s [%u]\n", PADDING, "HEADER_VER", ver); fprintf(stderr, "%-*s [%u]\n", PADDING, "HEADER_VER", ver);
if (!is_vendor) if (!is_vendor())
fprintf(stderr, "%-*s [%u]\n", PADDING, "KERNEL_SZ", kernel_size()); fprintf(stderr, "%-*s [%u]\n", PADDING, "KERNEL_SZ", kernel_size());
fprintf(stderr, "%-*s [%u]\n", PADDING, "RAMDISK_SZ", ramdisk_size()); fprintf(stderr, "%-*s [%u]\n", PADDING, "RAMDISK_SZ", ramdisk_size());
if (ver < 3) if (ver < 3)
@ -62,7 +58,7 @@ void dyn_img_hdr::print() {
fprintf(stderr, "%-*s [%u]\n", PADDING, "EXTRA_SZ", extra_size()); fprintf(stderr, "%-*s [%u]\n", PADDING, "EXTRA_SZ", extra_size());
if (ver == 1 || ver == 2) if (ver == 1 || ver == 2)
fprintf(stderr, "%-*s [%u]\n", PADDING, "RECOV_DTBO_SZ", recovery_dtbo_size()); fprintf(stderr, "%-*s [%u]\n", PADDING, "RECOV_DTBO_SZ", recovery_dtbo_size());
if (ver == 2 || is_vendor) if (ver == 2 || is_vendor())
fprintf(stderr, "%-*s [%u]\n", PADDING, "DTB_SZ", dtb_size()); fprintf(stderr, "%-*s [%u]\n", PADDING, "DTB_SZ", dtb_size());
if (uint32_t os_ver = os_version()) { if (uint32_t os_ver = os_version()) {
@ -81,12 +77,12 @@ void dyn_img_hdr::print() {
} }
fprintf(stderr, "%-*s [%u]\n", PADDING, "PAGESIZE", page_size()); fprintf(stderr, "%-*s [%u]\n", PADDING, "PAGESIZE", page_size());
if (char *n = name()) { if (const char *n = name()) {
fprintf(stderr, "%-*s [%s]\n", PADDING, "NAME", n); fprintf(stderr, "%-*s [%s]\n", PADDING, "NAME", n);
} }
fprintf(stderr, "%-*s [%.*s%.*s]\n", PADDING, "CMDLINE", fprintf(stderr, "%-*s [%.*s%.*s]\n", PADDING, "CMDLINE",
BOOT_ARGS_SIZE, cmdline(), BOOT_EXTRA_ARGS_SIZE, extra_cmdline()); BOOT_ARGS_SIZE, cmdline(), BOOT_EXTRA_ARGS_SIZE, extra_cmdline());
if (char *checksum = id()) { if (const char *checksum = id()) {
fprintf(stderr, "%-*s [", PADDING, "CHECKSUM"); fprintf(stderr, "%-*s [", PADDING, "CHECKSUM");
for (int i = 0; i < SHA256_DIGEST_SIZE; ++i) for (int i = 0; i < SHA256_DIGEST_SIZE; ++i)
fprintf(stderr, "%02hhx", checksum[i]); fprintf(stderr, "%02hhx", checksum[i]);
@ -94,7 +90,7 @@ void dyn_img_hdr::print() {
} }
} }
void dyn_img_hdr::dump_hdr_file() { void dyn_img_hdr::dump_hdr_file() const {
FILE *fp = xfopen(HEADER_FILE, "w"); FILE *fp = xfopen(HEADER_FILE, "w");
if (name()) if (name())
fprintf(fp, "name=%s\n", name()); fprintf(fp, "name=%s\n", name());
@ -321,7 +317,7 @@ if (hdr->name##_size()) { \
} }
void boot_img::parse_image(const uint8_t *addr, format_t type) { void boot_img::parse_image(const uint8_t *addr, format_t type) {
hdr = create_hdr(addr, type); auto hdr = create_hdr(addr, type);
if (char *id = hdr->id()) { if (char *id = hdr->id()) {
for (int i = SHA_DIGEST_SIZE + 4; i < SHA256_DIGEST_SIZE; ++i) { for (int i = SHA_DIGEST_SIZE + 4; i < SHA256_DIGEST_SIZE; ++i) {
@ -401,7 +397,7 @@ void boot_img::parse_image(const uint8_t *addr, format_t type) {
fprintf(stderr, "%-*s [%s]\n", PADDING, "KERNEL_FMT", fmt2name[k_fmt]); fprintf(stderr, "%-*s [%s]\n", PADDING, "KERNEL_FMT", fmt2name[k_fmt]);
} }
if (auto size = hdr->ramdisk_size()) { if (auto size = hdr->ramdisk_size()) {
if (hdr->is_vendor && hdr->header_version() >= 4) { if (hdr->is_vendor() && hdr->header_version() >= 4) {
// v4 vendor boot contains multiple ramdisks // v4 vendor boot contains multiple ramdisks
// Do not try to mess with it for now // Do not try to mess with it for now
r_fmt = UNKNOWN; r_fmt = UNKNOWN;
@ -451,6 +447,8 @@ void boot_img::parse_image(const uint8_t *addr, format_t type) {
} }
} }
} }
this->hdr = hdr;
} }
int split_image_dtb(const char *filename) { int split_image_dtb(const char *filename) {
@ -474,7 +472,7 @@ int split_image_dtb(const char *filename) {
} }
int unpack(const char *image, bool skip_decomp, bool hdr) { int unpack(const char *image, bool skip_decomp, bool hdr) {
boot_img boot(image); const boot_img boot(image);
if (hdr) if (hdr)
boot.hdr->dump_hdr_file(); boot.hdr->dump_hdr_file();
@ -640,7 +638,7 @@ void repack(const char *src_img, const char *out_img, bool skip_comp) {
if (access(RAMDISK_FILE, R_OK) == 0) { if (access(RAMDISK_FILE, R_OK) == 0) {
mmap_data m(RAMDISK_FILE); mmap_data m(RAMDISK_FILE);
auto r_fmt = boot.r_fmt; auto r_fmt = boot.r_fmt;
if (!skip_comp && !hdr->is_vendor && hdr->header_version() == 4 && r_fmt != LZ4_LEGACY) { if (!skip_comp && !hdr->is_vendor() && hdr->header_version() == 4 && r_fmt != LZ4_LEGACY) {
// A v4 boot image ramdisk will have to be merged with other vendor ramdisks, // A v4 boot image ramdisk will have to be merged with other vendor ramdisks,
// and they have to use the exact same compression method. v4 GKIs are required to // and they have to use the exact same compression method. v4 GKIs are required to
// use lz4 (legacy), so hardcode the format here. // use lz4 (legacy), so hardcode the format here.

View File

@ -338,27 +338,33 @@ struct vendor_ramdisk_table_entry_v4 {
* Polymorphic Universal Header * Polymorphic Universal Header
*******************************/ *******************************/
#define decl_val(name, len) \
virtual uint##len##_t name() const { return 0; }
#define decl_var(name, len) \ #define decl_var(name, len) \
virtual uint##len##_t &name() { j##len = 0; return j##len; } virtual uint##len##_t &name() { return j##len(); } \
#define decl_val(name, type) \ decl_val(name, len)
virtual type name() { return 0; }
#define decl_str(name) \
virtual char *name() { return nullptr; } \
virtual const char *name() const { return nullptr; }
struct dyn_img_hdr { struct dyn_img_hdr {
const bool is_vendor; virtual bool is_vendor() const = 0;
// Standard entries // Standard entries
decl_var(kernel_size, 32) decl_var(kernel_size, 32)
decl_var(ramdisk_size, 32) decl_var(ramdisk_size, 32)
decl_var(second_size, 32) decl_var(second_size, 32)
decl_val(page_size, uint32_t) decl_val(page_size, 32)
decl_val(header_version, uint32_t) decl_val(header_version, 32)
decl_var(extra_size, 32) decl_var(extra_size, 32)
decl_var(os_version, 32) decl_var(os_version, 32)
decl_val(name, char *) decl_str(name)
decl_val(cmdline, char *) decl_str(cmdline)
decl_val(id, char *) decl_str(id)
decl_val(extra_cmdline, char *) decl_str(extra_cmdline)
uint32_t kernel_dt_size = 0; uint32_t kernel_dt_size = 0;
// v1/v2 specific // v1/v2 specific
@ -368,21 +374,21 @@ struct dyn_img_hdr {
decl_var(dtb_size, 32) decl_var(dtb_size, 32)
// v4 specific // v4 specific
decl_val(signature_size, uint32_t) decl_val(signature_size, 32)
decl_val(vendor_ramdisk_table_size, uint32_t) decl_val(vendor_ramdisk_table_size, 32)
decl_val(bootconfig_size, uint32_t) decl_val(bootconfig_size, 32)
virtual ~dyn_img_hdr() { virtual ~dyn_img_hdr() {
free(raw); free(raw);
} }
virtual size_t hdr_size() = 0; virtual size_t hdr_size() const = 0;
virtual size_t hdr_space() { return page_size(); } virtual size_t hdr_space() const { return page_size(); }
virtual dyn_img_hdr *clone() = 0; virtual dyn_img_hdr *clone() const = 0;
const void *raw_hdr() const { return raw; } const void *raw_hdr() const { return raw; }
void print(); void print() const;
void dump_hdr_file(); void dump_hdr_file() const;
void load_hdr_file(); void load_hdr_file();
protected: protected:
@ -393,16 +399,19 @@ protected:
boot_img_hdr_pxa *hdr_pxa; /* Samsung PXA header */ boot_img_hdr_pxa *hdr_pxa; /* Samsung PXA header */
void *raw; /* Raw pointer */ void *raw; /* Raw pointer */
}; };
dyn_img_hdr(bool b) : is_vendor(b) {}
static uint32_t &j32() { _j32 = 0; return _j32; }
static uint64_t &j64() { _j64 = 0; return _j64; }
private: private:
// Junk for references // Junk for references
static uint32_t j32; inline static uint32_t _j32 = 0;
static uint64_t j64; inline static uint64_t _j64 = 0;
}; };
#undef decl_var #undef decl_var
#undef decl_val #undef decl_val
#undef decl_str
#define __impl_cls(name, hdr) \ #define __impl_cls(name, hdr) \
protected: name() = default; \ protected: name() = default; \
@ -411,91 +420,101 @@ name(const void *ptr) { \
raw = malloc(sizeof(hdr)); \ raw = malloc(sizeof(hdr)); \
memcpy(raw, ptr, sizeof(hdr)); \ memcpy(raw, ptr, sizeof(hdr)); \
} \ } \
size_t hdr_size() override { \ size_t hdr_size() const override { \
return sizeof(hdr); \ return sizeof(hdr); \
} \ } \
dyn_img_hdr *clone() override { \ dyn_img_hdr *clone() const override { \
auto p = new name(raw); \ auto p = new name(raw); \
p->kernel_dt_size = kernel_dt_size; \ p->kernel_dt_size = kernel_dt_size; \
return p; \ return p; \
}; };
#define __impl_val(name, hdr_name) \ #define __impl_val(name, hdr_name) \
decltype(std::declval<dyn_img_hdr>().name()) name() override { return hdr_name->name; } decltype(std::declval<const dyn_img_hdr>().name()) name() const override { return hdr_name->name; }
struct dyn_img_hdr_boot : public dyn_img_hdr { #define __impl_var(name, hdr_name) \
protected: decltype(std::declval<dyn_img_hdr>().name()) name() override { return hdr_name->name; } \
dyn_img_hdr_boot() : dyn_img_hdr(false) {} __impl_val(name, hdr_name)
};
#define impl_cls(ver) __impl_cls(dyn_img_##ver, boot_img_hdr_##ver) #define impl_cls(ver) __impl_cls(dyn_img_##ver, boot_img_hdr_##ver)
#define impl_val(name) __impl_val(name, v2_hdr) #define impl_val(name) __impl_val(name, v2_hdr)
#define impl_var(name) __impl_var(name, v2_hdr)
struct dyn_img_hdr_boot : public dyn_img_hdr {
bool is_vendor() const final { return false; }
};
struct dyn_img_common : public dyn_img_hdr_boot { struct dyn_img_common : public dyn_img_hdr_boot {
impl_val(kernel_size) impl_var(kernel_size)
impl_val(ramdisk_size) impl_var(ramdisk_size)
impl_val(second_size) impl_var(second_size)
}; };
struct dyn_img_v0 : public dyn_img_common { struct dyn_img_v0 : public dyn_img_common {
impl_cls(v0) impl_cls(v0)
impl_val(page_size) impl_val(page_size)
impl_val(extra_size) impl_var(extra_size)
impl_val(os_version) impl_var(os_version)
impl_val(name) impl_var(name)
impl_val(cmdline) impl_var(cmdline)
impl_val(id) impl_var(id)
impl_val(extra_cmdline) impl_var(extra_cmdline)
}; };
struct dyn_img_v1 : public dyn_img_v0 { struct dyn_img_v1 : public dyn_img_v0 {
impl_cls(v1) impl_cls(v1)
impl_val(header_version) impl_val(header_version)
impl_val(recovery_dtbo_size) impl_var(recovery_dtbo_size)
impl_val(recovery_dtbo_offset) impl_var(recovery_dtbo_offset)
impl_val(header_size) impl_var(header_size)
uint32_t &extra_size() override { return dyn_img_hdr::extra_size(); } uint32_t &extra_size() override { return j32(); }
uint32_t extra_size() const override { return 0; }
}; };
struct dyn_img_v2 : public dyn_img_v1 { struct dyn_img_v2 : public dyn_img_v1 {
impl_cls(v2) impl_cls(v2)
impl_val(dtb_size) impl_var(dtb_size)
}; };
#undef impl_val #undef impl_val
#undef impl_var
#define impl_val(name) __impl_val(name, hdr_pxa) #define impl_val(name) __impl_val(name, hdr_pxa)
#define impl_var(name) __impl_var(name, hdr_pxa)
struct dyn_img_pxa : public dyn_img_common { struct dyn_img_pxa : public dyn_img_common {
impl_cls(pxa) impl_cls(pxa)
impl_val(extra_size) impl_var(extra_size)
impl_val(page_size) impl_val(page_size)
impl_val(name) impl_var(name)
impl_val(cmdline) impl_var(cmdline)
impl_val(id) impl_var(id)
impl_val(extra_cmdline) impl_var(extra_cmdline)
}; };
#undef impl_val #undef impl_val
#undef impl_var
#define impl_val(name) __impl_val(name, v4_hdr) #define impl_val(name) __impl_val(name, v4_hdr)
#define impl_var(name) __impl_var(name, v4_hdr)
struct dyn_img_v3 : public dyn_img_hdr_boot { struct dyn_img_v3 : public dyn_img_hdr_boot {
impl_cls(v3) impl_cls(v3)
impl_val(kernel_size) impl_var(kernel_size)
impl_val(ramdisk_size) impl_var(ramdisk_size)
impl_val(os_version) impl_var(os_version)
impl_val(header_size) impl_var(header_size)
impl_val(header_version) impl_val(header_version)
impl_val(cmdline) impl_var(cmdline)
// Make API compatible // Make API compatible
uint32_t page_size() override { return 4096; } uint32_t page_size() const override { return 4096; }
char *extra_cmdline() override { return &v4_hdr->cmdline[BOOT_ARGS_SIZE]; } char *extra_cmdline() override { return &v4_hdr->cmdline[BOOT_ARGS_SIZE]; }
const char *extra_cmdline() const override { return &v4_hdr->cmdline[BOOT_ARGS_SIZE]; }
}; };
struct dyn_img_v4 : public dyn_img_v3 { struct dyn_img_v4 : public dyn_img_v3 {
@ -505,28 +524,30 @@ struct dyn_img_v4 : public dyn_img_v3 {
}; };
struct dyn_img_hdr_vendor : public dyn_img_hdr { struct dyn_img_hdr_vendor : public dyn_img_hdr {
protected: bool is_vendor() const final { return true; }
dyn_img_hdr_vendor() : dyn_img_hdr(true) {}
}; };
#undef impl_val #undef impl_val
#undef impl_var
#define impl_val(name) __impl_val(name, v4_vnd) #define impl_val(name) __impl_val(name, v4_vnd)
#define impl_var(name) __impl_var(name, v4_vnd)
struct dyn_img_vnd_v3 : public dyn_img_hdr_vendor { struct dyn_img_vnd_v3 : public dyn_img_hdr_vendor {
impl_cls(vnd_v3) impl_cls(vnd_v3)
impl_val(header_version) impl_val(header_version)
impl_val(page_size) impl_val(page_size)
impl_val(ramdisk_size) impl_var(ramdisk_size)
impl_val(cmdline) impl_var(cmdline)
impl_val(name) impl_var(name)
impl_val(header_size) impl_var(header_size)
impl_val(dtb_size) impl_var(dtb_size)
size_t hdr_space() override { return align_to(hdr_size(), page_size()); } size_t hdr_space() const override { return align_to(hdr_size(), page_size()); }
// Make API compatible // Make API compatible
char *extra_cmdline() override { return &v4_vnd->cmdline[BOOT_ARGS_SIZE]; } char *extra_cmdline() override { return &v4_vnd->cmdline[BOOT_ARGS_SIZE]; }
const char *extra_cmdline() const override { return &v4_vnd->cmdline[BOOT_ARGS_SIZE]; }
}; };
struct dyn_img_vnd_v4 : public dyn_img_vnd_v3 { struct dyn_img_vnd_v4 : public dyn_img_vnd_v3 {
@ -538,8 +559,10 @@ struct dyn_img_vnd_v4 : public dyn_img_vnd_v3 {
#undef __impl_cls #undef __impl_cls
#undef __impl_val #undef __impl_val
#undef __impl_var
#undef impl_cls #undef impl_cls
#undef impl_val #undef impl_val
#undef impl_var
/****************** /******************
* Full Boot Image * Full Boot Image
@ -564,10 +587,10 @@ enum {
struct boot_img { struct boot_img {
// Memory map of the whole image // Memory map of the whole image
mmap_data map; const mmap_data map;
// Android image header // Android image header
dyn_img_hdr *hdr; const dyn_img_hdr *hdr;
// Flags to indicate the state of current boot image // Flags to indicate the state of current boot image
std::bitset<BOOT_FLAGS_MAX> flags; std::bitset<BOOT_FLAGS_MAX> flags;

View File

@ -4,8 +4,6 @@
#include <base.hpp> #include <base.hpp>
#include "boot-rs.hpp"
#define HEADER_FILE "header" #define HEADER_FILE "header"
#define KERNEL_FILE "kernel" #define KERNEL_FILE "kernel"
#define RAMDISK_FILE "ramdisk.cpio" #define RAMDISK_FILE "ramdisk.cpio"

View File

@ -1,6 +1,7 @@
#include <mincrypt/sha.h> #include <mincrypt/sha.h>
#include <base.hpp> #include <base.hpp>
#include "boot-rs.hpp"
#include "magiskboot.hpp" #include "magiskboot.hpp"
#include "compress.hpp" #include "compress.hpp"