1 #
2 # Copyright (c) 2011, 2020, 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 # When absolute paths are not allowed in the output, and the compiler does not
209 # support any options to avoid it, we need to rewrite compile commands to use
210 # relative paths. By doing this, the __FILE__ macro will resolve to relative
211 # paths. The relevant input paths on the command line are the -I flags and the
212 # path to the source file itself.
213 #
214 # The macro MakeCommandRelative is used to rewrite the command line like this:
215 # 'CD $(WORKSPACE_ROOT) && <cmd>'
216 # and changes all paths in cmd to be relative to the workspace root. This only
217 # works properly if the build dir is inside the workspace root. If it's not,
218 # relative paths are still calculated, but depending on the distance between the
219 # dirs, paths in the build dir may end up as essentially absolute anyway.
220 #
221 # The fix-deps-file macro is used to adjust the contents of the generated make
222 # dependency files to contain paths compatible with make.
223 #
224 ifeq ($(ALLOW_ABSOLUTE_PATHS_IN_OUTPUT)-$(FILE_MACRO_CFLAGS), false-)
225 # Need to handle -I flags as both '-Ifoo' and '-I foo'.
226 MakeCommandRelative = \
227 $(CD) $(WORKSPACE_ROOT) && \
228 $(foreach o, $1, \
229 $(if $(filter $(WORKSPACE_ROOT)/% $(OUTPUTDIR)/%, $o), \
230 $(call RelativePath, $o, $(WORKSPACE_ROOT)) \
231 , \
232 $(if $(filter -I$(WORKSPACE_ROOT)/%, $o), \
233 -I$(call RelativePath, $(patsubst -I%, %, $o), $(WORKSPACE_ROOT)) \
234 , \
235 $o \
236 ) \
237 ) \
238 )
239
240 # When compiling with relative paths, the deps file comes out with relative
241 # paths.
242 define fix-deps-file
243 $(SED) -e 's|^\([ ]*\)|\1$(WORKSPACE_ROOT)|' $1.tmp > $1
244 endef
245 else
246 # By default the MakeCommandRelative macro does nothing.
247 MakeCommandRelative = $1
248
249 # No adjustment is needed.
250 define fix-deps-file
251 $(MV) $1.tmp $1
252 endef
253 endif
254
255 ################################################################################
256 # GetEntitlementsFile
257 # Find entitlements file for executable when signing on macosx. If no
258 # specialized file is found, returns the default file.
259 # $1 Executable to find entitlements file for.
260 ENTITLEMENTS_DIR := $(TOPDIR)/make/data/macosxsigning
261 DEFAULT_ENTITLEMENTS_FILE := $(ENTITLEMENTS_DIR)/default.plist
262
263 GetEntitlementsFile = \
264 $(foreach f, $(ENTITLEMENTS_DIR)/$(strip $(notdir $1)).plist, \
265 $(if $(wildcard $f), $f, $(DEFAULT_ENTITLEMENTS_FILE)) \
266 )
267
268 ################################################################################
269 # Create the recipe needed to compile a single native source file.
270 #
271 # Parameter 1 is the name of the rule, based on the name of the library/
272 # program being build and the name of the source code file, e.g.
273 # BUILD_LIBFOO_fooMain.cpp.
274 #
275 # Remaining parameters are named arguments:
276 # FILE - The full path of the source file to compiler
277 # BASE - The name of the rule for the entire binary to build ($1)
278 #
279 SetupCompileNativeFile = $(NamedParamsMacroTemplate)
280 define SetupCompileNativeFileBody
281 $1_FILENAME := $$(notdir $$($1_FILE))
282
283 # The target file to be generated.
284 $1_OBJ := $$($$($1_BASE)_OBJECT_DIR)/$$(call replace_with_obj_extension, \
285 $$($1_FILENAME))
286
287 # Generate the corresponding compile_commands.json fragment.
288 $1_OBJ_JSON = $$(MAKESUPPORT_OUTPUTDIR)/compile-commands/$$(subst /,_,$$(subst \
289 $$(OUTPUTDIR)/,,$$($1_OBJ))).json
290 $$($1_BASE)_ALL_OBJS_JSON += $$($1_OBJ_JSON)
291
292 # Only continue if this object file hasn't been processed already. This lets
293 # the first found source file override any other with the same name.
294 ifeq ($$($1_OBJ_PROCESSED), )
295 $1_OBJ_PROCESSED := true
296 # This is the definite source file to use for $1_FILENAME.
297 $1_SRC_FILE := $$($1_FILE)
298
299 ifeq ($$($1_OPTIMIZATION), )
300 $1_OPT_CFLAGS := $$($$($1_BASE)_OPT_CFLAGS)
301 $1_OPT_CXXFLAGS := $$($$($1_BASE)_OPT_CXXFLAGS)
302 else
303 ifeq ($$($1_OPTIMIZATION), NONE)
304 $1_OPT_CFLAGS := $(C_O_FLAG_NONE)
305 $1_OPT_CXXFLAGS := $(CXX_O_FLAG_NONE)
306 else ifeq ($$($1_OPTIMIZATION), LOW)
307 $1_OPT_CFLAGS := $(C_O_FLAG_NORM)
308 $1_OPT_CXXFLAGS := $(CXX_O_FLAG_NORM)
309 else ifeq ($$($1_OPTIMIZATION), HIGH)
310 $1_OPT_CFLAGS := $(C_O_FLAG_HI)
311 $1_OPT_CXXFLAGS := $(CXX_O_FLAG_HI)
312 else ifeq ($$($1_OPTIMIZATION), HIGHEST)
313 $1_OPT_CFLAGS := $(C_O_FLAG_HIGHEST)
314 $1_OPT_CXXFLAGS := $(CXX_O_FLAG_HIGHEST)
315 else ifeq ($$($1_OPTIMIZATION), HIGHEST_JVM)
316 $1_OPT_CFLAGS := $(C_O_FLAG_HIGHEST_JVM)
317 $1_OPT_CXXFLAGS := $(CXX_O_FLAG_HIGHEST_JVM)
318 else ifeq ($$($1_OPTIMIZATION), SIZE)
319 $1_OPT_CFLAGS := $(C_O_FLAG_SIZE)
320 $1_OPT_CXXFLAGS := $(CXX_O_FLAG_SIZE)
321 else
322 $$(error Unknown value for file OPTIMIZATION: $$($1_OPTIMIZATION))
323 endif
324 endif
325
326 ifneq ($$($$($1_BASE)_PRECOMPILED_HEADER), )
327 ifeq ($$(filter $$($1_FILENAME), $$($$($1_BASE)_PRECOMPILED_HEADER_EXCLUDE)), )
328 $1_USE_PCH_FLAGS := $$($$($1_BASE)_USE_PCH_FLAGS)
329 endif
330 endif
331
332 $1_BASE_CFLAGS := $$($$($1_BASE)_CFLAGS) $$($$($1_BASE)_EXTRA_CFLAGS) \
333 $$($$($1_BASE)_SYSROOT_CFLAGS)
334 $1_BASE_CXXFLAGS := $$($$($1_BASE)_CXXFLAGS) $$($$($1_BASE)_EXTRA_CXXFLAGS) \
335 $$($$($1_BASE)_SYSROOT_CFLAGS) $$($1_EXTRA_CXXFLAGS)
336 $1_BASE_ASFLAGS := $$($$($1_BASE)_ASFLAGS) $$($$($1_BASE)_EXTRA_ASFLAGS)
337
338 ifneq ($$(filter %.c, $$($1_FILENAME)), )
339 # Compile as a C file
340 $1_FLAGS := $(CFLAGS_CCACHE) $$($1_USE_PCH_FLAGS) $$($1_BASE_CFLAGS) \
341 $$($1_OPT_CFLAGS) $$($1_CFLAGS) -c
342 $1_COMPILER := $$($$($1_BASE)_CC)
343 $1_DEP_FLAG := $(C_FLAG_DEPS)
344 else ifneq ($$(filter %.m, $$($1_FILENAME)), )
345 # Compile as an Objective-C file
346 $1_FLAGS := -x objective-c $(CFLAGS_CCACHE) $$($1_USE_PCH_FLAGS) \
347 $$($1_BASE_CFLAGS) $$($1_OPT_CFLAGS) $$($1_CFLAGS) -c
348 $1_COMPILER := $$($$($1_BASE)_CC)
349 $1_DEP_FLAG := $(C_FLAG_DEPS)
350 else ifneq ($$(filter %.s %.S, $$($1_FILENAME)), )
351 # Compile as assembler file
352 $1_FLAGS := $$($1_BASE_ASFLAGS)
353 $1_COMPILER := $(AS)
354 $1_DEP_FLAG :=
355 else ifneq ($$(filter %.cpp %.cc %.mm, $$($1_FILENAME)), )
356 # Compile as a C++ or Objective-C++ file
357 $1_FLAGS := $(CFLAGS_CCACHE) $$($1_USE_PCH_FLAGS) $$($1_BASE_CXXFLAGS) \
358 $$($1_OPT_CXXFLAGS) $$($1_CXXFLAGS) -c
359 $1_COMPILER := $$($$($1_BASE)_CXX)
360 $1_DEP_FLAG := $(CXX_FLAG_DEPS)
361 else
362 $$(error Internal error in NativeCompilation.gmk: no compiler for file $$($1_FILENAME))
363 endif
364
365 ifeq ($$(filter %.s %.S, $$($1_FILENAME)), )
366 # And this is the dependency file for this obj file.
367 $1_DEPS_FILE := $$(patsubst %$(OBJ_SUFFIX),%.d,$$($1_OBJ))
368 # The dependency target file lists all dependencies as empty targets to
369 # avoid make error "No rule to make target" for removed files
370 $1_DEPS_TARGETS_FILE := $$(patsubst %$(OBJ_SUFFIX),%.d.targets,$$($1_OBJ))
371
372 # Only try to load individual dependency information files if the global
373 # file hasn't been loaded (could happen if make was interrupted).
374 ifneq ($$($$($1_BASE)_DEPS_FILE_LOADED), true)
375 # Include previously generated dependency information. (if it exists)
376 -include $$($1_DEPS_FILE)
377 -include $$($1_DEPS_TARGETS_FILE)
378 endif
379 endif
380
381 ifneq ($$(strip $$($1_CFLAGS) $$($1_CXXFLAGS) $$($1_OPTIMIZATION)), )
382 $1_VARDEPS := $$($1_CFLAGS) $$($1_CXXFLAGS) $$($1_OPTIMIZATION)
383 $1_VARDEPS_FILE := $$(call DependOnVariable, $1_VARDEPS, $$($1_OBJ).vardeps)
384 endif
385
386 $1_OBJ_DEPS := $$($1_SRC_FILE) $$($$($1_BASE)_COMPILE_VARDEPS_FILE) \
387 $$($$($1_BASE)_EXTRA_DEPS) $$($1_VARDEPS_FILE)
388 $1_COMPILE_OPTIONS := $$($1_FLAGS) $(CC_OUT_OPTION)$$($1_OBJ) $$($1_SRC_FILE)
389
390 $$($1_OBJ_JSON): $$($1_OBJ_DEPS)
391 $$(call WriteCompileCommandsFragment, $$@, $$(PWD), $$($1_SRC_FILE), \
392 $$($1_COMPILER) $$($1_COMPILE_OPTIONS))
393
394 $$($1_OBJ): $$($1_OBJ_DEPS) | $$($$($1_BASE)_BUILD_INFO)
395 $$(call LogInfo, Compiling $$($1_FILENAME) (for $$($$($1_BASE)_BASENAME)))
396 $$(call MakeDir, $$(@D))
397 ifneq ($(TOOLCHAIN_TYPE), microsoft)
398 $$(call ExecuteWithLog, $$@, $$(call MakeCommandRelative, \
399 $$($1_COMPILER) $$($1_DEP_FLAG) \
400 $$(addsuffix .tmp, $$($1_DEPS_FILE)) \
401 $$($1_COMPILE_OPTIONS)))
402 ifneq ($$($1_DEPS_FILE), )
403 $$(call fix-deps-file, $$($1_DEPS_FILE))
404 # Create a dependency target file from the dependency file.
405 # Solution suggested by:
406 # http://make.mad-scientist.net/papers/advanced-auto-dependency-generation/
407 $(SED) $(DEPENDENCY_TARGET_SED_PATTERN) $$($1_DEPS_FILE) \
408 > $$($1_DEPS_TARGETS_FILE)
409 endif
410 else
411 # The Visual Studio compiler lacks a feature for generating make
412 # dependencies, but by setting -showIncludes, all included files are
413 # printed. These are filtered out and parsed into make dependences.
414 #
415 # Keep as much as possible on one execution line for best performance
416 # on Windows. No need to save exit code from compilation since
417 # pipefail is always active on Windows.
418 $$(call ExecuteWithLog, $$@, $$(call MakeCommandRelative, \
419 $$($1_COMPILER) -showIncludes $$($1_COMPILE_OPTIONS))) \
420 | $(TR) -d '\r' | $(GREP) -v -e "^Note: including file:" \
421 -e "^$$($1_FILENAME)$$$$" || test "$$$$?" = "1" ; \
422 $(ECHO) $$@: \\ > $$($1_DEPS_FILE) ; \
423 $(SED) $(WINDOWS_SHOWINCLUDE_SED_PATTERN) $$($1_OBJ).log \
424 | $(SORT) -u >> $$($1_DEPS_FILE) ; \
425 $(ECHO) >> $$($1_DEPS_FILE) ; \
426 $(SED) $(DEPENDENCY_TARGET_SED_PATTERN) $$($1_DEPS_FILE) > $$($1_DEPS_TARGETS_FILE)
427 endif
428 endif
429 endef
430
431 # Setup make rules for creating a native binary (a shared library or an
432 # executable).
433 #
434 # Parameter 1 is the name of the rule. This name is used as variable prefix,
435 # and the targets generated are listed in a variable by that name.
436 #
437 # Remaining parameters are named arguments. These include:
438 # NAME The base name for the resulting binary, excluding decorations (like *.exe)
439 # TYPE Type of binary (EXECUTABLE, LIBRARY or STATIC_LIBRARY). Default is LIBRARY.
440 # SUFFIX Override the default suffix for the output file
441 # TOOLCHAIN Name of toolchain setup to use. Defaults to TOOLCHAIN_DEFAULT.
442 # SRC one or more directory roots to scan for C/C++ files.
443 # CFLAGS the compiler flags to be used, used both for C and C++.
444 # CXXFLAGS the compiler flags to be used for c++, if set overrides CFLAGS.
445 # LDFLAGS the linker flags to be used, used both for C and C++.
446 # LIBS the libraries to link to
447 # ARFLAGS the archiver flags to be used
448 # OBJECT_DIR the directory where we store the object files
449 # OUTPUT_DIR the directory where the resulting binary is put
450 # SYMBOLS_DIR the directory where the debug symbols are put, defaults to OUTPUT_DIR
451 # INCLUDES only pick source from these directories
452 # EXCLUDES do not pick source from these directories
453 # INCLUDE_FILES only compile exactly these files!
454 # EXCLUDE_FILES with these names
455 # EXCLUDE_PATTERN exclude files matching any of these substrings
456 # EXTRA_FILES List of extra files not in any of the SRC dirs
457 # EXTRA_OBJECT_FILES List of extra object files to include when linking
458 # EXTRA_DEPS List of extra dependencies to be added to each compiled file
459 # VERSIONINFO_RESOURCE Input file for RC. Setting this implies that RC will be run
460 # RC_FLAGS flags for RC.
461 # EMBED_MANIFEST if true, embed manifest on Windows.
462 # MAPFILE mapfile
463 # USE_MAPFILE_FOR_SYMBOLS if true and this is a STATIC_BUILD, just copy the
464 # mapfile for the output symbols file
465 # CC the compiler to use, default is $(CC)
466 # LD the linker to use, default is $(LD)
467 # OPTIMIZATION sets optimization level to NONE, LOW, HIGH, HIGHEST, HIGHEST_JVM, SIZE
468 # DISABLED_WARNINGS_<toolchain> Disable the given warnings for the specified toolchain
469 # DISABLED_WARNINGS_C_<toolchain> Disable the given warnings for the specified toolchain
470 # when compiling C code
471 # DISABLED_WARNINGS_CXX_<toolchain> Disable the given warnings for the specified
472 # toolchain when compiling C++ code
473 # STRIP_SYMBOLS Set to false to override global strip policy and always leave
474 # symbols in the binary, if the toolchain allows for it
475 # DEBUG_SYMBOLS Set to false to disable generation of debug symbols
476 # COPY_DEBUG_SYMBOLS Set to false to override global setting of debug symbol copying
477 # ZIP_EXTERNAL_DEBUG_SYMBOLS Set to false to override global setting of debug symbol
478 # zipping
479 # STRIPFLAGS Optionally change the flags given to the strip command
480 # PRECOMPILED_HEADER Header file to use as precompiled header
481 # PRECOMPILED_HEADER_EXCLUDE List of source files that should not use PCH
482 #
483 # After being called, some variables are exported from this macro, all prefixed
484 # with parameter 1 followed by a '_':
485 # TARGET The library or executable created by the macro
486 # TARGET_DEPS All prerequisites for the target calculated by the macro
487 # ALL_OBJS All object files
488 # IMPORT_LIBRARY The import library created for a shared library on Windows
489 SetupNativeCompilation = $(NamedParamsMacroTemplate)
490 define SetupNativeCompilationBody
491
492 # If type is unspecified, default to LIBRARY
493 ifeq ($$($1_TYPE), )
494 $1_TYPE := LIBRARY
495 endif
496
497 # If we're doing a static build and producing a library
498 # force it to be a static library and remove the -l libraries
499 ifeq ($(STATIC_BUILD), true)
500 ifeq ($$($1_TYPE), LIBRARY)
501 $1_TYPE := STATIC_LIBRARY
502 endif
503 endif
504
505 $$(call SetIfEmpty, $1_COMPILE_WITH_DEBUG_SYMBOLS, $$(COMPILE_WITH_DEBUG_SYMBOLS))
506
507 # STATIC_LIBS is set from Main.gmk when building static versions of certain
508 # native libraries.
509 ifeq ($(STATIC_LIBS), true)
510 $1_TYPE := STATIC_LIBRARY
511 # The static versions need to be redirected to different output dirs, both
512 # to not interfere with the main build as well as to not end up inside the
513 # jmods.
514 $1_OBJECT_DIR := $$($1_OBJECT_DIR)/static
515 $1_OUTPUT_DIR := $$($1_OBJECT_DIR)
516 # For release builds where debug symbols are configured to be moved to
517 # separate debuginfo files, disable debug symbols for static libs instead.
518 # We don't currently support this configuration and we don't want symbol
519 # information in release builds unless explicitly asked to provide it.
520 ifeq ($(DEBUG_LEVEL), release)
521 ifeq ($(COPY_DEBUG_SYMBOLS), true)
522 $1_COMPILE_WITH_DEBUG_SYMBOLS := false
523 endif
524 endif
525 endif
526
527 ifeq ($$($1_TYPE), EXECUTABLE)
528 $1_PREFIX :=
529 ifeq ($$($1_SUFFIX), )
530 $1_SUFFIX := $(EXE_SUFFIX)
531 endif
532 else
533 $1_PREFIX := $(LIBRARY_PREFIX)
534 ifeq ($$($1_TYPE), LIBRARY)
535 ifeq ($$($1_SUFFIX), )
536 $1_SUFFIX := $(SHARED_LIBRARY_SUFFIX)
537 endif
538 else ifeq ($$($1_TYPE), STATIC_LIBRARY)
539 ifeq ($$($1_SUFFIX), )
540 $1_SUFFIX := $(STATIC_LIBRARY_SUFFIX)
541 endif
542 endif
543 endif
544
545 ifneq ($$($1_NAME), $(basename $$($1_NAME)))
546 $$(error NAME must not contain any directory path in $1)
547 endif
548 ifneq ($(findstring $$($1_SUFFIX), $$($1_NAME)), )
549 $$(error NAME should be specified without suffix: $$($1_SUFFIX) in $1)
550 endif
551 ifneq ($(findstring $$($1_PREFIX), $$($1_NAME)), )
552 $$(error NAME should be specified without prefix: $$($1_PREFIX) in $1)
553 endif
554 ifeq ($$($1_OUTPUT_DIR), )
555 $$(error OUTPUT_DIR is missing in $1)
556 endif
557 ifneq ($$($1_MANIFEST), )
558 ifeq ($$($1_MANIFEST_VERSION), )
559 $$(error If MANIFEST is provided, then MANIFEST_VERSION is required in $1)
560 endif
561 endif
562
563 $1_BASENAME := $$($1_PREFIX)$$($1_NAME)$$($1_SUFFIX)
564 $1_TARGET := $$($1_OUTPUT_DIR)/$$($1_BASENAME)
565 $1_NOSUFFIX := $$($1_PREFIX)$$($1_NAME)
566 $1_SAFE_NAME := $$(strip $$(subst /,_, $1))
567
568 # Need to make sure TARGET is first on list
569 $1 := $$($1_TARGET)
570
571 # Setup the toolchain to be used
572 $$(call SetIfEmpty, $1_TOOLCHAIN, TOOLCHAIN_DEFAULT)
573 $$(call SetIfEmpty, $1_CC, $$($$($1_TOOLCHAIN)_CC))
574 $$(call SetIfEmpty, $1_CXX, $$($$($1_TOOLCHAIN)_CXX))
575 $$(call SetIfEmpty, $1_LD, $$($$($1_TOOLCHAIN)_LD))
576 $$(call SetIfEmpty, $1_AR, $$($$($1_TOOLCHAIN)_AR))
577 $$(call SetIfEmpty, $1_AS, $$($$($1_TOOLCHAIN)_AS))
578 $$(call SetIfEmpty, $1_MT, $$($$($1_TOOLCHAIN)_MT))
579 $$(call SetIfEmpty, $1_RC, $$($$($1_TOOLCHAIN)_RC))
580 $$(call SetIfEmpty, $1_OBJCOPY, $$($$($1_TOOLCHAIN)_OBJCOPY))
581 $$(call SetIfEmpty, $1_STRIP, $$($$($1_TOOLCHAIN)_STRIP))
582 $$(call SetIfEmpty, $1_SYSROOT_CFLAGS, $$($$($1_TOOLCHAIN)_SYSROOT_CFLAGS))
583 $$(call SetIfEmpty, $1_SYSROOT_LDFLAGS, $$($$($1_TOOLCHAIN)_SYSROOT_LDFLAGS))
584
585 $$(foreach d, $$($1_SRC), $$(if $$(wildcard $$d), , \
586 $$(error SRC specified to SetupNativeCompilation $1 contains missing directory $$d)))
587
588 $1_SRCS_RAW := $$(call FindFiles, $$($1_SRC))
589 # Order src files according to the order of the src dirs
590 $1_SRCS := $$(foreach d, $$($1_SRC), $$(filter $$d%, $$($1_SRCS_RAW)))
591 $1_SRCS := $$(filter $$(NATIVE_SOURCE_EXTENSIONS), $$($1_SRCS))
592 # Extract the C/C++ files.
593 ifneq ($$($1_EXCLUDE_PATTERNS), )
594 # We must not match the exclude pattern against the src root(s).
595 $1_SRCS_WITHOUT_ROOTS := $$($1_SRCS)
596 $$(foreach i, $$($1_SRC), $$(eval $1_SRCS_WITHOUT_ROOTS := $$(patsubst \
597 $$i/%,%, $$($1_SRCS_WITHOUT_ROOTS))))
598 $1_ALL_EXCLUDE_FILES := $$(call containing, $$($1_EXCLUDE_PATTERNS), \
599 $$($1_SRCS_WITHOUT_ROOTS))
600 endif
601 ifneq ($$($1_EXCLUDE_FILES), )
602 $1_ALL_EXCLUDE_FILES += $$($1_EXCLUDE_FILES)
603 endif
604 ifneq ($$($1_ALL_EXCLUDE_FILES), )
605 $1_EXCLUDE_FILES_PAT := $$($1_ALL_EXCLUDE_FILES) \
606 $$(foreach i, $$($1_SRC), $$(addprefix $$i/, $$($1_ALL_EXCLUDE_FILES)))
607 $1_EXCLUDE_FILES_PAT := $$(addprefix %, $$($1_EXCLUDE_FILES_PAT))
608 $1_SRCS := $$(filter-out $$($1_EXCLUDE_FILES_PAT), $$($1_SRCS))
609 endif
610 ifneq ($$($1_INCLUDE_FILES), )
611 $1_INCLUDE_FILES_PAT := $$(foreach i, $$($1_SRC), $$(addprefix $$i/, $$($1_INCLUDE_FILES)))
612 $1_SRCS := $$(filter $$($1_INCLUDE_FILES_PAT), $$($1_SRCS))
613 endif
614 # There can be only a single bin dir root, no need to foreach over the roots.
615 $1_BINS := $$(wildcard $$($1_OBJECT_DIR)/*$(OBJ_SUFFIX))
616 # Now we have a list of all c/c++ files to compile: $$($1_SRCS)
617 # and we have a list of all existing object files: $$($1_BINS)
618
619 # Prepend the source/bin path to the filter expressions. Then do the filtering.
620 ifneq ($$($1_INCLUDES), )
621 $1_SRC_INCLUDES := $$(foreach i, $$($1_SRC), $$(addprefix $$i/, $$(addsuffix /%, $$($1_INCLUDES))))
622 $1_SRCS := $$(filter $$($1_SRC_INCLUDES), $$($1_SRCS))
623 endif
624 ifneq ($$($1_EXCLUDES), )
625 $1_SRC_EXCLUDES := $$(addsuffix /%, $$($1_EXCLUDES))
626 $1_SRC_EXCLUDES += $$(foreach i, $$($1_SRC), $$(addprefix $$i/, $$(addsuffix /%, $$($1_EXCLUDES))))
627 $1_SRCS := $$(filter-out $$($1_SRC_EXCLUDES), $$($1_SRCS))
628 endif
629
630 $1_SRCS += $$($1_EXTRA_FILES)
631
632 ifeq ($$($1_SRCS), )
633 $$(error No sources found for $1 when looking inside the dirs $$($1_SRC))
634 endif
635
636 # Calculate the expected output from compiling the sources
637 $1_EXPECTED_OBJS_FILENAMES := $$(call replace_with_obj_extension, $$(notdir $$($1_SRCS)))
638 $1_EXPECTED_OBJS := $$(addprefix $$($1_OBJECT_DIR)/, $$($1_EXPECTED_OBJS_FILENAMES))
639 # Are there too many object files on disk? Perhaps because some source file was removed?
640 $1_SUPERFLOUS_OBJS := $$(sort $$(filter-out $$($1_EXPECTED_OBJS), $$($1_BINS)))
641 # Clean out the superfluous object files.
642 ifneq ($$($1_SUPERFLUOUS_OBJS), )
643 $$(shell $(RM) -f $$($1_SUPERFLUOUS_OBJS))
644 endif
645 # Sort to remove dupliates and provide a reproducable order on the input files to the linker.
646 $1_ALL_OBJS := $$(sort $$($1_EXPECTED_OBJS) $$($1_EXTRA_OBJECT_FILES))
647
648 # Pickup extra OPENJDK_TARGET_OS_TYPE, OPENJDK_TARGET_OS, and/or OPENJDK_TARGET_OS plus
649 # OPENJDK_TARGET_CPU pair dependent variables for CFLAGS.
650 $1_EXTRA_CFLAGS := $$($1_CFLAGS_$(OPENJDK_TARGET_OS_TYPE)) $$($1_CFLAGS_$(OPENJDK_TARGET_OS)) \
651 $$($1_CFLAGS_$(OPENJDK_TARGET_OS)_$(OPENJDK_TARGET_CPU))
652 ifneq ($(DEBUG_LEVEL), release)
653 # Pickup extra debug dependent variables for CFLAGS
654 $1_EXTRA_CFLAGS += $$($1_CFLAGS_debug)
655 $1_EXTRA_CFLAGS += $$($1_CFLAGS_$(OPENJDK_TARGET_OS_TYPE)_debug)
656 $1_EXTRA_CFLAGS += $$($1_CFLAGS_$(OPENJDK_TARGET_OS)_debug)
657 $1_EXTRA_CFLAGS += $$($1_CFLAGS_$(OPENJDK_TARGET_OS)_$(OPENJDK_TARGET_CPU)_debug)
658 else
659 $1_EXTRA_CFLAGS += $$($1_CFLAGS_release)
660 $1_EXTRA_CFLAGS += $$($1_CFLAGS_$(OPENJDK_TARGET_OS_TYPE)_release)
661 $1_EXTRA_CFLAGS += $$($1_CFLAGS_$(OPENJDK_TARGET_OS)_release)
662 $1_EXTRA_CFLAGS += $$($1_CFLAGS_$(OPENJDK_TARGET_OS)_$(OPENJDK_TARGET_CPU)_release)
663 endif
664 ifeq ($(STATIC_LIBS), true)
665 $1_EXTRA_CFLAGS += $$(STATIC_LIBS_CFLAGS)
666 endif
667
668 # Pickup extra OPENJDK_TARGET_OS_TYPE and/or OPENJDK_TARGET_OS dependent variables for CXXFLAGS.
669 $1_EXTRA_CXXFLAGS := $$($1_CXXFLAGS_$(OPENJDK_TARGET_OS_TYPE)) $$($1_CXXFLAGS_$(OPENJDK_TARGET_OS))
670 ifneq ($(DEBUG_LEVEL), release)
671 # Pickup extra debug dependent variables for CXXFLAGS
672 $1_EXTRA_CXXFLAGS += $$($1_CXXFLAGS_debug)
673 $1_EXTRA_CXXFLAGS += $$($1_CXXFLAGS_$(OPENJDK_TARGET_OS_TYPE)_debug)
674 $1_EXTRA_CXXFLAGS += $$($1_CXXFLAGS_$(OPENJDK_TARGET_OS)_debug)
675 else
676 $1_EXTRA_CXXFLAGS += $$($1_CXXFLAGS_release)
677 $1_EXTRA_CXXFLAGS += $$($1_CXXFLAGS_$(OPENJDK_TARGET_OS_TYPE)_release)
678 $1_EXTRA_CXXFLAGS += $$($1_CXXFLAGS_$(OPENJDK_TARGET_OS)_release)
679 endif
680 ifeq ($(STATIC_LIBS), true)
681 $1_EXTRA_CXXFLAGS += $$(STATIC_LIB_CFLAGS)
682 endif
683
684 # If no C++ flags are explicitly set, default to using the C flags.
685 # After that, we can set additional C++ flags that should not interfere
686 # with the mechanism for copying the C flags by default.
687 ifeq ($$($1_CXXFLAGS), )
688 $1_CXXFLAGS := $$($1_CFLAGS)
689 endif
690 ifeq ($$(strip $$($1_EXTRA_CXXFLAGS)), )
691 $1_EXTRA_CXXFLAGS := $$($1_EXTRA_CFLAGS)
692 endif
693
694 ifeq ($$($1_COMPILE_WITH_DEBUG_SYMBOLS), true)
695 $1_EXTRA_CFLAGS += $$(CFLAGS_DEBUG_SYMBOLS)
696 $1_EXTRA_CXXFLAGS += $$(CFLAGS_DEBUG_SYMBOLS)
697 $1_EXTRA_ASFLAGS += $$(ASFLAGS_DEBUG_SYMBOLS)
698 endif
699
700 # Pass the library name for static JNI library naming
701 ifeq ($$($1_TYPE), STATIC_LIBRARY)
702 $1_EXTRA_CFLAGS += -DLIBRARY_NAME=$$($1_NAME)
703 $1_EXTRA_CXXFLAGS += -DLIBRARY_NAME=$$($1_NAME)
704 endif
705
706 # Pick up disabled warnings, if possible on this platform.
707 ifneq ($(DISABLE_WARNING_PREFIX), )
708 $1_EXTRA_CFLAGS += $$(addprefix $(DISABLE_WARNING_PREFIX), \
709 $$(DISABLED_WARNINGS) \
710 $$(DISABLED_WARNINGS_C) \
711 $$($1_DISABLED_WARNINGS_$(TOOLCHAIN_TYPE)) \
712 $$($1_DISABLED_WARNINGS_C_$(TOOLCHAIN_TYPE)))
713 $1_EXTRA_CXXFLAGS += $$(addprefix $(DISABLE_WARNING_PREFIX), \
714 $$(DISABLED_WARNINGS) \
715 $$(DISABLED_WARNINGS_CXX) \
716 $$($1_DISABLED_WARNINGS_$(TOOLCHAIN_TYPE)) \
717 $$($1_DISABLED_WARNINGS_CXX_$(TOOLCHAIN_TYPE)))
718 endif
719
720 # Check if warnings should be considered errors.
721 # Pick first binary and toolchain specific, then binary specific, then general setting.
722 ifeq ($$($1_WARNINGS_AS_ERRORS_$(TOOLCHAIN_TYPE)), )
723 ifeq ($$($1_WARNINGS_AS_ERRORS), )
724 $1_WARNINGS_AS_ERRORS_$(TOOLCHAIN_TYPE) := $$(WARNINGS_AS_ERRORS)
725 else
726 $1_WARNINGS_AS_ERRORS_$(TOOLCHAIN_TYPE) := $$($1_WARNINGS_AS_ERRORS)
727 endif
728 endif
729
730 ifeq ($$($1_WARNINGS_AS_ERRORS_$(TOOLCHAIN_TYPE)), true)
731 $1_EXTRA_CFLAGS += $(CFLAGS_WARNINGS_ARE_ERRORS)
732 $1_EXTRA_CXXFLAGS += $(CFLAGS_WARNINGS_ARE_ERRORS)
733 endif
734
735 ifeq (NONE, $$($1_OPTIMIZATION))
736 $1_OPT_CFLAGS := $(C_O_FLAG_NONE)
737 $1_OPT_CXXFLAGS := $(CXX_O_FLAG_NONE)
738 else ifeq (LOW, $$($1_OPTIMIZATION))
739 $1_OPT_CFLAGS := $(C_O_FLAG_NORM)
740 $1_OPT_CXXFLAGS := $(CXX_O_FLAG_NORM)
741 else ifeq (HIGH, $$($1_OPTIMIZATION))
742 $1_OPT_CFLAGS := $(C_O_FLAG_HI)
743 $1_OPT_CXXFLAGS := $(CXX_O_FLAG_HI)
744 else ifeq (HIGHEST, $$($1_OPTIMIZATION))
745 $1_OPT_CFLAGS := $(C_O_FLAG_HIGHEST)
746 $1_OPT_CXXFLAGS := $(CXX_O_FLAG_HIGHEST)
747 else ifeq (HIGHEST_JVM, $$($1_OPTIMIZATION))
748 $1_OPT_CFLAGS := $(C_O_FLAG_HIGHEST_JVM)
749 $1_OPT_CXXFLAGS := $(CXX_O_FLAG_HIGHEST_JVM)
750 else ifeq (SIZE, $$($1_OPTIMIZATION))
751 $1_OPT_CFLAGS := $(C_O_FLAG_SIZE)
752 $1_OPT_CXXFLAGS := $(CXX_O_FLAG_SIZE)
753 else ifneq (, $$($1_OPTIMIZATION))
754 $$(error Unknown value for OPTIMIZATION: $$($1_OPTIMIZATION))
755 endif
756
757 $1_BUILD_INFO := $$($1_OBJECT_DIR)/_build-info.marker
758
759 # Track variable changes for all variables that affect the compilation command
760 # lines for all object files in this setup. This includes at least all the
761 # variables used in the call to add_native_source below.
762 $1_COMPILE_VARDEPS := $$($1_CFLAGS) $$($1_EXTRA_CFLAGS) $$($1_SYSROOT_CFLAGS) \
763 $$($1_CXXFLAGS) $$($1_EXTRA_CXXFLAGS) $$($1_OPT_CFLAGS) $$($1_OPT_CXXFLAGS) \
764 $$($1_CC) $$($1_CXX) $$($1_AS) $$($1_ASFLAGS)
765 $1_COMPILE_VARDEPS_FILE := $$(call DependOnVariable, $1_COMPILE_VARDEPS, \
766 $$($1_OBJECT_DIR)/$$($1_NOSUFFIX).comp.vardeps)
767
768 ifneq ($$($1_PRECOMPILED_HEADER), )
769 ifeq ($(USE_PRECOMPILED_HEADER), true)
770 ifeq ($(TOOLCHAIN_TYPE), microsoft)
771 $1_PCH_FILE := $$($1_OBJECT_DIR)/$1.pch
772 $1_GENERATED_PCH_SRC := $$($1_OBJECT_DIR)/$1_pch.cpp
773 $1_GENERATED_PCH_OBJ := $$($1_OBJECT_DIR)/$1_pch.obj
774
775 $$(eval $$(call SetupCompileNativeFile, $1_$$(notdir $$($1_GENERATED_PCH_SRC)), \
776 FILE := $$($1_GENERATED_PCH_SRC), \
777 BASE := $1, \
778 EXTRA_CXXFLAGS := -Fp$$($1_PCH_FILE) -Yc$$(notdir $$($1_PRECOMPILED_HEADER)), \
779 ))
780
781 $1_USE_PCH_FLAGS := \
782 -Fp$$($1_PCH_FILE) -Yu$$(notdir $$($1_PRECOMPILED_HEADER))
783
784 $$($1_ALL_OBJS): $$($1_GENERATED_PCH_OBJ)
785
786 # Explicitly add the pch obj file first to ease comparing to old
787 # hotspot build.
788 $1_ALL_OBJS := $$($1_GENERATED_PCH_OBJ) $$($1_ALL_OBJS)
789
790 $$($1_GENERATED_PCH_SRC):
791 $(ECHO) "#include \"$$(notdir $$($1_PRECOMPILED_HEADER))\"" > $$@
792
793 else ifneq ($(findstring $(TOOLCHAIN_TYPE), gcc clang), )
794 ifeq ($(TOOLCHAIN_TYPE), gcc)
795 $1_PCH_FILE := $$($1_OBJECT_DIR)/precompiled/$$(notdir $$($1_PRECOMPILED_HEADER)).gch
796 $1_USE_PCH_FLAGS := -I$$($1_OBJECT_DIR)/precompiled
797 else ifeq ($(TOOLCHAIN_TYPE), clang)
798 $1_PCH_FILE := $$($1_OBJECT_DIR)/precompiled/$$(notdir $$($1_PRECOMPILED_HEADER)).pch
799 $1_USE_PCH_FLAGS := -include-pch $$($1_PCH_FILE)
800 endif
801 $1_PCH_DEPS_FILE := $$($1_PCH_FILE).d
802 $1_PCH_DEPS_TARGETS_FILE := $$($1_PCH_FILE).d.targets
803
804 -include $$($1_PCH_DEPS_FILE)
805 -include $$($1_PCH_DEPS_TARGETS_FILE)
806
807 $1_PCH_COMMAND := $$($1_CC) $$($1_CFLAGS) $$($1_EXTRA_CFLAGS) $$($1_SYSROOT_CFLAGS) \
808 $$($1_OPT_CFLAGS) -x c++-header -c $(C_FLAG_DEPS) $$($1_PCH_DEPS_FILE)
809
810 $$($1_PCH_FILE): $$($1_PRECOMPILED_HEADER) $$($1_COMPILE_VARDEPS_FILE)
811 $$(call LogInfo, Generating precompiled header)
812 $$(call MakeDir, $$(@D))
813 $$(call ExecuteWithLog, $$@, $$(call MakeCommandRelative, \
814 $$($1_PCH_COMMAND) $$< -o $$@))
815 $(SED) $(DEPENDENCY_TARGET_SED_PATTERN) $$($1_PCH_DEPS_FILE) \
816 > $$($1_PCH_DEPS_TARGETS_FILE)
817
818 $$($1_ALL_OBJS): $$($1_PCH_FILE)
819
820 # Generate the corresponding compile_commands.json fragment.
821 $1_PCH_FILE_JSON := $$(MAKESUPPORT_OUTPUTDIR)/compile-commands/$$(subst /,_,$$(subst \
822 $$(OUTPUTDIR)/,,$$($1_PCH_FILE))).json
823 $1_ALL_OBJS_JSON += $$($1_PCH_FILE_JSON)
824
825 $$($1_PCH_FILE_JSON): $$($1_PRECOMPILED_HEADER) $$($1_COMPILE_VARDEPS_FILE)
826 $$(call WriteCompileCommandsFragment, $$@, $$(PWD), $$<, \
827 $$($1_PCH_COMMAND) $$< -o $$($1_PCH_FILE))
828 endif
829 endif
830 endif
831
832 # Now call SetupCompileNativeFile for each source file we are going to compile.
833 $$(foreach file, $$($1_SRCS), \
834 $$(eval $$(call SetupCompileNativeFile, $1_$$(notdir $$(file)),\
835 FILE := $$(file), \
836 BASE := $1, \
837 )) \
838 )
839
840 # Setup rule for printing progress info when compiling source files.
841 # This is a rough heuristic and may not always print accurate information.
842 $$($1_BUILD_INFO): $$($1_SRCS) $$($1_COMPILE_VARDEPS_FILE)
843 ifeq ($$(wildcard $$($1_TARGET)), )
844 $$(call LogWarn, Creating $$(subst $$(OUTPUTDIR)/,,$$($1_TARGET)) from $$(words \
845 $$(filter-out %.vardeps, $$?)) file(s))
846 else
847 $$(call LogWarn, $$(strip Updating $$(subst $$(OUTPUTDIR)/,,$$($1_TARGET)) \
848 $$(if $$(filter-out %.vardeps, $$?), \
849 due to $$(words $$(filter-out %.vardeps, $$?)) file(s), \
850 $$(if $$(filter %.vardeps, $$?), due to makefile changes))))
851 endif
852 $(TOUCH) $$@
853
854 # On windows we need to create a resource file
855 ifeq ($(call isTargetOs, windows), true)
856 ifneq ($$($1_VERSIONINFO_RESOURCE), )
857 $1_RES := $$($1_OBJECT_DIR)/$$($1_BASENAME).res
858 $1_RES_DEPS_FILE := $$($1_RES).d
859 $1_RES_DEPS_TARGETS_FILE := $$($1_RES).d.targets
860 -include $$($1_RES_DEPS_FILE)
861 -include $$($1_RES_DEPS_TARGETS_FILE)
862
863 $1_RES_VARDEPS := $$($1_RC) $$($1_RC_FLAGS)
864 $1_RES_VARDEPS_FILE := $$(call DependOnVariable, $1_RES_VARDEPS, \
865 $$($1_RES).vardeps)
866
867 $$($1_RES): $$($1_VERSIONINFO_RESOURCE) $$($1_RES_VARDEPS_FILE)
868 $$(call LogInfo, Compiling resource $$(notdir $$($1_VERSIONINFO_RESOURCE)) (for $$($1_BASENAME)))
869 $$(call MakeDir, $$(@D) $$($1_OBJECT_DIR))
870 $$(call ExecuteWithLog, $$@, $$(call MakeCommandRelative, \
871 $$($1_RC) $$($1_RC_FLAGS) $$($1_SYSROOT_CFLAGS) $(CC_OUT_OPTION)$$@ \
872 $$($1_VERSIONINFO_RESOURCE) 2>&1 ))
873 # Windows RC compiler does not support -showIncludes, so we mis-use CL
874 # for this. Filter out RC specific arguments that are unknown to CL.
875 # For some unknown reason, in this case CL actually outputs the show
876 # includes to stderr so need to redirect it to hide the output from the
877 # main log.
878 $$(call ExecuteWithLog, $$($1_RES_DEPS_FILE).obj, \
879 $$($1_CC) $$(filter-out -l%, $$($1_RC_FLAGS)) \
880 $$($1_SYSROOT_CFLAGS) -showIncludes -nologo -TC \
881 $(CC_OUT_OPTION)$$($1_RES_DEPS_FILE).obj -P -Fi$$($1_RES_DEPS_FILE).pp \
882 $$($1_VERSIONINFO_RESOURCE)) 2>&1 \
883 | $(TR) -d '\r' | $(GREP) -v -e "^Note: including file:" \
884 -e "^$$(notdir $$($1_VERSIONINFO_RESOURCE))$$$$" || test "$$$$?" = "1" ; \
885 $(ECHO) $$($1_RES): \\ > $$($1_RES_DEPS_FILE) ; \
886 $(SED) $(WINDOWS_SHOWINCLUDE_SED_PATTERN) $$($1_RES_DEPS_FILE).obj.log \
887 >> $$($1_RES_DEPS_FILE) ; \
888 $(ECHO) >> $$($1_RES_DEPS_FILE) ;\
889 $(SED) $(DEPENDENCY_TARGET_SED_PATTERN) $$($1_RES_DEPS_FILE) \
890 > $$($1_RES_DEPS_TARGETS_FILE)
891 endif
892 endif
893
894 # Create a rule to collect all the individual make dependency files into a
895 # single makefile.
896 $1_DEPS_FILE := $$($1_OBJECT_DIR)/$1.d
897
898 $$($1_DEPS_FILE): $$($1_ALL_OBJS) $$($1_RES)
899 $(RM) $$@
900 # CD into dir to reduce risk of hitting command length limits, which
901 # could otherwise happen if TOPDIR is a very long path.
902 $(CD) $$($1_OBJECT_DIR) && $(CAT) *.d > $$@.tmp
903 $(CD) $$($1_OBJECT_DIR) && $(CAT) *.d.targets | $(SORT) -u >> $$@.tmp
904 # After generating the file, which happens after all objects have been
905 # compiled, copy it to .old extension. On the next make invocation, this
906 # .old file will be included by make.
907 $(CP) $$@.tmp $$@.old
908 $(MV) $$@.tmp $$@
909
910 $1 += $$($1_DEPS_FILE)
911
912 # The include must be on the .old file, which represents the state from the
913 # previous invocation of make. The file being included must not have a rule
914 # defined for it as otherwise make will think it has to run the rule before
915 # being able to include the file, which would be wrong since we specifically
916 # need the file as it was generated by a previous make invocation.
917 ifneq ($$(wildcard $$($1_DEPS_FILE).old), )
918 $1_DEPS_FILE_LOADED := true
919 -include $$($1_DEPS_FILE).old
920 endif
921
922 ifneq ($(DISABLE_MAPFILES), true)
923 $1_REAL_MAPFILE := $$($1_MAPFILE)
924 endif
925
926 # Pickup extra OPENJDK_TARGET_OS_TYPE and/or OPENJDK_TARGET_OS dependent variables
927 # for LDFLAGS and LIBS
928 $1_EXTRA_LDFLAGS += $$($1_LDFLAGS_$(OPENJDK_TARGET_OS_TYPE)) $$($1_LDFLAGS_$(OPENJDK_TARGET_OS))
929 $1_EXTRA_LIBS += $$($1_LIBS_$(OPENJDK_TARGET_OS_TYPE)) $$($1_LIBS_$(OPENJDK_TARGET_OS))
930 ifneq ($$($1_REAL_MAPFILE), )
931 $1_EXTRA_LDFLAGS += $(call SET_SHARED_LIBRARY_MAPFILE,$$($1_REAL_MAPFILE))
932 endif
933
934 ifneq ($$($1_COPY_DEBUG_SYMBOLS), false)
935 $1_COPY_DEBUG_SYMBOLS := $(COPY_DEBUG_SYMBOLS)
936 endif
937
938 ifneq ($$($1_ZIP_EXTERNAL_DEBUG_SYMBOLS), false)
939 $1_ZIP_EXTERNAL_DEBUG_SYMBOLS := $(ZIP_EXTERNAL_DEBUG_SYMBOLS)
940 endif
941
942 ifeq ($$($1_COPY_DEBUG_SYMBOLS), true)
943 ifneq ($$($1_DEBUG_SYMBOLS), false)
944 $$(call SetIfEmpty, $1_SYMBOLS_DIR, $$($1_OUTPUT_DIR))
945 # Only copy debug symbols for dynamic libraries and programs.
946 ifneq ($$($1_TYPE), STATIC_LIBRARY)
947 # Generate debuginfo files.
948 ifeq ($(call isTargetOs, windows), true)
949 $1_EXTRA_LDFLAGS += -debug "-pdb:$$($1_SYMBOLS_DIR)/$$($1_NOSUFFIX).pdb" \
950 "-map:$$($1_SYMBOLS_DIR)/$$($1_NOSUFFIX).map"
951 ifeq ($(SHIP_DEBUG_SYMBOLS), public)
952 $1_EXTRA_LDFLAGS += "-pdbstripped:$$($1_SYMBOLS_DIR)/$$($1_NOSUFFIX).stripped.pdb"
953 endif
954 $1_DEBUGINFO_FILES := $$($1_SYMBOLS_DIR)/$$($1_NOSUFFIX).pdb \
955 $$($1_SYMBOLS_DIR)/$$($1_NOSUFFIX).map
956
957 else ifeq ($(call isTargetOs, linux), true)
958 $1_DEBUGINFO_FILES := $$($1_SYMBOLS_DIR)/$$($1_NOSUFFIX).debuginfo
959 # Setup the command line creating debuginfo files, to be run after linking.
960 # It cannot be run separately since it updates the original target file
961 $1_CREATE_DEBUGINFO_CMDS := \
962 $$($1_OBJCOPY) --only-keep-debug $$($1_TARGET) $$($1_DEBUGINFO_FILES) $$(NEWLINE) \
963 $(CD) $$($1_SYMBOLS_DIR) && \
964 $$($1_OBJCOPY) --add-gnu-debuglink=$$($1_DEBUGINFO_FILES) $$($1_TARGET)
965
966 else ifeq ($(call isTargetOs, macosx), true)
967 $1_DEBUGINFO_FILES := \
968 $$($1_SYMBOLS_DIR)/$$($1_BASENAME).dSYM/Contents/Info.plist \
969 $$($1_SYMBOLS_DIR)/$$($1_BASENAME).dSYM/Contents/Resources/DWARF/$$($1_BASENAME)
970 $1_CREATE_DEBUGINFO_CMDS := \
971 $(DSYMUTIL) --out $$($1_SYMBOLS_DIR)/$$($1_BASENAME).dSYM $$($1_TARGET)
972 endif
973
974 # Since the link rule creates more than one file that we want to track,
975 # we have to use some tricks to get make to cooperate. To properly
976 # trigger downstream dependants of $$($1_DEBUGINFO_FILES), we must have
977 # a recipe in the rule below. To avoid rerunning the recipe every time
978 # have it touch the target. If a debuginfo file is deleted by something
979 # external, explicitly delete the TARGET to trigger a rebuild of both.
980 ifneq ($$(wildcard $$($1_DEBUGINFO_FILES)), $$($1_DEBUGINFO_FILES))
981 $$(call LogDebug, Deleting $$($1_BASENAME) because debuginfo files are missing)
982 $$(shell $(RM) $$($1_TARGET))
983 endif
984 $$($1_DEBUGINFO_FILES): $$($1_TARGET)
985 $$(if $$(CORRECT_FUNCTION_IN_RECIPE_EVALUATION), \
986 $$(if $$(wildcard $$@), , $$(error $$@ was not created for $$<)) \
987 )
988 $(TOUCH) $$@
989
990 $1 += $$($1_DEBUGINFO_FILES)
991
992 ifeq ($$($1_ZIP_EXTERNAL_DEBUG_SYMBOLS), true)
993 $1_DEBUGINFO_ZIP := $$($1_SYMBOLS_DIR)/$$($1_NOSUFFIX).diz
994 $1 += $$($1_DEBUGINFO_ZIP)
995
996 # The dependency on TARGET is needed for debuginfo files
997 # to be rebuilt properly.
998 $$($1_DEBUGINFO_ZIP): $$($1_DEBUGINFO_FILES) $$($1_TARGET)
999 $(CD) $$($1_SYMBOLS_DIR) && \
1000 $(ZIPEXE) -q -r $$@ $$(subst $$($1_SYMBOLS_DIR)/,, $$($1_DEBUGINFO_FILES))
1001
1002 endif
1003 endif # !STATIC_LIBRARY
1004 endif # $1_DEBUG_SYMBOLS != false
1005 endif # COPY_DEBUG_SYMBOLS
1006
1007 # Unless specifically set, stripping should only happen if symbols are also
1008 # being copied.
1009 $$(call SetIfEmpty, $1_STRIP_SYMBOLS, $$($1_COPY_DEBUG_SYMBOLS))
1010
1011 ifneq ($$($1_STRIP_SYMBOLS), false)
1012 ifneq ($$($1_STRIP), )
1013 # Default to using the global STRIPFLAGS. Allow for overriding with an empty value
1014 $1_STRIPFLAGS ?= $(STRIPFLAGS)
1015 $1_STRIP_CMD := $$($1_STRIP) $$($1_STRIPFLAGS) $$($1_TARGET)
1016 endif
1017 endif
1018
1019 ifeq ($$($1_TYPE), STATIC_LIBRARY)
1020 $1_VARDEPS := $$($1_AR) $$(ARFLAGS) $$($1_ARFLAGS) $$($1_LIBS) \
1021 $$($1_EXTRA_LIBS)
1022 $1_VARDEPS_FILE := $$(call DependOnVariable, $1_VARDEPS, \
1023 $$($1_OBJECT_DIR)/$$($1_NOSUFFIX).vardeps)
1024
1025 # Generating a static library, ie object file archive.
1026 ifeq ($(STATIC_BUILD), true)
1027 ifeq ($$($1_USE_MAPFILE_FOR_SYMBOLS), true)
1028 STATIC_MAPFILE_DEP := $$($1_MAPFILE)
1029 endif
1030 endif
1031
1032 $1_TARGET_DEPS := $$($1_ALL_OBJS) $$($1_RES) $$($1_VARDEPS_FILE) $$(STATIC_MAPFILE_DEP)
1033
1034 $$($1_TARGET): $$($1_TARGET_DEPS)
1035 $$(call LogInfo, Building static library $$($1_BASENAME))
1036 $$(call MakeDir, $$($1_OUTPUT_DIR) $$($1_SYMBOLS_DIR))
1037 $$(call ExecuteWithLog, $$($1_OBJECT_DIR)/$$($1_SAFE_NAME)_link, \
1038 $$($1_AR) $$(ARFLAGS) $$($1_ARFLAGS) $(AR_OUT_OPTION)$$($1_TARGET) $$($1_ALL_OBJS) \
1039 $$($1_RES))
1040 ifeq ($(STATIC_BUILD), true)
1041 ifeq ($$($1_USE_MAPFILE_FOR_SYMBOLS), true)
1042 $(CP) $$($1_MAPFILE) $$(@D)/$$(basename $$(@F)).symbols
1043 else
1044 $(GetSymbols)
1045 endif
1046 endif
1047 else
1048 # A shared dynamic library or an executable binary has been specified
1049 ifeq ($$($1_TYPE), LIBRARY)
1050 # Generating a dynamic library.
1051 $1_EXTRA_LDFLAGS += $$(call SET_SHARED_LIBRARY_NAME,$$($1_BASENAME))
1052
1053 # Create loadmap on AIX. Helps in diagnosing some problems.
1054 ifneq ($(COMPILER_BINDCMD_FILE_FLAG), )
1055 $1_EXTRA_LDFLAGS += $(COMPILER_BINDCMD_FILE_FLAG)$$($1_OBJECT_DIR)/$$($1_NOSUFFIX).loadmap
1056 endif
1057 endif
1058
1059 ifeq ($(call isTargetOs, windows), true)
1060 ifeq ($$($1_EMBED_MANIFEST), true)
1061 $1_EXTRA_LDFLAGS += -manifest:embed
1062 endif
1063
1064 $1_IMPORT_LIBRARY := $$($1_OBJECT_DIR)/$$($1_NAME).lib
1065 $1_EXTRA_LDFLAGS += "-implib:$$($1_IMPORT_LIBRARY)"
1066 ifeq ($$($1_TYPE), LIBRARY)
1067 # To properly trigger downstream dependants of the import library, just as
1068 # for debug files, we must have a recipe in the rule. To avoid rerunning
1069 # the recipe every time have it touch the target. If an import library
1070 # file is deleted by something external, explicitly delete the target to
1071 # trigger a rebuild of both.
1072 ifneq ($$(wildcard $$($1_IMPORT_LIBRARY)), $$($1_IMPORT_LIBRARY))
1073 $$(call LogDebug, Deleting $$($1_BASENAME) because import library is missing)
1074 $$(shell $(RM) $$($1_TARGET))
1075 endif
1076 $$($1_IMPORT_LIBRARY): $$($1_TARGET)
1077 $(TOUCH) $$@
1078
1079 $1 += $$($1_IMPORT_LIBRARY)
1080 endif
1081 endif
1082
1083 $1_VARDEPS := $$($1_LD) $$($1_SYSROOT_LDFLAGS) $$($1_LDFLAGS) $$($1_EXTRA_LDFLAGS) \
1084 $$($1_LIBS) $$($1_EXTRA_LIBS) $$($1_MT) \
1085 $$($1_CREATE_DEBUGINFO_CMDS) $$($1_MANIFEST_VERSION) \
1086 $$($1_STRIP_CMD)
1087 $1_VARDEPS_FILE := $$(call DependOnVariable, $1_VARDEPS, \
1088 $$($1_OBJECT_DIR)/$$($1_NOSUFFIX).vardeps)
1089
1090 $1_LD_OBJ_ARG := $$($1_ALL_OBJS)
1091
1092 # If there are many object files, use an @-file...
1093 ifneq ($$(word 17, $$($1_ALL_OBJS)), )
1094 $1_OBJ_FILE_LIST := $$($1_OBJECT_DIR)/_$1_objectfilenames.txt
1095 ifneq ($(COMPILER_COMMAND_FILE_FLAG), )
1096 $1_LD_OBJ_ARG := $(COMPILER_COMMAND_FILE_FLAG)$$($1_OBJ_FILE_LIST)
1097 else
1098 # ...except for toolchains which don't support them.
1099 $1_LD_OBJ_ARG := `cat $$($1_OBJ_FILE_LIST)`
1100 endif
1101 endif
1102
1103 # Unfortunately the @-file trick does not work reliably when using clang.
1104 # Clang does not propagate the @-file parameter to the ld sub process, but
1105 # instead puts the full content on the command line. At least the llvm ld
1106 # does not even support an @-file.
1107 #
1108 # When linking a large amount of object files, we risk hitting the limit
1109 # of the command line length even on posix systems if the path length of
1110 # the output dir is very long due to our use of absolute paths. To
1111 # mitigate this, use paths relative to the output dir when linking over
1112 # 500 files with clang and the output dir path is deep.
1113 ifneq ($$(word 500, $$($1_ALL_OBJS)), )
1114 ifeq ($$(TOOLCHAIN_TYPE), clang)
1115 # There is no strlen function in make, but checking path depth is a
1116 # reasonable approximation.
1117 ifneq ($$(word 10, $$(subst /, ,$$(OUTPUTDIR))), )
1118 $1_LINK_OBJS_RELATIVE := true
1119 $1_ALL_OBJS_RELATIVE := $$(patsubst $$(OUTPUTDIR)/%, %, $$($1_ALL_OBJS))
1120 endif
1121 endif
1122 endif
1123
1124 $1_TARGET_DEPS := $$($1_ALL_OBJS) $$($1_RES) $$($1_MANIFEST) \
1125 $$($1_REAL_MAPFILE) $$($1_VARDEPS_FILE)
1126
1127 $$($1_TARGET): $$($1_TARGET_DEPS)
1128 ifneq ($$($1_OBJ_FILE_LIST), )
1129 ifeq ($$($1_LINK_OBJS_RELATIVE), true)
1130 $$(eval $$(call ListPathsSafely, $1_ALL_OBJS_RELATIVE, $$($1_OBJ_FILE_LIST)))
1131 else
1132 $$(eval $$(call ListPathsSafely, $1_ALL_OBJS, $$($1_OBJ_FILE_LIST)))
1133 endif
1134 endif
1135 # Keep as much as possible on one execution line for best performance
1136 # on Windows
1137 $$(call LogInfo, Linking $$($1_BASENAME))
1138 $$(call MakeDir, $$($1_OUTPUT_DIR) $$($1_SYMBOLS_DIR))
1139 ifeq ($(call isTargetOs, windows), true)
1140
1141 $$(call ExecuteWithLog, $$($1_OBJECT_DIR)/$$($1_SAFE_NAME)_link, \
1142 $$($1_LD) $$($1_LDFLAGS) $$($1_EXTRA_LDFLAGS) $$($1_SYSROOT_LDFLAGS) \
1143 $(LD_OUT_OPTION)$$($1_TARGET) $$($1_LD_OBJ_ARG) $$($1_RES) \
1144 $$($1_LIBS) $$($1_EXTRA_LIBS)) \
1145 | $(GREP) -v "^ Creating library .*\.lib and object .*\.exp" || \
1146 test "$$$$?" = "1" ; \
1147 $$($1_CREATE_DEBUGINFO_CMDS)
1148 $$($1_STRIP_CMD)
1149 else
1150 $$(call ExecuteWithLog, $$($1_OBJECT_DIR)/$$($1_SAFE_NAME)_link, \
1151 $$(if $$($1_LINK_OBJS_RELATIVE), $$(CD) $$(OUTPUTDIR) ; ) \
1152 $$($1_LD) $$($1_LDFLAGS) $$($1_EXTRA_LDFLAGS) $$($1_SYSROOT_LDFLAGS) \
1153 $(LD_OUT_OPTION)$$($1_TARGET) $$($1_LD_OBJ_ARG) $$($1_RES) \
1154 $$($1_LIBS) $$($1_EXTRA_LIBS)) ; \
1155 $$($1_CREATE_DEBUGINFO_CMDS)
1156 $$($1_STRIP_CMD)
1157 endif
1158 ifeq ($(call isTargetOs, windows), true)
1159 ifneq ($$($1_MANIFEST), )
1160 $$($1_MT) -nologo -manifest $$($1_MANIFEST) -identity:"$$($1_NAME).exe, version=$$($1_MANIFEST_VERSION)" -outputresource:$$@;#1
1161 endif
1162 endif
1163 # This only works if the openjdk_codesign identity is present on the system. Let
1164 # silently fail otherwise.
1165 ifneq ($(CODESIGN), )
1166 $(CODESIGN) -s "$(MACOSX_CODESIGN_IDENTITY)" --timestamp --options runtime \
1167 --entitlements $$(call GetEntitlementsFile, $$@) $$@
1168 endif
1169 endif
1170
1171 ifeq ($(GENERATE_COMPILE_COMMANDS_ONLY), true)
1172 $1 := $$($1_ALL_OBJS_JSON)
1173 endif
1174 endef
1175
1176 endif # _NATIVE_COMPILATION_GMK