Skip to contentSkip to conversation

misc: Enforce .[ch].inc extension for re-included .c/.h files

PATCH In review Philippe Mathieu-Daudé 1 participant 8 messages Jun 8, 2023 RISC-V

lore
Share & tools
lore
#0 lore raw

v2 cover misc: Enforce .[ch].inc extension for re-included .c/.h files

Since v1:
- addressed Richard's easy review comments

Richard, this is what I had before looking at removing exec/helper*. Posting in case it is useful enough before getting there.

--

Follow the convention to use the .inc extension for .c/.h files re-included, as docummented in Coding Style since commit 6a0057aa22:

If you do use template header files they should be named with the ``.c.inc`` or ``.h.inc`` suffix to make it clear they are being included for expansion.

Most of the codebase already uses this extension:

  $ git ls-files | fgrep .inc | wc -l
       155

Rename some files left over.

Philippe Mathieu-Daudé (5):
hw/remote/proxy: Remove dubious 'event_notifier-posix.c' include tests/tcg/aarch64: Rename bti-crt.inc.c -> bti-crt.c.inc target/arm: Rename helper template headers as '.h.inc' target/i386: Rename helper template headers as '.h.inc'
target: Bulk rename 'helper.h' -> 'helper.h.inc' for all targets

 include/exec/helper-gen.h                                 | 2 +-
 include/exec/helper-proto.h                               | 2 +-
 target/alpha/{helper.h => tcg/helper.h.inc}               | 0
 target/arm/tcg/{helper-a64.h => helper-a64.h.inc}         | 0
 target/arm/tcg/{helper-mve.h => helper-mve.h.inc}         | 0
 target/arm/tcg/{helper-sme.h => helper-sme.h.inc}         | 0
 target/arm/tcg/{helper-sve.h => helper-sve.h.inc}         | 0
 target/arm/{helper.h => tcg/helper.h.inc}                 | 8 ++++----
 target/avr/{helper.h => tcg/helper.h.inc}                 | 0
 target/cris/{helper.h => tcg/helper.h.inc}                | 0
 target/hexagon/{helper.h => tcg/helper.h.inc}             | 0
 target/hppa/{helper.h => tcg/helper.h.inc}                | 0
 .../{cc_helper_template.h => cc_helper_template.h.inc}    | 0
 target/i386/{helper.h => tcg/helper.h.inc}                | 6 +++---
 .../i386/{ops_sse_header.h => tcg/ops_sse_header.h.inc}   | 0
 .../shift_helper_template.h.inc}                          | 0
 target/loongarch/{helper.h => tcg/helper.h.inc}           | 0
 target/m68k/{helper.h => tcg/helper.h.inc}                | 0
 target/microblaze/{helper.h => tcg/helper.h.inc}          | 0
 target/mips/{helper.h => tcg/helper.h.inc}                | 0
 target/nios2/{helper.h => tcg/helper.h.inc}               | 0
 target/openrisc/{helper.h => tcg/helper.h.inc}            | 0
 target/ppc/{helper.h => tcg/helper.h.inc}                 | 0
 target/riscv/{helper.h => tcg/helper.h.inc}               | 0
 target/rx/{helper.h => tcg/helper.h.inc}                  | 0
 target/s390x/{helper.h => tcg/helper.h.inc}               | 0
 target/sh4/{helper.h => tcg/helper.h.inc}                 | 0
 target/sparc/{helper.h => tcg/helper.h.inc}               | 0
 target/tricore/{helper.h => tcg/helper.h.inc}             | 0
 target/xtensa/{helper.h => tcg/helper.h.inc}              | 0
 hw/remote/proxy.c                                         | 1 -
 target/alpha/translate.c                                  | 2 +-
 target/arm/tcg/translate.c                                | 2 +-
 target/avr/translate.c                                    | 2 +-
 target/cris/translate.c                                   | 2 +-
 target/hexagon/translate.c                                | 2 +-
 target/hppa/translate.c                                   | 2 +-
 target/i386/tcg/cc_helper.c                               | 8 ++++----
 target/i386/tcg/int_helper.c                              | 8 ++++----
 target/i386/tcg/translate.c                               | 2 +-
 target/loongarch/translate.c                              | 2 +-
 target/m68k/translate.c                                   | 2 +-
 target/microblaze/translate.c                             | 2 +-
 target/mips/tcg/translate.c                               | 2 +-
 target/nios2/translate.c                                  | 2 +-
 target/openrisc/translate.c                               | 2 +-
 target/ppc/translate.c                                    | 2 +-
 target/riscv/translate.c                                  | 2 +-
 target/rx/translate.c                                     | 2 +-
 target/s390x/tcg/translate.c                              | 2 +-
 target/sh4/translate.c                                    | 2 +-
 target/sparc/translate.c                                  | 2 +-
 target/tricore/translate.c                                | 2 +-
 target/xtensa/translate.c                                 | 2 +-
 tests/tcg/aarch64/bti-1.c                                 | 2 +-
 tests/tcg/aarch64/bti-3.c                                 | 2 +-
 tests/tcg/aarch64/{bti-crt.inc.c => bti-crt.c.inc}        | 0
 57 files changed, 40 insertions(+), 41 deletions(-)
 rename target/alpha/{helper.h => tcg/helper.h.inc} (100%)
 rename target/arm/tcg/{helper-a64.h => helper-a64.h.inc} (100%)
 rename target/arm/tcg/{helper-mve.h => helper-mve.h.inc} (100%)
 rename target/arm/tcg/{helper-sme.h => helper-sme.h.inc} (100%)
 rename target/arm/tcg/{helper-sve.h => helper-sve.h.inc} (100%)
 rename target/arm/{helper.h => tcg/helper.h.inc} (99%)
 rename target/avr/{helper.h => tcg/helper.h.inc} (100%)
 rename target/cris/{helper.h => tcg/helper.h.inc} (100%)
 rename target/hexagon/{helper.h => tcg/helper.h.inc} (100%)
 rename target/hppa/{helper.h => tcg/helper.h.inc} (100%)
 rename target/i386/tcg/{cc_helper_template.h => cc_helper_template.h.inc} (100%)
 rename target/i386/{helper.h => tcg/helper.h.inc} (98%)
 rename target/i386/{ops_sse_header.h => tcg/ops_sse_header.h.inc} (100%)
 rename target/i386/{shift_helper_template.h => tcg/shift_helper_template.h.inc} (100%)
 rename target/loongarch/{helper.h => tcg/helper.h.inc} (100%)
 rename target/m68k/{helper.h => tcg/helper.h.inc} (100%)
 rename target/microblaze/{helper.h => tcg/helper.h.inc} (100%)
 rename target/mips/{helper.h => tcg/helper.h.inc} (100%)
 rename target/nios2/{helper.h => tcg/helper.h.inc} (100%)
 rename target/openrisc/{helper.h => tcg/helper.h.inc} (100%)
 rename target/ppc/{helper.h => tcg/helper.h.inc} (100%)
 rename target/riscv/{helper.h => tcg/helper.h.inc} (100%)
 rename target/rx/{helper.h => tcg/helper.h.inc} (100%)
 rename target/s390x/{helper.h => tcg/helper.h.inc} (100%)
 rename target/sh4/{helper.h => tcg/helper.h.inc} (100%)
 rename target/sparc/{helper.h => tcg/helper.h.inc} (100%)
 rename target/tricore/{helper.h => tcg/helper.h.inc} (100%)
 rename target/xtensa/{helper.h => tcg/helper.h.inc} (100%)
 rename tests/tcg/aarch64/{bti-crt.inc.c => bti-crt.c.inc} (100%)
Signature · 1 line
2.38.1
#1 lore raw

PATCH v2 1/5 hw/remote/proxy: Remove dubious 'event_notifier-posix.c' include

event_notifier-posix.c is registered in meson's util_ss[] source set, which is built as libqemuutil.a.p library. Both tools and system emulation binaries are linked with qemuutil, so there is no point in including this source file.

Introduced in commit bd36adb8df ("multi-process: create IOHUB object to handle irq").

---
Note, --enable-multiprocess doesn't seem to be covered in CI.

---
 hw/remote/proxy.c | 1 -
 1 file changed, 1 deletion(-)
hw/remote/proxy.c +0 -1
index 1c7786b52c..2052d721e5 100644
@@ -22,7 +22,6 @@
 #include "qom/object.h"
 #include "qemu/event_notifier.h"
 #include "sysemu/kvm.h"
-#include "util/event_notifier-posix.c"
 
 static void probe_pci_info(PCIDevice *dev, Error **errp);
 static void proxy_device_reset(DeviceState *dev);
Signature · 1 line
2.38.1
#2 lore raw

Re: [PATCH v2 1/5] hw/remote/proxy: Remove dubious 'event_notifier-posix.c' include

Quoted 20 lines · Philippe Mathieu-Daudé

event_notifier-posix.c is registered in meson's util_ss[] source set, which is built as libqemuutil.a.p library. Both tools and system emulation binaries are linked with qemuutil, so there is no point in including this source file.

Introduced in commit bd36adb8df ("multi-process: create IOHUB object to handle irq").

---
Note, --enable-multiprocess doesn't seem to be covered in CI.

---
  hw/remote/proxy.c | 1 -
  1 file changed, 1 deletion(-)
hw/remote/proxy.c +0 -0
index 1c7786b52c..2052d721e5 100644

hw/remote/proxy.c line 25

Quoted 4 lines
hw/remote/proxy.c +0 -1
@@ -22,7 +22,6 @@
  #include "qom/object.h"
  #include "qemu/event_notifier.h"
  #include "sysemu/kvm.h"
-#include "util/event_notifier-posix.c"

Err wrong branch base, please discard this patch which is already in Paolo's queue.

#3 lore raw

PATCH v2 2/5 tests/tcg/aarch64: Rename bti-crt.inc.c -> bti-crt.c.inc

In reply to Philippe Mathieu-Daudé

Since commit 139c1837db ("meson: rename included C source files to .c.inc"), QEMU standard procedure for included C files is to use *.c.inc.

Besides, since commit 6a0057aa22 ("docs/devel: make a statement about includes") this is documented as the Coding Style:

If you do use template header files they should be named with the ``.c.inc`` or ``.h.inc`` suffix to make it clear they are being included for expansion.

Therefore rename 'bti-crt.inc.c' as 'bti-crt.c.inc'.

---
 tests/tcg/aarch64/bti-1.c                          | 2 +-
 tests/tcg/aarch64/bti-3.c                          | 2 +-
 tests/tcg/aarch64/{bti-crt.inc.c => bti-crt.c.inc} | 0
 3 files changed, 2 insertions(+), 2 deletions(-)
 rename tests/tcg/aarch64/{bti-crt.inc.c => bti-crt.c.inc} (100%)
tests/tcg/aarch64/bti-1.c +1 -1
index 61924f0d7a..99a879af23 100644
@@ -2,7 +2,7 @@
  * Branch target identification, basic notskip cases.
  */
 
-#include "bti-crt.inc.c"
+#include "bti-crt.c.inc"
 
 static void skip2_sigill(int sig, siginfo_t *info, ucontext_t *uc)
 {
tests/tcg/aarch64/bti-3.c +1 -1
index a852856d9a..8c534c09d7 100644
@@ -2,7 +2,7 @@
  * BTI vs PACIASP
  */
 
-#include "bti-crt.inc.c"
+#include "bti-crt.c.inc"
 
 static void skip2_sigill(int sig, siginfo_t *info, ucontext_t *uc)
 {
tests/tcg/aarch64/bti-crt.c.inc renamed from tests/tcg/aarch64/bti-crt.inc.c +0 -0
similarity index 100%
rename from tests/tcg/aarch64/bti-crt.inc.c
rename to tests/tcg/aarch64/bti-crt.c.inc
Signature · 1 line
2.38.1
#4 lore raw

PATCH v2 3/5 target/arm: Rename helper template headers as '.h.inc'

In reply to Philippe Mathieu-Daudé

Since commit 139c1837db ("meson: rename included C source files to .c.inc"), QEMU standard procedure for included C files is to use *.c.inc.

Besides, since commit 6a0057aa22 ("docs/devel: make a statement about includes") this is documented as the Coding Style:

If you do use template header files they should be named with the ``.c.inc`` or ``.h.inc`` suffix to make it clear they are being included for expansion.

Therefore rename the included templates as '.h.inc'.

---
 target/arm/helper.h                               | 8 ++++----
 target/arm/tcg/{helper-a64.h => helper-a64.h.inc} | 0
 target/arm/tcg/{helper-mve.h => helper-mve.h.inc} | 0
 target/arm/tcg/{helper-sme.h => helper-sme.h.inc} | 0
 target/arm/tcg/{helper-sve.h => helper-sve.h.inc} | 0
 5 files changed, 4 insertions(+), 4 deletions(-)
 rename target/arm/tcg/{helper-a64.h => helper-a64.h.inc} (100%)
 rename target/arm/tcg/{helper-mve.h => helper-mve.h.inc} (100%)
 rename target/arm/tcg/{helper-sme.h => helper-sme.h.inc} (100%)
 rename target/arm/tcg/{helper-sve.h => helper-sve.h.inc} (100%)
target/arm/helper.h +4 -4
index 3335c2b10b..4218d98b51 100644
@@ -1039,9 +1039,9 @@ DEF_HELPER_FLAGS_5(gvec_uclamp_d, TCG_CALL_NO_RWG,
                    void, ptr, ptr, ptr, ptr, i32)
 
 #ifdef TARGET_AARCH64
-#include "tcg/helper-a64.h"
-#include "tcg/helper-sve.h"
-#include "tcg/helper-sme.h"
+#include "tcg/helper-a64.h.inc"
+#include "tcg/helper-sve.h.inc"
+#include "tcg/helper-sme.h.inc"
 #endif
 
-#include "tcg/helper-mve.h"
+#include "tcg/helper-mve.h.inc"
target/arm/tcg/helper-a64.h.inc renamed from target/arm/tcg/helper-a64.h +0 -0
similarity index 100%
rename from target/arm/tcg/helper-a64.h
rename to target/arm/tcg/helper-a64.h.inc
target/arm/tcg/helper-mve.h.inc renamed from target/arm/tcg/helper-mve.h +0 -0
similarity index 100%
rename from target/arm/tcg/helper-mve.h
rename to target/arm/tcg/helper-mve.h.inc
target/arm/tcg/helper-sme.h.inc renamed from target/arm/tcg/helper-sme.h +0 -0
similarity index 100%
rename from target/arm/tcg/helper-sme.h
rename to target/arm/tcg/helper-sme.h.inc
target/arm/tcg/helper-sve.h.inc renamed from target/arm/tcg/helper-sve.h +0 -0
similarity index 100%
rename from target/arm/tcg/helper-sve.h
rename to target/arm/tcg/helper-sve.h.inc
Signature · 1 line
2.38.1
#5 lore raw

PATCH v2 4/5 target/i386: Rename helper template headers as '.h.inc'

In reply to Philippe Mathieu-Daudé

Since commit 139c1837db ("meson: rename included C source files to .c.inc"), QEMU standard procedure for included C files is to use *.c.inc.

Besides, since commit 6a0057aa22 ("docs/devel: make a statement about includes") this is documented as the Coding Style:

If you do use template header files they should be named with the ``.c.inc`` or ``.h.inc`` suffix to make it clear they are being included for expansion.

Therefore move the included templates in the tcg/ directory and rename as '.h.inc'.

---
 target/i386/helper.h                                      | 6 +++---
 .../{cc_helper_template.h => cc_helper_template.h.inc}    | 0
 .../i386/{ops_sse_header.h => tcg/ops_sse_header.h.inc}   | 0
 .../shift_helper_template.h.inc}                          | 0
 target/i386/tcg/cc_helper.c                               | 8 ++++----
 target/i386/tcg/int_helper.c                              | 8 ++++----
 6 files changed, 11 insertions(+), 11 deletions(-)
 rename target/i386/tcg/{cc_helper_template.h => cc_helper_template.h.inc} (100%)
 rename target/i386/{ops_sse_header.h => tcg/ops_sse_header.h.inc} (100%)
 rename target/i386/{shift_helper_template.h => tcg/shift_helper_template.h.inc} (100%)
target/i386/helper.h +3 -3
index e627a93107..48609c210b 100644
@@ -203,11 +203,11 @@ DEF_HELPER_1(enter_mmx, void, env)
 DEF_HELPER_1(emms, void, env)
 
 #define SHIFT 0
-#include "ops_sse_header.h"
+#include "tcg/ops_sse_header.h.inc"
 #define SHIFT 1
-#include "ops_sse_header.h"
+#include "tcg/ops_sse_header.h.inc"
 #define SHIFT 2
-#include "ops_sse_header.h"
+#include "tcg/ops_sse_header.h.inc"
 
 DEF_HELPER_3(rclb, tl, env, tl, tl)
 DEF_HELPER_3(rclw, tl, env, tl, tl)
target/i386/tcg/cc_helper_template.h.inc renamed from target/i386/tcg/cc_helper_template.h +0 -0
similarity index 100%
rename from target/i386/tcg/cc_helper_template.h
rename to target/i386/tcg/cc_helper_template.h.inc
target/i386/tcg/ops_sse_header.h.inc renamed from target/i386/ops_sse_header.h +0 -0
similarity index 100%
rename from target/i386/ops_sse_header.h
rename to target/i386/tcg/ops_sse_header.h.inc
target/i386/tcg/shift_helper_template.h.inc renamed from target/i386/shift_helper_template.h +0 -0
similarity index 100%
rename from target/i386/shift_helper_template.h
rename to target/i386/tcg/shift_helper_template.h.inc
target/i386/tcg/cc_helper.c +4 -4
index 6227dbb30b..c310bd842f 100644
@@ -58,21 +58,21 @@ const uint8_t parity_table[256] = {
 };
 
 #define SHIFT 0
-#include "cc_helper_template.h"
+#include "cc_helper_template.h.inc"
 #undef SHIFT
 
 #define SHIFT 1
-#include "cc_helper_template.h"
+#include "cc_helper_template.h.inc"
 #undef SHIFT
 
 #define SHIFT 2
-#include "cc_helper_template.h"
+#include "cc_helper_template.h.inc"
 #undef SHIFT
 
 #ifdef TARGET_X86_64
 
 #define SHIFT 3
-#include "cc_helper_template.h"
+#include "cc_helper_template.h.inc"
 #undef SHIFT
 
 #endif
target/i386/tcg/int_helper.c +4 -4
index 599ac968b0..05418f181f 100644
@@ -448,20 +448,20 @@ target_ulong helper_pext(target_ulong src, target_ulong mask)
 }
 
 #define SHIFT 0
-#include "shift_helper_template.h"
+#include "shift_helper_template.h.inc"
 #undef SHIFT
 
 #define SHIFT 1
-#include "shift_helper_template.h"
+#include "shift_helper_template.h.inc"
 #undef SHIFT
 
 #define SHIFT 2
-#include "shift_helper_template.h"
+#include "shift_helper_template.h.inc"
 #undef SHIFT
 
 #ifdef TARGET_X86_64
 #define SHIFT 3
-#include "shift_helper_template.h"
+#include "shift_helper_template.h.inc"
 #undef SHIFT
 #endif
 
Signature · 1 line
2.38.1
#6 lore raw

PATCH v2 5/5 target: Bulk rename 'helper.h' -> 'helper.h.inc' for all targets

In reply to Philippe Mathieu-Daudé

Since commit 139c1837db ("meson: rename included C source files to .c.inc"), QEMU standard procedure for included C files is to use *.c.inc.

Besides, since commit 6a0057aa22 ("docs/devel: make a statement about includes") this is documented as the Coding Style:

If you do use template header files they should be named with the ``.c.inc`` or ``.h.inc`` suffix to make it clear they are being included for expansion.

Therefore rename the included 'helper.h' as 'helper.h.inc' for all targets (updating the documentation).

Unfortunately since the HELPER_H path definition is used by all targets, we have to do all changes in a single bulk commit.

Mechanical change doing:

  $ for t_a in target/*; do \
      if test -f ${t_a}/helper.h; then \
        mkdir -p ${t_a}/tcg; \
        git mv ${t_a}/helper.h ${t_a}/tcg/helper.h.inc; \
      fi; \
    done
  $ sed -i \
    -e 's#define HELPER_H "helper.h"#define HELPER_H "tcg/helper.h.inc"#' \
       $(git grep -l 'define HELPER_H')

then manually updating files in include/exec/ and docs/.

---
 include/exec/helper-gen.h                        | 2 +-
 include/exec/helper-proto.h                      | 2 +-
 target/alpha/{helper.h => tcg/helper.h.inc}      | 0
 target/arm/{helper.h => tcg/helper.h.inc}        | 0
 target/avr/{helper.h => tcg/helper.h.inc}        | 0
 target/cris/{helper.h => tcg/helper.h.inc}       | 0
 target/hexagon/{helper.h => tcg/helper.h.inc}    | 0
 target/hppa/{helper.h => tcg/helper.h.inc}       | 0
 target/i386/{helper.h => tcg/helper.h.inc}       | 0
 target/loongarch/{helper.h => tcg/helper.h.inc}  | 0
 target/m68k/{helper.h => tcg/helper.h.inc}       | 0
 target/microblaze/{helper.h => tcg/helper.h.inc} | 0
 target/mips/{helper.h => tcg/helper.h.inc}       | 0
 target/nios2/{helper.h => tcg/helper.h.inc}      | 0
 target/openrisc/{helper.h => tcg/helper.h.inc}   | 0
 target/ppc/{helper.h => tcg/helper.h.inc}        | 0
 target/riscv/{helper.h => tcg/helper.h.inc}      | 0
 target/rx/{helper.h => tcg/helper.h.inc}         | 0
 target/s390x/{helper.h => tcg/helper.h.inc}      | 0
 target/sh4/{helper.h => tcg/helper.h.inc}        | 0
 target/sparc/{helper.h => tcg/helper.h.inc}      | 0
 target/tricore/{helper.h => tcg/helper.h.inc}    | 0
 target/xtensa/{helper.h => tcg/helper.h.inc}     | 0
 target/alpha/translate.c                         | 2 +-
 target/arm/tcg/translate.c                       | 2 +-
 target/avr/translate.c                           | 2 +-
 target/cris/translate.c                          | 2 +-
 target/hexagon/translate.c                       | 2 +-
 target/hppa/translate.c                          | 2 +-
 target/i386/tcg/translate.c                      | 2 +-
 target/loongarch/translate.c                     | 2 +-
 target/m68k/translate.c                          | 2 +-
 target/microblaze/translate.c                    | 2 +-
 target/mips/tcg/translate.c                      | 2 +-
 target/nios2/translate.c                         | 2 +-
 target/openrisc/translate.c                      | 2 +-
 target/ppc/translate.c                           | 2 +-
 target/riscv/translate.c                         | 2 +-
 target/rx/translate.c                            | 2 +-
 target/s390x/tcg/translate.c                     | 2 +-
 target/sh4/translate.c                           | 2 +-
 target/sparc/translate.c                         | 2 +-
 target/tricore/translate.c                       | 2 +-
 target/xtensa/translate.c                        | 2 +-
 44 files changed, 23 insertions(+), 23 deletions(-)
 rename target/alpha/{helper.h => tcg/helper.h.inc} (100%)
 rename target/arm/{helper.h => tcg/helper.h.inc} (100%)
 rename target/avr/{helper.h => tcg/helper.h.inc} (100%)
 rename target/cris/{helper.h => tcg/helper.h.inc} (100%)
 rename target/hexagon/{helper.h => tcg/helper.h.inc} (100%)
 rename target/hppa/{helper.h => tcg/helper.h.inc} (100%)
 rename target/i386/{helper.h => tcg/helper.h.inc} (100%)
 rename target/loongarch/{helper.h => tcg/helper.h.inc} (100%)
 rename target/m68k/{helper.h => tcg/helper.h.inc} (100%)
 rename target/microblaze/{helper.h => tcg/helper.h.inc} (100%)
 rename target/mips/{helper.h => tcg/helper.h.inc} (100%)
 rename target/nios2/{helper.h => tcg/helper.h.inc} (100%)
 rename target/openrisc/{helper.h => tcg/helper.h.inc} (100%)
 rename target/ppc/{helper.h => tcg/helper.h.inc} (100%)
 rename target/riscv/{helper.h => tcg/helper.h.inc} (100%)
 rename target/rx/{helper.h => tcg/helper.h.inc} (100%)
 rename target/s390x/{helper.h => tcg/helper.h.inc} (100%)
 rename target/sh4/{helper.h => tcg/helper.h.inc} (100%)
 rename target/sparc/{helper.h => tcg/helper.h.inc} (100%)
 rename target/tricore/{helper.h => tcg/helper.h.inc} (100%)
 rename target/xtensa/{helper.h => tcg/helper.h.inc} (100%)
include/exec/helper-gen.h +1 -1
index f7ec155699..ca8d82d99a 100644
@@ -9,7 +9,7 @@
 
 #include "exec/helper-gen-common.h"
 
-#define HELPER_H "helper.h"
+#define HELPER_H "tcg/helper.h.inc"
 #include "exec/helper-gen.h.inc"
 #undef  HELPER_H
 
include/exec/helper-proto.h +1 -1
index 6935cb4f16..4d9014e9aa 100644
@@ -9,7 +9,7 @@
 
 #include "exec/helper-proto-common.h"
 
-#define HELPER_H "helper.h"
+#define HELPER_H "tcg/helper.h.inc"
 #include "exec/helper-proto.h.inc"
 #undef  HELPER_H
 
target/alpha/tcg/helper.h.inc renamed from target/alpha/helper.h +0 -0
similarity index 100%
rename from target/alpha/helper.h
rename to target/alpha/tcg/helper.h.inc
target/arm/tcg/helper.h.inc renamed from target/arm/helper.h +0 -0
similarity index 100%
rename from target/arm/helper.h
rename to target/arm/tcg/helper.h.inc
target/avr/tcg/helper.h.inc renamed from target/avr/helper.h +0 -0
similarity index 100%
rename from target/avr/helper.h
rename to target/avr/tcg/helper.h.inc
target/cris/tcg/helper.h.inc renamed from target/cris/helper.h +0 -0
similarity index 100%
rename from target/cris/helper.h
rename to target/cris/tcg/helper.h.inc
target/hexagon/tcg/helper.h.inc renamed from target/hexagon/helper.h +0 -0
similarity index 100%
rename from target/hexagon/helper.h
rename to target/hexagon/tcg/helper.h.inc
target/hppa/tcg/helper.h.inc renamed from target/hppa/helper.h +0 -0
similarity index 100%
rename from target/hppa/helper.h
rename to target/hppa/tcg/helper.h.inc
target/i386/tcg/helper.h.inc renamed from target/i386/helper.h +0 -0
similarity index 100%
rename from target/i386/helper.h
rename to target/i386/tcg/helper.h.inc
target/loongarch/tcg/helper.h.inc renamed from target/loongarch/helper.h +0 -0
similarity index 100%
rename from target/loongarch/helper.h
rename to target/loongarch/tcg/helper.h.inc
target/m68k/tcg/helper.h.inc renamed from target/m68k/helper.h +0 -0
similarity index 100%
rename from target/m68k/helper.h
rename to target/m68k/tcg/helper.h.inc
target/microblaze/tcg/helper.h.inc renamed from target/microblaze/helper.h +0 -0
similarity index 100%
rename from target/microblaze/helper.h
rename to target/microblaze/tcg/helper.h.inc
target/mips/tcg/helper.h.inc renamed from target/mips/helper.h +0 -0
similarity index 100%
rename from target/mips/helper.h
rename to target/mips/tcg/helper.h.inc
target/nios2/tcg/helper.h.inc renamed from target/nios2/helper.h +0 -0
similarity index 100%
rename from target/nios2/helper.h
rename to target/nios2/tcg/helper.h.inc
target/openrisc/tcg/helper.h.inc renamed from target/openrisc/helper.h +0 -0
similarity index 100%
rename from target/openrisc/helper.h
rename to target/openrisc/tcg/helper.h.inc
target/ppc/tcg/helper.h.inc renamed from target/ppc/helper.h +0 -0
similarity index 100%
rename from target/ppc/helper.h
rename to target/ppc/tcg/helper.h.inc
target/riscv/tcg/helper.h.inc renamed from target/riscv/helper.h +0 -0
similarity index 100%
rename from target/riscv/helper.h
rename to target/riscv/tcg/helper.h.inc
target/rx/tcg/helper.h.inc renamed from target/rx/helper.h +0 -0
similarity index 100%
rename from target/rx/helper.h
rename to target/rx/tcg/helper.h.inc
target/s390x/tcg/helper.h.inc renamed from target/s390x/helper.h +0 -0
similarity index 100%
rename from target/s390x/helper.h
rename to target/s390x/tcg/helper.h.inc
target/sh4/tcg/helper.h.inc renamed from target/sh4/helper.h +0 -0
similarity index 100%
rename from target/sh4/helper.h
rename to target/sh4/tcg/helper.h.inc
target/sparc/tcg/helper.h.inc renamed from target/sparc/helper.h +0 -0
similarity index 100%
rename from target/sparc/helper.h
rename to target/sparc/tcg/helper.h.inc
target/tricore/tcg/helper.h.inc renamed from target/tricore/helper.h +0 -0
similarity index 100%
rename from target/tricore/helper.h
rename to target/tricore/tcg/helper.h.inc
target/xtensa/tcg/helper.h.inc renamed from target/xtensa/helper.h +0 -0
similarity index 100%
rename from target/xtensa/helper.h
rename to target/xtensa/tcg/helper.h.inc
target/alpha/translate.c +1 -1
index 1f7dd078d8..291e09640d 100644
@@ -30,7 +30,7 @@
 #include "exec/translator.h"
 #include "exec/log.h"
 
-#define HELPER_H "helper.h"
+#define HELPER_H "tcg/helper.h.inc"
 #include "exec/helper-info.c.inc"
 #undef  HELPER_H
 
target/arm/tcg/translate.c +1 -1
index 13c88ba1b9..75db6960cd 100644
@@ -29,7 +29,7 @@
 #include "cpregs.h"
 #include "exec/helper-proto.h"
 
-#define HELPER_H "helper.h"
+#define HELPER_H "tcg/helper.h.inc"
 #include "exec/helper-info.c.inc"
 #undef  HELPER_H
 
target/avr/translate.c +1 -1
index ef2edd7415..0bfa217d95 100644
@@ -30,7 +30,7 @@
 #include "exec/log.h"
 #include "exec/translator.h"
 
-#define HELPER_H "helper.h"
+#define HELPER_H "tcg/helper.h.inc"
 #include "exec/helper-info.c.inc"
 #undef  HELPER_H
 
target/cris/translate.c +1 -1
index 1445cd8bb5..89e9f3ee36 100644
@@ -37,7 +37,7 @@
 #include "exec/helper-gen.h"
 #include "exec/log.h"
 
-#define HELPER_H "helper.h"
+#define HELPER_H "tcg/helper.h.inc"
 #include "exec/helper-info.c.inc"
 #undef  HELPER_H
 
target/hexagon/translate.c +1 -1
index 708339198e..cf95de7314 100644
@@ -33,7 +33,7 @@
 #include "genptr.h"
 #include "printinsn.h"
 
-#define HELPER_H "helper.h"
+#define HELPER_H "tcg/helper.h.inc"
 #include "exec/helper-info.c.inc"
 #undef  HELPER_H
 
target/hppa/translate.c +1 -1
index d33813d173..f6b531166c 100644
@@ -29,7 +29,7 @@
 #include "exec/translator.h"
 #include "exec/log.h"
 
-#define HELPER_H "helper.h"
+#define HELPER_H "tcg/helper.h.inc"
 #include "exec/helper-info.c.inc"
 #undef  HELPER_H
 
target/i386/tcg/translate.c +1 -1
index 5cf14311a6..695b88e992 100644
@@ -34,7 +34,7 @@
 
 #include "exec/log.h"
 
-#define HELPER_H "helper.h"
+#define HELPER_H "tcg/helper.h.inc"
 #include "exec/helper-info.c.inc"
 #undef  HELPER_H
 
target/loongarch/translate.c +1 -1
index 3146a2d4ac..056d20334f 100644
@@ -23,7 +23,7 @@
 TCGv cpu_gpr[32], cpu_pc;
 static TCGv cpu_lladdr, cpu_llval;
 
-#define HELPER_H "helper.h"
+#define HELPER_H "tcg/helper.h.inc"
 #include "exec/helper-info.c.inc"
 #undef  HELPER_H
 
target/m68k/translate.c +1 -1
index 551ef9e52a..559cf46920 100644
@@ -34,7 +34,7 @@
 #include "exec/log.h"
 #include "fpu/softfloat.h"
 
-#define HELPER_H "helper.h"
+#define HELPER_H "tcg/helper.h.inc"
 #include "exec/helper-info.c.inc"
 #undef  HELPER_H
 
target/microblaze/translate.c +1 -1
index 7e7f837c63..564fcda876 100644
@@ -31,7 +31,7 @@
 
 #include "exec/log.h"
 
-#define HELPER_H "helper.h"
+#define HELPER_H "tcg/helper.h.inc"
 #include "exec/helper-info.c.inc"
 #undef  HELPER_H
 
target/mips/tcg/translate.c +1 -1
index 74af91e4f5..e884faf22f 100644
@@ -32,7 +32,7 @@
 #include "disas/disas.h"
 #include "fpu_helper.h"
 
-#define HELPER_H "helper.h"
+#define HELPER_H "tcg/helper.h.inc"
 #include "exec/helper-info.c.inc"
 #undef  HELPER_H
 
target/nios2/translate.c +1 -1
index a365ad8293..c9649fc5c8 100644
@@ -34,7 +34,7 @@
 #include "qemu/qemu-print.h"
 #include "semihosting/semihost.h"
 
-#define HELPER_H "helper.h"
+#define HELPER_H "tcg/helper.h.inc"
 #include "exec/helper-info.c.inc"
 #undef  HELPER_H
 
target/openrisc/translate.c +1 -1
index 7760329e75..152f93dec5 100644
@@ -34,7 +34,7 @@
 
 #include "exec/log.h"
 
-#define HELPER_H "helper.h"
+#define HELPER_H "tcg/helper.h.inc"
 #include "exec/helper-info.c.inc"
 #undef  HELPER_H
 
target/ppc/translate.c +1 -1
index 37fd431870..b20f3316aa 100644
@@ -41,7 +41,7 @@
 #include "qemu/qemu-print.h"
 #include "qapi/error.h"
 
-#define HELPER_H "helper.h"
+#define HELPER_H "tcg/helper.h.inc"
 #include "exec/helper-info.c.inc"
 #undef  HELPER_H
 
target/riscv/translate.c +1 -1
index 933b11c50d..a2d25052b3 100644
@@ -33,7 +33,7 @@
 #include "instmap.h"
 #include "internals.h"
 
-#define HELPER_H "helper.h"
+#define HELPER_H "tcg/helper.h.inc"
 #include "exec/helper-info.c.inc"
 #undef  HELPER_H
 
target/rx/translate.c +1 -1
index 08cabbde61..fdc091a2f4 100644
@@ -28,7 +28,7 @@
 #include "exec/translator.h"
 #include "exec/log.h"
 
-#define HELPER_H "helper.h"
+#define HELPER_H "tcg/helper.h.inc"
 #include "exec/helper-info.c.inc"
 #undef  HELPER_H
 
target/s390x/tcg/translate.c +1 -1
index a6ee2d4423..b6872ec7d8 100644
@@ -45,7 +45,7 @@
 #include "exec/log.h"
 #include "qemu/atomic128.h"
 
-#define HELPER_H "helper.h"
+#define HELPER_H "tcg/helper.h.inc"
 #include "exec/helper-info.c.inc"
 #undef  HELPER_H
 
target/sh4/translate.c +1 -1
index 49c87d7a01..93d038fc93 100644
@@ -29,7 +29,7 @@
 #include "exec/log.h"
 #include "qemu/qemu-print.h"
 
-#define HELPER_H "helper.h"
+#define HELPER_H "tcg/helper.h.inc"
 #include "exec/helper-info.c.inc"
 #undef  HELPER_H
 
target/sparc/translate.c +1 -1
index bad2ec90a0..45dc59f9a8 100644
@@ -33,7 +33,7 @@
 #include "exec/log.h"
 #include "asi.h"
 
-#define HELPER_H "helper.h"
+#define HELPER_H "tcg/helper.h.inc"
 #include "exec/helper-info.c.inc"
 #undef  HELPER_H
 
target/tricore/translate.c +1 -1
index 8e4f99478c..165a40c333 100644
@@ -33,7 +33,7 @@
 #include "exec/translator.h"
 #include "exec/log.h"
 
-#define HELPER_H "helper.h"
+#define HELPER_H "tcg/helper.h.inc"
 #include "exec/helper-info.c.inc"
 #undef  HELPER_H
 
target/xtensa/translate.c +1 -1
index b7386ff0f0..969b51ac07 100644
@@ -45,7 +45,7 @@
 
 #include "exec/log.h"
 
-#define HELPER_H "helper.h"
+#define HELPER_H "tcg/helper.h.inc"
 #include "exec/helper-info.c.inc"
 #undef  HELPER_H
 
Signature · 1 line
2.38.1
#7 lore raw

Re: [PATCH v2 5/5] target: Bulk rename 'helper.h' -> 'helper.h.inc' for all targets

Quoted 7 lines · Philippe Mathieu-Daudé

Since commit 139c1837db ("meson: rename included C source files to .c.inc"), QEMU standard procedure for included C files is to use *.c.inc.

Besides, since commit 6a0057aa22 ("docs/devel: make a statement about includes") this is documented as the Coding Style:

Quoted 6 lines

If you do use template header files they should be named with the ``.c.inc`` or ``.h.inc`` suffix to make it clear they are being included for expansion.

Therefore rename the included 'helper.h' as 'helper.h.inc' for all targets (

Missing:

"moving the headers which are not in the 'tcg/' subdirectory there and"

Quoted 87 lines

updating the documentation).

Unfortunately since the HELPER_H path definition is used by all targets, we have to do all changes in a single bulk commit.

Mechanical change doing:

   $ for t_a in target/*; do \
       if test -f ${t_a}/helper.h; then \
         mkdir -p ${t_a}/tcg; \
         git mv ${t_a}/helper.h ${t_a}/tcg/helper.h.inc; \
       fi; \
     done
   $ sed -i \
     -e 's#define HELPER_H "helper.h"#define HELPER_H "tcg/helper.h.inc"#' \
        $(git grep -l 'define HELPER_H')

then manually updating files in include/exec/ and docs/.

---
  include/exec/helper-gen.h                        | 2 +-
  include/exec/helper-proto.h                      | 2 +-
  target/alpha/{helper.h => tcg/helper.h.inc}      | 0
  target/arm/{helper.h => tcg/helper.h.inc}        | 0
  target/avr/{helper.h => tcg/helper.h.inc}        | 0
  target/cris/{helper.h => tcg/helper.h.inc}       | 0
  target/hexagon/{helper.h => tcg/helper.h.inc}    | 0
  target/hppa/{helper.h => tcg/helper.h.inc}       | 0
  target/i386/{helper.h => tcg/helper.h.inc}       | 0
  target/loongarch/{helper.h => tcg/helper.h.inc}  | 0
  target/m68k/{helper.h => tcg/helper.h.inc}       | 0
  target/microblaze/{helper.h => tcg/helper.h.inc} | 0
  target/mips/{helper.h => tcg/helper.h.inc}       | 0
  target/nios2/{helper.h => tcg/helper.h.inc}      | 0
  target/openrisc/{helper.h => tcg/helper.h.inc}   | 0
  target/ppc/{helper.h => tcg/helper.h.inc}        | 0
  target/riscv/{helper.h => tcg/helper.h.inc}      | 0
  target/rx/{helper.h => tcg/helper.h.inc}         | 0
  target/s390x/{helper.h => tcg/helper.h.inc}      | 0
  target/sh4/{helper.h => tcg/helper.h.inc}        | 0
  target/sparc/{helper.h => tcg/helper.h.inc}      | 0
  target/tricore/{helper.h => tcg/helper.h.inc}    | 0
  target/xtensa/{helper.h => tcg/helper.h.inc}     | 0
  target/alpha/translate.c                         | 2 +-
  target/arm/tcg/translate.c                       | 2 +-
  target/avr/translate.c                           | 2 +-
  target/cris/translate.c                          | 2 +-
  target/hexagon/translate.c                       | 2 +-
  target/hppa/translate.c                          | 2 +-
  target/i386/tcg/translate.c                      | 2 +-
  target/loongarch/translate.c                     | 2 +-
  target/m68k/translate.c                          | 2 +-
  target/microblaze/translate.c                    | 2 +-
  target/mips/tcg/translate.c                      | 2 +-
  target/nios2/translate.c                         | 2 +-
  target/openrisc/translate.c                      | 2 +-
  target/ppc/translate.c                           | 2 +-
  target/riscv/translate.c                         | 2 +-
  target/rx/translate.c                            | 2 +-
  target/s390x/tcg/translate.c                     | 2 +-
  target/sh4/translate.c                           | 2 +-
  target/sparc/translate.c                         | 2 +-
  target/tricore/translate.c                       | 2 +-
  target/xtensa/translate.c                        | 2 +-
  44 files changed, 23 insertions(+), 23 deletions(-)

rename target/alpha/{helper.h => tcg/helper.h.inc} (100%) rename target/arm/{helper.h => tcg/helper.h.inc} (100%) rename target/avr/{helper.h => tcg/helper.h.inc} (100%) rename target/cris/{helper.h => tcg/helper.h.inc} (100%) rename target/hexagon/{helper.h => tcg/helper.h.inc} (100%) rename target/hppa/{helper.h => tcg/helper.h.inc} (100%) rename target/i386/{helper.h => tcg/helper.h.inc} (100%) rename target/loongarch/{helper.h => tcg/helper.h.inc} (100%) rename target/m68k/{helper.h => tcg/helper.h.inc} (100%) rename target/microblaze/{helper.h => tcg/helper.h.inc} (100%) rename target/mips/{helper.h => tcg/helper.h.inc} (100%) rename target/nios2/{helper.h => tcg/helper.h.inc} (100%) rename target/openrisc/{helper.h => tcg/helper.h.inc} (100%) rename target/ppc/{helper.h => tcg/helper.h.inc} (100%) rename target/riscv/{helper.h => tcg/helper.h.inc} (100%) rename target/rx/{helper.h => tcg/helper.h.inc} (100%) rename target/s390x/{helper.h => tcg/helper.h.inc} (100%) rename target/sh4/{helper.h => tcg/helper.h.inc} (100%) rename target/sparc/{helper.h => tcg/helper.h.inc} (100%) rename target/tricore/{helper.h => tcg/helper.h.inc} (100%) rename target/xtensa/{helper.h => tcg/helper.h.inc} (100%)