tests,base: Delete the SymbolTable::load method and symtest test.
authorGabe Black <gabe.black@gmail.com>
Thu, 4 Feb 2021 07:57:47 +0000 (23:57 -0800)
committerGabe Black <gabe.black@gmail.com>
Sat, 6 Feb 2021 04:02:16 +0000 (04:02 +0000)
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:

0x00000000, 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 <odanrc@yahoo.com.br>
Maintainer: Bobby R. Bruce <bbruce@ucdavis.edu>
Tested-by: kokoro <noreply+kokoro@google.com>
src/base/loader/symtab.cc
src/base/loader/symtab.hh
src/unittest/SConscript
src/unittest/symtest.cc [deleted file]

index c2c53cc1e014bb3c16bff6a01e7ca6baf7c8d0c9..0d0e82615e9ac6142caf7755698d40823fafc635 100644 (file)
@@ -85,46 +85,6 @@ SymbolTable::insert(const SymbolTable &other)
     return true;
 }
 
-bool
-SymbolTable::load(const std::string &filename)
-{
-    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 &base, CheckpointOut &cp) const
 {
index a0203a692995d608fc7c8920446ffba0eb8c06e5..561054492b33eb1c784339c173a5cf22903ca12c 100644 (file)
@@ -129,7 +129,6 @@ class SymbolTable
     // into this one.
     bool insert(const Symbol &symbol);
     bool insert(const SymbolTable &other);
-    bool load(const std::string &file);
     bool empty() const { return symbols.empty(); }
 
     SymbolTablePtr
index 9ebe863eb189380157e519bc254e78c4abbe7f77..50080665a405c3d3a5c1f65f8f62a9313ea18871 100644 (file)
@@ -32,5 +32,3 @@ UnitTest('nmtest', 'nmtest.cc')
 
 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 (file)
index 6de3c8d..0000000
+++ /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 software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-#include <iostream>
-
-#include "base/loader/symtab.hh"
-#include "base/str.hh"
-
-void usage(const char *progname);
-
-void
-usage(const char *progname)
-{
-    std::cout << "Usage: " << progname << " <symbol file> <symbol>"
-        << std::endl;
-
-    exit(1);
-}
-
-int
-main(int argc, char *argv[])
-{
-    Loader::SymbolTable symtab;
-
-    if (argc != 3)
-        usage(argv[0]);
-
-    if (!symtab.load(argv[1])) {
-        std::cout << "could not load symbol file: " << argv[1] << std::endl;
-        exit(1);
-    }
-
-    std::string symbol = argv[2];
-    Addr address;
-
-    if (!to_number(symbol, address)) {
-        auto it = symtab.find(symbol);
-        if (it == symtab.end()) {
-            std::cout << "could not find symbol: " << symbol << std::endl;
-            exit(1);
-        }
-
-        std::cout << symbol << " -> " << "0x" << std::hex << it->address <<
-            std::endl;
-    } else {
-        auto it = symtab.find(address);
-        if (it == symtab.end()) {
-            std::cout << "could not find address: " << address << std::endl;
-            exit(1);
-        }
-
-        std::cout << "0x" << std::hex << address << " -> " << it->name <<
-            std::endl;
-    }
-
-    return 0;
-}