teems/Makefile

# Makefile based on the sample Cxx17SGXDemo/Makefile in the SGX SDK:

#
# Copyright (C) 2011-2021 Intel Corporation. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
#   * Redistributions of source code must retain the above copyright
#     notice, this list of conditions and the following disclaimer.
#   * Redistributions in binary form must reproduce the above copyright
#     notice, this list of conditions and the following disclaimer in
#     the documentation and/or other materials provided with the
#     distribution.
#   * Neither the name of Intel Corporation nor the names of its
#     contributors may be used to endorse or promote products derived
#     from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
#

######## SGX SDK Settings ########

SGX_SDK ?= /opt/intel/sgxsdk
SGX_MODE ?= HW
SGX_ARCH ?= x64
SGX_DEBUG ?= 1

ifeq ($(shell getconf LONG_BIT), 32)
	SGX_ARCH := x86
else ifeq ($(findstring -m32, $(CXXFLAGS)), -m32)
	SGX_ARCH := x86
endif

ifeq ($(SGX_ARCH), x86)
	SGX_COMMON_FLAGS := -m32
	SGX_LIBRARY_PATH := $(SGX_SDK)/lib
	SGX_ENCLAVE_SIGNER := $(SGX_SDK)/bin/x86/sgx_sign
	SGX_EDGER8R := $(SGX_SDK)/bin/x86/sgx_edger8r
else
	SGX_COMMON_FLAGS := -m64 -maes -msse2
	SGX_LIBRARY_PATH := $(SGX_SDK)/lib64
	SGX_ENCLAVE_SIGNER := $(SGX_SDK)/bin/x64/sgx_sign
	SGX_EDGER8R := $(SGX_SDK)/bin/x64/sgx_edger8r
endif

ifeq ($(SGX_DEBUG), 1)
ifeq ($(SGX_PRERELEASE), 1)
$(error Cannot set SGX_DEBUG and SGX_PRERELEASE at the same time!!)
endif
endif

ifeq ($(SGX_DEBUG), 1)
        SGX_COMMON_FLAGS += -O3 -g
else
        SGX_COMMON_FLAGS += -O3
endif

SGX_COMMON_FLAGS += -Wall -Wextra -Winit-self -Wpointer-arith -Wreturn-type \
                    -Waddress -Wsequence-point -Wformat-security \
                    -Wmissing-include-dirs -Wfloat-equal -Wundef -Wshadow \
                    -Wcast-align -Wcast-qual -Wconversion -Wredundant-decls
SGX_COMMON_CFLAGS := $(SGX_COMMON_FLAGS) -Wjump-misses-init -Wstrict-prototypes -Wunsuffixed-float-constants
SGX_COMMON_CXXFLAGS := $(SGX_COMMON_FLAGS) -Wnon-virtual-dtor -std=c++17

######## App Settings ########

ifneq ($(SGX_MODE), HW)
	Urts_Library_Name := sgx_urts_sim
else
	Urts_Library_Name := sgx_urts
endif

App_Cpp_Files := $(wildcard App/*.cpp Untrusted/*.cpp)
App_Include_Paths := -IApp -IUntrusted -I$(SGX_SDK)/include

App_C_Flags := -fPIC -Wno-attributes $(App_Include_Paths)

# Three configuration modes - Debug, prerelease, release
#   Debug - Macro DEBUG enabled.
#   Prerelease - Macro NDEBUG and EDEBUG enabled.
#   Release - Macro NDEBUG enabled.
ifeq ($(SGX_DEBUG), 1)
        App_C_Flags += -DDEBUG -UNDEBUG -UEDEBUG
else ifeq ($(SGX_PRERELEASE), 1)
        App_C_Flags += -DNDEBUG -DEDEBUG -UDEBUG
else
        App_C_Flags += -DNDEBUG -UEDEBUG -UDEBUG
endif

App_Cpp_Flags := $(App_C_Flags)
App_Link_Flags := -lboost_thread -L$(SGX_LIBRARY_PATH) -l$(Urts_Library_Name) -lpthread

App_Cpp_Objects := $(App_Cpp_Files:.cpp=.o)

App_Name := App/teems

######## Enclave Settings ########

Enclave_Version_Script := Enclave/Enclave_debug.lds
ifeq ($(SGX_MODE), HW)
ifneq ($(SGX_DEBUG), 1)
ifneq ($(SGX_PRERELEASE), 1)
	# Choose to use 'Enclave.lds' for HW release mode
	Enclave_Version_Script = Enclave/Enclave.lds
endif
endif
endif

ifneq ($(SGX_MODE), HW)
	Trts_Library_Name := sgx_trts_sim
	Service_Library_Name := sgx_tservice_sim
else
	Trts_Library_Name := sgx_trts
	Service_Library_Name := sgx_tservice
endif
Crypto_Library_Name := sgx_tcrypto

Enclave_Cpp_Files := $(wildcard Enclave/*.cpp Enclave/OblivAlgs/*.cpp)
Enclave_Include_Paths := -IEnclave -IEnclave/OblivAlgs -I$(SGX_SDK)/include -I$(SGX_SDK)/include/libcxx -I$(SGX_SDK)/include/tlibc

Enclave_C_Flags := -nostdinc -fvisibility=hidden -fpie -fstack-protector -fno-builtin-printf $(Enclave_Include_Paths)
Enclave_Cpp_Flags := $(Enclave_C_Flags) -nostdinc++

# Enable the security flags
Enclave_Security_Link_Flags := -Wl,-z,relro,-z,now,-z,noexecstack

# To generate a proper enclave, it is recommended to follow below guideline to link the trusted libraries:
#    1. Link sgx_trts with the `--whole-archive' and `--no-whole-archive' options,
#       so that the whole content of trts is included in the enclave.
#    2. For other libraries, you just need to pull the required symbols.
#       Use `--start-group' and `--end-group' to link these libraries.
# Do NOT move the libraries linked with `--start-group' and `--end-group' within `--whole-archive' and `--no-whole-archive' options.
# Otherwise, you may get some undesirable errors.
Enclave_Link_Flags := $(Enclave_Security_Link_Flags) \
    -Wl,--no-undefined -nostdlib -nodefaultlibs -nostartfiles -L$(SGX_LIBRARY_PATH) \
	-Wl,--whole-archive -l$(Trts_Library_Name) -Wl,--no-whole-archive \
	-Wl,--start-group -lsgx_tstdc -lsgx_tcxx -l$(Crypto_Library_Name) -l$(Service_Library_Name) -lsgx_pthread -Wl,--end-group \
	-Wl,-Bstatic -Wl,-Bsymbolic -Wl,--no-undefined \
	-Wl,-pie,-eenclave_entry -Wl,--export-dynamic  \
	-Wl,--defsym,__ImageBase=0 \
	-Wl,--version-script=$(Enclave_Version_Script)

Enclave_Cpp_Objects := $(Enclave_Cpp_Files:.cpp=.o)

Enclave_Name := Enclave/enclave.so
Signed_Enclave_Name := App/enclave.signed.so
Enclave_Config_File := Enclave/Enclave.config.xml
Enclave_Test_Key := Enclave/Enclave_private_test.pem

ifeq ($(SGX_MODE), HW)
ifeq ($(SGX_DEBUG), 1)
	Build_Mode = HW_DEBUG
else ifeq ($(SGX_PRERELEASE), 1)
	Build_Mode = HW_PRERELEASE
else
	Build_Mode = HW_RELEASE
endif
else
ifeq ($(SGX_DEBUG), 1)
	Build_Mode = SIM_DEBUG
else ifeq ($(SGX_PRERELEASE), 1)
	Build_Mode = SIM_PRERELEASE
else
	Build_Mode = SIM_RELEASE
endif
endif


.PHONY: all run target
all: .config_$(Build_Mode)_$(SGX_ARCH)
	@$(MAKE) target

ifeq ($(Build_Mode), HW_RELEASE)
target: $(App_Name) $(Enclave_Name)
	@echo "The project has been built in release hardware mode."
	@echo "Please sign the $(Enclave_Name) first with your signing key before you run the $(App_Name) to launch and access the enclave."
	@echo "To sign the enclave use the command:"
	@echo "   $(SGX_ENCLAVE_SIGNER) sign -key <your key> -enclave $(Enclave_Name) -out <$(Signed_Enclave_Name)> -config $(Enclave_Config_File)"
	@echo "You can also sign the enclave using an external signing tool."
	@echo "To build the project in simulation mode set SGX_MODE=SIM. To build the project in prerelease mode set SGX_PRERELEASE=1 and SGX_MODE=HW."
else
target: $(App_Name) $(Signed_Enclave_Name)
ifeq ($(Build_Mode), HW_DEBUG)
	@echo "The project has been built in debug hardware mode."
else ifeq ($(Build_Mode), SIM_DEBUG)
	@echo "The project has been built in debug simulation mode."
else ifeq ($(Build_Mode), HW_PRERELEASE)
	@echo "The project has been built in pre-release hardware mode."
else ifeq ($(Build_Mode), SIM_PRERELEASE)
	@echo "The project has been built in pre-release simulation mode."
else
	@echo "The project has been built in release simulation mode."
endif
endif

run: all
ifneq ($(Build_Mode), HW_RELEASE)
	@echo "RUN  =>  $(App_Name) [$(SGX_MODE)|$(SGX_ARCH), OK]"
	@$(CURDIR)/$(App_Name)
endif

.config_$(Build_Mode)_$(SGX_ARCH):
	@rm -f .config_* $(App_Name) $(Enclave_Name) $(Signed_Enclave_Name) $(App_Cpp_Objects) Untrusted/Enclave_u.* $(Enclave_Cpp_Objects) Enclave/Enclave_t.*
	@touch .config_$(Build_Mode)_$(SGX_ARCH)

######## App Objects ########

Untrusted/Enclave_u.h: $(SGX_EDGER8R) Enclave/Enclave.edl
	@echo "GEN  =>  $@"
	@cd Untrusted && $(SGX_EDGER8R) --untrusted ../Enclave/Enclave.edl --search-path ../Enclave --search-path $(SGX_SDK)/include

Untrusted/Enclave_u.c: Untrusted/Enclave_u.h

Untrusted/Enclave_u.o: Untrusted/Enclave_u.c Untrusted/Enclave_u.h
	@echo "CC   <=  $<"
	@$(CC) $(SGX_COMMON_CFLAGS) $(App_C_Flags) -c $< -o $@

Untrusted/%.o: Untrusted/%.cpp Untrusted/Enclave_u.h
	@echo "CXX  <=  $<"
	@$(CXX) $(SGX_COMMON_CXXFLAGS) $(App_Cpp_Flags) -c $< -o $@

App/%.o: App/%.cpp Untrusted/Enclave_u.h
	@echo "CXX  <=  $<"
	@$(CXX) $(SGX_COMMON_CXXFLAGS) $(App_Cpp_Flags) -c $< -o $@

$(App_Name): Untrusted/Enclave_u.o $(App_Cpp_Objects)
	@echo "LINK =>  $@"
	@$(CXX) $^ -o $@ $(App_Link_Flags)

######## Enclave Objects ########

Enclave/Enclave_t.h: $(SGX_EDGER8R) Enclave/Enclave.edl
	@echo "GEN  =>  $@"
	@cd Enclave && $(SGX_EDGER8R) --trusted ../Enclave/Enclave.edl --search-path ../Enclave --search-path $(SGX_SDK)/include

Enclave/Enclave_t.c: Enclave/Enclave_t.h

Enclave/Enclave_t.o: Enclave/Enclave_t.c Enclave/Enclave_t.h
	@echo "CC   <=  $<"
	@$(CC) $(SGX_COMMON_CFLAGS) $(Enclave_C_Flags) -c $< -o $@

Enclave/%.o: Enclave/%.cpp
	@echo "CXX  <=  $<"
	@$(CXX) $(SGX_COMMON_CXXFLAGS) $(Enclave_Cpp_Flags) -c $< -o $@

$(Enclave_Cpp_Objects): Enclave/Enclave_t.h

$(Enclave_Name): Enclave/Enclave_t.o $(Enclave_Cpp_Objects)
	@echo "LINK =>  $@"
	@$(CXX) $^ -o $@ $(Enclave_Link_Flags)

$(Signed_Enclave_Name): $(Enclave_Name) $(Enclave_Config_File)
ifeq ($(wildcard $(Enclave_Test_Key)),)
	@echo "There is no enclave test key<Enclave_private_test.pem>."
	@echo "The project will generate a key<Enclave_private_test.pem> for test."
	@openssl genrsa -out $(Enclave_Test_Key) -3 3072
endif
	@echo "SIGN =>  $@"
	@$(SGX_ENCLAVE_SIGNER) sign -key $(Enclave_Test_Key) -enclave $(Enclave_Name) -out $@ -config $(Enclave_Config_File)

.PHONY: clean

clean:
	@rm -f .config_* $(App_Name) $(Enclave_Name) $(Signed_Enclave_Name) $(App_Cpp_Objects) Untrusted/Enclave_u.* $(Enclave_Cpp_Objects) Enclave/Enclave_t.*

depend:
	makedepend -Y -- -IApp -IUntrusted -- $(App_Cpp_Files)
	makedepend -a -Y -- -IEnclave -- $(Enclave_Cpp_Files)

# DO NOT DELETE

App/appconfig.o: Untrusted/Untrusted.hpp Enclave/enclave_api.h
App/appconfig.o: App/appconfig.hpp
App/net.o: Untrusted/Enclave_u.h Enclave/enclave_api.h
App/net.o: Untrusted/Untrusted.hpp App/net.hpp App/appconfig.hpp
App/start.o: App/start.hpp App/net.hpp App/appconfig.hpp
App/start.o: Enclave/enclave_api.h
App/teems.o: Untrusted/Untrusted.hpp Enclave/enclave_api.h App/appconfig.hpp
App/teems.o: App/net.hpp App/start.hpp
Untrusted/Untrusted.o: Untrusted/Untrusted.hpp Enclave/enclave_api.h
Untrusted/Untrusted.o: Untrusted/Enclave_u.h

Enclave/comms.o: Enclave/Enclave_t.h Enclave/enclave_api.h Enclave/config.hpp
Enclave/comms.o: Enclave/enclave_api.h
Enclave/config.o: Enclave/Enclave_t.h Enclave/enclave_api.h Enclave/comms.hpp
Enclave/config.o: Enclave/enclave_api.h Enclave/config.hpp Enclave/route.hpp
Enclave/route.o: Enclave/Enclave_t.h Enclave/enclave_api.h Enclave/config.hpp
Enclave/route.o: Enclave/enclave_api.h Enclave/route.hpp
Enclave/sort.o: Enclave/sort.hpp
Enclave/OblivAlgs/RecursiveShuffle.o: Enclave/OblivAlgs/oasm_lib.h
Enclave/OblivAlgs/RecursiveShuffle.o: Enclave/OblivAlgs/CONFIG.h
Enclave/OblivAlgs/RecursiveShuffle.o: Enclave/OblivAlgs/oasm_lib.tcc
Enclave/OblivAlgs/RecursiveShuffle.o: Enclave/OblivAlgs/foav.h
Enclave/OblivAlgs/RecursiveShuffle.o: Enclave/OblivAlgs/utils.hpp
Enclave/OblivAlgs/RecursiveShuffle.o: Enclave/Enclave_t.h
Enclave/OblivAlgs/RecursiveShuffle.o: Enclave/enclave_api.h
Enclave/OblivAlgs/RecursiveShuffle.o: Enclave/OblivAlgs/RecursiveShuffle.hpp
Enclave/OblivAlgs/RecursiveShuffle.o: Enclave/OblivAlgs/TightCompaction_v2.hpp
Enclave/OblivAlgs/RecursiveShuffle.o: Enclave/OblivAlgs/TightCompaction_v2.tcc
Enclave/OblivAlgs/RecursiveShuffle.o: Enclave/OblivAlgs/RecursiveShuffle.tcc
Enclave/OblivAlgs/SortingNetwork.o: Enclave/OblivAlgs/SortingNetwork.hpp
Enclave/OblivAlgs/SortingNetwork.o: Enclave/OblivAlgs/oasm_lib.h
Enclave/OblivAlgs/SortingNetwork.o: Enclave/OblivAlgs/CONFIG.h
Enclave/OblivAlgs/SortingNetwork.o: Enclave/OblivAlgs/oasm_lib.tcc
Enclave/OblivAlgs/SortingNetwork.o: Enclave/OblivAlgs/foav.h
Enclave/OblivAlgs/SortingNetwork.o: Enclave/OblivAlgs/utils.hpp
Enclave/OblivAlgs/SortingNetwork.o: Enclave/Enclave_t.h Enclave/enclave_api.h
Enclave/OblivAlgs/SortingNetwork.o: Enclave/OblivAlgs/SortingNetwork.tcc
Enclave/OblivAlgs/TightCompaction_v2.o: Enclave/OblivAlgs/TightCompaction_v2.hpp
Enclave/OblivAlgs/TightCompaction_v2.o: Enclave/OblivAlgs/oasm_lib.h
Enclave/OblivAlgs/TightCompaction_v2.o: Enclave/OblivAlgs/CONFIG.h
Enclave/OblivAlgs/TightCompaction_v2.o: Enclave/OblivAlgs/oasm_lib.tcc
Enclave/OblivAlgs/TightCompaction_v2.o: Enclave/OblivAlgs/foav.h
Enclave/OblivAlgs/TightCompaction_v2.o: Enclave/OblivAlgs/utils.hpp
Enclave/OblivAlgs/TightCompaction_v2.o: Enclave/Enclave_t.h
Enclave/OblivAlgs/TightCompaction_v2.o: Enclave/enclave_api.h
Enclave/OblivAlgs/TightCompaction_v2.o: Enclave/OblivAlgs/TightCompaction_v2.tcc
Enclave/OblivAlgs/utils.o: Enclave/OblivAlgs/utils.hpp Enclave/Enclave_t.h
Enclave/OblivAlgs/utils.o: Enclave/enclave_api.h Enclave/OblivAlgs/CONFIG.h
Enclave/OblivAlgs/utils.o: Enclave/OblivAlgs/oasm_lib.h
Enclave/OblivAlgs/utils.o: Enclave/OblivAlgs/oasm_lib.tcc
Enclave/OblivAlgs/utils.o: Enclave/OblivAlgs/foav.h
Enclave/OblivAlgs/WaksmanNetwork.o: Enclave/OblivAlgs/SortingNetwork.hpp
Enclave/OblivAlgs/WaksmanNetwork.o: Enclave/OblivAlgs/oasm_lib.h
Enclave/OblivAlgs/WaksmanNetwork.o: Enclave/OblivAlgs/CONFIG.h
Enclave/OblivAlgs/WaksmanNetwork.o: Enclave/OblivAlgs/oasm_lib.tcc
Enclave/OblivAlgs/WaksmanNetwork.o: Enclave/OblivAlgs/foav.h
Enclave/OblivAlgs/WaksmanNetwork.o: Enclave/OblivAlgs/utils.hpp
Enclave/OblivAlgs/WaksmanNetwork.o: Enclave/Enclave_t.h Enclave/enclave_api.h
Enclave/OblivAlgs/WaksmanNetwork.o: Enclave/OblivAlgs/SortingNetwork.tcc
Enclave/OblivAlgs/WaksmanNetwork.o: Enclave/OblivAlgs/WaksmanNetwork.hpp
Enclave/OblivAlgs/WaksmanNetwork.o: Enclave/OblivAlgs/RecursiveShuffle.hpp
Enclave/OblivAlgs/WaksmanNetwork.o: Enclave/OblivAlgs/TightCompaction_v2.hpp
Enclave/OblivAlgs/WaksmanNetwork.o: Enclave/OblivAlgs/TightCompaction_v2.tcc
Enclave/OblivAlgs/WaksmanNetwork.o: Enclave/OblivAlgs/RecursiveShuffle.tcc
Enclave/OblivAlgs/WaksmanNetwork.o: Enclave/OblivAlgs/aes.hpp
Enclave/OblivAlgs/WaksmanNetwork.o: Enclave/OblivAlgs/WaksmanNetwork.tcc