reven2 API Documentation Modules Classes Names
Clear Help

Search bar offers the following options:

  • Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: +foo bar -baz
  • Wildcards. The below example searches for documents with words beginning with “foo”: foo*
  • Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: +qname:twisted.mail.* +search

    Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

  • Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: foo~1

Results provided by Lunr.js

Module Index

  • reven2 - The REVEN2 python API.
    • address - Defines memory address classes
    • arch - Contains classes and instances related to the description of the machine architecture.
      • helpers - Contains useful functions about registers.
      • msr - Registers in this module are generated at runtime, so they are not documented. To find them, use autocompletion in your python shell (e.g. in ipython), or use `dir(arch.msr)`
      • register - Defines the Register class and related classes.
      • sse2 - Registers in this module are generated at runtime, so they are not documented. To find them, use autocompletion in your python shell (e.g. in ipython), or use `dir(arch.sse2)`
      • x64 - Registers in this module are generated at runtime, so they are not documented. To find them, use autocompletion in your python shell (e.g. in ipython), or use `dir(arch.x64)`
      • x87 - Registers in this module are generated at runtime, so they are not documented. To find them, use autocompletion in your python shell (e.g. in ipython), or use `dir(arch.x87)`
    • bookmark - No module docstring; 2/3 classes documented
    • filter - Module related to trace filter. See the Trace object.
    • memhist - No module docstring; 0/1 variable, 0/10 function, 3/3 classes documented
    • memory_range - This module contains the MemoryRange type that model a range of memory addresses, and related types.
    • ossi - Package related to OSSI information. See the OssiContext object.
      • ossi - Module related to the public OSSI objects.
      • process - No module docstring; 1/1 class documented
      • thread - No module docstring; 1/1 class documented
      • _data_source - Undocumented
    • prelude - This is the prelude module of the Reven2 python API
    • preview - Contains subpackages and modules whose API is not considered stable yet.
      • project_manager - Package related to REVEN project manager. This is a low-level REST API binding, which is incomplete and unstable
        • project_manager - Wrapper to communicate with the REVEN project manager This is a work in progress This is a low-level REST API binding, which is incomplete and unstable
        • _connect - No module docstring; 0/7 variable, 0/5 function, 1/3 class documented
      • prototypes - Package related to function prototypes parsing.
        • callconv_helper - Implementation details of a helper to use calling convention implementations.
        • calling_conventions - Implementation details for each calling convention.
          • cdecl - Implementation of the cdecl calling convention used by 32bit systems
          • chunks - Types returned by calling conventions to define argument chunks.
          • fastcall - Implementation of the fastcall calling convention used by Windows 32bit
          • ms64 - Implementation of the Microsoft x64 calling convention used by Windows 64bit
          • sysv64 - Implementation of the System V ABI AMD64 calling convention used by Linux 64bit
        • parsing_types - Binding of the reven low level parsing API types
        • prototype - Prototype: a function and a calling convention Get arguments and return values at given points in the trace.
        • reven_prototypes - C and C++ prototypes parsing.
      • taint - Package related to data tainting.
        • helpers - Undocumented
      • windows - Package related to Windows utilities.
        • context - A wrapper above reven2.trace.Context to add more utilities method to it for Windows 10.
        • handle - Parsing of Windows 10 handles from handle tables
        • object - Parsing of Windows 10 objects with header and optional headers
        • utils - Some general utilities for Windows
    • register_slice - This module contains the RegisterSlice type that models a bitwise-slice of a register.
    • search - Module related to trace search. See the Search object.
    • search_in_memory - No module docstring; 7/8 classes documented
    • session - Module related to sessions, that allow to publish information to various other connected clients (e.g., Axion).
    • stack - Module related to stack. See the Stack object.
    • string - Module related to strings in trace. See the String object.
    • trace - Module related to the execution trace. See the Trace object.
      • _data_source - Undocumented
      • _find_inverse - No module docstring; 11/18 functions documented
    • types - Contains classes and instances related to the description of data types.
      • _array - This module provides the Array type.
      • _declaration - This module provides several types that represent unresolved types, such as type forward declarations in C.
      • _enum - This module provides the Enumeration type and associated types.
      • _error - This module provides the ErrorType type and associated types.
      • _instance - This module provides the various instance types that represents the result of reading certain types, such as a Struct.
      • _integer - Provides the Integer types and type constructors operating on integers such as BigEndian as well as the Endianness and Signedness enums.
      • _pointer - This modules contains the Pointer type.
      • _primitive - This module defines the primitive types manipulated by the API.
      • _string - The module defining the CString type and the Encoding enum describing the available encodings.
      • _struct - The module defining the Struct type and related types.
      • _type - Module defining the Type class.
      • _typeinfo - Undocumented
      • _void - The module containing the void type and its associated error type.
    • util - Module that provide util functions
API Documentation for reven2, generated by pydoctor 22.5.1 at 2022-05-25 10:29:00.