HOME
| OPENMP API Specification: Version 5.0 November 2018

5.5.8  Display Control Variables

5.5.8.1 ompd_get_display_control_vars

SummaryThe ompd_get_display_control_vars function returns a list of name/value pairs for OpenMP control variables.

Format

SVG-Viewer needed.

 

 
ompd_rc_t ompd_get_display_control_vars ( 
  ompd_address_space_handle_t *address_space_handle, 
  const char * const **control_vars 
);  

SVG-Viewer needed.

DescriptionThe ompd_get_display_control_vars function returns a NULL-terminated vector of NULL-terminated strings of name/value pairs of control variables that have user controllable settings and are important to the operation or performance of an OpenMP runtime system. The control variables that this interface exposes include all OpenMP environment variables, settings that may come from vendor or platform-specific environment variables, and other settings that affect the operation or functioning of an OpenMP runtime. The format of the strings is name=a string.

On return, the third-party tool owns the vector and the strings. The OMP library must satisfy the termination constraints; it may use static or dynamic memory for the vector and/or the strings and is unconstrained in how it arranges them in memory. If it uses dynamic memory then the OMPD library must use the allocate callback that the tool provides to ompd_initialize. The tool must use ompd_rel_display_control_vars() to release the vector and the strings.

Description of ArgumentsThe address_space_handle argument identifies the address space. On return, the control_vars argument points to the vector of display control variables.

Cross References

5.5.8.2 ompd_rel_display_control_vars

SummaryThe ompd_rel_display_control_vars releases a list of name/value pairs of OpenMP control variables previously acquired with ompd_get_display_control_vars.

Format

SVG-Viewer needed.

 

 
ompd_rc_t ompd_rel_display_control_vars ( 
  const char * const **control_vars 
);  

SVG-Viewer needed.

DescriptionThe third-party tool owns the vector and strings that ompd_get_display_control_vars returns. The tool must call ompd_rel_display_control_vars to release the vector and the strings.

Description of ArgumentsThe control_vars argument is the vector of display control variables to be released.

Cross References