x86/tools: Rename test_get_len to insn_decoder_test
authorMasami Hiramatsu <mhiramat@kernel.org>
Fri, 24 Nov 2017 15:10:25 +0000 (00:10 +0900)
committerIngo Molnar <mingo@kernel.org>
Tue, 12 Dec 2017 12:27:47 +0000 (13:27 +0100)
Rename test_get_len test command to insn_decoder_test
as it a more meaningful name. This also changes some
comments in related files.

Note that this also removes the paragraph about
writing to the Free Software Foundation's mailing
address.

Signed-off-by: Masami Hiramatsu <mhiramat@kernel.org>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Linus Torvalds <torvalds@linux-foundation.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
Link: http://lkml.kernel.org/r/151153622537.22827.14928774603980883278.stgit@devbox
Signed-off-by: Ingo Molnar <mingo@kernel.org>
arch/x86/tools/Makefile
arch/x86/tools/distill.awk
arch/x86/tools/insn_decoder_test.c [new file with mode: 0644]
arch/x86/tools/test_get_len.c [deleted file]

index 972b8e8d939c77ef787c9961cd613ff4d2656cbd..b0d75684d313d55302df10bf1afc733b75c03cfd 100644 (file)
@@ -17,24 +17,24 @@ distill_awk = $(srctree)/arch/x86/tools/distill.awk
 chkobjdump = $(srctree)/arch/x86/tools/chkobjdump.awk
 
 quiet_cmd_posttest = TEST    $@
-      cmd_posttest = ($(OBJDUMP) -v | $(AWK) -f $(chkobjdump)) || $(OBJDUMP) -d -j .text $(objtree)/vmlinux | $(AWK) -f $(distill_awk) | $(obj)/test_get_len $(posttest_64bit) $(posttest_verbose)
+      cmd_posttest = ($(OBJDUMP) -v | $(AWK) -f $(chkobjdump)) || $(OBJDUMP) -d -j .text $(objtree)/vmlinux | $(AWK) -f $(distill_awk) | $(obj)/insn_decoder_test $(posttest_64bit) $(posttest_verbose)
 
 quiet_cmd_sanitytest = TEST    $@
       cmd_sanitytest = $(obj)/insn_sanity $(posttest_64bit) -m 1000000
 
-posttest: $(obj)/test_get_len vmlinux $(obj)/insn_sanity
+posttest: $(obj)/insn_decoder_test vmlinux $(obj)/insn_sanity
        $(call cmd,posttest)
        $(call cmd,sanitytest)
 
-hostprogs-y    += test_get_len insn_sanity
+hostprogs-y    += insn_decoder_test insn_sanity
 
 # -I needed for generated C source and C source which in the kernel tree.
-HOSTCFLAGS_test_get_len.o := -Wall -I$(objtree)/arch/x86/lib/ -I$(srctree)/arch/x86/include/uapi/ -I$(srctree)/arch/x86/include/ -I$(srctree)/arch/x86/lib/ -I$(srctree)/include/uapi/
+HOSTCFLAGS_insn_decoder_test.o := -Wall -I$(objtree)/arch/x86/lib/ -I$(srctree)/arch/x86/include/uapi/ -I$(srctree)/arch/x86/include/ -I$(srctree)/arch/x86/lib/ -I$(srctree)/include/uapi/
 
 HOSTCFLAGS_insn_sanity.o := -Wall -I$(objtree)/arch/x86/lib/ -I$(srctree)/arch/x86/include/ -I$(srctree)/arch/x86/lib/ -I$(srctree)/include/
 
 # Dependencies are also needed.
-$(obj)/test_get_len.o: $(srctree)/arch/x86/lib/insn.c $(srctree)/arch/x86/lib/inat.c $(srctree)/arch/x86/include/asm/inat_types.h $(srctree)/arch/x86/include/asm/inat.h $(srctree)/arch/x86/include/asm/insn.h $(objtree)/arch/x86/lib/inat-tables.c
+$(obj)/insn_decoder_test.o: $(srctree)/arch/x86/lib/insn.c $(srctree)/arch/x86/lib/inat.c $(srctree)/arch/x86/include/asm/inat_types.h $(srctree)/arch/x86/include/asm/inat.h $(srctree)/arch/x86/include/asm/insn.h $(objtree)/arch/x86/lib/inat-tables.c
 
 $(obj)/insn_sanity.o: $(srctree)/arch/x86/lib/insn.c $(srctree)/arch/x86/lib/inat.c $(srctree)/arch/x86/include/asm/inat_types.h $(srctree)/arch/x86/include/asm/inat.h $(srctree)/arch/x86/include/asm/insn.h $(objtree)/arch/x86/lib/inat-tables.c
 
index e0edeccc142921ddeb57ef44c8ef908b4f20f4ef..80cd7d53bd07baf6599f426e7edcd6e2b8c6173a 100644 (file)
@@ -1,6 +1,6 @@
 #!/bin/awk -f
 # SPDX-License-Identifier: GPL-2.0
-# Usage: objdump -d a.out | awk -f distill.awk | ./test_get_len
+# Usage: objdump -d a.out | awk -f distill.awk | ./insn_decoder_test
 # Distills the disassembly as follows:
 # - Removes all lines except the disassembled instructions.
 # - For instructions that exceed 1 line (7 bytes), crams all the hex bytes
diff --git a/arch/x86/tools/insn_decoder_test.c b/arch/x86/tools/insn_decoder_test.c
new file mode 100644 (file)
index 0000000..8be7264
--- /dev/null
@@ -0,0 +1,169 @@
+/*
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * Copyright (C) IBM Corporation, 2009
+ */
+
+#include <stdlib.h>
+#include <stdio.h>
+#include <string.h>
+#include <assert.h>
+#include <unistd.h>
+
+#define unlikely(cond) (cond)
+
+#include <asm/insn.h>
+#include <inat.c>
+#include <insn.c>
+
+/*
+ * Test of instruction analysis in general and insn_get_length() in
+ * particular.  See if insn_get_length() and the disassembler agree
+ * on the length of each instruction in an elf disassembly.
+ *
+ * Usage: objdump -d a.out | awk -f distill.awk | ./insn_decoder_test
+ */
+
+const char *prog;
+static int verbose;
+static int x86_64;
+
+static void usage(void)
+{
+       fprintf(stderr, "Usage: objdump -d a.out | awk -f distill.awk |"
+               " %s [-y|-n] [-v]\n", prog);
+       fprintf(stderr, "\t-y   64bit mode\n");
+       fprintf(stderr, "\t-n   32bit mode\n");
+       fprintf(stderr, "\t-v   verbose mode\n");
+       exit(1);
+}
+
+static void malformed_line(const char *line, int line_nr)
+{
+       fprintf(stderr, "%s: malformed line %d:\n%s", prog, line_nr, line);
+       exit(3);
+}
+
+static void dump_field(FILE *fp, const char *name, const char *indent,
+                      struct insn_field *field)
+{
+       fprintf(fp, "%s.%s = {\n", indent, name);
+       fprintf(fp, "%s\t.value = %d, bytes[] = {%x, %x, %x, %x},\n",
+               indent, field->value, field->bytes[0], field->bytes[1],
+               field->bytes[2], field->bytes[3]);
+       fprintf(fp, "%s\t.got = %d, .nbytes = %d},\n", indent,
+               field->got, field->nbytes);
+}
+
+static void dump_insn(FILE *fp, struct insn *insn)
+{
+       fprintf(fp, "Instruction = {\n");
+       dump_field(fp, "prefixes", "\t",        &insn->prefixes);
+       dump_field(fp, "rex_prefix", "\t",      &insn->rex_prefix);
+       dump_field(fp, "vex_prefix", "\t",      &insn->vex_prefix);
+       dump_field(fp, "opcode", "\t",          &insn->opcode);
+       dump_field(fp, "modrm", "\t",           &insn->modrm);
+       dump_field(fp, "sib", "\t",             &insn->sib);
+       dump_field(fp, "displacement", "\t",    &insn->displacement);
+       dump_field(fp, "immediate1", "\t",      &insn->immediate1);
+       dump_field(fp, "immediate2", "\t",      &insn->immediate2);
+       fprintf(fp, "\t.attr = %x, .opnd_bytes = %d, .addr_bytes = %d,\n",
+               insn->attr, insn->opnd_bytes, insn->addr_bytes);
+       fprintf(fp, "\t.length = %d, .x86_64 = %d, .kaddr = %p}\n",
+               insn->length, insn->x86_64, insn->kaddr);
+}
+
+static void parse_args(int argc, char **argv)
+{
+       int c;
+       prog = argv[0];
+       while ((c = getopt(argc, argv, "ynv")) != -1) {
+               switch (c) {
+               case 'y':
+                       x86_64 = 1;
+                       break;
+               case 'n':
+                       x86_64 = 0;
+                       break;
+               case 'v':
+                       verbose = 1;
+                       break;
+               default:
+                       usage();
+               }
+       }
+}
+
+#define BUFSIZE 256
+
+int main(int argc, char **argv)
+{
+       char line[BUFSIZE], sym[BUFSIZE] = "<unknown>";
+       unsigned char insn_buf[16];
+       struct insn insn;
+       int insns = 0;
+       int warnings = 0;
+
+       parse_args(argc, argv);
+
+       while (fgets(line, BUFSIZE, stdin)) {
+               char copy[BUFSIZE], *s, *tab1, *tab2;
+               int nb = 0;
+               unsigned int b;
+
+               if (line[0] == '<') {
+                       /* Symbol line */
+                       strcpy(sym, line);
+                       continue;
+               }
+
+               insns++;
+               memset(insn_buf, 0, 16);
+               strcpy(copy, line);
+               tab1 = strchr(copy, '\t');
+               if (!tab1)
+                       malformed_line(line, insns);
+               s = tab1 + 1;
+               s += strspn(s, " ");
+               tab2 = strchr(s, '\t');
+               if (!tab2)
+                       malformed_line(line, insns);
+               *tab2 = '\0';   /* Characters beyond tab2 aren't examined */
+               while (s < tab2) {
+                       if (sscanf(s, "%x", &b) == 1) {
+                               insn_buf[nb++] = (unsigned char) b;
+                               s += 3;
+                       } else
+                               break;
+               }
+               /* Decode an instruction */
+               insn_init(&insn, insn_buf, sizeof(insn_buf), x86_64);
+               insn_get_length(&insn);
+               if (insn.length != nb) {
+                       warnings++;
+                       fprintf(stderr, "Warning: %s found difference at %s\n",
+                               prog, sym);
+                       fprintf(stderr, "Warning: %s", line);
+                       fprintf(stderr, "Warning: objdump says %d bytes, but "
+                               "insn_get_length() says %d\n", nb,
+                               insn.length);
+                       if (verbose)
+                               dump_insn(stderr, &insn);
+               }
+       }
+       if (warnings)
+               fprintf(stderr, "Warning: decoded and checked %d"
+                       " instructions with %d warnings\n", insns, warnings);
+       else
+               fprintf(stdout, "Success: decoded and checked %d"
+                       " instructions\n", insns);
+       return 0;
+}
diff --git a/arch/x86/tools/test_get_len.c b/arch/x86/tools/test_get_len.c
deleted file mode 100644 (file)
index ecf31e0..0000000
+++ /dev/null
@@ -1,173 +0,0 @@
-/*
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
- *
- * Copyright (C) IBM Corporation, 2009
- */
-
-#include <stdlib.h>
-#include <stdio.h>
-#include <string.h>
-#include <assert.h>
-#include <unistd.h>
-
-#define unlikely(cond) (cond)
-
-#include <asm/insn.h>
-#include <inat.c>
-#include <insn.c>
-
-/*
- * Test of instruction analysis in general and insn_get_length() in
- * particular.  See if insn_get_length() and the disassembler agree
- * on the length of each instruction in an elf disassembly.
- *
- * Usage: objdump -d a.out | awk -f distill.awk | ./test_get_len
- */
-
-const char *prog;
-static int verbose;
-static int x86_64;
-
-static void usage(void)
-{
-       fprintf(stderr, "Usage: objdump -d a.out | awk -f distill.awk |"
-               " %s [-y|-n] [-v]\n", prog);
-       fprintf(stderr, "\t-y   64bit mode\n");
-       fprintf(stderr, "\t-n   32bit mode\n");
-       fprintf(stderr, "\t-v   verbose mode\n");
-       exit(1);
-}
-
-static void malformed_line(const char *line, int line_nr)
-{
-       fprintf(stderr, "%s: malformed line %d:\n%s", prog, line_nr, line);
-       exit(3);
-}
-
-static void dump_field(FILE *fp, const char *name, const char *indent,
-                      struct insn_field *field)
-{
-       fprintf(fp, "%s.%s = {\n", indent, name);
-       fprintf(fp, "%s\t.value = %d, bytes[] = {%x, %x, %x, %x},\n",
-               indent, field->value, field->bytes[0], field->bytes[1],
-               field->bytes[2], field->bytes[3]);
-       fprintf(fp, "%s\t.got = %d, .nbytes = %d},\n", indent,
-               field->got, field->nbytes);
-}
-
-static void dump_insn(FILE *fp, struct insn *insn)
-{
-       fprintf(fp, "Instruction = {\n");
-       dump_field(fp, "prefixes", "\t",        &insn->prefixes);
-       dump_field(fp, "rex_prefix", "\t",      &insn->rex_prefix);
-       dump_field(fp, "vex_prefix", "\t",      &insn->vex_prefix);
-       dump_field(fp, "opcode", "\t",          &insn->opcode);
-       dump_field(fp, "modrm", "\t",           &insn->modrm);
-       dump_field(fp, "sib", "\t",             &insn->sib);
-       dump_field(fp, "displacement", "\t",    &insn->displacement);
-       dump_field(fp, "immediate1", "\t",      &insn->immediate1);
-       dump_field(fp, "immediate2", "\t",      &insn->immediate2);
-       fprintf(fp, "\t.attr = %x, .opnd_bytes = %d, .addr_bytes = %d,\n",
-               insn->attr, insn->opnd_bytes, insn->addr_bytes);
-       fprintf(fp, "\t.length = %d, .x86_64 = %d, .kaddr = %p}\n",
-               insn->length, insn->x86_64, insn->kaddr);
-}
-
-static void parse_args(int argc, char **argv)
-{
-       int c;
-       prog = argv[0];
-       while ((c = getopt(argc, argv, "ynv")) != -1) {
-               switch (c) {
-               case 'y':
-                       x86_64 = 1;
-                       break;
-               case 'n':
-                       x86_64 = 0;
-                       break;
-               case 'v':
-                       verbose = 1;
-                       break;
-               default:
-                       usage();
-               }
-       }
-}
-
-#define BUFSIZE 256
-
-int main(int argc, char **argv)
-{
-       char line[BUFSIZE], sym[BUFSIZE] = "<unknown>";
-       unsigned char insn_buf[16];
-       struct insn insn;
-       int insns = 0;
-       int warnings = 0;
-
-       parse_args(argc, argv);
-
-       while (fgets(line, BUFSIZE, stdin)) {
-               char copy[BUFSIZE], *s, *tab1, *tab2;
-               int nb = 0;
-               unsigned int b;
-
-               if (line[0] == '<') {
-                       /* Symbol line */
-                       strcpy(sym, line);
-                       continue;
-               }
-
-               insns++;
-               memset(insn_buf, 0, 16);
-               strcpy(copy, line);
-               tab1 = strchr(copy, '\t');
-               if (!tab1)
-                       malformed_line(line, insns);
-               s = tab1 + 1;
-               s += strspn(s, " ");
-               tab2 = strchr(s, '\t');
-               if (!tab2)
-                       malformed_line(line, insns);
-               *tab2 = '\0';   /* Characters beyond tab2 aren't examined */
-               while (s < tab2) {
-                       if (sscanf(s, "%x", &b) == 1) {
-                               insn_buf[nb++] = (unsigned char) b;
-                               s += 3;
-                       } else
-                               break;
-               }
-               /* Decode an instruction */
-               insn_init(&insn, insn_buf, sizeof(insn_buf), x86_64);
-               insn_get_length(&insn);
-               if (insn.length != nb) {
-                       warnings++;
-                       fprintf(stderr, "Warning: %s found difference at %s\n",
-                               prog, sym);
-                       fprintf(stderr, "Warning: %s", line);
-                       fprintf(stderr, "Warning: objdump says %d bytes, but "
-                               "insn_get_length() says %d\n", nb,
-                               insn.length);
-                       if (verbose)
-                               dump_insn(stderr, &insn);
-               }
-       }
-       if (warnings)
-               fprintf(stderr, "Warning: decoded and checked %d"
-                       " instructions with %d warnings\n", insns, warnings);
-       else
-               fprintf(stdout, "Success: decoded and checked %d"
-                       " instructions\n", insns);
-       return 0;
-}