2.0 (revision 4408)
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 size_t
285 
286 
295 size_t
297 
298 
311 size_t
313  const OTF2_AttributeList* attributeList );
314 
315 
324 size_t
326 
327 
336 size_t
338 
339 
348 size_t
350 
351 
360 size_t
362 
363 
372 size_t
374 
375 
384 size_t
386 
387 
396 size_t
398 
399 
408 size_t
410 
411 
420 size_t
422 
423 
432 size_t
434 
435 
444 size_t
446 
447 
456 size_t
458 
459 
468 size_t
470 
471 
480 size_t
482 
483 
494 size_t
496 
497 
508 size_t
510 
511 
522 size_t
524 
525 
536 size_t
538 
539 
550 size_t
552 
553 
564 size_t
566 
567 
578 size_t
580 
581 
591 size_t
593  uint8_t numberOfMetrics );
594 
595 
604 size_t
606 
607 
616 size_t
618 
619 
628 size_t
630 
631 
640 size_t
642 
643 
652 size_t
654 
655 
664 size_t
666 
667 
676 size_t
678 
679 
688 size_t
690 
691 
700 size_t
702 
703 
712 size_t
714 
715 
724 size_t
726 
727 
736 size_t
738 
739 
748 size_t
750 
751 
760 size_t
762 
763 
772 size_t
774 
775 
784 size_t
786 
787 
796 size_t
798 
799 
808 size_t
810 
811 
820 size_t
822 
823 
832 size_t
834 
835 
844 size_t
846 
847 
856 size_t
858 
859 
868 size_t
870 
871 
880 size_t
882 
883 
892 size_t
894 
895 
904 size_t
906 
907 
916 size_t
918 
919 
928 size_t
930 
931 
940 size_t
942 
943 
952 size_t
954 
955 
964 size_t
966 
967 
976 size_t
978 
979 
988 size_t
990 
991 
1000 size_t
1002 
1003 
1012 size_t
1014 
1015 
1024 size_t
1026 
1027 
1036 size_t
1038 
1039 
1040 #ifdef __cplusplus
1041 }
1042 #endif /* __cplusplus */
1043 
1044 
1045 #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_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_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_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.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfParameterDefinitions(OTF2_EventSizeEstimator *estimator, uint32_t numberOfParameterDefinitions)
Sets the number of Parameter definitions used.
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_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_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.
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_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.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfLocationDefinitions(OTF2_EventSizeEstimator *estimator, uint64_t numberOfLocationDefinitions)
Sets the number of Location definitions used.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfStringDefinitions(OTF2_EventSizeEstimator *estimator, uint32_t numberOfStringDefinitions)
Sets the number of String definitions used.
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_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_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.
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_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.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadTaskCompleteEvent(OTF2_EventSizeEstimator *estimator)
Calculates the size estimate for the ThreadTaskComplete event.