`generate_asm_macros_files` set to `False` still creating `include/include_asm.h`

[hansbonini]

Setting generate_asm_macros_files option to False in config.yaml still creating include/include_asm.h and overriding custom content. #470

[AngheloAlf]

Oh rats. This is indeed a bug. Sorry about this.

I opened #473 to address this issue. Could you please test it and ensure it works as it should?
If you installed splat with pip then you can install that branch with the following commands:

python3 -m pip uninstall splat64
python3 -m pip install git+https://github.com/AngheloAlf/splat.git@generate_asm_macros_files

Btw I'm a bit curious. What kind of custom content are you using in include_asm.h? I would like to know if we could expand the the generation of these files to better accommodate the usecase of as much people as we could.

[hansbonini]

@AngheloAlf @ethteck

#if !defined(SPLAT) && !defined(M2CTX) && !defined(PERMUTER) && !defined(SKIP_ASM)

        #ifndef BIOS_STUB
                #define BIOS_STUB(name, table, id)                                              \
                __asm__("\t.set push # maspsx-keep\n"                                           \
                        "\t.set noat # maspsx-keep\n"                                           \
                        "\t.set noreorder # maspsx-keep\n"                                      \
                        "\tglabel " #name " # maspsx-keep\n"                                    \
                        "\tli  $t2, " #table " # maspsx-keep\n"                                 \
                        "\tjr  $t2 # maspsx-keep\n"                                             \
                        "\tli  $t1, " #id " # maspsx-keep\n"                                    \
                        "\tnop # maspsx-keep\n"                                                 \
                        "\t.set pop # maspsx-keep\n"                                            \
                        "\tendlabel " #name" #maspsx-keep\n");
        #endif

        #ifndef SYSCALL
                #define SYSCALL(id)                                                             \
                __asm__("\tli $a0, " #id " # maspsx-keep\n"                                     \
                        "\tsyscall 0 # maspsx-keep\n");
        #endif

        #ifndef INCLUDE_ASM
                #define INCLUDE_ASM(FOLDER, NAME)                                               \
                void __maspsx_include_asm_hack_##NAME() {                                       \
                        __asm__(                                                                \
                            ".text # maspsx-keep \n"                                            \
                            "\t.align\t2 # maspsx-keep\n"                                       \
                            "\t.set noreorder # maspsx-keep\n"                                  \
                            "\t.set noat # maspsx-keep\n"                                       \
                            ".include \""FOLDER"/"#NAME".s\" # maspsx-keep\n"                   \
                            "\t.set reorder # maspsx-keep\n"                                    \
                            "\t.set at # maspsx-keep\n"                                         \
                        ); \
                    }
        #endif

        #ifndef INCLUDE_RODATA
                #define INCLUDE_RODATA(FOLDER, NAME)                                            \
                        __asm__(".section .rodata\n"                                            \
                                "\t.include \"" FOLDER "/" #NAME ".s\"\n"                       \
                                ".section .text")
        #endif

        __asm__(".include \"include/macro.inc\"\n"
                "\t.set\treorder\n"
                "\t.set\tat\n");
#else
        #ifndef INCLUDE_ASM
                #define INCLUDE_ASM(FOLDER, NAME)
        #endif
        #ifndef INCLUDE_RODATA
                #define INCLUDE_RODATA(FOLDER, NAME)
        #endif
#endif

[AngheloAlf]

Ohh. That's interesting.
Your INCLUDE_ASM definition comes from maspsx. I'll consult @mkst about how standard that definition is and if it could be worth to include it into splat.

About your BIOS_STUB and SYSCALL macros, those extra macros don't really belong into include_asm.h. This file is meant to provide the standard splat macros to inline assembly into C files. Even if all those macros happen to use __asm__.
In this case I would recommend you to move those definitions to a different header, maybe something like asm.h, hasm.h, os.h, etc.

[hansbonini]

@AngheloAlf Thank you for guidance! I'll move the BIOS_STUB and SYSCALL to a more appropriate file.

[AngheloAlf]

Were you able to test the PR I linked a few comments above?

[hansbonini]

Were you able to test the PR I linked a few comments above?

Sorry for reopen the issue and for delay, i've a baby girl so time is a little wacky here. Tested version 0.3.52 with the PR#473 applied. It fix the issue! No overwrite in include_asm.h. Thanks a lot @AngheloAlf!