e7ecd56bd2
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.
204 строки
7.0 KiB
C
204 строки
7.0 KiB
C
/*
|
|
* Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
|
|
* University Research and Technology
|
|
* Corporation. All rights reserved.
|
|
* Copyright (c) 2004-2005 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$
|
|
*
|
|
* Additional copyrights may follow
|
|
*
|
|
* $HEADER$
|
|
*/
|
|
|
|
#include "ompi_config.h"
|
|
|
|
#include <stdio.h>
|
|
#include <stdlib.h>
|
|
|
|
#include "mpi.h"
|
|
#include "ompi/constants.h"
|
|
#include "opal/class/opal_list.h"
|
|
#include "orte/util/output.h"
|
|
#include "opal/mca/mca.h"
|
|
#include "opal/mca/base/base.h"
|
|
#include "opal/mca/base/mca_base_component_repository.h"
|
|
#include "ompi/mca/io/io.h"
|
|
#include "ompi/mca/io/base/base.h"
|
|
#include "ompi/mca/io/base/io_base_request.h"
|
|
|
|
|
|
|
|
/*
|
|
* Private functions
|
|
*/
|
|
static int init_query(const mca_base_component_t *ls,
|
|
mca_base_component_priority_list_item_t *entry,
|
|
bool enable_progress_threads,
|
|
bool enable_mpi_threads);
|
|
static int init_query_1_0_0(const mca_base_component_t *ls,
|
|
mca_base_component_priority_list_item_t *entry,
|
|
bool enable_progress_threads,
|
|
bool enable_mpi_threads);
|
|
|
|
/*
|
|
* Scan down the list of successfully opened components and query each of
|
|
* them (the opened list will be one or more components. If the user
|
|
* requested a specific component, it will be the only component in the
|
|
* opened list). Create and populate the available list of all
|
|
* components who indicate that they want to be considered for selection.
|
|
* Close all components who do not want to be considered for selection,
|
|
* and destroy the opened list.
|
|
*
|
|
* It is *not* an error if there are no io components available.
|
|
* Appropriate run-time MPI exceptions will be invoked during
|
|
* MPI_FILE_OPEN and MPI_FILE_DELETE.
|
|
*/
|
|
int mca_io_base_find_available(bool enable_progress_threads,
|
|
bool enable_mpi_threads)
|
|
{
|
|
int err;
|
|
mca_base_component_priority_list_item_t *entry;
|
|
opal_list_item_t *p;
|
|
const mca_base_component_t *component;
|
|
|
|
/* Initialize the list */
|
|
|
|
OBJ_CONSTRUCT(&mca_io_base_components_available, opal_list_t);
|
|
mca_io_base_components_available_valid = true;
|
|
|
|
/* The list of components that we should check has already been
|
|
established in mca_io_base_open. */
|
|
|
|
for (p = opal_list_remove_first(&mca_io_base_components_opened);
|
|
p != NULL;
|
|
p = opal_list_remove_first(&mca_io_base_components_opened)) {
|
|
component = ((mca_base_component_list_item_t *) p)->cli_component;
|
|
|
|
/* Call a subroutine to do the work, because the component may
|
|
represent different versions of the io MCA. */
|
|
|
|
entry = OBJ_NEW(mca_base_component_priority_list_item_t);
|
|
entry->super.cli_component = component;
|
|
entry->cpli_priority = 0;
|
|
if (OMPI_SUCCESS == init_query(component, entry,
|
|
enable_progress_threads,
|
|
enable_mpi_threads)) {
|
|
|
|
/* Save the results in the list. The priority isn't
|
|
relevant, because selection is decided at
|
|
communicator-constructor time. But we save the thread
|
|
arguments (set in the init_query() function) so that
|
|
the initial selection algorithm can negotiate the
|
|
overall thread level for this process. */
|
|
|
|
opal_list_append(&mca_io_base_components_available,
|
|
(opal_list_item_t *) entry);
|
|
} else {
|
|
|
|
/* If the component doesn't want to run, then close it.
|
|
It's already had its close() method invoked; now close
|
|
it out of the DSO repository (if it's there). */
|
|
|
|
mca_base_component_repository_release(component);
|
|
OBJ_RELEASE(entry);
|
|
}
|
|
|
|
/* Free the entry from the "opened" list */
|
|
|
|
OBJ_RELEASE(p);
|
|
}
|
|
|
|
/* The opened list is now no longer useful and we can free it */
|
|
|
|
OBJ_DESTRUCT(&mca_io_base_components_opened);
|
|
mca_io_base_components_opened_valid = false;
|
|
|
|
/* Setup the freelist */
|
|
|
|
if (OMPI_SUCCESS != (err = mca_io_base_request_create_freelist())) {
|
|
return err;
|
|
}
|
|
|
|
/* All done */
|
|
|
|
return OMPI_SUCCESS;
|
|
}
|
|
|
|
|
|
/*
|
|
* Query a component, see if it wants to run at all. If it does, save
|
|
* some information. If it doesn't, close it.
|
|
*/
|
|
static int init_query(const mca_base_component_t *m,
|
|
mca_base_component_priority_list_item_t *entry,
|
|
bool enable_progress_threads,
|
|
bool enable_mpi_threads)
|
|
{
|
|
int ret;
|
|
|
|
orte_output_verbose(10, mca_io_base_output,
|
|
"io:find_available: querying io component %s",
|
|
m->mca_component_name);
|
|
|
|
/* This component has already been successfully opened. So now
|
|
query it. */
|
|
|
|
if (1 == m->mca_type_major_version &&
|
|
0 == m->mca_type_minor_version &&
|
|
0 == m->mca_type_release_version) {
|
|
ret = init_query_1_0_0(m, entry, enable_progress_threads,
|
|
enable_mpi_threads);
|
|
} else {
|
|
/* Unrecognized io API version */
|
|
|
|
orte_output_verbose(10, mca_io_base_output,
|
|
"io:find_available: unrecognized io API version (%d.%d.%d)",
|
|
m->mca_type_major_version,
|
|
m->mca_type_minor_version,
|
|
m->mca_type_release_version);
|
|
/* JMS show_help */
|
|
return OMPI_ERROR;
|
|
}
|
|
|
|
/* Query done -- look at the return value to see what happened */
|
|
|
|
if (OMPI_SUCCESS != ret) {
|
|
orte_output_verbose(10, mca_io_base_output,
|
|
"io:find_available: io component %s is not available",
|
|
m->mca_component_name);
|
|
if (NULL != m->mca_close_component) {
|
|
m->mca_close_component();
|
|
}
|
|
} else {
|
|
orte_output_verbose(10, mca_io_base_output,
|
|
"io:find_available: io component %s is available",
|
|
m->mca_component_name);
|
|
}
|
|
|
|
/* All done */
|
|
|
|
return ret;
|
|
}
|
|
|
|
|
|
/*
|
|
* Query a specific component, io v1.0.0
|
|
*/
|
|
static int init_query_1_0_0(const mca_base_component_t *component,
|
|
mca_base_component_priority_list_item_t *entry,
|
|
bool enable_progress_threads,
|
|
bool enable_mpi_threads)
|
|
{
|
|
mca_io_base_component_1_0_0_t *io =
|
|
(mca_io_base_component_1_0_0_t *) component;
|
|
|
|
return io->io_init_query(enable_progress_threads,
|
|
enable_mpi_threads);
|
|
}
|