Context Navigation

header.kmk@ 3632

Last change on this file since 3632 was 3632, checked in by bird, 9 months ago
header.kmk: Added KB_FN_LOAD_TOOL and KB_FN_LOAD_SDK for explictly loading a tool or an sdk implementation.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 57.1 KB

Line
1	# $Id: header.kmk 3632 2024-10-25 23:26:28Z bird $
2	## @file
3	# kBuild - File included at top of a makefile.
4	#
5
6	#
7	# Copyright (c) 2004-2017 knut st. osmundsen <bird-kBuild-spam-xviiv@anduin.net>
8	#
9	# This file is part of kBuild.
10	#
11	# kBuild is free software; you can redistribute it and/or modify
12	# it under the terms of the GNU General Public License as published by
13	# the Free Software Foundation; either version 2 of the License, or
14	# (at your option) any later version.
15	#
16	# kBuild is distributed in the hope that it will be useful,
17	# but WITHOUT ANY WARRANTY; without even the implied warranty of
18	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19	# GNU General Public License for more details.
20	#
21	# You should have received a copy of the GNU General Public License
22	# along with kBuild; if not, write to the Free Software
23	# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24	#
25	#
26	# As a special exception you are granted permission to include this file, via
27	# the kmk include directive, as you wish without this in itself causing the
28	# resulting makefile, program or whatever to be covered by the GPL license.
29	# This exception does not however invalidate any other reasons why the makefile,
30	# program, whatever should not be covered the GPL.
31	#
32	#
33
34	ifndef __header_kmk__
35	# start-of-file-content
36	ifdef KBUILD_PROFILE_SELF
37	_KBUILD_TS_HEADER_START := $(nanots ) # just a dummy warm up query
38	$(info prof: since start - since previous -- event description)
39	ifeq ($(KBUILD_PROFILE_SELF),2)
40	$(info stat: $(make-stats ))
41	endif
42	_KBUILD_TS_HEADER_START := $(nanots )
43	_KBUILD_TS_PREV := $(_KBUILD_TS_HEADER_START)
44
45	_KBUILD_FMT_ELAPSED_EX = $(int-div $(int-add $(int-sub $1, $2),500000),1000000)ms
46	_KBUILD_FMT_ELAPSED = $(call _KBUILD_FMT_ELAPSED_EX,$(_KBUILD_TS_NOW),$1)
47
48	define def_profile_self
49	_KBUILD_TS_NOW := $(nanots )
50	$(info prof: $(call _KBUILD_FMT_ELAPSED,$(_KBUILD_TS_HEADER_START)) - $(call _KBUILD_FMT_ELAPSED, $(_KBUILD_TS_PREV)) -- $(strip $1))
51	ifeq ($(KBUILD_PROFILE_SELF),2)
52	$(info stat: $(make-stats ))
53	endif
54	_KBUILD_TS_PREV := $(_KBUILD_TS_NOW)
55	endef
56
57	endif
58
59
60	#
61	# Check make version before we do anything else.
62	#
63	ifndef KMK_VERSION
64	$(error kBuild: The kmk default variable KMK_VERSION isn't defined! Make sure you are using 'kmk' and not 'make', 'gmake', 'kmk_gmake', 'dmake' or any other make program)
65	endif
66	ifneq ($(KBUILD_VERSION_MAJOR).$(KBUILD_VERSION_MINOR),0.1)
67	ifneq ($(KBUILD_VERSION_MAJOR),0)
68	$(warning kBuild: kmk major version mismatch! Expected '0' but found '$(KBUILD_VERSION_MAJOR)'!)
69	else
70	$(warning kBuild: kmk minor version mismatch! Expected '1' but found '$(KBUILD_VERSION_MINOR)'!)
71	endif
72	else
73	if $(KBUILD_VERSION_PATCH) < 999
74	$(error kBuild: kmk version mismatch! Expected 0.1.999 or later. Actual version is $(KBUILD_VERSION).)
75	endif
76	endif
77
78	#
79	# The revision in which this file was last modified.
80	# This can be useful when using development versions of kBuild.
81	#
82	KMK_REVISION := $(patsubst %:,, $Rev: 3632 $ )
83
84
85	#
86	# Define the default goal.
87	#
88	.PHONY: all all_recursive
89	all: all_recursive
90
91	#
92	# The phony FORCE target.
93	#
94	.PHONY: FORCE
95	FORCE:
96
97
98	#
99	# Enable delete on error and second expansion of prerequisites and targets.
100	#
101	.DELETE_ON_ERROR:
102
103	.SECONDEXPANSION:
104
105	.SECONDTARGETEXPANSION:
106
107
108	#
109	# General purpose macros.
110	#
111
112	##
113	# Newline character(s).
114	define NL
115
116
117	endef
118
119	##
120	# Tab character.
121	TAB := $(subst ., ,.)
122
123	##
124	# Newline + tab characters (for generating commands).
125	NLTAB = $(NL)$(TAB)
126
127	##
128	# Space character.
129	SP := $(subst ., ,.)
130
131	##
132	# Hash character.
133	define HASH
134	#
135	endef
136
137	##
138	# Colon character.
139	COLON := :
140
141	##
142	# Semicolon character.
143	SEMICOLON := ;
144
145	##
146	# Comma character.
147	COMMA := ,
148
149	##
150	# Dot character.
151	DOT := .
152
153	##
154	# Dollar character.
155	DOLLAR := $$
156
157	##
158	# Equal character.
159	EQUAL := =
160
161	##
162	# Percent character.
163	PERCENT := %
164
165	##
166	# Single quote character.
167	SQUOTE := '
168
169	##
170	# Double quote character.
171	DQUOTE := "
172
173	##
174	# Opening parenthesis.
175	OPENPAR := (
176
177	##
178	# Closing parenthesis.
179	CLOSEPAR := )
180
181
182	#
183	# The list of standard build types in kBuild.
184	#
185	# This list can be extended in Config.kmk and it's possible to extend
186	# (inherit) another build type.
187	#
188	KBUILD_BLD_TYPES := release profile debug
189
190
191	#
192	# The OSes, Architectures and CPUs that kBuild recognizes.
193	#
194	# When kBuild is ported to a new OS or architecture a unique keyword needs
195	# to be assigned to it and added here. This strictness is required because
196	# this keyword namespace is shared between OSes, architectures, cpus and
197	# build types. (PORTME)
198	#
199	KBUILD_OSES := darwin dos dragonfly freebsd gnuhurd gnukfbsd gnuknbsd haiku l4 linux netbsd nt openbsd os2 solaris win os-agnostic
200	KBUILD_ARCHES := x86 amd64 noarch alpha arm32 arm64 hppa32 hppa64 ia64 m68k loongarch64 mips32 mips64 ppc32 ppc64 riscv32 riscv64 s390 s390x sh32 sh64 sparc32 sparc64 x32
201	KBUILD_ARCHES_64 := amd64 alpha arm64 hppa64 ia64 loongarch64 mips64 ppc64 riscv64 s390x sh64 sparc64 x32
202	KBUILD_ARCHES_32 := x86 arm32 hppa32 m68k mips32 ppc32 riscv32 s390 sh32 sparc32
203
204
205
206	#
207	# Mapping of kBuild OS + ARCH to GNU system type wildcards.
208	# For use with the foreach/append/prepend and wildcard functions.
209	#
210	KBUILD_OSARCH_2_GNU_SYSTEM_TYPES.darwin.x86 = i?86-apple-darwin*
211	KBUILD_OSARCH_2_GNU_SYSTEM_TYPES.darwin.amd64 = x86_64-apple-darwin* amd64-apple-darwin*
212	KBUILD_OSARCH_2_GNU_SYSTEM_TYPES.freebsd.x86 = i?86-freebsd
213	KBUILD_OSARCH_2_GNU_SYSTEM_TYPES.freebsd.amd64 = x86_64-freebsd amd64-freebsd
214	KBUILD_OSARCH_2_GNU_SYSTEM_TYPES.linux.x86 = i?86-*linux-gnu
215	KBUILD_OSARCH_2_GNU_SYSTEM_TYPES.linux.amd64 = x86_64-linux-gnu amd64-linux-gnu
216	KBUILD_OSARCH_2_GNU_SYSTEM_TYPES.netbsd.x86 = i?86-netbsd
217	KBUILD_OSARCH_2_GNU_SYSTEM_TYPES.netbsd.amd64 = x86_64-netbsd amd64-netbsd
218	KBUILD_OSARCH_2_GNU_SYSTEM_TYPES.os2.x86 = i?86-os2
219	KBUILD_OSARCH_2_GNU_SYSTEM_TYPES.solaris.x86 = i?86-solaris2
220	KBUILD_OSARCH_2_GNU_SYSTEM_TYPES.solaris.amd64 = amd64-solaris2 x86_64-solaris2
221	KBUILD_OSARCH_2_GNU_SYSTEM_TYPES.solaris.sparc32 = sparc-solaris2
222	KBUILD_OSARCH_2_GNU_SYSTEM_TYPES.solaris.sparc64 = sparc64-solaris2 sparcv9-solaris2
223	KBUILD_OSARCH_2_GNU_SYSTEM_TYPES.win.x86 = i?86-mingw32 i?86-msys i?86-cygwin
224	KBUILD_OSARCH_2_GNU_SYSTEM_TYPES.win.amd64 = x86_64-mingw64 amd64-mingw64 x86_64-msys amd64-msys x86_64-cygwin amd64-cygwin
225
226
227	#
228	# Set default build type.
229	#
230	ifndef KBUILD_TYPE
231	ifdef BUILD_TYPE
232	KBUILD_TYPE := $(BUILD_TYPE)
233	endif
234	else ifdef BUILD_TYPE
235	ifneq ($(KBUILD_TYPE),$(BUILD_TYPE))
236	ifeq ($(origin KBUILD_TYPE):$(origin BUILD_TYPE),environment:command line)
237	$(warning kBuild: Please use KBUILD_TYPE instead of BUILD_TYPE on the command line!)
238	KBUILD_TYPE := $(BUILD_TYPE)
239	else ifneq ($(origin KBUILD_TYPE):$(origin BUILD_TYPE),command line:environment)
240	$(error kBuild: KBUILD_TYPE (command line) and BUILD_TYPE (env) disagree.)
241	endif
242	endif
243	endif
244	override BUILD_TYPE = $(KBUILD_TYPE)
245
246	ifndef KBUILD_TYPE
247	KBUILD_TYPE := release
248	else
249	if1of ($(KBUILD_TYPE), $(KBUILD_OSES) $(KBUILD_ARCHES))
250	$(error kBuild: The KBUILD_TYPE value '$(KBUILD_TYPE)' is an OS or architecture!)
251	endif
252	ifneq (.$(words $(KBUILD_TYPE)).$(KBUILD_TYPE).,.1.$(strip $(KBUILD_TYPE)).)
253	$(error kBuild: The KBUILD_TYPE value '$(KBUILD_TYPE)' contains spaces/tabs!)
254	endif
255	endif
256
257
258	#
259	# Assert valid build platform variables.
260	#
261	# All these are set by kmk so they shouldn't be any trouble
262	# unless the user starts messing about with environment variables.
263	#
264	ifneq (.$(words $(KBUILD_HOST)).$(KBUILD_HOST).,.1.$(strip $(KBUILD_HOST)).)
265	$(error kBuild: The KBUILD_HOST value '$(KBUILD_HOST)' contains spaces/tabs!)
266	endif
267	ifneq ($(words $(filter $(KBUILD_HOST),$(KBUILD_OSES))),1)
268	$(error kBuild: KBUILD_HOST value '$(KBUILD_HOST)' is not recognized (valid: $(KBUILD_OSES)))
269	endif
270
271	ifneq (.$(words $(KBUILD_HOST_ARCH)).$(KBUILD_HOST_ARCH).,.1.$(strip $(KBUILD_HOST_ARCH)).)
272	$(error kBuild: The KBUILD_HOST_ARCH value '$(KBUILD_HOST_ARCH)' contains spaces/tabs!)
273	endif
274	ifneq ($(words $(filter $(KBUILD_HOST_ARCH),$(KBUILD_ARCHES))),1)
275	$(error kBuild: KBUILD_HOST_ARCH value '$(KBUILD_HOST_ARCH)' is not recognized (valid: $(KBUILD_ARCHES)))
276	endif
277
278	ifeq ($(strip $(KBUILD_HOST_CPU)),)
279	KBUILD_HOST_CPU := blend
280	else
281	ifneq (.$(words $(KBUILD_HOST_CPU)).$(KBUILD_HOST_CPU).,.1.$(strip $(KBUILD_HOST_CPU)).)
282	$(error kBuild: The KBUILD_HOST_CPU value '$(KBUILD_HOST_CPU)' contains spaces/tabs!)
283	endif
284	if1of ($(KBUILD_HOST_CPU), $(KBUILD_OSES) $(KBUILD_ARCHES))
285	$(error kBuild: The KBUILD_HOST_CPU value '$(KBUILD_HOST_CPU)' was found in the OS or architecture keywords!)
286	endif
287	ifeq ($(KBUILD_HOST_CPU),$(KBUILD_TYPE))
288	$(error kBuild: The KBUILD_HOST_CPU value '$(KBUILD_HOST_CPU)' is the same as the KBUILD_TYPE!)
289	endif
290	endif
291
292
293	#
294	# Deal with target platform legacy.
295	#
296	ifndef KBUILD_TARGET
297	ifdef BUILD_TARGET
298	KBUILD_TARGET := $(BUILD_TARGET)
299	endif
300	else ifdef BUILD_TARGET
301	ifneq ($(KBUILD_TARGET),$(BUILD_TARGET))
302	ifeq ($(origin KBUILD_TARGET):$(origin BUILD_TARGET),environment:command line)
303	$(warning kBuild: Please use KBUILD_TARGET instead of BUILD_TARGET on the command line!)
304	KBUILD_TARGET := $(BUILD_TARGET)
305	else ifneq ($(origin KBUILD_TARGET):$(origin BUILD_TARGET),command line:environment)
306	$(error kBuild: KBUILD_TARGET and BUILD_TARGET disagree)
307	endif
308	endif
309	endif
310	override BUILD_TARGET = $(KBUILD_TARGET)
311
312	ifndef KBUILD_TARGET_ARCH
313	ifdef BUILD_TARGET_ARCH
314	KBUILD_TARGET_ARCH := $(BUILD_TARGET_ARCH)
315	endif
316	else ifdef BUILD_TARGET_ARCH
317	ifneq ($(KBUILD_TARGET_ARCH),$(BUILD_TARGET_ARCH))
318	ifeq ($(origin KBUILD_TARGET_ARCH):$(origin BUILD_TARGET_ARCH),environment:command line)
319	$(warning kBuild: Please use KBUILD_TARGET_ARCH instead of BUILD_TARGET_ARCH on the command line!)
320	KBUILD_TARGET_ARCH := $(BUILD_TARGET_ARCH)
321	else ifneq ($(origin KBUILD_TARGET_ARCH):$(origin BUILD_TARGET_ARCH),command line:environment)
322	$(error kBuild: KBUILD_TARGET_ARCH and BUILD_TARGET_ARCH disagree)
323	endif
324	endif
325	endif
326	override BUILD_TARGET_ARCH = $(KBUILD_TARGET_ARCH)
327
328	ifndef KBUILD_TARGET_CPU
329	ifdef BUILD_TARGET_CPU
330	KBUILD_TARGET_CPU := $(BUILD_TARGET_CPU)
331	endif
332	else ifdef BUILD_TARGET_CPU
333	ifneq ($(KBUILD_TARGET_CPU),$(BUILD_TARGET_CPU))
334	ifeq ($(origin KBUILD_TARGET_CPU):$(origin BUILD_TARGET_CPU),environment:command line)
335	$(warning kBuild: Please use KBUILD_TARGET_CPU instead of BUILD_TARGET_CPU on the command line!)
336	KBUILD_TARGET_CPU := $(BUILD_TARGET_CPU)
337	else ifneq ($(origin KBUILD_TARGET_CPU):$(origin BUILD_TARGET_CPU),command line:environment)
338	$(error kBuild: KBUILD_TARGET_CPU and BUILD_TARGET_CPU disagree)
339	endif
340	endif
341	endif
342	override BUILD_TARGET_CPU = $(KBUILD_TARGET_CPU)
343
344
345	#
346	# Assert or set default target platform.
347	# When not defined use the corresponding KBUILD_HOST value.
348	#
349	ifndef KBUILD_TARGET
350	KBUILD_TARGET := $(KBUILD_HOST)
351	else
352	ifneq (.$(words $(KBUILD_TARGET)).$(KBUILD_TARGET).,.1.$(strip $(KBUILD_TARGET)).)
353	$(error kBuild: The KBUILD_TARGET value '$(KBUILD_TARGET)' contains spaces/tabs!)
354	endif
355	ifneq ($(words $(filter $(KBUILD_TARGET),$(KBUILD_OSES))),1)
356	$(error kBuild: KBUILD_TARGET value '$(KBUILD_TARGET)' is not recognized (valid: $(KBUILD_OSES)))
357	endif
358	endif
359
360	ifndef KBUILD_TARGET_ARCH
361	KBUILD_TARGET_ARCH := $(KBUILD_HOST_ARCH)
362	else
363	ifneq (.$(words $(KBUILD_TARGET_ARCH)).$(KBUILD_TARGET_ARCH).,.1.$(strip $(KBUILD_TARGET_ARCH)).)
364	$(error kBuild: The KBUILD_TARGET_ARCH value '$(KBUILD_TARGET_ARCH)' contains spaces/tabs!)
365	endif
366	ifneq ($(words $(filter $(KBUILD_TARGET_ARCH),$(KBUILD_ARCHES))),1)
367	$(error kBuild: KBUILD_TARGET_ARCH value '$(KBUILD_TARGET_ARCH)' is not recognized (valid: $(KBUILD_ARCHES)))
368	endif
369	endif
370
371	ifndef KBUILD_TARGET_CPU
372	KBUILD_TARGET_CPU := $(KBUILD_HOST_CPU)
373	else ifeq ($(strip $(KBUILD_TARGET_CPU)),)
374	ifeq ($(KBUILD_TARGET_ARCH),$(KBUILD_HOST_ARCH))
375	KBUILD_TARGET_CPU := $(KBUILD_HOST_CPU)
376	else
377	KBUILD_TARGET_CPU := blend
378	endif
379	else
380	ifneq (.$(words $(KBUILD_TARGET_CPU)).$(KBUILD_TARGET_CPU).,.1.$(strip $(KBUILD_TARGET_CPU)).)
381	$(error kBuild: The KBUILD_TARGET_CPU value '$(KBUILD_TARGET_CPU)' contains spaces/tabs!)
382	endif
383	if1of ($(KBUILD_TARGET_CPU), $(KBUILD_OSES) $(KBUILD_ARCHES))
384	$(error kBuild: The KBUILD_TARGET_CPU value was found in the OS or architecture keywords!)
385	endif
386	ifeq ($(KBUILD_TARGET_CPU),$(KBUILD_TYPE))
387	$(error kBuild: The KBUILD_TARGET_CPU value '$(KBUILD_TARGET_CPU)' is the same as the KBUILD_TYPE!)
388	endif
389	endif
390
391	# Short hand for $(KBUILD_TARGET).$(KBUILD_TARGET_ARCH).
392	KBUILD_TARGET_DOT_ARCH = $(KBUILD_TARGET).$(KBUILD_TARGET_ARCH)
393	KBUILD_HOST_DOT_ARCH = $(KBUILD_HOST).$(KBUILD_TARGET_ARCH)
394
395
396	#
397	# Feature indicators.
398	#
399
400	## File quoting functions.
401	if1of (quote, $(KMK_FEATURES))
402	KMK_WITH_QUOTING := 1
403	endif
404
405	## Version sorting and comparing.
406	if1of (versort, $(KMK_FEATURES))
407	KMK_WITH_VERSION_COMPARE := 1
408	endif
409
410
411	#
412	# Paths and stuff.
413	#
414
415	# Adjust DEPTH first.
416	DEPTH := $(strip $(DEPTH))
417	ifeq ($(DEPTH),)
418	DEPTH := .
419	endif
420
421	## PATH_CURRENT is the current directory (getcwd).
422	PATH_CURRENT := $(abspath $(CURDIR))
423	## PATH_SUB_CURRENT points to current directory of the current makefile.
424	# Meaning that it will change value as we enter and exit sub-makefiles.
425	PATH_SUB_CURRENT := $(PATH_CURRENT)
426	## PATH_ROOT points to the project root directory.
427	PATH_ROOT := $(abspath $(PATH_CURRENT)/$(DEPTH))
428	## PATH_SUB_ROOT points to the directory of the top-level makefile.
429	ifneq ($(strip $(SUB_DEPTH)),)
430	SUB_DEPTH := $(strip $(SUB_DEPTH))
431	PATH_SUB_ROOT := $(abspath $(PATH_CURRENT)/$(SUB_DEPTH))
432	else
433	PATH_SUB_ROOT := $(PATH_CURRENT)
434	endif
435
436	## CURSUBDIR is PATH_SUB_ROOT described relative to PATH_ROOT.
437	# This variable is used to determin where the object files and other output goes.
438	ifneq ($(PATH_ROOT),$(PATH_SUB_ROOT))
439	CURSUBDIR := $(patsubst $(PATH_ROOT)/%,%,$(PATH_SUB_ROOT))
440	else
441	CURSUBDIR := .
442	endif
443
444	# Install directory layout. Relative to PATH_INS.
445	KBUILD_INST_PATHS := BIN DLL SYS LIB DOC DEBUG SBIN LIBEXEC SHARE
446	INST_BIN = bin/
447	if1of ($(KBUILD_TARGET), win)
448	INST_DLL = bin/
449	else
450	INST_DLL = lib/
451	endif
452	if1of ($(KBUILD_TARGET), os2 win)
453	INST_SYS = drivers/
454	else
455	INST_SYS = kernel/
456	endif
457	INST_LIB = lib/
458	INST_DOC = share/doc/
459	INST_DEBUG = debug/
460	INST_SBIN = sbin/
461	INST_LIBEXEC = libexec/
462	INST_SHARE = share/
463
464	# Staging directory layout. Relative to PATH_STAGE.
465	STAGE_BIN = $(INST_BIN)
466	STAGE_DLL = $(INST_DLL)
467	STAGE_SYS = $(INST_SYS)
468	STAGE_LIB = $(INST_LIB)
469	STAGE_DOC = $(INST_DOC)
470	STAGE_DEBUG = $(INST_DEBUG)
471	STAGE_SBIN = $(INST_SBIN)
472	STAGE_LIBEXEC = $(INST_LIBEXEC)
473	STAGE_SHARE = $(INST_SHARE)
474
475	# Install and staging directory paths.
476	$(foreach path, $(KBUILD_INST_PATHS), \
477	$(eval PATH_STAGE_$(path) = $$(patsubst %/,%,$$(PATH_STAGE)/$$(STAGE_$(path)))) \
478	$(eval PATH_INST_$(path) = $$(patsubst %/,%,$$(PATH_INS)/$$(INST_$(path)))) \
479	)
480
481	# Output directories.
482	ifndef PATH_OUT_BASE
483	PATH_OUT_BASE := $(PATH_ROOT)/out
484	endif
485	ifndef PATH_OUT
486	ifdef BUILD_TARGET_SUB # (BUILD_TARGET_SUB is not currently recognized by kBuild in any other places - obsolete)
487	PATH_OUT = $(PATH_OUT_BASE)/$(KBUILD_TARGET).$(KBUILD_TARGET_ARCH).$(BUILD_TARGET_SUB)/$(KBUILD_TYPE)
488	else
489	PATH_OUT = $(PATH_OUT_BASE)/$(KBUILD_TARGET).$(KBUILD_TARGET_ARCH)/$(KBUILD_TYPE)
490	endif
491	endif # !define PATH_OUT
492	PATH_OBJCACHE = $(PATH_OUT_BASE)/kObjCache
493	PATH_OBJ = $(PATH_OUT)/obj
494	PATH_TARGET = $(PATH_OBJ)/$(CURSUBDIR)
495	PATH_STAGE = $(PATH_OUT)/stage
496	ifndef PATH_INS
497	ifdef DESTDIR
498	PATH_INS = $(DESTDIR)
499	else ifdef DESTROOT
500	PATH_INS = $(DESTROOT)
501	else
502	PATH_INS = $(PATH_OUT)/dist
503	endif
504	endif
505
506	# Tripwire obsolete PATH defines.
507	PATH_BIN = $(error kBuild: PATH_BIN is obsoleted in kBuild 0.1.2. Use PATH_STAGE_BIN or PATH_INST_BIN instead)
508	PATH_DLL = $(error kBuild: PATH_LIB is obsoleted in kBuild 0.1.2. Use PATH_STAGE_DLL or PATH_INST_DLL instead)
509	PATH_LIB = $(error kBuild: PATH_LIB is obsoleted in kBuild 0.1.2. Use PATH_STAGE_LIB or PATH_INST_LIB instead)
510	PATH_SYS = $(error kBuild: PATH_SYS is obsoleted in kBuild 0.1.2. Use PATH_STAGE_SYS or PATH_INST_SYS instead)
511	PATH_DOC = $(error kBuild: PATH_DOC is obsoleted in kBuild 0.1.2. Use PATH_STAGE_DOC or PATH_INST_DOC instead)
512
513	# Development tool tree.
514	ifndef KBUILD_DEVTOOLS
515	ifeq ($(PATH_DEVTOOLS),)
516	KBUILD_DEVTOOLS = $(PATH_ROOT)/tools
517	else
518	KBUILD_DEVTOOLS := $(PATH_DEVTOOLS)
519	export KBUILD_DEVTOOLS
520	endif
521	endif
522	KBUILD_DEVTOOLS_TRG ?= $(KBUILD_DEVTOOLS)/$(KBUILD_TARGET).$(KBUILD_TARGET_ARCH)
523	KBUILD_DEVTOOLS_HST ?= $(KBUILD_DEVTOOLS)/$(KBUILD_HOST).$(KBUILD_HOST_ARCH)
524	KBUILD_DEVTOOLS_TRG_NOARCH ?= $(KBUILD_DEVTOOLS)/$(KBUILD_TARGET).noarch
525	KBUILD_DEVTOOLS_HST_NOARCH ?= $(KBUILD_DEVTOOLS)/$(KBUILD_HOST).noarch
526
527	if1of ($(KBUILD_TARGET_ARCH), amd64 hppa64 mips64 ppc64 s390x sparc64)
528	ifeq ($(KBUILD_TARGET_ARCH),amd64)
529	KBUILD_DEVTOOLS_TRG_ALT ?= $(KBUILD_DEVTOOLS)/$(KBUILD_TARGET).x86
530	else ifeq ($(KBUILD_TARGET_ARCH),hppa64)
531	KBUILD_DEVTOOLS_TRG_ALT ?= $(KBUILD_DEVTOOLS)/$(KBUILD_TARGET).hppa32
532	else ifeq ($(KBUILD_TARGET_ARCH),mips64)
533	KBUILD_DEVTOOLS_TRG_ALT ?= $(KBUILD_DEVTOOLS)/$(KBUILD_TARGET).mips32
534	else ifeq ($(KBUILD_TARGET_ARCH),ppc64)
535	KBUILD_DEVTOOLS_TRG_ALT ?= $(KBUILD_DEVTOOLS)/$(KBUILD_TARGET).ppc32
536	else ifeq ($(KBUILD_TARGET_ARCH),s390x)
537	KBUILD_DEVTOOLS_TRG_ALT ?= $(KBUILD_DEVTOOLS)/$(KBUILD_TARGET).s390
538	else ifeq ($(KBUILD_TARGET_ARCH),sparc64)
539	KBUILD_DEVTOOLS_TRG_ALT ?= $(KBUILD_DEVTOOLS)/$(KBUILD_TARGET).sparc32
540	endif
541	endif
542
543	if1of ($(KBUILD_HOST_ARCH), amd64 hppa64 mips64 ppc64 s390x sparc64)
544	ifeq ($(KBUILD_HOST_ARCH),amd64)
545	KBUILD_DEVTOOLS_HST_ALT ?= $(KBUILD_DEVTOOLS)/$(KBUILD_HOST).x86
546	else ifeq ($(KBUILD_HOST_ARCH),hppa64)
547	KBUILD_DEVTOOLS_HST_ALT ?= $(KBUILD_DEVTOOLS)/$(KBUILD_HOST).hppa32
548	else ifeq ($(KBUILD_HOST_ARCH),mips64)
549	KBUILD_DEVTOOLS_HST_ALT ?= $(KBUILD_DEVTOOLS)/$(KBUILD_HOST).mips32
550	else ifeq ($(KBUILD_HOST_ARCH),ppc64)
551	KBUILD_DEVTOOLS_HST_ALT ?= $(KBUILD_DEVTOOLS)/$(KBUILD_HOST).ppc32
552	else ifeq ($(KBUILD_HOST_ARCH),s390x)
553	KBUILD_DEVTOOLS_HST_ALT ?= $(KBUILD_DEVTOOLS)/$(KBUILD_HOST).s390
554	else ifeq ($(KBUILD_HOST_ARCH),sparc64)
555	KBUILD_DEVTOOLS_HST_ALT ?= $(KBUILD_DEVTOOLS)/$(KBUILD_HOST).sparc32
556	endif
557	endif
558
559	# Deprecated legacy names.
560	unexport PATH_DEVTOOLS
561	PATH_DEVTOOLS = $(warning Please replace obsolete PATH_DEVTOOLS with KBUILD_DEVTOOLS)$(KBUILD_DEVTOOLS)
562	PATH_DEVTOOLS_TRG = $(warning Please replace obsolete PATH_DEVTOOLS_TRG with KBUILD_DEVTOOLS_TRG)$(KBUILD_DEVTOOLS_TRG)
563	PATH_DEVTOOLS_BLD = $(warning Please replace obsolete PATH_DEVTOOLS_BLD with KBUILD_DEVTOOLS_BLD)$(KBUILD_DEVTOOLS_TRG)
564	PATH_DEVTOOLS_TRG_ALT = $(warning Please replace obsolete PATH_DEVTOOLS_TRG_ALT with KBUILD_DEVTOOLS_TRG_ALT)$(KBUILD_DEVTOOLS_TRG_ALT)
565	PATH_DEVTOOLS_HST = $(warning Please replace obsolete PATH_DEVTOOLS_HST with KBUILD_DEVTOOLS_HST)$(KBUILD_DEVTOOLS_HST)
566	PATH_DEVTOOLS_HST_ALT = $(warning Please replace obsolete PATH_DEVTOOLS_HST_ALT with KBUILD_DEVTOOLS_HST_ALT)$(KBUILD_DEVTOOLS_HST_ALT)
567
568	# KBUILD_PATH / PATH_KBUILD is determined by kmk.
569	ifndef KBUILD_PATH
570	KBUILD_PATH := $(PATH_KBUILD)
571	endif
572	ifeq ($(strip $(KBUILD_PATH)),)
573	$(error kBuild: KBUILD_PATH is missing or empty! kmk is supposed to set it.)
574	endif
575	# KBUILD_BIN_PATH / PATH_KBUILD_BIN is determined by kmk.
576	ifndef KBUILD_BIN_PATH
577	KBUILD_BIN_PATH := $(PATH_KBUILD_BIN)
578	endif
579	ifeq ($(strip $(KBUILD_BIN_PATH)),)
580	$(error kBuild: KBUILD_BIN_PATH is missing or empty! kmk is supposed to set it.)
581	endif
582
583	# kBuild files which might be of interest.
584	FILE_KBUILD_HEADER := $(KBUILD_PATH)/header.kmk
585	#FILE_KBUILD_CONFIG := $(KBUILD_PATH)/config.kmk
586	FILE_KBUILD_FOOTER := $(KBUILD_PATH)/footer.kmk
587	FILE_KBUILD_SUB_HEADER := $(KBUILD_PATH)/subheader.kmk
588	FILE_KBUILD_SUB_FOOTER := $(KBUILD_PATH)/subfooter.kmk
589
590	## MAKEFILE is the name of the main makefile.
591	MAKEFILE := $(firstword $(MAKEFILE_LIST))
592	## MAKEFILE_CURRENT is the name of the current makefile.
593	# This is updated everything a sub-makefile is included.
594	MAKEFILE_CURRENT := $(MAKEFILE)
595
596
597	## @todo this should be done via SUFF_XYZ.target/host...
598
599	#
600	# Build platform setup.
601	# (PORTME)
602	#
603	if1of ($(KBUILD_HOST), win nt)
604	# Win, Win32, Win64, NT.
605	EXEC_X86_WIN32 :=
606	HOSTSUFF_EXE := .exe
607	HOST_PATH_SEP := $(SEMICOLON)
608
609	# OS/2.
610	else ifeq ($(KBUILD_HOST),os2)
611	EXEC_X86_WIN32 := innopec.exe
612	HOSTSUFF_EXE := .exe
613	HOST_PATH_SEP := $(SEMICOLON)
614
615	else if1of ($(KBUILD_HOST), dragonfly freebsd gnukfbsd gnuknbsd linux openbsd netbsd)
616	# Unix (like) systems with wine.
617	EXEC_X86_WIN32 := wine
618	HOSTSUFF_EXE :=
619	HOST_PATH_SEP := $(COLON)
620
621	else
622	# Unix (like) systems without wine.
623	EXEC_X86_WIN32 := false
624	HOSTSUFF_EXE :=
625	HOST_PATH_SEP := $(COLON)
626	endif
627
628
629	#
630	# Build target setup.
631	# (PORTME)
632	#
633	SUFF_DEP := .dep
634	SUFF_BIN :=
635	if1of ($(KBUILD_TARGET), win nt os2)
636	SUFF_OBJ := .obj
637	SUFF_LIB := .lib
638	SUFF_DLL := .dll
639	SUFF_EXE := .exe
640	SUFF_SYS := .sys
641	SUFF_RES := .res
642	else ifeq ($(KBUILD_TARGET),l4)
643	SUFF_OBJ := .o
644	SUFF_LIB := .a
645	SUFF_DLL := .s.so
646	SUFF_EXE :=
647	SUFF_SYS := .a
648	SUFF_RES :=
649	else ifeq ($(KBUILD_TARGET),darwin)
650	SUFF_OBJ := .o
651	SUFF_LIB := .a
652	SUFF_DLL := .dylib
653	SUFF_EXE :=
654	SUFF_SYS :=
655	SUFF_RES :=
656	else
657	SUFF_OBJ := .o
658	SUFF_LIB := .a
659	SUFF_DLL := .so
660	SUFF_EXE :=
661	if1of ($(KBUILD_TARGET), dragonfly freebsd gnukfbsd gnuknbsd linux netbsd openbsd) ## @todo check netbsd, gnuknbsd and openbsd.
662	SUFF_SYS := .ko
663	else
664	SUFF_SYS :=
665	endif
666	SUFF_RES :=
667	endif
668
669	#
670	# Standard kBuild tools.
671	#
672	ifeq ($(KMK),kmk)
673	KMK := $(KBUILD_BIN_PATH)/kmk$(HOSTSUFF_EXE)
674	endif
675	MAKE := $(KMK)
676
677	GMAKE := $(KBUILD_BIN_PATH)/kmk_gmake$(HOSTSUFF_EXE)
678
679	#DEP_EXT := $(KBUILD_BIN_PATH)/kDep$(HOSTSUFF_EXE)
680	#DEP_INT := $(KBUILD_BIN_PATH)/kDep$(HOSTSUFF_EXE)
681	#DEP := $(DEP_INT)
682
683	DEP_IDB_EXT := $(KBUILD_BIN_PATH)/kDepIDB$(HOSTSUFF_EXE)
684	DEP_IDB_INT := kmk_builtin_kDepIDB
685	DEP_IDB := $(DEP_IDB_INT)
686
687	DEP_OBJ_EXT := $(KBUILD_BIN_PATH)/kDepObj$(HOSTSUFF_EXE)
688	DEP_OBJ_INT := kmk_builtin_kDepObj
689	DEP_OBJ := $(DEP_OBJ_INT)
690
691	DEP_PRE := $(KBUILD_BIN_PATH)/kDepPre$(HOSTSUFF_EXE)
692
693	KOBJCACHE_EXT := $(KBUILD_BIN_PATH)/kObjCache$(HOSTSUFF_EXE)
694	KOBJCACHE := $(KOBJCACHE_EXT)
695
696	KLIBTWEAKER_EXT := $(KBUILD_BIN_PATH)/kLibTweaker$(HOSTSUFF_EXE)
697	KLIBTWEAKER := $(KLIBTWEAKER_EXT)
698
699	APPEND_EXT := $(KBUILD_BIN_PATH)/kmk_append$(HOSTSUFF_EXE)
700	APPEND_INT := kmk_builtin_append
701	APPEND := $(APPEND_INT)
702
703	CAT_EXT := $(KBUILD_BIN_PATH)/kmk_cat$(HOSTSUFF_EXE)
704	CAT_INT := kmk_builtin_cat
705	CAT := $(CAT_INT)
706
707	CHMOD_EXT := $(KBUILD_BIN_PATH)/kmk_chmod$(HOSTSUFF_EXE)
708	CHMOD_INT := kmk_builtin_chmod
709	CHMOD := $(CHMOD_INT)
710
711	CMP_EXT := $(KBUILD_BIN_PATH)/kmk_cmp$(HOSTSUFF_EXE)
712	CMP_INT := kmk_builtin_cmp
713	CMP := $(CMP_INT)
714
715	CP_EXT := $(KBUILD_BIN_PATH)/kmk_cp$(HOSTSUFF_EXE)
716	CP_INT := kmk_builtin_cp
717	CP := $(CP_INT)
718
719	ECHO_EXT := $(KBUILD_BIN_PATH)/kmk_echo$(HOSTSUFF_EXE)
720	ECHO_INT := kmk_builtin_echo
721	ECHO := $(ECHO_INT)
722
723	EXPR_EXT := $(KBUILD_BIN_PATH)/kmk_expr$(HOSTSUFF_EXE)
724	EXPR_INT := kmk_builtin_expr
725	EXPR := $(EXPR_INT)
726
727	INSTALL_EXT := $(KBUILD_BIN_PATH)/kmk_install$(HOSTSUFF_EXE)
728	INSTALL_INT := kmk_builtin_install
729	INSTALL := $(INSTALL_INT)
730
731	LN_EXT := $(KBUILD_BIN_PATH)/kmk_ln$(HOSTSUFF_EXE)
732	LN_INT := kmk_builtin_ln
733	LN := $(LN_INT)
734
735	MD5SUM_EXT := $(KBUILD_BIN_PATH)/kmk_md5sum$(HOSTSUFF_EXE)
736	MD5SUM_INT := kmk_builtin_md5sum
737	MD5SUM := $(MD5SUM_INT)
738
739	MKDIR_EXT := $(KBUILD_BIN_PATH)/kmk_mkdir$(HOSTSUFF_EXE)
740	MKDIR_INT := kmk_builtin_mkdir
741	MKDIR := $(MKDIR_INT)
742
743	MV_EXT := $(KBUILD_BIN_PATH)/kmk_mv$(HOSTSUFF_EXE)
744	MV_INT := kmk_builtin_mv
745	MV := $(MV_INT)
746
747	PRINTF_EXT := $(KBUILD_BIN_PATH)/kmk_printf$(HOSTSUFF_EXE)
748	PRINTF_INT := kmk_builtin_printf
749	PRINTF := $(PRINTF_INT)
750
751	REDIRECT_EXT:= $(KBUILD_BIN_PATH)/kmk_redirect$(HOSTSUFF_EXE)
752	if $(KBUILD_KMK_REVISION) > 2911
753	REDIRECT_INT:= kmk_builtin_redirect
754	else
755	REDIRECT_INT:= $(REDIRECT_EXT)
756	endif
757	REDIRECT := $(REDIRECT_INT)
758
759	RM_EXT := $(KBUILD_BIN_PATH)/kmk_rm$(HOSTSUFF_EXE)
760	RM_INT := kmk_builtin_rm
761	RM := $(RM_INT)
762
763	RMDIR_EXT := $(KBUILD_BIN_PATH)/kmk_rmdir$(HOSTSUFF_EXE)
764	RMDIR_INT := kmk_builtin_rmdir
765	RMDIR := $(RMDIR_INT)
766
767	SED_EXT := $(KBUILD_BIN_PATH)/kmk_sed$(HOSTSUFF_EXE)
768	SED_INT := $(SED_EXT)
769	SED := $(SED_EXT)
770
771	SLEEP_INT := kmk_builtin_sleep
772	SLEEP_EXT := $(KBUILD_BIN_PATH)/kmk_sleep$(HOSTSUFF_EXE)
773	SLEEP := $(SLEEP_EXT)
774
775	TEST_EXT := $(KBUILD_BIN_PATH)/kmk_test$(HOSTSUFF_EXE)
776	TEST_INT := kmk_builtin_test
777	TEST := $(TEST_INT)
778
779	TIME_EXT := $(KBUILD_BIN_PATH)/kmk_time$(HOSTSUFF_EXE)
780	TIME_INT := $(TIME_EXT)
781	TIME := $(TIME_INT)
782
783	TOUCH_EXT := $(KBUILD_BIN_PATH)/kmk_touch$(HOSTSUFF_EXE)
784	if $(KBUILD_KMK_REVISION) >= 3060
785	TOUCH_INT := kmk_builtin_touch
786	else
787	TOUCH_INT := $(TOUCH_EXT)
788	endif
789	TOUCH := $(TOUCH_INT)
790
791	# Our default shell is the Almquist shell from *BSD.
792	ASH := $(KBUILD_BIN_PATH)/kmk_ash$(HOSTSUFF_EXE)
793	MAKESHELL := $(ASH)
794	SHELL := $(ASH)
795	export SHELL MAKESHELL
796
797	# Symlinking is problematic on some platforms...
798	LN_SYMLINK := $(LN) -s
799
800	# When copying to the staging area, use hard links to save time and space.
801	ifndef KBUILD_NO_HARD_LINKING
802	INSTALL_STAGING := $(INSTALL) --hard-link-files-when-possible
803	else
804	INSTALL_STAGING := $(INSTALL)
805	endif
806
807
808	#
809	# Some Functions.
810	# The lower cased ones are either fallbacks or candidates for functions.c.
811	#
812
813	## ABSPATH - make paths absolute.
814	# This implementation is clumsy and doesn't resolve '..' and '.' components.
815	#
816	# @param $1 The paths to make absolute.
817	# @obsolete Use the GNU make function $(abspath) directly now.
818	ABSPATH = $(abspath $(1))$(warning ABSPATH is deprecated, use abspath directly!)
819
820	## DIRDEP - make create directory dependencies.
821	#
822	# @param $1 The paths to the directories which must be created.
823	DIRDEP = $(foreach path,$(patsubst %/,%,$(1)),$(path)/)
824
825	## Cygwin kludge.
826	# This converts /cygdrive/x/% to x:%.
827	#
828	# @param $1 The paths to make native.
829	# @remark This macro is pretty much obsolete since we don't use cygwin base make.
830	ifneq ($(patsubst /cygdrive/%,%,$(CURDIR)),$(CURDIR))
831	CYGPATHMIXED = $(foreach path,$(1)\
832	,$(if $(patsubst /cygdrive/%,,$(path)),$(path),$(patsubst $(strip $(firstword $(subst /, ,$(patsubst /cygdrive/%,%,$(path)))))/%,$(strip $(firstword $(subst /, ,$(patsubst /cygdrive/%,%,$(path))))):/%,$(patsubst /cygdrive/%,%,$(path)))))
833	else
834	CYGPATHMIXED = $(1)
835	endif
836
837	## Removes the drive letter from a path (if it has one)
838	# @param $1 the path
839	no-drive = $(word $(words $(subst :, ,$(1))),$(subst :, ,$(1)))
840
841	## Removes the root slash from a path (if it has one)
842	# @param $1 the path
843	no-root-slash = $(patsubst /%,%,$(1))
844
845	##
846	# Similar to firstword, except it returns the value of first defined variable.
847	# @param $1 list of variables to probe.
848	define FIRST-DEFINED-VAR
849	local .RETURN := $(strip $(firstdefined $1, value))
850	endef
851
852	## Figure out where to put object files.
853	# @param $1 real target name.
854	# @param $2 normalized main target
855	TARGET_BASE = $(PATH_TARGET)/$(2)/$(call no-root-slash,$(call no-drive,$(1)))
856
857	## Figure out where to put object files.
858	# @param $1 normalized main target
859	TARGET_PATH = $(PATH_TARGET)/$(1)
860
861	##
862	# An internal define used by subheader.kmk, subfooter.kmk, and
863	# KB_FN_DO_PASS0_ON_TARGET.
864	#
865	# @param target The target to process.
866	#
867	define def_subfooter_header_target_pass
868	ifndef $(target)_PATH
869	ifndef $(target)_DEFPATH
870	$(target)_DEFPATH := $(PATH_SUB_CURRENT)
871	endif
872	$(call KB_FN_ASSIGN_DEPRECATED,$(target)_PATH,$($(target)_DEFPATH), $(target)_DEFPATH)
873	else ifndef $(target)_DEFPATH
874	$(target)_DEFPATH := $($(target)_PATH)
875	endif
876	ifndef $(target)_MAKEFILE
877	$(target)_MAKEFILE := $(MAKEFILE_CURRENT)
878	endif
879	ifndef $(target)_0_OUTDIR
880	$(target)_0_OUTDIR := $(call TARGET_PATH,$(target))
881	$(call KB_FN_ASSIGN_DEPRECATED,PATH_$(target),$($(target)_0_OUTDIR), $(target)_0_OUTDIR)
882	endif
883	endef
884
885	##
886	# Function to call to set _0_OUTDIR, _DEFPATH, and _MAKEFILE earlier than subfooter.
887	# Can be used to avoid exploiting double expansion.
888	#
889	# @param 1 The target name.
890	KB_FN_DO_PASS0_ON_TARGET = $(foreach target,$1,$(if-expr defined($(target)_0_OUTDIR),,$(evalval def_subfooter_header_target_pass)))
891
892	##
893	# Checks if the specified short option ($1) is found in the flags ($2),
894	# assuming getopt style options.
895	#
896	# @returns $3 if present, $4 not.
897	#
898	# @param $1 The option (single char!).
899	# @param $2 The option arguments.
900	# @param $3 Eval and return if present.
901	# @param $4 Eval and return if not present.
902	#
903	# @todo May confuse option values starting with '-' for options.
904	# @remarks Invoke like this: $(evalcall KB_FN_OPT_TEST_SHORT,d,$(flags),present,not-present)
905	#
906	define KB_FN_OPT_TEST_SHORT
907	local options := $(translate $(strip $(filter -%,$(filter-out --%,$2))),$(SP)-,)
908	local .RETURN := $(if-expr $(pos $1,$(options)) != 0,$3,$4)
909	endef
910
911	##
912	# Checks if the specified long option ($1) is found in the flags ($2),
913	# assuming getopt style options.
914	#
915	# @returns $3 if present, $4 not.
916	#
917	# @param $1 The long option, dashes included. No % chars.
918	# @param $2 The option arguments.
919	# @param $3 Eval and return if present.
920	# @param $4 Eval and return if not present.
921	#
922	# @todo May confuse option values starting with '--' for options.
923	# @remarks Invoke like this: $(evalcall KBFN_OPT_TEST_SHORT,--defined,$(flags),present,not-present)
924	#
925	define KB_FN_OPT_TEST_LONG
926	local options := $(filter-out =delete=%,$(subst :, =delete=,$(subst =, =delete=,$2)))
927	local .RETURN := $(if-expr "$(filter $1,$(options))" != "",$3,$4)
928	endef
929
930	##
931	# Checks if the specified short ($1) or long ($2) option is found in the flags ($2),
932	# assuming getopt style options.
933	#
934	# @returns $4 if present, $5 not.
935	#
936	# @param $1 The short option (single char!).
937	# @param $2 The long option, dashes included. No % chars.
938	# @param $3 The option arguments.
939	# @param $4 Eval and return if present.
940	# @param $5 Eval and return if not present.
941	#
942	# @todo May confuse option values starting with '--' for options.
943	# @remarks Invoke like this: $(evalcall KB_FN_OPT_TEST_SHORT_LONG,d,--defined,$(flags),present,not-present)
944	#
945	define KB_FN_OPT_TEST_SHORT_LONG
946	local short_options := $(translate $(strip $(filter -%,$(filter-out --%,$3))),$(SP)-,)
947	local long_options := $(filter-out =delete=%,$(subst :, =delete=,$(subst =, =delete=,$3)))
948	local .RETURN := $(if-expr $(pos $1,$(short_options)) != 0 \|\| "$(filter $2,$(long_options))" != "",$4,$5)
949	endef
950
951	##
952	# Make an assignment to a deprecated variable.
953	#
954	# @param $1 The variable name.
955	# @param $2 The value.
956	# @param $3 The variable to use instead.
957	#
958	ifdef KBUILD_WITH_DEPREATED_AS_ERROR
959	KB_FN_ASSIGN_DEPRECATED = $(eval $(subst :,$$(COLON),$1) = $2$$(error $1 is deprecated, use $3 instead))
960	else
961	KB_FN_ASSIGN_DEPRECATED = $(eval $(subst :,$$(COLON),$1) = $2$$(warning $1 is deprecated, use $3 instead))
962	endif
963
964	##
965	# Show an assertion message.
966	#
967	# @param $1 The assertion name.
968	# @param $2 The details.
969	#
970	define KB_FN_ASSERT_MSG
971	$(info !! kBuild $1 Assertion Failed !!)
972	ifdef target
973	$(info !! target: $(target))
974	local varloc := $(where $(target))
975	if "$(varloc)" == "undefined"
976	local varloc := $(where $(target)_TEMPLATE)
977	endif
978	if "$(varloc)" == "undefined"
979	local varloc := $(where $(target)_SOURCES)
980	endif
981	if "$(varloc)" == "undefined"
982	local varloc := $(where $(target)_EXTENDS)
983	endif
984	if "$(varloc)" == "undefined"
985	local varloc := $(where target)
986	endif
987	ifneq ($(varloc),)
988	$(info !! location: $(varloc))
989	else
990	$(info !! probable location: $($(target)_DEFPATH)/Makefile.kmk)
991	endif
992	endif
993	$(info !! $2)
994	$(error fixme)
995	endef
996
997	##
998	# Throw an error if the given path $1 isn't absolute and assertions are enabled.
999	#
1000	# @param $1 The name of the path variable to check.
1001	#
1002	ifdef KBUILD_INTERNAL_STRICT
1003	KB_FN_ASSERT_ABSPATH = $(if-expr "$(abspath $($(strip $1)))" != "$(strip $($(strip $1)))",\
1004	$(evalcall KB_FN_ASSERT_MSG,abspath,$1 is:$(NLTAB)'$($(strip $1))'$(NLTAB)expected:$(NLTAB)'$(abspath $($(strip $1)))'))
1005	else
1006	KB_FN_ASSERT_ABSPATH :=
1007	endif
1008
1009
1010	#
1011	# Somewhat simple solution for automatic command dependencies.
1012	#
1013
1014	## Included dependency files (used to be in footer.kmk).
1015	_DEPFILES_INCLUDED :=
1016
1017	## Temporary for the compile rule below.
1018	if "$(KBUILD_KMK_REVISION)" >= 3134
1019	KBUILD_HAVE_OPTIMIZED_APPEND := 1
1020	endif
1021
1022	##
1023	# Advanced version of KB_FN_AUTO_CMD_DEPS_COMMANDS_EX where you set
1024	# the dependency file name yourself.
1025	#
1026	# After or before the recipe do $(call KB_FN_AUTO_CMD_DEPS_EX,<recipe-target>,<dep-file>).
1027	#
1028	# @param 1 dep file.
1029	ifdef KBUILD_HAVE_OPTIMIZED_APPEND
1030	define KB_FN_AUTO_CMD_DEPS_COMMANDS_EX
1031	%$(QUIET2)$(APPEND) -tin "$1" \
1032	'define AUTO_CMD_DEP_$(translate $@,:,_)_PREV_CMDS' \
1033	'--insert-command=$@' \
1034	'endef'
1035	endef
1036	else
1037	define KB_FN_AUTO_CMD_DEPS_COMMANDS_EX
1038	%$(QUIET2)$(RM) -f -- "$1"
1039	%$(QUIET2)$(APPEND) "$1" 'define AUTO_CMD_DEP_$(translate $@,:,_)_PREV_CMDS'
1040	%$(QUIET2)$(APPEND) -c "$1" '$@'
1041	%$(QUIET2)$(APPEND) "$1" 'endef'
1042	endef
1043	endif
1044
1045	##
1046	# Advanced version of KB_FN_AUTO_CMD_DEPS
1047	#
1048	# @param 1 recipe name
1049	# @param 2 dep file.
1050	KB_FN_AUTO_CMD_DEPS_EX = $(eval includedep $2$(NL)_DEPFILES_INCLUDED += $2)$1: .MUST_MAKE = $$(comp-cmds-ex $$(AUTO_CMD_DEP_$(translate $1,:,_)_PREV_CMDS),$$(commands $1),FORCE)
1051
1052	##
1053	# $(call KB_FN_AUTO_CMD_DEPS_COMMANDS) as the first command in a recipe to
1054	# automatically generate command dependencies.
1055	# After or before the recipe do $(call KB_FN_AUTO_CMD_DEPS,<recipe-target>).
1056	ifdef KBUILD_HAVE_OPTIMIZED_APPEND
1057	define KB_FN_AUTO_CMD_DEPS_COMMANDS
1058	%$(QUIET2)$(APPEND) -tni "$@.auto-dep" \
1059	'define AUTO_CMD_DEP_$(translate $@,:,_)_PREV_CMDS' \
1060	'--insert-command=$@' \
1061	'endef'
1062	endef
1063	else
1064	define KB_FN_AUTO_CMD_DEPS_COMMANDS
1065	%$(QUIET2)$(RM) -f -- "$@.auto-dep"
1066	%$(QUIET2)$(APPEND) "$@.auto-dep" 'define AUTO_CMD_DEP_$(translate $@,:,_)_PREV_CMDS'
1067	%$(QUIET2)$(APPEND) -c "$@.auto-dep" '$@'
1068	%$(QUIET2)$(APPEND) "$@.auto-dep" 'endef'
1069	endef
1070	endif
1071
1072	##
1073	# Call before or after defining a recipe that you want automatic command
1074	# dependencies on. The recipe must start off by $(call KB_FN_AUTO_CMD_DEPS_COMMANDS).
1075	#
1076	# @param 1 recipe name
1077	KB_FN_AUTO_CMD_DEPS = $(call KB_FN_AUTO_CMD_DEPS_EX,$1,$1.auto-dep)
1078
1079	##
1080	# Call this (evalcall) this to explictly load tool by name.
1081	#
1082	# @param 1 The tool name
1083	define KB_FN_LOAD_TOOL
1084	ifndef TOOL_$(1)
1085	TOOL_$(1)_KMK_FILE := $(firstword $(foreach path, $(KBUILD_TOOL_PATHS) $(KBUILD_PATH)/tools $(KBUILD_DEFAULT_PATHS), $(wildcard $(path)/$(1).kmk)))
1086	ifeq ($(TOOL_$(1)_KMK_FILE),)
1087	$(error kBuild: Cannot find include file for the tool '$(1)'! Searched: $(KBUILD_TOOL_PATHS) $(KBUILD_PATH)/tools $(KBUILD_DEFAULT_PATHS))
1088	endif
1089	include $(TOOL_$(1)_KMK_FILE)
1090	ifndef TOOL_$(1)
1091	$(warning kBuild: TOOL_$(1) was not defined by $(TOOL_$(1)_KMK_FILE)!)
1092	endif
1093	endif
1094	endef
1095
1096	##
1097	# Call this (evalcall) this to explictly load an SDK by name.
1098	#
1099	# @param 1 The SDK name
1100	define KB_FN_LOAD_SDK
1101	ifndef SDK_$(1)
1102	SDK_$(1)_KMK_FILE := $(firstword $(foreach path, $(KBUILD_SDK_PATHS) $(KBUILD_PATH)/sdks $(KBUILD_DEFAULT_PATHS), $(wildcard $(path)/$(1).kmk)))
1103	ifeq ($(SDK_$(1)_KMK_FILE),)
1104	$(error kBuild: Cannot find include file for the SDK '$(1)'! Searched: $(KBUILD_SDK_PATHS) $(KBUILD_PATH)/sdks $(KBUILD_DEFAULT_PATHS))
1105	endif
1106	include $(SDK_$(1)_KMK_FILE)
1107	ifndef SDK_$(1)
1108	$(warning kBuild: SDK_$(1) was not defined by $(SDK_$(1)_KMK_FILE)!)
1109	endif
1110	endif
1111	endef
1112
1113
1114	#
1115	# Initialize some of the globals which the Config.kmk and
1116	# others can add stuff to if they like for processing in the footer.
1117	#
1118
1119	## KBUILD_TEMPLATE_PATHS
1120	# List a paths (separated by space) where templates can be found.
1121	KBUILD_TEMPLATE_PATHS :=
1122
1123	## KBUILD_TOOL_PATHS
1124	# List of paths (separated by space) where tools can be found.
1125	KBUILD_TOOL_PATHS :=
1126
1127	## KBUILD_SDK_PATHS
1128	# List of paths (separated by space) where SDKs can be found.
1129	KBUILD_SDK_PATHS :=
1130
1131	## KBUILD_UNIT_PATHS
1132	# List of paths (separated by space) where units (USES) can be found.
1133	KBUILD_UNIT_PATHS :=
1134
1135	## KBUILD_DEFAULT_PATHS
1136	# List of paths (separated by space) to search for stuff as a last resort.
1137	KBUILD_DEFAULT_PATHS :=
1138
1139	## Proritized list of the default makefile when walking subdirectories.
1140	# The user can overload this list.
1141	DEFAULT_MAKEFILE := Makefile.kmk makefile.kmk Makefile makefile
1142
1143	## KBUILD_SRC_HANDLERS
1144	# The list of source handlers, pair of extension and handler.
1145	# The user can overload this list to provide additional or custom
1146	# handlers. On a per-target/template see SRC_HANDLERS.
1147	KBUILD_SRC_HANDLERS := \
1148	.c:def_src_handler_c \
1149	.C:def_src_handler_c \
1150	.cxx:def_src_handler_cxx \
1151	.CXX:def_src_handler_cxx \
1152	.cpp:def_src_handler_cxx \
1153	.CPP:def_src_handler_cxx \
1154	.cc:def_src_handler_cxx \
1155	.CC:def_src_handler_cxx \
1156	.m:def_src_handler_objc \
1157	.M:def_src_handler_objcxx \
1158	.mm:def_src_handler_objcxx \
1159	.asm:def_src_handler_asm \
1160	.ASM:def_src_handler_asm \
1161	.s:def_src_handler_asm \
1162	.S:def_src_handler_asm \
1163	.rc:def_src_handler_rc \
1164	.obj:def_src_handler_obj \
1165	.o:def_src_handler_obj \
1166	.res:def_src_handler_obj
1167
1168	## PROPS_TOOLS
1169	# This is a subset of PROPS_SINGLE.
1170	PROPS_TOOLS := TOOL CTOOL CXXTOOL PCHTOOL OBJCTOOL OBJCXXTOOL ASTOOL RCTOOL ARTOOL LDTOOL FETCHTOOL UNPACKTOOL PATCHTOOL
1171
1172	## PROPS_SINGLE
1173	# The list of non-accumulative target properties.
1174	# A Config.kmk file can add it's own properties to this list and kBuild
1175	# will do the necessary inheritance for templates, sdks, tools and targets.
1176	PROPS_SINGLE := $(PROPS_TOOLS) TEMPLATE INSTTYPE INST STAGE NOINST BLD_TYPE BLD_TRG BLD_TRG_ARCH BLD_TRG_CPU FETCHDIR \
1177	OBJSUFF COBJSUFF CXXOBJSUFF PCHOBJSUFF OBJCOBJSUFF OBJCXXOBJSUFF ASOBJSUFF RCOBJSUFF SYSSUFF BINSUFF EXESUFF DLLSUFF LIBSUFF ARLIBSUFF \
1178	MODE UID GID LD_DEBUG DEBUG_INSTTYPE DEBUG_INST DEBUG_STAGE PCH_HDR
1179	## PROPS_SINGLE_LNK
1180	# Subset of PROPS_SINGLE which applies to all linkable targets.
1181	PROPS_SINGLE_LNK := $(filter-out FETCHTOOL UNPACKTOOL PATCHTOOL FETCHDIR, $(PROPS_SINGLE))
1182
1183	## PROPS_DEFERRED
1184	# This list of non-accumulative target properties which are or may be
1185	# functions, and thus should not be expanded until the very last moment.
1186	PROPS_DEFERRED := INSTFUN INSTALLER PRE_CMDS POST_CMDS PRE_INST_CMDS POST_INST_CMDS \
1187	PRE_FILE_CMDS POST_FILE_CMDS PRE_SYMLINK_CMDS POST_SYMLINK_CMDS PRE_DIRECTORY_CMDS POST_DIRECTORY_CMDS \
1188	NAME SONAME
1189
1190	## PROPS_ACCUMULATE_R
1191	# The list of accumulative target properties where the right most value/flag
1192	# is the 'most significant'.
1193	# A Config.kmk file can add it's own properties to this list and kBuild
1194	# will do the necessary inheritance from templates to targets.
1195	PROPS_ACCUMULATE_R := \
1196	DEPS LNK_DEPS ORDERDEPS LNK_ORDERDEPS DEFS \
1197	ARFLAGS \
1198	CFLAGS CDEFS \
1199	CXXFLAGS CXXDEFS \
1200	PCHFLAGS PCHDEFS \
1201	OBJCFLAGS OBJCDEFS \
1202	OBJCXXFLAGS OBJCXXDEFS \
1203	ASFLAGS ASDEFS \
1204	RCFLAGS RCDEFS \
1205	LDFLAGS \
1206	IDFLAGS IFFLAGS EXEC_IFFLAGS ISFLAGS \
1207	FETCHFLAGS UNPACKFLAGS PATCHFLAGS
1208	## PROPS_ACCUMULATE_R_LNK
1209	# Subset of PROPS_ACCUMULATE_R which applies to all linkable targets.
1210	PROPS_ACCUMULATE_R_LNK := $(filter-out ARFLAGS LDFLAGS EXEC_IFFLAGS FETCHFLAGS UNPACKFLAGS PATCHFLAGS, $(PROPS_ACCUMULATE_R))
1211
1212	## PROPS_ACCUMULATE
1213	# The list of accumulative target properties where the left most value/flag
1214	# is the 'most significant'.
1215	# A Config.kmk file can add it's own properties to this list and kBuild
1216	# will do the necessary inheritance from templates to targets.
1217	PROPS_ACCUMULATE_L := \
1218	SDKS USES SOURCES EXEC_SOURCES SRC_HANDLERS INTERMEDIATES \
1219	INCS CINCS CXXINCS PCHINCS OBJCINCS OBJCXXINCS ASINCS RCINCS \
1220	EARLY_LIBS LIBS LATE_LIBS LIBPATH \
1221	DIRS BLDDIRS CLEAN
1222	## PROPS_ACCUMULATE_L_LNK
1223	# Subset of PROPS_ACCUMULATE_L which applies to all linkable targets.
1224	PROPS_ACCUMULATE_L_LNK := $(filter-out EARLY_LIBS LIBS LATE_LIBS LIBPATH EXEC_SOURCES DIRS, $(PROPS_ACCUMULATE_L))
1225
1226	## PROPS_ALL
1227	# List of all the properties.
1228	PROPS_ALL = $(PROPS_SINGLE) $(PROPS_DEFERRED) $(PROPS_ACCUMULATE_L) $(PROPS_ACCUMULATE_R)
1229
1230	## @name Properties valid on programs (BLDPROGS and PROGRAMS)
1231	## @{
1232	PROPS_PROGRAMS_SINGLE := $(PROPS_SINGLE_LNK) LDTOOL EXESUFF
1233	PROPS_PROGRAMS_DEFERRED := $(PROPS_DEFERRED)
1234	PROPS_PROGRAMS_ACCUMULATE_R := $(PROPS_ACCUMULATE_R_LNK) LDFLAGS
1235	PROPS_PROGRAMS_ACCUMULATE_L := $(PROPS_ACCUMULATE_L_LNK) EARLY_LIBS LIBS LATE_LIBS LIBPATH
1236	## @}
1237
1238	## @name Properties valid on libraries (LIBRARIES and IMPORT_LIBS)
1239	## @{
1240	PROPS_LIBRARIES_SINGLE := $(PROPS_SINGLE_LNK) ARTOOL LIBSUFF ARLIBSUFF LIBSUFF
1241	PROPS_LIBRARIES_DEFERRED := $(filter-out SONAME,$(PROPS_DEFERRED))
1242	PROPS_LIBRARIES_ACCUMULATE_R := $(PROPS_ACCUMULATE_R_LNK) ARFLAGS
1243	PROPS_LIBRARIES_ACCUMULATE_L := $(PROPS_ACCUMULATE_L_LNK)
1244	## @}
1245
1246	## @name Properties valid on dlls (DLLS)
1247	## @{
1248	PROPS_DLLS_SINGLE := $(PROPS_SINGLE_LNK) LDTOOL DLLSUFF LIBSUFF
1249	PROPS_DLLS_DEFERRED := $(PROPS_DEFERRED)
1250	PROPS_DLLS_ACCUMULATE_R := $(PROPS_ACCUMULATE_R_LNK) LDFLAGS
1251	PROPS_DLLS_ACCUMULATE_L := $(PROPS_ACCUMULATE_L_LNK) EARLY_LIBS LIBS LATE_LIBS LIBPATH
1252	## @}
1253
1254	## @name Properties valid on system modules (SYSMODS)
1255	## @{
1256	PROPS_SYSMODS_SINGLE := $(PROPS_SINGLE_LNK) LDTOOL SYSSUFF
1257	PROPS_SYSMODS_DEFERRED := $(PROPS_DEFERRED)
1258	PROPS_SYSMODS_ACCUMULATE_R := $(PROPS_ACCUMULATE_R_LNK) LDFLAGS
1259	PROPS_SYSMODS_ACCUMULATE_L := $(PROPS_ACCUMULATE_L_LNK) EARLY_LIBS LIBS LATE_LIBS LIBPATH
1260	## @}
1261
1262	## @name Properties valid on misc binaries (MISCBINS)
1263	## @{
1264	PROPS_MISCBINS_SINGLE := $(PROPS_SINGLE_LNK) LDTOOL BINSUFF
1265	PROPS_MISCBINS_DEFERRED := $(PROPS_DEFERRED)
1266	PROPS_MISCBINS_ACCUMULATE_R := $(PROPS_ACCUMULATE_R_LNK) LDFLAGS
1267	PROPS_MISCBINS_ACCUMULATE_L := $(PROPS_ACCUMULATE_L_LNK) EARLY_LIBS LIBS LATE_LIBS LIBPATH
1268	## @}
1269
1270	## @name Properties valid on installs (INSTALLS)
1271	## @{
1272	PROPS_INSTALLS_SINGLE := TOOL TEMPLATE INSTTYPE INST STAGE NOINST BLD_TYPE BLD_TRG BLD_TRG_ARCH BLD_TRG_CPU MODE UID GID
1273	PROPS_INSTALLS_DEFERRED := INSTFUN INSTALLER PRE_FILE_CMDS POST_FILE_CMDS PRE_SYMLINK_CMDS POST_SYMLINK_CMDS \
1274	PRE_DIRECTORY_CMDS POST_DIRECTORY_CMDS
1275	PROPS_INSTALLS_ACCUMULATE_R := DEPS ORDERDEPS GOALS INST_ONLY_GOALS STAGE_ONLY_GOALS IFFLAGS EXEC_IFFLAGS
1276	PROPS_INSTALLS_ACCUMULATE_L := SOURCES EXEC_SOURCES DIRS CLEAN
1277	## @}
1278
1279	## @name Properties valid on fetches (FETCHES)
1280	## @{
1281	PROPS_FETCHES_SINGLE := TOOL TEMPLATE FETCHTOOL UNPACKTOOL PATCHTOOL INST FETCHDIR
1282	PROPS_FETCHES_DEFERRED := NAME
1283	PROPS_FETCHES_ACCUMULATE_R := FETCHFLAGS UNPACKFLAGS PATCHFLAGS
1284	PROPS_FETCHES_ACCUMULATE_L := SOURCES CLEAN
1285	## @}
1286
1287	## KBUILD_COMPILE_CATEGTORIES
1288	# Tools categories for compiling.
1289	KBUILD_COMPILE_CATEGTORIES := AS C CXX PCH OBJC OBJCXX RC
1290
1291	## KBUILD_GENERIC_CATEGORIES
1292	# Generic tool categories.
1293	KBUILD_GENERIC_CATEGORIES := FETCH UNPACK PATCH $(addprefix LINK_,LIBRARY PROGRAM DLL SYSMOD MISCBIN)
1294
1295	## PROPS_TOOLS_ONLY
1296	# Properties found only on tools.
1297	# This is expanded in a deferred manner, so it will pick up changes made to
1298	# KBUILD_COMPILE_CATEGTORIES and KBUILD_GENERIC_CATEGORIES made by units.
1299	PROPS_TOOLS_ONLY = \
1300	$(foreach cat, $(KBUILD_COMPILE_CATEGTORIES), \
1301	COMPILE_$(cat)_CMDS \
1302	COMPILE_$(cat)_OUTPUT \
1303	COMPILE_$(cat)_OUTPUT_MAYBE \
1304	COMPILE_$(cat)_DEPEND \
1305	COMPILE_$(cat)_DEPORD \
1306	COMPILE_$(cat)_USES_KOBJCACHE ) \
1307	$(foreach cat, $(KBUILD_GENERIC_CATEGORIES), \
1308	$(cat)_CMDS \
1309	$(cat)_OUTPUT \
1310	$(cat)_OUTPUT_MAYBE \
1311	$(cat)_DEPEND \
1312	$(cat)_DEPORD ))
1313
1314
1315	#
1316	# Here is a special 'hack' to prevent innocent environment variables being
1317	# picked up and treated as properties. (The most annoying example of why
1318	# this is necessary is the Visual C++ commandline with it's LIBPATH.)
1319	#
1320	# Define KBUILD_DONT_KILL_ENV_PROPS in the env. or on the commandline to
1321	# disable this 'hack'.
1322	#
1323	ifndef KBUILD_DONT_KILL_ENV_PROPS
1324
1325	define def_nuke_environment_prop
1326	ifeq ($(origin $(prop)),environment)
1327	$(prop) =
1328	endif
1329	endef
1330	$(foreach prop, $(PROPS_ALL) \
1331	FETCHES PATCHES BLDPROGS LIBRARIES IMPORT_LIBS DLLS PROGRAMS SYSMODS MISCBINS INSTALLS OTHERS \
1332	SUBDIRS MAKEFILES BLDDIRS \
1333	,$(eval $(value def_nuke_environment_prop)))
1334
1335	endif # KBUILD_DONT_KILL_ENV_PROPS
1336
1337
1338	#
1339	# Pass configuration.
1340	#
1341	# The PASS_<passname>_trgs variable is listing the targets.
1342	# The PASS_<passname>_vars variable is listing the target variables.
1343	# The PASS_<passname>_pass variable is the lowercased passname.
1344	#
1345
1346	## PASS: fetches
1347	# This pass fetches and unpacks things needed to complete the build.
1348	PASS_FETCHES := Fetches
1349	PASS_FETCHES_trgs :=
1350	PASS_FETCHES_vars := _FETCHES
1351	PASS_FETCHES_pass := fetches
1352
1353	## PASS: patches
1354	# This pass applies patches.
1355	PASS_PATCHES := Patches
1356	PASS_PATCHES_trgs :=
1357	PASS_PATCHES_vars := _PATCHES
1358	PASS_PATCHES_pass := patches
1359
1360	## PASS: bldprogs
1361	# This pass builds targets which are required for building the rest.
1362	PASS_BLDPROGS := Build Programs
1363	PASS_BLDPROGS_trgs :=
1364	PASS_BLDPROGS_vars := _BLDPROGS
1365	PASS_BLDPROGS_pass := bldprogs
1366
1367	## PASS: libraries
1368	# This pass builds library targets.
1369	PASS_LIBRARIES := Libraries
1370	PASS_LIBRARIES_trgs :=
1371	PASS_LIBRARIES_vars := _LIBS _IMPORT_LIBS _OTHER_LIBRARIES
1372	PASS_LIBRARIES_pass := libraries
1373
1374	## PASS: binaries
1375	# This pass builds dll targets.
1376	PASS_DLLS := DLLs
1377	PASS_DLLS_trgs :=
1378	PASS_DLLS_vars := _DLLS _OTHER_DLLS
1379	PASS_DLLS_pass := dlls
1380
1381	## PASS: binaries
1382	# This pass builds binary targets, i.e. programs, system modules and stuff.
1383	PASS_BINARIES := Programs
1384	PASS_BINARIES_trgs :=
1385	PASS_BINARIES_vars := _PROGRAMS _SYSMODS _MISC_BINS _OTHER_BINARIES
1386	PASS_BINARIES_pass := binaries
1387
1388	## PASS: others
1389	# This pass builds other targets.
1390	PASS_OTHERS := Other Stuff
1391	PASS_OTHERS_trgs :=
1392	PASS_OTHERS_vars := _OTHERS
1393	PASS_OTHERS_pass := others
1394
1395	## PASS: staging
1396	# This pass installs the built entities to a sandbox area.
1397	## @todo split this up into build install (to sandbox) and real installation.
1398	PASS_STAGING := Staging
1399	PASS_STAGING_trgs :=
1400	PASS_STAGING_vars := _STAGE_DIRS _INSTALLS _STAGE_FILES _DEBUG_STAGE_DIRS _DEBUG_STAGE_FILES
1401	PASS_STAGING_pass := staging
1402
1403	## PASS: install
1404	# This pass installs the built entities to where they will be used (using
1405	# DESTROOT or PATH_INS to indicate where this is).
1406	PASS_INSTALLS := Install
1407	PASS_INSTALLS_trgs :=
1408	PASS_INSTALLS_vars := _INSTALLS_DIRS _INSTALLS_FILES _DEBUG_INSTALL_DIRS _DEBUG_INSTALL_FILES
1409	PASS_INSTALLS_pass := installs
1410
1411	## PASS: testing
1412	# This pass processes custom rules for executing tests.
1413	PASS_TESTING := Tests
1414	PASS_TESTING_trgs :=
1415	PASS_TESTING_vars := _TESTING
1416	PASS_TESTING_pass := testing
1417
1418	## PASS: packing
1419	# This pass processes custom packing rules.
1420	PASS_PACKING := Packing
1421	PASS_PACKING_trgs :=
1422	PASS_PACKING_vars := _PACKING
1423	PASS_PACKING_pass := packing
1424
1425	## PASS: clean
1426	# This pass removes all generated files.
1427	PASS_CLEAN := Clean
1428	PASS_CLEAN_trgs := do-clean
1429	PASS_CLEAN_vars :=
1430	PASS_CLEAN_pass := clean
1431
1432	## PASS: nothing
1433	# This pass just walks the tree.
1434	PASS_NOTHING := Nothing
1435	PASS_NOTHING_trgs := do-nothing
1436	PASS_NOTHING_vars :=
1437	PASS_NOTHING_pass := nothing
1438
1439	## DEFAULT_PASSES
1440	# The default passes and their order.
1441	DEFAULT_PASSES := BLDPROGS LIBRARIES DLLS BINARIES OTHERS STAGING
1442
1443	## PASSES
1444	# The passes that should be defined. This must include
1445	# all passes mentioned by DEFAULT_PASSES.
1446	PASSES := FETCHES PATCHES $(DEFAULT_PASSES) INSTALLS TESTING PACKING CLEAN NOTHING
1447
1448
1449	#
1450	# Check for --pretty-command-printing before including the Config.kmk
1451	# so that anyone overriding the message macros can take the implied
1452	# verbosity level change into account.
1453	#
1454	ifndef KBUILD_VERBOSE
1455	ifndef KBUILD_QUIET
1456	ifeq ($(KMK_OPTS_PRETTY_COMMAND_PRINTING),1)
1457	export KBUILD_VERBOSE := 2
1458	endif
1459	endif
1460	endif
1461
1462
1463	#
1464	# Legacy variable translation.
1465	# These will be eliminated when switching to the next version.
1466	#
1467	ifdef USE_KOBJCACHE
1468	ifndef KBUILD_USE_KOBJCACHE
1469	export KBUILD_USE_KOBJCACHE := $(USE_KOBJCACHE)
1470	endif
1471	endif
1472
1473
1474	#
1475	# Library path searching hints (target OS + arch).
1476	#
1477	# KBUILD_LIB_SEARCH_SUBS - Subdirs typically containing the right libraries.
1478	# KBUILD_LIB_SEARCH_ROOTS - Roots to search for library subdirs.
1479	# KBUILD_LIB_SEARCH_PATHS - ROOTS + SUBS.
1480	#
1481	ifeq ($(KBUILD_TARGET),darwin)
1482	KBUILD_LIB_SEARCH_ROOTS := \
1483	/usr/ \
1484	/Developer/usr/
1485	KBUILD_LIB_SEARCH_SUBS := lib/
1486
1487	else if1of ($(KBUILD_TARGET), freebsd openbsd dragonfly)
1488	KBUILD_LIB_SEARCH_ROOTS := \
1489	/ \
1490	/usr/ \
1491	/usr/local/
1492	KBUILD_LIB_SEARCH_SUBS := lib/
1493
1494	else ifeq ($(KBUILD_TARGET),netbsd)
1495	KBUILD_LIB_SEARCH_ROOTS := \
1496	/ \
1497	/usr/ \
1498	/usr/pkg/ \
1499	/usr/local/
1500	KBUILD_LIB_SEARCH_SUBS := lib/
1501
1502	else if1of ($(KBUILD_TARGET), gnukfbsd gnuknbsd linux)
1503	ifeq ($(realpath /bin),/usr/bin)
1504	KBUILD_LIB_SEARCH_ROOTS := \
1505	/usr/ \
1506	/ \
1507	/usr/local/
1508	else
1509	KBUILD_LIB_SEARCH_ROOTS := \
1510	/ \
1511	/usr/ \
1512	/usr/local/
1513	endif
1514	ifeq ($(KBUILD_TARGET_ARCH),amd64)
1515	KBUILD_LIB_SEARCH_SUBS := \
1516	lib/x86_64-linux-gnu/ \
1517	lib64/ \
1518	lib/
1519	else ifeq ($(KBUILD_TARGET_ARCH),x86)
1520	KBUILD_LIB_SEARCH_SUBS := \
1521	lib/i686-linux-gnu/ \
1522	lib/i386-linux-gnu/ \
1523	lib32/ \
1524	lib/
1525	else
1526	KBUILD_LIB_SEARCH_SUBS := lib/
1527	endif
1528
1529	else ifeq ($(KBUILD_TARGET),solaris)
1530	KBUILD_LIB_SEARCH_ROOTS := \
1531	/ \
1532	/usr/ \
1533	/usr/sfw/ \
1534	/usr/local/ \
1535	/sw/
1536	ifeq ($(KBUILD_TARGET_ARCH),amd64)
1537	KBUILD_LIB_SEARCH_SUBS := lib/amd64/ lib/
1538	else ifeq ($(KBUILD_TARGET_ARCH),sparc64)
1539	KBUILD_LIB_SEARCH_SUBS := lib/sparcv9/ lib/
1540	else
1541	KBUILD_LIB_SEARCH_SUBS := lib/
1542	endif
1543
1544	else
1545	KBUILD_LIB_SEARCH_SUBS :=
1546	KBUILD_LIB_SEARCH_ROOTS :=
1547	endif
1548	KBUILD_LIB_SEARCH_PATHS := $(foreach root, $(KBUILD_LIB_SEARCH_ROOTS), $(addprefix $(root),$(KBUILD_LIB_SEARCH_SUBS)))
1549
1550
1551	#
1552	# This is how we find the closest config.kmk.
1553	# It's a little hacky but I think it works fine.
1554	#
1555	_CFGDIR := .
1556	_CFGFILES := ./Config.kmk ./config.kmk
1557	define def_include_config
1558	$(eval _CFGDIR := $(_CFGDIR)/$(dir))
1559	_CFGFILES += $(_CFGDIR)/Config.kmk $(_CFGDIR)/config.kmk
1560	endef
1561	# walk down the _RELATIVE_ path specified by DEPTH.
1562	$(foreach dir,$(subst /, ,$(DEPTH)), $(eval $(def_include_config)) )
1563	# add the default config file.
1564	_CFGFILE := $(firstword $(wildcard $(_CFGFILES) $(FILE_KBUILD_CONFIG)))
1565	_CFGFILES :=
1566	_CFGDIR :=
1567	ifeq ($(_CFGFILE),)
1568	$(error kBuild: no Config.kmk file found! Check the DEPTH: DEPTH='$(DEPTH)' PATH_CURRENT='$(PATH_CURRENT)')
1569	endif
1570
1571	# Include the config.kmk we found file (or the default one).
1572	ifdef KBUILD_PROFILE_SELF
1573	$(evalcall def_profile_self, including $(_CFGFILE))
1574	include $(_CFGFILE)
1575	$(evalcall def_profile_self, included $(_CFGFILE))
1576	else
1577	include $(_CFGFILE)
1578	endif
1579
1580
1581
1582	#
1583	# Finalize a the central path variables now that we've included the Config.kmk file.
1584	#
1585	# This prevents some trouble when users override the defaults for these
1586	# variables and uses relative paths or paths with incorrect case.
1587	#
1588	PATH_OUT_BASE := $(abspath $(PATH_OUT_BASE))
1589	PATH_OUT := $(abspath $(PATH_OUT))
1590	PATH_OBJ := $(abspath $(PATH_OBJ))
1591	PATH_TARGET := $(abspath $(PATH_TARGET))
1592	PATH_INS := $(abspath $(PATH_INS))
1593	PATH_STAGE := $(abspath $(PATH_STAGE))
1594
1595	# Finalize the install and staging directory layouts.
1596	define def_kbuild_finalize_inst
1597	local val := $(strip $($(y)_$(x)))
1598	ifeq ($(val),)
1599	$(error kBuild: '$(y)_$(x)' is set to an empty value.)
1600	endif
1601	ifneq ($(words $(val)),1)
1602	$(error kBuild: The '$(y)_$(x)' value '$(val)' should not contain spaces.)
1603	endif
1604	ifneq ($(pos \,$(val)), 0)
1605	$(error kBuild: The '$(y)_$(x)' value '$(val)' contains DOS slashes: not allowed.)
1606	endif
1607	ifneq ($(pos $(COLON),$(val)), 0)
1608	$(error kBuild: The '$(y)_$(x)' value '$(val)' contains colon: not allowed.)
1609	endif
1610	ifneq ($(substr $(val),-1), /)
1611	$(error kBuild: The '$(y)_$(x)' value '$(val)' has no trailing slash.)
1612	endif
1613	if $(pos /../,$(val)) != 0 \|\| "$(substr $(val), 3)" == "../"
1614	$(error kBuild: The '$(y)_$(x)' value '$(val)' contains dot-dot escape.)
1615	endif
1616	$($(y)_$(x) := $(val)
1617
1618	local val := $(strip $(PATH_$(y)_$(x)))
1619	ifeq ($(val),)
1620	$(error kBuild: 'PATH_$(y)_$(x)' is set to an empty value.)
1621	endif
1622	PATH_$(y)_$(x) := $(val)
1623	endef
1624	$(foreach y, INST STAGE, $(foreach x, $(KBUILD_INST_PATHS), $(evalcall def_kbuild_finalize_inst)))
1625
1626	# No abspath for devtools since they might've been referenced already and we
1627	# don't want conflicting variable expansions.
1628	KBUILD_DEVTOOLS := $(KBUILD_DEVTOOLS)
1629	KBUILD_DEVTOOLS_TRG := $(KBUILD_DEVTOOLS_TRG)
1630	KBUILD_DEVTOOLS_TRG_ALT := $(KBUILD_DEVTOOLS_TRG_ALT)
1631	KBUILD_DEVTOOLS_HST := $(KBUILD_DEVTOOLS_HST)
1632	KBUILD_DEVTOOLS_HST_ALT := $(KBUILD_DEVTOOLS_HST_ALT)
1633
1634
1635	#
1636	# Setup the message style. The default one is inlined.
1637	#
1638	# See kBuild/msgstyles for more styles or use KBUILD_MSG_STYLE_PATHS
1639	# to create your own message style.
1640	#
1641	KBUILD_MSG_STYLE ?= default
1642	ifeq ($(KBUILD_MSG_STYLE),default)
1643	#
1644	# The 'default' style.
1645	#
1646
1647	## Fetch starting.
1648	# @param 1 Target name.
1649	MSG_FETCH ?= $(call MSG_L1,Fetching $1...)
1650	## Re-fetch starting.
1651	# @param 1 Target name.
1652	MSG_REFETCH ?= $(call MSG_L1,Re-fetching $1...)
1653	## Downloading a fetch component.
1654	# @param 1 Target name.
1655	# @param 2 The source URL.
1656	# @param 3 The destination file name.
1657	MSG_FETCH_DL ?= $(call MSG_L1,Downloading $1 - $2,=> $3)
1658	## Checking a fetch component.
1659	# @param 1 Target name.
1660	# @param 2 The source URL.
1661	# @param 3 The destination file name.
1662	MSG_FETCH_CHK?= $(call MSG_L1,Checking $1 - $3, ($2))
1663	## Unpacking a fetch component.
1664	# @param 1 Target name.
1665	# @param 2 The archive file name.
1666	# @param 3 The target directory.
1667	MSG_FETCH_UP ?= $(call MSG_L1,Unpacking $1 - $2 => $3)
1668	## Fetch completed.
1669	# @param 1 Target name.
1670	MSG_FETCH_OK ?= $(call MSG_L1,Successfully fetched $1)
1671	## Unfetch a fetch target.
1672	# @param 1 Target name.
1673	MSG_UNFETCH ?= $(call MSG_L1,Unfetching $1...)
1674	## Compiling a source file.
1675	# @param 1 Target name.
1676	# @param 2 The source filename.
1677	# @param 3 The primary link output file name.
1678	# @param 4 The source type (C,CXX,OBJC,AS,RC,++).
1679	MSG_COMPILE ?= $(call MSG_L1,Compiling $1 - $2,=> $3)
1680	## Tool
1681	# @param 1 The tool name (bin2c,...)
1682	# @param 2 Target name.
1683	# @param 3 The source filename.
1684	# @param 4 The primary output file name.
1685	MSG_TOOL ?= $(call MSG_L1,$1 $2 - $3,=> $4)
1686	## Generate a file, typically a source file.
1687	# @param 1 Target name if applicable.
1688	# @param 2 Output file name.
1689	# @param 3 What it's generated from
1690	MSG_GENERATE ?= $(call MSG_L1,Generating $(if $1,$1 - )$2,$(if $3,from $3))
1691	## Linking a bldprog/dll/program/sysmod target.
1692	# @param 1 Target name.
1693	# @param 2 The primary link output file name.
1694	# @param 3 The link tool operation (LINK_LIBRARY,LINK_PROGRAM,LINK_DLL,LINK_SYSMOD,++).
1695	MSG_LINK ?= $(call MSG_L1,Linking $1,=> $2)
1696	## Merging a library into the target (during library linking).
1697	# @param 1 Target name.
1698	# @param 2 The output library name.
1699	# @param 3 The input library name.
1700	MSG_AR_MERGE ?= $(call MSG_L1,Merging $3 into $1, ($2))
1701	## Creating a directory (build).
1702	# @param 1 Directory name.
1703	MSG_MKDIR ?= $(call MSG_L2,Creating directory $1)
1704	## Cleaning.
1705	MSG_CLEAN ?= $(call MSG_L1,Cleaning...)
1706	## Nothing.
1707	MSG_NOTHING ?= $(call MSG_L1,Did nothing in $(CURDIR))
1708	## Pass
1709	# @param 1 The pass name.
1710	MSG_PASS ?= $(call MSG_L1,Pass - $1)
1711	## Installing a bldprog/lib/dll/program/sysmod target.
1712	# @param 1 Target name.
1713	# @param 2 The source filename.
1714	# @param 3 The destination file name.
1715	MSG_INST_TRG ?= $(call MSG_L1,Installing $1 => $3)
1716	## Installing a file (install target).
1717	# @param 1 The source filename.
1718	# @param 2 The destination filename.
1719	MSG_INST_FILE?= $(call MSG_L1,Installing $2,(<= $1))
1720	## Installing a symlink.
1721	# @param 1 Symlink
1722	# @param 2 Link target
1723	MSG_INST_SYM ?= $(call MSG_L1,Installing symlink $1,=> $2)
1724	## Installing a directory.
1725	# @param 1 Directory name.
1726	MSG_INST_DIR ?= $(call MSG_L1,Installing directory $1)
1727
1728	else
1729	_KBUILD_MSG_STYLE_FILE := $(firstword $(foreach path, $(KBUILD_MSG_STYLE_PATHS) $(KBUILD_PATH)/msgstyles, $(wildcard $(path)/$(KBUILD_MSG_STYLE).kmk)))
1730	ifneq ($(_KBUILD_MSG_STYLE_FILE),)
1731	include $(_KBUILD_MSG_STYLE_FILE)
1732	else
1733	$(error kBuild: Can't find the style setup file for KBUILD_MSG_STYLE '$(KBUILD_MSG_STYLE)')
1734	endif
1735	endif
1736
1737
1738	#
1739	# Message macros.
1740	#
1741	# This is done after including Config.kmk as to allow for
1742	# KBUILD_QUIET and KBUILD_VERBOSE to be configurable.
1743	#
1744	ifdef KBUILD_QUIET
1745	# No output
1746	QUIET := @
1747	QUIET2 := @
1748	MSG_L1 :=
1749	MSG_L2 :=
1750	else
1751	ifndef KBUILD_VERBOSE
1752	# Default output level.
1753	QUIET := @
1754	QUIET2 := @
1755	MSG_L1 ?= %@$(ECHO) "kBuild: $1"
1756	MSG_L2 :=
1757	else ifeq ($(KBUILD_VERBOSE),1)
1758	# A bit more output
1759	QUIET := @
1760	QUIET2 := @
1761	MSG_L1 ?= %@$(ECHO) "kBuild: $1 $2"
1762	MSG_L2 :=
1763	else ifeq ($(KBUILD_VERBOSE),2)
1764	# Lot more output
1765	QUIET :=
1766	QUIET2 := @
1767	MSG_L1 ?= %@$(ECHO) "kBuild: $1 $2"
1768	MSG_L2 ?= %@$(ECHO) "kBuild: $1"
1769	else
1770	# maximal output.
1771	QUIET :=
1772	QUIET2 :=
1773	MSG_L1 ?= %@$(ECHO) "kBuild: $1 $2"
1774	MSG_L2 ?= %@$(ECHO) "kBuild: $1"
1775	endif
1776	endif
1777
1778
1779	#
1780	# Validate any KBUILD_BLD_TYPES additions and finally the KBUILD_TYPE.
1781	#
1782	if1of ($(KBUILD_BLD_TYPES), $(KBUILD_OSES))
1783	$(error kBuild: found KBUILD_BLD_TYPES in KBUILD_OSES!)
1784	endif
1785	if1of ($(KBUILD_BLD_TYPES), $(KBUILD_ARCHES))
1786	$(error kBuild: found KBUILD_BLD_TYPES in KBUILD_ARCHES!)
1787	endif
1788	if1of ($(KBUILD_OSES), $(KBUILD_ARCHES))
1789	$(error kBuild: found KBUILD_OSES in KBUILD_ARCHES!)
1790	endif
1791	ifn1of ($(KBUILD_TYPE), $(KBUILD_BLD_TYPES))
1792	$(error kBuild: KBUILD_TYPE(=$(KBUILD_TYPE)) is not found in KBUILD_BLD_TYPES(=$(KBUILD_BLD_TYPES))!)
1793	endif
1794
1795
1796	#
1797	# Mark the output and temporary directories as volatile on windows.
1798	#
1799	# This automatically means the directories not listed here are considered
1800	# static and won't be invalidated once we start running compile jobs.
1801	#
1802	ifeq ($(KBUILD_HOST),win)
1803	if $(KBUILD_KMK_REVISION) >= 2886
1804	$(dircache-ctl volatile, $(PATH_OUT_BASE), $(PATH_OUT), $(TEMP), $(TMP), $(TMPDIR), $(TMP))
1805	endif
1806	endif
1807
1808
1809	ifdef KBUILD_PROFILE_SELF
1810	$(evalcall def_profile_self, end of header.kmk)
1811	_KBUILD_TS_HEADER_END := $(_KBUILD_TS_PREV)
1812	endif
1813
1814	# end-of-file-content
1815	__header_kmk__ := 1
1816	endif # !__header_kmk__
1817
1818

Note: See TracBrowser for help on using the repository browser.

Download in other formats:

Original Format