OpenMPI  0.1.1
iof_tool.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2004-2007 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) 2007 Cisco Systems, Inc. All rights reserved.
13  * Copyright (c) 2007 Sun Microsystems, Inc. All rights reserved.
14  * $COPYRIGHT$
15  *
16  * Additional copyrights may follow
17  *
18  * $HEADER$
19  */
20 /**
21  * @file
22  *
23  * The tool IOF component is used in tools. It is used
24  * to interface to the HNP to request forwarding of stdout/err/diag
25  * from any combination of procs, and to forward stdin from the
26  * tool to a specified proc provided the user has allowed that
27  * functionality.
28  *
29  * Flow control is employed on a per-stream basis to ensure that
30  * SOURCEs don't overwhelm SINK resources (E.g., send an entire input
31  * file to an orted before the target process has read any of it).
32  *
33  */
34 #ifndef ORTE_IOF_TOOL_H
35 #define ORTE_IOF_TOOL_H
36 
37 #include "orte_config.h"
38 #include "orte/mca/iof/iof.h"
39 
40 BEGIN_C_DECLS
41 
44  bool closed;
45  opal_mutex_t lock;
46 };
48 
49 ORTE_MODULE_DECLSPEC extern orte_iof_tool_component_t mca_iof_tool_component;
50 extern orte_iof_base_module_t orte_iof_tool_module;
51 
52 void orte_iof_tool_recv(int status, orte_process_name_t* sender,
53  opal_buffer_t* buffer, orte_rml_tag_t tag,
54  void* cbdata);
55 
56 END_C_DECLS
57 
58 #endif
Definition: types.h:146
Definition: iof.h:184
Definition: mutex_unix.h:53
I/O Forwarding Service The I/O forwarding service (IOF) is used to connect stdin, stdout...
uint32_t orte_rml_tag_t
Message matching tag.
Definition: rml_types.h:220
Structure for holding a buffer to be used with the RML or OOB subsystems.
Definition: dss_types.h:159
Definition: iof_tool.h:42
IOF module.
Definition: iof.h:171