clean up NONEOS and MCU group

Author: xwings

qiling/const.py

@@ -57,11 +57,11 @@ class QL_INTERCEPT(IntEnum):
 QL_ARCH_32BIT  = (QL_ARCH.ARM, QL_ARCH.ARM_THUMB, QL_ARCH.MIPS, QL_ARCH.X86, QL_ARCH.CORTEX_M)
 QL_ARCH_64BIT  = (QL_ARCH.ARM64, QL_ARCH.X8664)
 
-QL_OS_NONPID        = (QL_OS.DOS, QL_OS.UEFI)
-QL_ARCH_HARDWARE    = (QL_ARCH.CORTEX_M,)
-QL_ARCH_NONEOS      = (QL_ARCH.EVM,)
-QL_OS_POSIX         = (QL_OS.LINUX, QL_OS.FREEBSD, QL_OS.MACOS, QL_OS.QNX)
-QL_OS_ALL           = QL_OS_POSIX + QL_OS_NONPID + (QL_OS.WINDOWS,)
+QL_OS_NONPID            = (QL_OS.DOS, QL_OS.UEFI)
+QL_ARCH_BAREMETAL        = (QL_ARCH.CORTEX_M,)
+QL_ARCH_INTERPRETER   = (QL_ARCH.EVM,)
+QL_OS_POSIX             = (QL_OS.LINUX, QL_OS.FREEBSD, QL_OS.MACOS, QL_OS.QNX)
+QL_OS_ALL               = QL_OS_POSIX + QL_OS_NONPID + (QL_OS.WINDOWS,)
 
 QL_HOOK_BLOCK = 0b0001
 QL_CALL_BLOCK = 0b0010

qiling/core.py

@@ -19,7 +19,7 @@
     from .hw.hw import QlHwManager
     from .loader.loader import QlLoader
 
-from .const import QL_ARCH_ENDIAN, QL_ENDIAN, QL_OS, QL_VERBOSE, QL_ARCH_NONEOS, QL_ARCH_HARDWARE
+from .const import QL_ARCH_ENDIAN, QL_ENDIAN, QL_OS, QL_VERBOSE, QL_ARCH_INTERPRETER, QL_ARCH_BAREMETAL
 from .exception import QlErrorFileNotFound, QlErrorArch, QlErrorOsType, QlErrorOutput
 from .utils import *
 from .core_struct import QlCoreStructs
@@ -68,7 +68,8 @@ def __init__(
         self._code = code
         self._ostype = ostype
         self._archtype = archtype
-        self._noneos = None,
+        self._interpreter = False,
+        self._baremetal = False,
         self._archendian = None
         self._archbit = None
         self._pointersize = None
@@ -110,29 +111,29 @@ def __init__(
         """
         Qiling Framework Core Engine
         """
-        ##############
-        # Shellcode? #
-        ##############
+        ###############
+        # code_exec() #
+        ###############
 
         if self._code or (self._archtype and type(self._archtype) == str):
             if (self._archtype and type(self._archtype) == str):
                 self._archtype= arch_convert(self._archtype.lower())
 
-            if (self._ostype and type(self._ostype) == str):
+            if self._ostype == None:
+                self._ostype = arch_os_convert(self._archtype)
+            else:
                 self._ostype = ostype_convert(self._ostype.lower())
 
-            if self._archtype in QL_ARCH_NONEOS or self._ostype == None:
-                if self._ostype == None:
-                    self._ostype = arch_os_convert(self._archtype)
-                if self._code == None:
-                    self._code = self._archtype
-
-
+            if self._code == None:
+                self._code = "qiling"
             if self._argv is None:
                 self._argv = ["qilingcode"]
             if self._rootfs is None:
                 self._rootfs = "."
-
+        
+        self._interpreter = True if self._archtype in (QL_ARCH_INTERPRETER) else False
+        self._baremetal = True if self._archtype in (QL_ARCH_BAREMETAL) else False
+        
         # file check
         if self._code is None:
             if not os.path.exists(str(self._argv[0])):
@@ -201,11 +202,11 @@ def __init__(
         # Components #
         ##############
 
-        if self.archtype not in QL_ARCH_NONEOS:
+        if not self._interpreter:
             self._mem = component_setup("os", "memory", self)
             self._reg = component_setup("arch", "register", self)
 
-        if self.archtype in QL_ARCH_HARDWARE:   
+        if self._baremetal:   
             self._hw  = component_setup("hw", "hw", self)
 
         self._arch = arch_setup(self.archtype, self)
@@ -215,11 +216,11 @@ def __init__(
         QlCoreHooks.__init__(self, self.uc)
 
         # Setup Outpt
-        if self.archtype not in QL_ARCH_NONEOS:
+        if not self._interpreter:
             self.arch.utils.setup_output()
 
-        if (self.archtype not in QL_ARCH_NONEOS):
-            if (self.archtype not in QL_ARCH_HARDWARE):
+        if not self._interpreter:
+            if not self._baremetal:
                 self._os = os_setup(self.archtype, self.ostype, self)
 
                 if stdin is not None:
@@ -234,8 +235,8 @@ def __init__(
         # Run the loader
         self.loader.run()
 
-        if (self.archtype not in QL_ARCH_NONEOS):
-            if (self.archtype not in QL_ARCH_HARDWARE):
+        if not self._interpreter:
+            if not self._baremetal:
                 # Add extra guard options when configured to do so
                 self._init_stop_guard()    
 
@@ -545,7 +546,7 @@ def verbose(self):
     def verbose(self, v):
         self._verbose = v
         self.log.setLevel(ql_resolve_logger_level(self._verbose))
-        if self.archtype not in QL_ARCH_NONEOS:
+        if self.interpreter:
             self.arch.utils.setup_output()
 
     @property
@@ -629,6 +630,31 @@ def uc(self) -> Uc:
     def uc(self, u):
         self._uc = u
 
+    @property
+    def interpreter(self) -> bool:
+        """ Raw uc instance.
+
+            Type: Ucgit
+        """
+        return self._interpreter
+
+    @interpreter.setter
+    def interpreter(self, i):
+        self._interpreter = i
+
+    @property
+    def baremetal(self) -> bool:
+        """ Raw uc instance.
+
+            Type: Ucgit
+        """
+        return self._baremetal
+
+    @baremetal.setter
+    def baremetal(self, b):
+        self._baremetal = b
+
+
     @property
     def stop_options(self) -> "QlStopOptions":
         """ The stop options configured:
@@ -710,21 +736,22 @@ def run(self, begin=None, end=None, timeout=0, count=0, code = None):
         if self._debugger != False and self._debugger != None:
             self._debugger = debugger_setup(self._debugger, self)
 
-        if self.archtype not in QL_ARCH_NONEOS and  self.archtype not in QL_ARCH_HARDWARE:
-            self.write_exit_trap()
-            # patch binary
-            self.__enable_bin_patch()
+        if not self.interpreter:
+            if not self.baremetal:
+                self.write_exit_trap()
+                # patch binary
+                self.__enable_bin_patch()
 
-            # emulate the binary
-            self.os.run()
+                # emulate the binary
+                self.os.run()
 
-        if self.archtype in QL_ARCH_NONEOS:
+        if self.interpreter:
             if code == None:
                 return self.arch.run(self._code)
             else:
                 return self.arch.run(code) 
 
-        if self.archtype in QL_ARCH_HARDWARE:
+        if self.baremetal:
             self.__enable_bin_patch()
             if self.count <= 0:
                 self.count = -1
@@ -872,7 +899,7 @@ def stop(self):
         if self.multithread:
             self.os.thread_management.stop() 
 
-        elif self.archtype in QL_ARCH_HARDWARE:
+        elif self.baremetal:
             self.arch.stop()
 
         else:

qiling/core_hooks.py

@@ -15,7 +15,7 @@
 
 from .core_hooks_types import Hook, HookAddr, HookIntr, HookRet
 from .utils import catch_KeyboardInterrupt
-from .const import QL_HOOK_BLOCK, QL_ARCH_NONEOS
+from .const import QL_HOOK_BLOCK
 from .exception import QlErrorCoreHook
 
 # Don't assume self is Qiling.
@@ -238,7 +238,7 @@ def ql_hook(self, hook_type: int, callback: Callable, user_data=None, begin=1, e
 
 
     def hook_code(self, callback, user_data=None, begin=1, end=0):
-        if self.archtype in QL_ARCH_NONEOS:
+        if self.interpreter:
             from .arch.evm.hooks import ql_evm_hooks
             return ql_evm_hooks(self, 'HOOK_CODE', callback, user_data, begin, end)
 
@@ -281,7 +281,7 @@ def hook_mem_invalid(self, callback, user_data=None, begin=1, end=0):
     def hook_address(self, callback, address, user_data=None):
         hook = HookAddr(callback, address, user_data)
 
-        if self.archtype in QL_ARCH_NONEOS:
+        if self.interpreter:
             from .arch.evm.hooks import evm_hook_address
             return evm_hook_address(self, 'HOOK_ADDR', hook, address)
 
@@ -320,7 +320,7 @@ def hook_mem_fetch(self, callback, user_data=None, begin=1, end=0):
 
 
     def hook_insn(self, callback, arg1, user_data=None, begin=1, end=0):
-        if self.archtype in QL_ARCH_NONEOS:
+        if self.interpreter:
             from .arch.evm.hooks import evm_hook_insn
             return evm_hook_insn(self, 'HOOK_INSN', callback, arg1, user_data, begin, end)
 
@@ -337,7 +337,7 @@ def hook_del(self, *args):
 
         hook_type, h = args
 
-        if self.archtype in QL_ARCH_NONEOS:
+        if self.interpreter:
             from .arch.evm.hooks import evm_hook_del
             return evm_hook_del(hook_type, h)
 

qiling/debugger/gdb/gdb.py

@@ -52,18 +52,18 @@ def __init__(self, ql: Qiling, ip: str = '127.0.01', port: int = 9999):
         self.port = port
 
 
-        if ql.archtype in QL_ARCH_HARDWARE:
-            load_address = ql.loader.load_address
+        if self.ql.baremetal:
+            load_address = self.ql.loader.load_address
             exit_point = load_address + os.path.getsize(ql.path)
-        elif ql.code:
-            load_address = ql.os.entry_point
+        elif self.ql.code:
+            load_address = self.ql.os.entry_point
             exit_point = load_address + len(ql.code)
         else:
             load_address = ql.loader.load_address
             exit_point = load_address + os.path.getsize(ql.path)
 
-        if ql.archtype in QL_ARCH_HARDWARE:
-            self.entry_point = ql.loader.entry_point
+        if self.ql.baremetal:
+            self.entry_point = self.ql.loader.entry_point
         elif self.ql.ostype in (QL_OS.LINUX, QL_OS.FREEBSD) and not self.ql.code:
             self.entry_point = self.ql.os.elf_entry
         else:
@@ -506,7 +506,7 @@ def handle_q(subcmd):
 
 
                 elif subcmd.startswith('Xfer:threads:read::0,'):
-                    if self.ql.ostype in QL_OS_NONPID or self.ql.archtype in QL_ARCH_HARDWARE:
+                    if self.ql.ostype in QL_OS_NONPID or self.ql.baremetal:
                         self.send("l")
                     else:    
                         file_contents = ("<threads>\r\n<thread id=\""+ str(self.ql.os.pid) + "\" core=\"1\" name=\"" + self.ql.targetname + "\"/>\r\n</threads>")
@@ -621,7 +621,7 @@ def handle_v(subcmd):
                     self.send("")
 
                 elif subcmd.startswith('File:open'):
-                    if self.ql.ostype == QL_OS.UEFI or self.ql.archtype in QL_ARCH_HARDWARE:
+                    if self.ql.ostype == QL_OS.UEFI or self.ql.baremetal:
                         self.send("F-1")
                         return
 

qiling/debugger/gdb/utils.py

@@ -26,7 +26,7 @@ def __init__(self):
 
     def initialize(self, ql, hook_address, exit_point=None, mappings=None):
         self.ql = ql
-        if self.ql.archtype in QL_ARCH_HARDWARE:
+        if self.ql.baremetal:
             self.current_address = self.entry_point
         else:
             self.current_address = self.entry_point = self.ql.os.entry_point   

qiling/utils.py

@@ -16,7 +16,7 @@
 from unicorn import UC_ERR_READ_UNMAPPED, UC_ERR_FETCH_UNMAPPED
 
 from .exception import *
-from .const import QL_ARCH_HARDWARE, QL_ARCH_NONEOS, QL_VERBOSE, QL_ARCH, QL_ENDIAN, QL_OS, QL_DEBUGGER, QL_ARCH_1BIT, QL_ARCH_16BIT, QL_ARCH_32BIT, QL_ARCH_64BIT
+from .const import QL_VERBOSE, QL_ARCH, QL_ENDIAN, QL_OS, QL_DEBUGGER, QL_ARCH_1BIT, QL_ARCH_16BIT, QL_ARCH_32BIT, QL_ARCH_64BIT
 from .const import debugger_map, arch_map, os_map, arch_os_map, loader_map
 
 FMT_STR = "%(levelname)s\t%(message)s"
@@ -432,7 +432,7 @@ def arch_setup(archtype, ql):
     else:
         arch_str = arch_convert_str(archtype)
 
-    if archtype in QL_ARCH_NONEOS:
+    if ql.interpreter:
         return ql_get_module_function(f"qiling.arch.{arch_str.lower()}.{arch_str.lower()}", archmanager)(ql)
     else:    
         return ql_get_module_function(f"qiling.arch.{arch_str.lower()}", archmanager)(ql)
@@ -458,7 +458,7 @@ def os_setup(archtype: QL_ARCH, ostype: QL_OS, ql):
 
 
 def profile_setup(ql):
-    if ql.archtype in QL_ARCH_HARDWARE:
+    if ql.baremetal:
         return ql_hw_profile_setup(ql)
 
     _profile = "Default"