PyPlugin logging policy

pyplugins/actuation/vpn.py

@@ -105,7 +105,7 @@ def __init__(self, panda) -> None:
 
         self.outdir = self.get_arg("outdir")
 
-        if self.get_arg_bool("verbose"):
+        if self.get_arg_bool("penguin_verbose"):
             self.logger.setLevel("DEBUG")
 
         # TODO: add option on whether or not to pass -o to host vpn

pyplugins/analysis/env.py

@@ -49,7 +49,7 @@ def __init__(self):
         self.env_vars = set()  # set of env vars that were read through libc getenv
         self.uboot_vars = set()  # set of env vars that were read through libc getenv
         self.mtd_vars = set()  # set of mtd partitions read out of /proc/mtd
-        if self.get_arg_bool("verbose"):
+        if self.get_arg_bool("penguin_verbose"):
             self.logger.setLevel("DEBUG")
 
         self.default_env_vars = DEFAULT_ENV_VARS
@@ -214,7 +214,7 @@ def __init__(self):
         # this hurts performance, but without it we definitely miss some comparisons
         # in targetcmp/callwitharg/callstack_instr.
         panda.disable_tb_chaining()
-        if self.get_arg_bool("verbose"):
+        if self.get_arg_bool("penguin_verbose"):
             self.logger.setLevel("DEBUG")
 
         self.outdir = self.get_arg("outdir")

pyplugins/analysis/interfaces.py

@@ -15,7 +15,7 @@ class Interfaces(Plugin):
     def __init__(self):
         self.outdir = self.get_arg("outdir")
         self.conf = self.get_arg("conf")
-        if self.get_arg_bool("verbose"):
+        if self.get_arg_bool("penguin_verbose"):
             self.logger.setLevel("DEBUG")
 
         open(f"{self.outdir}/{iface_log}", "w").close()

pyplugins/apis/send_hypercall.py

@@ -60,7 +60,7 @@ def __init__(self) -> None:
         Sets up logging, event registration, and subscribes to the igloo_send_hypercall event.
         """
         self.outdir = self.get_arg("outdir")
-        if self.get_arg_bool("verbose"):
+        if self.get_arg_bool("penguin_verbose"):
             self.logger.setLevel("DEBUG")
         self.registered_events: Dict[str, Callable[...,
                                                    Tuple[int, Union[str, bytes]]]] = {}

pyplugins/apis/uprobes.py

@@ -35,7 +35,7 @@ class Uprobes(Plugin):
     def __init__(self):
         self.outdir = self.get_arg("outdir")
         self.projdir = self.get_arg("proj_dir")
-        if self.get_arg_bool("verbose"):
+        if self.get_arg_bool("penguin_verbose"):
             self.logger.setLevel("DEBUG")
         self.libsymbols = os.path.join(
             self.projdir, "static", "LibrarySymbols.json.xz")

pyplugins/hyper/bash_command.py

@@ -54,7 +54,7 @@ def __init__(self) -> None:
         **Returns:** None
         """
         self.outdir = self.get_arg("outdir")
-        if self.get_arg_bool("verbose"):
+        if self.get_arg_bool("penguin_verbose"):
             self.logger.setLevel("DEBUG")
 
         # Bash

pyplugins/hyper/canary.py

@@ -54,7 +54,7 @@ def __init__(self) -> None:
         """
         self.outdir = self.get_arg("outdir")
 
-        if self.get_arg_bool("verbose"):
+        if self.get_arg_bool("penguin_verbose"):
             self.logger.setLevel("DEBUG")
 
     @plugins.SendHypercall.subscribe("canary")

pyplugins/hyper/portal.py

@@ -134,8 +134,6 @@ def __init__(self) -> None:
         **Returns:** None
         """
         self.outdir = self.get_arg("outdir")
-        # if self.get_arg_bool("verbose"):
-        #   self.logger.setLevel("DEBUG")
         # Set endianness format character for struct operations
         self.endian_format = '<' if self.panda.endianness == 'little' else '>'
         self.portal_interrupt = None

pyplugins/hyper/shell.py

@@ -74,7 +74,7 @@ def __init__(self, panda: Any) -> None:
         self.read_scripts = {}  # filename -> contents
         self.last_line = None
 
-        if self.get_arg_bool("verbose"):
+        if self.get_arg_bool("penguin_verbose"):
             self.logger.setLevel("DEBUG")
 
         # initialize outfiles:

pyplugins/hyper/uboot.py

@@ -59,7 +59,7 @@ def __init__(self) -> None:
         open(os.path.join(self.outdir, UBOOT_LOG), "w").close()
         self.uboot_log = set()
 
-        if self.get_arg_bool("verbose"):
+        if self.get_arg_bool("penguin_verbose"):
             self.logger.setLevel("DEBUG")
 
         # U-Boot

pyplugins/interventions/lifeguard.py

@@ -95,7 +95,7 @@ def __init__(self, panda: object) -> None:
         """
         self.panda = panda
         self.outdir = self.get_arg("outdir")
-        if self.get_arg_bool("verbose"):
+        if self.get_arg_bool("penguin_verbose"):
             self.logger.setLevel("DEBUG")
 
         self.blocked_signals = []

pyplugins/interventions/mount.py

@@ -66,7 +66,7 @@ def __init__(self):
         self.mounts = set()
         self.fake_mounts = self.get_arg("fake_mounts") or []
         self.all_succeed = self.get_arg("all_succeed") or False
-        if self.get_arg_bool("verbose"):
+        if self.get_arg_bool("penguin_verbose"):
             self.logger.setLevel("DEBUG")
 
         plugins.syscalls.syscall("on_sys_mount_return")(self.post_mount)

pyplugins/interventions/nvram2.py

@@ -61,7 +61,7 @@ def __init__(self):
         - None
         """
         self.outdir = self.get_arg("outdir")
-        if self.get_arg_bool("verbose"):
+        if self.get_arg_bool("penguin_verbose"):
             self.logger.setLevel("DEBUG")
         # Even at debug level, logging every nvram get/clear can be very verbose.
         # As such, we only debug log nvram sets

pyplugins/interventions/pseudofiles.py

@@ -140,7 +140,7 @@ def __init__(self):
         self.outdir = self.get_arg("outdir")
         self.proj_dir = self.get_arg("proj_dir")
         self.written_data = {}  # filename -> data that was written to it
-        if self.get_arg_bool("verbose"):
+        if self.get_arg_bool("penguin_verbose"):
             self.logger.setLevel(logging.DEBUG)
         self.did_mtd_warn = False  # Set if we've warned about misconfigured MTD devices
         # XXX: It has seemed like this should be 1 for some architectures, but

pyplugins/loggers/db.py

@@ -67,7 +67,7 @@ def __init__(self) -> None:
         self.finished_worker = Event()
         self.initialized_db = False
 
-        if self.get_arg_bool("verbose"):
+        if self.get_arg_bool("penguin_verbose"):
             self.logger.setLevel("DEBUG")
 
         # Start the background flush thread

pyplugins/testing/ioctl_interaction_test.py

@@ -9,7 +9,7 @@
 class TestIoctlInteraction(Plugin):
     def __init__(self):
         self.outdir = self.get_arg("outdir")
-        if self.get_arg_bool("verbose"):
+        if self.get_arg_bool("penguin_verbose"):
             self.logger.setLevel("DEBUG")
 
     @plugins.syscalls.syscall("on_sys_ioctl_return", arg_filters=[None, SIOCDEVPRIVATE])

pyplugins/testing/kffi_test.py

@@ -9,7 +9,7 @@
 class KFFITest(Plugin):
     def __init__(self):
         self.outdir = self.get_arg("outdir")
-        if self.get_arg_bool("verbose"):
+        if self.get_arg_bool("penguin_verbose"):
             self.logger.setLevel("DEBUG")
 
     @syscalls.syscall("on_sys_ioctl_return", arg_filters=[0x14, 0x15, 0x16])

pyplugins/testing/portal_test.py

@@ -10,8 +10,6 @@ class PortalTest(Plugin):
     def __init__(self, panda):
         self.panda = panda
         self.outdir = self.get_arg("outdir")
-        # if self.get_arg_bool("verbose"):
-        #     self.logger.setLevel("DEBUG")
 
     '''
     This test checks that we can get information from our program, its arguments,

src/penguin/penguin_run.py

@@ -542,7 +542,7 @@ def run_config(
         "fs": config_fs,
         "fw": config_image,
         "outdir": out_dir,
-        "verbose": verbose,
+        "penguin_verbose": verbose,
         "telnet_port": telnet_port,
     }
     args.update(vpn_args)

src/penguin/plugin_manager.py

@@ -64,8 +64,30 @@ def __preinit__(self, plugins: 'IGLOOPluginManager', args: Dict) -> None:
         """
         self.plugins = plugins
         self.args = args
+        self._initialize_logger()
+
+    def _set_level_arg(self, level: Union[str, bool, int]) -> None:
+        # The verbose argument is used to set the logger level
+        verbose_arg = self.args.get("verbose", False)
+        if isinstance(verbose_arg, bool):
+            if verbose_arg is True:
+                self.logger.setLevel("DEBUG")
+        elif isinstance(verbose_arg, int) or isinstance(verbose_arg, str):
+            # If verbose is an int, set the logger level to that value
+            self.logger.setLevel(verbose_arg)
+        else:
+            raise ValueError(
+                f"Unsupported verbose argument type: {type(verbose_arg)}. Expected bool, int, or str.")
+
+    def _initialize_logger(self):
         logname = camel_to_snake(self.name)
         self.logger = getColoredLogger(f"plugins.{logname}")
+        if self.args.get("verbose", None) is not None:
+            # If verbose is set, set the logger level to DEBUG
+            self._set_level_arg(self.args["verbose"])
+        elif self.args.get("loglevel", None) is not None:
+            # If loglevel is set, set the logger level to that value
+            self._set_level_arg(self.args["loglevel"])
 
     @property
     def name(self) -> str:
@@ -263,6 +285,10 @@ def initialize(self, panda: Panda, args: Dict[str, Any]) -> None:
         self.args = args
         self.logger = getColoredLogger("penguin.plugin_manger")
 
+        # Set the logger level based on the 'penguin_verbose' argument
+        if self.args.get("penguin_verbose", False):
+            self.logger.setLevel("DEBUG")
+
         self.plugin_cbs: Dict[Plugin, Dict[str, List[Callable]]] = {}
         self.registered_cbs: Dict[Tuple[Plugin, str], Callable] = {}
         self.aliases: Dict[str, str] = {}