5.3.12  Return Code Types

Summary The ompd_rc_t type is the return code type of an OMPD operation.

Format

 
typedef enum ompd_rc_t { 
  ompd_rc_ok                   = 0, 
  ompd_rc_unavailable          = 1, 
  ompd_rc_stale_handle         = 2, 
  ompd_rc_bad_input            = 3, 
  ompd_rc_error                = 4, 
  ompd_rc_unsupported          = 5, 
  ompd_rc_needs_state_tracking = 6,
  

 
  ompd_rc_incompatible         = 7, 
  ompd_rc_device_read_error    = 8, 
  ompd_rc_device_write_error   = 9, 
  ompd_rc_nomem                = 10, 
  ompd_rc_incomplete           = 11, 
  ompd_rc_callback_error       = 12 
} ompd_rc_t;
  

Description The ompd_rc_t type is used for the return codes of OMPD operations. The return code types and their semantics are defined as follows:

• ompd_rc_ok is returned when the operation is successful;
• ompd_rc_unavailable is returned when information is not available for the specified context;
• ompd_rc_stale_handle is returned when the specified handle is no longer valid;
• ompd_rc_bad_input is returned when the input parameters (other than handle) are invalid;
• ompd_rc_error is returned when a fatal error occurred;
• ompd_rc_unsupported is returned when the requested operation is not supported;
• ompd_rc_needs_state_tracking is returned when the state tracking operation failed because state tracking is not currently enabled;
• ompd_rc_device_read_error is returned when a read operation failed on the device;
• ompd_rc_device_write_error is returned when a write operation failed on the device;
• ompd_rc_incompatible is returned when this OMPD library is incompatible with the OpenMP program or is not capable of handling it;
• ompd_rc_nomem is returned when a memory allocation fails;
• ompd_rc_incomplete is returned when the information provided on return is incomplete, while the arguments are still set to valid values; and
• ompd_rc_callback_error is returned when the callback interface or any one of the required callback routines provided by the third-party tool is invalid.