sims/external/simics: add Makefile recipe for installing Simics

Simply installs vanilla simics under sims/external/simics. Because of licensing
restrictions we cannot automatically download simics from the intel page.
Instead the makefile will prompt the user to download to files and add them to
the simics directory.

This commit does not include any simbricks integration at all yet.
Co-authored-by: Antoine Kaufmann <antoinek@mpi-sws.org>

sims/external/rules.mk

@@ -26,6 +26,8 @@ QEMU_IMG := $(d)qemu/build/qemu-img
 QEMU := $(d)qemu/build/qemu-system-x86_64
 GEM5_VARIANT ?= fast
 
+$(eval $(call subdir,simics))
+
 external: $(d)gem5/ready $(d)qemu/ready $(d)ns-3/ready $(d)femu/ready
 .PHONY: external
 

sims/external/simics/.gitignore

+installdir/
+intel-simics-package-manager*.tar.gz
+latest
+package-manager/
+ready
+simics-6-packages*.ispm

sims/external/simics/rules.mk

+# Copyright 2023 Max Planck Institute for Software Systems, and
+# National University of Singapore
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+include mk/subdir_pre.mk
+
+SIMICS_DIR := $(d)
+
+SIMICS_PKGMGR_DOWNLOAD ?= $(SIMICS_DIR)intel-simics-package-manager.tar.gz
+SIMICS_ISPM_DOWNLOAD ?= $(SIMICS_DIR)simics-6-packages.ispm
+
+SIMICS_ISPM := $(SIMICS_DIR)package-manager/ispm
+SIMICS_INSTALLDIR := $(SIMICS_DIR)installdir
+SIMICS_INSTALL := $(SIMICS_INSTALLDIR)/simics-latest
+
+$(SIMICS_PKGMGR_DOWNLOAD):
+	$(error Download intel-simics-package-manager-(version).tar.gz from \
+		https://www.intel.com/content/www/us/en/developer/articles/tool/simics-simulator.html \
+		and store it as $(SIMICS_PKGMGR_DOWNLOAD) or set \
+		SIMICS_PKGMGR_DOWNLOAD to its path)
+
+$(SIMICS_ISPM_DOWNLOAD):
+	$(error Download simics-6-packages-(version).ispm from \
+		https://www.intel.com/content/www/us/en/developer/articles/tool/simics-simulator.html \
+		and store it as $(SIMICS_ISPM_DOWNLOAD) or set \
+		SIMICS_ISPM_DOWNLOAD to its path)
+
+$(SIMICS_ISPM): $(SIMICS_PKGMGR_DOWNLOAD)
+	mkdir -p $(@D)
+	tar xf $< -C $(@D) --strip-components=1
+	touch $@
+
+$(SIMICS_INSTALL): $(SIMICS_ISPM) $(SIMICS_ISPM_DOWNLOAD)
+	$< packages --install-bundle $(SIMICS_ISPM_DOWNLOAD) \
+		--install-dir $(SIMICS_INSTALLDIR) --non-interactive
+	SIMICS_LATEST=`ls -d $(SIMICS_INSTALLDIR)/simics-?.*/ | tail -n 1`; \
+	ln -sf `basename $$SIMICS_LATEST` $(@)
+
+$(d)ready: $(SIMICS_INSTALL)
+	touch $@
+
+DISTCLEAN := $(SIMICS_PKGMGR_DOWNLOAD) $(SIMICS_ISPM_DOWNLOAD) \
+  $(d)package-manager $(SIMICS_INSTALL) $(SIMICS_INSTALLDIR) $(d)ready
+include mk/subdir_post.mk