c_symbols.binary -> c_symbols.find.

python · ericsnowcurrently · Oct 19, 2019 · Sep 27, 2019 · Sep 27, 2019 · Sep 27, 2019
commit 52113aeb4790b7bd3ec7cea59deacdebd25a5e87
diff --git a/Tools/c-analyzer/c_analyzer_common/__init__.py b/Tools/c-analyzer/c_analyzer_common/__init__.py
@@ -1,4 +1,5 @@
 import os.path
+import sys
 
 
 PKG_ROOT = os.path.dirname(__file__)
@@ -14,6 +15,10 @@
         'Modules',
         ]]
 
+#PYTHON = os.path.join(REPO_ROOT, 'python')
+PYTHON = sys.executable
+
 
 # Clean up the namespace.
+del sys
 del os
diff --git a/Tools/c-analyzer/c_globals/find.py b/Tools/c-analyzer/c_globals/find.py
@@ -1,8 +1,8 @@
-from c_analyzer_common import SOURCE_DIRS
+from c_analyzer_common import SOURCE_DIRS, PYTHON
 from c_analyzer_common.info import UNKNOWN, Variable
 from c_symbols import (
         info as s_info,
-        binary as b_symbols,
+        find as b_symbols,
         source as s_symbols,
         resolve,
         )
@@ -12,7 +12,7 @@
 # XXX needs tests:
 # * iter_variables
 
-def globals_from_binary(binfile=b_symbols.PYTHON, *,
+def globals_from_binary(binfile=PYTHON, *,
                         knownvars=None,
                         dirnames=None,
                         _iter_symbols=b_symbols.iter_symbols,

diff --git a/Tools/c-analyzer/c_symbols/binary.py → Tools/c-analyzer/c_symbols/_nm.py b/Tools/c-analyzer/c_symbols/binary.py → Tools/c-analyzer/c_symbols/_nm.py
@@ -1,46 +1,24 @@
-import os
 import os.path
 import shutil
-import sys
 
 from c_analyzer_common import util, info
-from . import source
-from .info import Symbol
-
 
-#PYTHON = os.path.join(REPO_ROOT, 'python')
-PYTHON = sys.executable
+from .info import Symbol
 
 
-def iter_symbols(binary=PYTHON, dirnames=None, *,
-                 # Alternately, use look_up_known_symbol()
-                 # from c_globals.supported.
-                 find_local_symbol=source.find_symbol,
-                 _file_exists=os.path.exists,
-                 _iter_symbols_nm=(lambda b, *a: _iter_symbols_nm(b, *a)),
-                 ):
-    """Yield a Symbol for each symbol found in the binary."""
-    if not _file_exists(binary):
-        raise Exception('executable missing (need to build it first?)')
-
-    if find_local_symbol:
-        cache = {}
-        def find_local_symbol(name, *, _find=find_local_symbol):
-            return _find(name, dirnames, _perfilecache=cache)
-    else:
-        find_local_symbol = None
-
-    if os.name == 'nt':
-        # XXX Support this.
-        raise NotImplementedError
-    else:
-        yield from _iter_symbols_nm(binary, find_local_symbol)
+# XXX need tests:
+# * iter_symbols
 
-
-#############################
-# binary format (e.g. ELF)
+NM_KINDS = {
+        'b': Symbol.KIND.VARIABLE,  # uninitialized
+        'd': Symbol.KIND.VARIABLE,  # initialized
+        #'g': Symbol.KIND.VARIABLE,  # uninitialized
+        #'s': Symbol.KIND.VARIABLE,  # initialized
+        't': Symbol.KIND.FUNCTION,
+        }
 
 SPECIAL_SYMBOLS = {
+        # binary format (e.g. ELF)
         '__bss_start',
         '__data_start',
         '__dso_handle',
@@ -63,29 +41,21 @@ def _is_special_symbol(name):
     return False
 
 
-#############################
-# "nm"
-
-NM_KINDS = {
-        'b': Symbol.KIND.VARIABLE,  # uninitialized
-        'd': Symbol.KIND.VARIABLE,  # initialized
-        #'g': Symbol.KIND.VARIABLE,  # uninitialized
-        #'s': Symbol.KIND.VARIABLE,  # initialized
-        't': Symbol.KIND.FUNCTION,
-        }
-
+def iter_symbols(binfile, find_local_symbol=None,
+                 *,
+                 nm=None,
+                 _which=shutil.which,
+                 _run=util.run_cmd,
+                 ):
+    """Yield a Symbol for each relevant entry reported by the "nm" command."""
+    if nm is None:
+        nm = _which('nm')
+        if not nm:
+            raise NotImplementedError
 
-def _iter_symbols_nm(binary, find_local_symbol=None,
-                     *,
-                     _which=shutil.which,
-                     _run=util.run_cmd,
-                     ):
-    nm = _which('nm')
-    if not nm:
-        raise NotImplementedError
     argv = [nm,
             '--line-numbers',
-            binary,
+            binfile,
             ]
     try:
         output = _run(argv)

diff --git a/Tools/c-analyzer/c_symbols/find.py b/Tools/c-analyzer/c_symbols/find.py
@@ -0,0 +1,42 @@
+import os
+import os.path
+import shutil
+
+from c_analyzer_common import PYTHON
+
+from . import _nm, source
+
+# XXX need tests:
+# * iter_symbols
+
+
+def _get_platform_tool():
+    if os.name == 'nt':
+        # XXX Support this.
+        raise NotImplementedError
+    elif nm := shutil.which('nm'):
+        return lambda b, fls: _nm.iter_symbols(b, fls, nm=nm)
+    else:
+        raise NotImplementedError
+
+
+def iter_symbols(binfile=PYTHON, dirnames=None, *,
+                 # Alternately, use look_up_known_symbol()
+                 # from c_globals.supported.
+                 find_local_symbol=source.find_symbol,
+                 _file_exists=os.path.exists,
+                 _get_platform_tool=_get_platform_tool,
+                 ):
+    """Yield a Symbol for each symbol found in the binary."""
+    if not _file_exists(binfile):
+        raise Exception('executable missing (need to build it first?)')
+
+    if find_local_symbol:
+        cache = {}
+        def find_local_symbol(name, *, _find=find_local_symbol):
+            return _find(name, dirnames, _perfilecache=cache)
+    else:
+        find_local_symbol = None
+
+    _iter_symbols = _get_platform_tool()
+    yield from _iter_symbols(binfile, find_local_symbol)