[gem5-dev] Change in gem5/gem5[develop]: tests,base: Delete the SymbolTable::load method and symtest test.

2021-02-05 Thread Gabe Black (Gerrit) via gem5-dev
Gabe Black has submitted this change. (  
https://gem5-review.googlesource.com/c/public/gem5/+/40620 )


Change subject: tests,base: Delete the SymbolTable::load method and symtest  
test.

..

tests,base: Delete the SymbolTable::load method and symtest test.

This test expects to load a symbol file using the load method of gem5's
SymbolTable class, and then to search through it for a given symbol or
address.

Unfortunately, the type of file it expects to load has a format where
each line is of the form:

0x, symbol_name

where the numerical part is the address of the symbol, and the part
after the comma is the symbol name. I have not been able to find any
tool which outputs a symbol file in this format, or any tool for
inspecting an existing object file which will output symbols in this
format. I looked at objdump, objcopy, nm, and the map file format output
by gnu's linker. nm has 3 different output formats, none of which match.
Usually when working with ELF files, one would just generate a new ELF
file which only had debugging information like the symbol table, and
then strip the symbols out of the original.

Since this file format seems to have been invented from thin air, there
isn't really a good way to generate a canonical file to test the loading
code against, nor is being able to load this obscure format likely to be
useful to anybody. If someone *did* want to load an external symbol
table, they would use the ELF loader and not this.

This CL deletes both this test, and the loading code in SymbolTable.

Change-Id: I20402e3f35e54d1e186a92d9c83d1c06ec86bf7d
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/40620
Reviewed-by: Daniel Carvalho 
Maintainer: Bobby R. Bruce 
Tested-by: kokoro 
---
M src/base/loader/symtab.cc
M src/base/loader/symtab.hh
M src/unittest/SConscript
D src/unittest/symtest.cc
4 files changed, 0 insertions(+), 125 deletions(-)

Approvals:
  Daniel Carvalho: Looks good to me, approved
  Bobby R. Bruce: Looks good to me, approved
  kokoro: Regressions pass



diff --git a/src/base/loader/symtab.cc b/src/base/loader/symtab.cc
index c2c53cc..0d0e826 100644
--- a/src/base/loader/symtab.cc
+++ b/src/base/loader/symtab.cc
@@ -85,46 +85,6 @@
 return true;
 }

-bool
-SymbolTable::load(const std::string )
-{
-std::string buffer;
-std::ifstream file(filename.c_str());
-
-if (!file)
-fatal("file error: Can't open symbol table file %s\n", filename);
-
-while (!file.eof()) {
-getline(file, buffer);
-if (buffer.empty())
-continue;
-
-std::string::size_type idx = buffer.find(',');
-if (idx == std::string::npos)
-return false;
-
-std::string address = buffer.substr(0, idx);
-eat_white(address);
-if (address.empty())
-return false;
-
-std::string name = buffer.substr(idx + 1);
-eat_white(name);
-if (name.empty())
-return false;
-
-Addr addr;
-if (!to_number(address, addr))
-return false;
-
-if (!insert({ Symbol::Binding::Global, name, addr }))
-return false;
-}
-
-file.close();
-return true;
-}
-
 void
 SymbolTable::serialize(const std::string , CheckpointOut ) const
 {
diff --git a/src/base/loader/symtab.hh b/src/base/loader/symtab.hh
index a0203a6..5610544 100644
--- a/src/base/loader/symtab.hh
+++ b/src/base/loader/symtab.hh
@@ -129,7 +129,6 @@
 // into this one.
 bool insert(const Symbol );
 bool insert(const SymbolTable );
-bool load(const std::string );
 bool empty() const { return symbols.empty(); }

 SymbolTablePtr
diff --git a/src/unittest/SConscript b/src/unittest/SConscript
index 9ebe863..5008066 100644
--- a/src/unittest/SConscript
+++ b/src/unittest/SConscript
@@ -32,5 +32,3 @@

 stattest_py = PySource('m5', 'stattestmain.py', tags='stattest')
 UnitTest('stattest', 'stattest.cc', with_tag('stattest'), main=True)
-
-UnitTest('symtest', 'symtest.cc')
diff --git a/src/unittest/symtest.cc b/src/unittest/symtest.cc
deleted file mode 100644
index 6de3c8d..000
--- a/src/unittest/symtest.cc
+++ /dev/null
@@ -1,82 +0,0 @@
-/*
- * Copyright (c) 2002-2005 The Regents of The University of Michigan
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are
- * met: redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer;
- * redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution;
- * neither the name of the copyright holders nor the names of its
- * contributors may be used to endorse or promote products derived from
- * this 

[gem5-dev] Change in gem5/gem5[develop]: tests,base: Delete the SymbolTable::load method and symtest test.

2021-02-04 Thread Gabe Black (Gerrit) via gem5-dev
Gabe Black has uploaded this change for review. (  
https://gem5-review.googlesource.com/c/public/gem5/+/40620 )



Change subject: tests,base: Delete the SymbolTable::load method and symtest  
test.

..

tests,base: Delete the SymbolTable::load method and symtest test.

This test expects to load a symbol file using the load method of gem5's
SymbolTable class, and then to search through it for a given symbol or
address.

Unfortunately, the type of file it expects to load has a format where
each line is of the form:

0x, symbol_name

where the numerical part is the address of the symbol, and the part
after the comma is the symbol name. I have not been able to find any
tool which outputs a symbol file in this format, or any tool for
inspecting an existing object file which will output symbols in this
format. I looked at objdump, objcopy, nm, and the map file format output
by gnu's linker. nm has 3 different output formats, none of which match.
Usually when working with ELF files, one would just generate a new ELF
file which only had debugging information like the symbol table, and
then strip the symbols out of the original.

Since this file format seems to have been invented from thin air, there
isn't really a good way to generate a canonical file to test the loading
code against, nor is being able to load this obscure format likely to be
useful to anybody. If someone *did* want to load an external symbol
table, they would use the ELF loader and not this.

This CL deletes both this test, and the loading code in SymbolTable.

Change-Id: I20402e3f35e54d1e186a92d9c83d1c06ec86bf7d
---
A src/base/loader/symtab.basic.test
M src/base/loader/symtab.cc
M src/base/loader/symtab.hh
A src/base/loader/test.c
A src/base/loader/test.o
M src/unittest/SConscript
D src/unittest/symtest.cc
7 files changed, 2 insertions(+), 125 deletions(-)



diff --git a/src/base/loader/symtab.basic.test  
b/src/base/loader/symtab.basic.test

new file mode 100644
index 000..d218ace
--- /dev/null
+++ b/src/base/loader/symtab.basic.test
Binary files differ
diff --git a/src/base/loader/symtab.cc b/src/base/loader/symtab.cc
index c2c53cc..0d0e826 100644
--- a/src/base/loader/symtab.cc
+++ b/src/base/loader/symtab.cc
@@ -85,46 +85,6 @@
 return true;
 }

-bool
-SymbolTable::load(const std::string )
-{
-std::string buffer;
-std::ifstream file(filename.c_str());
-
-if (!file)
-fatal("file error: Can't open symbol table file %s\n", filename);
-
-while (!file.eof()) {
-getline(file, buffer);
-if (buffer.empty())
-continue;
-
-std::string::size_type idx = buffer.find(',');
-if (idx == std::string::npos)
-return false;
-
-std::string address = buffer.substr(0, idx);
-eat_white(address);
-if (address.empty())
-return false;
-
-std::string name = buffer.substr(idx + 1);
-eat_white(name);
-if (name.empty())
-return false;
-
-Addr addr;
-if (!to_number(address, addr))
-return false;
-
-if (!insert({ Symbol::Binding::Global, name, addr }))
-return false;
-}
-
-file.close();
-return true;
-}
-
 void
 SymbolTable::serialize(const std::string , CheckpointOut ) const
 {
diff --git a/src/base/loader/symtab.hh b/src/base/loader/symtab.hh
index a0203a6..5610544 100644
--- a/src/base/loader/symtab.hh
+++ b/src/base/loader/symtab.hh
@@ -129,7 +129,6 @@
 // into this one.
 bool insert(const Symbol );
 bool insert(const SymbolTable );
-bool load(const std::string );
 bool empty() const { return symbols.empty(); }

 SymbolTablePtr
diff --git a/src/base/loader/test.c b/src/base/loader/test.c
new file mode 100644
index 000..1660fa6
--- /dev/null
+++ b/src/base/loader/test.c
@@ -0,0 +1,2 @@
+char symbol_1;
+int symbol_2;
diff --git a/src/base/loader/test.o b/src/base/loader/test.o
new file mode 100644
index 000..d218ace
--- /dev/null
+++ b/src/base/loader/test.o
Binary files differ
diff --git a/src/unittest/SConscript b/src/unittest/SConscript
index 9ebe863..5008066 100644
--- a/src/unittest/SConscript
+++ b/src/unittest/SConscript
@@ -32,5 +32,3 @@

 stattest_py = PySource('m5', 'stattestmain.py', tags='stattest')
 UnitTest('stattest', 'stattest.cc', with_tag('stattest'), main=True)
-
-UnitTest('symtest', 'symtest.cc')
diff --git a/src/unittest/symtest.cc b/src/unittest/symtest.cc
deleted file mode 100644
index 6de3c8d..000
--- a/src/unittest/symtest.cc
+++ /dev/null
@@ -1,82 +0,0 @@
-/*
- * Copyright (c) 2002-2005 The Regents of The University of Michigan
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are
- * met: redistributions of source code must retain the above copyright
- * notice, this list of conditions and the