xref: /OK3568_Linux_fs/buildroot/fs/common.mk (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1#
2# Macro that builds the needed Makefile target to create a root
3# filesystem image.
4#
5# The following variable must be defined before calling this macro
6#
7#  ROOTFS_$(FSTYPE)_CMD, the command that generates the root
8#  filesystem image. A single command is allowed. The filename of the
9#  filesystem image that it must generate is $$@.
10#
11# The following variables can optionaly be defined
12#
13#  ROOTFS_$(FSTYPE)_DEPENDENCIES, the list of dependencies needed to
14#  build the root filesystem (usually host tools)
15#
16#  ROOTFS_$(FSTYPE)_PRE_GEN_HOOKS, a list of hooks to call before
17#  generating the filesystem image
18#
19#  ROOTFS_$(FSTYPE)_POST_GEN_HOOKS, a list of hooks to call after
20#  generating the filesystem image
21#
22# In terms of configuration option, this macro assumes that the
23# BR2_TARGET_ROOTFS_$(FSTYPE) config option allows to enable/disable
24# the generation of a filesystem image of a particular type. If
25# the configuration options BR2_TARGET_ROOTFS_$(FSTYPE)_GZIP,
26# BR2_TARGET_ROOTFS_$(FSTYPE)_BZIP2 or
27# BR2_TARGET_ROOTFS_$(FSTYPE)_LZMA exist and are enabled, then the
28# macro will automatically generate a compressed filesystem image.
29
30FS_DIR = $(BUILD_DIR)/buildroot-fs
31ROOTFS_DEVICE_TABLES = $(call qstrip,$(BR2_ROOTFS_DEVICE_TABLE) \
32	$(BR2_ROOTFS_STATIC_DEVICE_TABLE))
33
34ROOTFS_USERS_TABLES = $(call qstrip,$(BR2_ROOTFS_USERS_TABLES))
35
36ROOTFS_FULL_DEVICES_TABLE = $(FS_DIR)/full_devices_table.txt
37ROOTFS_FULL_USERS_TABLE = $(FS_DIR)/full_users_table.txt
38
39ROOTFS_COMMON_NAME = rootfs-common
40ROOTFS_COMMON_TYPE = rootfs
41ROOTFS_COMMON_DEPENDENCIES = \
42	host-fakeroot host-makedevs \
43	$(BR2_TAR_HOST_DEPENDENCY) \
44	$(if $(PACKAGES_USERS)$(ROOTFS_USERS_TABLES),host-mkpasswd)
45
46ifeq ($(BR2_REPRODUCIBLE),y)
47define ROOTFS_REPRODUCIBLE
48	find $(TARGET_DIR) -print0 | xargs -0 -r touch -hd @$(SOURCE_DATE_EPOCH)
49endef
50endif
51
52ifeq ($(BR2_PACKAGE_REFPOLICY),y)
53define ROOTFS_SELINUX
54	$(HOST_DIR)/sbin/setfiles -m -r $(TARGET_DIR) \
55		-c $(TARGET_DIR)/etc/selinux/targeted/policy/policy.$(BR2_PACKAGE_LIBSEPOL_POLICY_VERSION) \
56		$(TARGET_DIR)/etc/selinux/targeted/contexts/files/file_contexts \
57		$(TARGET_DIR)
58endef
59ROOTFS_COMMON_DEPENDENCIES += host-policycoreutils
60endif
61
62ROOTFS_COMMON_FINAL_RECURSIVE_DEPENDENCIES = $(sort \
63	$(if $(filter undefined,$(origin ROOTFS_COMMON_FINAL_RECURSIVE_DEPENDENCIES__X)), \
64		$(eval ROOTFS_COMMON_FINAL_RECURSIVE_DEPENDENCIES__X := \
65			$(foreach p, \
66				$(ROOTFS_COMMON_DEPENDENCIES), \
67				$(p) \
68				$($(call UPPERCASE,$(p))_FINAL_RECURSIVE_DEPENDENCIES) \
69			) \
70		) \
71	) \
72	$(ROOTFS_COMMON_FINAL_RECURSIVE_DEPENDENCIES__X))
73
74.PHONY: rootfs-common
75rootfs-common: $(ROOTFS_COMMON_DEPENDENCIES) target-finalize
76	@$(call MESSAGE,"Generating root filesystems common tables")
77	rm -rf $(FS_DIR)
78	mkdir -p $(FS_DIR)
79
80	$(call PRINTF,$(PACKAGES_USERS)) >> $(ROOTFS_FULL_USERS_TABLE)
81ifneq ($(ROOTFS_USERS_TABLES),)
82	cat $(ROOTFS_USERS_TABLES) >> $(ROOTFS_FULL_USERS_TABLE)
83endif
84
85	$(call PRINTF,$(PACKAGES_PERMISSIONS_TABLE)) > $(ROOTFS_FULL_DEVICES_TABLE)
86ifneq ($(ROOTFS_DEVICE_TABLES),)
87	cat $(ROOTFS_DEVICE_TABLES) >> $(ROOTFS_FULL_DEVICES_TABLE)
88endif
89ifeq ($(BR2_ROOTFS_DEVICE_CREATION_STATIC),y)
90	$(call PRINTF,$(PACKAGES_DEVICES_TABLE)) >> $(ROOTFS_FULL_DEVICES_TABLE)
91endif
92
93rootfs-common-show-depends:
94	@echo $(ROOTFS_COMMON_DEPENDENCIES)
95
96.PHONY: rootfs-common-show-info
97rootfs-common-show-info:
98	@:
99	$(info $(call clean-json,{ $(call json-info,ROOTFS_COMMON) }))
100
101# Since this function will be called from within an $(eval ...)
102# all variable references except the arguments must be $$-quoted.
103define inner-rootfs
104
105ROOTFS_$(2)_NAME = rootfs-$(1)
106ROOTFS_$(2)_TYPE = rootfs
107ROOTFS_$(2)_IMAGE_NAME ?= rootfs.$(1)
108ROOTFS_$(2)_FINAL_IMAGE_NAME = $$(strip $$(ROOTFS_$(2)_IMAGE_NAME))
109ROOTFS_$(2)_DIR = $$(FS_DIR)/$(1)
110ROOTFS_$(2)_TARGET_DIR = $$(ROOTFS_$(2)_DIR)/target
111
112ROOTFS_$(2)_DEPENDENCIES += rootfs-common
113
114ROOTFS_$(2)_FINAL_RECURSIVE_DEPENDENCIES = $$(sort \
115	$$(if $$(filter undefined,$$(origin ROOTFS_$(2)_FINAL_RECURSIVE_DEPENDENCIES__X)), \
116		$$(eval ROOTFS_$(2)_FINAL_RECURSIVE_DEPENDENCIES__X := \
117			$$(foreach p, \
118				$$(ROOTFS_$(2)_DEPENDENCIES), \
119				$$(p) \
120				$$($$(call UPPERCASE,$$(p))_FINAL_RECURSIVE_DEPENDENCIES) \
121			) \
122		) \
123	) \
124	$$(ROOTFS_$(2)_FINAL_RECURSIVE_DEPENDENCIES__X))
125
126ifeq ($$(BR2_TARGET_ROOTFS_$(2)_GZIP),y)
127ROOTFS_$(2)_COMPRESS_EXT = .gz
128ROOTFS_$(2)_COMPRESS_CMD = gzip -9 -c -n
129endif
130ifeq ($$(BR2_TARGET_ROOTFS_$(2)_BZIP2),y)
131ROOTFS_$(2)_COMPRESS_EXT = .bz2
132ROOTFS_$(2)_COMPRESS_CMD = bzip2 -9 -c
133endif
134ifeq ($$(BR2_TARGET_ROOTFS_$(2)_LZMA),y)
135ROOTFS_$(2)_DEPENDENCIES += host-lzma
136ROOTFS_$(2)_COMPRESS_EXT = .lzma
137ROOTFS_$(2)_COMPRESS_CMD = $$(LZMA) -9 -c
138endif
139ifeq ($$(BR2_TARGET_ROOTFS_$(2)_LZ4),y)
140ROOTFS_$(2)_DEPENDENCIES += host-lz4
141ROOTFS_$(2)_COMPRESS_EXT = .lz4
142ROOTFS_$(2)_COMPRESS_CMD = lz4 -l -9 -c
143endif
144ifeq ($$(BR2_TARGET_ROOTFS_$(2)_LZO),y)
145ROOTFS_$(2)_DEPENDENCIES += host-lzop
146ROOTFS_$(2)_COMPRESS_EXT = .lzo
147ROOTFS_$(2)_COMPRESS_CMD = $$(LZOP) -9 -c
148endif
149ifeq ($$(BR2_TARGET_ROOTFS_$(2)_XZ),y)
150ROOTFS_$(2)_DEPENDENCIES += host-xz
151ROOTFS_$(2)_COMPRESS_EXT = .xz
152ROOTFS_$(2)_COMPRESS_CMD = xz -9 -C crc32 -c
153ifeq ($(BR2_REPRODUCIBLE),)
154ROOTFS_$(2)_COMPRESS_CMD += -T $(PARALLEL_JOBS)
155endif
156endif
157ifeq ($(BR2_TARGET_ROOTFS_$(2)_ZSTD),y)
158ROOTFS_$(2)_DEPENDENCIES += host-zstd
159ROOTFS_$(2)_COMPRESS_EXT = .zst
160ROOTFS_$(2)_COMPRESS_CMD = zstd -19 -z -f -T$(PARALLEL_JOBS)
161endif
162
163$$(BINARIES_DIR)/$$(ROOTFS_$(2)_FINAL_IMAGE_NAME): ROOTFS=$(2)
164$$(BINARIES_DIR)/$$(ROOTFS_$(2)_FINAL_IMAGE_NAME): FAKEROOT_SCRIPT=$$(ROOTFS_$(2)_DIR)/fakeroot
165$$(BINARIES_DIR)/$$(ROOTFS_$(2)_FINAL_IMAGE_NAME): $$(ROOTFS_$(2)_DEPENDENCIES)
166	@$$(call MESSAGE,"Generating filesystem image $$(ROOTFS_$(2)_FINAL_IMAGE_NAME)")
167	mkdir -p $$(@D)
168	rm -rf $$(ROOTFS_$(2)_DIR)
169	mkdir -p $$(ROOTFS_$(2)_DIR)
170	rsync -auH \
171		--exclude=/$$(notdir $$(TARGET_DIR_WARNING_FILE)) \
172		$$(BASE_TARGET_DIR)/ \
173		$$(TARGET_DIR)
174
175	echo '#!/bin/sh' > $$(FAKEROOT_SCRIPT)
176	echo "set -e" >> $$(FAKEROOT_SCRIPT)
177
178	echo "chown -h -R 0:0 $$(TARGET_DIR)" >> $$(FAKEROOT_SCRIPT)
179	PATH=$$(BR_PATH) $$(TOPDIR)/support/scripts/mkusers $$(ROOTFS_FULL_USERS_TABLE) $$(TARGET_DIR) >> $$(FAKEROOT_SCRIPT)
180	echo "$$(HOST_DIR)/bin/makedevs -d $$(ROOTFS_FULL_DEVICES_TABLE) $$(TARGET_DIR)" >> $$(FAKEROOT_SCRIPT)
181	$$(foreach hook,$$(ROOTFS_PRE_CMD_HOOKS),\
182		$$(call PRINTF,$$($$(hook))) >> $$(FAKEROOT_SCRIPT)$$(sep))
183	$$(foreach s,$$(call qstrip,$$(BR2_ROOTFS_POST_FAKEROOT_SCRIPT)),\
184		echo "echo '$$(TERM_BOLD)>>>   Executing fakeroot script $$(s)$$(TERM_RESET)'" >> $$(FAKEROOT_SCRIPT); \
185		echo $$(EXTRA_ENV) $$(s) $$(TARGET_DIR) $$(BR2_ROOTFS_POST_SCRIPT_ARGS) >> $$(FAKEROOT_SCRIPT)$$(sep))
186
187	$$(foreach hook,$$(ROOTFS_$(2)_PRE_GEN_HOOKS),\
188		$$(call PRINTF,$$($$(hook))) >> $$(FAKEROOT_SCRIPT)$$(sep))
189	$$(call PRINTF,$$(ROOTFS_REPRODUCIBLE)) >> $$(FAKEROOT_SCRIPT)
190	$$(call PRINTF,$$(ROOTFS_SELINUX)) >> $$(FAKEROOT_SCRIPT)
191	$$(call PRINTF,$$(ROOTFS_$(2)_CMD)) >> $$(FAKEROOT_SCRIPT)
192	chmod a+x $$(FAKEROOT_SCRIPT)
193	PATH=$$(BR_PATH) FAKEROOTDONTTRYCHOWN=1 $$(HOST_DIR)/bin/fakeroot -- $$(FAKEROOT_SCRIPT)
194	$(Q)rm -rf $$(TARGET_DIR)
195ifneq ($$(ROOTFS_$(2)_COMPRESS_CMD),)
196	PATH=$$(BR_PATH) $$(ROOTFS_$(2)_COMPRESS_CMD) $$@ > $$@$$(ROOTFS_$(2)_COMPRESS_EXT)
197endif
198	$$(foreach hook,$$(ROOTFS_$(2)_POST_GEN_HOOKS),$$(call $$(hook))$$(sep))
199
200rootfs-$(1)-show-depends:
201	@echo $$(ROOTFS_$(2)_DEPENDENCIES)
202
203rootfs-$(1)-show-info:
204	@:
205	$$(info $$(call clean-json,{ $$(call json-info,ROOTFS_$(2)) }))
206
207rootfs-$(1): $$(BINARIES_DIR)/$$(ROOTFS_$(2)_FINAL_IMAGE_NAME)
208
209.PHONY: rootfs-$(1) rootfs-$(1)-show-depends rootfs-$(1)-show-info
210
211ifeq ($$(BR2_TARGET_ROOTFS_$(2)),y)
212TARGETS_ROOTFS += rootfs-$(1)
213PACKAGES += $$(filter-out rootfs-%,$$(ROOTFS_$(2)_FINAL_RECURSIVE_DEPENDENCIES))
214endif
215
216# Check for legacy POST_TARGETS rules
217ifneq ($$(ROOTFS_$(2)_POST_TARGETS),)
218$$(error Filesystem $(1) uses post-target rules, which are no longer supported.\
219	Update $(1) to use post-gen hooks instead)
220endif
221
222endef
223
224# $(pkgname) also works well to return the filesystem name
225rootfs = $(call inner-rootfs,$(pkgname),$(call UPPERCASE,$(pkgname)))
226
227include $(sort $(wildcard fs/*/*.mk))
228