git.y1.nz

gbdk-support/romusage/src/banks_summarized.c

// This is free and unencumbered software released into the public domain.
// For more information, please refer to <https://unlicense.org>
// bbbbbr 2023

#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <stdbool.h>
#include <stdint.h>

#include "common.h"
#include "logging.h"
#include "list.h"
#include "banks.h"

// === Summarized mode ===

static void summarize_copy_areas(bank_item *, const bank_item *);
static void summarize_copy_bank(bank_item *, const bank_item *);
static bool check_apply_forced_max_bank(int * p_banknum, int bank_num_max_used, int bank_mem_type);
static void summarize_fixup_sizes_and_names(list_type *);
static bool summarize_try_merge_bank(const bank_item *, list_type *);

// Copy (append) areas from one bank to another
//
// Translate banked areas addresses based on their bank number
// Assumes: source and dest bank are valid, that areas from different banks don't overlap
static void summarize_copy_modified_areas(bank_item * p_dest_bank, const bank_item * p_src_bank) {

    area_item * areas_to_copy = (area_item *)p_src_bank->area_list.p_array;

    // Copy areas from source bank to new summary bank
    for (int c = 0; c < p_src_bank->area_list.count; c++) {

        area_item new_area = areas_to_copy[c];
        // Scale area address up by bank number * bank size (factoring in whether bank start is 0 or 1 based)
        //
        // Handle special (-smWRAM or -smROM) case of a non-banked region merged with banked region.
        // This causes address range size to be 2x bank size and throws of base address calc for banked data
        // (to fix: bank - 1, and bank size / 2 )
        if ((p_src_bank->is_merged_bank) && (p_src_bank->bank_num > 0))
            new_area.start += (((p_src_bank->bank_num - p_src_bank->base_bank_num) - 1) * (p_src_bank->size_total / 2));
        else
            new_area.start += ((p_src_bank->bank_num - p_src_bank->base_bank_num) * p_src_bank->size_total);

        new_area.end = new_area.start + (new_area.length - 1);

        // Don't update bank size used here since that wouldn't factor in
        // overlapping areas, instead do it below in a single pass at the end
        // NO: p_dest_bank->size_used += new_area.length;
        list_additem(&(p_dest_bank->area_list), &new_area);
    }

    // Re-calculate size used in bank, taking overlapped areas into consideration
    //
    // For collapsing multiple banked regions with the same address range into
    // one bank, the address range would need to be scaled upward to accomodate
    // their larger virtual address range.
    //
    // Instead, make the assumption that areas have been previously clipped to be
    // within allowed ranges so that we don't need a stard/end range check and disable clipping. 
    p_dest_bank->size_used = bank_areas_calc_used(p_dest_bank, ADDR_NO_CLIP_MIN, ADDR_NO_CLIP_MAX);
}


// Copy a bank entry and it's areas
static void summarize_copy_bank(bank_item * p_dest_bank, const bank_item * p_src_bank) {

    // Duplicate bank, re-initialize bank list & copy areas from source
    *p_dest_bank = *p_src_bank;
    p_dest_bank->size_used = 0;
    list_init(&(p_dest_bank->area_list), sizeof(area_item));
    summarize_copy_modified_areas(p_dest_bank, p_src_bank);
}


// Checks to see whether -F  : Force displayed Max ROM and SRAM bank range needs to be applied
// Modifies p_banknum if so and returns true
static bool check_apply_forced_max_bank(int * p_banknum, int bank_num_max_used, int bank_mem_type) {

    int forced_bank_num;
    char str_ROM[] = "ROM";
    char str_SRAM[] = "SRAM";
    char str_NONE[] = "UNKNOWN";
    char * p_str_banktype = str_NONE;

    if (option_forced_display_max_bank_ROM) {

        switch (bank_mem_type) {
            case BANK_MEM_TYPE_ROM:
                    forced_bank_num = option_forced_display_max_bank_ROM;
                    p_str_banktype = str_ROM;
                    break;
            case BANK_MEM_TYPE_SRAM:
                    forced_bank_num = option_forced_display_max_bank_SRAM;
                    p_str_banktype = str_SRAM;
                    break;
        }

        if (forced_bank_num < bank_num_max_used) {
            log_warning("Warning! Forced Max %s Bank %d is smaller than Max Used Bank %d\n", p_str_banktype, forced_bank_num, bank_num_max_used);
            if (option_error_on_warning)
                set_exit_error();
        }

        *p_banknum = forced_bank_num;
        return true; // Success
    }
    return false; // Failure
}


// After banked regions have been merged, fix their names and sizes
static void summarize_fixup_sizes_and_names(list_type * p_bank_list_summarized) {

    bank_item * banks_summarized = (bank_item *)p_bank_list_summarized->p_array;

    for (int c=0; c < p_bank_list_summarized->count; c++) {
        if (banks_summarized[c].is_banked) {

            // Some banked region bank nums are 0, don't process those
            // (no need to resize, resize code not built to handle it)
            if (banks_summarized[c].bank_num) {

                // Save current as max "used" before replacing with max possible
                int bank_num_max_used = banks_summarized[c].bank_num;

                // ROM_X size: Round up bank num to next (power of 2) -1
                // SRAM_X size: Round up to next (power of 4) - 1
                // WRAM_X: Fixed number of banks on CGB, 7 always max
                switch (banks_summarized[c].bank_mem_type) {
                    case BANK_MEM_TYPE_ROM:
                            if (! check_apply_forced_max_bank(&banks_summarized[c].bank_num, bank_num_max_used, banks_summarized[c].bank_mem_type))
                                banks_summarized[c].bank_num = round_up_power_of_2((uint32_t)banks_summarized[c].bank_num + 1) - 1;
                            break;
                    case BANK_MEM_TYPE_SRAM:
                            if (! check_apply_forced_max_bank(&banks_summarized[c].bank_num, bank_num_max_used, banks_summarized[c].bank_mem_type)) {
                                if      (banks_summarized[c].bank_num > 7) banks_summarized[c].bank_num = 15;
                                else if (banks_summarized[c].bank_num > 3) banks_summarized[c].bank_num = 7;
                                else if (banks_summarized[c].bank_num > 1) banks_summarized[c].bank_num = 3;
                            }
                            break;
                    case BANK_MEM_TYPE_WRAM: banks_summarized[c].bank_num = WRAM_X_MAX_BANKS;
                            break;
                }

                // Update bank total size (factoring in whether bank start is 0 or 1 based)
                banks_summarized[c].size_total = ((banks_summarized[c].bank_num - banks_summarized[c].base_bank_num) + 1) *  banks_summarized[c].size_total;

                // Handle special (-cWRAM or -cROM) case of a non-banked region merged with banked region.
                // This causes address range size to be 2x which inflates total bank size. Divide by 2 to fix.
                if (banks_summarized[c].is_merged_bank)
                    banks_summarized[c].size_total /= 2;

                // Don't resize .end so that bank region shows correctly when rendered. charts will use ".size_total"
                // banks_summarized[c].end = (banks_summarized[c].size_total - 1) + banks_summarized[c].start;

                // Update Bank name with Used / Max - example: "ROM_1" with "ROM_Used/Max"
                char new_name[BANK_MAX_STR];
                // Strip bank name and underscore off the end if present
                char * p_chr_underscore = strstr(banks_summarized[c].name, "_");
                if (p_chr_underscore != NULL)
                    *p_chr_underscore = '\0';

                int ret; // save result to suppress truncation warning, bank names will never be > 100 chars and truncation is fine if it got to that
                ret = snprintf(new_name, sizeof(new_name), "%s_%d/%d", banks_summarized[c].name, bank_num_max_used, banks_summarized[c].bank_num);
                ret = snprintf(banks_summarized[c].name, sizeof(banks_summarized[c].name), "%s", new_name);
            }
        }
    }
}


// Try to find a matching bank in summarized data
// If found merge source bank into it
static bool summarize_try_merge_bank(const bank_item * p_src_bank, list_type * p_bank_list_summarized) {

    bank_item * banks_summarized = (bank_item *)p_bank_list_summarized->p_array;

    // Check if bank type already exists in summarized data by start of memory region
    for (int dest_idx=0; dest_idx < p_bank_list_summarized->count; dest_idx++) {
        if (banks_summarized[dest_idx].start == p_src_bank->start) {
            // Found matching bank type, copy areas and bump up max bank used if needed
            summarize_copy_modified_areas(&banks_summarized[dest_idx], p_src_bank);
            banks_summarized[dest_idx].bank_num = max(banks_summarized[dest_idx].bank_num, p_src_bank->bank_num);
            return true; // Success
        }
    }
    return false; // Failed: no existing bank found to merge into
}


// Generate a summarized view with all banked
// categories collapsed into to single ranges
//
// Data in the bank list is assumed to be good
// and not requiring validation at this point
void banklist_collapse_to_summary(const list_type * p_bank_list, list_type * p_bank_list_summarized) {

    bank_item * banks            = (bank_item *)p_bank_list->p_array;
    bank_item * banks_summarized = (bank_item *)p_bank_list_summarized->p_array;
    bank_item   new_bank;

    for (int src_idx=0; src_idx < p_bank_list->count; src_idx++) {

        // Add non-banked items directly without aggregating them
        // Assumes no dupes, or if dupes then intentional
        if (! banks[src_idx].is_banked) {
            summarize_copy_bank(&new_bank, &banks[src_idx]);
            list_additem(p_bank_list_summarized, &new_bank);
        } else {
            // Otherwise try to merge with an existing bank, or create a new entry in sumamrized data if needed
            if (! summarize_try_merge_bank(&banks[src_idx], p_bank_list_summarized)) {
                summarize_copy_bank(&new_bank, &banks[src_idx]);
                list_additem(p_bank_list_summarized, &new_bank);
            }
        }
    }

    summarize_fixup_sizes_and_names(p_bank_list_summarized);
}

This webpage is intended to be an accessible preview of this repository. To get a fuller picture, clone it and use the git CLI.