improve showing address map

add tockloader list --map

Author: bradjc

tockloader/display.py

@@ -48,6 +48,31 @@ def get(self):
         return self.out
 
 
+def choose(b, t, f):
+    if b:
+        return t
+    return f
+
+
+def start_of_app(width, address):
+    return "{:>#10x}┬{}┐\n".format(address, "─" * width)
+
+
+def end_of_app(width, address, continuing):
+    left_corner = choose(continuing, "┼", "┴")
+    right_corner = choose(continuing, "┤", "┘")
+    return "{:>#10x}{}{}{}\n".format(address, left_corner, "─" * width, right_corner)
+
+
+def app_bracket(width, left, right):
+    if len(left) + len(right) >= (width - 1):
+        room_for_left = width - 1 - 1 - len(right)
+        left = "{}…".format(left[0:room_for_left])
+    left_size = width - len(right)
+    content = "{:<{left_size}}{}".format(left, right, left_size=left_size)
+    return "{}│{}│\n".format(" " * 10, content)
+
+
 class HumanReadableDisplay(Display):
     """
     Format output as a string meant to be human readable.
@@ -87,30 +112,21 @@ def list_apps(self, apps, verbose, quiet):
             # In quiet mode just show the names.
             self.out += " ".join([app.get_name() for app in apps])
 
-    def show_app_map(self, apps, start_address):
-        def choose(b, t, f):
-            if b:
-                return t
-            return f
-
-        def start_of_app(width, address):
-            return "{:>#10x}┬{}┐\n".format(address, "─" * width)
-
-        def end_of_app(width, address, continuing):
-            left_corner = choose(continuing, "┼", "┴")
-            right_corner = choose(continuing, "┤", "┘")
-            return "{:>#10x}{}{}{}\n".format(
-                address, left_corner, "─" * width, right_corner
-            )
-
-        def app_bracket(width, left, right):
-            if len(left) + len(right) >= (width - 1):
-                room_for_left = width - 1 - 1 - len(right)
-                left = "{}…".format(left[0:room_for_left])
-            left_size = width - len(right)
-            content = "{:<{left_size}}{}".format(left, right, left_size=left_size)
-            return "{}│{}│\n".format(" " * 10, content)
-
+    def show_app_map_from_address(self, apps, start_address):
+        """
+        Print a layout map of apps assuming they are located back-to-back
+        starting from `start_address`. Example:
+
+        ```
+        0x30000┬──────────────────────────────────────────────────┐
+               │App: blink                             [Installed]│
+               │  Length: 16384 (0x4000)                          │
+        0x34000┼──────────────────────────────────────────────────┤
+               │App: blink                             [Installed]│
+               │  Length: 16384 (0x4000)                          │
+        0x3c000┴──────────────────────────────────────────────────┘
+        ```
+        """
         out = ""
         address = start_address
         for i, app in enumerate(apps):
@@ -136,6 +152,54 @@ def app_bracket(width, left, right):
 
         self.out += out
 
+    def show_app_map_actual_address(self, apps):
+        """
+        Show a map of installed applications with known addresses. Example:
+
+        ```
+        0x30000┬──────────────────────────────────────────────────┐
+               │App: blink                             [Installed]│
+               │  Length: 16384 (0x4000)                          │
+        0x34000┴──────────────────────────────────────────────────┘
+        0x38000┬──────────────────────────────────────────────────┐
+               │App: blink                             [Installed]│
+               │  Length: 16384 (0x4000)                          │
+        0x3c000┴──────────────────────────────────────────────────┘
+        ```
+        """
+
+        out = ""
+        prev_address = -1
+        for i, app in enumerate(apps):
+            size = app.get_size()
+            active_address = app.get_address()
+
+            if active_address != prev_address:
+                out += start_of_app(50, active_address)
+
+            if isinstance(app, TabApp):
+                title = "App: {}".format(app.get_name())
+                out += app_bracket(50, title, "[From TAB]")
+            elif isinstance(app, InstalledApp):
+                title = "App: {}".format(app.get_name())
+                out += app_bracket(50, title, "[Installed]")
+            elif isinstance(app, PaddingApp):
+                out += app_bracket(50, "Padding", "")
+            out += app_bracket(50, "  Length: {} ({:#x})".format(size, size), "")
+
+            prev_address = active_address + size
+
+            # Check if the next app starts at the address the current app ends
+            # at.
+            immediately_after = False
+            if i < len(apps) - 1:
+                next_address = apps[i + 1].get_address()
+                immediately_after = prev_address == next_address
+
+            out += end_of_app(50, prev_address, immediately_after)
+
+        self.out += out
+
     def show_board_visual(self, apps):
         def horizontal_add(existing, new):
             existing_lines = existing.split("\n")

tockloader/main.py

@@ -144,9 +144,15 @@ def command_list(args):
                 with open(key_path, "rb") as f:
                     public_keys.append(f.read())
 
+    verbose = args.verbose
+    if args.map:
+        # We always want verbose if showing the map so we see all apps including
+        # padding.
+        verbose = True
+
     tock_loader = TockLoader(args)
     tock_loader.open()
-    tock_loader.list_apps(args.verbose, args.quiet, public_keys)
+    tock_loader.list_apps(verbose, args.quiet, args.map, public_keys)
 
 
 def command_install(args):
@@ -1013,6 +1019,11 @@ def main():
         help="Print just a list of application names",
         action="store_true",
     )
+    listcmd.add_argument(
+        "--map",
+        help="Print a table with apps and addresses",
+        action="store_true",
+    )
     listcmd.add_argument(
         "--verify-credentials",
         help="Check credentials with a list of public keys",

tockloader/tockloader.py

@@ -301,12 +301,13 @@ def flash_binary(self, binary, address, pad=None):
                         logging.debug("Unable to set attribute after flash command.")
                         logging.debug(ret)
 
-    def list_apps(self, verbose, quiet, verify_credentials_public_keys):
+    def list_apps(self, verbose, quiet, map, verify_credentials_public_keys):
         """
         Query the chip's flash to determine which apps are installed.
 
         - `verbose` - bool: Show details about TBF.
         - `quiet` - bool: Just show the app name.
+        - `map` - bool: Show a diagram listing apps with addresses.
         - `verify_credentials_public_keys`: Either `None`, meaning do not verify
           any credentials, or a list of public keys binaries to use to help
           verify credentials. The list can be empty and all credentials that can
@@ -333,7 +334,11 @@ def list_apps(self, verbose, quiet, verify_credentials_public_keys):
             else:
                 displayer = display.HumanReadableDisplay()
 
-            displayer.list_apps(apps, verbose, quiet)
+            if map:
+                displayer.show_app_map_actual_address(apps)
+            else:
+                displayer.list_apps(apps, verbose, quiet)
+
             print(displayer.get())
 
     def install(self, tabs, replace="yes", erase=False, sticky=False, layout=None):
@@ -1457,7 +1462,7 @@ def is_valid(slices):
 
             logging.info("App Layout:")
             displayer = display.HumanReadableDisplay()
-            displayer.show_app_map(to_flash_apps, address)
+            displayer.show_app_map_from_address(to_flash_apps, address)
             app_layout = displayer.get()
             for l in app_layout.splitlines():
                 logging.info(l)