GTPin: GTPin: Event Handling

GTPin

- Main Page
- Related Pages
- Modules
- Data Structures

Data Structures | Enumerations
GTPin: Event Handling

A group of interfaces intended for handle events (errors, warnings, etc.) reported by GTPin More...

## Data Structures
class | gtpin::GtStatus
| Status of the GTPin operation. More...
class | gtpin::GtEventReaction
| Wrapper class of the EVENT_REACTION enumeration that defines return value of the event handling callback. More...
class | gtpin::IGtEvent
| Abstract representation of the event generated by GTPin. More...
class | gtpin::IGtKernelEvent
| Abstract representation of the event associated with a concrete kernel. More...
class | gtpin::IGtInternalEvent
| Abstract representation of the event that reports internal GTPin error, warning, etc. More...
class | gtpin::IGtEventHandler
| Interface of the GTPin event handler. More...
## Enumerations
enum | gtpin::GT_STATUS { gtpin::GTPIN_STATUS_SUCCESS = 0, gtpin::GTPIN_STATUS_WARNING = 0x20000000, gtpin::GTPIN_STATUS_WARNING_KERNEL_FILTERED = GTPIN_STATUS_WARNING + 1, gtpin::GTPIN_STATUS_WARNING_INTERNAL = GTPIN_STATUS_WARNING + 0x1000000, gtpin::GTPIN_STATUS_ERROR = 0x40000000, gtpin::GTPIN_STATUS_ERROR_NO_DRIVER = GTPIN_STATUS_ERROR + 1, gtpin::GTPIN_STATUS_ERROR_UNSUPPORTED_CFG = GTPIN_STATUS_ERROR + 2, gtpin::GTPIN_STATUS_ERROR_REG_ALLOC_FAILURE = GTPIN_STATUS_ERROR + 3, gtpin::GTPIN_STATUS_ERROR_INSTRUMENT_FAILURE = GTPIN_STATUS_ERROR + 4, gtpin::GTPIN_STATUS_ERROR_API_VERSION_MISMATCH = GTPIN_STATUS_ERROR + 5, gtpin::GTPIN_STATUS_ERROR_INVALID_API_ARGUMENT = GTPIN_STATUS_ERROR + 6, gtpin::GTPIN_STATUS_ERROR_ACCESS_DENIED = GTPIN_STATUS_ERROR + 7, gtpin::GTPIN_STATUS_ERROR_INVALID_API_CALL = GTPIN_STATUS_ERROR + 8, gtpin::GTPIN_STATUS_ERROR_BUFFER_OVERFLOW = GTPIN_STATUS_ERROR + 9, gtpin::GTPIN_STATUS_ERROR_HLI_COMPILE_FAILURE = GTPIN_STATUS_ERROR + 10, gtpin::GTPIN_STATUS_ERROR_HLI_BUILD_FAILURE = GTPIN_STATUS_ERROR + 11, gtpin::GTPIN_STATUS_ERROR_GFX_RUNTIME_FAILURE = GTPIN_STATUS_ERROR + 12, gtpin::GTPIN_STATUS_ERROR_UNSUPPORTED_FEATURE = GTPIN_STATUS_ERROR + 13, gtpin::GTPIN_STATUS_ERROR_BIN_LINK_FAILURE = GTPIN_STATUS_ERROR + 14, gtpin::GTPIN_STATUS_ERROR_D3D_PROTOCOL_ERROR = GTPIN_STATUS_ERROR + 15, gtpin::GTPIN_STATUS_ERROR_GFX_DRIVER_VERSION = GTPIN_STATUS_ERROR + 16, gtpin::GTPIN_STATUS_ERROR_INTERNAL = GTPIN_STATUS_ERROR + 0x1000000 }
| Status of the GTPin operation. More...
enum | gtpin::EVENT_REACTION { gtpin::EVENT_REACTION_DEFAULT, gtpin::EVENT_REACTION_CONTINUE, gtpin::EVENT_REACTION_RETRY, gtpin::EVENT_REACTION_TERMINATE, gtpin::EVENT_REACTION_SHUTDOWN_GTPIN }
| Possible action that may be requested by the GTPin event handler. More...

## Detailed Description

A group of interfaces intended for handle events (errors, warnings, etc.) reported by GTPin

This group defines an abstract representation of the GTPin event, and an interface of the event handler which can be implemented by the tool and registered with the GTPin core.

## Enumeration Type Documentation

enum gtpin::EVENT_REACTION

Possible action that may be requested by the GTPin event handler.

Enumerator:

  EVENT_REACTION_DEFAULT | Default action on the event of a specific type.
  EVENT_REACTION_CONTINUE | Ignore event, e.g. skip instrumentation of the problematic kernel.
  EVENT_REACTION_RETRY | Retry the last operation, e.g. redo instrumentation for the problematic kernel.
  EVENT_REACTION_TERMINATE | Terminate (abort) the application.
  EVENT_REACTION_SHUTDOWN_GTPIN | Shuts down GTPin operation by keeping the application process alive.

enum gtpin::GT_STATUS

Status of the GTPin operation.

Enumerator:

  GTPIN_STATUS_SUCCESS | Success.
  GTPIN_STATUS_WARNING | Generic warning.
  GTPIN_STATUS_WARNING_KERNEL_FILTERED | Instrumentation is skipped. The kernel is filtered out.
  GTPIN_STATUS_WARNING_INTERNAL | Internal warning.
  GTPIN_STATUS_ERROR | Generic error.
  GTPIN_STATUS_ERROR_NO_DRIVER | The communication with the driver is not established/broken.
  GTPIN_STATUS_ERROR_UNSUPPORTED_CFG | Kernel could not be instrumented: CFG is too complex.
  GTPIN_STATUS_ERROR_REG_ALLOC_FAILURE | Kernel could not be instrumented: register allocation failed.
  GTPIN_STATUS_ERROR_INSTRUMENT_FAILURE | Kernel instrumentation failed.
  GTPIN_STATUS_ERROR_API_VERSION_MISMATCH | GTPin/tool API version mismatch.
  GTPIN_STATUS_ERROR_INVALID_API_ARGUMENT | Invalid API argument specified by the tool.
  GTPIN_STATUS_ERROR_ACCESS_DENIED | Generic access error, e.g. memory/file access failure.
  GTPIN_STATUS_ERROR_INVALID_API_CALL | API is not available in the current context (callback)
  GTPIN_STATUS_ERROR_BUFFER_OVERFLOW | Memory buffer is too small.
  GTPIN_STATUS_ERROR_HLI_COMPILE_FAILURE | HLI module compilation failed.
  GTPIN_STATUS_ERROR_HLI_BUILD_FAILURE | HLI binary module build failed.
  GTPIN_STATUS_ERROR_GFX_RUNTIME_FAILURE | GFX runtime error.
  GTPIN_STATUS_ERROR_UNSUPPORTED_FEATURE | Unsupported feature/API.
  GTPIN_STATUS_ERROR_BIN_LINK_FAILURE | Binary link failed.
  GTPIN_STATUS_ERROR_D3D_PROTOCOL_ERROR | D3D protocol error.
  GTPIN_STATUS_ERROR_GFX_DRIVER_VERSION | Gfx driver version mismatch.
  GTPIN_STATUS_ERROR_INTERNAL | Internal error.

All Data Structures Functions Variables Typedefs Enumerations Enumerator

      Copyright (C) 2013-2025 Intel Corporation

      SPDX-License-Identifier: MIT