This file contains function declarations and structs which handle informations on user defined regions. POMP2_USER_Region_info is used to store these informations. It can be filled with a ctcString by ctcString2UserRegionInfo().
More...
#include "opari2_region_info.h"
#include <stdbool.h>
Go to the source code of this file.
This file contains function declarations and structs which handle informations on user defined regions. POMP2_USER_Region_info is used to store these informations. It can be filled with a ctcString by ctcString2UserRegionInfo().
- Date
- Started Tue Apr 1 2014
| #define CTC_USER_REGION_TOKENS CTC_USER_Region_name |
ctcString2UserRegionInfo() fills the POMP2_USER_Region_info object with data read from the ctcString. If the ctcString does not comply with the specification, the program aborts with exit code 1.
Rationale: ctcString2UserRegionInfo() is used during initialization of the measurement system. If an error occurs, it is better to abort than to struggle with undefined behaviour or guessing the meaning of the broken string.
- Note
- Can be called from multiple threads concurrently, assuming malloc is thread-safe.
-
ctcString2UserRegionInfo() will assign memory to the members of regionInfo. You are supposed to to release this memory by calling freePOMP2UserRegionInfoMembers().
- Parameters
-
| ctcString | A string in the format "length*key=value*[key=value]*". The length field is parsed but not used by this implementation. Possible values for key are listed in ctcTokenMap. The string must at least contain values for the keys regionType, sscl and escl. Possible values for the key regionType are listed in regionTypesMap. The format for sscl resp. escl values is "filename:lineNo1:lineNo2". |
| regionInfo | must be a valid object |
- Postcondition
- At least the required attributes (see POMP2_USER_Region_info) are set.
If regionType=userRegion then POMP2_USER_Region_info::mUserRegionName has a value != 0.
Free the memory of the regionInfo members.
- Parameters
-
| regionInfo | The regioninfo to be freed. |
converts regionType into a string
- Parameters
-
| regionType | The regionType to be converted. |
- Returns
- string representation of the region type