ports/openmpi
ports/openmpi
1
1
Форкнуть 0
Код Релизы Активность
openmpi/orte/mca/iof/svc/iof_svc_proxy.c
Jeff Squyres e7ecd56bd2 This commit represents a bunch of work on a Mercurial side branch. As 
such, the commit message back to the master SVN repository is fairly
long.

= ORTE Job-Level Output Messages =

Add two new interfaces that should be used for all new code throughout
the ORTE and OMPI layers (we already make the search-and-replace on
the existing ORTE / OMPI layers):

 * orte_output(): (and corresponding friends ORTE_OUTPUT,
   orte_output_verbose, etc.)  This function sends the output directly
   to the HNP for processing as part of a job-specific output
   channel.  It supports all the same outputs as opal_output()
   (syslog, file, stdout, stderr), but for stdout/stderr, the output
   is sent to the HNP for processing and output.  More on this below.
 * orte_show_help(): This function is a drop-in-replacement for
   opal_show_help(), with two differences in functionality:
   1. the rendered text help message output is sent to the HNP for
      display (rather than outputting directly into the process' stderr
      stream)
   1. the HNP detects duplicate help messages and does not display them
      (so that you don't see the same error message N times, once from
      each of your N MPI processes); instead, it counts "new" instances
      of the help message and displays a message every ~5 seconds when
      there are new ones ("I got X new copies of the help message...")

opal_show_help and opal_output still exist, but they only output in
the current process.  The intent for the new orte_* functions is that
they can apply job-level intelligence to the output.  As such, we
recommend that all new ORTE and OMPI code use the new orte_*
functions, not thei opal_* functions.

=== New code ===

For ORTE and OMPI programmers, here's what you need to do differently
in new code:

 * Do not include opal/util/show_help.h or opal/util/output.h.
   Instead, include orte/util/output.h (this one header file has
   declarations for both the orte_output() series of functions and
   orte_show_help()).
 * Effectively s/opal_output/orte_output/gi throughout your code.
   Note that orte_output_open() takes a slightly different argument
   list (as a way to pass data to the filtering stream -- see below),
   so you if explicitly call opal_output_open(), you'll need to
   slightly adapt to the new signature of orte_output_open().
 * Literally s/opal_show_help/orte_show_help/.  The function signature
   is identical.

=== Notes ===

 * orte_output'ing to stream 0 will do similar to what
   opal_output'ing did, so leaving a hard-coded "0" as the first
   argument is safe.
 * For systems that do not use ORTE's RML or the HNP, the effect of
   orte_output_* and orte_show_help will be identical to their opal
   counterparts (the additional information passed to
   orte_output_open() will be lost!).  Indeed, the orte_* functions
   simply become trivial wrappers to their opal_* counterparts.  Note
   that we have not tested this; the code is simple but it is quite
   possible that we mucked something up.

= Filter Framework =

Messages sent view the new orte_* functions described above and
messages output via the IOF on the HNP will now optionally be passed
through a new "filter" framework before being output to
stdout/stderr.  The "filter" OPAL MCA framework is intended to allow
preprocessing to messages before they are sent to their final
destinations.  The first component that was written in the filter
framework was to create an XML stream, segregating all the messages
into different XML tags, etc.  This will allow 3rd party tools to read
the stdout/stderr from the HNP and be able to know exactly what each
text message is (e.g., a help message, another OMPI infrastructure
message, stdout from the user process, stderr from the user process,
etc.).

Filtering is not active by default.  Filter components must be
specifically requested, such as:

{{{
$ mpirun --mca filter xml ...
}}}

There can only be one filter component active.

= New MCA Parameters =

The new functionality described above introduces two new MCA
parameters:

 * '''orte_base_help_aggregate''': Defaults to 1 (true), meaning that
   help messages will be aggregated, as described above.  If set to 0,
   all help messages will be displayed, even if they are duplicates
   (i.e., the original behavior).
 * '''orte_base_show_output_recursions''': An MCA parameter to help
   debug one of the known issues, described below.  It is likely that
   this MCA parameter will disappear before v1.3 final.

= Known Issues =

 * The XML filter component is not complete.  The current output from
   this component is preliminary and not real XML.  A bit more work
   needs to be done to configure.m4 search for an appropriate XML
   library/link it in/use it at run time.
 * There are possible recursion loops in the orte_output() and
   orte_show_help() functions -- e.g., if RML send calls orte_output()
   or orte_show_help().  We have some ideas how to fix these, but
   figured that it was ok to commit before feature freeze with known
   issues.  The code currently contains sub-optimal workarounds so
   that this will not be a problem, but it would be good to actually
   solve the problem rather than have hackish workarounds before v1.3 final.

This commit was SVN r18434.
2008-05-13 20:00:55 +00:00

339 строки
11 KiB
C
Исходник Ответственный История

/*
* Copyright (c) 2004-2007 The Trustees of Indiana University and Indiana
* University Research and Technology
* Corporation. All rights reserved.
* Copyright (c) 2004-2006 The University of Tennessee and The University
* of Tennessee Research Foundation. All rights
* reserved.
* Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
* University of Stuttgart. All rights reserved.
* Copyright (c) 2004-2005 The Regents of the University of California.
* All rights reserved.
* Copyright (c) 2007 Cisco, Inc. All rights reserved.
* $COPYRIGHT$
*
* Additional copyrights may follow
*
* $HEADER$
*/
#include "orte_config.h"
#include "orte/types.h"
#include "orte/constants.h"
#include "orte/util/output.h"
#include "orte/mca/rml/rml.h"
#include "orte/mca/errmgr/errmgr.h"
#include "orte/util/name_fns.h"
#include "orte/mca/iof/base/iof_base_header.h"
#include "orte/mca/iof/base/iof_base_endpoint.h"
#include "orte/mca/iof/base/iof_base_fragment.h"
#include "iof_svc.h"
#include "iof_svc_proxy.h"
#include "iof_svc_pub.h"
#include "iof_svc_sub.h"
static void orte_iof_svc_proxy_msg(const orte_process_name_t*, orte_iof_base_msg_header_t*, unsigned char*);
static void orte_iof_svc_proxy_ack(const orte_process_name_t*, orte_iof_base_msg_header_t*, bool do_close);
static void orte_iof_svc_proxy_pub(const orte_process_name_t*, orte_iof_base_pub_header_t*);
static void orte_iof_svc_proxy_unpub(const orte_process_name_t*, orte_iof_base_pub_header_t*);
static void orte_iof_svc_proxy_sub(const orte_process_name_t*, orte_iof_base_sub_header_t*);
static void orte_iof_svc_proxy_unsub(const orte_process_name_t*, orte_iof_base_sub_header_t*);
/**
* Callback function from RML on receipt of IOF request.
*
* @param status (IN) Completion status.
* @param peer (IN) Opaque name of peer process.
* @param msg (IN) Array of iovecs describing user buffers and lengths.
* @param count (IN) Number of elements in iovec array.
* @param tag (IN) User defined tag for matching send/recv.
* @param cbdata (IN) User data.
*/
void orte_iof_svc_proxy_recv(
int status,
orte_process_name_t* peer,
struct iovec* iov,
int count,
orte_rml_tag_t tag,
void* cbdata)
{
orte_iof_base_header_t* hdr = (orte_iof_base_header_t*)iov[0].iov_base;
if(status < 0) {
ORTE_ERROR_LOG(status);
goto done;
}
switch(hdr->hdr_common.hdr_type) {
case ORTE_IOF_BASE_HDR_MSG:
ORTE_IOF_BASE_HDR_MSG_NTOH(hdr->hdr_msg);
orte_output_verbose(1, orte_iof_base.iof_output,
"orte_iof_svc_proxy_recv: HDR_MSG\n");
orte_iof_svc_proxy_msg(peer, &hdr->hdr_msg,
((unsigned char*)iov[0].iov_base)+sizeof(orte_iof_base_header_t));
break;
case ORTE_IOF_BASE_HDR_ACK:
ORTE_IOF_BASE_HDR_MSG_NTOH(hdr->hdr_msg);
orte_output_verbose(1, orte_iof_base.iof_output,
"orte_iof_svc_proxy_recv: HDR_ACK\n");
orte_iof_svc_proxy_ack(peer, &hdr->hdr_msg, false);
break;
case ORTE_IOF_BASE_HDR_CLOSE:
ORTE_IOF_BASE_HDR_MSG_NTOH(hdr->hdr_msg);
orte_output_verbose(1, orte_iof_base.iof_output,
"orte_iof_svc_proxy_recv: HDR_CLOSE\n");
orte_iof_svc_proxy_ack(peer, &hdr->hdr_msg, true);
break;
case ORTE_IOF_BASE_HDR_PUB:
ORTE_IOF_BASE_HDR_PUB_NTOH(hdr->hdr_pub);
orte_output_verbose(1, orte_iof_base.iof_output,
"orte_iof_svc_proxy_recv: HDR_PUB\n");
orte_iof_svc_proxy_pub(peer, &hdr->hdr_pub);
break;
case ORTE_IOF_BASE_HDR_UNPUB:
ORTE_IOF_BASE_HDR_PUB_NTOH(hdr->hdr_pub);
orte_output_verbose(1, orte_iof_base.iof_output,
"orte_iof_svc_proxy_recv: HDR_UNPUB\n");
orte_iof_svc_proxy_unpub(peer, &hdr->hdr_pub);
break;
case ORTE_IOF_BASE_HDR_SUB:
ORTE_IOF_BASE_HDR_SUB_NTOH(hdr->hdr_sub);
orte_output_verbose(1, orte_iof_base.iof_output,
"orte_iof_svc_proxy_recv: HDR_SUB\n");
orte_iof_svc_proxy_sub(peer, &hdr->hdr_sub);
break;
case ORTE_IOF_BASE_HDR_UNSUB:
ORTE_IOF_BASE_HDR_SUB_NTOH(hdr->hdr_sub);
orte_output_verbose(1, orte_iof_base.iof_output,
"orte_iof_svc_proxy_recv: HDR_UNSUB\n");
orte_iof_svc_proxy_unsub(peer, &hdr->hdr_sub);
break;
default:
orte_output_verbose(1, orte_iof_base.iof_output,
"orte_iof_svc_recv: invalid message type: %d (ignored)\n",
hdr->hdr_common.hdr_type);
break;
}
done:
free(hdr);
mca_iof_svc_component.svc_iov[0].iov_base = NULL;
mca_iof_svc_component.svc_iov[0].iov_len = 0;
}
/**
* Release resources when ack completed.
*/
static void ack_send_cb(
int status,
orte_process_name_t* peer,
struct iovec* msg,
int count,
orte_rml_tag_t tag,
void* cbdata)
{
orte_iof_base_frag_t* frag = (orte_iof_base_frag_t*)cbdata;
ORTE_IOF_BASE_FRAG_RETURN(frag);
if(status < 0) {
ORTE_ERROR_LOG(status);
}
}
/**
* Receive a data message. Check the subscription list for a match
* on the source - and on matches forward to any published endpoints
* that match the subscriptions destination.
*/
static void orte_iof_svc_proxy_msg(
const orte_process_name_t* peer,
orte_iof_base_msg_header_t* hdr,
unsigned char* data)
{
opal_list_item_t* item;
bool forwarded_at_all = false, forward = false;
orte_output_verbose(1, orte_iof_base.iof_output,
"orte_iof_svc_proxy_msg: tag %d seq %d",
hdr->msg_tag,hdr->msg_seq);
/* dispatch based on subscription list */
OPAL_THREAD_LOCK(&mca_iof_svc_component.svc_lock);
for(item = opal_list_get_first(&mca_iof_svc_component.svc_subscribed);
item != opal_list_get_end(&mca_iof_svc_component.svc_subscribed);
item = opal_list_get_next(item)) {
orte_iof_svc_sub_t* sub = (orte_iof_svc_sub_t*)item;
/* if the tags don't match, skip this subscription */
if(sub->origin_tag != hdr->msg_tag && hdr->msg_tag != ORTE_IOF_ANY) {
continue;
}
/* if the subscription origin doesn't match the message's
origin, skip this subscription */
if (OPAL_EQUAL == orte_util_compare_name_fields(sub->origin_mask,&sub->origin_name,&hdr->msg_origin)) {
orte_output_verbose(1, orte_iof_base.iof_output, "sub MATCH: origin %s, msg origin %s, msg proxy %s orte_iof_svc_proxy_msg: tag %d sequence %d, len %d",
ORTE_NAME_PRINT(&sub->origin_name),
ORTE_NAME_PRINT(&hdr->msg_origin),
ORTE_NAME_PRINT(&hdr->msg_proxy),
hdr->msg_tag, hdr->msg_seq, hdr->msg_len);
/* Everthing matched -- forward the message */
OPAL_THREAD_UNLOCK(&mca_iof_svc_component.svc_lock);
orte_iof_svc_sub_forward(sub,peer,hdr,data,&forward);
OPAL_THREAD_LOCK(&mca_iof_svc_component.svc_lock);
if (forward) {
forwarded_at_all = true;
}
}
}
OPAL_THREAD_UNLOCK(&mca_iof_svc_component.svc_lock);
/* If there was no one to forward to, then we effectively drop it.
But ACK it so that the sender doesn't block. */
if (!forwarded_at_all) {
orte_iof_base_frag_t* frag;
int rc;
orte_output_verbose(1, orte_iof_base.iof_output, "no sub match found -- dropped");
ORTE_IOF_BASE_FRAG_ALLOC(frag,rc);
if(NULL == frag) {
ORTE_ERROR_LOG(rc);
return;
}
frag->frag_hdr.hdr_msg = *hdr;
frag->frag_hdr.hdr_common.hdr_type = ORTE_IOF_BASE_HDR_ACK;
frag->frag_iov[0].iov_base = (IOVBASE_TYPE*)&frag->frag_hdr;
frag->frag_iov[0].iov_len = sizeof(frag->frag_hdr);
ORTE_IOF_BASE_HDR_MSG_HTON(frag->frag_hdr.hdr_msg);
rc = orte_rml.send_nb(
&hdr->msg_proxy,
frag->frag_iov,
1,
ORTE_RML_TAG_IOF_SVC,
0,
ack_send_cb,
frag);
if(rc < 0) {
ORTE_ERROR_LOG(rc);
}
}
}
static void orte_iof_svc_proxy_ack(
const orte_process_name_t* peer,
orte_iof_base_msg_header_t* hdr,
bool do_close)
{
orte_iof_svc_sub_ack(peer, hdr, do_close);
}
/**
* A remote process has announced that it has an endpoint that it is
* making available. Create an entry for it, and also check to see if
* the new publication matches any pending subscriptions.
*/
static void orte_iof_svc_proxy_pub(
const orte_process_name_t* peer,
orte_iof_base_pub_header_t* hdr)
{
int rc;
orte_output_verbose(1, orte_iof_base.iof_output, "orte_iof_svc_proxy_pub: mask %d, tag %d, proc %s, proxy %s",
hdr->pub_mask, hdr->pub_tag,
ORTE_NAME_PRINT(&hdr->pub_name),
ORTE_NAME_PRINT(&hdr->pub_proxy));
rc = orte_iof_svc_pub_create(
&hdr->pub_name,
&hdr->pub_proxy,
hdr->pub_mask,
hdr->pub_tag);
if (ORTE_SUCCESS != rc) {
ORTE_ERROR_LOG(rc);
}
}
/**
* Opposite of publish -- remove any previous publications and unmap
* it from any subscriptions that were using it.
*/
static void orte_iof_svc_proxy_unpub(
const orte_process_name_t* peer,
orte_iof_base_pub_header_t* hdr)
{
int rc;
orte_output_verbose(1, orte_iof_base.iof_output, "orte_iof_svc_proxy_unpub: mask %d, tag %d, proc %s, proxy %s",
hdr->pub_mask, hdr->pub_tag,
ORTE_NAME_PRINT(&hdr->pub_name),
ORTE_NAME_PRINT(&hdr->pub_proxy));
rc = orte_iof_svc_pub_delete(
&hdr->pub_name,
&hdr->pub_proxy,
hdr->pub_mask,
hdr->pub_tag);
if (ORTE_SUCCESS != rc && ORTE_ERR_NOT_FOUND != rc) {
ORTE_ERROR_LOG(rc);
}
}
/**
* Create a subscription entry. A subscription entry determines the
* set of origin(s) that will forward to any matching published
* endpoint targets.
*/
static void orte_iof_svc_proxy_sub(
const orte_process_name_t* peer,
orte_iof_base_sub_header_t* hdr)
{
int rc;
orte_output_verbose(1, orte_iof_base.iof_output, "orte_iof_svc_proxy_sub");
rc = orte_iof_svc_sub_create(
&hdr->origin_name,
hdr->origin_mask,
hdr->origin_tag,
&hdr->target_name,
hdr->target_mask,
hdr->target_tag);
if (ORTE_SUCCESS != rc) {
ORTE_ERROR_LOG(rc);
}
}
/**
* Remove a subscription.
*/
static void orte_iof_svc_proxy_unsub(
const orte_process_name_t* peer,
orte_iof_base_sub_header_t* hdr)
{
int rc;
orte_output_verbose(1, orte_iof_base.iof_output, "orte_iof_svc_proxy_unsub");
rc = orte_iof_svc_sub_delete(
&hdr->origin_name,
hdr->origin_mask,
hdr->origin_tag,
&hdr->target_name,
hdr->target_mask,
hdr->target_tag);
if (ORTE_SUCCESS != rc) {
ORTE_ERROR_LOG(rc);
}
}
Показать git blame Копировать постоянную ссылку