Remove dependency of check subcmd upon orc
cover Remove dependency of check subcmd upon orc
Hi,
Matt Helsley's change[1] provided a base framework to opt-in/out objtool subcommands at compile time. This makes it easier for architectures to port objtool, one subcommand at a time.
Orc generation relies on the check operation implementation. However, the way this is done causes the check implementation to depend on the implementation of orc generation functions to call if orc generation is requested. This means that in order to implement check subcmd, orc subcmd also need to be implemented.
These patches aim at removing that dependency, having orc subcmd being built on top of the check subcmd.
[1] https://www.spinics.net/lists/kernel/msg3510844.html
Cheers,
Julien Thierry (4):
objtool: Move object file loading out of check
objtool: Move orc outside of check
objtool: orc: Skip setting orc_entry for non-text sections
objtool: orc_gen: Move orc_entry out of instruction structure
tools/objtool/builtin-check.c | 7 ++- tools/objtool/builtin-orc.c | 24 +++++++++- tools/objtool/check.c | 45 ++++-------------- tools/objtool/check.h | 1 - tools/objtool/objtool.c | 30 ++++++++++++ tools/objtool/objtool.h | 5 +- tools/objtool/orc_gen.c | 86 ++++++++++++++++++++--------------- tools/objtool/weak.c | 4 +- 8 files changed, 122 insertions(+), 80 deletions(-)
--
2.21.1
PATCH 1/4 objtool: Move object file loading out of check
Structure objtool_file can be used by different subcommands. In fact it already is, by check and orc.
Provide a function that allows to initialize objtool_file, that builtin can call, without relying on check to do the correct setup for them and explicitly hand the objtool_file to them.
--- tools/objtool/builtin-check.c | 7 ++++++- tools/objtool/builtin-orc.c | 8 +++++++- tools/objtool/check.c | 37 +++++++++++------------------------ tools/objtool/objtool.c | 29 +++++++++++++++++++++++++++ tools/objtool/objtool.h | 4 +++- tools/objtool/weak.c | 4 +--- 6 files changed, 57 insertions(+), 32 deletions(-)
tools/objtool/builtin-check.c +6 -1
@@ -41,6 +41,7 @@ const struct option check_options[] = {int cmd_check (int argc,const char **argv) {const char *objname, *s; +struct objtool_file *file; argc =parse_options (argc, argv, check_options, check_usage,0 );
@@ -53,5 +54,9 @@ int cmd_check(int argc, const char **argv)if (s && !s[9 ]) vmlinux = true; -return check (objname, false); + file =objtool_setup_file (objname, false); +if (!file) +return 1 ; + +return check (file, false); }
tools/objtool/builtin-orc.c +7 -1
@@ -31,13 +31,19 @@ int cmd_orc(int argc, const char **argv)usage_with_options (orc_usage, check_options);if (!strncmp (argv[0 ],"gen" ,3 )) { +struct objtool_file *file; + argc =parse_options (argc, argv, check_options, orc_usage,0 );if (argc !=1 )usage_with_options (orc_usage, check_options); objname = argv[0 ]; -return check (objname, true); + file =objtool_setup_file (objname, true); +if (!file) +return 1 ; + +return check (file, true); }if (!strcmp (argv[0 ],"dump" )) {
tools/objtool/check.c +11 -26
@@ -26,7 +26,6 @@ struct alternative {bool skip_orig; }; -const char *objname;struct cfi_init_state initial_func_cfi; struct instruction *find_insn(struct objtool_file *file,
@@ -2710,36 +2709,22 @@ static int validate_reachable_instructions(struct objtool_file *file)return 0 ; } -static struct objtool_file file; - -int check (const char *_objname,bool orc) +int check (struct objtool_file *file,bool orc) {int ret, warnings =0 ; - objname = _objname; - - file.elf =elf_open_read (objname, orc ?O_RDWR :O_RDONLY ); -if (!file.elf) -return 1 ; - -INIT_LIST_HEAD (&file.insn_list); -hash_init (file.insn_hash); - file.c_file =find_section_by_name (file.elf,".comment" ); - file.ignore_unreachables = no_unreachable; - file.hints = false; -arch_initial_func_cfi_state (&initial_func_cfi); - ret =decode_sections (&file); + ret =decode_sections (file);if (ret <0 ) goto out; warnings += ret; -if (list_empty (&file.insn_list)) +if (list_empty (&file->insn_list)) goto out;if (vmlinux && !validate_dup) { - ret =validate_vmlinux_functions (&file); + ret =validate_vmlinux_functions (file);if (ret <0 ) goto out;
@@ -2748,39 +2733,39 @@ int check(const char *_objname, bool orc) }if (retpoline) { - ret =validate_retpoline (&file); + ret =validate_retpoline (file);if (ret <0 )return ret; warnings += ret; } - ret =validate_functions (&file); + ret =validate_functions (file);if (ret <0 ) goto out; warnings += ret; - ret =validate_unwind_hints (&file,NULL ); + ret =validate_unwind_hints (file,NULL );if (ret <0 ) goto out; warnings += ret;if (!warnings) { - ret =validate_reachable_instructions (&file); + ret =validate_reachable_instructions (file);if (ret <0 ) goto out; warnings += ret; }if (orc) { - ret =create_orc (&file); + ret =create_orc (file);if (ret <0 ) goto out; - ret =create_orc_sections (&file); + ret =create_orc_sections (file);if (ret <0 ) goto out; - ret =elf_write (file.elf); + ret =elf_write (file->elf);if (ret <0 ) goto out; }
tools/objtool/objtool.c +29 -0
@@ -22,6 +22,8 @@#include <linux/kernel.h> #include "builtin.h" +#include "objtool.h" +#include "warn.h" struct cmd_struct {const char *name;
@@ -39,6 +41,33 @@ static struct cmd_struct objtool_cmds[] = {bool help; +const char *objname; +static struct objtool_file file; + +struct objtool_file *objtool_setup_file (const char *_objname,bool writable) +{ +if (objname) { +if (strcmp (objname, _objname)) { +WARN ("won't handle more than one file at a time" ); +return NULL ; + } +return &file; + } + objname = _objname; + + file.elf =elf_open_read (objname, writable ?O_RDWR :O_RDONLY ); +if (!file.elf) +return NULL ; + +INIT_LIST_HEAD (&file.insn_list); +hash_init (file.insn_hash); + file.c_file =find_section_by_name (file.elf,".comment" ); + file.ignore_unreachables = no_unreachable; + file.hints = false; + +return &file; +} +static void cmd_usage (void ) {unsigned int i, longest =0 ;
tools/objtool/objtool.h +3 -1
@@ -19,7 +19,9 @@ struct objtool_file {bool ignore_unreachables, c_file, hints, rodata; }; -int check (const char *objname,bool orc); +struct objtool_file *objtool_setup_file (const char *_objname,bool writable); + +int check (struct objtool_file *file,bool orc);int orc_dump (const char *objname);int create_orc (struct objtool_file *file);int create_orc_sections (struct objtool_file *file);
tools/objtool/weak.c +1 -3
@@ -17,9 +17,7 @@return ENOSYS ; \ }) -const char __weak *objname; - -int __weak check (const char *_objname,bool orc) +int __weak check (struct objtool_file *file,bool orc) {UNSUPPORTED ("check subcommand" ); }
Signature · 1 line
2.21.1
PATCH 2/4 objtool: Move orc outside of check
In reply to Julien ThierryNow that the objtool_file can be obtained outside of the check function, orc generation builtin no longer requires check to explicitly call its orc related functions.
--- tools/objtool/builtin-check.c | 2 +- tools/objtool/builtin-orc.c | 18 +++++++++++++++++- tools/objtool/check.c | 16 +--------------- tools/objtool/objtool.h | 2 +- tools/objtool/weak.c | 2 +- 5 files changed, 21 insertions(+), 19 deletions(-)
tools/objtool/builtin-check.c +1 -1
@@ -58,5 +58,5 @@ int cmd_check(int argc, const char **argv)if (!file)return 1 ; -return check (file, false); +return check (file); }
tools/objtool/builtin-orc.c +17 -1
@@ -32,6 +32,7 @@ int cmd_orc(int argc, const char **argv)if (!strncmp (argv[0 ],"gen" ,3 )) {struct objtool_file *file; +int ret; argc =parse_options (argc, argv, check_options, orc_usage,0 );if (argc !=1 )
@@ -43,7 +44,22 @@ int cmd_orc(int argc, const char **argv)if (!file)return 1 ; -return check (file, true); + ret =check (file); +if (ret) +return ret; + +if (list_empty (&file->insn_list)) +return 0 ; + + ret =create_orc (file); +if (ret <0 ) +return ret; + + ret =create_orc_sections (file); +if (ret <0 ) +return ret; + +return elf_write (file->elf); }if (!strcmp (argv[0 ],"dump" )) {
tools/objtool/check.c +1 -15
@@ -2709,7 +2709,7 @@ static int validate_reachable_instructions(struct objtool_file *file)return 0 ; } -int check (struct objtool_file *file,bool orc) +int check (struct objtool_file *file) {int ret, warnings =0 ;
@@ -2756,20 +2756,6 @@ int check(struct objtool_file *file, bool orc) warnings += ret; } -if (orc) { - ret =create_orc (file); -if (ret <0 ) - goto out; - - ret =create_orc_sections (file); -if (ret <0 ) - goto out; - - ret =elf_write (file->elf); -if (ret <0 ) - goto out; - } - out:if (ret <0 ) {/*
tools/objtool/objtool.h +1 -1
@@ -21,7 +21,7 @@ struct objtool_file {struct objtool_file *objtool_setup_file (const char *_objname,bool writable); -int check (struct objtool_file *file,bool orc); +int check (struct objtool_file *file);int orc_dump (const char *objname);int create_orc (struct objtool_file *file);int create_orc_sections (struct objtool_file *file);
tools/objtool/weak.c +1 -1
@@ -17,7 +17,7 @@return ENOSYS ; \ }) -int __weak check (struct objtool_file *file,bool orc) +int __weak check (struct objtool_file *file) {UNSUPPORTED ("check subcommand" ); }
Signature · 1 line
2.21.1
PATCH 3/4 objtool: orc: Skip setting orc_entry for non-text sections
In reply to Julien ThierryOrc generation is only done for text sections, but some instructions can be found in non-text sections (e.g. .discard.text sections).
Skip setting their orc sections since their whole sections will be skipped for orc generation.
--- tools/objtool/orc_gen.c | 3 +++ 1 file changed, 3 insertions(+)
tools/objtool/orc_gen.c +3 -0
@@ -18,6 +18,9 @@ int create_orc(struct objtool_file *file)struct cfi_reg *cfa = &insn->cfi.cfa;struct cfi_reg *bp = &insn->cfi.regs[CFI_BP ]; +if (!insn->sec->text) +continue ; + orc->end = insn->cfi.end;if (cfa->base ==CFI_UNDEFINED ) {
Signature · 1 line
2.21.1
PATCH 4/4 objtool: orc_gen: Move orc_entry out of instruction structure
In reply to Julien ThierryOne orc_entry is associated with each instruction in the object file, but having the orc_entry contained by the instruction structure forces architectures not implementing the orc subcommands to provide a dummy definition of the orc_entry.
Avoid that by having orc_entries in a separate list, part of the objtool_file.
--- tools/objtool/check.h | 1 - tools/objtool/objtool.c | 1 + tools/objtool/objtool.h | 1 + tools/objtool/orc_gen.c | 83 +++++++++++++++++++++++------------------ 4 files changed, 49 insertions(+), 37 deletions(-)
tools/objtool/check.h +0 -1
@@ -42,7 +42,6 @@ struct instruction {struct symbol *func;struct list_head stack_ops;struct cfi_state cfi; -struct orc_entry orc; }; struct instruction *find_insn(struct objtool_file *file,
tools/objtool/objtool.c +1 -0
@@ -61,6 +61,7 @@ struct objtool_file *objtool_setup_file(const char *_objname, bool writable)INIT_LIST_HEAD (&file.insn_list);hash_init (file.insn_hash); +INIT_LIST_HEAD (&file.orc_data_list); file.c_file =find_section_by_name (file.elf,".comment" ); file.ignore_unreachables = no_unreachable; file.hints = false;
tools/objtool/objtool.h +1 -0
@@ -16,6 +16,7 @@ struct objtool_file {struct elf *elf;struct list_head insn_list;DECLARE_HASHTABLE (insn_hash,20 ); +struct list_head orc_data_list;bool ignore_unreachables, c_file, hints, rodata; };
tools/objtool/orc_gen.c +47 -36
124 lines not on this page · raw message
Signature · 1 line
2.21.1
Re: [PATCH 4/4] objtool: orc_gen: Move orc_entry out of instruction structure
Hi,
a nit below...
Quoted 11 lines · Julien Thierry
One
orc_entryis associated with each instruction in the object file, but having theorc_entrycontained by the instruction structure forces architectures not implementing the orc subcommands to provide a dummy definition of theorc_entry.Avoid that by having
orc_entriesin a separate list, part of theobjtool_file.int
create_orc(struct objtool_file *file)
{tools/objtool/orc_gen.c +0
-0struct instruction *insn;
tools/objtool/orc_gen.c line 29
Quoted 10 lines
tools/objtool/orc_gen.c +5
-1for_each_insn (file, insn) { -struct orc_entry *orc = &insn->orc;struct cfi_reg *cfa = &insn->cfi.cfa;struct cfi_reg *bp = &insn->cfi.regs[CFI_BP ]; +struct orc_entry *orc; +struct orc_data *od; + +if (!insn->sec->text) +continue ;
You have the same check added by the previous check a couple of lines below.
tools/objtool/orc_gen.c line 40
Quoted 10 lines
tools/objtool/orc_gen.c +7
-0+ od =calloc (1 ,sizeof (*od)); +if (!od) +return -1 ; + od->insn = insn; +list_add_tail (&od->list, &file->orc_data_list); + + orc = &od->orc;if (!insn->sec->text)continue ;
Here.
The rest looks good to me, but I should probably check again with a clearer head.
Overall, the patch set is a nice improvement.
Miroslav
Re: [PATCH 4/4] objtool: orc_gen: Move orc_entry out of instruction structure
Hi,
Quoted 39 lines · Miroslav Benes
Hi,
a nit below...
Quoted 13 lines · Julien Thierry
One
orc_entryis associated with each instruction in the object file, but having theorc_entrycontained by the instruction structure forces architectures not implementing the orc subcommands to provide a dummy definition of theorc_entry.Avoid that by having
orc_entriesin a separate list, part of theobjtool_file.int create_orc(struct objtool_file *file) { struct instruction *insn; for_each_insn(file, insn) {tools/objtool/orc_gen.c line 29
Quoted 8 lines
tools/objtool/orc_gen.c +5
-1-struct orc_entry *orc = &insn->orc;struct cfi_reg *cfa = &insn->cfi.cfa;struct cfi_reg *bp = &insn->cfi.regs[CFI_BP ]; +struct orc_entry *orc; +struct orc_data *od; + +if (!insn->sec->text) +continue ;You have the same check added by the previous check a couple of lines below.
Quoted 8 lines
tools/objtool/orc_gen.c +7
-0+ od =calloc (1 ,sizeof (*od)); +if (!od) +return -1 ; + od->insn = insn; +list_add_tail (&od->list, &file->orc_data_list); + + orc = &od->orc;
Quoted 8 lines
Quoted 2 lines
if (!insn->sec->text)
continue;Here.
The rest looks good to me, but I should probably check again with a clearer head.
Ah, I must have messed up the patch splitting/rebasing somewhere. Thanks for pointing it out, this patch shouldn't add the check (but od allocation should happen after the existing check). I'll fix that.
Quoted 2 lines
Overall, the patch set is a nice improvement.
Thanks!
Signature · 1 line
Julien Thierry