1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
/*
* Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
* University Research and Technology
* Corporation. All rights reserved.
* Copyright (c) 2004-2006 The University of Tennessee and The University
* of Tennessee Research Foundation. All rights
* reserved.
* Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
* University of Stuttgart. All rights reserved.
* Copyright (c) 2004-2005 The Regents of the University of California.
* All rights reserved.
* $COPYRIGHT$
*
* Additional copyrights may follow
*
* $HEADER$
*
*/
#ifndef OPAL_TIMER_BASE_H
#define OPAL_TIMER_BASE_H
#include "opal_config.h"
#include "opal/mca/timer/timer.h"
/*
* Global functions for MCA overall timer open and close
*/
#if defined(c_plusplus) || defined(__cplusplus)
extern "C" {
#endif
/**
* Initialize the timer MCA framework
*
* @retval OPAL_SUCCESS Upon success
* @retval OPAL_ERROR Upon failure
*
* This must be the first function invoked in the timer MCA
* framework. It initializes the timer MCA framework, finds
* and opens timer components, etc.
*
* This function is invoked during opal_init() and during the
* initialization of the special case of the laminfo command.
*
* This function fills in the internal global variable
* opal_timer_base_components_opened, which is a list of all
* timer components that were successfully opened. This
* variable should \em only be used by other timer base
* functions -- it is not considered a public interface member --
* and is only mentioned here for completeness.
*/
OPAL_DECLSPEC int opal_timer_base_open(void);
/**
* Shut down the timer MCA framework.
*
* @retval OPAL_SUCCESS Always
*
* This function shuts down everything in the timer MCA
* framework, and is called during opal_finalize() and the
* special case of the laminfo command.
*
* It must be the last function invoked on the timer MCA framework.
*/
OPAL_DECLSPEC int opal_timer_base_close(void);
OPAL_DECLSPEC extern opal_list_t opal_timer_base_components_opened;
#if defined(c_plusplus) || defined(__cplusplus)
}
#endif
/* include implementation to call */
#include MCA_timer_IMPLEMENTATION_HEADER
#endif /* OPAL_BASE_TIMER_H */
|
