Makefile

   1 # Sample Makefile to build simple project.
   2 #
   3 # This Makefile expect all source files (.c) to be at the same level, in the
   4 # $(SRC_PATH) directory.
   5 #
   6 # This Makefile expect all embedded library source files (.c) to be at the same level, in the
   7 # $(LIBRARY_PATH) directory.
   8 #
   9 # It will automatically generate dependencies, compile all files, and produce a
  10 # binary using the provided name linked against the library if necessary.
  11 #
  12 # Set BINARY_NAME to the name of the binary file to build.
  13 # Set LIBRARY_NAME to the name of the library file to build.
  14 # The default path for the library code and object is lib.
  15 # By default the linker will look for $(BINARY_NAME) library name.
  16 # Set BUILD_TYPE to either debug or release.
  17 #
  18 # Automatic dependencies code from:
  19 # http://make.mad-scientist.net/papers/advanced-auto-dependency-generation/#tldr
  20 BINARY_NAME:=othello
  21 SRC_PATH:=src
  22 LIBRARY_NAME:=lib$(BINARY_NAME)
  23 LIBRARY_PATH:=lib
  24 LDLIBS:=-l$(BINARY_NAME) -lncurses -ltinfo
  25 BUILD_TYPE:=debug
  26 #BUILD_TYPE:=release
  27
  28 # ====================================
  29 # DO NOT CHANGE STUFF BEYOND THIS LINE
  30 # ====================================
  31
  32 CC=gcc
  33 LD=gcc
  34 AR=ar
  35
  36 WARN_FLAGS = -Wall -Wextra
  37 STD_FLAG = -std=c11
  38 UNAME := $(shell uname -s)
  39
  40 ifeq ($(BUILD_TYPE),debug)
  41 BUILDDIR := .build/debug
  42 DEBUG_FLAG = -g
  43 STRIP_FLAG =
  44 OPTI_FLAG = -O0
  45 LTO_SUPPORT = yes
  46 GOLD_SUPPORT = yes
  47 else
  48 BUILDDIR := .build/release
  49 DEBUG_FLAG =
  50 STRIP_FLAG = -s
  51 OPTI_FLAG = -O3
  52 LTO_SUPPORT = yes
  53 GOLD_SUPPORT = yes
  54 endif
  55
  56 BINARY_SUFFIX :=
  57 DLIB_PREFIX :=
  58 SDLIB_PREFIX :=
  59 SHLIBLDFLAG := -shared
  60 DLIB_SUFFIX := .so
  61 SLIB_SUFFIX := .a
  62
  63 OBJDIR := $(BUILDDIR)/objs
  64 $(shell mkdir -p $(OBJDIR))
  65
  66 SRCS=$(wildcard $(SRC_PATH)/*.c)
  67 LIBSRCS=$(wildcard $(LIBRARY_PATH)/*.c)
  68 OBJS=$(patsubst %.c,$(OBJDIR)/%.o,$(notdir $(SRCS)))
  69 LIBOBJS=$(patsubst %.c,$(OBJDIR)/%.o,$(notdir $(LIBSRCS)))
  70
  71 DEPDIR := $(BUILDDIR)/deps
  72 $(shell mkdir -p $(DEPDIR))
  73 DEPFLAGS = -MT $@ -MMD -MP -MF $(DEPDIR)/$(notdir $*).Td
  74 POSTCOMPILE = mv -f $(DEPDIR)/$(notdir $*).Td $(DEPDIR)/$(notdir $*).d
  75
  76 ifeq ($(findstring CYGWIN_NT,$(UNAME)),CYGWIN_NT)
  77 CYGWIN_DLIBRARY_NAME := $(subst lib,cyg,$(LIBRARY_NAME))
  78 GOLD_SUPPORT = no
  79 # Cygwin ncurses do not contain tinfo
  80 LDLIBS := $(filter-out -ltinfo,$(LDLIBS))
  81 BINARY_SUFFIX := .exe
  82 DLIB_SUFFIX := .dll
  83 # do not archive external libraries
  84 CYGWIN_LDLIBS_NOARCHIVE := $(filter-out -l$(BINARY_NAME),$(LDLIBS))
  85 CYGWIN_LIBLDFLAGS := -Wl,--out-implib=$(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX).a \
  86     -Wl,--export-all-symbols \
  87     -Wl,--enable-auto-import
  88 endif
  89
  90 ifeq ($(UNAME),Darwin)
  91 SHLIBLDFLAG=-dynamiclib
  92 LDLIBS := $(filter-out -ltinfo,$(LDLIBS))
  93 DLIB_SUFFIX=.dylib
  94 LTO_SUPPORT=no
  95 GOLD_SUPPORT=no
  96 endif
  97
  98 ifeq ($(LTO_SUPPORT),yes)
  99 CFLAGS_LTO = -flto -ffat-lto-objects
 100 LDFLAGS_LTO = -fuse-linker-plugin -flto
 101 endif
 102
 103 ifeq ($(GOLD_SUPPORT),yes)
 104 LDFLAGS_GOLD = -fuse-ld=gold
 105 endif
 106
 107 # Putting header files in the source directory is not the purpose of this INCLUDES_PATH variable
 108 INCLUDES_PATH := $(INCLUDES_PATH) -I$(LIBRARY_PATH)
 109 CFLAGS := -DBUILD_TYPE=$(BUILD_TYPE) $(CFLAGS) $(CFLAGS_LTO) $(WARN_FLAGS) $(STD_FLAG) $(OPTI_FLAG) $(DEBUG_FLAG) $(INCLUDES_PATH)
 110 LIBCFLAGS := -fPIC $(CFLAGS)
 111 LDFLAGS := $(LDFLAGS) $(LDFLAGS_LTO) $(LDFLAGS_GOLD) $(STRIP_FLAG)
 112 LIBLDFLAGS := $(SHLIBLDFLAG) $(LDFLAGS)
 113 STATICLIBLDFLAGS := -static $(LDFLAGS)
 114 LDLIBS := $(LDLIBS) -L$(LIBRARY_PATH)
 115
 116 # Mac OS X do not support static linking
 117 ifeq ($(UNAME),Darwin)
 118 all: $(BINARY_NAME)$(BINARY_SUFFIX) $(BINARY_NAME).dynamic$(BINARY_SUFFIX)
 119 else
 120 all: $(BINARY_NAME)$(BINARY_SUFFIX) $(BINARY_NAME).dynamic$(BINARY_SUFFIX) $(BINARY_NAME).static$(BINARY_SUFFIX)
 121 endif
 122
 123 $(LIBRARY_PATH)/$(SLIB_PREFIX)$(LIBRARY_NAME)$(SLIB_SUFFIX): $(LIBOBJS)
 124         @echo "[AR StO] $@"
 125         @$(AR) rcs $@ $^
 126
 127 ifeq ($(findstring CYGWIN_NT,$(UNAME)),CYGWIN_NT)
 128 $(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX).a: $(LIBRARY_PATH)/$(DLIB_PREFIX)$(CYGWIN_DLIBRARY_NAME)$(DLIB_SUFFIX)
 129 $(LIBRARY_PATH)/$(DLIB_PREFIX)$(CYGWIN_DLIBRARY_NAME)$(DLIB_SUFFIX): $(LIBOBJS)
 130         @echo "[LD DLL] $@"
 131         @$(LD) $(LIBCFLAGS) $(LIBLDFLAGS) $(CYGWIN_LIBLDFLAGS) -Wl,--whole-archive $^ -Wl,--no-whole-archive $(CYGWIN_LDLIBS_NOARCHIVE) -o $@
 132 else
 133 $(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX): $(LIBOBJS)
 134         @echo "[LD ShO] $@"
 135         @$(LD) $(LIBCFLAGS) $(LIBLDFLAGS) $^ $(LDLIBS) -o $@
 136 endif
 137
 138 #$(BINARY_NAME)$(BINARY_SUFFIX): $(OBJS) $(LIBOBJS)
 139 #       @echo "[LD ] $@"
 140 #       @$(LD) $(CFLAGS) $(LDFLAGS) $^ $(LDLIBS) -o $@
 141
 142 $(BINARY_NAME)$(BINARY_SUFFIX): $(OBJS) $(LIBRARY_PATH)/$(SLIB_PREFIX)$(LIBRARY_NAME)$(SLIB_SUFFIX)
 143         @echo "[LD ] $@"
 144         @$(LD) $(CFLAGS) $(LDFLAGS) $^ $(LDLIBS) -o $@
 145
 146 $(BINARY_NAME).static$(BINARY_SUFFIX): $(OBJS) $(LIBRARY_PATH)/$(SLIB_PREFIX)$(LIBRARY_NAME)$(SLIB_SUFFIX)
 147         @echo "[LD ] $@"
 148         @$(LD) $(CFLAGS) $(STATICLIBLDFLAGS) $^ $(LDLIBS) -o $@
 149
 150 ifeq ($(findstring CYGWIN_NT,$(UNAME)),CYGWIN_NT)
 151 $(BINARY_NAME).dynamic$(BINARY_SUFFIX): $(OBJS) $(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX).a
 152 else
 153 $(BINARY_NAME).dynamic$(BINARY_SUFFIX): $(OBJS) $(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX)
 154 endif
 155         @echo "[LD ] $@"
 156         @$(LD) $(CFLAGS) $(LDFLAGS) $^ $(LDLIBS) -o $@
 157
 158 $(OBJDIR)/%.o: $(SRC_PATH)/%.c $(DEPDIR)/%.d
 159         @echo "[C  ] $(notdir $*)"
 160         @$(CC) $(DEPFLAGS) $(CFLAGS) -c $< -o $@
 161         @$(POSTCOMPILE)
 162
 163 include $(wildcard $(patsubst %,$(DEPDIR)/%.d,$(basename $(SRCS))))
 164
 165 $(OBJDIR)/%.o: $(LIBRARY_PATH)/%.c $(DEPDIR)/%.d
 166         @echo "[C  ] $(notdir $*)"
 167         @$(CC) $(DEPFLAGS) $(LIBCFLAGS) -c $< -o $@
 168         @$(POSTCOMPILE)
 169
 170 include $(wildcard $(patsubst %,$(DEPDIR)/%.d,$(basename $(LIBSRCS))))
 171
 172 $(DEPDIR)/%.d: ;
 173
 174 .PRECIOUS: $(DEPDIR)/%.d
 175
 176 #FIXME: add an install target
 177
 178 clean:
 179         @echo "[CLN]"
 180         -@rm -r $(BUILDDIR)
 181         -@rm $(BINARY_NAME)$(BINARY_SUFFIX)
 182 ifneq ($(UNAME),Darwin)
 183         -@rm $(BINARY_NAME).static$(BINARY_SUFFIX)
 184 endif
 185         -@rm $(BINARY_NAME).dynamic$(BINARY_SUFFIX)
 186         -@rm $(LIBRARY_PATH)/$(SLIB_PREFIX)$(LIBRARY_NAME)$(SLIB_SUFFIX)
 187 ifeq ($(findstring CYGWIN_NT,$(UNAME)),CYGWIN_NT)
 188         -@rm $(LIBRARY_PATH)/$(DLIB_PREFIX)$(CYGWIN_DLIBRARY_NAME)$(DLIB_SUFFIX)
 189         -@rm $(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX).a
 190 else
 191         -@rm $(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX)
 192 endif
 193
 194 run: $(BINARY_NAME)
 195         ./$(BINARY_NAME)
 196
 197 disassemble: $(BINARY_NAME)$(BINARY_SUFFIX)
 198         objdump -d $< | less
 199
 200 symbols: $(BINARY_NAME)$(BINARY_SUFFIX)
 201         objdump -t $< | sort | less