]> git.saurik.com Git - apple/xnu.git/blame_incremental - makedefs/MakeInc.cmd
xnu-7195.60.75.tar.gz
[apple/xnu.git] / makedefs / MakeInc.cmd
... / ...
CommitLineData
1# -*- mode: makefile;-*-
2#
3# Copyright (C) 1999-2020 Apple Inc. All rights reserved.
4#
5# MakeInc.cmd contains command paths for use during
6# the build, as well as make fragments and text
7# strings that may be evaluated as utility functions.
8#
9
10#
11# Commands for the build environment
12#
13
14#
15# Build Logging and Verbosity
16#
17
18ifeq ($(RC_XBS),YES)
19 VERBOSE = YES
20else
21 VERBOSE = NO
22endif
23
24ECHO = echo
25
26ERR = $(ECHO) > /dev/stderr
27PRINTF = printf
28
29QUIET ?= 0
30ifneq ($(QUIET),0)
31 PRINTF = printf > /dev/null
32 ifeq ($(VERBOSE),YES)
33 override VERBOSE = NO
34 endif
35endif
36
37# Helper functions for logging operations.
38LOG_PFX_LEN = 15
39LOG_PFX_LEN_ADJ = $(LOG_PFX_LEN)
40LOG = $(PRINTF) "$2%$4s$(Color0) $3%s$(Color0)\n" "$1"
41
42CONCISE ?= 0
43ifneq ($(CONCISE),0)
44 # Concise logging puts all logs on the same line (CSI K to clear and
45 # carriage return).
46 LOG = $(PRINTF) "$2%$4s$(Color0) $3%s$(Color0)\033[K\r" "$1"
47endif
48
49_LOG_COMP = $(call LOG,$1,$(ColorC),$(ColorF),$(LOG_PFX_LEN_ADJ))
50_LOG_HOST = $(call LOG,$1,$(ColorH),$(ColorF),$(LOG_PFX_LEN))
51_LOG_HOST_LINK = $(call LOG,$1,$(ColorH),$(ColorLF),$(LOG_PFX_LEN))
52
53# Special operations.
54LOG_LDFILELIST = $(call LOG,LDFILELIST,$(ColorL),$(ColorLF),$(LOG_PFX_LEN_ADJ))
55LOG_MIG = $(call LOG,MIG,$(ColorM),$(ColorF),$(LOG_PFX_LEN_ADJ))
56LOG_LD = $(call LOG,LD,$(ColorL),$(ColorF),$(LOG_PFX_LEN_ADJ))
57LOG_ALIGN = $(call LOG,--------->,$(Color0),$(Color0),$(LOG_PFX_LEN))
58
59# Compiling/machine-specific operations.
60LOG_CC = $(call _LOG_COMP,CC)
61LOG_CXX = $(call _LOG_COMP,C++)
62LOG_AS = $(call _LOG_COMP,AS)
63LOG_LTO = $(call _LOG_COMP,LTO)
64LOG_SYMBOLSET = $(call _LOG_COMP,SYMSET)
65LOG_SYMBOLSETPLIST = $(call _LOG_COMP,SYMSETPLIST)
66
67# Host-side operations.
68LOG_IIG = $(call _LOG_HOST,IIG)
69LOG_HOST_CC = $(call _LOG_HOST,CC)
70LOG_HOST_LD = $(call _LOG_HOST,LD)
71LOG_HOST_CODESIGN = $(call _LOG_HOST,CODESIGN)
72LOG_HOST_BISON = $(call _LOG_HOST,BISON)
73LOG_HOST_FLEX = $(call _LOG_HOST,FLEX)
74LOG_INSTALL = $(call _LOG_HOST,INSTALL)
75LOG_INSTALLSYM = $(call _LOG_HOST,INSTALLSYM)
76LOG_INSTALLHDR = $(call _LOG_HOST,INSTALLHDR)
77LOG_INSTALLMACROS = $(call _LOG_HOST,INSTALLMACROS)
78LOG_INSTALLPY = $(call _LOG_HOST,INSTALLPY)
79LOG_MAN = $(call _LOG_HOST,MAN)
80LOG_MANLINK = $(call _LOG_HOST,MANLINK)
81LOG_ALIAS = $(call _LOG_HOST,ALIAS)
82LOG_STRIP = $(call _LOG_HOST,STRIP)
83LOG_DSYMUTIL = $(call _LOG_HOST,DSYMUTIL)
84LOG_LIBTOOL = $(call _LOG_HOST,LIBTOOL)
85LOG_FILEPREP = $(call _LOG_HOST,FILEPREP)
86
87# Host-side linking operations.
88LOG_GENASSYM = $(call _LOG_HOST_LINK,GENASSYM)
89LOG_GENERATE= $(call _LOG_HOST_LINK,GENERATE)
90LOG_CTFCONVERT = $(call _LOG_HOST_LINK,CTFCONVERT)
91LOG_CTFMERGE = $(call _LOG_HOST_LINK,CTFMERGE)
92LOG_CTFINSERT = $(call _LOG_HOST_LINK,CTFINSERT)
93LOG_DSYMUTIL = $(call _LOG_HOST_LINK,DSYMUTIL)
94LOG_SUPPORTED_KPI = $(call _LOG_HOST_LINK,SUPPORTED_KPI)
95
96ifeq ($(VERBOSE),YES)
97 _v =
98 _vstdout =
99 _vstderr =
100 XCRUN = /usr/bin/xcrun -verbose
101else
102 _v = @
103 _vstdout = > /dev/null
104 _vstderr = 2&> /dev/null
105 XCRUN = /usr/bin/xcrun
106endif
107
108VERBOSE_GENERATED_MAKE_FRAGMENTS = NO
109
110#
111# Defaults
112#
113
114SDKROOT ?= macosx
115HOST_SDKROOT ?= macosx
116
117# SDKROOT may be passed as a shorthand like "iphoneos.internal". We
118# must resolve these to a full path and override SDKROOT.
119
120ifeq ($(SDKROOT_RESOLVED),)
121export SDKROOT_RESOLVED := $(shell $(XCRUN) -sdk $(SDKROOT) -show-sdk-path)
122ifeq ($(strip $(SDKROOT)_$(SDKROOT_RESOLVED)),/_)
123export SDKROOT_RESOLVED := /
124endif
125endif
126override SDKROOT = $(SDKROOT_RESOLVED)
127
128ifeq ($(HOST_SDKROOT_RESOLVED),)
129export HOST_SDKROOT_RESOLVED := $(shell $(XCRUN) -sdk $(HOST_SDKROOT) -show-sdk-path)
130ifeq ($(strip $(HOST_SDKROOT_RESOLVED)),)
131export HOST_SDKROOT_RESOLVED := /
132endif
133endif
134override HOST_SDKROOT = $(HOST_SDKROOT_RESOLVED)
135
136ifeq ($(PLATFORM),)
137 export PLATFORMPATH := $(shell $(XCRUN) -sdk $(SDKROOT) -show-sdk-platform-path)
138 export PLATFORM := $(shell echo $(PLATFORMPATH) | sed 's,^.*/\([^/]*\)\.platform$$,\1,')
139 ifeq ($(PLATFORM),)
140 export PLATFORM := MacOSX
141 else ifeq ($(shell echo $(PLATFORM) | tr A-Z a-z),watchos)
142 export PLATFORM := WatchOS
143 endif
144endif
145
146ifeq ($(PLATFORM),MacOSX)
147 ifeq (DriverKit,$(shell echo $(SDKROOT_RESOLVED) | sed 's,^.*/\([^/1-9]*\)[1-9][^/]*\.sdk$$,\1,'))
148 export PLATFORM := DriverKit
149 export DRIVERKIT ?= 1
150 export DRIVERKITROOT ?= /System/DriverKit
151 export DRIVERKITRUNTIMEROOT = $(DRIVERKITROOT)/Runtime
152 endif
153endif
154
155ifeq ($(SDKVERSION),)
156 export SDKVERSION := $(shell $(XCRUN) -sdk $(SDKROOT) -show-sdk-version)
157endif
158
159# CC/CXX get defined by make(1) by default, so we can't check them
160# against the empty string to see if they haven't been set
161ifeq ($(origin CC),default)
162 export CC := $(shell $(XCRUN) -sdk $(SDKROOT) -find clang)
163endif
164ifeq ($(origin CXX),default)
165 export CXX := $(shell $(XCRUN) -sdk $(SDKROOT) -find clang++)
166endif
167ifeq ($(MIG),)
168 export MIG := $(shell $(XCRUN) -sdk $(SDKROOT) -find mig)
169endif
170ifeq ($(MIGCOM),)
171 export MIGCOM := $(shell $(XCRUN) -sdk $(SDKROOT) -find migcom)
172endif
173ifeq ($(MIGCC),)
174 export MIGCC := $(CC)
175endif
176ifeq ($(IIG),)
177 export IIG := $(shell $(XCRUN) -sdk $(SDKROOT) -find iig)
178endif
179ifeq ($(STRIP),)
180 export STRIP := $(shell $(XCRUN) -sdk $(SDKROOT) -find strip)
181endif
182ifeq ($(LIPO),)
183 export LIPO := $(shell $(XCRUN) -sdk $(SDKROOT) -find lipo)
184endif
185ifeq ($(LIBTOOL),)
186 export LIBTOOL := $(shell $(XCRUN) -sdk $(SDKROOT) -find libtool)
187endif
188ifeq ($(NM),)
189 export NM := $(shell $(XCRUN) -sdk $(SDKROOT) -find nm)
190endif
191ifeq ($(UNIFDEF),)
192 export UNIFDEF := $(shell $(XCRUN) -sdk $(SDKROOT) -find unifdef)
193endif
194ifeq ($(DSYMUTIL),)
195 export DSYMUTIL := $(shell $(XCRUN) -sdk $(SDKROOT) -find dsymutil)
196endif
197ifeq ($(CTFCONVERT),)
198 export CTFCONVERT := $(shell $(XCRUN) -sdk $(SDKROOT) -find ctfconvert)
199endif
200ifeq ($(CTFMERGE),)
201 export CTFMERGE := $(shell $(XCRUN) -sdk $(SDKROOT) -find ctfmerge)
202endif
203ifeq ($(CTFINSERT),)
204 export CTFINSERT := $(shell $(XCRUN) -sdk $(SDKROOT) -find ctf_insert)
205endif
206ifeq ($(NMEDIT),)
207 export NMEDIT := $(shell $(XCRUN) -sdk $(SDKROOT) -find nmedit)
208endif
209
210#
211# Platform options
212#
213SUPPORTED_EMBEDDED_PLATFORMS := iPhoneOS iPhoneOSNano tvOS AppleTVOS WatchOS BridgeOS
214SUPPORTED_SIMULATOR_PLATFORMS := iPhoneSimulator iPhoneNanoSimulator tvSimulator AppleTVSimulator WatchSimulator
215SUPPORTED_PLATFORMS := MacOSX DriverKit $(SUPPORTED_SIMULATOR_PLATFORMS) $(SUPPORTED_EMBEDDED_PLATFORMS)
216
217# Platform-specific tools
218EDM_DBPATH ?= $(PLATFORMPATH)/usr/local/standalone/firmware/device_map.db
219
220# Scripts or tools we build ourselves
221#
222# setsegname - Rename segments in a Mach-O object file
223# kextsymboltool - Create kext pseudo-kext Mach-O kexts binaries
224# decomment - Strip out comments to detect whether a file is comments-only
225# installfile - Atomically copy files, esp. when multiple architectures
226# are trying to install the same target header
227# replacecontents - Write contents to a file and update modtime *only* if
228# contents differ
229#
230SEG_HACK = $(OBJROOT)/SETUP/setsegname/setsegname
231KEXT_CREATE_SYMBOL_SET = $(OBJROOT)/SETUP/kextsymboltool/kextsymboltool
232DECOMMENT = $(OBJROOT)/SETUP/decomment/decomment
233NEWVERS = $(SRCROOT)/config/newvers.pl
234INSTALL = $(OBJROOT)/SETUP/installfile/installfile
235REPLACECONTENTS = $(OBJROOT)/SETUP/replacecontents/replacecontents
236JSONCOMPILATIONDB = $(OBJROOT)/SETUP/json_compilation_db/json_compilation_db
237
238# Standard BSD tools
239RM = /bin/rm -f
240RMDIR = /bin/rmdir
241CP = /bin/cp
242MV = /bin/mv
243LN = /bin/ln -fs
244CAT = /bin/cat
245MKDIR = /bin/mkdir -p
246CHMOD = /bin/chmod
247FIND = /usr/bin/find
248XARGS = /usr/bin/xargs
249PAX = /bin/pax
250BASENAME = /usr/bin/basename
251DIRNAME = /usr/bin/dirname
252TR = /usr/bin/tr
253TOUCH = /usr/bin/touch
254SLEEP = /bin/sleep
255AWK = /usr/bin/awk
256SED = /usr/bin/sed
257PLUTIL = /usr/bin/plutil
258
259#
260# Command to generate host binaries. Intentionally not
261# $(CC), which controls the target compiler
262#
263ifeq ($(HOST_OS_VERSION),)
264 export HOST_OS_VERSION := $(shell sw_vers -productVersion)
265endif
266ifeq ($(HOST_CC),)
267 export HOST_CC := $(shell $(XCRUN) -sdk $(HOST_SDKROOT) -find clang)
268endif
269ifeq ($(HOST_FLEX),)
270 export HOST_FLEX := $(shell $(XCRUN) -sdk $(HOST_SDKROOT) -find flex)
271endif
272ifeq ($(HOST_BISON),)
273 export HOST_BISON := $(shell $(XCRUN) -sdk $(HOST_SDKROOT) -find bison)
274endif
275ifeq ($(HOST_GM4),)
276 export HOST_GM4 := $(shell $(XCRUN) -sdk $(HOST_SDKROOT) -find gm4)
277endif
278ifeq ($(HOST_CODESIGN),)
279 export HOST_CODESIGN := /usr/bin/codesign
280endif
281ifeq ($(HOST_CODESIGN_ALLOCATE),)
282 export HOST_CODESIGN_ALLOCATE := $(shell $(XCRUN) -sdk $(HOST_SDKROOT) -find codesign_allocate)
283endif
284
285#
286# The following variables are functions invoked with "call", and thus
287# behave similarly to externally compiled commands
288#
289
290# $(1) is an expanded kernel config from a TARGET_CONFIGS_UC tuple
291# $(2) is an expanded arch config from a TARGET_CONFIGS_UC tuple
292# $(3) is an expanded machine config from a TARGET_CONFIGS_UC tuple
293_function_create_build_configs_join = $(strip $(1))^$(strip $(2))^$(strip $(3))
294
295# $(1) is an un-expanded kernel config from a TARGET_CONFIGS_UC tuple
296# $(2) is an un-expanded arch config from a TARGET_CONFIGS_UC tuple
297# $(3) is an un-expanded machine config from a TARGET_CONFIGS_UC tuple
298_function_create_build_configs_do_expand = $(call _function_create_build_configs_join, \
299 $(if $(filter DEFAULT,$(1)), \
300 $(DEFAULT_KERNEL_CONFIG), \
301 $(1) \
302 ), \
303 $(if $(filter DEFAULT,$(2)), \
304 $(DEFAULT_ARCH_CONFIG), \
305 $(2) \
306 ), \
307 $(if $(filter DEFAULT,$(3)), \
308 $(if $(filter DEFAULT,$(2)), \
309 $(DEFAULT_$(DEFAULT_ARCH_CONFIG)_MACHINE_CONFIG), \
310 $(DEFAULT_$(strip $(2))_MACHINE_CONFIG) \
311 ), \
312 $(3) \
313 ) \
314 )
315
316# $(1) is an un-expanded TARGET_CONFIGS_UC list, which must be consumed
317# 3 elements at a time
318function_create_build_configs = $(sort \
319 $(strip \
320 $(call _function_create_build_configs_do_expand, \
321 $(word 1,$(1)), \
322 $(word 2,$(1)), \
323 $(word 3,$(1)), \
324 ) \
325 $(if $(word 4,$(1)), \
326 $(call function_create_build_configs, \
327 $(wordlist 4,$(words $(1)),$(1)) \
328 ), \
329 ) \
330 ) \
331 )
332
333# Similar to build configs, but alias configs are a 4-tuple
334
335# $(1) is an expanded kernel config from a TARGET_CONFIGS_ALIASES_UC tuple
336# $(2) is an expanded arch config from a TARGET_CONFIGS_ALIASES_UC tuple
337# $(3) is an expanded kernel machine config from a TARGET_CONFIGS_ALIASES_UC tuple
338# $(4) is an expanded SoC platform config from a TARGET_CONFIGS_ALIASES_UC tuple,
339# which should be an alias of $(3)
340_function_create_alias_configs_join = $(strip $(1))^$(strip $(2))^$(strip $(3))^$(strip $(4))
341
342_function_create_alias_configs_do_expand = $(call _function_create_alias_configs_join, \
343 $(if $(filter DEFAULT,$(1)), \
344 $(DEFAULT_KERNEL_CONFIG), \
345 $(1) \
346 ), \
347 $(if $(filter DEFAULT,$(2)), \
348 $(DEFAULT_ARCH_CONFIG), \
349 $(2) \
350 ), \
351 $(3), \
352 $(4) \
353 )
354
355function_create_alias_configs = $(sort \
356 $(strip \
357 $(call _function_create_alias_configs_do_expand, \
358 $(word 1,$(1)), \
359 $(word 2,$(1)), \
360 $(word 3,$(1)), \
361 $(word 4,$(1)), \
362 ) \
363 $(if $(word 5,$(1)), \
364 $(call function_create_alias_configs, \
365 $(wordlist 5,$(words $(1)),$(1)) \
366 ), \
367 ) \
368 ) \
369 )
370
371# $(1) is a fully-expanded kernel config
372# $(2) is a fully-expanded arch config
373# $(3) is a fully-expanded machine config. "NONE" is not represented in the objdir path
374function_convert_target_config_uc_to_objdir = $(if $(filter NONE,$(3)),$(strip $(1))_$(strip $(2)),$(strip $(1))_$(strip $(2))_$(strip $(3)))
375
376# $(1) is a fully-expanded build config (like "RELEASE^X86_64^NONE")
377function_convert_build_config_to_objdir = $(call function_convert_target_config_uc_to_objdir, \
378 $(word 1,$(subst ^, ,$(1))), \
379 $(word 2,$(subst ^, ,$(1))), \
380 $(word 3,$(subst ^, ,$(1))) \
381 )
382
383# $(1) is a fully-expanded build config (like "RELEASE^X86_64^NONE")
384function_extract_kernel_config_from_build_config = $(word 1,$(subst ^, ,$(1)))
385function_extract_arch_config_from_build_config = $(word 2,$(subst ^, ,$(1)))
386function_extract_machine_config_from_build_config = $(word 3,$(subst ^, ,$(1)))
387
388# $(1) is an input word
389# $(2) is a list of colon-separate potential substitutions like "FOO:BAR BAZ:QUX"
390# $(3) is a fallback if no substitutions were made
391function_substitute_word_with_replacement = $(strip $(if $(2), \
392 $(if $(filter $(word 1,$(subst :, ,$(word 1,$(2)))),$(1)), \
393 $(word 2,$(subst :, ,$(word 1,$(2)))), \
394 $(call function_substitute_word_with_replacement,$(1),$(wordlist 2,$(words $(2)),$(2)),$(3))), \
395 $(3) \
396 ) \
397 )
398
399# You can't assign a variable to an empty space without these
400# shenanigans
401empty :=
402space := $(empty) $(empty)
403
404# Arithmetic
405# $(1) is the number to increment
406NUM32 = x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x
407increment = $(words x $(wordlist 1,$(1),$(NUM32)))
408decrement = $(words $(wordlist 2,$(1),$(NUM32)))
409
410# Create a sequence from 1 to $(1)
411# F(N) = if N > 0: return F(N-1) + "N" else: return ""
412sequence = $(if $(wordlist 1,$(1),$(NUM32)),$(call sequence,$(call decrement,$(1))) $(1),)
413
414# Reverse a list of words in $(1)
415reverse = $(if $(word 2,$(1)),$(call reverse,$(wordlist 2,$(words $(1)),$(1)))) $(word 1,$(1))
416
417# vim: set ft=make: