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