Makefile

#
# Copyright 2016-2020 International Business Machines
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

SHELL=/bin/bash
PLATFORM ?= $(shell uname -m)

export SNAP_ROOT=$(abspath .)

config_subdirs += $(SNAP_ROOT)/scripts
software_subdirs += $(SNAP_ROOT)/software
hardware_subdirs += $(SNAP_ROOT)/hardware
action_subdirs += $(SNAP_ROOT)/actions

snap_config = .snap_config
snap_config_bak = .snap_config_test.bak
snap_config_new = .snap_config_test.new
snap_config_sh = .snap_config.sh
snap_config_cflags = .snap_config.cflags
snap_env_sh        = snap_env.sh

clean_subdirs += $(config_subdirs) $(software_subdirs) $(hardware_subdirs) $(action_subdirs)

# Only build if the subdirectory is really existent
.PHONY: help $(software_subdirs) software $(action_subdirs) apps actions $(hardware_subdirs) hardware test install uninstall snap_env hw_project model sim image synth place route cloud_enable cloud_base cloud_action snap_config config menuconfig xconfig gconfig oldconfig silentoldconfig clean clean_cloud clean_config clean_env gitclean

help:
	@echo "   ___  ____  ______       ___  ___             ___  __";
	@echo "  ___  / __ \/ ____/      ___  /   | _____________  / /";
	@echo " ___  / / / / /      ______   / /| |/ ___/ ___/ _ \/ / ";
	@echo "___  / /_/ / /___   /_____/  / ___ / /__/ /__/  __/ /  ";
	@echo " ___ \____/\____/      ___  /_/  |_\___/\___/\___/_/   ";
	@echo "";
	@echo "Main targets for the OC-Accel Framework make process:";
	@echo "=================================================";
	@echo "* ./ocaccel_workflow.py -i  Drives you through the whole simulation process flow";
	@echo "*";
	@echo "* snap_config    Configure OC-Accel framework";
	@echo "* model          Build simulation model for simulator specified via target snap_config";
	@echo "* sim            Start a simulation (it will build the model before)";
	@echo "* sim_tmux       Start a simulation in tmux (no xterm window popped up)";
	@echo "*";
	@echo "* image          Build a complete FPGA bitstream (takes more than one hour)";
	@echo "*                 (can be splitted into 'make synth' + 'make place' + 'make route')";
	@echo "* hardware       One step to build FPGA bitstream (Combines targets 'model' and 'image')";
	@echo "*";
	@echo "* cloud_base     Partial Reconfiguration: synthesize the top (static zone)";
	@echo "*                 This command can be splitted into 4 steps:";
	@echo "*                   'make oc_pr_synth_action' + 'make oc_pr_synth_static' and then"; 
	@echo "*                   'make oc_pr_route_static' + 'make oc_pr_image'";
	@echo "*                   Full binary images will be generated for Flash + partial for FPGA";
	@echo "* cloud_action   Partial Reconfiguration: synthesize the action (dynamic zone)";
	@echo "*                 (can be splitted into 3 steps: (after a 'make cloud_base' run)";
	@echo "*                   'make oc_pr_synth_action' and then";
	@echo "*                   'make oc_pr_route_action' + 'make oc_pr_image'";
	@echo "*                   Partial binary image will be generated for FPGA";
	@echo "*";
	@echo "* software       Build software libraries and tools for SNAP";
	@echo "* apps           Build the applications for all actions";
	@echo "* hw_project     Create Vivado project with oc-bip (included in make image)";
	@echo "* clean          Remove all files generated in make process";
	@echo "* clean_cloud    Remove all files generated in DCP dir with make process (PR mode)";
	@echo "* clean_config   As target 'clean' plus reset of the configuration";
	@echo "* help           Print this message";
	@echo;
	@echo "The hardware related targets 'model', 'sim', 'image', 'cloud_base', 'cloud_action',";
	@echo "'hardware', and 'hw_project' do only exist on an x86 platform";
	@echo;
	@echo "Few tools to help debug";
	@echo "-----------------------";
	@echo "* ./display_traces       Display traces to debug action code";
	@echo "* ./debug_timing         Display timing failing paths when image generation fails";
	@echo "* vivado hardware/build/Checkpoints/opt_routed_design.dcp to see logic placement.";
	@echo "* vivado hardware/viv_project/framework.xpr to see project internal details.";
	@echo;


ifeq ($(PLATFORM),x86_64)
all: $(software_subdirs) $(action_subdirs) $(hardware_subdirs)
else
all: $(software_subdirs) $(action_subdirs)
endif

# Disabling implicit rule for shell scripts
%: %.sh

$(software_subdirs):
	@if [ -d $@ ]; then             \
	    echo "Enter: $@";           \
	    $(MAKE) -C $@ || exit 1; 	\
	    echo "Exit:  $@";           \
	fi

software: $(software_subdirs)

$(action_subdirs):
	@if [ -d $@ ]; then             \
	    echo "Enter: $@";           \
	    $(MAKE) -C $@ || exit 1; 	\
	    echo "Exit:  $@";           \
	fi

apps actions: $(action_subdirs)

# Install/uninstall
test install uninstall:
	@for dir in $(software_subdirs) $(action_subdirs); do \
	    if [ -d $$dir ]; then                             \
	        $(MAKE) -s -C $$dir $@ || exit 1;             \
	    fi                                                \
	done

ifeq ($(PLATFORM),x86_64)
$(hardware_subdirs): $(snap_env_sh)
	@if [ -d $@ ]; then              \
	    $(MAKE) -s -C $@ || exit 1;  \
	fi

hardware: $(hardware_subdirs)

# Model build and config
hw_project model sim image synth place route cloud_enable cloud_base cloud_action oc_pr_synth_static oc_pr_synth_action oc_pr_route_static oc_pr_route_action oc_pr_image sim_tmux: $(snap_env_sh)
	@for dir in $(hardware_subdirs); do                \
	    if [ -d $$dir ]; then                          \
	        $(MAKE) -s -C $$dir $@ || exit 1;          \
	    fi                                             \
	done

else #noteq ($(PLATFORM),x86_64)
.PHONY: wrong_platform

wrong_platform:
	@echo; echo "ERROR: SNAP hardware builds and simulation are possible on x86 platform only"; echo;

$(hardware_subdirs) hardware hw_project model sim image cloud_base cloud_action oc_pr_synth_static oc_pr_synth_action oc_pr_route_static oc_pr_route_action oc_pr_image : wrong_platform

endif

# SNAP Config
config menuconfig xconfig gconfig oldconfig silentoldconfig:
	@echo "$@: Setting up SNAP configuration" &>/dev/null
	@touch $(snap_config) && sed '/^#/ d' <$(snap_config) >$(snap_config_bak)
	@for dir in $(config_subdirs); do          \
	    if [ -d $$dir ]; then                  \
	        $(MAKE) -s -C $$dir $@ || exit 1;  \
	    fi                                     \
	done
	@sed '/^#/ d' <$(snap_config) >$(snap_config_new)
	@if [ -n "`diff -q $(snap_config_bak) $(snap_config_new)`" ]; then \
	    $(MAKE) -C hardware clean;                                     \
	fi
	@$(RM) $(snap_config_bak) $(snap_config_new)

snap_config:
	@$(MAKE) -s menuconfig || exit 1
	@$(MAKE) -s snap_env snap_env_parm=config
	@echo "SNAP config done" &>/dev/null
	@echo "-----------" &>/dev/null
	@echo "  Suggested next step: to run a simulation,      execute: make sim" &>/dev/null
	@echo "                    or to build the FPGA binary, execute: make image" &>/dev/null


$(snap_config_sh):
	@$(MAKE) -s menuconfig || exit 1
	@echo "SNAP config done" &>/dev/null
	@echo "-----------" &>/dev/null
	@echo "  Suggested next step: to run a simulation,      execute: make sim" &>/dev/null
	@echo "                    or to build the FPGA binary, execute: make image" &>/dev/null


# Prepare SNAP Environment
$(snap_env_sh) snap_env: $(snap_config_sh)
	@$(SNAP_ROOT)/snap_env $(snap_env_parm) $(ignore_action_root) $(snap_config_sh)

%.defconfig:
	@if [ ! -f defconfig/$@ ]; then			        \
		echo "ERROR: Configuration $@ not existing!";	\
		exit 2 ; 					\
	fi
	@cp defconfig/$@ $(snap_config)
	@$(MAKE) -s oldconfig
	@$(MAKE) -s snap_env

clean:
	@for dir in $(clean_subdirs); do           \
	    if [ -d $$dir ]; then                  \
	        $(MAKE) -s -C  $$dir $@ || exit 1; \
	    fi                                     \
	done
	@find . -depth -name '*~'  -exec rm -rf '{}' \; -print
	@find . -depth -name '.#*' -exec rm -rf '{}' \; -print
	@$(RM) *.log *.mif vivado*.jou vivado*.log

clean_cloud: clean
	@$(MAKE) -s -C  $(hardware_subdirs) $@ || exit 1;


clean_config: clean
	@$(RM) snap_workflow*.log
	@$(RM) null
	@$(RM) $(snap_config)
	@$(RM) $(snap_config_sh)
	@$(RM) $(snap_config_cflags)

clean_env: clean_config
	@$(RM) $(snap_env_sh)

gitclean:
	@echo -e "[GITCLEAN............] cleaning and resetting snap git";
	git clean -f -d -x
	git reset --hard