Skip to contentSkip to conversation

kbuild: add .DELETE_ON_ERROR special target

PATCH New Masahiro Yamada 2 participants 4 messages Jan 11, 2019 – Jan 16, 2019 Kbuild

lore
Share & tools
lore
#0 lore raw

PATCH 1/2 kbuild: add .DELETE_ON_ERROR special target

Linux commit 9c2af1c7377a8a6ef86e5cabf80978f3dbbb25c0

If Make gets a fatal signal while a shell is executing, it may delete the target file that the recipe was supposed to update. This is needed to make sure that it is remade from scratch when Make is next run; if Make is interrupted after the recipe has begun to write the target file, it results in an incomplete file whose time stamp is newer than that of the prerequisites files. Make automatically deletes the incomplete file on interrupt unless the target is marked .PRECIOUS.

The situation is just the same as when the shell fails for some reasons. Usually when a recipe line fails, if it has changed the target file at all, the file is corrupted, or at least it is not completely updated. Yet the file’s time stamp says that it is now up to date, so the next time Make runs, it will not try to update that file.

However, Make does not cater to delete the incomplete target file in this case. We need to add .DELETE_ON_ERROR somewhere in the Makefile to request it.

scripts/Kbuild.include seems a suitable place to add it because it is included from almost all sub-makes.

---

 scripts/Kbuild.include | 3 +++
 1 file changed, 3 insertions(+)
scripts/Kbuild.include +3 -0
index 13ebddd..460acd6 100644
@@ -315,6 +315,9 @@ why =                                                                        \
 echo-why = $(call escsq, $(strip $(why)))
 endif
 
+# delete partially updated (i.e. corrupted) files on error
+.DELETE_ON_ERROR:
+
 ifdef CONFIG_SPL_BUILD
 SPL_ := SPL_
 ifeq ($(CONFIG_TPL_BUILD),y)
Signature · 1 line
2.7.4
#1 lore raw

PATCH 2/2 kbuild: add .SECONDARY special target to scripts/Kbuild.include

Based on the following Linux commits:

- 54a702f70589 ("kbuild: mark $(targets) as .SECONDARY and remove .PRECIOUS markers")

- 8e9b61b293d9 ("kbuild: move .SECONDARY special target to Kbuild.include")

GNU Make automatically deletes intermediate files that are updated in a chain of pattern rules.

Example 1) %.dtb.o <- %.dtb.S <- %.dtb <- %.dts
Example 2) %.o <- %.c <- %.c_shipped

A couple of makefiles mark such targets as .PRECIOUS to prevent Make from deleting them, but the correct way is to use .SECONDARY.

.SECONDARY
Prerequisites of this special target are treated as intermediate files but are never automatically deleted.

.PRECIOUS
When make is interrupted during execution, it may delete the target file it is updating if the file was modified since make started. If you mark the file as precious, make will never delete the file if interrupted.

Both can avoid deletion of intermediate files, but the difference is the behavior when Make is interrupted; .SECONDARY deletes the target, but .PRECIOUS does not.

The use of .PRECIOUS is relatively rare since we do not want to keep partially constructed (possibly corrupted) targets.

.SECONDARY with no prerequisites causes all targets to be treated as secondary. This agrees the policy of Kbuild.

scripts/Kbuild.include seems a suitable place to add it because it is included from almost all sub-makes.

---

 dts/Makefile                  | 3 ---
 examples/standalone/Makefile  | 1 -
 post/lib_powerpc/fpu/Makefile | 3 ---
 scripts/Kbuild.include        | 3 +++
 scripts/Makefile.build        | 2 --
 scripts/Makefile.lib          | 3 ---
 6 files changed, 3 insertions(+), 12 deletions(-)
dts/Makefile +0 -3
index cd6e9a9..a7a6043 100644
@@ -43,9 +43,6 @@ endif
 arch-dtbs:
 	$(Q)$(MAKE) $(build)=$(ARCH_PATH) dtbs
 
-.SECONDARY: $(obj)/dt.dtb.S $(obj)/dt-spl.dtb.S
-
-
 ifeq ($(CONFIG_SPL_BUILD),y)
 obj-$(CONFIG_OF_EMBED) := dt-spl.dtb.o
 # support "out-of-tree" build for dtb-spl
examples/standalone/Makefile +0 -1
index f01816f..0b17a91 100644
@@ -26,7 +26,6 @@ LIB	= $(obj)/libstubs.o
 LIBOBJS-$(CONFIG_PPC) += ppc_longjmp.o ppc_setjmp.o
 LIBOBJS-y += stubs.o
 
-.SECONDARY: $(call objectify,$(COBJS))
 targets += $(patsubst $(obj)/%,%,$(LIB)) $(COBJS) $(LIBOBJS-y)
 
 LIBOBJS	:= $(addprefix $(obj)/,$(LIBOBJS-y))
post/lib_powerpc/fpu/Makefile +0 -3
index 404eefc..9b2c1fa 100644
@@ -11,9 +11,6 @@ targets += $(objs-before-objcopy)
 $(foreach m, $(objs-before-objcopy), $(eval CFLAGS_REMOVE_$m := -msoft-float))
 ccflags-y := -mhard-float -fkeep-inline-functions
 
-# Do not delete intermidiate files (*.o)
-.SECONDARY: $(call objectify, $(objs-before-objcopy))
-
 obj-y := $(objs-before-objcopy:.o=_.o)
 
 OBJCOPYFLAGS := -R .gnu.attributes
scripts/Kbuild.include +3 -0
index 460acd6..b8969e2 100644
@@ -318,6 +318,9 @@ endif
 # delete partially updated (i.e. corrupted) files on error
 .DELETE_ON_ERROR:
 
+# do not delete intermediate files automatically
+.SECONDARY:
+
 ifdef CONFIG_SPL_BUILD
 SPL_ := SPL_
 ifeq ($(CONFIG_TPL_BUILD),y)
scripts/Makefile.build +0 -2
index 482ed0c..f7a0412 100644
@@ -331,8 +331,6 @@ quiet_cmd_asn1_compiler = ASN.1   $@
       cmd_asn1_compiler = $(objtree)/scripts/asn1_compiler $< \
 				$(subst .h,.c,$@) $(subst .c,.h,$@)
 
-.PRECIOUS: $(objtree)/$(obj)/%-asn1.c $(objtree)/$(obj)/%-asn1.h
-
 $(obj)/%-asn1.c $(obj)/%-asn1.h: $(src)/%.asn1 $(objtree)/scripts/asn1_compiler
 	$(call cmd,asn1_compiler)
 
scripts/Makefile.lib +0 -3
index a4f16bb..a5b57fc 100644
@@ -214,7 +214,6 @@ endef
 quiet_cmd_flex = LEX     $@
       cmd_flex = $(LEX) -o$@ -L $<
 
-.PRECIOUS: $(obj)/%.lex.c
 $(obj)/%.lex.c: $(src)/%.l FORCE
 	$(call if_changed,flex)
 
@@ -223,14 +222,12 @@ $(obj)/%.lex.c: $(src)/%.l FORCE
 quiet_cmd_bison = YACC    $@
       cmd_bison = $(YACC) -o$@ -t -l $<
 
-.PRECIOUS: $(obj)/%.tab.c
 $(obj)/%.tab.c: $(src)/%.y FORCE
 	$(call if_changed,bison)
 
 quiet_cmd_bison_h = YACC    $@
       cmd_bison_h = $(YACC) -o/dev/null --defines=$@ -t -l $<
 
-.PRECIOUS: $(obj)/%.tab.h
 $(obj)/%.tab.h: $(src)/%.y FORCE
 	$(call if_changed,bison_h)
 
Signature · 1 line
2.7.4
#2 lore raw

PATCH 2/2 kbuild: add .SECONDARY special target to scripts/Kbuild.include

Quoted 34 lines · Masahiro Yamada

Based on the following Linux commits:

- 54a702f70589 ("kbuild: mark $(targets) as .SECONDARY and remove .PRECIOUS markers")

- 8e9b61b293d9 ("kbuild: move .SECONDARY special target to Kbuild.include")

GNU Make automatically deletes intermediate files that are updated in a chain of pattern rules.

Example 1) %.dtb.o <- %.dtb.S <- %.dtb <- %.dts
Example 2) %.o <- %.c <- %.c_shipped

A couple of makefiles mark such targets as .PRECIOUS to prevent Make from deleting them, but the correct way is to use .SECONDARY.

.SECONDARY
Prerequisites of this special target are treated as intermediate files but are never automatically deleted.

.PRECIOUS
When make is interrupted during execution, it may delete the target file it is updating if the file was modified since make started. If you mark the file as precious, make will never delete the file if interrupted.

Both can avoid deletion of intermediate files, but the difference is the behavior when Make is interrupted; .SECONDARY deletes the target, but .PRECIOUS does not.

The use of .PRECIOUS is relatively rare since we do not want to keep partially constructed (possibly corrupted) targets.

Quoted 7 lines

.SECONDARY with no prerequisites causes all targets to be treated as secondary. This agrees the policy of Kbuild.

scripts/Kbuild.include seems a suitable place to add it because it is included from almost all sub-makes.

Applied to u-boot/master, thanks!

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
URL: <http://lists.denx.de/pipermail/u-boot/attachments/20190116/ddf29055/attachment.sig>
#3 lore raw

PATCH 1/2 kbuild: add .DELETE_ON_ERROR special target

In reply to Masahiro Yamada
Quoted 16 lines · Masahiro Yamada

Linux commit 9c2af1c7377a8a6ef86e5cabf80978f3dbbb25c0

If Make gets a fatal signal while a shell is executing, it may delete the target file that the recipe was supposed to update. This is needed to make sure that it is remade from scratch when Make is next run; if Make is interrupted after the recipe has begun to write the target file, it results in an incomplete file whose time stamp is newer than that of the prerequisites files. Make automatically deletes the incomplete file on interrupt unless the target is marked .PRECIOUS.

The situation is just the same as when the shell fails for some reasons. Usually when a recipe line fails, if it has changed the target file at all, the file is corrupted, or at least it is not completely updated. Yet the file’s time stamp says that it is now up to date, so the next time Make runs, it will not try to update that file.

Quoted 8 lines

However, Make does not cater to delete the incomplete target file in this case. We need to add .DELETE_ON_ERROR somewhere in the Makefile to request it.

scripts/Kbuild.include seems a suitable place to add it because it is included from almost all sub-makes.

Applied to u-boot/master, thanks!

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
URL: <http://lists.denx.de/pipermail/u-boot/attachments/20190116/545a274c/attachment.sig>