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 #   PRE_DEPEND         targets required for dependency check
  38 #
  39 #   BINARY         (/) binary output name (like appname)
  40 #   LIBRARY        (/) library output name (like libname)
  41 #
  42 #   EXTRA_OUTPUT       additional output targets
  43 #   EXTRA_CLEAN        additional cleanup targets
  44 #
  45 # Optionally, for a binary:
  46 #   STATIC_NEEDED      set to 'y' for init binaries, will build statically
  47 #                      linked version
  48 #
  49 # Optionally, for a library:
  50 #   SOVERSION            shared library version (major.minor),
  51 #                        if missing, no shared library is built
  52 #
  53 # (x) required variables
  54 # (/) exactly one of the variables must be defined
  55 #
  56
  57 ROOT_PATH = $(USPACE_PREFIX)/..
  58
  59 VERSION_DEF = $(ROOT_PATH)/version
  60
  61 COMMON_MAKEFILE = $(ROOT_PATH)/Makefile.common
  62 COMMON_HEADER = $(ROOT_PATH)/common.h
  63
  64 CONFIG_MAKEFILE = $(ROOT_PATH)/Makefile.config
  65 CONFIG_HEADER = $(ROOT_PATH)/config.h
  66
  67 -include $(VERSION_DEF)
  68 -include $(COMMON_MAKEFILE)
  69 -include $(CONFIG_MAKEFILE)
  70
  71 OUTPUTS = $(EXTRA_OUTPUT)
  72
  73 ifneq ($(BINARY),)
  74         JOB = $(BINARY).job
  75         TEST_BINARY = test-$(BINARY)
  76         OUTPUTS += $(BINARY) $(BINARY).disasm
  77         EXTRA_CLEAN += $(BINARY).map
  78 endif
  79
  80 ifneq ($(LIBRARY),)
  81         JOB = $(LIBRARY).job
  82         TEST_BINARY = test-$(LIBRARY)
  83         OUTPUTS += $(LIBRARY).a
  84 endif
  85
  86 ifeq ($(CONFIG_BUILD_SHARED_LIBS),y)
  87         ifneq ($(SOVERSION),)
  88                 SLIBRARY = $(LIBRARY).so.$(SOVERSION)
  89                 LSONAME = $(LIBRARY).so.$(basename $(SOVERSION))
  90                 OUTPUTS += $(SLIBRARY) $(SLIBRARY).disasm $(LSONAME)
  91                 EXTRA_CLEAN += $(LIBRARY).la $(SLIBRARY).map
  92         endif
  93 endif
  94
  95 LIB_PREFIX = $(USPACE_PREFIX)/lib
  96
  97 LIBC_PREFIX = $(LIB_PREFIX)/c
  98 LIBC_INCLUDES_FLAGS = \
  99         -isystem $(LIBC_PREFIX)/include \
 100         -isystem $(LIBC_PREFIX)/arch/$(UARCH)/include \
 101         -isystem $(ROOT_PATH)/abi/arch/$(KARCH)/include \
 102         -isystem $(ROOT_PATH)/abi/include
 103
 104 LIBCPP_PREFIX = $(LIB_PREFIX)/cpp
 105 LIBCPP_INCLUDES_FLAGS = -isystem $(LIBCPP_PREFIX)/include
 106
 107 LIBDLTEST_PREFIX = $(LIB_PREFIX)/dltest
 108
 109 START_FILES = $(LIBC_PREFIX)/crt0.o $(LIBC_PREFIX)/crt1.o
 110
 111 AFLAGS = --fatal-warnings
 112 LDFLAGS = -Wl,--fatal-warnings,--warn-common
 113
 114 STATIC_BUILD = n
 115
 116 ifeq ($(STATIC_NEEDED),y)
 117         STATIC_BUILD = y
 118 endif
 119
 120 ifneq ($(CONFIG_BUILD_SHARED_LIBS),y)
 121         STATIC_BUILD = y
 122 endif
 123
 124 ifneq ($(CONFIG_USE_SHARED_LIBS),y)
 125         ifeq ($(LIBRARY),)
 126                 STATIC_BUILD = y
 127         endif
 128 endif
 129
 130 # LINK_DYNAMIC is only here to allow app/dltest to link dynamically in otherwise static build.
 131 ifeq ($(LINK_DYNAMIC),y)
 132         STATIC_BUILD = n
 133 endif
 134
 135 ifeq ($(STATIC_BUILD),y)
 136         LDFLAGS += -static
 137 endif
 138
 139 BASE_LIBS =
 140
 141 ifneq ($(LIBRARY),libc)
 142         ifeq ($(STATIC_BUILD),y)
 143                 BASE_LIBS += $(LIBC_PREFIX)/libc.a
 144         else
 145                 BASE_LIBS += $(LIBC_PREFIX)/libc.so.0
 146         endif
 147 endif
 148
 149 BASE_LIBS += -lgcc
 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 DEPLIBS := $(LIBS)
 160
 161 ifneq ($(filter %.cpp %.cc %.cxx, $(SOURCES)),)
 162         ifneq ($(LIBRARY),libcpp)
 163                 DEPLIBS += cpp
 164         endif
 165 endif
 166
 167 ifneq ($(LIBRARY),libc)
 168         DEPLIBS += c
 169 endif
 170
 171 # PCUT-based unit tests
 172 ifneq ($(TEST_SOURCES),)
 173         TEST_OUTPUTS = $(TEST_BINARY) $(TEST_BINARY).disasm
 174         TEST_CFLAGS = -I$(LIB_PREFIX)/pcut/include -D__helenos__ $(EXTRA_TEST_CFLAGS)
 175         TEST_BINARY_LIBS = $(LIB_PREFIX)/pcut/libpcut.a
 176         EXTRA_CLEAN += $(TEST_OUTPUTS) $(TEST_BINARY).map
 177 ifneq ($(LIBRARY),)
 178         TEST_BINARY_LIBS += $(LIBRARY).a
 179 endif
 180         TEST_BINARY_LIBS += $(TEST_LIBS)
 181 endif
 182
 183 # Flags that are not necessary, and can be overriden, but are used by default.
 184 DEFAULT_CFLAGS = \
 185         -O$(OPTIMIZATION) \
 186         -ffunction-sections \
 187         -fno-builtin-strftime \
 188         -pipe \
 189         -Wall \
 190         -Wextra \
 191         -Wno-unused-parameter \
 192         -Wmissing-prototypes \
 193         -Wwrite-strings \
 194         -Werror-implicit-function-declaration \
 195         -Wsystem-headers \
 196         -Wunknown-pragmas
 197
 198 # XXX: -fno-builtin-strftime is for a seemingly spurious format warning.
 199
 200 ifeq ($(CONFIG_DEBUG),y)
 201         DEFAULT_CFLAGS += -Werror
 202 endif
 203
 204 ifeq ($(CONFIG_UBSAN),y)
 205         DEFAULT_CFLAGS += -fsanitize=undefined
 206 endif
 207
 208 ifeq ($(COMPILER),clang)
 209         DEFAULT_CFLAGS += \
 210                 -Wno-missing-braces \
 211                 -Wno-missing-field-initializers \
 212                 -Wno-typedef-redefinition \
 213                 -Wno-unused-command-line-argument
 214 else
 215         DEFAULT_CFLAGS += \
 216                 -Wno-nonnull-compare \
 217                 -Wno-clobbered
 218 endif
 219
 220 ifeq ($(CONFIG_LINE_DEBUG),y)
 221         DEFAULT_CFLAGS += -ggdb
 222 endif
 223
 224 # Flags that should always be used, even for third-party software.
 225 COMMON_CPPFLAGS = \
 226         -D__$(ENDIANESS)__
 227
 228 COMMON_CFLAGS = \
 229         -nostdlib
 230
 231 # Flags that are always used for HelenOS code, but not for third-party.
 232 HELENOS_CFLAGS = \
 233         -std=gnu11 \
 234         $(INCLUDES_FLAGS) \
 235         -imacros $(CONFIG_HEADER) \
 236         -D_HELENOS_SOURCE \
 237         -fexec-charset=UTF-8 \
 238         -finput-charset=UTF-8 \
 239         -fno-common \
 240         -fdebug-prefix-map=$(realpath $(ROOT_PATH))=.
 241
 242 # TODO: Use a different name.
 243 # CFLAGS variable is traditionally used for overridable flags.
 244 CFLAGS = $(COMMON_CPPFLAGS) $(COMMON_CFLAGS) $(HELENOS_CFLAGS) $(DEFAULT_CFLAGS)
 245
 246 # Flags for the compilation of C++ code.
 247 CXX_BASE_LIBS = $(LIBCPP_PREFIX)/libcpp.a $(BASE_LIBS)
 248 DEFAULT_CXXFLAGS = \
 249         -O$(OPTIMIZATION) \
 250         -ffunction-sections \
 251         -pipe \
 252         -Wall \
 253         -Wextra \
 254         -Wno-unused-parameter \
 255         -Wwrite-strings \
 256         -Werror-implicit-function-declaration
 257
 258 ifeq ($(CONFIG_DEBUG),y)
 259         DEFAULT_CXXFLAGS += -Werror
 260 endif
 261
 262 COMMON_CXXFLAGS = $(COMMON_CFLAGS) -fno-exceptions
 263 HELENOS_CXXFLAGS = \
 264         -std=c++17 -frtti \
 265         $(LIBCPP_INCLUDES_FLAGS) $(INCLUDES_FLAGS) \
 266         -imacros $(CONFIG_HEADER) \
 267         -D_HELENOS_SOURCE \
 268         -fexec-charset=UTF-8 \
 269         -finput-charset=UTF-8 \
 270         -fno-common \
 271         -fdebug-prefix-map=$(realpath $(ROOT_PATH))=.
 272
 273 CXXFLAGS = $(COMMON_CPPFLAGS) $(COMMON_CXXFLAGS) $(HELENOS_CXXFLAGS) $(DEFAULT_CXXFLAGS)
 274
 275 ## Setup platform configuration
 276 #
 277
 278 -include $(LIBC_PREFIX)/arch/$(UARCH)/Makefile.common
 279
 280 ## Compilation options
 281 #
 282
 283 ifeq ($(PRECHECK),y)
 284         JOBFILE = $(LIBC_PREFIX)/../../../tools/jobfile.py
 285         # NOTE: You must not change the order of arguments.
 286         CC_JOB = $(JOBFILE) $(JOB) $(CC) $< -o $@
 287         CXX_JOB = $(JOBFILE) $(JOB) $(CXX) $< -o $@
 288 else
 289         CC_JOB = $(CC) $< -o $@
 290         CXX_JOB = $(CXX) $< -o $@
 291 endif
 292
 293 ifeq ($(CONFIG_STRIP_BINARIES),y)
 294         LDFLAGS += -s
 295 endif
 296
 297 LIB_CFLAGS = $(CFLAGS) -fPIC
 298 LIB_CXXFLAGS = $(CXXFLAGS) -fPIC
 299 LIB_LDFLAGS = $(LDFLAGS) -shared -Wl,-soname,$(LSONAME) -Wl,--no-undefined,--no-allow-shlib-undefined
 300
 301 AS_CFLAGS := $(addprefix -Xassembler ,$(AFLAGS))
 302
 303 OBJECTS := $(addsuffix .o,$(basename $(SOURCES)))
 304 LOBJECTS := $(addsuffix .lo,$(basename $(SOURCES)))
 305 TEST_OBJECTS := $(addsuffix .test.o,$(basename $(TEST_SOURCES)))
 306 DEPENDS := $(addsuffix .d,$(basename $(SOURCES))) $(addsuffix .test.d,$(basename $(TEST_SOURCES)))
 307
 308 LIBTAGS := $(foreach lib,$(DEPLIBS), $(USPACE_PREFIX)/lib/$(lib)/tag)
 309 LIBARGS := $(addprefix -L$(USPACE_PREFIX)/lib/, $(LIBS)) $(addprefix -l, $(LIBS))
 310
 311 .PHONY: all all-test clean fasterclean depend
 312
 313 all: tag $(OUTPUTS)
 314
 315 all-test: $(TEST_OUTPUTS)
 316
 317 clean: fasterclean
 318         find . -name '*.o' -follow -exec rm \{\} \;
 319         find . -name '*.lo' -follow -exec rm \{\} \;
 320         find . -name '*.d' -follow -exec rm \{\} \;
 321
 322 fasterclean:
 323         rm -rf $(JOB) $(OUTPUTS) $(EXTRA_CLEAN) tag deps.mk
 324
 325 depend: $(PRE_DEPEND)
 326
 327 # "Tag" files are used to force relink of binaries when dependencies get rebuilt,
 328 # regardless of whether the dependency was linked statically or dynamically,
 329 # or which version of a dynamic library was used. Prerequisites for this file
 330 # are defined further down.
 331 tag:
 332         touch tag
 333
 334 # Generate inter-module make dependencies.
 335 # This is needed to ensure correct build order of libraries and code depending on them.
 336 deps.mk: Makefile
 337         echo > $@.new
 338         for lib in $(DEPLIBS); do \
 339                 echo "$(SELF_TARGET): lib/$$lib.build" >> $@.new; \
 340         done
 341         mv -f $@.new $@
 342
 343 %.disasm: %
 344 ifeq ($(CONFIG_LINE_DEBUG),y)
 345         $(OBJDUMP) -d -S $< > $@
 346 else
 347         $(OBJDUMP) -d $< > $@
 348 endif
 349
 350 ifneq ($(BINARY),)
 351
 352 ifneq ($(filter %.cpp %.cc %.cxx, $(SOURCES)),)
 353 $(BINARY): $(OBJECTS) $(LIBTAGS)
 354         $(CXX) $(CXXFLAGS) $(LDFLAGS) $(EXTRA_LDFLAGS) -Wl,-Map,$@.map -o $@ $(START_FILES) $(OBJECTS) $(LIBARGS) $(CXX_BASE_LIBS)
 355 else
 356 $(BINARY): $(OBJECTS) $(LIBTAGS)
 357         $(CC) $(CFLAGS) $(LDFLAGS) $(EXTRA_LDFLAGS) -Wl,-Map,$@.map -o $@ $(START_FILES) $(OBJECTS) $(LIBARGS) $(BASE_LIBS)
 358 endif
 359
 360 endif
 361
 362 ifneq ($(TEST_BINARY),)
 363 $(TEST_BINARY): $(TEST_OBJECTS) $(TEST_BINARY_LIBS) $(LIBTAGS)
 364         $(CC) $(CFLAGS) $(LDFLAGS) $(EXTRA_LDFLAGS) -Wl,-Map,$@.map -o $@ $(START_FILES) $(TEST_OBJECTS) $(TEST_BINARY_LIBS) $(LIBARGS) $(BASE_LIBS)
 365 endif
 366
 367 ifneq ($(LIBRARY),)
 368 tag: $(LIBRARY).a
 369
 370 $(LIBRARY).a: $(OBJECTS)
 371         $(AR) rc $@ $(OBJECTS)
 372 endif
 373
 374 ifneq ($(SLIBRARY),)
 375 tag: $(SLIBRARY)
 376
 377 $(LIBRARY).la: $(LOBJECTS)
 378         $(AR) rc $@ $(LOBJECTS)
 379
 380 $(SLIBRARY): $(LIBRARY).la $(LIBTAGS)
 381         $(CC) $(CFLAGS) $(LIB_LDFLAGS) $(EXTRA_LDFLAGS) -Wl,-Map,$@.map -o $@ -Wl,--whole-archive $(LIBRARY).la -Wl,--no-whole-archive $(LIBARGS) $(BASE_LIBS)
 382
 383 $(LSONAME):
 384         ln -s $(SLIBRARY) $@
 385 endif
 386
 387 %.o: %.S | depend
 388         $(CC_JOB) -c -MD -MP $(DEFS) $(CFLAGS) $(EXTRA_CFLAGS) $(AS_CFLAGS)
 389
 390 %.o: %.s | depend
 391         $(CC_JOB) -c -MD -MP $(DEFS) $(CFLAGS) $(EXTRA_CFLAGS) $(AS_CFLAGS)
 392
 393 %.o: %.c | depend
 394         $(CC_JOB) -c -MD -MP $(DEFS) $(CFLAGS) $(EXTRA_CFLAGS)
 395
 396 %.o: %.cpp | depend
 397         $(CXX_JOB) -c -MD -MP $(DEFS) $(CXXFLAGS) $(EXTRA_CXXFLAGS)
 398
 399 %.o: %.cxx | depend
 400         $(CXX_JOB) -c -MD -MP $(DEFS) $(CXXFLAGS) $(EXTRA_CXXFLAGS)
 401
 402 %.o: %.cc | depend
 403         $(CXX_JOB) -c -MD -MP $(DEFS) $(CXXFLAGS) $(EXTRA_CXXFLAGS)
 404
 405 %.test.o: %.c | depend
 406         $(CC_JOB) -c -MD -MP $(DEFS) $(CFLAGS) $(EXTRA_CFLAGS) $(TEST_CFLAGS)
 407
 408 %.lo: %.S | depend
 409         $(CC_JOB) -c -MD -MP $(DEFS) $(LIB_CFLAGS) $(EXTRA_CFLAGS) $(AS_CFLAGS)
 410
 411 %.lo: %.s | depend
 412         $(CC_JOB) -c -MD -MP $(DEFS) $(LIB_CFLAGS) $(EXTRA_CFLAGS) $(AS_CFLAGS)
 413
 414 %.lo: %.c | depend
 415         $(CC_JOB) -c -MD -MP $(DEFS) $(LIB_CFLAGS) $(EXTRA_CFLAGS)
 416
 417 %.lo: %.cpp | depend
 418         $(CXX_JOB) -c -MD -MP $(DEFS) $(LIB_CXXFLAGS) $(EXTRA_CXXFLAGS)
 419
 420 %.lo: %.cxx | depend
 421         $(CXX_JOB) -c -MD -MP $(DEFS) $(LIB_CXXFLAGS) $(EXTRA_CXXFLAGS)
 422
 423 %.lo: %.cc | depend
 424         $(CXX_JOB) -c -MD -MP $(DEFS) $(LIB_CXXFLAGS) $(EXTRA_CXXFLAGS)
 425
 426 -include $(DEPENDS)