Makefile

# ------------------------------------------------------------------------------
# Configuration
# ------------------------------------------------------------------------------

VERSION  ?= us
BASENAME := pilotwings64
DISPNAME := Pilotwings 64

NO_COL  := \033[0m
RED     := \033[0;31m
RED2    := \033[1;31m
GREEN   := \033[0;32m
YELLOW  := \033[0;33m
BLUE    := \033[0;34m
PINK    := \033[0;35m
CYAN    := \033[0;36m

VERBOSE ?= 0
ifeq ($(VERBOSE),0)
  V := @
endif

RECOMP_BUILD ?= 0

# ------------------------------------------------------------------------------
# Toolchain
# ------------------------------------------------------------------------------

find-command = $(shell which $(1) 2>/dev/null)

ifneq      ($(call find-command,mips-linux-gnu-ld),)
  CROSS := mips-linux-gnu-
else ifneq ($(call find-command,mips64-linux-gnu-ld),)
  CROSS := mips64-linux-gnu-
else ifneq ($(call find-command,mips64-elf-ld),)
  CROSS := mips64-elf-
else
  $(error Unable to detect a suitable MIPS toolchain installed.)
endif

# Prefer clang as C preprocessor if installed on the system
ifneq (,$(call find-command,clang))
  CPP      := clang
  CPPFLAGS := -E -P -x c -Wno-trigraphs -Wmissing-prototypes -Wstrict-prototypes -D_LANGUAGE_ASSEMBLY
else
  CPP      := cpp
  CPPFLAGS := -P -Wno-trigraphs -Wmissing-prototypes -Wstrict-prototypes -D_LANGUAGE_ASSEMBLY
endif

TOOLS_DIR = tools

AS       := $(CROSS)as
LD       := $(CROSS)ld
OBJCOPY  := $(CROSS)objcopy
PYTHON   := python3
GREP     := grep -rl
# prefer clang as host compiler if installed on the system.
# this allows certain 32-bit CC_CHECK flags to work on arm hosts
ifneq (,$(call find-command,clang))
  CC_CHECK  := clang
else
  CC_CHECK  := gcc
endif

CC := $(TOOLS_DIR)/ido-static-recomp/build/5.3/out/cc

ASM_PROCESSOR_DIR := $(TOOLS_DIR)/asm-processor
ASM_PROCESSOR     := $(PYTHON) $(ASM_PROCESSOR_DIR)/asm_processor.py

SPLAT       := $(PYTHON) -m splat split
SPLAT_YAML  := config/$(VERSION)/$(BASENAME).$(VERSION).yaml
SPLAT_FLAGS :=

# ------------------------------------------------------------------------------
# Inputs
# ------------------------------------------------------------------------------

ASM_DIR = asm
BIN_DIR = bin
SRC_DIR = src

ASM_DIRS := $(shell find $(ASM_DIR) -type d -not -path "asm/nonmatchings/*")
BIN_DIRS := $(shell find $(BIN_DIR) -type d)
SRC_DIRS := $(shell find $(SRC_DIR) -type d)

S_FILES := $(foreach dir,$(ASM_DIRS) $(SRC_DIRS),$(wildcard $(dir)/*.s))
B_FILES := $(foreach dir,$(BIN_DIRS),$(wildcard $(dir)/*.bin))
C_FILES := $(foreach dir,$(SRC_DIRS),$(wildcard $(dir)/*.c))

# ------------------------------------------------------------------------------
# Outputs
# ------------------------------------------------------------------------------

BUILD_DIR := build
SPLAT_DIR := $(BUILD_DIR)/splat_out

ROM_BIN   := $(BUILD_DIR)/$(BASENAME).$(VERSION).bin
ROM_ELF   := $(BUILD_DIR)/$(BASENAME).$(VERSION).elf
ROM_Z64   := $(BUILD_DIR)/$(BASENAME).$(VERSION).z64
LD_MAP    := $(BUILD_DIR)/$(BASENAME).$(VERSION).map
LD_SCRIPT := $(BUILD_DIR)/$(BASENAME).$(VERSION).ld

S_O_FILES := $(foreach file,$(S_FILES:.s=.o),$(BUILD_DIR)/$(file))
B_O_FILES := $(foreach file,$(B_FILES:.bin=.o),$(BUILD_DIR)/$(file))
C_O_FILES := $(foreach file,$(C_FILES:.c=.o),$(BUILD_DIR)/$(file))

O_FILES := $(C_O_FILES) $(S_O_FILES) $(B_O_FILES)

DEP_FILES := $(C_O_FILES:.o=.d)

CRC := $(TOOLS_DIR)/n64crc

OPT_FLAGS      = -O2
LOOP_UNROLL    =

ASM_PROC_FLAGS = $(OPT_FLAGS)
ASM_DEFINES    = -D_LANGUAGE_ASSEMBLY

MIPSISET       = -mips2 -32

INCLUDE_CFLAGS = -I. -Isrc -Iinclude -Iinclude/kernel -Iinclude/libultra -Iinclude/libultra/PR -Iinclude/libultra/compiler/ido -Ibin

ASFLAGS        = -EB -mtune=vr4300 -march=vr4300 -mabi=32 -I include
OBJCOPYFLAGS   = -O binary

# Files requiring pre/post-processing
GLOBAL_ASM_C_FILES := $(shell $(GREP) GLOBAL_ASM $(SRC_DIR) </dev/null 2>/dev/null)
GLOBAL_ASM_O_FILES := $(foreach file,$(GLOBAL_ASM_C_FILES:.c=.o),$(BUILD_DIR)/$(file))

DEFINES := -D_LANGUAGE_C -D_FINALROM -DWIN32 -DNDEBUG -DTARGET_N64 -DCOMPILING_LIBULTRA
DEFINES += -DVERSION_US
DEFINES += -DBUILD_VERSION=VERSION_D

ifneq ($(RECOMP_BUILD),0)
  DEFINES += -DRECOMP_BUILD
endif

VERIFY = verify

CFLAGS := -Wab,-r4300_mul -non_shared -G 0 -Xcpluscomm -fullwarn  -nostdinc -g0
CFLAGS += $(DEFINES)
# ignore compiler warnings about anonymous structs
CFLAGS += -woff 624,649,838,712,516,513,596,564,594,709,807
CFLAGS += $(INCLUDE_CFLAGS)

# -m32 has compiler treat code as 32-bit, but only works on clang and x86_64 gcc
# other architectures may need to rely on clang or a cross-compiler
ifeq ($(shell getconf LONG_BIT),64)
  CHECK_ARCH := -m32
endif
CHECK_WARNINGS := -Wall -Wextra -Wno-format-security -Wno-unknown-pragmas -Wunused-function -Wno-unused-parameter -Wno-unused-variable -Wno-missing-braces -Wno-int-conversion -Wno-multichar
CHECK_CFLAGS := -fsyntax-only -fno-builtin -fsigned-char -std=gnu90 $(CHECK_ARCH) $(CHECK_WARNINGS) $(INCLUDE_CFLAGS) $(DEFINES)

LD_FLAGS := -T $(LD_SCRIPT)
LD_FLAGS += -T config/$(VERSION)/sym/hardware_regs.ld
LD_FLAGS += -T config/$(VERSION)/sym/pif_syms.ld
LD_FLAGS += -T config/$(VERSION)/sym/libultra_undefined_syms.txt
LD_FLAGS += -T $(SPLAT_DIR)/$(VERSION)/undefined_funcs_auto.txt
LD_FLAGS += -T $(SPLAT_DIR)/$(VERSION)/undefined_syms_auto.txt
LD_FLAGS += -Map $(LD_MAP) --no-check-sections

ifeq ($(VERSION),us)
LD_FLAGS_EXTRA  =
LD_FLAGS_EXTRA += $(foreach sym,$(UNDEFINED_SYMS),-u $(sym))
else
LD_FLAGS_EXTRA  =
endif

### Optimisation Overrides
$(BUILD_DIR)/src/libultra/audio/auxbus.o: OPT_FLAGS := -O3
$(BUILD_DIR)/src/libultra/audio/bnkf.o: OPT_FLAGS := -O3
$(BUILD_DIR)/src/libultra/audio/cseq.o: OPT_FLAGS := -O3
$(BUILD_DIR)/src/libultra/audio/csplayer.o: OPT_FLAGS := -O3
$(BUILD_DIR)/src/libultra/audio/drvrnew.o: OPT_FLAGS := -O3
$(BUILD_DIR)/src/libultra/audio/env.o: OPT_FLAGS := -O3
$(BUILD_DIR)/src/libultra/audio/event.o: OPT_FLAGS := -O3
$(BUILD_DIR)/src/libultra/audio/load.o: OPT_FLAGS := -O3
$(BUILD_DIR)/src/libultra/audio/mainbus.o: OPT_FLAGS := -O3
$(BUILD_DIR)/src/libultra/audio/resample.o: OPT_FLAGS := -O3
$(BUILD_DIR)/src/libultra/audio/reverb.o: OPT_FLAGS := -O3
$(BUILD_DIR)/src/libultra/audio/save.o: OPT_FLAGS := -O3
$(BUILD_DIR)/src/libultra/audio/seq.o: OPT_FLAGS := -O3
$(BUILD_DIR)/src/libultra/audio/seqplayer.o: OPT_FLAGS := -O3
$(BUILD_DIR)/src/libultra/audio/seqpsetbank.o: OPT_FLAGS := -O3
$(BUILD_DIR)/src/libultra/audio/seqpsetseq.o: OPT_FLAGS := -O3
$(BUILD_DIR)/src/libultra/audio/seqpsettempo.o: OPT_FLAGS := -O3
$(BUILD_DIR)/src/libultra/audio/seqpsetvol.o: OPT_FLAGS := -O3
$(BUILD_DIR)/src/libultra/audio/sl.o: OPT_FLAGS := -O3
$(BUILD_DIR)/src/libultra/audio/sndplayer.o: OPT_FLAGS := -O3
$(BUILD_DIR)/src/libultra/audio/sndpsetfxmix.o: OPT_FLAGS := -O3
$(BUILD_DIR)/src/libultra/audio/sndpsetpan.o: OPT_FLAGS := -O3
$(BUILD_DIR)/src/libultra/audio/sndpsetvol.o: OPT_FLAGS := -O3
$(BUILD_DIR)/src/libultra/audio/synallocfx.o: OPT_FLAGS := -O3
$(BUILD_DIR)/src/libultra/audio/synallocvoice.o: OPT_FLAGS := -O3
$(BUILD_DIR)/src/libultra/audio/synfreevoice.o: OPT_FLAGS := -O3
$(BUILD_DIR)/src/libultra/audio/synthesizer.o: OPT_FLAGS := -O3
$(BUILD_DIR)/src/libultra/debug/%.o: OPT_FLAGS := -O1
$(BUILD_DIR)/src/libultra/io/%.o: OPT_FLAGS := -O1
$(BUILD_DIR)/src/libultra/libc/ll.o: OPT_FLAGS := -O1 -g0
$(BUILD_DIR)/src/libultra/libc/ll.o: MIPSISET := -mips3 -32
$(BUILD_DIR)/src/libultra/os/%.o: OPT_FLAGS := -O1
$(BUILD_DIR)/src/libultra/sp/sprite.o: OPT_FLAGS := -O3
$(BUILD_DIR)/src/kernel/debug.o: OPT_FLAGS := -O1 -g
$(BUILD_DIR)/src/kernel/debug.o: MIPSISET := -mips1 -32

# ------------------------------------------------------------------------------
# Targets
# ------------------------------------------------------------------------------

default: all

all: dirs $(VERIFY)

dirs:
	$(foreach dir,$(SRC_DIRS) $(ASM_DIRS) $(BIN_DIRS),$(shell mkdir -p $(BUILD_DIR)/$(dir)))

verify: $(ROM_Z64)
	$(V)sha1sum -c config/$(VERSION)/$(BASENAME).$(VERSION).sha1

no_verify: $(ROM_Z64)
	@echo "Skipping SHA1SUM check!"

init: $(TOOLS_DIR)
	$(MAKE) clean
	$(MAKE) extract
	$(MAKE) -j$(nproc)

extract: $(TOOLS_DIR)
	rm -rf asm
	rm -rf build
	$(SPLAT) $(SPLAT_YAML) $(SPLAT_FLAGS)

dependencies: $(TOOLS_DIR)
	$(V)$(MAKE) -C $(TOOLS_DIR)
	$(V)$(PYTHON) -m pip install -r requirements.txt

expected:
	mkdir -p expected/build
	rm -rf expected/build/
	cp -r build/ expected/build/

clean:
	rm -rf $(BUILD_DIR)/asm $(BUILD_DIR)/bin $(BUILD_DIR)/src
	rm -rf $(ROM_BIN) $(ROM_ELF) $(ROM_Z64)

distclean: clean
	rm -rf $(BUILD_DIR) $(ASM_DIR) $(BIN_DIR)
	rm -f *auto.txt
	rm -f *ctx.c*

format:
	$(PYTHON) $(TOOLS_DIR)/format.py -j

$(ROM_ELF): $(LD_SCRIPT) $(BUILD_DIR)/$(LIBULTRA) $(O_FILES) $(LANG_RNC_O_FILES) $(IMAGE_O_FILES)
	@printf "[$(PINK) linker $(NO_COL)]  $<\n"
	$(V)$(LD) $(LD_FLAGS) $(LD_FLAGS_EXTRA) -o $@

ifndef PERMUTER
$(GLOBAL_ASM_O_FILES): $(BUILD_DIR)/%.o: %.c
	@printf "[$(YELLOW) syntax $(NO_COL)]  $<\n"
	$(V)$(CC_CHECK) $(CHECK_CFLAGS) -MMD -MP -MT $@ -MF $(BUILD_DIR)/$*.d $<
	@printf "[$(GREEN) ido5.3 $(NO_COL)]  $<\n"
	$(V)$(ASM_PROCESSOR) $(ASM_PROC_FLAGS) $< > $(BUILD_DIR)/$<
	$(V)$(CC) -c $(CFLAGS) $(OPT_FLAGS) $(LOOP_UNROLL) $(MIPSISET) -o $@ $(BUILD_DIR)/$<
	$(V)$(ASM_PROCESSOR) $(ASM_PROC_FLAGS) $< --post-process $@ \
		--assembler "$(AS) $(ASFLAGS)" --asm-prelude $(ASM_PROCESSOR_DIR)/prelude.inc
endif

# non asm-processor recipe
$(BUILD_DIR)/%.o: %.c
	@printf "[$(YELLOW) syntax $(NO_COL)]  $<\n"
	$(V)$(CC_CHECK) $(CHECK_CFLAGS) -MMD -MP -MT $@ -MF $(BUILD_DIR)/$*.d $<
	@printf "[$(GREEN) ido5.3 $(NO_COL)]  $<\n"
	$(V)$(CC) -c $(CFLAGS) $(OPT_FLAGS) $(LOOP_UNROLL) $(MIPSISET) -o $@ $<

# Patch ll.o
$(BUILD_DIR)/src/libultra/libc/ll.o: src/libultra/libc/ll.c
	@printf "[$(YELLOW) syntax $(NO_COL)]  $<\n"
	$(V)$(CC_CHECK) $(CHECK_CFLAGS) -MMD -MP -MT $@ -MF $*.d $<
	@printf "[$(GREEN) ido5.3 $(NO_COL)]  $<\n"
	$(V)$(CC) -c $(CFLAGS) $(OPT_FLAGS) $(LOOP_UNROLL) $(MIPSISET) -o $@ $<
	@printf "[$(CYAN) patch $(NO_COL)]  $<\n"
	$(V)$(PYTHON) $(TOOLS_DIR)/set_o32abi_bit.py $@

$(BUILD_DIR)/$(LIBULTRA): $(LIBULTRA)
	$(V)mkdir -p $$(dirname $@)
#	$(V)cp $< $@
#	$(V)$(PYTHON) $(TOOLS_DIR)/set_o32abi_bit.py $@

$(BUILD_DIR)/%.o: %.s
	@printf "[$(GREEN)   as   $(NO_COL)]  $<\n"
	$(V)$(CPP) $(CPPFLAGS) $(INCLUDE_CFLAGS) -I $(dir $*) $(ASM_DEFINES) $< | $(AS) $(ASFLAGS) $(INCLUDE_CFLAGS) -o $@ -

$(BUILD_DIR)/%.o: %.bin
	@printf "[$(PINK) linker $(NO_COL)]  $<\n"
	$(V)$(LD) -r -b binary -o $@ $<

$(ROM_BIN): $(ROM_ELF)
	@printf "[$(CYAN) objcpy $(NO_COL)]  $<\n"
	$(V)$(OBJCOPY) $(OBJCOPYFLAGS) $< $@

$(ROM_Z64): $(ROM_BIN)
	@printf "[$(CYAN)bin->z64$(NO_COL)]  $<\n"
	$(V)cp $(ROM_BIN) $(ROM_Z64)
	@printf "[$(GREEN) n64crc $(NO_COL)]  $@\n"
	$(V)$(CRC) $@

# fake targets for better error handling
$(SPLAT):
	$(info Repo cloned without submodules, attempting to fetch them now...)
	@which git >/dev/null || echo "ERROR: git binary not found on PATH"
	@which git >/dev/null
	git submodule update --init --recursive

# include compiler generated dependency files
-include $(DEP_FILES)

### Settings
.SECONDARY:
.PHONY: all clean default dirs expected verify no_verify
SHELL = /bin/bash -e -o pipefail