2.2 (revision 4737)
OTF2_EventSizeEstimator.h
Go to the documentation of this file.
1 /*
2  * This file is part of the Score-P software (http://www.score-p.org)
3  *
4  * Copyright (c) 2013-2015,
5  * Technische Universitaet Dresden, Germany
6  *
7  * This software may be modified and distributed under the terms of
8  * a BSD-style license. See the COPYING file in the package base
9  * directory for details.
10  *
11  */
12 
13 
14 #ifndef OTF2_EVENT_SIZE_ESTIMATOR_H
15 #define OTF2_EVENT_SIZE_ESTIMATOR_H
16 
17 
27 #include <stdint.h>
28 #include <stdlib.h>
29 
30 
31 #include <otf2/OTF2_ErrorCodes.h>
32 
33 
35 
36 
37 #ifdef __cplusplus
38 extern "C" {
39 #endif /* __cplusplus */
40 
41 
45 
46 
53 
54 
63 
64 
79  uint32_t numberOfStringDefinitions );
80 
81 
96  uint32_t numberOfAttributeDefinitions );
97 
98 
113  uint64_t numberOfLocationDefinitions );
114 
115 
130  uint32_t numberOfRegionDefinitions );
131 
132 
147  uint32_t numberOfGroupDefinitions );
148 
149 
164  uint32_t numberOfMetricDefinitions );
165 
166 
181  uint32_t numberOfCommDefinitions );
182 
183 
198  uint32_t numberOfParameterDefinitions );
199 
200 
215  uint32_t numberOfRmaWinDefinitions );
216 
217 
232  uint32_t numberOfSourceCodeLocationDefinitions );
233 
234 
249  uint32_t numberOfCallingContextDefinitions );
250 
251 
266  uint32_t numberOfInterruptGeneratorDefinitions );
267 
268 
283  uint32_t numberOfIoFileDefinitions );
284 
285 
300  uint32_t numberOfIoHandleDefinitions );
301 
302 
317 size_t
319 
320 
329 size_t
331 
332 
345 size_t
347  const OTF2_AttributeList* attributeList );
348 
349 
358 size_t
360 
361 
370 size_t
372 
373 
382 size_t
384 
385 
394 size_t
396 
397 
406 size_t
408 
409 
418 size_t
420 
421 
430 size_t
432 
433 
442 size_t
444 
445 
454 size_t
456 
457 
466 size_t
468 
469 
478 size_t
480 
481 
490 size_t
492 
493 
502 size_t
504 
505 
514 size_t
516 
517 
528 size_t
530 
531 
542 size_t
544 
545 
556 size_t
558 
559 
570 size_t
572 
573 
584 size_t
586 
587 
598 size_t
600 
601 
612 size_t
614 
615 
625 size_t
627  uint8_t numberOfMetrics );
628 
629 
638 size_t
640 
641 
650 size_t
652 
653 
662 size_t
664 
665 
674 size_t
676 
677 
686 size_t
688 
689 
698 size_t
700 
701 
710 size_t
712 
713 
722 size_t
724 
725 
734 size_t
736 
737 
746 size_t
748 
749 
758 size_t
760 
761 
770 size_t
772 
773 
782 size_t
784 
785 
794 size_t
796 
797 
806 size_t
808 
809 
818 size_t
820 
821 
830 size_t
832 
833 
842 size_t
844 
845 
854 size_t
856 
857 
866 size_t
868 
869 
878 size_t
880 
881 
890 size_t
892 
893 
902 size_t
904 
905 
914 size_t
916 
917 
926 size_t
928 
929 
938 size_t
940 
941 
950 size_t
952 
953 
962 size_t
964 
965 
974 size_t
976 
977 
986 size_t
988 
989 
998 size_t
1000 
1001 
1010 size_t
1012 
1013 
1022 size_t
1024 
1025 
1034 size_t
1036 
1037 
1046 size_t
1048 
1049 
1058 size_t
1060 
1061 
1070 size_t
1072 
1073 
1082 size_t
1084 
1085 
1094 size_t
1096 
1097 
1106 size_t
1108 
1109 
1118 size_t
1120 
1121 
1130 size_t
1132 
1133 
1142 size_t
1144 
1145 
1154 size_t
1156 
1157 
1166 size_t
1168 
1169 
1178 size_t
1180 
1181 
1190 size_t
1192 
1193 
1202 size_t
1204 
1205 
1214 size_t
1216 
1217 
1226 size_t
1228 
1229 
1238 size_t
1240 
1241 
1251 size_t
1253  uint32_t numberOfArguments );
1254 
1255 
1264 size_t
1266 
1267 
1268 #ifdef __cplusplus
1269 }
1270 #endif /* __cplusplus */
1271 
1272 
1273 #endif /* !OTF2_EVENT_SIZE_ESTIMATOR_H */
size_t OTF2_EventSizeEstimator_GetSizeOfThreadCreateEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the ThreadCreate event.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfMetricDefinitions(OTF2_EventSizeEstimator *estimator, uint32_t numberOfMetricDefinitions)
Sets the number of Metric definitions used.
size_t OTF2_EventSizeEstimator_GetSizeOfIoAcquireLockEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the IoAcquireLock event.
size_t OTF2_EventSizeEstimator_GetSizeOfMpiRequestCancelledEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the MpiRequestCancelled event.
size_t OTF2_EventSizeEstimator_GetSizeOfMpiIrecvEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the MpiIrecv event.
size_t OTF2_EventSizeEstimator_GetSizeOfIoOperationTestEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the IoOperationTest event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaOpCompleteRemoteEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the RmaOpCompleteRemote event.
size_t OTF2_EventSizeEstimator_GetSizeOfOmpTaskCreateEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the OmpTaskCreate event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaAtomicEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the RmaAtomic event.
size_t OTF2_EventSizeEstimator_GetSizeOfIoDestroyHandleEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the IoDestroyHandle event.
size_t OTF2_EventSizeEstimator_GetSizeOfMetricEvent(OTF2_EventSizeEstimator *estimator, uint8_t numberOfMetrics)
Calculates the size estimate for the Metric event.
size_t OTF2_EventSizeEstimator_GetDefChunkSize(OTF2_EventSizeEstimator *estimator)
Returns an estimate for the size of the definition chunk size.
size_t OTF2_EventSizeEstimator_GetSizeOfProgramBeginEvent(OTF2_EventSizeEstimator *estimator, uint32_t numberOfArguments)
Calculates the size estimate for the ProgramBegin event.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfParameterDefinitions(OTF2_EventSizeEstimator *estimator, uint32_t numberOfParameterDefinitions)
Sets the number of Parameter definitions used.
size_t OTF2_EventSizeEstimator_GetSizeOfIoChangeStatusFlagsEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the IoChangeStatusFlags event.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadTaskSwitchEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the ThreadTaskSwitch event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaWinDestroyEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the RmaWinDestroy event.
size_t OTF2_EventSizeEstimator_GetSizeOfBufferFlushEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the BufferFlush event.
size_t OTF2_EventSizeEstimator_GetSizeOfOmpAcquireLockEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the OmpAcquireLock event.
size_t OTF2_EventSizeEstimator_GetSizeOfMpiCollectiveEndEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the MpiCollectiveEnd event.
size_t OTF2_EventSizeEstimator_GetSizeOfIoDuplicateHandleEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the IoDuplicateHandle event.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadReleaseLockEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the ThreadReleaseLock event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaOpCompleteNonBlockingEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the RmaOpCompleteNonBlocking event.
This layer enables dynamic appending of arbitrary attributes to any type of event record...
size_t OTF2_EventSizeEstimator_GetSizeOfThreadJoinEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the ThreadJoin event.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadTeamBeginEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the ThreadTeamBegin event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaGroupSyncEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the RmaGroupSync event.
size_t OTF2_EventSizeEstimator_GetSizeOfIoCreateHandleEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the IoCreateHandle event.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadWaitEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the ThreadWait event.
size_t OTF2_EventSizeEstimator_GetSizeOfOmpTaskCompleteEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the OmpTaskComplete event.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfRmaWinDefinitions(OTF2_EventSizeEstimator *estimator, uint32_t numberOfRmaWinDefinitions)
Sets the number of RmaWin definitions used.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaWinCreateEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the RmaWinCreate event.
OTF2_EventSizeEstimator * OTF2_EventSizeEstimator_New(void)
Creates a new OTF2_EventSizeEstimator object.
size_t OTF2_EventSizeEstimator_GetSizeOfIoOperationCancelledEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the IoOperationCancelled event.
struct OTF2_AttributeList_struct OTF2_AttributeList
Attribute list handle.
Definition: OTF2_AttributeList.h:104
OTF2_ErrorCode
Definition: OTF2_ErrorCodes.h:54
size_t OTF2_EventSizeEstimator_GetSizeOfOmpTaskSwitchEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the OmpTaskSwitch event.
size_t OTF2_EventSizeEstimator_GetSizeOfOmpReleaseLockEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the OmpReleaseLock event.
size_t OTF2_EventSizeEstimator_GetSizeOfMeasurementOnOffEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the MeasurementOnOff event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaRequestLockEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the RmaRequestLock event.
size_t OTF2_EventSizeEstimator_GetSizeOfLeaveEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the Leave event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaCollectiveBeginEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the RmaCollectiveBegin event.
size_t OTF2_EventSizeEstimator_GetSizeOfIoTryLockEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the IoTryLock event.
size_t OTF2_EventSizeEstimator_GetSizeOfCallingContextEnterEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the CallingContextEnter event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaCollectiveEndEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the RmaCollectiveEnd event.
size_t OTF2_EventSizeEstimator_GetSizeOfMpiIsendCompleteEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the MpiIsendComplete event.
size_t OTF2_EventSizeEstimator_GetSizeOfOmpForkEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the OmpFork event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaGetEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the RmaGet event.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfAttributeDefinitions(OTF2_EventSizeEstimator *estimator, uint32_t numberOfAttributeDefinitions)
Sets the number of Attribute definitions used.
struct OTF2_EventSizeEstimator OTF2_EventSizeEstimator
Keeps all necessary information about the event size estimator. See OTF2_EventSizeEstimator_struct fo...
Definition: OTF2_EventSizeEstimator.h:44
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfCommDefinitions(OTF2_EventSizeEstimator *estimator, uint32_t numberOfCommDefinitions)
Sets the number of Comm definitions used.
size_t OTF2_EventSizeEstimator_GetSizeOfIoSeekEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the IoSeek event.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfLocationDefinitions(OTF2_EventSizeEstimator *estimator, uint64_t numberOfLocationDefinitions)
Sets the number of Location definitions used.
size_t OTF2_EventSizeEstimator_GetSizeOfIoDeleteFileEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the IoDeleteFile event.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfStringDefinitions(OTF2_EventSizeEstimator *estimator, uint32_t numberOfStringDefinitions)
Sets the number of String definitions used.
size_t OTF2_EventSizeEstimator_GetSizeOfIoOperationBeginEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the IoOperationBegin event.
size_t OTF2_EventSizeEstimator_GetSizeOfMpiIrecvRequestEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the MpiIrecvRequest event.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadTaskCreateEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the ThreadTaskCreate event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaAcquireLockEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the RmaAcquireLock event.
size_t OTF2_EventSizeEstimator_GetSizeOfMpiIsendEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the MpiIsend event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaWaitChangeEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the RmaWaitChange event.
size_t OTF2_EventSizeEstimator_GetSizeOfMpiCollectiveBeginEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the MpiCollectiveBegin event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaTryLockEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the RmaTryLock event.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadEndEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the ThreadEnd event.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadTeamEndEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the ThreadTeamEnd event.
size_t OTF2_EventSizeEstimator_GetSizeOfParameterUnsignedIntEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the ParameterUnsignedInt event.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadBeginEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the ThreadBegin event.
size_t OTF2_EventSizeEstimator_GetSizeOfCallingContextLeaveEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the CallingContextLeave event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaPutEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the RmaPut event.
size_t OTF2_EventSizeEstimator_GetSizeOfParameterIntEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the ParameterInt event.
size_t OTF2_EventSizeEstimator_GetSizeOfMpiRecvEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the MpiRecv event.
size_t OTF2_EventSizeEstimator_GetSizeOfMpiSendEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the MpiSend event.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfIoFileDefinitions(OTF2_EventSizeEstimator *estimator, uint32_t numberOfIoFileDefinitions)
Sets the number of IoFile definitions used.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfInterruptGeneratorDefinitions(OTF2_EventSizeEstimator *estimator, uint32_t numberOfInterruptGeneratorDefinitions)
Sets the number of InterruptGenerator definitions used.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfRegionDefinitions(OTF2_EventSizeEstimator *estimator, uint32_t numberOfRegionDefinitions)
Sets the number of Region definitions used.
size_t OTF2_EventSizeEstimator_GetSizeOfTimestamp(OTF2_EventSizeEstimator *estimator)
Returns the size for a timestamp record.
size_t OTF2_EventSizeEstimator_GetSizeOfParameterStringEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the ParameterString event.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadAcquireLockEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the ThreadAcquireLock event.
size_t OTF2_EventSizeEstimator_GetSizeOfAttributeList(const OTF2_EventSizeEstimator *estimator, const OTF2_AttributeList *attributeList)
Returns the size estimate for an attribute list.
size_t OTF2_EventSizeEstimator_GetSizeOfCallingContextSampleEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the CallingContextSample event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaSyncEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the RmaSync event.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfSourceCodeLocationDefinitions(OTF2_EventSizeEstimator *estimator, uint32_t numberOfSourceCodeLocationDefinitions)
Sets the number of SourceCodeLocation definitions used.
size_t OTF2_EventSizeEstimator_GetSizeOfOmpJoinEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the OmpJoin event.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfGroupDefinitions(OTF2_EventSizeEstimator *estimator, uint32_t numberOfGroupDefinitions)
Sets the number of Group definitions used.
size_t OTF2_EventSizeEstimator_GetSizeOfProgramEndEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the ProgramEnd event.
size_t OTF2_EventSizeEstimator_GetSizeOfMpiRequestTestEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the MpiRequestTest event.
size_t OTF2_EventSizeEstimator_GetSizeOfEnterEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the Enter event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaOpTestEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the RmaOpTest event.
OTF2_ErrorCode OTF2_EventSizeEstimator_Delete(OTF2_EventSizeEstimator *estimator)
Deletes an OTF2_EventSizeEstimator object.
size_t OTF2_EventSizeEstimator_GetSizeOfIoOperationCompleteEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the IoOperationComplete event.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfCallingContextDefinitions(OTF2_EventSizeEstimator *estimator, uint32_t numberOfCallingContextDefinitions)
Sets the number of CallingContext definitions used.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaOpCompleteBlockingEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the RmaOpCompleteBlocking event.
Error codes and error handling.
size_t OTF2_EventSizeEstimator_GetSizeOfIoOperationIssuedEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the IoOperationIssued event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaReleaseLockEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the RmaReleaseLock event.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadForkEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the ThreadFork event.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfIoHandleDefinitions(OTF2_EventSizeEstimator *estimator, uint32_t numberOfIoHandleDefinitions)
Sets the number of IoHandle definitions used.
size_t OTF2_EventSizeEstimator_GetSizeOfIoReleaseLockEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the IoReleaseLock event.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadTaskCompleteEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the ThreadTaskComplete event.