]> rtime.felk.cvut.cz Git - coffee/buildroot.git/blob - fs/common.mk
fs: introduce a macro for reproducible command
[coffee/buildroot.git] / fs / common.mk
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
30 FS_DIR = $(BUILD_DIR)/buildroot-fs
31 FULL_DEVICE_TABLE = $(FS_DIR)/device_table.txt
32 ROOTFS_DEVICE_TABLES = $(call qstrip,$(BR2_ROOTFS_DEVICE_TABLE) \
33         $(BR2_ROOTFS_STATIC_DEVICE_TABLE))
34 USERS_TABLE = $(FS_DIR)/users_table.txt
35 ROOTFS_USERS_TABLES = $(call qstrip,$(BR2_ROOTFS_USERS_TABLES))
36
37 ifeq ($(BR2_REPRODUCIBLE),y)
38 define ROOTFS_REPRODUCIBLE
39         find $(TARGET_DIR) -print0 | xargs -0 -r touch -hd @$(SOURCE_DATE_EPOCH)
40 endef
41 endif
42
43 ROOTFS_COMMON_TAR = $(FS_DIR)/rootfs.common.tar
44
45 .PHONY: rootfs-common
46 rootfs-common: $(ROOTFS_COMMON_TAR)
47
48 ROOTFS_COMMON_DEPENDENCIES = \
49         host-fakeroot host-makedevs \
50         $(if $(PACKAGES_USERS)$(ROOTFS_USERS_TABLES),host-mkpasswd)
51
52 .PHONY: $(ROOTFS_COMMON_TAR)
53 # When doing the common tarball, we're not really doing a rootfs.
54 $(ROOTFS_COMMON_TAR): ROOTFS=
55 $(ROOTFS_COMMON_TAR): $(ROOTFS_COMMON_DEPENDENCIES) target-finalize
56         @:
57
58 rootfs-common-show-depends:
59         @echo $(ROOTFS_COMMON_DEPENDENCIES)
60
61 # Since this function will be called from within an $(eval ...)
62 # all variable references except the arguments must be $$-quoted.
63 define inner-rootfs
64
65 ROOTFS_$(2)_DIR = $$(FS_DIR)/$(1)
66 ROOTFS_$(2)_TARGET_DIR = $$(BASE_TARGET_DIR)
67
68 ROOTFS_$(2)_DEPENDENCIES += rootfs-common
69
70 ifeq ($$(BR2_TARGET_ROOTFS_$(2)_GZIP),y)
71 ROOTFS_$(2)_COMPRESS_EXT = .gz
72 ROOTFS_$(2)_COMPRESS_CMD = gzip -9 -c
73 endif
74 ifeq ($$(BR2_TARGET_ROOTFS_$(2)_BZIP2),y)
75 ROOTFS_$(2)_COMPRESS_EXT = .bz2
76 ROOTFS_$(2)_COMPRESS_CMD = bzip2 -9 -c
77 endif
78 ifeq ($$(BR2_TARGET_ROOTFS_$(2)_LZMA),y)
79 ROOTFS_$(2)_DEPENDENCIES += host-lzma
80 ROOTFS_$(2)_COMPRESS_EXT = .lzma
81 ROOTFS_$(2)_COMPRESS_CMD = $$(LZMA) -9 -c
82 endif
83 ifeq ($$(BR2_TARGET_ROOTFS_$(2)_LZ4),y)
84 ROOTFS_$(2)_DEPENDENCIES += host-lz4
85 ROOTFS_$(2)_COMPRESS_EXT = .lz4
86 ROOTFS_$(2)_COMPRESS_CMD = lz4 -l -9 -c
87 endif
88 ifeq ($$(BR2_TARGET_ROOTFS_$(2)_LZO),y)
89 ROOTFS_$(2)_DEPENDENCIES += host-lzop
90 ROOTFS_$(2)_COMPRESS_EXT = .lzo
91 ROOTFS_$(2)_COMPRESS_CMD = $$(LZOP) -9 -c
92 endif
93 ifeq ($$(BR2_TARGET_ROOTFS_$(2)_XZ),y)
94 ROOTFS_$(2)_DEPENDENCIES += host-xz
95 ROOTFS_$(2)_COMPRESS_EXT = .xz
96 ROOTFS_$(2)_COMPRESS_CMD = xz -9 -C crc32 -c
97 endif
98
99 $$(BINARIES_DIR)/rootfs.$(1): ROOTFS=$(2)
100 $$(BINARIES_DIR)/rootfs.$(1): FAKEROOT_SCRIPT=$$(ROOTFS_$(2)_DIR)/fakeroot
101 $$(BINARIES_DIR)/rootfs.$(1): $$(ROOTFS_$(2)_DEPENDENCIES)
102         @$$(call MESSAGE,"Generating root filesystem image rootfs.$(1)")
103         rm -rf $(FS_DIR) $$(ROOTFS_$(2)_DIR)
104         mkdir -p $(FS_DIR) $$(ROOTFS_$(2)_DIR)
105         echo '#!/bin/sh' > $$(FAKEROOT_SCRIPT)
106         echo "set -e" >> $$(FAKEROOT_SCRIPT)
107         $$(foreach hook,$$(ROOTFS_$(2)_PRE_GEN_HOOKS),\
108                 $$(call PRINTF,$$($$(hook))) >> $$(FAKEROOT_SCRIPT)$$(sep))
109         echo "chown -h -R 0:0 $$(TARGET_DIR)" >> $$(FAKEROOT_SCRIPT)
110 ifneq ($$(ROOTFS_USERS_TABLES),)
111         cat $$(ROOTFS_USERS_TABLES) >> $$(USERS_TABLE)
112 endif
113         $$(call PRINTF,$$(PACKAGES_USERS)) >> $$(USERS_TABLE)
114         PATH=$$(BR_PATH) $$(TOPDIR)/support/scripts/mkusers $$(USERS_TABLE) $$(TARGET_DIR) >> $$(FAKEROOT_SCRIPT)
115 ifneq ($$(ROOTFS_DEVICE_TABLES),)
116         cat $$(ROOTFS_DEVICE_TABLES) > $$(FULL_DEVICE_TABLE)
117 ifeq ($$(BR2_ROOTFS_DEVICE_CREATION_STATIC),y)
118         $$(call PRINTF,$$(PACKAGES_DEVICES_TABLE)) >> $$(FULL_DEVICE_TABLE)
119 endif
120 endif
121         $$(call PRINTF,$$(PACKAGES_PERMISSIONS_TABLE)) >> $$(FULL_DEVICE_TABLE)
122         echo "$$(HOST_DIR)/bin/makedevs -d $$(FULL_DEVICE_TABLE) $$(TARGET_DIR)" >> $$(FAKEROOT_SCRIPT)
123         $$(foreach s,$$(call qstrip,$$(BR2_ROOTFS_POST_FAKEROOT_SCRIPT)),\
124                 echo "echo '$$(TERM_BOLD)>>>   Executing fakeroot script $$(s)$$(TERM_RESET)'" >> $$(FAKEROOT_SCRIPT); \
125                 echo $$(EXTRA_ENV) $$(s) $$(TARGET_DIR) $$(BR2_ROOTFS_POST_SCRIPT_ARGS) >> $$(FAKEROOT_SCRIPT)$$(sep))
126         $$(foreach hook,$$(ROOTFS_PRE_CMD_HOOKS),\
127                 $$(call PRINTF,$$($$(hook))) >> $$(FAKEROOT_SCRIPT)$$(sep))
128         $$(call PRINTF,$$(ROOTFS_REPRODUCIBLE)) >> $$(FAKEROOT_SCRIPT)
129         $$(call PRINTF,$$(ROOTFS_$(2)_CMD)) >> $$(FAKEROOT_SCRIPT)
130         $$(foreach hook,$$(ROOTFS_POST_CMD_HOOKS),\
131                 $$(call PRINTF,$$($$(hook))) >> $$(FAKEROOT_SCRIPT)$$(sep))
132         chmod a+x $$(FAKEROOT_SCRIPT)
133         rm -f $$(TARGET_DIR_WARNING_FILE)
134         PATH=$$(BR_PATH) $$(HOST_DIR)/bin/fakeroot -- $$(FAKEROOT_SCRIPT)
135         $$(INSTALL) -m 0644 support/misc/target-dir-warning.txt $$(TARGET_DIR_WARNING_FILE)
136 ifneq ($$(ROOTFS_$(2)_COMPRESS_CMD),)
137         PATH=$$(BR_PATH) $$(ROOTFS_$(2)_COMPRESS_CMD) $$@ > $$@$$(ROOTFS_$(2)_COMPRESS_EXT)
138 endif
139         $$(foreach hook,$$(ROOTFS_$(2)_POST_GEN_HOOKS),$$(call $$(hook))$$(sep))
140
141 rootfs-$(1)-show-depends:
142         @echo $$(ROOTFS_$(2)_DEPENDENCIES)
143
144 rootfs-$(1): $$(BINARIES_DIR)/rootfs.$(1)
145
146 .PHONY: rootfs-$(1) rootfs-$(1)-show-depends
147
148 ifeq ($$(BR2_TARGET_ROOTFS_$(2)),y)
149 TARGETS_ROOTFS += rootfs-$(1)
150 PACKAGES += $$(filter-out rootfs-%,$$(ROOTFS_$(2)_DEPENDENCIES))
151 endif
152
153 # Check for legacy POST_TARGETS rules
154 ifneq ($$(ROOTFS_$(2)_POST_TARGETS),)
155 $$(error Filesystem $(1) uses post-target rules, which are no longer supported.\
156         Update $(1) to use post-gen hooks instead)
157 endif
158
159 endef
160
161 # $(pkgname) also works well to return the filesystem name
162 rootfs = $(call inner-rootfs,$(pkgname),$(call UPPERCASE,$(pkgname)))
163
164 include $(sort $(wildcard fs/*/*.mk))