uspace/Makefile.common

   1 #
   2 # Copyright (c) 2005 Martin Decky
   3 # Copyright (c) 2007 Jakub Jermar
   4 # All rights reserved.
   5 #
   6 # Redistribution and use in source and binary forms, with or without
   7 # modification, are permitted provided that the following conditions
   8 # are met:
   9 #
  10 # - Redistributions of source code must retain the above copyright
  11 #   notice, this list of conditions and the following disclaimer.
  12 # - Redistributions in binary form must reproduce the above copyright
  13 #   notice, this list of conditions and the following disclaimer in the
  14 #   documentation and/or other materials provided with the distribution.
  15 # - The name of the author may not be used to endorse or promote products
  16 #   derived from this software without specific prior written permission.
  17 #
  18 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  19 # IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20 # OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21 # IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  22 # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23 # NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27 # THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 #
  29
  30 # Individual makefiles set:
  31 #
  32 #   USPACE_PREFIX  (*) relative path to uspace/ directory
  33 #   SOURCES        (*) list of source files
  34 #   LIBS               libraries to link with
  35 #   DEFS               compiler defines
  36 #   EXTRA_CFLAGS       additional flags to pass to C compiler
  37 #   LINKER_SCRIPT      linker script
  38 #   PRE_DEPEND         targets required for dependency check
  39 #
  40 #   BINARY         (/) binary output name (like appname)
  41 #   LIBRARY        (/) library output name (like libname)
  42 #
  43 #   EXTRA_OUTPUT       additional output targets
  44 #   EXTRA_CLEAN        additional cleanup targets
  45 #
  46 # Optionally, for a binary:
  47 #   STATIC_NEEDED      set to 'y' for init binaries, will build statically
  48 #                      linked version
  49 #   STATIC_ONLY        set to 'y' if binary cannot be linked dynamically
  50 #                      (e.g. uses thread-local variables)
  51 #
  52 # Optionally, for a library:
  53 #   SOVERSION            shared library version (major.minor),
  54 #                        if missing, no shared library is built
  55 #
  56 # (x) required variables
  57 # (/) exactly one of the variables must be defined
  58 #
  59
  60 ROOT_PATH = $(USPACE_PREFIX)/..
  61
  62 VERSION_DEF = $(ROOT_PATH)/version
  63
  64 COMMON_MAKEFILE = $(ROOT_PATH)/Makefile.common
  65 COMMON_HEADER = $(ROOT_PATH)/common.h
  66
  67 CONFIG_MAKEFILE = $(ROOT_PATH)/Makefile.config
  68 CONFIG_HEADER = $(ROOT_PATH)/config.h
  69
  70 -include $(VERSION_DEF)
  71 -include $(COMMON_MAKEFILE)
  72 -include $(CONFIG_MAKEFILE)
  73
  74 OUTPUTS = $(EXTRA_OUTPUT)
  75
  76 ifneq ($(BINARY),)
  77         JOB = $(BINARY).job
  78         TEST_BINARY = test-$(BINARY)
  79         OUTPUTS += $(BINARY) $(BINARY).disasm
  80         EXTRA_CLEAN += $(BINARY).map
  81 endif
  82
  83 ifneq ($(LIBRARY),)
  84         JOB = $(LIBRARY).job
  85         TEST_BINARY = test-$(LIBRARY)
  86         OUTPUTS += $(LIBRARY).a
  87 endif
  88
  89 ifeq ($(CONFIG_BUILD_SHARED_LIBS),y)
  90         ifneq ($(SOVERSION),)
  91                 SLIBRARY = $(LIBRARY).so.$(SOVERSION)
  92                 LSONAME = $(LIBRARY).so.$(basename $(SOVERSION))
  93                 OUTPUTS += $(SLIBRARY) $(SLIBRARY).disasm $(LSONAME)
  94                 EXTRA_CLEAN += $(LIBRARY).la $(SLIBRARY).map
  95         endif
  96 endif
  97
  98 LIB_PREFIX = $(USPACE_PREFIX)/lib
  99
 100 LIBC_PREFIX = $(LIB_PREFIX)/c
 101 LIBC_INCLUDES_FLAGS = \
 102         -I$(LIBC_PREFIX)/include \
 103         -I$(LIBC_PREFIX)/arch/$(UARCH)/include \
 104         -I$(ROOT_PATH)/abi/include
 105 LIBSOFTFLOAT_PREFIX = $(LIB_PREFIX)/softfloat
 106 LIBSOFTINT_PREFIX = $(LIB_PREFIX)/softint
 107
 108 LIBMATH_PREFIX = $(LIB_PREFIX)/math
 109 LIBMATH_INCLUDES_FLAGS = \
 110         -I$(LIBMATH_PREFIX)/include \
 111         -I$(LIBMATH_PREFIX)/arch/$(UARCH)/include
 112
 113 LIBPOSIX_PREFIX = $(LIB_PREFIX)/posix
 114 LIBDLTEST_PREFIX = $(LIB_PREFIX)/dltest
 115
 116 AFLAGS = --fatal-warnings
 117 LDFLAGS = -Wl,--fatal-warnings,--warn-common
 118
 119 ifeq ($(STATIC_NEEDED),y)
 120         STATIC_BUILD = y
 121 else
 122         ifeq ($(STATIC_ONLY),y)
 123                 STATIC_BUILD = y
 124         else
 125                 ifeq ($(CONFIG_USE_SHARED_LIBS),y)
 126                         STATIC_BUILD = n
 127                 else
 128                         STATIC_BUILD = y
 129                 endif
 130         endif
 131 endif
 132
 133 ifeq ($(STATIC_BUILD),y)
 134         BASE_LIBS = $(LIBC_PREFIX)/libc.a
 135 else
 136         BASE_LIBS = $(LIBC_PREFIX)/libc.so.0
 137         LINK_DYNAMIC = y
 138 endif
 139
 140 BASE_LIBS += $(LIBSOFTFLOAT_PREFIX)/libsoftfloat.a $(LIBSOFTINT_PREFIX)/libsoftint.a
 141
 142 ifeq ($(LINK_DYNAMIC),y)
 143         LINKER_SCRIPT ?= $(LIBC_PREFIX)/arch/$(UARCH)/_link-dlexe.ld
 144 else
 145         LDFLAGS += -static
 146         LINKER_SCRIPT ?= $(LIBC_PREFIX)/arch/$(UARCH)/_link.ld
 147 endif
 148
 149 LIB_LINKER_SCRIPT = $(LIBC_PREFIX)/arch/$(UARCH)/_link-shlib.ld
 150
 151 INCLUDES_FLAGS = $(LIBC_INCLUDES_FLAGS)
 152
 153 ifneq ($(LIBRARY),)
 154         INCLUDES_FLAGS += -Iinclude -I.
 155 endif
 156
 157 INCLUDES_FLAGS += $(foreach lib,$(LIBS), -I$(LIB_PREFIX)/$(lib) -I$(LIB_PREFIX)/$(lib)/include)
 158
 159 # TODO: get rid of this special case
 160 ifneq ($(filter math, $(LIBS)),)
 161         INCLUDES_FLAGS += $(LIBMATH_INCLUDES_FLAGS)
 162 endif
 163
 164 # PCUT-based unit tests
 165 ifneq ($(TEST_SOURCES),)
 166         TEST_OUTPUTS = $(TEST_BINARY) $(TEST_BINARY).disasm
 167         TEST_CFLAGS = -I$(LIB_PREFIX)/pcut/include -D__helenos__
 168         TEST_BINARY_LIBS = $(LIB_PREFIX)/pcut/libpcut.a
 169         EXTRA_CLEAN += $(TEST_OUTPUTS) $(TEST_BINARY).map
 170 ifneq ($(LIBRARY),)
 171         TEST_BINARY_LIBS += $(LIBRARY).a
 172 endif
 173         TEST_BINARY_LIBS += $(TEST_LIBS)
 174 endif
 175
 176 # Flags that are not necessary, and can be overriden, but are used by default.
 177 DEFAULT_CFLAGS = \
 178         -O$(OPTIMIZATION) \
 179         -ffunction-sections \
 180         -pipe \
 181         -Wall \
 182         -Wextra \
 183         -Wno-unused-parameter \
 184         -Wmissing-prototypes \
 185         -Wwrite-strings \
 186         -Werror-implicit-function-declaration
 187
 188 ifeq ($(CONFIG_DEBUG),y)
 189         DEFAULT_CFLAGS += -Werror
 190 endif
 191
 192 ifeq ($(COMPILER),clang)
 193         DEFAULT_CFLAGS += \
 194                 -Wno-missing-field-initializers \
 195                 -Wno-typedef-redefinition \
 196                 -Wno-unused-command-line-argument
 197 else
 198         DEFAULT_CFLAGS += \
 199                 -Wno-clobbered
 200 endif
 201
 202 ifeq ($(CONFIG_LINE_DEBUG),y)
 203         DEFAULT_CFLAGS += -ggdb
 204 endif
 205
 206 # Flags that should always be used, even for third-party software.
 207 COMMON_CPPFLAGS = \
 208         -nostdinc \
 209         -D__$(ENDIANESS)__
 210
 211 COMMON_CFLAGS = \
 212         -ffreestanding \
 213         -nostdlib
 214
 215 # Flags that are always used for HelenOS code, but not for third-party.
 216 HELENOS_CFLAGS = \
 217         -std=gnu99 \
 218         $(INCLUDES_FLAGS) \
 219         -imacros $(CONFIG_HEADER) \
 220         -D_HELENOS_SOURCE \
 221         -fexec-charset=UTF-8 \
 222         -finput-charset=UTF-8 \
 223         -fno-common \
 224         -fdebug-prefix-map=$(realpath $(ROOT_PATH))=.
 225
 226 # TODO: Use a different name.
 227 # CFLAGS variable is traditionally used for overridable flags.
 228 CFLAGS = $(COMMON_CPPFLAGS) $(COMMON_CFLAGS) $(HELENOS_CFLAGS) $(DEFAULT_CFLAGS)
 229
 230 ## Setup platform configuration
 231 #
 232
 233 -include $(LIBC_PREFIX)/arch/$(UARCH)/Makefile.common
 234
 235 ## Compilation options
 236 #
 237
 238 ifeq ($(PRECHECK),y)
 239         JOBFILE = $(LIBC_PREFIX)/../../../tools/jobfile.py
 240         # XXX: Do not change the order of arguments.
 241         CC_JOB = $(JOBFILE) $(JOB) $(CC) $< -o $@
 242 else
 243         CC_JOB = $(CC) $< -o $@
 244 endif
 245
 246 ifeq ($(CONFIG_STRIP_BINARIES),y)
 247         LDFLAGS += -s
 248 endif
 249
 250 LIB_CFLAGS = $(CFLAGS) -fPIC
 251 LIB_LDFLAGS = $(LDFLAGS) -shared -Wl,-soname,$(LSONAME)
 252
 253 AS_CFLAGS := $(addprefix -Xassembler ,$(AFLAGS))
 254
 255 OBJECTS := $(addsuffix .o,$(basename $(SOURCES)))
 256 LOBJECTS := $(addsuffix .lo,$(basename $(SOURCES)))
 257 TEST_OBJECTS := $(addsuffix .test.o,$(basename $(TEST_SOURCES)))
 258 DEPENDS := $(addsuffix .d,$(basename $(SOURCES))) $(addsuffix .test.d,$(basename $(TEST_SOURCES)))
 259
 260 LIBTAGS := $(foreach lib,$(LIBS), $(USPACE_PREFIX)/lib/$(lib)/tag)
 261 LIBARGS := $(addprefix -L$(USPACE_PREFIX)/lib/, $(LIBS)) $(addprefix -l, $(LIBS))
 262
 263 .PHONY: all all-test clean fasterclean depend
 264
 265 all: tag $(OUTPUTS)
 266
 267 all-test: $(TEST_OUTPUTS)
 268
 269 clean: fasterclean
 270         find . -name '*.o' -follow -exec rm \{\} \;
 271         find . -name '*.lo' -follow -exec rm \{\} \;
 272         find . -name '*.d' -follow -exec rm \{\} \;
 273
 274 fasterclean:
 275         rm -rf $(JOB) $(OUTPUTS) $(EXTRA_CLEAN) tag deps.mk
 276
 277 depend: $(PRE_DEPEND)
 278
 279 # "Tag" files are used to force relink of binaries when dependencies get rebuilt,
 280 # regardless of whether the dependency was linked statically or dynamically,
 281 # or which version of a dynamic library was used. Prerequisites for this file
 282 # are defined further down.
 283 tag:
 284         touch tag
 285
 286 # Generate inter-module make dependencies.
 287 # This is needed to ensure correct build order of libraries and code depending on them.
 288 deps.mk: Makefile
 289         echo > $@.new
 290         for lib in $(LIBS); do \
 291                 echo "$(SELF_TARGET): lib/$$lib.build" >> $@.new; \
 292         done
 293         mv -f $@.new $@
 294
 295 %.disasm: %
 296 ifeq ($(CONFIG_LINE_DEBUG),y)
 297         $(OBJDUMP) -d -S $< > $@
 298 else
 299         $(OBJDUMP) -d $< > $@
 300 endif
 301
 302 ifneq ($(BINARY),)
 303 $(BINARY): $(LINKER_SCRIPT) $(OBJECTS) $(LIBTAGS) $(BASE_LIBS)
 304         $(CC) $(CFLAGS) $(LDFLAGS) $(EXTRA_LDFLAGS) -T $(LINKER_SCRIPT) -Wl,-Map,$@.map -o $@ $(OBJECTS) $(LIBARGS) $(BASE_LIBS)
 305 endif
 306
 307 ifneq ($(TEST_BINARY),)
 308 $(TEST_BINARY): $(LINKER_SCRIPT) $(TEST_OBJECTS) $(TEST_BINARY_LIBS) $(LIBTAGS) $(BASE_LIBS)
 309         $(CC) $(CFLAGS) $(LDFLAGS) $(EXTRA_LDFLAGS) -T $(LINKER_SCRIPT) -Wl,-Map,$@.map -o $@ $(TEST_OBJECTS) $(TEST_BINARY_LIBS) $(LIBARGS) $(BASE_LIBS)
 310 endif
 311
 312 ifneq ($(LIBRARY),)
 313 tag: $(LIBRARY).a
 314
 315 $(LIBRARY).a: $(OBJECTS)
 316         $(AR) rc $@ $(OBJECTS)
 317 endif
 318
 319 ifneq ($(SLIBRARY),)
 320 tag: $(SLIBRARY)
 321
 322 $(LIBRARY).la: $(LOBJECTS)
 323         $(AR) rc $@ $(LOBJECTS)
 324
 325 $(SLIBRARY): $(LIB_LINKER_SCRIPT) $(LIBRARY).la
 326         $(CC) $(CFLAGS) $(LIB_LDFLAGS) $(EXTRA_LDFLAGS) -T $(LIB_LINKER_SCRIPT) -Wl,-Map,$@.map -o $@ -Wl,--whole-archive $(LIBRARY).la -Wl,--no-whole-archive
 327
 328 $(LSONAME):
 329         ln -s $(SLIBRARY) $@
 330 endif
 331
 332 %.o: %.S | depend
 333         $(CC_JOB) -c -MD -MP $(DEFS) $(CFLAGS) $(EXTRA_CFLAGS) $(AS_CFLAGS)
 334
 335 %.o: %.s | depend
 336         $(CC_JOB) -c -MD -MP $(DEFS) $(CFLAGS) $(EXTRA_CFLAGS) $(AS_CFLAGS)
 337
 338 %.o: %.c | depend
 339         $(CC_JOB) -c -MD -MP $(DEFS) $(CFLAGS) $(EXTRA_CFLAGS)
 340
 341 %.test.o: %.c | depend
 342         $(CC_JOB) -c -MD -MP $(DEFS) $(CFLAGS) $(EXTRA_CFLAGS) $(TEST_CFLAGS)
 343
 344 %.lo: %.S | depend
 345         $(CC_JOB) -c -MD -MP $(DEFS) $(LIB_CFLAGS) $(EXTRA_CFLAGS) $(AS_CFLAGS)
 346
 347 %.lo: %.s | depend
 348         $(CC_JOB) -c -MD -MP $(DEFS) $(LIB_CFLAGS) $(EXTRA_CFLAGS) $(AS_CFLAGS)
 349
 350 %.lo: %.c | depend
 351         $(CC_JOB) -c -MD -MP $(DEFS) $(LIB_CFLAGS) $(EXTRA_CFLAGS)
 352
 353 -include $(DEPENDS)
 354