Makefile

#       Copyright 2020 Two Sigma Investments, LP.
#
#       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.

#BUILD ?= debug
BUILD ?= release

BUILD_FLAGS ?=
ifeq ($(BUILD),release)
	BUILD_FLAGS += --release
endif

CARGO ?= $(HOME)/.cargo/bin/cargo
ifeq (,$(wildcard $(CARGO)))
	CARGO := cargo
endif

SRCS := $(wildcard src/*.rs src/**/*.rs) Cargo.toml

all: fastfreeze.tar.xz

.PHONY: $(build_deps)
build_deps:
	$(MAKE) -C deps

deps/%: build_deps;

DIST_DIR = dist
DIST_BIN_DIR = $(DIST_DIR)/bin
DIST_LIB_DIR = $(DIST_DIR)/lib

$(DIST_DIR):
	mkdir -p $@

$(DIST_BIN_DIR):
	mkdir -p $@

$(DIST_LIB_DIR):
	mkdir -p $@

DIST_BINS := \
	deps/criu/criu/criu \
	deps/criu-image-streamer/criu-image-streamer \
	deps/gcsthin/gcsthin \
	deps/set_ns_last_pid/set_ns_last_pid \
	target/$(BUILD)/fastfreeze \
	$(shell which pv) \
	$(shell which lz4) \
	$(shell which zstd) \
	$(shell which openssl) \

DIST_LIBS := \
	deps/libvirtcpuid/ld-virtcpuid.so \
	deps/libvirtcpuid/libvirtcpuid.so \
	deps/libvirttime/libvirttime.so \

DIST_MISC := scripts/fastfreeze \

# We assume an installation location. This is only used when the user
# makes one of the binary secure (like criu, or set_ns_last_pid) via
# setuid/setcap. See more info on the comment near extract-libs
INSTALL_LOCATION=/opt/fastfreeze

# We avoid packaging libc libraries because they work in tandem with the system
# ELF loader (typically /lib64/ld-linux-x86-64.so.2). We could package the ELF
# loader, but that ties our installation to something like /opt/fastfreeze,
# and that's not desirable.
PACKAGE_SKIP_LIBS := \
	librt.so.* \
	libdl.so.* \
	libpthread.so.* \
	libc.so.* \
	libm.so.* \
	ld-linux-*.so.* \

define add_dist_file
$(eval SRC_FILE := $(1))
$(eval DST_DIR := $(2))
$(eval DST_FILE := $(DST_DIR)/$(notdir $(SRC_FILE)))

DIST_FILES += $(DST_FILE)
$(DST_FILE): $(SRC_FILE) | $(DST_DIR)
	cp -aL $$< $$@
endef

$(foreach path,$(DIST_BINS),$(eval \
	$(call add_dist_file,$(path),$(DIST_BIN_DIR)) \
	$(eval DIST_ELF_FILES += $(DST_FILE)) \
))

$(foreach path,$(DIST_LIBS),$(eval \
	$(call add_dist_file,$(path),$(DIST_LIB_DIR)) \
	$(eval DIST_ELF_FILES += $(DST_FILE)) \
))

$(foreach path,$(DIST_MISC),$(eval \
	$(call add_dist_file,$(path),$(DIST_DIR)) \
))

target/$(BUILD)/fastfreeze: $(SRCS)
	$(CARGO) build $(BUILD_FLAGS)

.PHONY: test clean extract-libs

clean:
	rm -rf target $(DIST_DIR)
	@echo Dependencies are not cleaned. You may do so with: make -C deps clean

# In the following, we package libraries needed by our binary distribution.
# Normally, our wrapper script will set LD_LIBRARY_PATH to ensure proper lib
# loading, but if the user sets setcap/setuid on certain binaries, then
# these become secure binary. Meaning that LD_LIBRARY_PATH won't work,
# and $ORIGIN in RPATH won't work either. So we hard-code RPATH to
# /opt/fastfreeze/lib. It's not great, but it's better than nothing.
extract-libs: $(DIST_ELF_FILES) | $(DIST_LIB_DIR)
	ldd $(DIST_ELF_FILES) | sed 's/.*=> \(.*\) .*/\1/;t;d' | \
		sort -u | \
		xargs realpath -s | \
		grep -v $(DIST_LIB_DIR)/ | \
		grep -v -E /\($$(echo '$(PACKAGE_SKIP_LIBS)' | sed -e 's/ $$//' -e 's/ /|/g' -e 's/\./\\./g' -e 's/\*/.*/g')\)$$ | \
		xargs -I'{}' cp -L '{}' $(DIST_LIB_DIR)/
	for file in $$(echo $(DIST_ELF_FILES) $(DIST_LIB_DIR)/* | \
			tr " " "\n" | sort -u | grep -v 'ld-.*.so'); do \
		RPATH=$(INSTALL_LOCATION)/lib; \
		echo "Patching rpath=$$RPATH of $$file"; \
		patchelf --set-rpath $$RPATH $$file ;\
	done

fastfreeze.tar.xz: $(DIST_FILES) extract-libs Makefile
	tar --transform 's|^$(DIST_DIR)|fastfreeze|' -cJf $@ $(DIST_DIR)