2005-07-20 01:04:22 +04: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.
|
2011-10-04 18:50:31 +04:00
|
|
|
* Copyright (c) 2004-2011 The University of Tennessee and The University
|
2005-11-05 22:57:48 +03:00
|
|
|
* of Tennessee Research Foundation. All rights
|
|
|
|
|
* reserved.
|
2005-07-20 01:04:22 +04:00
|
|
|
* 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.
|
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-14 00:00:55 +04:00
|
|
|
* Copyright (c) 2007-2008 Cisco Systems, Inc. All rights reserved.
|
2007-10-15 17:10:20 +04:00
|
|
|
* Copyright (c) 2007 Sun Microsystems, Inc. All rights reserved.
|
2013-01-28 03:25:10 +04:00
|
|
|
* Copyright (c) 2012 Los Alamos National Security, LLC.
|
|
|
|
|
* All rights reserved.
|
|
|
|
|
* $COPYRIGHT$
|
2005-07-20 01:04:22 +04:00
|
|
|
*
|
|
|
|
|
* Additional copyrights may follow
|
|
|
|
|
*
|
|
|
|
|
* $HEADER$
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef MCA_BTL_BASE_ERROR_H
|
|
|
|
|
#define MCA_BTL_BASE_ERROR_H
|
|
|
|
|
|
2005-08-02 17:20:50 +04:00
|
|
|
#include "ompi_config.h"
|
2006-09-25 21:17:43 +04:00
|
|
|
|
|
|
|
|
#include <errno.h>
|
2005-08-02 17:20:50 +04:00
|
|
|
#include <stdio.h>
|
2006-09-25 21:17:43 +04:00
|
|
|
|
2013-01-28 03:25:10 +04:00
|
|
|
#include "ompi/mca/rte/rte.h"
|
2005-07-20 19:17:18 +04:00
|
|
|
|
2007-10-15 17:10:20 +04:00
|
|
|
OMPI_DECLSPEC extern int mca_btl_base_verbose;
|
2005-08-02 17:20:50 +04:00
|
|
|
|
2009-05-14 04:10:59 +04:00
|
|
|
OMPI_DECLSPEC extern int mca_btl_base_err(const char*, ...) __opal_attribute_format__(__printf__, 1, 2);
|
|
|
|
|
OMPI_DECLSPEC extern int mca_btl_base_out(const char*, ...) __opal_attribute_format__(__printf__, 1, 2);
|
2005-08-02 17:20:50 +04:00
|
|
|
|
2011-10-04 18:50:31 +04:00
|
|
|
#define BTL_OUTPUT(args) \
|
|
|
|
|
do { \
|
|
|
|
|
mca_btl_base_out("[%s]%s[%s:%d:%s] ", \
|
2013-01-28 03:25:10 +04:00
|
|
|
ompi_process_info.nodename, \
|
|
|
|
|
OMPI_NAME_PRINT(OMPI_PROC_MY_NAME), \
|
2011-10-04 18:50:31 +04:00
|
|
|
__FILE__, __LINE__, __func__); \
|
|
|
|
|
mca_btl_base_out args; \
|
|
|
|
|
mca_btl_base_out("\n"); \
|
2005-08-02 17:20:50 +04:00
|
|
|
} while(0);
|
|
|
|
|
|
|
|
|
|
|
2011-10-04 18:50:31 +04:00
|
|
|
#define BTL_ERROR(args) \
|
|
|
|
|
do { \
|
|
|
|
|
mca_btl_base_err("[%s]%s[%s:%d:%s] ", \
|
2013-01-28 03:25:10 +04:00
|
|
|
ompi_process_info.nodename, \
|
|
|
|
|
OMPI_NAME_PRINT(OMPI_PROC_MY_NAME), \
|
2011-10-04 18:50:31 +04:00
|
|
|
__FILE__, __LINE__, __func__); \
|
|
|
|
|
mca_btl_base_err args; \
|
|
|
|
|
mca_btl_base_err("\n"); \
|
2006-06-06 00:02:41 +04:00
|
|
|
} while(0);
|
|
|
|
|
|
2011-10-04 18:50:31 +04:00
|
|
|
#define BTL_PEER_ERROR(proc, args) \
|
|
|
|
|
do { \
|
|
|
|
|
mca_btl_base_err("%s[%s:%d:%s] from %s ", \
|
2013-01-28 03:25:10 +04:00
|
|
|
OMPI_NAME_PRINT(OMPI_PROC_MY_NAME), \
|
2011-10-04 18:50:31 +04:00
|
|
|
__FILE__, __LINE__, __func__, \
|
2013-01-28 03:25:10 +04:00
|
|
|
ompi_process_info.nodename); \
|
When we direct launch an application, we rely on PMI for wireup support. In doing so, we lose the de facto data compression we get from the ORTE modex since we no longer get all the wireup info from every proc in a single blob. Instead, we have to iterate over all the procs, calling PMI_KVS_get for every value we require.
This creates a really bad scaling behavior. Users have found a nearly 20% launch time differential between mpirun and PMI, with PMI being the slower method. Some of the problem is attributable to poor exchange algorithms in RM's like Slurm and Alps, but we make things worse by calling "get" so many times.
Nathan (with a tad advice from me) has attempted to alleviate this problem by reducing the number of "get" calls. This required the following changes:
* upon first request for data, have the OPAL db pmi component fetch and decode *all* the info from a given remote proc. It turned out we weren't caching the info, so we would continually request it and only decode the piece we needed for the immediate request. We now decode all the info and push it into the db hash component for local storage - and then all subsequent retrievals are fulfilled locally
* reduced the amount of data by eliminating the exchange of the OMPI_ARCH value if heterogeneity is not enabled. This was used solely as a check so we would error out if the system wasn't actually homogeneous, which was fine when we thought there was no cost in doing the check. Unfortunately, at large scale and with direct launch, there is a non-zero cost of making this test. We are open to finding a compromise (perhaps turning the test off if requested?), if people feel strongly about performing the test
* reduced the amount of RTE data being automatically fetched, and fetched the rest only upon request. In particular, we no longer immediately fetch the hostname (which is only used for error reporting), but instead get it when needed. Likewise for the RML uri as that info is only required for some (not all) environments. In addition, we no longer fetch the locality unless required, relying instead on the PMI clique info to tell us who is on our local node (if additional info is required, the fetch is performed when a modex_recv is issued).
Again, all this only impacts direct launch - all the info is provided when launched via mpirun as there is no added cost to getting it
Barring objections, we may move this (plus any required other pieces) to the 1.7 branch once it soaks for an appropriate time.
This commit was SVN r29040.
2013-08-17 04:49:18 +04:00
|
|
|
if(proc && ompi_proc_get_hostname(proc)) { \
|
|
|
|
|
mca_btl_base_err("to: %s ", ompi_proc_get_hostname(proc)); \
|
2011-10-04 18:50:31 +04:00
|
|
|
} \
|
|
|
|
|
mca_btl_base_err args; \
|
|
|
|
|
mca_btl_base_err("\n"); \
|
2005-08-02 17:20:50 +04:00
|
|
|
} while(0);
|
|
|
|
|
|
|
|
|
|
|
2009-05-07 00:11:28 +04:00
|
|
|
#if OPAL_ENABLE_DEBUG
|
2011-10-04 18:50:31 +04:00
|
|
|
#define BTL_VERBOSE(args) \
|
|
|
|
|
do { \
|
|
|
|
|
if(mca_btl_base_verbose > 0) { \
|
|
|
|
|
mca_btl_base_err("[%s]%s[%s:%d:%s] ", \
|
2013-01-28 03:25:10 +04:00
|
|
|
ompi_process_info.nodename, \
|
|
|
|
|
OMPI_NAME_PRINT(OMPI_PROC_MY_NAME), \
|
2011-10-04 18:50:31 +04:00
|
|
|
__FILE__, __LINE__, __func__); \
|
|
|
|
|
mca_btl_base_err args; \
|
|
|
|
|
mca_btl_base_err("\n"); \
|
|
|
|
|
} \
|
2005-08-09 20:22:55 +04:00
|
|
|
} while(0);
|
2005-07-20 19:17:18 +04:00
|
|
|
#else
|
2005-08-09 20:22:55 +04:00
|
|
|
#define BTL_VERBOSE(args)
|
2005-08-02 17:20:50 +04:00
|
|
|
#endif
|
|
|
|
|
|
2005-07-20 01:04:22 +04:00
|
|
|
#endif
|
2005-09-30 08:39:44 +04:00
|
|
|
|
|
|
|
|
|
2008-02-28 04:57:57 +03:00
|
|
|
BEGIN_C_DECLS
|
2005-09-30 08:39:44 +04:00
|
|
|
|
2007-04-27 15:38:45 +04:00
|
|
|
OMPI_DECLSPEC extern void mca_btl_base_error_no_nics(const char* transport,
|
|
|
|
|
const char* nic_name);
|
2005-09-30 08:39:44 +04:00
|
|
|
|
2008-02-28 04:57:57 +03:00
|
|
|
END_C_DECLS
|