granicus.if.org Git - esp-idf/blob - make/component_wrapper.mk

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