1 #
2 # Copyright (c) 2011, 2019, Oracle and/or its affiliates. All rights reserved.
3 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 #
5 # This code is free software; you can redistribute it and/or modify it
6 # under the terms of the GNU General Public License version 2 only, as
7 # published by the Free Software Foundation. Oracle designates this
8 # particular file as subject to the "Classpath" exception as provided
9 # by Oracle in the LICENSE file that accompanied this code.
10 #
11 # This code is distributed in the hope that it will be useful, but WITHOUT
12 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 # version 2 for more details (a copy is included in the LICENSE file that
15 # accompanied this code).
16 #
17 # You should have received a copy of the GNU General Public License version
18 # 2 along with this work; if not, write to the Free Software Foundation,
19 # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 #
21 # Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 # or visit www.oracle.com if you need additional information or have any
23 # questions.
24 #
25
26 # When you read this source. Remember that $(sort ...) has the side effect
27 # of removing duplicates. It is actually this side effect that is
28 # desired whenever sort is used below!
29
30 ifndef _NATIVE_COMPILATION_GMK
31 _NATIVE_COMPILATION_GMK := 1
32
33 ifeq ($(_MAKEBASE_GMK), )
34 $(error You must include MakeBase.gmk prior to including NativeCompilation.gmk)
35 endif
36
37 ################################################################################
38 # Create exported symbols file for static libraries
39 ################################################################################
40
41 # get the exported symbols from mapfiles and if there
42 # is no mapfile, get them from the archive
43 define GetSymbols
44 $(RM) $$(@D)/$$(basename $$(@F)).symbols; \
45 if [ ! -z $$($1_MAPFILE) -a -e $$($1_MAPFILE) ]; then \
46 $(ECHO) "Getting symbols from mapfile $$($1_MAPFILE)"; \
47 $(AWK) '/global:/','/local:/' $$($1_MAPFILE) | \
48 $(SED) -e 's/#.*//;s/global://;s/local://;s/\;//;s/^[ ]*/_/;/^_$$$$/d' | \
49 $(EGREP) -v "JNI_OnLoad|JNI_OnUnload|Agent_OnLoad|Agent_OnUnload|Agent_OnAttach" > \
50 $$(@D)/$$(basename $$(@F)).symbols || true; \
51 $(NM) $$($1_TARGET) | $(GREP) " T " | \
52 $(EGREP) "JNI_OnLoad|JNI_OnUnload|Agent_OnLoad|Agent_OnUnload|Agent_OnAttach" | \
53 $(CUT) -d ' ' -f 3 >> $$(@D)/$$(basename $$(@F)).symbols || true;\
54 else \
55 $(ECHO) "Getting symbols from nm"; \
56 $(NM) -m $$($1_TARGET) | $(GREP) "__TEXT" | \
57 $(EGREP) -v "non-external|private extern|__TEXT,__eh_frame" | \
58 $(SED) -e 's/.* //' > $$(@D)/$$(basename $$(@F)).symbols; \
59 fi
60 endef
61
62 ################################################################################
63 # Creates a recipe that creates a compile_commands.json fragment. Remove any
64 # occurences of FIXPATH programs from the command to show the actual invocation.
65 #
66 # Param 1: Name of file to create
67 # Param 2: Working directory
68 # Param 3: Source file
69 # Param 4: Compile command
70 ################################################################################
71 define WriteCompileCommandsFragment
72 $(call LogInfo, Creating compile commands fragment for $(notdir $3))
73 $(call MakeDir, $(dir $1))
74 $(call WriteFile,{ \
75 "directory": "$(strip $2)"$(COMMA) \
76 "file": "$(strip $3)"$(COMMA) \
77 "command": "$(strip $(subst $(DQUOTE),\$(DQUOTE),$(subst \,\\,\
78 $(subst $(FIXPATH),,$4))))" \
79 }$(COMMA), \
80 $1)
81 endef
82
83 ################################################################################
84 # Define a native toolchain configuration that can be used by
85 # SetupNativeCompilation calls
86 #
87 # Parameter 1 is the name of the toolchain definition
88 #
89 # Remaining parameters are named arguments:
90 # EXTENDS - Optional parent definition to get defaults from
91 # CC - The C compiler
92 # CXX - The C++ compiler
93 # LD - The Linker
94 # AR - Static linker
95 # AS - Assembler
96 # MT - Windows MT tool
97 # RC - Windows RC tool
98 # OBJCOPY - The objcopy tool for debug symbol handling
99 # STRIP - The tool to use for stripping debug symbols
100 # SYSROOT_CFLAGS - Compiler flags for using the specific sysroot
101 # SYSROOT_LDFLAGS - Linker flags for using the specific sysroot
102 DefineNativeToolchain = $(NamedParamsMacroTemplate)
103 define DefineNativeToolchainBody
104 # If extending another definition, get default values from that,
105 # otherwise, nothing more needs to be done as variable assignments
106 # already happened in NamedParamsMacroTemplate.
107 ifneq ($$($1_EXTENDS), )
108 $$(call SetIfEmpty, $1_CC, $$($$($1_EXTENDS)_CC))
109 $$(call SetIfEmpty, $1_CXX, $$($$($1_EXTENDS)_CXX))
110 $$(call SetIfEmpty, $1_LD, $$($$($1_EXTENDS)_LD))
111 $$(call SetIfEmpty, $1_AR, $$($$($1_EXTENDS)_AR))
112 $$(call SetIfEmpty, $1_AS, $$($$($1_EXTENDS)_AS))
113 $$(call SetIfEmpty, $1_MT, $$($$($1_EXTENDS)_MT))
114 $$(call SetIfEmpty, $1_RC, $$($$($1_EXTENDS)_RC))
115 $$(call SetIfEmpty, $1_OBJCOPY, $$($$($1_EXTENDS)_OBJCOPY))
116 $$(call SetIfEmpty, $1_STRIP, $$($$($1_EXTENDS)_STRIP))
117 $$(call SetIfEmpty, $1_SYSROOT_CFLAGS, $$($$($1_EXTENDS)_SYSROOT_CFLAGS))
118 $$(call SetIfEmpty, $1_SYSROOT_LDFLAGS, $$($$($1_EXTENDS)_SYSROOT_LDFLAGS))
119 endif
120 endef
121
122 # Create a default toolchain with the main compiler and linker
123 $(eval $(call DefineNativeToolchain, TOOLCHAIN_DEFAULT, \
124 CC := $(CC), \
125 CXX := $(CXX), \
126 LD := $(LD), \
127 AR := $(AR), \
128 AS := $(AS), \
129 MT := $(MT), \
130 RC := $(RC), \
131 OBJCOPY := $(OBJCOPY), \
132 STRIP := $(STRIP), \
133 SYSROOT_CFLAGS := $(SYSROOT_CFLAGS), \
134 SYSROOT_LDFLAGS := $(SYSROOT_LDFLAGS), \
135 ))
136
137 # Create a toolchain where linking is done with the C++ linker
138 $(eval $(call DefineNativeToolchain, TOOLCHAIN_LINK_CXX, \
139 EXTENDS := TOOLCHAIN_DEFAULT, \
140 LD := $(LDCXX), \
141 ))
142
143 # Create a toolchain with the BUILD compiler, used for build tools that
144 # are to be run during the build.
145 $(eval $(call DefineNativeToolchain, TOOLCHAIN_BUILD, \
146 CC := $(BUILD_CC), \
147 CXX := $(BUILD_CXX), \
148 LD := $(BUILD_LD), \
149 AR := $(BUILD_AR), \
150 AS := $(BUILD_AS), \
151 OBJCOPY := $(BUILD_OBJCOPY), \
152 STRIP := $(BUILD_STRIP), \
153 SYSROOT_CFLAGS := $(BUILD_SYSROOT_CFLAGS), \
154 SYSROOT_LDFLAGS := $(BUILD_SYSROOT_LDFLAGS), \
155 ))
156
157 # BUILD toolchain with the C++ linker
158 $(eval $(call DefineNativeToolchain, TOOLCHAIN_BUILD_LINK_CXX, \
159 EXTENDS := TOOLCHAIN_BUILD, \
160 LD := $(BUILD_LDCXX), \
161 ))
162
163 ################################################################################
164
165 # Extensions of files handled by this macro.
166 NATIVE_SOURCE_EXTENSIONS := %.s %.S %.c %.cpp %.cc %.m %.mm
167
168 # Replaces native source extensions with the object file extension in a string.
169 # Param 1: the string containing source file names with extensions
170 # The surrounding strip is needed to keep additional whitespace out
171 define replace_with_obj_extension
172 $(strip \
173 $(foreach extension, $(NATIVE_SOURCE_EXTENSIONS), \
174 $(patsubst $(extension),%$(OBJ_SUFFIX), $(filter $(extension), $1))) \
175 )
176 endef
177
178 ifeq ($(call isBuildOsEnv, windows.cygwin), true)
179 UNIX_PATH_PREFIX := /cygdrive
180 else ifeq ($(call isBuildOsEnv, windows.msys), true)
181 UNIX_PATH_PREFIX :=
182 endif
183
184 # This pattern is used to transform the output of the microsoft CL compiler
185 # into a make syntax dependency file (.d)
186 WINDOWS_SHOWINCLUDE_SED_PATTERN := \
187 -e '/^Note: including file:/!d' \
188 -e 's|Note: including file: *||' \
189 -e 's|\r||g' \
190 -e 's|\\|/|g' \
191 -e 's|^\([a-zA-Z]\):|$(UNIX_PATH_PREFIX)/\1|g' \
192 -e '\|$(TOPDIR)|I !d' \
193 -e 's|$$$$| \\|g' \
194 #
195
196 # This pattern is used to transform a dependency file (.d) to a list
197 # of make targets for dependent files (.d.targets)
198 DEPENDENCY_TARGET_SED_PATTERN := \
199 -e 's/\#.*//' \
200 -e 's/^[^:]*: *//' \
201 -e 's/ *\\$$$$//' \
202 -e 's/^[ ]*//' \
203 -e '/^$$$$/ d' \
204 -e 's/$$$$/ :/' \
205 #
206
207 ################################################################################
208 # Create the recipe needed to compile a single native source file.
209 #
210 # Parameter 1 is the name of the rule, based on the name of the library/
211 # program being build and the name of the source code file, e.g.
212 # BUILD_LIBFOO_fooMain.cpp.
213 #
214 # Remaining parameters are named arguments:
215 # FILE - The full path of the source file to compiler
216 # BASE - The name of the rule for the entire binary to build ($1)
217 # DISABLE_THIS_FILE_DEFINE - Set to true to disable the THIS_FILE define.
218 #
219 SetupCompileNativeFile = $(NamedParamsMacroTemplate)
220 define SetupCompileNativeFileBody
221 $1_FILENAME := $$(notdir $$($1_FILE))
222
223 # The target file to be generated.
224 $1_OBJ := $$($$($1_BASE)_OBJECT_DIR)/$$(call replace_with_obj_extension, \
225 $$($1_FILENAME))
226
227 # Generate the corresponding compile_commands.json fragment.
228 $1_OBJ_JSON = $$(MAKESUPPORT_OUTPUTDIR)/compile-commands/$$(subst /,_,$$(subst \
229 $$(OUTPUTDIR)/,,$$($1_OBJ))).json
230 $$($1_BASE)_ALL_OBJS_JSON += $$($1_OBJ_JSON)
231
232 # Only continue if this object file hasn't been processed already. This lets
233 # the first found source file override any other with the same name.
234 ifeq ($$($1_OBJ_PROCESSED), )
235 $1_OBJ_PROCESSED := true
236 # This is the definite source file to use for $1_FILENAME.
237 $1_SRC_FILE := $$($1_FILE)
238
239 ifneq ($$($1_DEFINE_THIS_FILE), false)
240 ifneq ($$($$($1_BASE)_DEFINE_THIS_FILE), false)
241 $1_THIS_FILE = -DTHIS_FILE='"$$($1_FILENAME)"'
242 endif
243 endif
244
245 ifeq ($$($1_OPTIMIZATION), )
246 $1_OPT_CFLAGS := $$($$($1_BASE)_OPT_CFLAGS)
247 $1_OPT_CXXFLAGS := $$($$($1_BASE)_OPT_CXXFLAGS)
248 else
249 ifeq ($$($1_OPTIMIZATION), NONE)
250 $1_OPT_CFLAGS := $(C_O_FLAG_NONE)
251 $1_OPT_CXXFLAGS := $(CXX_O_FLAG_NONE)
252 else ifeq ($$($1_OPTIMIZATION), LOW)
253 $1_OPT_CFLAGS := $(C_O_FLAG_NORM)
254 $1_OPT_CXXFLAGS := $(CXX_O_FLAG_NORM)
255 else ifeq ($$($1_OPTIMIZATION), HIGH)
256 $1_OPT_CFLAGS := $(C_O_FLAG_HI)
257 $1_OPT_CXXFLAGS := $(CXX_O_FLAG_HI)
258 else ifeq ($$($1_OPTIMIZATION), HIGHEST)
259 $1_OPT_CFLAGS := $(C_O_FLAG_HIGHEST)
260 $1_OPT_CXXFLAGS := $(CXX_O_FLAG_HIGHEST)
261 else ifeq ($$($1_OPTIMIZATION), HIGHEST_JVM)
262 $1_OPT_CFLAGS := $(C_O_FLAG_HIGHEST_JVM)
263 $1_OPT_CXXFLAGS := $(CXX_O_FLAG_HIGHEST_JVM)
264 else ifeq ($$($1_OPTIMIZATION), SIZE)
265 $1_OPT_CFLAGS := $(C_O_FLAG_SIZE)
266 $1_OPT_CXXFLAGS := $(CXX_O_FLAG_SIZE)
267 else
268 $$(error Unknown value for file OPTIMIZATION: $$($1_OPTIMIZATION))
269 endif
270 endif
271
272 ifneq ($$($$($1_BASE)_PRECOMPILED_HEADER), )
273 ifeq ($$(filter $$($1_FILENAME), $$($$($1_BASE)_PRECOMPILED_HEADER_EXCLUDE)), )
274 $1_USE_PCH_FLAGS := $$($$($1_BASE)_USE_PCH_FLAGS)
275 endif
276 endif
277
278 $1_BASE_CFLAGS := $$($$($1_BASE)_CFLAGS) $$($$($1_BASE)_EXTRA_CFLAGS) \
279 $$($$($1_BASE)_SYSROOT_CFLAGS)
280 $1_BASE_CXXFLAGS := $$($$($1_BASE)_CXXFLAGS) $$($$($1_BASE)_EXTRA_CXXFLAGS) \
281 $$($$($1_BASE)_SYSROOT_CFLAGS) $$($1_EXTRA_CXXFLAGS)
282 $1_BASE_ASFLAGS := $$($$($1_BASE)_ASFLAGS) $$($$($1_BASE)_EXTRA_ASFLAGS)
283
284 ifneq ($$(filter %.c, $$($1_FILENAME)), )
285 # Compile as a C file
286 $1_FLAGS := $(CFLAGS_CCACHE) $$($1_USE_PCH_FLAGS) $$($1_BASE_CFLAGS) \
287 $$($1_OPT_CFLAGS) $$($1_CFLAGS) $$($1_THIS_FILE) -c
288 $1_COMPILER := $$($$($1_BASE)_CC)
289 $1_DEP_FLAG := $(C_FLAG_DEPS)
290 else ifneq ($$(filter %.m, $$($1_FILENAME)), )
291 # Compile as an Objective-C file
292 $1_FLAGS := -x objective-c $(CFLAGS_CCACHE) $$($1_USE_PCH_FLAGS) \
293 $$($1_BASE_CFLAGS) $$($1_OPT_CFLAGS) $$($1_CFLAGS) $$($1_THIS_FILE) -c
294 $1_COMPILER := $$($$($1_BASE)_CC)
295 $1_DEP_FLAG := $(C_FLAG_DEPS)
296 else ifneq ($$(filter %.s %.S, $$($1_FILENAME)), )
297 # Compile as assembler file
298 $1_FLAGS := $$($1_BASE_ASFLAGS)
299 $1_COMPILER := $(AS)
300 $1_DEP_FLAG :=
301 else ifneq ($$(filter %.cpp %.cc %.mm, $$($1_FILENAME)), )
302 # Compile as a C++ or Objective-C++ file
303 $1_FLAGS := $(CFLAGS_CCACHE) $$($1_USE_PCH_FLAGS) $$($1_BASE_CXXFLAGS) \
304 $$($1_OPT_CXXFLAGS) $$($1_CXXFLAGS) $$($1_THIS_FILE) -c
305 $1_COMPILER := $$($$($1_BASE)_CXX)
306 $1_DEP_FLAG := $(CXX_FLAG_DEPS)
307 else
308 $$(error Internal error in NativeCompilation.gmk: no compiler for file $$($1_FILENAME))
309 endif
310
311 ifeq ($$(filter %.s %.S, $$($1_FILENAME)), )
312 # And this is the dependency file for this obj file.
313 $1_DEPS_FILE := $$(patsubst %$(OBJ_SUFFIX),%.d,$$($1_OBJ))
314 # The dependency target file lists all dependencies as empty targets to
315 # avoid make error "No rule to make target" for removed files
316 $1_DEPS_TARGETS_FILE := $$(patsubst %$(OBJ_SUFFIX),%.d.targets,$$($1_OBJ))
317
318 # Only try to load individual dependency information files if the global
319 # file hasn't been loaded (could happen if make was interrupted).
320 ifneq ($$($$($1_BASE)_DEPS_FILE_LOADED), true)
321 # Include previously generated dependency information. (if it exists)
322 -include $$($1_DEPS_FILE)
323 -include $$($1_DEPS_TARGETS_FILE)
324 endif
325 endif
326
327 ifneq ($$(strip $$($1_CFLAGS) $$($1_CXXFLAGS) $$($1_OPTIMIZATION)), )
328 $1_VARDEPS := $$($1_CFLAGS) $$($1_CXXFLAGS) $$($1_OPTIMIZATION)
329 $1_VARDEPS_FILE := $$(call DependOnVariable, $1_VARDEPS, $$($1_OBJ).vardeps)
330 endif
331
332 $1_OBJ_DEPS := $$($1_SRC_FILE) $$($$($1_BASE)_COMPILE_VARDEPS_FILE) \
333 $$($$($1_BASE)_EXTRA_DEPS) $$($1_VARDEPS_FILE)
334 $1_COMPILE_OPTIONS := $$($1_FLAGS) $(CC_OUT_OPTION)$$($1_OBJ) $$($1_SRC_FILE)
335
336 $$($1_OBJ_JSON): $$($1_OBJ_DEPS)
337 $$(call WriteCompileCommandsFragment, $$@, $$(PWD), $$($1_SRC_FILE), \
338 $$($1_COMPILER) $$($1_COMPILE_OPTIONS))
339
340 $$($1_OBJ): $$($1_OBJ_DEPS) | $$($$($1_BASE)_BUILD_INFO)
341 $$(call LogInfo, Compiling $$($1_FILENAME) (for $$($$($1_BASE)_BASENAME)))
342 $$(call MakeDir, $$(@D))
343 ifneq ($(TOOLCHAIN_TYPE), microsoft)
344 ifeq ($(TOOLCHAIN_TYPE)$$(filter %.s, $$($1_FILENAME)), solstudio)
345 # The Solaris studio compiler doesn't output the full path to the
346 # object file in the generated deps files. Fixing it with sed. If
347 # compiling assembly, don't try this.
348 $$(call ExecuteWithLog, $$@, \
349 $$($1_COMPILER) $$($1_DEP_FLAG) $$($1_DEPS_FILE).tmp $$($1_COMPILE_OPTIONS))
350 $(SED) 's|^$$(@F):|$$@:|' $$($1_DEPS_FILE).tmp > $$($1_DEPS_FILE)
351 else
352 $$(call ExecuteWithLog, $$@, \
353 $$($1_COMPILER) $$($1_DEP_FLAG) $$($1_DEPS_FILE) $$($1_COMPILE_OPTIONS))
354 endif
355 # Create a dependency target file from the dependency file.
356 # Solution suggested by http://make.mad-scientist.net/papers/advanced-auto-dependency-generation/
357 ifneq ($$($1_DEPS_FILE), )
358 $(SED) $(DEPENDENCY_TARGET_SED_PATTERN) $$($1_DEPS_FILE) > $$($1_DEPS_TARGETS_FILE)
359 endif
360 else
361 # The Visual Studio compiler lacks a feature for generating make
362 # dependencies, but by setting -showIncludes, all included files are
363 # printed. These are filtered out and parsed into make dependences.
364 #
365 # Keep as much as possible on one execution line for best performance
366 # on Windows. No need to save exit code from compilation since
367 # pipefail is always active on Windows.
368 $$(call ExecuteWithLog, $$@, \
369 $$($1_COMPILER) -showIncludes $$($1_COMPILE_OPTIONS)) \
370 | $(TR) -d '\r' | $(GREP) -v -e "^Note: including file:" \
371 -e "^$$($1_FILENAME)$$$$" || test "$$$$?" = "1" ; \
372 $(ECHO) $$@: \\ > $$($1_DEPS_FILE) ; \
373 $(SED) $(WINDOWS_SHOWINCLUDE_SED_PATTERN) $$($1_OBJ).log \
374 | $(SORT) -u >> $$($1_DEPS_FILE) ; \
375 $(ECHO) >> $$($1_DEPS_FILE) ; \
376 $(SED) $(DEPENDENCY_TARGET_SED_PATTERN) $$($1_DEPS_FILE) > $$($1_DEPS_TARGETS_FILE)
377 endif
378 endif
379 endef
380
381 # Setup make rules for creating a native binary (a shared library or an
382 # executable).
383 #
384 # Parameter 1 is the name of the rule. This name is used as variable prefix,
385 # and the targets generated are listed in a variable by that name.
386 #
387 # Remaining parameters are named arguments. These include:
388 # NAME The base name for the resulting binary, excluding decorations (like *.exe)
389 # TYPE Type of binary (EXECUTABLE, LIBRARY or STATIC_LIBRARY). Default is LIBRARY.
390 # SUFFIX Override the default suffix for the output file
391 # TOOLCHAIN Name of toolchain setup to use. Defaults to TOOLCHAIN_DEFAULT.
392 # SRC one or more directory roots to scan for C/C++ files.
393 # CFLAGS the compiler flags to be used, used both for C and C++.
394 # CXXFLAGS the compiler flags to be used for c++, if set overrides CFLAGS.
395 # LDFLAGS the linker flags to be used, used both for C and C++.
396 # LIBS the libraries to link to
397 # ARFLAGS the archiver flags to be used
398 # OBJECT_DIR the directory where we store the object files
399 # OUTPUT_DIR the directory where the resulting binary is put
400 # SYMBOLS_DIR the directory where the debug symbols are put, defaults to OUTPUT_DIR
401 # INCLUDES only pick source from these directories
402 # EXCLUDES do not pick source from these directories
403 # INCLUDE_FILES only compile exactly these files!
404 # EXCLUDE_FILES with these names
405 # EXCLUDE_PATTERN exclude files matching any of these substrings
406 # EXTRA_FILES List of extra files not in any of the SRC dirs
407 # EXTRA_OBJECT_FILES List of extra object files to include when linking
408 # EXTRA_DEPS List of extra dependencies to be added to each compiled file
409 # VERSIONINFO_RESOURCE Input file for RC. Setting this implies that RC will be run
410 # RC_FLAGS flags for RC.
411 # EMBED_MANIFEST if true, embed manifest on Windows.
412 # MAPFILE mapfile
413 # REORDER reorder file
414 # USE_MAPFILE_FOR_SYMBOLS if true and this is a STATIC_BUILD, just copy the
415 # mapfile for the output symbols file
416 # CC the compiler to use, default is $(CC)
417 # LD the linker to use, default is $(LD)
418 # OPTIMIZATION sets optimization level to NONE, LOW, HIGH, HIGHEST, HIGHEST_JVM, SIZE
419 # DISABLED_WARNINGS_<toolchain> Disable the given warnings for the specified toolchain
420 # DISABLED_WARNINGS_C_<toolchain> Disable the given warnings for the specified toolchain
421 # when compiling C code
422 # DISABLED_WARNINGS_CXX_<toolchain> Disable the given warnings for the specified
423 # toolchain when compiling C++ code
424 # STRIP_SYMBOLS Set to false to override global strip policy and always leave
425 # symbols in the binary, if the toolchain allows for it
426 # DEBUG_SYMBOLS Set to false to disable generation of debug symbols
427 # COPY_DEBUG_SYMBOLS Set to false to override global setting of debug symbol copying
428 # ZIP_EXTERNAL_DEBUG_SYMBOLS Set to false to override global setting of debug symbol
429 # zipping
430 # STRIPFLAGS Optionally change the flags given to the strip command
431 # PRECOMPILED_HEADER Header file to use as precompiled header
432 # PRECOMPILED_HEADER_EXCLUDE List of source files that should not use PCH
433 # DEFINE_THIS_FILE Set to false to not set the THIS_FILE preprocessor macro
434 #
435 # After being called, some variables are exported from this macro, all prefixed
436 # with parameter 1 followed by a '_':
437 # TARGET The library or executable created by the macro
438 # TARGET_DEPS All prerequisites for the target calculated by the macro
439 # ALL_OBJS All object files
440 # IMPORT_LIBRARY The import library created for a shared library on Windows
441 SetupNativeCompilation = $(NamedParamsMacroTemplate)
442 define SetupNativeCompilationBody
443
444 # If type is unspecified, default to LIBRARY
445 ifeq ($$($1_TYPE), )
446 $1_TYPE := LIBRARY
447 endif
448
449 # If we're doing a static build and producing a library
450 # force it to be a static library and remove the -l libraries
451 ifeq ($(STATIC_BUILD), true)
452 ifeq ($$($1_TYPE), LIBRARY)
453 $1_TYPE := STATIC_LIBRARY
454 endif
455 endif
456
457 $$(call SetIfEmpty, $1_COMPILE_WITH_DEBUG_SYMBOLS, $$(COMPILE_WITH_DEBUG_SYMBOLS))
458
459 # STATIC_LIBS is set from Main.gmk when building static versions of certain
460 # native libraries.
461 ifeq ($(STATIC_LIBS), true)
462 $1_TYPE := STATIC_LIBRARY
463 # The static versions need to be redirected to different output dirs, both
464 # to not interfere with the main build as well as to not end up inside the
465 # jmods.
466 $1_OBJECT_DIR := $$($1_OBJECT_DIR)/static
467 $1_OUTPUT_DIR := $$($1_OBJECT_DIR)
468 # For release builds where debug symbols are configured to be moved to
469 # separate debuginfo files, disable debug symbols for static libs instead.
470 # We don't currently support this configuration and we don't want symbol
471 # information in release builds unless explicitly asked to provide it.
472 ifeq ($(DEBUG_LEVEL), release)
473 ifeq ($(COPY_DEBUG_SYMBOLS), true)
474 $1_COMPILE_WITH_DEBUG_SYMBOLS := false
475 endif
476 endif
477 endif
478
479 ifeq ($$($1_TYPE), EXECUTABLE)
480 $1_PREFIX :=
481 ifeq ($$($1_SUFFIX), )
482 $1_SUFFIX := $(EXE_SUFFIX)
483 endif
484 else
485 $1_PREFIX := $(LIBRARY_PREFIX)
486 ifeq ($$($1_TYPE), LIBRARY)
487 ifeq ($$($1_SUFFIX), )
488 $1_SUFFIX := $(SHARED_LIBRARY_SUFFIX)
489 endif
490 else ifeq ($$($1_TYPE), STATIC_LIBRARY)
491 ifeq ($$($1_SUFFIX), )
492 $1_SUFFIX := $(STATIC_LIBRARY_SUFFIX)
493 endif
494 endif
495 endif
496
497 ifneq ($$($1_NAME), $(basename $$($1_NAME)))
498 $$(error NAME must not contain any directory path in $1)
499 endif
500 ifneq ($(findstring $$($1_SUFFIX), $$($1_NAME)), )
501 $$(error NAME should be specified without suffix: $$($1_SUFFIX) in $1)
502 endif
503 ifneq ($(findstring $$($1_PREFIX), $$($1_NAME)), )
504 $$(error NAME should be specified without prefix: $$($1_PREFIX) in $1)
505 endif
506 ifeq ($$($1_OUTPUT_DIR), )
507 $$(error OUTPUT_DIR is missing in $1)
508 endif
509 ifneq ($$($1_MANIFEST), )
510 ifeq ($$($1_MANIFEST_VERSION), )
511 $$(error If MANIFEST is provided, then MANIFEST_VERSION is required in $1)
512 endif
513 endif
514
515 $1_BASENAME := $$($1_PREFIX)$$($1_NAME)$$($1_SUFFIX)
516 $1_TARGET := $$($1_OUTPUT_DIR)/$$($1_BASENAME)
517 $1_NOSUFFIX := $$($1_PREFIX)$$($1_NAME)
518 $1_SAFE_NAME := $$(strip $$(subst /,_, $1))
519
520 # Need to make sure TARGET is first on list
521 $1 := $$($1_TARGET)
522
523 # Setup the toolchain to be used
524 $$(call SetIfEmpty, $1_TOOLCHAIN, TOOLCHAIN_DEFAULT)
525 $$(call SetIfEmpty, $1_CC, $$($$($1_TOOLCHAIN)_CC))
526 $$(call SetIfEmpty, $1_CXX, $$($$($1_TOOLCHAIN)_CXX))
527 $$(call SetIfEmpty, $1_LD, $$($$($1_TOOLCHAIN)_LD))
528 $$(call SetIfEmpty, $1_AR, $$($$($1_TOOLCHAIN)_AR))
529 $$(call SetIfEmpty, $1_AS, $$($$($1_TOOLCHAIN)_AS))
530 $$(call SetIfEmpty, $1_MT, $$($$($1_TOOLCHAIN)_MT))
531 $$(call SetIfEmpty, $1_RC, $$($$($1_TOOLCHAIN)_RC))
532 $$(call SetIfEmpty, $1_OBJCOPY, $$($$($1_TOOLCHAIN)_OBJCOPY))
533 $$(call SetIfEmpty, $1_STRIP, $$($$($1_TOOLCHAIN)_STRIP))
534 $$(call SetIfEmpty, $1_SYSROOT_CFLAGS, $$($$($1_TOOLCHAIN)_SYSROOT_CFLAGS))
535 $$(call SetIfEmpty, $1_SYSROOT_LDFLAGS, $$($$($1_TOOLCHAIN)_SYSROOT_LDFLAGS))
536
537 $$(foreach d, $$($1_SRC), $$(if $$(wildcard $$d), , \
538 $$(error SRC specified to SetupNativeCompilation $1 contains missing directory $$d)))
539
540 $1_SRCS_RAW := $$(call FindFiles, $$($1_SRC))
541 # Order src files according to the order of the src dirs
542 $1_SRCS := $$(foreach d, $$($1_SRC), $$(filter $$d%, $$($1_SRCS_RAW)))
543 $1_SRCS := $$(filter $$(NATIVE_SOURCE_EXTENSIONS), $$($1_SRCS))
544 # Extract the C/C++ files.
545 ifneq ($$($1_EXCLUDE_PATTERNS), )
546 # We must not match the exclude pattern against the src root(s).
547 $1_SRCS_WITHOUT_ROOTS := $$($1_SRCS)
548 $$(foreach i, $$($1_SRC), $$(eval $1_SRCS_WITHOUT_ROOTS := $$(patsubst \
549 $$i/%,%, $$($1_SRCS_WITHOUT_ROOTS))))
550 $1_ALL_EXCLUDE_FILES := $$(call containing, $$($1_EXCLUDE_PATTERNS), \
551 $$($1_SRCS_WITHOUT_ROOTS))
552 endif
553 ifneq ($$($1_EXCLUDE_FILES), )
554 $1_ALL_EXCLUDE_FILES += $$($1_EXCLUDE_FILES)
555 endif
556 ifneq ($$($1_ALL_EXCLUDE_FILES), )
557 $1_EXCLUDE_FILES_PAT := $$($1_ALL_EXCLUDE_FILES) \
558 $$(foreach i, $$($1_SRC), $$(addprefix $$i/, $$($1_ALL_EXCLUDE_FILES)))
559 $1_EXCLUDE_FILES_PAT := $$(addprefix %, $$($1_EXCLUDE_FILES_PAT))
560 $1_SRCS := $$(filter-out $$($1_EXCLUDE_FILES_PAT), $$($1_SRCS))
561 endif
562 ifneq ($$($1_INCLUDE_FILES), )
563 $1_INCLUDE_FILES_PAT := $$(foreach i, $$($1_SRC), $$(addprefix $$i/, $$($1_INCLUDE_FILES)))
564 $1_SRCS := $$(filter $$($1_INCLUDE_FILES_PAT), $$($1_SRCS))
565 endif
566 # There can be only a single bin dir root, no need to foreach over the roots.
567 $1_BINS := $$(wildcard $$($1_OBJECT_DIR)/*$(OBJ_SUFFIX))
568 # Now we have a list of all c/c++ files to compile: $$($1_SRCS)
569 # and we have a list of all existing object files: $$($1_BINS)
570
571 # Prepend the source/bin path to the filter expressions. Then do the filtering.
572 ifneq ($$($1_INCLUDES), )
573 $1_SRC_INCLUDES := $$(foreach i, $$($1_SRC), $$(addprefix $$i/, $$(addsuffix /%, $$($1_INCLUDES))))
574 $1_SRCS := $$(filter $$($1_SRC_INCLUDES), $$($1_SRCS))
575 endif
576 ifneq ($$($1_EXCLUDES), )
577 $1_SRC_EXCLUDES := $$(addsuffix /%, $$($1_EXCLUDES))
578 $1_SRC_EXCLUDES += $$(foreach i, $$($1_SRC), $$(addprefix $$i/, $$(addsuffix /%, $$($1_EXCLUDES))))
579 $1_SRCS := $$(filter-out $$($1_SRC_EXCLUDES), $$($1_SRCS))
580 endif
581
582 $1_SRCS += $$($1_EXTRA_FILES)
583
584 ifeq ($$($1_SRCS), )
585 $$(error No sources found for $1 when looking inside the dirs $$($1_SRC))
586 endif
587
588 # Calculate the expected output from compiling the sources
589 $1_EXPECTED_OBJS_FILENAMES := $$(call replace_with_obj_extension, $$(notdir $$($1_SRCS)))
590 $1_EXPECTED_OBJS := $$(addprefix $$($1_OBJECT_DIR)/, $$($1_EXPECTED_OBJS_FILENAMES))
591 # Are there too many object files on disk? Perhaps because some source file was removed?
592 $1_SUPERFLOUS_OBJS := $$(sort $$(filter-out $$($1_EXPECTED_OBJS), $$($1_BINS)))
593 # Clean out the superfluous object files.
594 ifneq ($$($1_SUPERFLUOUS_OBJS), )
595 $$(shell $(RM) -f $$($1_SUPERFLUOUS_OBJS))
596 endif
597 # Sort to remove dupliates and provide a reproducable order on the input files to the linker.
598 $1_ALL_OBJS := $$(sort $$($1_EXPECTED_OBJS) $$($1_EXTRA_OBJECT_FILES))
599
600 # Pickup extra OPENJDK_TARGET_OS_TYPE, OPENJDK_TARGET_OS, and/or OPENJDK_TARGET_OS plus
601 # OPENJDK_TARGET_CPU pair dependent variables for CFLAGS.
602 $1_EXTRA_CFLAGS := $$($1_CFLAGS_$(OPENJDK_TARGET_OS_TYPE)) $$($1_CFLAGS_$(OPENJDK_TARGET_OS)) \
603 $$($1_CFLAGS_$(OPENJDK_TARGET_OS)_$(OPENJDK_TARGET_CPU))
604 ifneq ($(DEBUG_LEVEL), release)
605 # Pickup extra debug dependent variables for CFLAGS
606 $1_EXTRA_CFLAGS += $$($1_CFLAGS_debug)
607 $1_EXTRA_CFLAGS += $$($1_CFLAGS_$(OPENJDK_TARGET_OS_TYPE)_debug)
608 $1_EXTRA_CFLAGS += $$($1_CFLAGS_$(OPENJDK_TARGET_OS)_debug)
609 $1_EXTRA_CFLAGS += $$($1_CFLAGS_$(OPENJDK_TARGET_OS)_$(OPENJDK_TARGET_CPU)_debug)
610 else
611 $1_EXTRA_CFLAGS += $$($1_CFLAGS_release)
612 $1_EXTRA_CFLAGS += $$($1_CFLAGS_$(OPENJDK_TARGET_OS_TYPE)_release)
613 $1_EXTRA_CFLAGS += $$($1_CFLAGS_$(OPENJDK_TARGET_OS)_release)
614 $1_EXTRA_CFLAGS += $$($1_CFLAGS_$(OPENJDK_TARGET_OS)_$(OPENJDK_TARGET_CPU)_release)
615 endif
616 ifeq ($(STATIC_LIBS), true)
617 $1_EXTRA_CFLAGS += $$(STATIC_LIBS_CFLAGS)
618 endif
619
620 # Pickup extra OPENJDK_TARGET_OS_TYPE and/or OPENJDK_TARGET_OS dependent variables for CXXFLAGS.
621 $1_EXTRA_CXXFLAGS := $$($1_CXXFLAGS_$(OPENJDK_TARGET_OS_TYPE)) $$($1_CXXFLAGS_$(OPENJDK_TARGET_OS))
622 ifneq ($(DEBUG_LEVEL), release)
623 # Pickup extra debug dependent variables for CXXFLAGS
624 $1_EXTRA_CXXFLAGS += $$($1_CXXFLAGS_debug)
625 $1_EXTRA_CXXFLAGS += $$($1_CXXFLAGS_$(OPENJDK_TARGET_OS_TYPE)_debug)
626 $1_EXTRA_CXXFLAGS += $$($1_CXXFLAGS_$(OPENJDK_TARGET_OS)_debug)
627 else
628 $1_EXTRA_CXXFLAGS += $$($1_CXXFLAGS_release)
629 $1_EXTRA_CXXFLAGS += $$($1_CXXFLAGS_$(OPENJDK_TARGET_OS_TYPE)_release)
630 $1_EXTRA_CXXFLAGS += $$($1_CXXFLAGS_$(OPENJDK_TARGET_OS)_release)
631 endif
632 ifeq ($(STATIC_LIBS), true)
633 $1_EXTRA_CXXFLAGS += $$(STATIC_LIB_CFLAGS)
634 endif
635
636 # If no C++ flags are explicitly set, default to using the C flags.
637 # After that, we can set additional C++ flags that should not interfere
638 # with the mechanism for copying the C flags by default.
639 ifeq ($$($1_CXXFLAGS), )
640 $1_CXXFLAGS := $$($1_CFLAGS)
641 endif
642 ifeq ($$(strip $$($1_EXTRA_CXXFLAGS)), )
643 $1_EXTRA_CXXFLAGS := $$($1_EXTRA_CFLAGS)
644 endif
645
646 ifeq ($$($1_COMPILE_WITH_DEBUG_SYMBOLS), true)
647 $1_EXTRA_CFLAGS += $$(CFLAGS_DEBUG_SYMBOLS)
648 $1_EXTRA_CXXFLAGS += $$(CFLAGS_DEBUG_SYMBOLS)
649 $1_EXTRA_ASFLAGS += $$(ASFLAGS_DEBUG_SYMBOLS)
650 endif
651
652 ifneq ($$($1_REORDER), )
653 $1_EXTRA_CFLAGS += $$(C_FLAG_REORDER)
654 $1_EXTRA_CXXFLAGS += $$(C_FLAG_REORDER)
655 endif
656
657 # Pass the library name for static JNI library naming
658 ifeq ($$($1_TYPE), STATIC_LIBRARY)
659 $1_EXTRA_CFLAGS += -DLIBRARY_NAME=$$($1_NAME)
660 $1_EXTRA_CXXFLAGS += -DLIBRARY_NAME=$$($1_NAME)
661 endif
662
663 # Pick up disabled warnings, if possible on this platform.
664 ifneq ($(DISABLE_WARNING_PREFIX), )
665 $1_EXTRA_CFLAGS += $$(addprefix $(DISABLE_WARNING_PREFIX), \
666 $$(DISABLED_WARNINGS) \
667 $$(DISABLED_WARNINGS_C) \
668 $$($1_DISABLED_WARNINGS_$(TOOLCHAIN_TYPE)) \
669 $$($1_DISABLED_WARNINGS_C_$(TOOLCHAIN_TYPE)))
670 $1_EXTRA_CXXFLAGS += $$(addprefix $(DISABLE_WARNING_PREFIX), \
671 $$(DISABLED_WARNINGS) \
672 $$(DISABLED_WARNINGS_CXX) \
673 $$($1_DISABLED_WARNINGS_$(TOOLCHAIN_TYPE)) \
674 $$($1_DISABLED_WARNINGS_CXX_$(TOOLCHAIN_TYPE)))
675 endif
676
677 # Check if warnings should be considered errors.
678 # Pick first binary and toolchain specific, then binary specific, then general setting.
679 ifeq ($$($1_WARNINGS_AS_ERRORS_$(TOOLCHAIN_TYPE)), )
680 ifeq ($$($1_WARNINGS_AS_ERRORS), )
681 $1_WARNINGS_AS_ERRORS_$(TOOLCHAIN_TYPE) := $$(WARNINGS_AS_ERRORS)
682 else
683 $1_WARNINGS_AS_ERRORS_$(TOOLCHAIN_TYPE) := $$($1_WARNINGS_AS_ERRORS)
684 endif
685 endif
686
687 ifeq ($$($1_WARNINGS_AS_ERRORS_$(TOOLCHAIN_TYPE)), true)
688 $1_EXTRA_CFLAGS += $(CFLAGS_WARNINGS_ARE_ERRORS)
689 $1_EXTRA_CXXFLAGS += $(CFLAGS_WARNINGS_ARE_ERRORS)
690 $1_EXTRA_LDFLAGS += $(LDFLAGS_WARNINGS_ARE_ERRORS)
691 endif
692
693 ifeq (NONE, $$($1_OPTIMIZATION))
694 $1_OPT_CFLAGS := $(C_O_FLAG_NONE)
695 $1_OPT_CXXFLAGS := $(CXX_O_FLAG_NONE)
696 else ifeq (LOW, $$($1_OPTIMIZATION))
697 $1_OPT_CFLAGS := $(C_O_FLAG_NORM)
698 $1_OPT_CXXFLAGS := $(CXX_O_FLAG_NORM)
699 else ifeq (HIGH, $$($1_OPTIMIZATION))
700 $1_OPT_CFLAGS := $(C_O_FLAG_HI)
701 $1_OPT_CXXFLAGS := $(CXX_O_FLAG_HI)
702 else ifeq (HIGHEST, $$($1_OPTIMIZATION))
703 $1_OPT_CFLAGS := $(C_O_FLAG_HIGHEST)
704 $1_OPT_CXXFLAGS := $(CXX_O_FLAG_HIGHEST)
705 else ifeq (HIGHEST_JVM, $$($1_OPTIMIZATION))
706 $1_OPT_CFLAGS := $(C_O_FLAG_HIGHEST_JVM)
707 $1_OPT_CXXFLAGS := $(CXX_O_FLAG_HIGHEST_JVM)
708 else ifeq (SIZE, $$($1_OPTIMIZATION))
709 $1_OPT_CFLAGS := $(C_O_FLAG_SIZE)
710 $1_OPT_CXXFLAGS := $(CXX_O_FLAG_SIZE)
711 else ifneq (, $$($1_OPTIMIZATION))
712 $$(error Unknown value for OPTIMIZATION: $$($1_OPTIMIZATION))
713 endif
714
715 $1_BUILD_INFO := $$($1_OBJECT_DIR)/_build-info.marker
716
717 # Track variable changes for all variables that affect the compilation command
718 # lines for all object files in this setup. This includes at least all the
719 # variables used in the call to add_native_source below.
720 $1_COMPILE_VARDEPS := $$($1_CFLAGS) $$($1_EXTRA_CFLAGS) $$($1_SYSROOT_CFLAGS) \
721 $$($1_CXXFLAGS) $$($1_EXTRA_CXXFLAGS) $$($1_OPT_CFLAGS) $$($1_OPT_CXXFLAGS) \
722 $$($1_CC) $$($1_CXX) $$($1_AS) $$($1_ASFLAGS)
723 $1_COMPILE_VARDEPS_FILE := $$(call DependOnVariable, $1_COMPILE_VARDEPS, \
724 $$($1_OBJECT_DIR)/$$($1_NOSUFFIX).comp.vardeps)
725
726 ifneq ($$($1_PRECOMPILED_HEADER), )
727 ifeq ($(USE_PRECOMPILED_HEADER), true)
728 ifeq ($(TOOLCHAIN_TYPE), microsoft)
729 $1_PCH_FILE := $$($1_OBJECT_DIR)/$1.pch
730 $1_GENERATED_PCH_SRC := $$($1_OBJECT_DIR)/$1_pch.cpp
731 $1_GENERATED_PCH_OBJ := $$($1_OBJECT_DIR)/$1_pch.obj
732
733 $$(eval $$(call SetupCompileNativeFile, $1_$$(notdir $$($1_GENERATED_PCH_SRC)), \
734 FILE := $$($1_GENERATED_PCH_SRC), \
735 BASE := $1, \
736 EXTRA_CXXFLAGS := -Fp$$($1_PCH_FILE) -Yc$$(notdir $$($1_PRECOMPILED_HEADER)), \
737 DEFINE_THIS_FILE := false, \
738 ))
739
740 $1_USE_PCH_FLAGS := \
741 -Fp$$($1_PCH_FILE) -Yu$$(notdir $$($1_PRECOMPILED_HEADER))
742
743 $$($1_ALL_OBJS): $$($1_GENERATED_PCH_OBJ)
744
745 # Explicitly add the pch obj file first to ease comparing to old
746 # hotspot build.
747 $1_ALL_OBJS := $$($1_GENERATED_PCH_OBJ) $$($1_ALL_OBJS)
748
749 $$($1_GENERATED_PCH_SRC):
750 $(ECHO) "#include \"$$(notdir $$($1_PRECOMPILED_HEADER))\"" > $$@
751
752 else ifneq ($(findstring $(TOOLCHAIN_TYPE), gcc clang), )
753 ifeq ($(TOOLCHAIN_TYPE), gcc)
754 $1_PCH_FILE := $$($1_OBJECT_DIR)/precompiled/$$(notdir $$($1_PRECOMPILED_HEADER)).gch
755 $1_USE_PCH_FLAGS := -I$$($1_OBJECT_DIR)/precompiled
756 else ifeq ($(TOOLCHAIN_TYPE), clang)
757 $1_PCH_FILE := $$($1_OBJECT_DIR)/precompiled/$$(notdir $$($1_PRECOMPILED_HEADER)).pch
758 $1_USE_PCH_FLAGS := -include-pch $$($1_PCH_FILE)
759 endif
760 $1_PCH_DEPS_FILE := $$($1_PCH_FILE).d
761 $1_PCH_DEPS_TARGETS_FILE := $$($1_PCH_FILE).d.targets
762
763 -include $$($1_PCH_DEPS_FILE)
764 -include $$($1_PCH_DEPS_TARGETS_FILE)
765
766 $1_PCH_COMMAND := $$($1_CC) $$($1_CFLAGS) $$($1_EXTRA_CFLAGS) $$($1_SYSROOT_CFLAGS) \
767 $$($1_OPT_CFLAGS) -x c++-header -c $(C_FLAG_DEPS) $$($1_PCH_DEPS_FILE)
768
769 $$($1_PCH_FILE): $$($1_PRECOMPILED_HEADER) $$($1_COMPILE_VARDEPS_FILE)
770 $$(call LogInfo, Generating precompiled header)
771 $$(call MakeDir, $$(@D))
772 $$(call ExecuteWithLog, $$@, $$($1_PCH_COMMAND) $$< -o $$@)
773 $(SED) $(DEPENDENCY_TARGET_SED_PATTERN) $$($1_PCH_DEPS_FILE) \
774 > $$($1_PCH_DEPS_TARGETS_FILE)
775
776 $$($1_ALL_OBJS): $$($1_PCH_FILE)
777
778 # Generate the corresponding compile_commands.json fragment.
779 $1_PCH_FILE_JSON := $$(MAKESUPPORT_OUTPUTDIR)/compile-commands/$$(subst /,_,$$(subst \
780 $$(OUTPUTDIR)/,,$$($1_PCH_FILE))).json
781 $1_ALL_OBJS_JSON += $$($1_PCH_FILE_JSON)
782
783 $$($1_PCH_FILE_JSON): $$($1_PRECOMPILED_HEADER) $$($1_COMPILE_VARDEPS_FILE)
784 $$(call WriteCompileCommandsFragment, $$@, $$(PWD), $$<, \
785 $$($1_PCH_COMMAND) $$< -o $$($1_PCH_FILE))
786 endif
787 endif
788 endif
789
790 # Now call SetupCompileNativeFile for each source file we are going to compile.
791 $$(foreach file, $$($1_SRCS), \
792 $$(eval $$(call SetupCompileNativeFile, $1_$$(notdir $$(file)),\
793 FILE := $$(file), \
794 BASE := $1, \
795 )) \
796 )
797
798 # Setup rule for printing progress info when compiling source files.
799 # This is a rough heuristic and may not always print accurate information.
800 $$($1_BUILD_INFO): $$($1_SRCS) $$($1_COMPILE_VARDEPS_FILE)
801 ifeq ($$(wildcard $$($1_TARGET)), )
802 $$(call LogWarn, Creating $$(subst $$(OUTPUTDIR)/,,$$($1_TARGET)) from $$(words \
803 $$(filter-out %.vardeps, $$?)) file(s))
804 else
805 $$(call LogWarn, $$(strip Updating $$(subst $$(OUTPUTDIR)/,,$$($1_TARGET)) \
806 $$(if $$(filter-out %.vardeps, $$?), \
807 due to $$(words $$(filter-out %.vardeps, $$?)) file(s), \
808 $$(if $$(filter %.vardeps, $$?), due to makefile changes))))
809 endif
810 $(TOUCH) $$@
811
812 # On windows we need to create a resource file
813 ifeq ($(call isTargetOs, windows), true)
814 ifneq ($$($1_VERSIONINFO_RESOURCE), )
815 $1_RES := $$($1_OBJECT_DIR)/$$($1_BASENAME).res
816 $1_RES_DEPS_FILE := $$($1_RES).d
817 $1_RES_DEPS_TARGETS_FILE := $$($1_RES).d.targets
818 -include $$($1_RES_DEPS_FILE)
819 -include $$($1_RES_DEPS_TARGETS_FILE)
820
821 $1_RES_VARDEPS := $$($1_RC) $$($1_RC_FLAGS)
822 $1_RES_VARDEPS_FILE := $$(call DependOnVariable, $1_RES_VARDEPS, \
823 $$($1_RES).vardeps)
824
825 $$($1_RES): $$($1_VERSIONINFO_RESOURCE) $$($1_RES_VARDEPS_FILE)
826 $$(call LogInfo, Compiling resource $$(notdir $$($1_VERSIONINFO_RESOURCE)) (for $$($1_BASENAME)))
827 $$(call MakeDir, $$(@D) $$($1_OBJECT_DIR))
828 $$(call ExecuteWithLog, $$@, \
829 $$($1_RC) $$($1_RC_FLAGS) $$($1_SYSROOT_CFLAGS) $(CC_OUT_OPTION)$$@ \
830 $$($1_VERSIONINFO_RESOURCE) 2>&1 )
831 # Windows RC compiler does not support -showIncludes, so we mis-use CL
832 # for this. Filter out RC specific arguments that are unknown to CL.
833 # For some unknown reason, in this case CL actually outputs the show
834 # includes to stderr so need to redirect it to hide the output from the
835 # main log.
836 $$(call ExecuteWithLog, $$($1_RES_DEPS_FILE).obj, \
837 $$($1_CC) $$(filter-out -l%, $$($1_RC_FLAGS)) \
838 $$($1_SYSROOT_CFLAGS) -showIncludes -nologo -TC \
839 $(CC_OUT_OPTION)$$($1_RES_DEPS_FILE).obj -P -Fi$$($1_RES_DEPS_FILE).pp \
840 $$($1_VERSIONINFO_RESOURCE)) 2>&1 \
841 | $(TR) -d '\r' | $(GREP) -v -e "^Note: including file:" \
842 -e "^$$(notdir $$($1_VERSIONINFO_RESOURCE))$$$$" || test "$$$$?" = "1" ; \
843 $(ECHO) $$($1_RES): \\ > $$($1_RES_DEPS_FILE) ; \
844 $(SED) $(WINDOWS_SHOWINCLUDE_SED_PATTERN) $$($1_RES_DEPS_FILE).obj.log \
845 >> $$($1_RES_DEPS_FILE) ; \
846 $(ECHO) >> $$($1_RES_DEPS_FILE) ;\
847 $(SED) $(DEPENDENCY_TARGET_SED_PATTERN) $$($1_RES_DEPS_FILE) \
848 > $$($1_RES_DEPS_TARGETS_FILE)
849 endif
850 endif
851
852 # Create a rule to collect all the individual make dependency files into a
853 # single makefile.
854 $1_DEPS_FILE := $$($1_OBJECT_DIR)/$1.d
855
856 $$($1_DEPS_FILE): $$($1_ALL_OBJS) $$($1_RES)
857 $(RM) $$@
858 # CD into dir to reduce risk of hitting command length limits, which
859 # could otherwise happen if TOPDIR is a very long path.
860 $(CD) $$($1_OBJECT_DIR) && $(CAT) *.d > $$@.tmp
861 $(CD) $$($1_OBJECT_DIR) && $(CAT) *.d.targets | $(SORT) -u >> $$@.tmp
862 # After generating the file, which happens after all objects have been
863 # compiled, copy it to .old extension. On the next make invocation, this
864 # .old file will be included by make.
865 $(CP) $$@.tmp $$@.old
866 $(MV) $$@.tmp $$@
867
868 $1 += $$($1_DEPS_FILE)
869
870 # The include must be on the .old file, which represents the state from the
871 # previous invocation of make. The file being included must not have a rule
872 # defined for it as otherwise make will think it has to run the rule before
873 # being able to include the file, which would be wrong since we specifically
874 # need the file as it was generated by a previous make invocation.
875 ifneq ($$(wildcard $$($1_DEPS_FILE).old), )
876 $1_DEPS_FILE_LOADED := true
877 -include $$($1_DEPS_FILE).old
878 endif
879
880 ifneq ($(DISABLE_MAPFILES), true)
881 $1_REAL_MAPFILE := $$($1_MAPFILE)
882 ifeq ($(call isTargetOs, windows), false)
883 ifneq ($$($1_REORDER), )
884 $1_REAL_MAPFILE := $$($1_OBJECT_DIR)/mapfile
885
886 $$($1_REAL_MAPFILE) : $$($1_MAPFILE) $$($1_REORDER)
887 $$(call MakeDir, $$(@D))
888 $$(CP) $$($1_MAPFILE) $$@.tmp
889 $$(SED) -e 's=OUTPUTDIR=$$($1_OBJECT_DIR)=' $$($1_REORDER) >> $$@.tmp
890 $$(MV) $$@.tmp $$@
891 endif
892 endif
893 endif
894
895 # Pickup extra OPENJDK_TARGET_OS_TYPE and/or OPENJDK_TARGET_OS dependent variables
896 # for LDFLAGS and LIBS
897 $1_EXTRA_LDFLAGS += $$($1_LDFLAGS_$(OPENJDK_TARGET_OS_TYPE)) $$($1_LDFLAGS_$(OPENJDK_TARGET_OS))
898 $1_EXTRA_LIBS += $$($1_LIBS_$(OPENJDK_TARGET_OS_TYPE)) $$($1_LIBS_$(OPENJDK_TARGET_OS))
899 ifneq ($$($1_REAL_MAPFILE), )
900 $1_EXTRA_LDFLAGS += $(call SET_SHARED_LIBRARY_MAPFILE,$$($1_REAL_MAPFILE))
901 endif
902
903 ifneq ($$($1_COPY_DEBUG_SYMBOLS), false)
904 $1_COPY_DEBUG_SYMBOLS := $(COPY_DEBUG_SYMBOLS)
905 endif
906
907 ifneq ($$($1_ZIP_EXTERNAL_DEBUG_SYMBOLS), false)
908 $1_ZIP_EXTERNAL_DEBUG_SYMBOLS := $(ZIP_EXTERNAL_DEBUG_SYMBOLS)
909 endif
910
911 ifeq ($$($1_COPY_DEBUG_SYMBOLS), true)
912 ifneq ($$($1_DEBUG_SYMBOLS), false)
913 $$(call SetIfEmpty, $1_SYMBOLS_DIR, $$($1_OUTPUT_DIR))
914 # Only copy debug symbols for dynamic libraries and programs.
915 ifneq ($$($1_TYPE), STATIC_LIBRARY)
916 # Generate debuginfo files.
917 ifeq ($(call isTargetOs, windows), true)
918 $1_EXTRA_LDFLAGS += -debug "-pdb:$$($1_SYMBOLS_DIR)/$$($1_NOSUFFIX).pdb" "-pdbstripped:$$($1_SYMBOLS_DIR)/$$($1_NOSUFFIX).stripped.pdb" \
919 "-map:$$($1_SYMBOLS_DIR)/$$($1_NOSUFFIX).map"
920 $1_DEBUGINFO_FILES := $$($1_SYMBOLS_DIR)/$$($1_NOSUFFIX).pdb \
921 $$($1_SYMBOLS_DIR)/$$($1_NOSUFFIX).map
922
923 else ifeq ($(call isTargetOs, linux solaris), true)
924 $1_DEBUGINFO_FILES := $$($1_SYMBOLS_DIR)/$$($1_NOSUFFIX).debuginfo
925 # Setup the command line creating debuginfo files, to be run after linking.
926 # It cannot be run separately since it updates the original target file
927 $1_CREATE_DEBUGINFO_CMDS := \
928 $$($1_OBJCOPY) --only-keep-debug $$($1_TARGET) $$($1_DEBUGINFO_FILES) $$(NEWLINE) \
929 $(CD) $$($1_SYMBOLS_DIR) && \
930 $$($1_OBJCOPY) --add-gnu-debuglink=$$($1_DEBUGINFO_FILES) $$($1_TARGET)
931
932 else ifeq ($(call isTargetOs, macosx), true)
933 $1_DEBUGINFO_FILES := \
934 $$($1_SYMBOLS_DIR)/$$($1_BASENAME).dSYM/Contents/Info.plist \
935 $$($1_SYMBOLS_DIR)/$$($1_BASENAME).dSYM/Contents/Resources/DWARF/$$($1_BASENAME)
936 $1_CREATE_DEBUGINFO_CMDS := \
937 $(DSYMUTIL) --out $$($1_SYMBOLS_DIR)/$$($1_BASENAME).dSYM $$($1_TARGET)
938 endif
939
940 # Since the link rule creates more than one file that we want to track,
941 # we have to use some tricks to get make to cooperate. To properly
942 # trigger downstream dependants of $$($1_DEBUGINFO_FILES), we must have
943 # a recipe in the rule below. To avoid rerunning the recipe every time
944 # have it touch the target. If a debuginfo file is deleted by something
945 # external, explicitly delete the TARGET to trigger a rebuild of both.
946 ifneq ($$(wildcard $$($1_DEBUGINFO_FILES)), $$($1_DEBUGINFO_FILES))
947 $$(call LogDebug, Deleting $$($1_BASENAME) because debuginfo files are missing)
948 $$(shell $(RM) $$($1_TARGET))
949 endif
950 $$($1_DEBUGINFO_FILES): $$($1_TARGET)
951 $$(if $$(CORRECT_FUNCTION_IN_RECIPE_EVALUATION), \
952 $$(if $$(wildcard $$@), , $$(error $$@ was not created for $$<)) \
953 )
954 $(TOUCH) $$@
955
956 $1 += $$($1_DEBUGINFO_FILES)
957
958 ifeq ($$($1_ZIP_EXTERNAL_DEBUG_SYMBOLS), true)
959 $1_DEBUGINFO_ZIP := $$($1_SYMBOLS_DIR)/$$($1_NOSUFFIX).diz
960 $1 += $$($1_DEBUGINFO_ZIP)
961
962 # The dependency on TARGET is needed for debuginfo files
963 # to be rebuilt properly.
964 $$($1_DEBUGINFO_ZIP): $$($1_DEBUGINFO_FILES) $$($1_TARGET)
965 $(CD) $$($1_SYMBOLS_DIR) && \
966 $(ZIPEXE) -q -r $$@ $$(subst $$($1_SYMBOLS_DIR)/,, $$($1_DEBUGINFO_FILES))
967
968 endif
969 endif # !STATIC_LIBRARY
970 endif # $1_DEBUG_SYMBOLS != false
971 endif # COPY_DEBUG_SYMBOLS
972
973 # Unless specifically set, stripping should only happen if symbols are also
974 # being copied.
975 $$(call SetIfEmpty, $1_STRIP_SYMBOLS, $$($1_COPY_DEBUG_SYMBOLS))
976
977 ifneq ($$($1_STRIP_SYMBOLS), false)
978 ifneq ($$($1_STRIP), )
979 # Default to using the global STRIPFLAGS. Allow for overriding with an empty value
980 $1_STRIPFLAGS ?= $(STRIPFLAGS)
981 $1_STRIP_CMD := $$($1_STRIP) $$($1_STRIPFLAGS) $$($1_TARGET)
982 endif
983 endif
984
985 ifeq ($$($1_TYPE), STATIC_LIBRARY)
986 $1_VARDEPS := $$($1_AR) $$($1_ARFLAGS) $$($1_LIBS) \
987 $$($1_EXTRA_LIBS)
988 $1_VARDEPS_FILE := $$(call DependOnVariable, $1_VARDEPS, \
989 $$($1_OBJECT_DIR)/$$($1_NOSUFFIX).vardeps)
990
991 # Generating a static library, ie object file archive.
992 ifeq ($(STATIC_BUILD), true)
993 ifeq ($$($1_USE_MAPFILE_FOR_SYMBOLS), true)
994 STATIC_MAPFILE_DEP := $$($1_MAPFILE)
995 endif
996 endif
997
998 $1_TARGET_DEPS := $$($1_ALL_OBJS) $$($1_RES) $$($1_VARDEPS_FILE) $$(STATIC_MAPFILE_DEP)
999
1000 $$($1_TARGET): $$($1_TARGET_DEPS)
1001 $$(call LogInfo, Building static library $$($1_BASENAME))
1002 $$(call MakeDir, $$($1_OUTPUT_DIR) $$($1_SYMBOLS_DIR))
1003 $$(call ExecuteWithLog, $$($1_OBJECT_DIR)/$$($1_SAFE_NAME)_link, \
1004 $$($1_AR) $$($1_ARFLAGS) $(AR_OUT_OPTION)$$($1_TARGET) $$($1_ALL_OBJS) \
1005 $$($1_RES))
1006 ifeq ($(STATIC_BUILD), true)
1007 ifeq ($$($1_USE_MAPFILE_FOR_SYMBOLS), true)
1008 $(CP) $$($1_MAPFILE) $$(@D)/$$(basename $$(@F)).symbols
1009 else
1010 $(GetSymbols)
1011 endif
1012 endif
1013 else
1014 # A shared dynamic library or an executable binary has been specified
1015 ifeq ($$($1_TYPE), LIBRARY)
1016 # Generating a dynamic library.
1017 $1_EXTRA_LDFLAGS += $$(call SET_SHARED_LIBRARY_NAME,$$($1_BASENAME))
1018
1019 # Create loadmap on AIX. Helps in diagnosing some problems.
1020 ifneq ($(COMPILER_BINDCMD_FILE_FLAG), )
1021 $1_EXTRA_LDFLAGS += $(COMPILER_BINDCMD_FILE_FLAG)$$($1_OBJECT_DIR)/$$($1_NOSUFFIX).loadmap
1022 endif
1023 endif
1024
1025 ifeq ($(call isTargetOs, windows), true)
1026 ifeq ($$($1_EMBED_MANIFEST), true)
1027 $1_EXTRA_LDFLAGS += -manifest:embed
1028 endif
1029
1030 $1_IMPORT_LIBRARY := $$($1_OBJECT_DIR)/$$($1_NAME).lib
1031 $1_EXTRA_LDFLAGS += "-implib:$$($1_IMPORT_LIBRARY)"
1032 ifeq ($$($1_TYPE), LIBRARY)
1033 # To properly trigger downstream dependants of the import library, just as
1034 # for debug files, we must have a recipe in the rule. To avoid rerunning
1035 # the recipe every time have it touch the target. If an import library
1036 # file is deleted by something external, explicitly delete the target to
1037 # trigger a rebuild of both.
1038 ifneq ($$(wildcard $$($1_IMPORT_LIBRARY)), $$($1_IMPORT_LIBRARY))
1039 $$(call LogDebug, Deleting $$($1_BASENAME) because import library is missing)
1040 $$(shell $(RM) $$($1_TARGET))
1041 endif
1042 $$($1_IMPORT_LIBRARY): $$($1_TARGET)
1043 $(TOUCH) $$@
1044
1045 $1 += $$($1_IMPORT_LIBRARY)
1046 endif
1047 endif
1048
1049 $1_VARDEPS := $$($1_LD) $$($1_SYSROOT_LDFLAGS) $$($1_LDFLAGS) $$($1_EXTRA_LDFLAGS) \
1050 $$(GLOBAL_LIBS) $$($1_LIBS) $$($1_EXTRA_LIBS) $$($1_MT) \
1051 $$($1_CREATE_DEBUGINFO_CMDS) $$($1_MANIFEST_VERSION) \
1052 $$($1_STRIP_CMD)
1053 $1_VARDEPS_FILE := $$(call DependOnVariable, $1_VARDEPS, \
1054 $$($1_OBJECT_DIR)/$$($1_NOSUFFIX).vardeps)
1055
1056 $1_LD_OBJ_ARG := $$($1_ALL_OBJS)
1057
1058 # If there are many object files, use an @-file...
1059 ifneq ($$(word 17, $$($1_ALL_OBJS)), )
1060 $1_OBJ_FILE_LIST := $$($1_OBJECT_DIR)/_$1_objectfilenames.txt
1061 ifneq ($(COMPILER_COMMAND_FILE_FLAG), )
1062 $1_LD_OBJ_ARG := $(COMPILER_COMMAND_FILE_FLAG)$$($1_OBJ_FILE_LIST)
1063 else
1064 # ...except for toolchains which don't support them.
1065 $1_LD_OBJ_ARG := `cat $$($1_OBJ_FILE_LIST)`
1066 endif
1067 endif
1068
1069 # Unfortunately the @-file trick does not work reliably when using clang.
1070 # Clang does not propagate the @-file parameter to the ld sub process, but
1071 # instead puts the full content on the command line. At least the llvm ld
1072 # does not even support an @-file.
1073 #
1074 # When linking a large amount of object files, we risk hitting the limit
1075 # of the command line length even on posix systems if the path length of
1076 # the output dir is very long due to our use of absolute paths. To
1077 # mitigate this, use paths relative to the output dir when linking over
1078 # 500 files with clang and the output dir path is deep.
1079 ifneq ($$(word 500, $$($1_ALL_OBJS)), )
1080 ifeq ($$(TOOLCHAIN_TYPE), clang)
1081 # There is no strlen function in make, but checking path depth is a
1082 # reasonable approximation.
1083 ifneq ($$(word 10, $$(subst /, ,$$(OUTPUTDIR))), )
1084 $1_LINK_OBJS_RELATIVE := true
1085 $1_ALL_OBJS_RELATIVE := $$(patsubst $$(OUTPUTDIR)/%, %, $$($1_ALL_OBJS))
1086 endif
1087 endif
1088 endif
1089
1090 $1_TARGET_DEPS := $$($1_ALL_OBJS) $$($1_RES) $$($1_MANIFEST) \
1091 $$($1_REAL_MAPFILE) $$($1_VARDEPS_FILE)
1092
1093 $$($1_TARGET): $$($1_TARGET_DEPS)
1094 ifneq ($$($1_OBJ_FILE_LIST), )
1095 ifeq ($$($1_LINK_OBJS_RELATIVE), true)
1096 $$(eval $$(call ListPathsSafely, $1_ALL_OBJS_RELATIVE, $$($1_OBJ_FILE_LIST)))
1097 else
1098 $$(eval $$(call ListPathsSafely, $1_ALL_OBJS, $$($1_OBJ_FILE_LIST)))
1099 endif
1100 endif
1101 # Keep as much as possible on one execution line for best performance
1102 # on Windows
1103 $$(call LogInfo, Linking $$($1_BASENAME))
1104 $$(call MakeDir, $$($1_OUTPUT_DIR) $$($1_SYMBOLS_DIR))
1105 ifeq ($(call isTargetOs, windows), true)
1106
1107 $$(call ExecuteWithLog, $$($1_OBJECT_DIR)/$$($1_SAFE_NAME)_link, \
1108 $$($1_LD) $$($1_LDFLAGS) $$($1_EXTRA_LDFLAGS) $$($1_SYSROOT_LDFLAGS) \
1109 $(LD_OUT_OPTION)$$($1_TARGET) $$($1_LD_OBJ_ARG) $$($1_RES) $$(GLOBAL_LIBS) \
1110 $$($1_LIBS) $$($1_EXTRA_LIBS)) \
1111 | $(GREP) -v "^ Creating library .*\.lib and object .*\.exp" || \
1112 test "$$$$?" = "1" ; \
1113 $$($1_CREATE_DEBUGINFO_CMDS)
1114 $$($1_STRIP_CMD)
1115 else
1116 $$(call ExecuteWithLog, $$($1_OBJECT_DIR)/$$($1_SAFE_NAME)_link, \
1117 $$(if $$($1_LINK_OBJS_RELATIVE), $$(CD) $$(OUTPUTDIR) ; ) \
1118 $$($1_LD) $$($1_LDFLAGS) $$($1_EXTRA_LDFLAGS) $$($1_SYSROOT_LDFLAGS) \
1119 $(LD_OUT_OPTION)$$($1_TARGET) $$($1_LD_OBJ_ARG) $$($1_RES) $$(GLOBAL_LIBS) \
1120 $$($1_LIBS) $$($1_EXTRA_LIBS)) ; \
1121 $$($1_CREATE_DEBUGINFO_CMDS)
1122 $$($1_STRIP_CMD)
1123 endif
1124 ifeq ($(call isTargetOs, windows), true)
1125 ifneq ($$($1_MANIFEST), )
1126 $$($1_MT) -nologo -manifest $$($1_MANIFEST) -identity:"$$($1_NAME).exe, version=$$($1_MANIFEST_VERSION)" -outputresource:$$@;#1
1127 endif
1128 endif
1129 # This only works if the openjdk_codesign identity is present on the system. Let
1130 # silently fail otherwise.
1131 ifneq ($(CODESIGN), )
1132 $(CODESIGN) -s "$(MACOSX_CODESIGN_IDENTITY)" --timestamp --options runtime \
1133 --entitlements $(TOPDIR)/make/data/macosxsigning/entitlements.plist $$@
1134 endif
1135 endif
1136
1137 ifeq ($(GENERATE_COMPILE_COMMANDS_ONLY), true)
1138 $1 := $$($1_ALL_OBJS_JSON)
1139 endif
1140 endef
1141
1142 endif # _NATIVE_COMPILATION_GMK