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.
171 строка
6.2 KiB
C
171 строка
6.2 KiB
C
/*
|
|
* Copyright (c) 2004-2005 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) 2008 Cisco Systems, Inc. All rights reserved.
|
|
* $COPYRIGHT$
|
|
*
|
|
* Additional copyrights may follow
|
|
*
|
|
* $HEADER$
|
|
*/
|
|
/**
|
|
* @file
|
|
*
|
|
* The "show help" subsystem (SHS) in Open MPI is intended to help the
|
|
* developer convey meaningful information to the user (read longer
|
|
* than is convenient in a single printf), particularly when errors
|
|
* occur. The SHS allows the storage of arbitrary-length help
|
|
* messages in text files which can be parameterized by text filename,
|
|
* message name, POSIX locale, and printf()-style parameters (e.g.,
|
|
* "%s", "%d", etc.). Note that the primary purpose of the SHS is to
|
|
* display help messages, but it can actually be used to display any
|
|
* arbitrary text messages.
|
|
*
|
|
* The function opal_show_help() is used to find a help message and
|
|
* display it. Its important parameters are a filename, message name,
|
|
* and printf()-style varargs parameters used to substitute into the
|
|
* message.
|
|
*
|
|
* There's work pending about i18n-like support (nothing near as
|
|
* complex as GNU gettext -- just a simple mechanism that may be
|
|
* used). But I won't describe it here until/if it's actually used.
|
|
* So right now, the file lookup is quite straightforward -- the
|
|
* caller passes in the filename to find the help message, and the SHS
|
|
* looks for that file in $pkgdatadir (typically
|
|
* $prefix/share/openmpi).
|
|
*
|
|
* Once the file is successfully opened, the SHS looks for the
|
|
* appropriate help message to display. It looks for the message name
|
|
* in the file, reads in the message, and displays it. printf()-like
|
|
* substitutions are performed (e.g., %d, %s, etc.) --
|
|
* opal_show_help() takes a variable legnth argument list that are
|
|
* used for these substitutions.
|
|
*
|
|
* The format of the help file is simplistic:
|
|
*
|
|
* - Comments begin with #. Any characters after a # on a line are
|
|
* ignored. It is not possible to escape a #.
|
|
* - Message names are on a line by themselves and marked with [].
|
|
* Names can be any ASCII string within the [] (excluding the
|
|
* characters newline, linefeed, [, ], and #).
|
|
* - Messages are any characters between message names and/or the end
|
|
* of the file.
|
|
*
|
|
* Here's a sample helpfile:
|
|
*
|
|
* \verbatimbegin
|
|
* # This is a comment.
|
|
* [topic 1]
|
|
* Here's the first message. Let's substitute in an integer: %d.
|
|
* The quick brown fox jumped over the lazy %s.
|
|
* # This is another comment -- it's not displayed in the first message.
|
|
* [another:topic:foo:foo:foo]
|
|
* This is the second message. Let's just keep rolling along to get
|
|
* to the second line in the message for this example.
|
|
* \verbatimend
|
|
*
|
|
* It is expected that help messages will be grouped by filename;
|
|
* similar messages should be in a single file. For example, an MCA
|
|
* component may install its own helpfile in Open MPI's $pkgdatadir,
|
|
* and therefore the component can invoke opal_show_help() to display
|
|
* its own help messages.
|
|
*
|
|
* Message files in $pkgdatadir have a naming convention: they
|
|
* generally start with the prefix "help-" and are followed by a name
|
|
* descriptive of what kind of messages they contain. MCA components
|
|
* should generally abide by the MCA prefix rule, with the exception
|
|
* that they should start the filename with "help-", as mentioned
|
|
* previously.
|
|
*/
|
|
|
|
#ifndef OPAL_SHOW_HELP_H
|
|
#define OPAL_SHOW_HELP_H
|
|
|
|
#include "opal_config.h"
|
|
|
|
#include <stdarg.h>
|
|
|
|
BEGIN_C_DECLS
|
|
|
|
/**
|
|
* \internal
|
|
*
|
|
* Initialization of show_help subsystem
|
|
*/
|
|
OPAL_DECLSPEC int opal_show_help_init(void);
|
|
|
|
|
|
/**
|
|
* \internal
|
|
*
|
|
* Finalization of show_help subsystem
|
|
*/
|
|
OPAL_DECLSPEC int opal_show_help_finalize(void);
|
|
|
|
|
|
/**
|
|
* Look up a text message in a text file and display it to the
|
|
* stderr using printf()-like substitutions (%d, %s, etc.).
|
|
*
|
|
* @param filename File where the text messages are contained.
|
|
* @param topic String index of which message to display from the
|
|
* text file.
|
|
* @param want_error_header Display error-bar line header and
|
|
* footer with the message.
|
|
* @param varargs Any additional parameters are substituted,
|
|
* printf()-style into the help message that is displayed.
|
|
*
|
|
* This function looks for the filename in the $pkgdatadir
|
|
* (typically $prefix/share/openmpi), and looks up the message
|
|
* based on the topic, and displays it. If want_error_header is
|
|
* true, a header and footer of asterisks are also displayed.
|
|
*/
|
|
OPAL_DECLSPEC int opal_show_help(const char *filename, const char *topic,
|
|
bool want_error_header, ...);
|
|
|
|
/**
|
|
* This function does the same thing as opal_show_help(), but accepts
|
|
* a va_list form of varargs.
|
|
*/
|
|
OPAL_DECLSPEC int opal_show_vhelp(const char *filename, const char *topic,
|
|
bool want_error_header, va_list ap);
|
|
|
|
/**
|
|
* This function does the same thing as opal_show_help(), but returns
|
|
* its output in a string (that must be freed by the caller).
|
|
*/
|
|
OPAL_DECLSPEC char* opal_show_help_string(const char *filename,
|
|
const char *topic,
|
|
bool want_error_header, ...);
|
|
|
|
/**
|
|
* This function does the same thing as opal_show_help_string(), but
|
|
* accepts a va_list form of varargs.
|
|
*/
|
|
OPAL_DECLSPEC char* opal_show_help_vstring(const char *filename,
|
|
const char *topic,
|
|
bool want_error_header, va_list ap);
|
|
|
|
/**
|
|
* \internal
|
|
*
|
|
* Internal function to help clean up the flex parser.
|
|
*
|
|
* This function is called internally by the SHS to shut down the
|
|
* flex parser since we may not hit the <<EOF>> rule and call this
|
|
* function automatically.
|
|
*/
|
|
OPAL_DECLSPEC int opal_show_help_finish_parsing(void);
|
|
|
|
END_C_DECLS
|
|
|
|
#endif
|