1
1
Ralph Castain a200e4f865 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 16:37:40 +00:00
..

Some notes from Jeff/Rolf while trying to figure out how IOF works...

1. E-mail from Rolf->Jeff with some pretty ASCII art
2. Notes from Jeff about problems we'll have when/if we ever try to
   use IOF more creatively.

===============================================================================

	From: 	  Rolf.Vandevaart@Sun.COM
	Subject: 	Picture of IOF side of things.
	Date: 	June 7, 2007 10:43:42 AM EDT
	To: 	  jsquyres@cisco.com


Not sure if this will come out for you, but here is an ASCII represantation of what
the HNP looks like after IOF has been wired up.



VIEW OF DATA STRUCTURES ON IOF SVC SIDE

KEY: ORTE_IOF_SOURCE=0
     ORTE_IOF_SINK=1

After the job starts up, this is how things look on the HNP side of things.

ENDPOINTS (orte_iof_base_endpoint_t)
mode   origin	 tag	fd	seq	ack	src_frags   sink_frags  notes
=============================================================================================      
1	0,0,0	 1      1         0       0             0            0  pull() call from rmgr<-
=============================================================================================  |
1	0,0,0	 2      2         0       0             0            0  pull() call from rmgr<-|---
=============================================================================================  |   |
0	0,0,0    0      0         0       0             0            0  push() call from rmgr  |   |
=============================================================================================  |   |
                                                                                               |   |
                                                                                               |   |
SUBSCRIBERS (orte_iof_svc_sub_t)                                                               |   |
   ORIGIN              TARGET		  	 (list)                                        |   |
name   mask  tag    name   mask  tag  endpoint  forward  has_been_acked last_ack_forwarded     |   |
======================================================================================         |   |
0,1,0     2    1    0,0,0     2    1    	      0                                        |   |
                                           ptr-------------------------------------------------|   |
======================================================================================             |
0,1,0     2    2    0,0,0     2    2                  0                                            |
                                           ptr-----------------------------------------------------|
======================================================================================
0,0,0    ff    0    0,1,0     2    0      NULL	      1 -----------------------------------
                                                                                           |
======================================================================================     |
                                                                                           |
                                                                                           |
PUBLISHED (orte_iof_svc_pub_t)                                                             |
name   proxy    mask  tag	endpoint                                                   |
=========================================================================================  |
0,1,0  0,0,1      ff    0       NULL                                    <------------------
=========================================================================================


FORWARD (orte_iof_svc_fwd_t)
This structure is just a connection from a subscriber to publisher.  I have
omitted it in the drawings.  However, it is worth pointing out the structure
as I am not clear on why we have the table.

struct orte_iof_svc_fwd_t {
    opal_list_item_t super;
    orte_iof_svc_pub_t* fwd_pub;
    opal_hash_table_t fwd_seq_hash;
};


Note: This first subscriber says that it will receive from any process 
in the job.  Note that the jobid=1 and the mask=2.  So, we expect this
to collect the stdout from any of the ranks.  Obviously the second 
subscriber says the same thing but for stderr.  The third subscriber
is for receving data from stdin and sending it out to rank 0 of
the job.  Notice the mask=ff which means compare jobid,vpid
when addressing where the data goes.

The first endpoint is created by a call to pull by the rmgr.  After
the endpoint is created, a subscription is created as well.  Then, the
subscription is tied to the endpoint.

For the stdin creation, we first create the subscription, and then the
endpoint.  In that way, the endpoint is not found and does not get
tied to the subscription.  Hmmm, this I do not really understand.



APPENDIX A
These are the defines that go with the mask.  
#define ORTE_NS_CMP_NONE       0x00
#define ORTE_NS_CMP_JOBID      0x02
#define ORTE_NS_CMP_VPID       0x04
#define ORTE_NS_CMP_ALL        0Xff


When we get a HDR_MSG, we call orte_iof_svc_proxy_msg() 

APPENDIX B
There are two dbx files that help get to where we want to get 
for seeing how things work.  
start.x : Run this first to get initial breakpoint.  Needs this
so we can set additional breakpoints.  This also has some very
helpful aliases for looking at the structures shown above.

follow.x : Run this second to set initial breakpoints and setup
some useful aliases.

===============================================================================

Random notes from Jeff:

- Many issues may not come up because we only have single subscribers;
  I'm sure new things will come up.  Examples:

  - What happens if all subscribers to a stream disconnect, and then a
    new subscriber connects?  I'm guessing the ACKs will be all
    screwed up and we'll never end up reading from that fd again
    (because it will likely be stalled because not enough acks have
    been received, and therefore it removed itself from the event
    engine).

  - If all subscribers disconnect from a stdin/SINK, chances are that
    we'll lose the last frag that was sent before the disconnect.
    I.e., if there was a frag in flight when the disconnect was
    received, that frag is effectively lost.  So if someone reconnects
    to the stdin stream later, it won't start reading exactly where
    the first subscriber left off.  We need to define what is
    *supposed* to happen here...

- odls default: make handling of vpid 0 uniform between setup and
  takedown -- some kind of global variable, perhaps?  (not multi-proc /
  thread safe)

- odls default: currently, we publish stdin (if relevant), stdout, and
  stderr (note that only the stdin publish message gets sent to svc;
  the publish for SOURCEs stdout/stderr is not actually sent to the
  svc because all SOURCE frags are sent to the svc automatically).
  But we only unpublish stdout.  I think we should either:
  - publish stdin, stdout, stderr, and unpublish stdin, stdout, stderr
    or
  - publish stdin, and unpublish stdin
  I.e., make the code symmetric.

  Note, however, that unpublish for STDOUT/STDERR are sent to the svc
  (whereas publish for STDOUT/STDERR are not).  So if we unpublish
  stdout/stderr, we'll be creating a storm to the svc upon shutdown
  (i.e,. scalability problems).  :-(

- for scalability, we want to be able to change the proxy to *not*
  unconfitionally send everything to svc.  But this has the problem
  that if we do this, then we have to send the publish request to the
  svc (which we don't today since everything just automatically goes
  to svc).  But then in the common case (where vpid!=0 has no
  stdout/stderr), we're flooding svc with N publish requests from all
  the vpids, simply creating a different scalability problem (during
  startup).

- random q: are the proxy publish requests not sent back to svc
  because it prevents a storm of publish requests during startup?
  I.e., this was intentional to give better scalability?  Could be;
  but it still seems weird...

  Perhaps a better scheme would be to have the IOF *assume* that the
  stdin/stdout/stderr are all published upon startup (or be told by a
  single control message; perhaps in the app context?) and further
  *assume* that they are all unpublished when the job completes.

  Putting this info in the app context (for example) might jive with a
  more capable orterun that allows flexible stdin/stdout/stderr
  mapping (think: mpirun --screen ...).  mpirun makes the decision
  about how to wire up stdin/stdout/stderr and includes it in the app
  context (or whatever).  This is given to the svc who then creates
  publications as relevant.  Upon job completion, all
  publications/subscriptions related to that job are destroyed.