Be more explicit in Makefiles about external libraries linking
[TD_C.git] / TP_13 / exo1 / Makefile
index 146115f0af178fc9623f83ebfacc19a8f3fa5930..55808324352487727f845abb810d906d6d84f483 100644 (file)
@@ -1,58 +1,68 @@
 # Sample Makefile to build simple project.
 #
 # This Makefile expect all source files (.c) to be at the same level, in the
-# current working directory.
+# $(SRC_PATH) directory.
+#
+# This Makefile expect all embedded library source files (.c) to be at the same level, in the
+# $(LIBRARY_PATH) directory.
 #
 # It will automatically generate dependencies, compile all files, and produce a
-# binary using the provided name.
+# binary using the provided name linked against the library if necessary.
 #
 # Set BINARY_NAME to the name of the binary file to build.
-# Set BUILD_TYPE to either debug or release
+# Set LIBRARY_NAME to the name of the library file to build.
+# The default path for the library code and object is lib.
+# By default the linker will look for $(BINARY_NAME) library name.
+# Set BUILD_TYPE to either debug or release.
 #
 # Automatic dependencies code from:
 # http://make.mad-scientist.net/papers/advanced-auto-dependency-generation/#tldr
-BINARY_NAME=exo1
-BINARY_PATH:=src
-LIBRARY_NAME=libexo1
+BINARY_NAME:=exo1
+SRC_PATH:=src
+LIBRARY_NAME:=lib$(BINARY_NAME)
 LIBRARY_PATH:=lib
-BUILD_TYPE=debug
+LDLIBS:=-l$(BINARY_NAME)
+BUILD_TYPE:=debug
+#BUILD_TYPE=release
 
 # ====================================
 # DO NOT CHANGE STUFF BEYOND THIS LINE
 # ====================================
 
-all: $(BINARY_NAME) $(BINARY_NAME).dynamic $(BINARY_NAME).static
-
 CC=gcc
 LD=gcc
 AR=ar
 
 WARN_FLAGS = -Wall -Wextra
 STD_FLAG = -std=c11
+UNAME := $(shell uname -o)
 
 ifeq ($(BUILD_TYPE),debug)
 BUILDDIR := .build/debug
 DEBUG_FLAG = -g
 STRIP_FLAG =
 OPTI_FLAG = -O0
+LTO_SUPPORT = yes
+GOLD_SUPPORT = yes
 else
 BUILDDIR := .build/release
 DEBUG_FLAG =
 STRIP_FLAG = -s
 OPTI_FLAG = -O3
+LTO_SUPPORT = yes
+GOLD_SUPPORT = yes
 endif
 
-CFLAGS := $(CFLAGS) $(WARN_FLAGS) $(STD_FLAG) $(OPTI_FLAG) $(DEBUG_FLAG)
-LIBCFLAGS := -fPIC $(CFLAGS)
-LDFLAGS := $(LDFLAGS) $(STRIP_FLAG)
-LIBLDFLAGS := -shared $(LDFLAGS)
-STATICLIBLDFLAGS := -static $(LDFLAGS)
-LDLIBS := $(LDLIBS) -L$(LIBRARY_PATH) -l$(BINARY_NAME)
+BINARY_SUFFIX :=
+DLIB_PREFIX :=
+SDLIB_PREFIX :=
+DLIB_SUFFIX := .so
+SLIB_SUFFIX := .a
 
 OBJDIR := $(BUILDDIR)/objs
 $(shell mkdir -p $(OBJDIR))
 
-SRCS=$(wildcard $(BINARY_PATH)/*.c)
+SRCS=$(wildcard $(SRC_PATH)/*.c)
 LIBSRCS=$(wildcard $(LIBRARY_PATH)/*.c)
 OBJS=$(patsubst %.c,$(OBJDIR)/%.o,$(notdir $(SRCS)))
 LIBOBJS=$(patsubst %.c,$(OBJDIR)/%.o,$(notdir $(LIBSRCS)))
@@ -62,51 +72,80 @@ $(shell mkdir -p $(DEPDIR))
 DEPFLAGS = -MT $@ -MMD -MP -MF $(DEPDIR)/$(notdir $*).Td
 POSTCOMPILE = mv -f $(DEPDIR)/$(notdir $*).Td $(DEPDIR)/$(notdir $*).d
 
-print: 
-       @echo $(basename $(notdir $(SRCS)))
-       @echo $(notdir $(SRCS))
-       @echo $(DEPDIR)/%d
-       @echo $(wildcard $(patsubst %,$(DEPDIR)/%.d,$(basename $(SRCS))))
-       @echo $(OBJS) $(LIBOBJS)
-       @echo $(SRCS) $(LIBSRCS)
-       @echo $(POSTCOMPILE)
+ifeq ($(UNAME),Cygwin)
+CYGWIN_DLIBRARY_NAME := $(subst lib,cyg,$(LIBRARY_NAME))
+GOLD_SUPPORT = no
+BINARY_SUFFIX := .exe
+DLIB_SUFFIX := .dll
+CYGWIN_LDLIBS_NOARCHIVE :=
+CYGWIN_LIBLDFLAGS := -Wl,--out-implib=$(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX).a \
+    -Wl,--export-all-symbols \
+    -Wl,--enable-auto-import
+endif
+
+ifeq ($(LTO_SUPPORT),yes)
+CFLAGS_LTO = -flto -ffat-lto-objects
+LDFLAGS_LTO = -fuse-linker-plugin -flto
+endif
+
+ifeq ($(GOLD_SUPPORT),yes)
+LDFLAGS_GOLD = -fuse-ld=gold
+endif
+
+# Putting header files in the source directory is not the purpose of this INCLUDES_PATH variable
+INCLUDES_PATH := $(INCLUDES_PATH) -I$(LIBRARY_PATH)
+CFLAGS := $(CFLAGS) $(CFLAGS_LTO) $(WARN_FLAGS) $(STD_FLAG) $(OPTI_FLAG) $(DEBUG_FLAG) $(INCLUDES_PATH)
+LIBCFLAGS := -fPIC $(CFLAGS)
+LDFLAGS := $(LDFLAGS) $(LDFLAGS_LTO) $(LDFLAGS_GOLD) $(STRIP_FLAG)
+LIBLDFLAGS := -shared $(LDFLAGS)
+STATICLIBLDFLAGS := -static $(LDFLAGS)
+LDLIBS := $(LDLIBS) -L$(LIBRARY_PATH)
+
+all: $(BINARY_NAME)$(BINARY_SUFFIX) $(BINARY_NAME).dynamic$(BINARY_SUFFIX) $(BINARY_NAME).static$(BINARY_SUFFIX)
 
-$(LIBRARY_PATH)/$(LIBRARY_NAME).a: $(LIBOBJS)
+$(LIBRARY_PATH)/$(SLIB_PREFIX)$(LIBRARY_NAME)$(SLIB_SUFFIX): $(LIBOBJS)
        @echo "[AR StO] $@"
        @$(AR) rcs $@ $^
 
-$(LIBRARY_PATH)/$(LIBRARY_NAME).so: $(LIBOBJS)
+ifeq ($(UNAME),Cygwin)
+$(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX).a: $(LIBRARY_PATH)/$(DLIB_PREFIX)$(CYGWIN_DLIBRARY_NAME)$(DLIB_SUFFIX)
+$(LIBRARY_PATH)/$(DLIB_PREFIX)$(CYGWIN_DLIBRARY_NAME)$(DLIB_SUFFIX): $(LIBOBJS)
+       @echo "[LD DLL] $@"
+       @$(LD) $(LIBCFLAGS) $(LIBLDFLAGS) $(CYGWIN_LIBLDFLAGS) -Wl,--whole-archive $^ -Wl,--no-whole-archive $(CYGWIN_LDLIBS_NOARCHIVE) -o $@
+else
+$(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX): $(LIBOBJS)
        @echo "[LD ShO] $@"
        @$(LD) $(LIBCFLAGS) $(LIBLDFLAGS) $^ -o $@
+endif
 
-#$(BINARY_NAME): $(OBJS) $(LIBOBJS)
+#$(BINARY_NAME)$(BINARY_SUFFIX): $(OBJS) $(LIBOBJS)
 #      @echo "[LD ] $@"
 #      @$(LD) $(CFLAGS) $(LDFLAGS) $^ $(LDLIBS) -o $@
 
-$(BINARY_NAME): $(OBJS) $(LIBRARY_PATH)/$(LIBRARY_NAME).a
+$(BINARY_NAME)$(BINARY_SUFFIX): $(OBJS) $(LIBRARY_PATH)/$(SLIB_PREFIX)$(LIBRARY_NAME)$(SLIB_SUFFIX)
        @echo "[LD ] $@"
        @$(LD) $(CFLAGS) $(LDFLAGS) $^ $(LDLIBS) -o $@
 
-$(BINARY_NAME).static: $(OBJS) $(LIBRARY_PATH)/$(LIBRARY_NAME).a
+$(BINARY_NAME).static$(BINARY_SUFFIX): $(OBJS) $(LIBRARY_PATH)/$(SLIB_PREFIX)$(LIBRARY_NAME)$(SLIB_SUFFIX)
        @echo "[LD ] $@"
        @$(LD) $(CFLAGS) $(STATICLIBLDFLAGS) $^ $(LDLIBS) -o $@
 
-#$(BINARY_NAME).staticlocal: $(OBJS) $(LIBRARY_PATH)/$(LIBRARY_NAME).a
-#      @echo "[LD ] $@"
-#      @$(LD) $(CFLAGS) $(LDFLAGS) $^ $(LDLIBS) -o $@
-
-$(BINARY_NAME).dynamic: $(OBJS) $(LIBRARY_PATH)/$(LIBRARY_NAME).so
+ifeq ($(UNAME),Cygwin)
+$(BINARY_NAME).dynamic$(BINARY_SUFFIX): $(OBJS) $(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX).a
+else
+$(BINARY_NAME).dynamic$(BINARY_SUFFIX): $(OBJS) $(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX)
+endif
        @echo "[LD ] $@"
        @$(LD) $(CFLAGS) $(LDFLAGS) $^ $(LDLIBS) -o $@
 
-$(OBJS): $(SRCS) $(DEPDIR)/%.d
+$(OBJDIR)/%.o: $(SRC_PATH)/%.c $(DEPDIR)/%.d
        @echo "[C  ] $(notdir $*)"
        @$(CC) $(DEPFLAGS) $(CFLAGS) -c $< -o $@
        @$(POSTCOMPILE)
 
 include $(wildcard $(patsubst %,$(DEPDIR)/%.d,$(basename $(SRCS))))
 
-$(LIBOBJS): $(LIBSRCS) $(DEPDIR)/%.d
+$(OBJDIR)/%.o: $(LIBRARY_PATH)/%.c $(DEPDIR)/%.d
        @echo "[C  ] $(notdir $*)"
        @$(CC) $(DEPFLAGS) $(LIBCFLAGS) -c $< -o $@
        @$(POSTCOMPILE)
@@ -122,14 +161,19 @@ $(DEPDIR)/%.d: ;
 clean:
        @echo "[CLN]"
        -@rm -r $(BUILDDIR)
-       -@rm $(BINARY_NAME)
-       -@rm $(BINARY_NAME).static
-       -@rm $(BINARY_NAME).dynamic
-       -@rm $(LIBRARY_PATH)/$(LIBRARY_NAME).a
-       -@rm $(LIBRARY_PATH)/$(LIBRARY_NAME).so
+       -@rm $(BINARY_NAME)$(BINARY_SUFFIX)
+       -@rm $(BINARY_NAME).static$(BINARY_SUFFIX)
+       -@rm $(BINARY_NAME).dynamic$(BINARY_SUFFIX)
+       -@rm $(LIBRARY_PATH)/$(SLIB_PREFIX)$(LIBRARY_NAME)$(SLIB_SUFFIX)
+ifeq ($(UNAME),Cygwin)
+       -@rm $(LIBRARY_PATH)/$(DLIB_PREFIX)$(CYGWIN_DLIBRARY_NAME)$(DLIB_SUFFIX)
+       -@rm $(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX).a
+else
+       -@rm $(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX)
+endif
 
-disassemble: $(BINARY_NAME)
+disassemble: $(BINARY_NAME)$(BINARY_SUFFIX)
        objdump -d $< | less
 
-symbols: $(BINARY_NAME)
+symbols: $(BINARY_NAME)$(BINARY_SUFFIX)
        objdump -t $< | sort | less