OpenMPI 0.1.1

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

- File List
- Globals

show_help.h
Go to the documentation of this file.
1 /*
2 * Copyright (c) 2004-2008 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 (c) 2008-2011 Cisco Systems, Inc. All rights reserved.
13 * $COPYRIGHT$
14 *
15 * Additional copyrights may follow
16 *
17 * $HEADER$
18 */
19
20 /** @file:
21 *
22 * Populates global structure with system-specific information.
23 *
24 * Notes: add limits.h, compute size of integer and other types via sizeof(type)*CHAR_BIT
25 *
26 */
27
28 #ifndef _ORTE_SHOW_HELP_H_
29 #define _ORTE_SHOW_HELP_H_
30
31 #include "orte_config.h"
32 #include "orte/types.h"
33
34
35 #include "orte/mca/rml/rml_types.h"
36
37 BEGIN_C_DECLS
38
39 /**
40 * Initializes the output stream system and opens a default
41 * "verbose" stream.
42 *
43 * @retval success Upon success.
44 * @retval error Upon failure.
45 *
46 * This should be the first function invoked in the output
47 * subsystem. After this call, the default "verbose" stream is open
48 * and can be written to via calls to orte_output_verbose() and
49 * orte_output_error().
50 *
51 * By definition, the default verbose stream has a handle ID of 0,
52 * and has a verbose level of 0.
53 */
54 ORTE_DECLSPEC int orte_show_help_init(void);
55
56 /**
57 * Allow other parts of the code base to know if the ORTE show_help
58 * system is available or not (does not necessarily indicate that
59 * aggregating is available; on no-ORTE systems, ORTE show_help is
60 * available, but aggregating is not).
61 */
62 ORTE_DECLSPEC bool orte_show_help_is_available(void);
63
64 /**
65 * Shut down the output stream system.
66 *
67 * Shut down the output stream system, including the default verbose
68 * stream.
69 */
70 ORTE_DECLSPEC void orte_show_help_finalize(void);
71
72 /**
73 * Show help.
74 *
75 * Sends show help messages to the HNP if on a backend node. Note
76 * that aggregation is not currently supported on HNP-less systems
77 * (e.g., cray).
78 */
79 ORTE_DECLSPEC int orte_show_help(const char *filename, const char *topic,
80 bool want_error_header, ...);
81
82 /**
83 * Exactly the same as orte_show_help, but pass in a rendered string,
84 * rather than a varargs list which must be rendered.
85 */
86 ORTE_DECLSPEC int orte_show_help_norender(const char *filename,
87 const char *topic,
88 bool want_error_header,
89 const char *output);
90
91 /**
92 * Pretend that this message has already been shown.
93 *
94 * Sends a control message to the HNP that will effecitvely suppress
95 * this message from being shown. Primitive *-wildcarding is
96 * possible.
97 *
98 * Not currently supported on HNP-less systems (e.g., cray).
99 */
100 ORTE_DECLSPEC int orte_show_help_suppress(const char *filename,
101 const char *topic);
102
103 #if !ORTE_DISABLE_FULL_SUPPORT
104
105 ORTE_DECLSPEC void orte_show_help_recv(int status, orte_process_name_t* sender,
106 opal_buffer_t *buffer, orte_rml_tag_t tag,
107 void* cbdata);
108
109 #endif /* ORTE_DISABLE_FULL_SUPPORT */
110
111 END_C_DECLS
112 #endif
orte_show_help_norender
ORTE_DECLSPEC int orte_show_help_norender(const char *filename, const char *topic, bool want_error_header, const char *output)
Exactly the same as orte_show_help, but pass in a rendered string, rather than a varargs list which m...
Definition: show_help.c:662
orte_show_help
ORTE_DECLSPEC int orte_show_help(const char *filename, const char *topic, bool want_error_header,...)
Show help.
Definition: show_help.c:636
orte_process_name_t
Definition: types.h:146
orte_show_help_init
BEGIN_C_DECLS ORTE_DECLSPEC int orte_show_help_init(void)
Initializes the output stream system and opens a default "verbose" stream.
Definition: show_help.c:594
types.h
orte_show_help_suppress
ORTE_DECLSPEC int orte_show_help_suppress(const char *filename, const char *topic)
Pretend that this message has already been shown.
Definition: show_help.c:733
orte_show_help_finalize
ORTE_DECLSPEC void orte_show_help_finalize(void)
Shut down the output stream system.
Definition: show_help.c:612
orte_rml_tag_t
uint32_t orte_rml_tag_t
Message matching tag.
Definition: rml_types.h:220
orte_show_help_is_available
ORTE_DECLSPEC bool orte_show_help_is_available(void)
Allow other parts of the code base to know if the ORTE show_help system is available or not (does not...
Definition: show_help.c:53
opal_buffer_t
Structure for holding a buffer to be used with the RML or OOB subsystems.
Definition: dss_types.h:159
rml_types.h
Contains the typedefs for the use of the rml.