Currently objtool headers are being included either by their base name
or included via ../ from a parent directory. In case of a base name usage:
#include "warn.h"
#include "arch_elf.h"
it does not make it apparent from which directory the file comes from.
To make it slightly better, and actually to avoid name clashes some arch
specific files have "arch_" suffix. And files from an arch folder have
to revert to including via ../ e.g:
#include "../../elf.h"
With additional architectures support and the code base growth there is
a need for clearer headers naming scheme for multiple reasons:
1. to make it instantly obvious where these files come from (objtool
itself / objtool arch|generic folders / some other external files),
2. to avoid name clashes of objtool arch specific headers, potential
obtool arch generic headers and the system header files (there is
/usr/include/elf.h already),
3. to avoid ../ includes and improve code readability.
4. to give a warm fuzzy feeling to developers who are mostly kernel
developers and are accustomed to linux kernel headers arranging
scheme.
Doesn't this make it instantly obvious where are these files come from?
#include
#include
And doesn't it look nicer to avoid ugly ../ includes? Which also
guarantees this is elf.h from the objtool and not /usr/include/elf.h.
#include
This patch defines and implements new objtool headers arranging
scheme. Which is:
- all generic headers go to include/objtool (similar to include/linux)
- all arch headers go to arch/$(SRCARCH)/include/arch (to get arch
prefix). This is similar to linux arch specific "asm/*" headers but we
are not abusing "asm" name and calling it what it is. This also helps
to prevent name clashes (arch is not used in system headers or kernel
exports).
To bring objtool to this state the following things are done:
1. current top level tools/objtool/ headers are moved into
include/objtool/ subdirectory,
2. arch specific headers, currently only arch/x86/include/ are moved into
arch/x86/include/arch/ and were stripped of "arch_" suffix,
3. new -I$(srctree)/tools/objtool/include include path to make
includes like possible,
4. rewriting file includes,
5. make git not to ignore include/objtool/ subdirectory.
Signed-off-by: Vasily Gorbik
---
tools/objtool/.gitignore | 2 +-
tools/objtool/Makefile | 1 +
tools/objtool/arch/x86/decode.c| 8
.../objtool/arch/x86/include/{ => arch}/cfi_regs.h | 0
.../arch/x86/include/{arch_elf.h => arch/elf.h}| 0
.../x86/include/{arch_special.h => arch/special.h} | 0
tools/objtool/arch/x86/special.c | 4 ++--
tools/objtool/builtin-check.c | 4 ++--
tools/objtool/builtin-orc.c| 4 ++--
tools/objtool/check.c | 14 +++---
tools/objtool/elf.c| 6 +++---
tools/objtool/{ => include/objtool}/arch.h | 4 ++--
tools/objtool/{ => include/objtool}/builtin.h | 0
tools/objtool/{ => include/objtool}/cfi.h | 2 +-
tools/objtool/{ => include/objtool}/check.h| 4 ++--
tools/objtool/{ => include/objtool}/elf.h | 0
tools/objtool/{ => include/objtool}/objtool.h | 2 +-
tools/objtool/{ => include/objtool}/special.h | 4 ++--
tools/objtool/{ => include/objtool}/warn.h | 2 +-
tools/objtool/objtool.c| 6 +++---
tools/objtool/orc_dump.c | 4 ++--
tools/objtool/orc_gen.c| 4 ++--
tools/objtool/special.c| 8
tools/objtool/weak.c | 2 +-
24 files changed, 43 insertions(+), 42 deletions(-)
rename tools/objtool/arch/x86/include/{ => arch}/cfi_regs.h (100%)
rename tools/objtool/arch/x86/include/{arch_elf.h => arch/elf.h} (100%)
rename tools/objtool/arch/x86/include/{arch_special.h => arch/special.h} (100%)
rename tools/objtool/{ => include/objtool}/arch.h (96%)
rename tools/objtool/{ => include/objtool}/builtin.h (100%)
rename tools/objtool/{ => include/objtool}/cfi.h (96%)
rename tools/objtool/{ => include/objtool}/check.h (96%)
rename tools/objtool/{ => include/objtool}/elf.h (100%)
rename tools/objtool/{ => include/objtool}/objtool.h (96%)
rename tools/objtool/{ => include/objtool}/special.h (94%)
rename tools/objtool/{ => include/objtool}/warn.h (98%)
diff --git a/tools/objtool/.gitignore b/tools/objtool/.gitignore
index 45cefda24c7b..14236db3677f 100644
--- a/tools/objtool/.gitignore
+++ b/tools/objtool/.gitignore
@@ -1,4 +1,4 @@
# SPDX-License-Identifier: GPL-2.0-only
arch/x86/lib/inat-tables.c
-objtool
+/objtool
fixdep
diff --git a/tools/objtool/Makefile b/tools/objtool/Makefile
index 33d1e3ca8efd..0d944a29a357 100644
--- a/tools/objtool/Makefile
+++ b/tools/objtool/Makefile
@@ -36,6 +36,7 @@ all: $(OBJTOOL)
I
