OpenMPI 0.1.1

- Main Page
- Related Pages
- Modules
- Data Structures
- Files

- File List
- Globals

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