Design Considerations
=====================

There are three logical groups of source files:

* The framework itself - not related to any specific kernel subsystem. It
  consists of two parts:

  * C-module - implements Python bindings to ``crash`` and ``GDB``
    internals. The sources are in the ``Extension/`` subdirectory.

  * Python API implemented on top of the C-module. The sources are in
    the ``pykdump/`` subdirectory.

* A library of subroutines implementing access to different Linux
  kernel tables/structures, e.g. *inet* or *storage*. It consists of
  several modules residing in the ``LinuxDump/`` subdirectory.

* Top-level programs - those that can be used for vmcore analysis
  without doing any programming. They reside in the ``progs/`` subdirectory.


.. toctree::
   :maxdepth: 2
   :caption: Contents:

   cfiles
   pfiles

   lowlevel