2004-01-15 07:47:20 +03:00
|
|
|
/*
|
2005-11-05 22:57:48 +03:00
|
|
|
* Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
|
|
|
|
|
* University Research and Technology
|
|
|
|
|
* Corporation. All rights reserved.
|
2006-08-23 07:32:36 +04:00
|
|
|
* Copyright (c) 2004-2006 The University of Tennessee and The University
|
2005-11-05 22:57:48 +03:00
|
|
|
* of Tennessee Research Foundation. All rights
|
|
|
|
|
* reserved.
|
2015-06-24 06:59:57 +03:00
|
|
|
* Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
|
2004-11-28 23:09:25 +03:00
|
|
|
* University of Stuttgart. All rights reserved.
|
2005-03-24 15:43:37 +03:00
|
|
|
* Copyright (c) 2004-2005 The Regents of the University of California.
|
|
|
|
|
* All rights reserved.
|
2008-05-20 16:13:19 +04:00
|
|
|
* Copyright (c) 2007-2008 Sun Microsystems, Inc. All rights reserved.
|
2004-11-22 04:38:40 +03:00
|
|
|
* $COPYRIGHT$
|
2015-06-24 06:59:57 +03:00
|
|
|
*
|
2004-11-22 04:38:40 +03:00
|
|
|
* Additional copyrights may follow
|
2015-06-24 06:59:57 +03:00
|
|
|
*
|
2004-01-15 07:47:20 +03:00
|
|
|
* $HEADER$
|
|
|
|
|
*/
|
|
|
|
|
|
2004-08-05 18:35:38 +04:00
|
|
|
/**
|
|
|
|
|
* @file
|
|
|
|
|
*
|
|
|
|
|
* Interface into the Open MPI Run Time Environment
|
|
|
|
|
*/
|
2005-05-19 17:33:55 +04:00
|
|
|
#ifndef ORTE_RUNTIME_H
|
|
|
|
|
#define ORTE_RUNTIME_H
|
2004-01-15 07:47:20 +03:00
|
|
|
|
2005-05-19 17:33:55 +04:00
|
|
|
#include "orte_config.h"
|
2004-02-01 00:47:59 +03:00
|
|
|
|
2004-10-20 05:03:09 +04:00
|
|
|
#ifdef HAVE_SYS_TYPES_H
|
2004-09-03 23:26:49 +04:00
|
|
|
#include <sys/types.h>
|
2004-10-20 05:03:09 +04:00
|
|
|
#endif
|
2004-09-03 23:26:49 +04:00
|
|
|
|
2009-05-04 15:07:40 +04:00
|
|
|
#include "orte/util/proc_info.h"
|
2004-09-23 18:40:05 +04:00
|
|
|
|
2008-02-28 04:57:57 +03:00
|
|
|
BEGIN_C_DECLS
|
2004-09-03 20:26:15 +04:00
|
|
|
|
2008-05-20 16:13:19 +04:00
|
|
|
/** version string of ompi */
|
|
|
|
|
ORTE_DECLSPEC extern const char orte_version_string[];
|
|
|
|
|
|
2008-06-18 07:15:56 +04:00
|
|
|
/**
|
|
|
|
|
* Whether ORTE is initialized or we are in orte_finalize
|
|
|
|
|
*/
|
2012-10-25 22:39:37 +04:00
|
|
|
ORTE_DECLSPEC extern int orte_initialized;
|
2008-06-18 07:15:56 +04:00
|
|
|
ORTE_DECLSPEC extern bool orte_finalizing;
|
|
|
|
|
ORTE_DECLSPEC extern int orte_debug_output;
|
|
|
|
|
ORTE_DECLSPEC extern bool orte_debug_flag;
|
|
|
|
|
|
2004-09-03 20:26:15 +04:00
|
|
|
/**
|
2005-08-27 00:13:35 +04:00
|
|
|
* Initialize the Open Run Time Environment
|
2004-09-03 20:26:15 +04:00
|
|
|
*
|
2005-08-27 00:13:35 +04:00
|
|
|
* Initlize the Open Run Time Environment, including process
|
2005-03-14 23:57:21 +03:00
|
|
|
* control, malloc debugging and threads, and out of band messaging.
|
2005-08-27 00:13:35 +04:00
|
|
|
* This function should be called exactly once. This function should
|
2004-09-03 20:26:15 +04:00
|
|
|
* be called by every application using the RTE interface, including
|
|
|
|
|
* MPI applications and mpirun.
|
2005-08-27 00:13:35 +04:00
|
|
|
*
|
2009-12-04 03:51:15 +03:00
|
|
|
* @param pargc Pointer to the number of arguments in the pargv array
|
|
|
|
|
* @param pargv The list of arguments.
|
|
|
|
|
* @param flags Whether we are ORTE tool or not
|
2004-09-03 20:26:15 +04:00
|
|
|
*/
|
2009-12-04 03:51:15 +03:00
|
|
|
ORTE_DECLSPEC int orte_init(int*pargc, char*** pargv, orte_proc_type_t flags);
|
2005-03-23 20:50:12 +03:00
|
|
|
|
2005-08-27 00:13:35 +04:00
|
|
|
/**
|
|
|
|
|
* Initialize parameters for ORTE.
|
|
|
|
|
*
|
|
|
|
|
* @retval ORTE_SUCCESS Upon success.
|
|
|
|
|
* @retval ORTE_ERROR Upon failure.
|
|
|
|
|
*/
|
2008-02-28 04:57:57 +03:00
|
|
|
ORTE_DECLSPEC int orte_register_params(void);
|
2005-08-27 00:13:35 +04:00
|
|
|
|
2004-09-03 20:26:15 +04:00
|
|
|
/**
|
2008-02-28 04:57:57 +03:00
|
|
|
* Finalize the Open run time environment. Any function calling \code
|
2015-06-24 06:59:57 +03:00
|
|
|
* orte_init should call \code orte_finalize.
|
2004-09-03 20:26:15 +04:00
|
|
|
*
|
|
|
|
|
*/
|
As per the RFC, bring in the ORTE async progress code and the rewrite of OOB:
*** THIS RFC INCLUDES A MINOR CHANGE TO THE MPI-RTE INTERFACE ***
Note: during the course of this work, it was necessary to completely separate the MPI and RTE progress engines. There were multiple places in the MPI layer where ORTE_WAIT_FOR_COMPLETION was being used. A new OMPI_WAIT_FOR_COMPLETION macro was created (defined in ompi/mca/rte/rte.h) that simply cycles across opal_progress until the provided flag becomes false. Places where the MPI layer blocked waiting for RTE to complete an event have been modified to use this macro.
***************************************************************************************
I am reissuing this RFC because of the time that has passed since its original release. Since its initial release and review, I have debugged it further to ensure it fully supports tests like loop_spawn. It therefore seems ready for merge back to the trunk. Given its prior review, I have set the timeout for one week.
The code is in https://bitbucket.org/rhc/ompi-oob2
WHAT: Rewrite of ORTE OOB
WHY: Support asynchronous progress and a host of other features
WHEN: Wed, August 21
SYNOPSIS:
The current OOB has served us well, but a number of limitations have been identified over the years. Specifically:
* it is only progressed when called via opal_progress, which can lead to hangs or recursive calls into libevent (which is not supported by that code)
* we've had issues when multiple NICs are available as the code doesn't "shift" messages between transports - thus, all nodes had to be available via the same TCP interface.
* the OOB "unloads" incoming opal_buffer_t objects during the transmission, thus preventing use of OBJ_RETAIN in the code when repeatedly sending the same message to multiple recipients
* there is no failover mechanism across NICs - if the selected NIC (or its attached switch) fails, we are forced to abort
* only one transport (i.e., component) can be "active"
The revised OOB resolves these problems:
* async progress is used for all application processes, with the progress thread blocking in the event library
* each available TCP NIC is supported by its own TCP module. The ability to asynchronously progress each module independently is provided, but not enabled by default (a runtime MCA parameter turns it "on")
* multi-address TCP NICs (e.g., a NIC with both an IPv4 and IPv6 address, or with virtual interfaces) are supported - reachability is determined by comparing the contact info for a peer against all addresses within the range covered by the address/mask pairs for the NIC.
* a message that arrives on one TCP NIC is automatically shifted to whatever NIC that is connected to the next "hop" if that peer cannot be reached by the incoming NIC. If no TCP module will reach the peer, then the OOB attempts to send the message via all other available components - if none can reach the peer, then an "error" is reported back to the RML, which then calls the errmgr for instructions.
* opal_buffer_t now conforms to standard object rules re OBJ_RETAIN as we no longer "unload" the incoming object
* NIC failure is reported to the TCP component, which then tries to resend the message across any other available TCP NIC. If that doesn't work, then the message is given back to the OOB base to try using other components. If all that fails, then the error is reported to the RML, which reports to the errmgr for instructions
* obviously from the above, multiple OOB components (e.g., TCP and UD) can be active in parallel
* the matching code has been moved to the RML (and out of the OOB/TCP component) so it is independent of transport
* routing is done by the individual OOB modules (as opposed to the RML). Thus, both routed and non-routed transports can simultaneously be active
* all blocking send/recv APIs have been removed. Everything operates asynchronously.
KNOWN LIMITATIONS:
* although provision is made for component failover as described above, the code for doing so has not been fully implemented yet. At the moment, if all connections for a given peer fail, the errmgr is notified of a "lost connection", which by default results in termination of the job if it was a lifeline
* the IPv6 code is present and compiles, but is not complete. Since the current IPv6 support in the OOB doesn't work anyway, I don't consider this a blocker
* routing is performed at the individual module level, yet the active routed component is selected on a global basis. We probably should update that to reflect that different transports may need/choose to route in different ways
* obviously, not every error path has been tested nor necessarily covered
* determining abnormal termination is more challenging than in the old code as we now potentially have multiple ways of connecting to a process. Ideally, we would declare "connection failed" when *all* transports can no longer reach the process, but that requires some additional (possibly complex) code. For now, the code replicates the old behavior only somewhat modified - i.e., if a module sees its connection fail, it checks to see if it is a lifeline. If so, it notifies the errmgr that the lifeline is lost - otherwise, it notifies the errmgr that a non-lifeline connection was lost.
* reachability is determined solely on the basis of a shared subnet address/mask - more sophisticated algorithms (e.g., the one used in the tcp btl) are required to handle routing via gateways
* the RML needs to assign sequence numbers to each message on a per-peer basis. The receiving RML will then deliver messages in order, thus preventing out-of-order messaging in the case where messages travel across different transports or a message needs to be redirected/resent due to failure of a NIC
This commit was SVN r29058.
2013-08-22 20:37:40 +04:00
|
|
|
ORTE_DECLSPEC int orte_finalize(void);
|
2007-02-03 03:25:42 +03:00
|
|
|
|
2008-02-28 04:57:57 +03:00
|
|
|
END_C_DECLS
|
2004-01-15 07:47:20 +03:00
|
|
|
|
Commit the orted-failed-to-start code. This correctly causes the system to detect the failure of an orted to start and allows the system to terminate all procs/orteds that *did* start.
The primary change that underlies all this is in the OOB. Specifically, the problem in the code until now has been that the OOB attempts to resolve an address when we call the "send" to an unknown recipient. The OOB would then wait forever if that recipient never actually started (and hence, never reported back its OOB contact info). In the case of an orted that failed to start, we would correctly detect that the orted hadn't started, but then we would attempt to order all orteds (including the one that failed to start) to die. This would cause the OOB to "hang" the system.
Unfortunately, revising how the OOB resolves addresses introduced a number of additional problems. Specifically, and most troublesome, was the fact that comm_spawn involved the immediate transmission of the rendezvous point from parent-to-child after the child was spawned. The current code used the OOB address resolution as a "barrier" - basically, the parent would attempt to send the info to the child, and then "hold" there until the child's contact info had arrived (meaning the child had started) and the send could be completed.
Note that this also caused comm_spawn to "hang" the entire system if the child never started... The app-failed-to-start helped improve that behavior - this code provides additional relief.
With this change, the OOB will return an ADDRESSEE_UNKNOWN error if you attempt to send to a recipient whose contact info isn't already in the OOB's hash tables. To resolve comm_spawn issues, we also now force the cross-sharing of connection info between parent and child jobs during spawn.
Finally, to aid in setting triggers to the right values, we introduce the "arith" API for the GPR. This function allows you to atomically change the value in a registry location (either divide, multiply, add, or subtract) by the provided operand. It is equivalent to first fetching the value using a "get", then modifying it, and then putting the result back into the registry via a "put".
This commit was SVN r14711.
2007-05-21 22:31:28 +04:00
|
|
|
#endif /* RUNTIME_H */
|