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