1 # Makefile.rules - OCERA make framework common project rules -*- makefile -*- #OMK@base
3 # (C) Copyright 2003 by Pavel Pisa - OCERA team member
4 # (C) Copyright 2006 by Michal Sojka - Czech Technical University, FEE, DCE
6 # Homepage: http://rtime.felk.cvut.cz/omk/
8 # The OMK build system is distributed under the GNU General Public
9 # License. See file COPYING for details.
12 # V .. if set to 1, full command text is shown else short form is used
13 # W .. whole tree - if set to 1, make is always called from the top-level directory
14 # SUBDIRS .. list of subdirectories intended for make from actual directory
15 # default_CONFIG .. list of default config assignments CONFIG_XXX=y/n ...
17 # kbuild: Generic definitions
18 OMK_RULES_TYPE=test #OMK@__type
20 # We need to ensure definition of sources directory first
22 # Only shell built-in pwd understands -L
23 SOURCES_DIR := $(shell ( pwd -L ) )
26 # If we are not called by OMK leaf Makefile...
28 MAKERULES_DIR := $(abspath $(dir $(filter %Makefile.rules,$(MAKEFILE_LIST))))
31 # OUTPUT_DIR is the place where _compiled, _build and possible other
32 # files/directories are created. By default is the same as
35 OUTPUT_DIR := $(MAKERULES_DIR)
38 .PHONY: all default check-make-ver omkize
41 ifeq ("$(origin W)", "command line")
49 ifneq ($(OMK_WHOLE_TREE),1)
50 all: check-make-ver default
51 @echo "Compilation finished"
53 # Run make in the top-level directory
55 @$(MAKE) -C $(MAKERULES_DIR) OMK_SERIALIZE_INCLUDED=n SOURCES_DIR=$(MAKERULES_DIR) RELATIVE_DIR="" $(MAKECMDGOALS) W=0
59 # Usage: $(call canttest,<error message>)
61 ( echo "$(1)" > $(OUTPUT_DIR)/_canttest; echo "$(1)"; exit 1 )
69 #=========================
70 # Include the config file
72 # FIXME: I think CONFIG_FILE_OK variable is useless. We have three
73 # config files and it is not clearly defined to which file is this
75 ifneq ($(CONFIG_FILE_OK),y)
77 CONFIG_FILE := $(OUTPUT_DIR)/config.omk
79 ifneq ($(wildcard $(CONFIG_FILE)-default),)
80 -include $(CONFIG_FILE)-default
82 ifneq ($(MAKECMDGOALS),default-config)
83 $(warning Please, run "make default-config" first)
87 -include $(OUTPUT_DIR)/config.target
89 ifneq ($(wildcard $(CONFIG_FILE)),)
90 -include $(CONFIG_FILE)
93 endif #$(CONFIG_FILE_OK)
96 CONFIG_FILES ?= $(wildcard $(CONFIG_FILE)-default) $(wildcard $(OUTPUT_DIR)/config.target) $(wildcard $(CONFIG_FILE))
99 export SOURCES_DIR MAKERULES_DIR RELATIVE_DIR
100 export CONFIG_FILE CONFIG_FILES OMK_SERIALIZE_INCLUDED OMK_VERBOSE OMK_SILENT
101 # OMK_SERIALIZE_INCLUDED has to be exported to submakes because passes
102 # must to be serialized only in the toplevel make.
105 RELATIVE_DIR := $(SOURCES_DIR:$(OUTPUT_DIR)%=%)
107 #$(warning === RELATIVE_DIR = "$(RELATIVE_DIR)" ===)
108 override RELATIVE_DIR := $(RELATIVE_DIR:/%=%)
109 override RELATIVE_DIR := $(RELATIVE_DIR:\\%=%)
110 #$(warning RELATIVE_DIR = "$(RELATIVE_DIR)")
111 override BACK2TOP_DIR := $(shell echo $(RELATIVE_DIR)/ | sed -e 's_//_/_g' -e 's_/\./_/_g' -e 's_^\./__g' -e 's_\([^/][^/]*\)_.._g' -e 's_/$$__')
112 #$(warning BACK2TOP_DIR = "$(BACK2TOP_DIR)")
114 #$(warning SOURCES_DIR = "$(SOURCES_DIR)")
115 #$(warning MAKERULES_DIR = "$(OUTPUT_DIR)")
116 #$(warning RELATIVE_DIR = "$(RELATIVE_DIR)")
118 # We have to use RELATIVE_PREFIX because of mingw
119 override RELATIVE_PREFIX := $(RELATIVE_DIR)/
120 override RELATIVE_PREFIX := $(RELATIVE_PREFIX:/%=%)
122 #vpath %.c $(SOURCES_DIR)
123 #vpath %.cc $(SOURCES_DIR)
124 #vpath %.cxx $(SOURCES_DIR)
126 # Define srcdir for Automake compatibility
127 srcdir = $(SOURCES_DIR)
129 # Defines for quiet compilation
131 ifeq ("$(origin V)", "command line")
138 ifneq ($(OMK_VERBOSE),0)
143 ifneq ($(findstring s,$(MAKEFLAGS)),)
144 QUIET_CMD_ECHO = true
147 QUIET_CMD_ECHO = echo
150 MAKEFILE_OMK=Makefile.omk
151 # All subdirectories (even linked ones) containing Makefile.omk
152 # Usage in Makefile.omk: SUBDIRS = $(ALL_OMK_SUBDIRS)
153 ALL_OMK_SUBDIRS = $(patsubst %/$(MAKEFILE_OMK),%,$(patsubst $(SOURCES_DIR)/%,%,$(wildcard $(SOURCES_DIR)/*/$(MAKEFILE_OMK))))
155 # ===================================================================
156 # We have set up all important variables, so we can check and include
157 # real OCERA style Makefile.omk now
159 include $(SOURCES_DIR)/$(MAKEFILE_OMK)
160 ifeq ($(AUTOMATIC_SUBDIRS),y)
161 SUBDIRS?=$(ALL_OMK_SUBDIRS)
167 @GOOD_MAKE_VERSION=`echo $(MAKE_VERSION) | sed -n -e 's/^[4-9]\..*\|^3\.9[0-9].*\|^3\.8[1-9].*/y/p'` ; \
168 if [ x$$GOOD_MAKE_VERSION != xy ] ; then \
169 echo "Your make program version is too old and does not support OMK system." ; \
170 echo "Please update to make program 3.81beta1 or newer." ; exit 1 ; \
173 distclean dist-clean:
174 @$(QUIET_CMD_ECHO) " RM $(COMPILED_DIR_NAME) $(BUILD_DIR_NAME)"
175 @rm -fr $(OUTPUT_DIR)/$(COMPILED_DIR_NAME) $(OUTPUT_DIR)/$(BUILD_DIR_NAME)
177 # Common OMK templates
178 # ====================
180 # Syntax: $(call mkdir,<dir name>)
182 [ -d $(1) ] || mkdir -p $(1) || exit 1
185 ifneq ($(OMK_VERBOSE),2)
186 NO_PRINT_DIRECTORY := --no-print-directory
189 ifeq ($(USE_LEAF_MAKEFILES),n)
190 export USE_LEAF_MAKEFILES
191 SUBDIR_MAKEFILE=$(MAKERULES_DIR)/Makefile.rules
192 SOURCESDIR_MAKEFILE=$(MAKERULES_DIR)/Makefile.rules
194 SUBDIR_MAKEFILE=$(SOURCES_DIR)/$(3)/Makefile
195 SOURCESDIR_MAKEFILE=$(SOURCES_DIR)/Makefile
200 # Call a pass in a subdirectory
201 # Usage: $(call omk_pass_subdir_template,<pass name>,<build dir>,<subdir>)
202 define omk_pass_subdir_template
203 .PHONY: $(pass)-$(3)-subdir
204 $(pass)-submakes: $(pass)-$(3)-subdir
206 @$(call mkdir_def,$(2)/$(3))
207 +@$(MAKE) SOURCES_DIR=$(SOURCES_DIR)/$(3) $(NO_PRINT_DIRECTORY) \
208 RELATIVE_DIR=$(RELATIVE_PREFIX)$(3) -C $(2)/$(3) \
209 -f $(SUBDIR_MAKEFILE) $(pass)-submakes
210 # In subdirectories we can call submakes directly since passes are
211 # already searialized on the toplevel make.
215 check-target = $(1:%=%-check)
218 # Call a pass in a subdirectory
219 # Usage: $(call extra_rules_subdir_template,<subdir>)
220 define extra_rules_subdir_template
221 extra-rules-subdirs: extra-rules-$(1)
223 +@$(MAKE) OMK_SERIALIZE_INCLUDED=n MAKERULES_DIR=$(SOURCES_DIR)/$(1) OUTPUT_DIR=$(OUTPUT_DIR) \
224 SOURCES_DIR=$(SOURCES_DIR)/$(1) RELATIVE_DIR=$(RELATIVE_PREFIX)$(1) -C $(SOURCES_DIR)/$(1)
227 .PHONY: extra-rules-subdirs
230 $(foreach subdir,$(EXTRA_RULES_SUBDIRS),$(eval $(call extra_rules_subdir_template,$(subdir))))
232 # Usage: $(call omk_pass_template,<pass name>,<build dir>,[<local make flags>],[<local enable condition>])
233 define omk_pass_template
234 .PHONY: $(pass) $(pass)-local $(pass)-check $(pass)-submakes
235 $(foreach subdir,$(SUBDIRS),$(eval $(call omk_pass_subdir_template,$(pass),$(2),$(subdir))))
237 # Submakes have to be called this way and not as dependecies for pass
238 # serialization to work
239 +@$(MAKE) SOURCES_DIR=$(SOURCES_DIR) $(NO_PRINT_DIRECTORY) \
240 RELATIVE_DIR=$(RELATIVE_DIR) \
241 -f $(SOURCESDIR_MAKEFILE) $(pass)-submakes
243 @true # Do not emit "nothing to be done" messages
245 ifneq ($(4)$($(pass)_HOOKS),)
246 $(pass)-submakes: $(pass)-this-dir
247 $(pass)-this-dir: $(foreach subdir,$(SUBDIRS),$(pass)-$(subdir)-subdir)
248 +@echo "make[omk]: $(pass) in $(RELATIVE_DIR)"
249 @$(call mkdir_def,$(2))
250 +@$(MAKE) $(NO_PRINT_DIRECTORY) SOURCES_DIR=$(SOURCES_DIR) RELATIVE_DIR=$(RELATIVE_DIR) -C $(2) \
251 -f $(SOURCESDIR_MAKEFILE) $(3) $(check-target) $(1:%=%-local)
252 $(pass)-local: $($(pass)_HOOKS)
256 # =======================
257 # DEFAULT CONFIG PASS
260 @echo "# Start of OMK config file" > "$(CONFIG_FILE)-default"
261 @echo "# This file should not be altered manually" >> "$(CONFIG_FILE)-default"
262 @echo "# Overrides should be stored in file $(notdir $(CONFIG_FILE))" >> "$(CONFIG_FILE)-default"
263 @echo >> "$(CONFIG_FILE)-default"
264 @$(MAKE) $(NO_PRINT_DIRECTORY) -C $(OUTPUT_DIR) \
265 RELATIVE_DIR="" SOURCES_DIR=$(OUTPUT_DIR) \
266 -f $(OUTPUT_DIR)/Makefile default-config-pass
268 $(eval $(call omk_pass_template,default-config-pass,$$(LOCAL_BUILD_DIR),,always))
270 default-config-pass-local:
271 # @echo Default config for $(RELATIVE_DIR)
272 @echo "# Config for $(RELATIVE_DIR)" >> "$(CONFIG_FILE)-default"
273 @$(foreach x, $(default_CONFIG), echo '$(x)' | \
274 sed -e 's/^[^=]*=x$$/#\0/' >> "$(CONFIG_FILE)-default" ; )
278 $(Q)if ! grep -q MAKERULES_DIR Makefile; then \
279 echo "Makefile is not OMK leaf makefile!" >&2; exit 1; \
281 $(Q)for i in `find -L . -name Makefile.omk` ; do \
283 if ! test -f "$${d}/Makefile.rules" && ( ! test -f "$${d}/Makefile" || ! cmp --silent Makefile "$${d}/Makefile" ); then \
284 rm -f "$${d}/Makefile"; \
285 cp -v Makefile "$${d}/Makefile"; \
289 # Convenient variables
294 space := $(empty) $(empty)
296 BUILD_DIR_NAME = _build
297 COMPILED_DIR_NAME = _compiled
299 USER_INCLUDE_DIR := $(OUTPUT_DIR)/$(COMPILED_DIR_NAME)/include
300 USER_LIB_DIR := $(OUTPUT_DIR)/$(COMPILED_DIR_NAME)/lib
301 USER_UTILS_DIR := $(OUTPUT_DIR)/$(COMPILED_DIR_NAME)/bin-utils
302 USER_TESTS_DIR := $(OUTPUT_DIR)/$(COMPILED_DIR_NAME)/bin-tests
303 USER_BIN_DIR := $(OUTPUT_DIR)/$(COMPILED_DIR_NAME)/bin
304 USER_BUILD_DIR := $(OUTPUT_DIR)/$(BUILD_DIR_NAME)/user
305 LINK_BUILD_DIR := $(OUTPUT_DIR)/$(BUILD_DIR_NAME)/link
307 USER_OBJS_DIR = $(USER_BUILD_DIR)/$(RELATIVE_DIR)
308 KERN_OBJS_DIR = $(KERN_BUILD_DIR)/$(RELATIVE_DIR)
309 OMK_WORK_DIR = $(USER_OBJS_DIR)
311 strip_out = $(patsubst $(OUTPUT_DIR)/%,%,$(1))
312 repl_out = $(patsubst $(OUTPUT_DIR)/%,$$(OUTPUT_DIR)/%,$(1))
320 $(eval $(call omk_pass_template,prepare-pass,$(USER_OBJS_DIR),,always))
323 # Name of the prepared rule. This name is used as prefix of variable
324 # names in .omk.inc and is based on the first target
325 omk_inc_rule = $(firstword $(1:$(OUTPUT_DIR)/%=%))
327 # The name of .omk.inc file is derived from $(omk_inc_rule) and
328 # depends whether the target is under _build or elsewhere.
329 omk_inc_file = $(if $(filter $(BUILD_DIR_NAME)%,$(omk_inc_rule)),\
330 $(OMK_WORK_DIR)/$(notdir $(omk_inc_rule)).omk.inc,\
331 $(OMK_WORK_DIR)/$(subst /,_,$(omk_inc_rule)).omk.inc)
333 target_omk_file = $(OMK_WORK_DIR)/$(notdir $(1)).target.omk
336 # prepare_rule is used to generate .omk.inc files during prepare-pass.
337 # All paths in this file should be relative to $(OUTPUT_DIR)
338 # Usage: $(call prepare_rule,<targets>,<deps>,<msg>,<cmd>)
340 prepare-pass-local: $(omk_inc_file)
342 $(omk_inc_file): FORCE
343 $(Q)echo 'prepared_rules += $(omk_inc_rule)' > $$@.tmp; \
344 echo '$(omk_inc_rule)_targets = $$(call strip_out,$(1))' >> $$@.tmp; \
345 echo '$(omk_inc_rule)_deps += $$(call strip_out,$(2))' >> $$@.tmp; \
346 echo '$(omk_inc_rule)_msg = $(3)' >> $$@.tmp; \
347 echo '$(omk_inc_rule)_cmd = $$(call repl_out,$(4))' >> $$@.tmp; \
348 if cmp -s $$@.tmp $$@; then rm $$@.tmp; else mv $$@.tmp $$@; fi
352 # prepare_rule_default - same as prepare rules but the target is put
353 # as dependency to the default build rule, which causes it to be built
355 define prepare_rule_default
356 $(call prepare_rule,$(1),$(2),$(3),$(4))
357 prepared_default_build_targets += $(call strip_out,$(1))
360 prepare-pass-local: $(OMK_WORK_DIR)/omk.inc
361 $(OMK_WORK_DIR)/omk.inc: FORCE
362 $(Q)echo 'default_build_targets += $(prepared_default_build_targets)' > $@.tmp; \
363 if cmp -s $@.tmp $@; then rm $@.tmp; else mv $@.tmp $@; fi
370 # Usage: $(call program_template,<executable-name>,<bin|utils|test>)
371 define program_template
372 $(1)_OBJS += $$(patsubst %.c,%.o,$$(filter %.c,$$($(1)_SOURCES)))
373 $(1)_OBJS := $$(addprefix $(USER_OBJS_DIR),$$(sort $$($(1)_OBJS:%/=%)))
375 USER_OBJS += $$($(1)_OBJS)
376 USER_SOURCES += $$($(1)_SOURCES)
380 program_cmd = $$(if $$(filter %.cc,$$($(1)_SOURCES)),$$(CXX),$$(CC)) \
381 $$($(1)_OBJS) $$($(1)_LIBS:%=-l%) $$(LOADLIBES) $$(LDFLAGS) -Wl,-rpath-link,$(USER_LIB_DIR) \
382 -Wl,-Map,$(USER_OBJS_DIR)/$(1).exe.map -o $$$$@
384 $(call prepare_rule_default,\
385 $(USER_BIN_DIR)/$(1)$(EXE_SUFFIX),\
386 $$($(1)_OBJS) $$($(1)_LIBS),\
391 c_o_cmd := set -e; cd $$(dir $$@); \
392 if $$(c_o_COMPILE) $$(CC_DEPFLAGS) -o $$@ -c $$< ; \
393 then mv -f "$$@.d.tmp" "$$@.d" ; \
394 else rm -f "$$@.d.tmp" ; \
398 $(foreach prog,$(bin_PROGRAMS),$(eval $(call program_template,$(prog),bin)))
399 $(foreach src,$(filter %.c,$(USER_SOURCES)),$(eval $(call prepare_rule,\
400 $(USER_OBJS_DIR)/$(src:%.c=%.o),\
401 $(SOURCES_DIR)/$(src),\
405 default: check-dir prepare-pass
406 $(MAKE) -qp -f Makefile.build > make.db.build-pseudo-pass; \
407 $(MAKE) -f Makefile.build
410 @$(call mkdir_def,$(USER_BUILD_DIR))
411 @$(call mkdir_def,$(USER_INCLUDE_DIR))
412 @$(call mkdir_def,$(USER_LIB_DIR))
413 @$(call mkdir_def,$(USER_BIN_DIR))
414 @$(call mkdir_def,$(USER_UTILS_DIR))
415 @$(call mkdir_def,$(USER_TESTS_DIR))