:py:mod:`dissect.target.plugins.os.unix.linux.modules`
======================================================

.. py:module:: dissect.target.plugins.os.unix.linux.modules




Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   dissect.target.plugins.os.unix.linux.modules.Module
   dissect.target.plugins.os.unix.linux.modules.ModulePlugin




Attributes
~~~~~~~~~~

.. autoapisummary::

   dissect.target.plugins.os.unix.linux.modules.ModuleRecord


.. py:data:: ModuleRecord

.. py:class:: Module

   .. py:attribute:: path
      :type:  str


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: size
      :type:  int


   .. py:attribute:: refcnt
      :type:  int


   .. py:attribute:: used_by
      :type:  list[str]


.. py:class:: ModulePlugin(target: dissect.target.target.Target)

   Bases: :py:obj:`dissect.target.plugin.Plugin`


   Linux volatile kernel ``/sys/module`` plugin.


   .. py:method:: check_compatible() -> bool

      Perform a compatibility check with the target.

      This function should return ``None`` if the plugin is compatible with the current target (``self.target``).
      For example, check if a certain file exists. Otherwise it should raise an
      :class:`UnsupportedPluginError`.

      :raises UnsupportedPluginError: If the plugin could not be loaded.



   .. py:method:: sysmodules() -> collections.abc.Iterator[ModuleRecord]

      Return information about active kernel modules.



   .. py:method:: lsmod() -> collections.abc.Iterator[str]

      Return information about active kernel modules in lsmod format.