make/component_wrapper.mk

   1 # Copyright 2015-2018 Espressif Systems (Shanghai) PTE LTD
   2 #
   3 # Component wrapper makefile
   4 #
   5 # This makefile gets called recursively from the project make, once for each component.
   6 # COMPONENT_MAKEFILE is set to point at the component.mk file for the component itself,
   7 # which is included as part of this process (after default variables are defined).
   8 #
   9 # This makefile comprises multiple stages, marked in blocked comments below.
  10 #
  11 # CWD is the build directory of the component.
  12 #
  13 # Licensed under the Apache License, Version 2.0 (the "License");
  14 # you may not use this file except in compliance with the License.
  15 # You may obtain a copy of the License at
  16 #
  17 #     http://www.apache.org/licenses/LICENSE-2.0
  18 #
  19 # Unless required by applicable law or agreed to in writing, software
  20 # distributed under the License is distributed on an "AS IS" BASIS,
  21 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  22 # See the License for the specific language governing permissions and
  23 # limitations under the License.
  24
  25 ifndef PROJECT_PATH
  26 $(error Make was invoked from $(CURDIR). However please do not run make from the sdk or a component directory; invoke make from the project directory. See the ESP-IDF README for details.)
  27 endif
  28
  29
  30 ################################################################################
  31 # 1) Set default variables for the component build (including configuration
  32 #       loaded from sdkconfig.)
  33 ################################################################################
  34
  35 # Find the path to the component
  36 COMPONENT_PATH := $(abspath $(dir $(COMPONENT_MAKEFILE)))
  37 export COMPONENT_PATH
  38
  39 # COMPONENT_BUILD_DIR is otherwise known as CWD for the build
  40 COMPONENT_BUILD_DIR := $(abspath .)
  41
  42 # include elements common to both project & component makefiles
  43 # (includes project configuration set via menuconfig)
  44 include $(IDF_PATH)/make/common.mk
  45
  46 # Some of the following defaults may be overriden by the component's component.mk makefile,
  47 # during the next step:
  48
  49 # Absolute path of the .a file
  50 COMPONENT_LIBRARY = lib$(COMPONENT_NAME).a
  51
  52 # Source dirs a component has. Default to root directory of component.
  53 COMPONENT_SRCDIRS = .
  54
  55 #Names of binary & text files to embed as raw content in the component library
  56 COMPONENT_EMBED_FILES ?=
  57 COMPONENT_EMBED_TXTFILES ?=
  58
  59 # By default, include only the include/ dir.
  60 COMPONENT_ADD_INCLUDEDIRS = include
  61 COMPONENT_ADD_LDFLAGS = -l$(COMPONENT_NAME)
  62
  63 # Define optional compiling macros
  64 define compile_exclude
  65 COMPONENT_OBJEXCLUDE += $(1)
  66 endef
  67
  68 define compile_include
  69 COMPONENT_OBJINCLUDE += $(1)
  70 endef
  71
  72 define compile_only_if
  73 $(eval $(if $(1), $(call compile_include, $(2)), $(call compile_exclude, $(2))))
  74 endef
  75
  76 define compile_only_if_not
  77 $(eval $(if $(1), $(call compile_exclude, $(2)), $(call compile_include, $(2))))
  78 endef
  79
  80 COMPONENT_ADD_LINKER_DEPS ?=
  81 COMPONENT_DEPENDS ?=
  82 COMPONENT_EXTRA_CLEAN ?=
  83 COMPONENT_EXTRA_INCLUDES ?=
  84 COMPONENT_OBJEXCLUDE ?=
  85 COMPONENT_OBJINCLUDE ?=
  86 COMPONENT_SUBMODULES ?=
  87
  88 ################################################################################
  89 # 2) Include the component.mk for the specific component (COMPONENT_MAKEFILE) to
  90 #     override variables & optionally define custom targets. Also include global
  91 #     component makefiles.
  92 ################################################################################
  93
  94
  95 # Include any Makefile.componentbuild file letting components add
  96 # configuration at the global component level
  97
  98 # Save component_path; we pass it to the called Makefile.componentbuild
  99 # as COMPILING_COMPONENT_PATH, and we use it to restore the current
 100 # COMPONENT_PATH later.
 101 COMPILING_COMPONENT_PATH := $(COMPONENT_PATH)
 102
 103 define includeCompBuildMakefile
 104 $(if $(V),$(info including $(1)/Makefile.componentbuild...))
 105 COMPONENT_PATH := $(1)
 106 include $(1)/Makefile.componentbuild
 107 endef
 108 $(foreach componentpath,$(COMPONENT_PATHS), \
 109         $(if $(wildcard $(componentpath)/Makefile.componentbuild), \
 110                 $(eval $(call includeCompBuildMakefile,$(componentpath)))))
 111
 112 #Restore COMPONENT_PATH to what it was
 113 COMPONENT_PATH := $(COMPILING_COMPONENT_PATH)
 114
 115
 116 # Include component.mk for this component.
 117 include $(COMPONENT_MAKEFILE)
 118
 119
 120 ################################################################################
 121 # 3) Set variables that depend on values that may changed by component.mk
 122 ################################################################################
 123
 124 ifndef COMPONENT_CONFIG_ONLY  # Skip steps 3-5 if COMPONENT_CONFIG_ONLY is set
 125
 126 # Object files which need to be linked into the library
 127 # By default we take all .c, .cpp, .cc & .S files in COMPONENT_SRCDIRS.
 128 ifndef COMPONENT_OBJS
 129 # Find all source files in all COMPONENT_SRCDIRS
 130 COMPONENT_OBJS := $(foreach compsrcdir,$(COMPONENT_SRCDIRS),$(patsubst %.c,%.o,$(wildcard $(COMPONENT_PATH)/$(compsrcdir)/*.c)))
 131 COMPONENT_OBJS += $(foreach compsrcdir,$(COMPONENT_SRCDIRS),$(patsubst %.cpp,%.o,$(wildcard $(COMPONENT_PATH)/$(compsrcdir)/*.cpp)))
 132 COMPONENT_OBJS += $(foreach compsrcdir,$(COMPONENT_SRCDIRS),$(patsubst %.cc,%.o,$(wildcard $(COMPONENT_PATH)/$(compsrcdir)/*.cc)))
 133 COMPONENT_OBJS += $(foreach compsrcdir,$(COMPONENT_SRCDIRS),$(patsubst %.S,%.o,$(wildcard $(COMPONENT_PATH)/$(compsrcdir)/*.S)))
 134 # Make relative by removing COMPONENT_PATH from all found object paths
 135 COMPONENT_OBJS := $(patsubst $(COMPONENT_PATH)/%,%,$(COMPONENT_OBJS))
 136 else
 137 # Add in components defined by conditional compiling macros
 138 COMPONENT_OBJS += $(COMPONENT_OBJINCLUDE)
 139 endif
 140 # Remove items disabled by optional compilation
 141 COMPONENT_OBJS := $(foreach obj,$(COMPONENT_OBJS),$(if $(filter $(realpath $(obj)),$(realpath $(COMPONENT_OBJEXCLUDE))), ,$(obj)))
 142
 143 # Remove duplicates
 144 COMPONENT_OBJS := $(call uniq,$(COMPONENT_OBJS))
 145
 146
 147 # Object files with embedded binaries to add to the component library
 148 # Correspond to the files named in COMPONENT_EMBED_FILES & COMPONENT_EMBED_TXTFILES
 149 COMPONENT_EMBED_OBJS ?= $(addsuffix .bin.o,$(notdir $(COMPONENT_EMBED_FILES))) $(addsuffix .txt.o,$(notdir $(COMPONENT_EMBED_TXTFILES)))
 150
 151 # If we're called to compile something, we'll get passed the COMPONENT_INCLUDES
 152 # variable with all the include dirs from all the components in random order. This
 153 # means we can accidentally grab a header from another component before grabbing our own.
 154 # To make sure that does not happen, re-order the includes so ours come first.
 155 COMPONENT_PRIV_INCLUDEDIRS ?=
 156 OWN_INCLUDES:=$(abspath $(addprefix $(COMPONENT_PATH)/,$(COMPONENT_PRIV_INCLUDEDIRS) $(COMPONENT_ADD_INCLUDEDIRS)))
 157 COMPONENT_INCLUDES := $(OWN_INCLUDES) $(filter-out $(OWN_INCLUDES),$(COMPONENT_INCLUDES))
 158
 159
 160 ################################################################################
 161 # 4) Define a target to generate component_project_vars.mk Makefile which
 162 # contains common per-component settings which are included directly in the
 163 # top-level project make
 164 #
 165 # (Skipped if COMPONENT_CONFIG_ONLY is set.)
 166 ################################################################################
 167
 168 # macro to generate variable-relative paths inside component_project_vars.mk, whenever possible
 169 # ie put literal $(IDF_PATH), $(PROJECT_PATH) and $(BUILD_DIR_BASE) into the generated
 170 # makefiles where possible.
 171 #
 172 # This means if directories move (breaking absolute paths), don't need to 'make clean'
 173 define MakeVariablePath
 174 $(subst $(IDF_PATH),$$(IDF_PATH),$(subst $(PROJECT_PATH),$$(PROJECT_PATH),$(subst $(BUILD_DIR_BASE),$$(BUILD_DIR_BASE),$(1))))
 175 endef
 176
 177 # component_project_vars.mk target for the component. This is used to
 178 # take component.mk variables COMPONENT_ADD_INCLUDEDIRS,
 179 # COMPONENT_ADD_LDFLAGS, COMPONENT_DEPENDS and COMPONENT_SUBMODULES
 180 # and inject those into the project make pass.
 181 #
 182 # The target here has no dependencies, as the parent target in
 183 # project.mk evaluates dependencies before calling down to here. See
 184 # GenerateComponentTargets macro in project.mk.
 185 #
 186 # If you are thinking of editing the output of this target for a
 187 # component-specific feature, please don't! What you want is a
 188 # Makefile.projbuild for your component (see docs/build-system.rst for
 189 # more.)
 190 #
 191 # Note: The :: target here is not a mistake. This target should always be
 192 # executed, as dependencies are checked by the parent project-level make target.
 193 # See https://www.gnu.org/software/make/manual/make.html#index-_003a_003a-rules-_0028double_002dcolon_0029
 194 component_project_vars.mk::
 195         $(details) "Building component project variables list $(abspath $@)"
 196         @echo '# Automatically generated build file. Do not edit.' > $@
 197         @echo 'COMPONENT_INCLUDES += $(call MakeVariablePath,$(addprefix $(COMPONENT_PATH)/,$(COMPONENT_ADD_INCLUDEDIRS)))' >> $@
 198         @echo 'COMPONENT_LDFLAGS += $(call MakeVariablePath,-L$(COMPONENT_BUILD_DIR) $(COMPONENT_ADD_LDFLAGS))' >> $@
 199         @echo 'COMPONENT_LINKER_DEPS += $(call MakeVariablePath,$(call resolvepath,$(COMPONENT_ADD_LINKER_DEPS),$(COMPONENT_PATH)))' >> $@
 200         @echo 'COMPONENT_SUBMODULES += $(call MakeVariablePath,$(addprefix $(COMPONENT_PATH)/,$(COMPONENT_SUBMODULES)))' >> $@
 201         @echo 'COMPONENT_LIBRARIES += $(COMPONENT_NAME)' >> $@
 202         @echo 'component-$(COMPONENT_NAME)-build: $(addprefix component-,$(addsuffix -build,$(COMPONENT_DEPENDS)))' >> $@
 203
 204 ################################################################################
 205 # 5) Where COMPONENT_OWNBUILDTARGET / COMPONENT_OWNCLEANTARGET
 206 # is not set by component.mk, define default build, clean, etc. targets
 207 #
 208 # (Skipped if COMPONENT_CONFIG_ONLY is set.)
 209 ################################################################################
 210
 211 # Default build behaviour: define a phony build target and a COMPONENT_LIBRARY link target.
 212 ifndef COMPONENT_OWNBUILDTARGET
 213 .PHONY: build
 214 build: $(COMPONENT_LIBRARY)
 215
 216 # Build the archive. We remove the archive first, otherwise ar will get confused if we update
 217 # an archive when multiple filenames have the same name (src1/test.o and src2/test.o)
 218 $(COMPONENT_LIBRARY): $(COMPONENT_OBJS) $(COMPONENT_EMBED_OBJS)
 219         $(summary) AR $(patsubst $(PWD)/%,%,$(CURDIR))/$@
 220         rm -f $@
 221         $(AR) cru $@ $^
 222 endif
 223
 224 # If COMPONENT_OWNCLEANTARGET is not set, define a phony clean target
 225 ifndef COMPONENT_OWNCLEANTARGET
 226 CLEAN_FILES := $(COMPONENT_LIBRARY) $(COMPONENT_OBJS) $(COMPONENT_OBJS:.o=.d) $(COMPONENT_OBJEXCLUDE) $(COMPONENT_OBJEXCLUDE:.o=.d) $(COMPONENT_EMBED_OBJS) $(COMPONENT_EXTRA_CLEAN) component_project_vars.mk
 227 .PHONY: clean
 228 clean:
 229         $(summary) RM $(CLEAN_FILES)
 230         rm -f $(CLEAN_FILES)
 231 endif
 232
 233 DEBUG_FLAGS ?= -ggdb
 234
 235 # Include all dependency files already generated
 236 -include $(COMPONENT_OBJS:.o=.d)
 237
 238 # This is a fix for situation where the project or IDF dir moves, and instead
 239 # of rebuilding the target the build fails until make clean is run
 240 #
 241 # It adds an empty dependency rule for the (possibly non-existent) source file itself,
 242 # which prevents it not being found from failing the build
 243 #
 244 # $1 == Source File, $2 == .o file used for .d file name
 245 define AppendSourceToDependencies
 246 echo "$1:" >> $$(patsubst %.o,%.d,$2)
 247 endef
 248
 249
 250 # This pattern is generated for each COMPONENT_SRCDIR to compile the files in it.
 251 define GenerateCompileTargets
 252 # $(1) - directory containing source files, relative to $(COMPONENT_PATH) - one of $(COMPONENT_SRCDIRS)
 253 #
 254 $(1)/%.o: $$(COMPONENT_PATH)/$(1)/%.c $(COMMON_MAKEFILES) $(COMPONENT_MAKEFILE) | $(COMPONENT_SRCDIRS)
 255         $$(summary) CC $$(patsubst $$(PWD)/%,%,$$(CURDIR))/$$@
 256         $$(CC) $$(CFLAGS) $$(CPPFLAGS) $$(addprefix -I ,$$(COMPONENT_INCLUDES)) $$(addprefix -I ,$$(COMPONENT_EXTRA_INCLUDES)) -I$(1) -c $$< -o $$@
 257         $(call AppendSourceToDependencies,$$<,$$@)
 258
 259 $(1)/%.o: $$(COMPONENT_PATH)/$(1)/%.cpp $(COMMON_MAKEFILES) $(COMPONENT_MAKEFILE) | $(COMPONENT_SRCDIRS)
 260         $$(summary) CXX $$(patsubst $$(PWD)/%,%,$$(CURDIR))/$$@
 261         $$(CXX) $$(CXXFLAGS) $$(CPPFLAGS) $$(addprefix -I,$$(COMPONENT_INCLUDES)) $$(addprefix -I,$$(COMPONENT_EXTRA_INCLUDES)) -I$(1) -c $$< -o $$@
 262         $(call AppendSourceToDependencies,$$<,$$@)
 263
 264 $(1)/%.o: $$(COMPONENT_PATH)/$(1)/%.cc $(COMMON_MAKEFILES) $(COMPONENT_MAKEFILE) | $(COMPONENT_SRCDIRS)
 265         $$(summary) CXX $$(patsubst $$(PWD)/%,%,$$(CURDIR))/$$@
 266         $$(CXX) $$(CXXFLAGS) $$(CPPFLAGS) $$(addprefix -I,$$(COMPONENT_INCLUDES)) $$(addprefix -I,$$(COMPONENT_EXTRA_INCLUDES)) -I$(1) -c $$< -o $$@
 267         $(call AppendSourceToDependencies,$$<,$$@)
 268
 269 $(1)/%.o: $$(COMPONENT_PATH)/$(1)/%.S $(COMMON_MAKEFILES) $(COMPONENT_MAKEFILE) | $(COMPONENT_SRCDIRS)
 270         $$(summary) AS $$(patsubst $$(PWD)/%,%,$$(CURDIR))/$$@
 271         $$(CC) $$(CPPFLAGS) $$(DEBUG_FLAGS) $$(addprefix -I ,$$(COMPONENT_INCLUDES)) $$(addprefix -I ,$$(COMPONENT_EXTRA_INCLUDES)) -I$(1) -c $$< -o $$@
 272         $(call AppendSourceToDependencies,$$<,$$@)
 273
 274 # CWD is build dir, create the build subdirectory if it doesn't exist
 275 #
 276 # (NB: Each .o file depends on all relative component build dirs $(COMPONENT_SRCDIRS), rather than just $(1), to work
 277 # around a behaviour make 3.81 where the first pattern (randomly) seems to be matched rather than the best fit. ie if
 278 # you have objects a/y.o and a/b/c.o then c.o can be matched with $(1)=a & %=b/c, meaning that subdir 'a/b' needs to be
 279 # created but wouldn't be created if $(1)=a. Make 4.x doesn't have this problem, it seems to preferentially
 280 # choose the better match ie $(1)=a/b and %=c )
 281 #
 282 $(1):
 283         mkdir -p $(1)
 284 endef
 285
 286 # Generate all the compile target patterns
 287 $(foreach srcdir,$(COMPONENT_SRCDIRS), $(eval $(call GenerateCompileTargets,$(srcdir))))
 288
 289 ## Support for embedding binary files into the ELF as symbols
 290
 291 OBJCOPY_EMBED_ARGS := --input-target binary --output-target elf32-xtensa-le --binary-architecture xtensa --rename-section .data=.rodata.embedded
 292
 293 # Generate pattern for embedding text or binary files into the app
 294 # $(1) is name of file (as relative path inside component)
 295 # $(2) is txt or bin depending on file contents
 296 #
 297 # txt files are null-terminated before being embedded (otherwise
 298 # identical behaviour.)
 299 #
 300 define GenerateEmbedTarget
 301
 302 # copy the input file into the build dir (using a subdirectory
 303 # in case the file already exists elsewhere in the build dir)
 304 embed_bin/$$(notdir $(1)): $(call resolvepath,$(1),$(COMPONENT_PATH)) | embed_bin
 305         cp $$< $$@
 306
 307 embed_txt/$$(notdir $(1)): $(call resolvepath,$(1),$(COMPONENT_PATH)) | embed_txt
 308         cp $$< $$@
 309         printf '\0' >> $$@  # null-terminate text files
 310
 311 # messing about with the embed_X subdirectory then using 'cd' for objcopy is because the
 312 # full path passed to OBJCOPY makes it into the name of the symbols in the .o file
 313 $$(notdir $(1)).$(2).o: embed_$(2)/$$(notdir $(1))
 314         $(summary) EMBED $$(patsubst $$(PWD)/%,%,$$(CURDIR))/$$@
 315         cd embed_$(2); $(OBJCOPY) $(OBJCOPY_EMBED_ARGS) $$(notdir $$<) ../$$@
 316
 317 CLEAN_FILES += embed_$(2)/$$(notdir $(1))
 318 endef
 319
 320 embed_txt embed_bin:
 321         mkdir -p $@
 322
 323 # generate targets to embed binary & text files
 324 $(foreach binfile,$(COMPONENT_EMBED_FILES), $(eval $(call GenerateEmbedTarget,$(binfile),bin)))
 325
 326 $(foreach txtfile,$(COMPONENT_EMBED_TXTFILES), $(eval $(call GenerateEmbedTarget,$(txtfile),txt)))
 327
 328 else   # COMPONENT_CONFIG_ONLY is set
 329
 330 build:
 331         $(details) "No build needed for $(COMPONENT_NAME) (COMPONENT_CONFIG_ONLY)"
 332
 333 clean:
 334         $(summary) RM component_project_vars.mk
 335         rm -f component_project_vars.mk
 336
 337 component_project_vars.mk::  # no need to add variables via component.mk
 338         @echo '# COMPONENT_CONFIG_ONLY target sets no variables here' > $@
 339
 340 endif  # COMPONENT_CONFIG_ONLY
 341