1 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 # Use of this source code is governed by a BSD-style license that can be
3 # found in the LICENSE file.
6 # GNU Make based build file. For details on GNU Make see:
7 # http://www.gnu.org/software/make/manual/make.html
13 # By default the VALID_TOOLCHAINS list contains pnacl, newlib and glibc. If
14 # your project only builds in one or the other then this should be overridden
17 ifneq ($(ENABLE_BIONIC),)
18 ALL_TOOLCHAINS ?= pnacl newlib glibc bionic
20 ALL_TOOLCHAINS ?= pnacl newlib glibc
23 VALID_TOOLCHAINS ?= $(ALL_TOOLCHAINS)
24 TOOLCHAIN ?= $(word 1,$(VALID_TOOLCHAINS))
27 # Top Make file, which we want to trigger a rebuild on if it changes
29 TOP_MAKE := $(word 1,$(MAKEFILE_LIST))
33 # Figure out which OS we are running on.
35 GETOS := python $(NACL_SDK_ROOT)/tools/getos.py
36 NACL_CONFIG := python $(NACL_SDK_ROOT)/tools/nacl_config.py
37 FIXDEPS := python $(NACL_SDK_ROOT)/tools/fix_deps.py -c
38 OSNAME := $(shell $(GETOS))
42 # TOOLCHAIN=all recursively calls this Makefile for all VALID_TOOLCHAINS.
44 ifeq ($(TOOLCHAIN),all)
46 # Define the default target
50 # Generate a new MAKE command for each TOOLCHAIN.
52 # Note: We use targets for each toolchain (instead of an explicit recipe) so
53 # each toolchain can be built in parallel.
58 TOOLCHAIN_TARGETS += $(1)_TARGET
61 +$(MAKE) TOOLCHAIN=$(1) $(MAKECMDGOALS)
65 # The target for all versions
67 USABLE_TOOLCHAINS=$(filter $(OSNAME) $(ALL_TOOLCHAINS),$(VALID_TOOLCHAINS))
69 ifeq ($(NO_HOST_BUILDS),1)
70 USABLE_TOOLCHAINS:=$(filter-out $(OSNAME),$(USABLE_TOOLCHAINS))
73 # Define the toolchain targets for all usable toolchains via the macro.
74 $(foreach tool,$(USABLE_TOOLCHAINS),$(eval $(call TOOLCHAIN_RULE,$(tool))))
76 .PHONY: all clean install
77 all: $(TOOLCHAIN_TARGETS)
78 clean: $(TOOLCHAIN_TARGETS)
79 install: $(TOOLCHAIN_TARGETS)
84 # Verify we selected a valid toolchain for this example
86 ifeq (,$(findstring $(TOOLCHAIN),$(VALID_TOOLCHAINS)))
88 # Only fail to build if this is a top-level make. When building recursively, we
89 # don't care if an example can't build with this toolchain.
91 $(warning Availbile choices are: $(VALID_TOOLCHAINS))
92 $(error Can not use TOOLCHAIN=$(TOOLCHAIN) on this example.)
95 # Dummy targets for recursive make with unsupported toolchain...
96 .PHONY: all clean install
103 else # TOOLCHAIN is valid...
106 # Build Configuration
108 # The SDK provides two sets of libraries, Debug and Release. Debug libraries
109 # are compiled without optimizations to make debugging easier. By default
110 # this will build a Release configuration. When debugging via "make debug",
111 # build the debug configuration by default instead.
113 ifneq (,$(findstring debug,$(MAKECMDGOALS)))
121 # Verify we selected a valid configuration for this example.
123 VALID_CONFIGS ?= Debug Release
124 ifeq (,$(findstring $(CONFIG),$(VALID_CONFIGS)))
125 $(warning Availbile choices are: $(VALID_CONFIGS))
126 $(error Can not use CONFIG=$(CONFIG) on this example.)
132 # The GCC and LLVM toolchains (include the version of Make.exe that comes
133 # with the SDK) expect and are capable of dealing with the '/' seperator.
134 # For this reason, the tools in the SDK, including Makefiles and build scripts
135 # have a preference for POSIX style command-line arguments.
137 # Keep in mind however that the shell is responsible for command-line escaping,
138 # globbing, and variable expansion, so those may change based on which shell
139 # is used. For Cygwin shells this can include automatic and incorrect expansion
140 # of response files (files starting with '@').
142 # Disable DOS PATH warning when using Cygwin based NaCl tools on Windows.
145 CYGWIN?=nodosfilewarning
151 # If NACL_SDK_ROOT is not already set, then set it relative to this makefile.
153 THIS_MAKEFILE := $(CURDIR)/$(lastword $(MAKEFILE_LIST))
154 NACL_SDK_ROOT ?= $(realpath $(dir $(THIS_MAKEFILE))/..)
158 # Check that NACL_SDK_ROOT is set to a valid location.
159 # We use the existence of tools/oshelpers.py to verify the validity of the SDK
162 ifeq (,$(wildcard $(NACL_SDK_ROOT)/tools/oshelpers.py))
163 $(error NACL_SDK_ROOT is set to an invalid location: $(NACL_SDK_ROOT))
168 # If this makefile is part of a valid nacl SDK, but NACL_SDK_ROOT is set
169 # to a different location this is almost certainly a local configuration
172 LOCAL_ROOT := $(realpath $(dir $(THIS_MAKEFILE))/..)
173 ifneq (,$(wildcard $(LOCAL_ROOT)/tools/oshelpers.py))
174 ifneq ($(realpath $(NACL_SDK_ROOT)), $(realpath $(LOCAL_ROOT)))
175 $(error common.mk included from an SDK that does not match the current NACL_SDK_ROOT)
181 # Alias for standard POSIX file system commands
183 OSHELPERS = python $(NACL_SDK_ROOT)/tools/oshelpers.py
184 WHICH := $(OSHELPERS) which
186 RM := $(OSHELPERS) rm
187 CP := $(OSHELPERS) cp
188 MKDIR := $(OSHELPERS) mkdir
189 MV := $(OSHELPERS) mv
191 RM := @$(OSHELPERS) rm
192 CP := @$(OSHELPERS) cp
193 MKDIR := @$(OSHELPERS) mkdir
194 MV := @$(OSHELPERS) mv
200 # Compute path to requested NaCl Toolchain
202 TC_PATH := $(abspath $(NACL_SDK_ROOT)/toolchain)
206 # Check for required minimum SDK version.
208 ifdef NACL_SDK_VERSION_MIN
209 VERSION_CHECK:=$(shell $(GETOS) --check-version=$(NACL_SDK_VERSION_MIN) 2>&1)
210 ifneq ($(VERSION_CHECK),)
211 $(error $(VERSION_CHECK))
219 # If no targets are specified on the command-line, the first target listed in
220 # the makefile becomes the default target. By convention this is usually called
221 # the 'all' target. Here we leave it blank to be first, but define it later
228 # The install target is used to install built libraries to thier final destination.
229 # By default this is the NaCl SDK 'lib' folder.
240 OUTDIR := $(OUTBASE)/$(TOOLCHAIN)/standalone_$(CONFIG)
242 OUTDIR := $(OUTBASE)/$(TOOLCHAIN)/$(CONFIG)
244 STAMPDIR ?= $(OUTDIR)
245 LIBDIR ?= $(NACL_SDK_ROOT)/lib
249 # Target to remove temporary files
253 $(RM) -f $(TARGET).nmf
255 $(RM) -rf user-data-dir
259 # Rules for output directories.
261 # Output will be places in a directory name based on Toolchain and configuration
262 # be default this will be "newlib/Debug". We use a python wrapped MKDIR to
263 # proivde a cross platform solution. The use of '|' checks for existance instead
264 # of timestamp, since the directory can update when files change.
267 $(MKDIR) -p $(dir $@)
268 @echo Directory Stamp > $@
275 # $2 = Directory for the sub-make
276 # $3 = Extra Settings
282 rebuild_$(1) :| $(STAMPDIR)/dir.stamp
284 +$(MAKE) -C $(NACL_SDK_ROOT)/src/$(1) STAMPDIR=$(abspath $(STAMPDIR)) $(abspath $(STAMPDIR)/$(1).stamp) $(3)
286 +$(MAKE) -C $(2) STAMPDIR=$(abspath $(STAMPDIR)) $(abspath $(STAMPDIR)/$(1).stamp) $(3)
290 $(STAMPDIR)/$(1).stamp: rebuild_$(1)
294 .PHONY: $(STAMPDIR)/$(1).stamp
295 $(STAMPDIR)/$(1).stamp:
300 ifeq ($(TOOLCHAIN),win)
316 # Common Compile Options
318 # For example, -DNDEBUG is added to release builds by default
319 # so that calls to assert(3) are not included in the build.
321 ifeq ($(CONFIG),Release)
322 POSIX_FLAGS ?= -g -O2 -pthread -MMD -DNDEBUG
326 POSIX_FLAGS ?= -g -O0 -pthread -MMD -DNACL_SDK_DEBUG
330 POSIX_FLAGS += -DSEL_LDR=1
333 NACL_CFLAGS ?= -Wno-long-long -Werror
334 NACL_CXXFLAGS ?= -Wno-long-long -Werror
335 NACL_LDFLAGS += -Wl,-as-needed -pthread
340 INC_PATHS := $(shell $(NACL_CONFIG) -t $(TOOLCHAIN) --include-dirs) $(EXTRA_INC_PATHS)
341 LIB_PATHS := $(NACL_SDK_ROOT)/lib $(EXTRA_LIB_PATHS)
344 # Define a LOG macro that allow a command to be run in quiet mode where
345 # the command echoed is not the same as the actual command executed.
346 # The primary use case for this is to avoid echoing the full compiler
347 # and linker command in the default case. Defining V=1 will restore
348 # the verbose behavior
350 # $1 = The name of the tool being run
351 # $2 = The target file being built
352 # $3 = The full command to run
361 @echo $(1) $(2) && $(3)
365 @echo " $(1) $(2)" && $(3)
372 # Convert a source path to a object file path.
378 $(OUTDIR)/$(basename $(subst ..,__,$(1)))$(2).o
383 # Convert a source path to a dependency file path.
384 # We use the .deps extension for dependencies. These files are generated by
385 # fix_deps.py based on the .d files which gcc generates. We don't reference
386 # the .d files directly so that we can avoid the the case where the compile
387 # failed but still generated a .d file (in that case the .d file would not
388 # be processed by fix_deps.py)
394 $(patsubst %.o,%.deps,$(call SRC_TO_OBJ,$(1),$(2)))
398 # The gcc-generated deps files end in .d
400 define SRC_TO_DEP_PRE_FIXUP
401 $(patsubst %.o,%.d,$(call SRC_TO_OBJ,$(1),$(2)))
406 # If the requested toolchain is a NaCl or PNaCl toolchain, the use the
407 # macros and targets defined in nacl.mk, otherwise use the host sepecific
408 # macros and targets.
410 ifneq (,$(findstring $(TOOLCHAIN),linux mac))
411 include $(NACL_SDK_ROOT)/tools/host_gcc.mk
414 ifneq (,$(findstring $(TOOLCHAIN),win))
415 include $(NACL_SDK_ROOT)/tools/host_vc.mk
418 ifneq (,$(findstring $(TOOLCHAIN),glibc newlib bionic))
419 include $(NACL_SDK_ROOT)/tools/nacl_gcc.mk
422 ifneq (,$(findstring $(TOOLCHAIN),pnacl))
423 include $(NACL_SDK_ROOT)/tools/nacl_llvm.mk
427 # File to redirect to to in order to hide output.
437 # Variables for running examples with Chrome.
439 RUN_PY := python $(NACL_SDK_ROOT)/tools/run.py
440 HTTPD_PY := python $(NACL_SDK_ROOT)/tools/httpd.py
442 # Add this to launch Chrome with additional environment variables defined.
443 # Each element should be specified as KEY=VALUE, with whitespace separating
444 # key-value pairs. e.g.
445 # CHROME_ENV=FOO=1 BAR=2 BAZ=3
448 # Additional arguments to pass to Chrome.
449 CHROME_ARGS += --enable-nacl --enable-pnacl --no-first-run
450 CHROME_ARGS += --user-data-dir=$(CURDIR)/user-data-dir
453 # Paths to Debug and Release versions of the Host Pepper plugins
454 PPAPI_DEBUG = $(abspath $(OSNAME)/Debug/$(TARGET)$(HOST_EXT));application/x-ppapi-debug
455 PPAPI_RELEASE = $(abspath $(OSNAME)/Release/$(TARGET)$(HOST_EXT));application/x-ppapi-release
458 SYSARCH := $(shell $(GETOS) --nacl-arch)
459 SEL_LDR_PATH := python $(NACL_SDK_ROOT)/tools/sel_ldr.py
462 # Common Compile Options
464 ifeq ($(CONFIG),Debug)
465 SEL_LDR_ARGS += --debug-libs
470 # Assign a sensible default to CHROME_PATH.
472 CHROME_PATH ?= $(shell $(GETOS) --chrome 2> $(DEV_NULL))
475 # Verify we can find the Chrome executable if we need to launch it.
479 SPACE := $(NULL) # one space after NULL is required
480 CHROME_PATH_ESCAPE := $(subst $(SPACE),\ ,$(CHROME_PATH))
481 GDB_PATH := $(shell $(NACL_CONFIG) -t $(TOOLCHAIN) --tool=gdb)
483 .PHONY: check_for_chrome
485 ifeq (,$(wildcard $(CHROME_PATH_ESCAPE)))
486 $(warning No valid Chrome found at CHROME_PATH=$(CHROME_PATH))
487 $(error Set CHROME_PATH via an environment variable, or command-line.)
489 $(warning Using chrome at: $(CHROME_PATH))
492 PAGE_TC_CONFIG ?= "$(PAGE)?tc=$(TOOLCHAIN)&config=$(CONFIG)"
495 run: check_for_chrome all $(PAGE)
496 $(RUN_PY) -C $(CURDIR) -P $(PAGE_TC_CONFIG) \
497 $(addprefix -E ,$(CHROME_ENV)) -- $(CHROME_PATH_ESCAPE) \
498 $(CHROME_ARGS) --no-sandbox \
499 --register-pepper-plugins="$(PPAPI_DEBUG),$(PPAPI_RELEASE)"
502 run_package: check_for_chrome all
503 @echo "$(TOOLCHAIN) $(CONFIG)" > $(CURDIR)/run_package_config
504 $(CHROME_PATH_ESCAPE) --load-and-launch-app=$(CURDIR) $(CHROME_ARGS)
506 GDB_ARGS += -D $(GDB_PATH)
507 # PNaCl's nexe is acquired with "remote get nexe <path>" instead of the NMF.
508 ifeq (,$(findstring $(TOOLCHAIN),pnacl))
509 GDB_ARGS += -D --eval-command="nacl-manifest $(abspath $(OUTDIR))/$(TARGET).nmf"
510 GDB_ARGS += -D $(GDB_DEBUG_TARGET)
514 debug: check_for_chrome all $(PAGE)
515 $(RUN_PY) $(GDB_ARGS) \
516 -C $(CURDIR) -P $(PAGE_TC_CONFIG) \
517 $(addprefix -E ,$(CHROME_ENV)) -- $(CHROME_PATH_ESCAPE) \
518 $(CHROME_ARGS) --enable-nacl-debug \
519 --register-pepper-plugins="$(PPAPI_DEBUG),$(PPAPI_RELEASE)"
523 $(HTTPD_PY) -C $(CURDIR)
526 # uppercase aliases (for backward compatibility)
527 .PHONY: CHECK_FOR_CHROME DEBUG LAUNCH RUN
528 CHECK_FOR_CHROME: check_for_chrome
533 endif # TOOLCHAIN is valid...
535 endif # TOOLCHAIN=all