2007-05-17 08:41:01 +00:00
/*
* 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 ( c ) 2006 - 2007 Voltaire All rights reserved .
2009-01-11 02:30:00 +00:00
* Copyright ( c ) 2007 Cisco Systems , Inc . All rights reserved .
2010-07-13 11:30:43 +00:00
* Copyright ( c ) 2010 Oracle and / or its affiliates . All rights reserved .
2007-05-17 08:41:01 +00:00
*
* $ COPYRIGHT $
*
* Additional copyrights may follow
*
* $ HEADER $
*/
# include "ompi_config.h"
# include <stdio.h>
2009-02-14 02:26:12 +00:00
# include "opal/util/output.h"
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
2007-05-17 08:41:01 +00:00
# include "ompi/mca/btl/btl.h"
# include "ompi/mca/btl/base/base.h"
int mca_btl_base_param_register ( mca_base_component_t * version ,
2012-05-21 13:15:24 +00:00
mca_btl_base_module_t * module )
2007-05-17 08:41:01 +00:00
{
2007-06-20 16:37:50 +00:00
char * msg ;
2013-03-27 21:09:41 +00:00
/* If this is ever triggered change the uint32_ts in mca_btl_base_module_t to unsigned ints */
assert ( sizeof ( unsigned int ) = = sizeof ( uint32_t ) ) ;
2007-05-17 08:41:01 +00:00
2013-03-27 21:09:41 +00:00
( void ) mca_base_component_var_register ( version , " exclusivity " ,
" BTL exclusivity (must be >= 0) " ,
MCA_BASE_VAR_TYPE_UNSIGNED_INT , NULL , 0 , 0 ,
2013-07-10 00:47:52 +00:00
OPAL_INFO_LVL_7 ,
2013-03-27 21:09:41 +00:00
MCA_BASE_VAR_SCOPE_READONLY ,
& module - > btl_exclusivity ) ;
2007-05-17 08:41:01 +00:00
2010-07-13 11:30:43 +00:00
asprintf ( & msg , " BTL bit flags (general flags: SEND=%d, PUT=%d, GET=%d, SEND_INPLACE=%d, RDMA_MATCHED=%d, HETEROGENEOUS_RDMA=%d; flags only used by the \" dr \" PML (ignored by others): ACK=%d, CHECKSUM=%d, RDMA_COMPLETION=%d; flags only used by the \" bfo \" PML (ignored by others): FAILOVER_SUPPORT=%d) " ,
2007-06-20 16:37:50 +00:00
MCA_BTL_FLAGS_SEND ,
MCA_BTL_FLAGS_PUT ,
MCA_BTL_FLAGS_GET ,
MCA_BTL_FLAGS_SEND_INPLACE ,
2008-11-05 00:00:55 +00:00
MCA_BTL_FLAGS_RDMA_MATCHED ,
MCA_BTL_FLAGS_HETEROGENEOUS_RDMA ,
2007-06-20 16:37:50 +00:00
MCA_BTL_FLAGS_NEED_ACK ,
MCA_BTL_FLAGS_NEED_CSUM ,
2010-07-13 11:30:43 +00:00
MCA_BTL_FLAGS_RDMA_COMPLETION ,
MCA_BTL_FLAGS_FAILOVER_SUPPORT ) ;
2013-03-27 21:09:41 +00:00
( void ) mca_base_component_var_register ( version , " flags " , msg ,
MCA_BASE_VAR_TYPE_UNSIGNED_INT , NULL , 0 , 0 ,
2013-07-10 00:47:52 +00:00
OPAL_INFO_LVL_5 ,
2013-03-27 21:09:41 +00:00
MCA_BASE_VAR_SCOPE_READONLY ,
& module - > btl_flags ) ;
2007-06-20 16:37:50 +00:00
free ( msg ) ;
2007-05-17 08:41:01 +00:00
2013-03-27 21:09:41 +00:00
( void ) mca_base_component_var_register ( version , " rndv_eager_limit " , " Size (in bytes, including header) of \" phase 1 \" fragment sent for all large messages (must be >= 0 and <= eager_limit) " ,
MCA_BASE_VAR_TYPE_SIZE_T , NULL , 0 , 0 ,
2013-07-10 00:47:52 +00:00
OPAL_INFO_LVL_4 ,
2013-03-27 21:09:41 +00:00
MCA_BASE_VAR_SCOPE_READONLY ,
& module - > btl_rndv_eager_limit ) ;
( void ) mca_base_component_var_register ( version , " eager_limit " , " Maximum size (in bytes, including header) of \" short \" messages (must be >= 1). " ,
MCA_BASE_VAR_TYPE_SIZE_T , NULL , 0 , 0 ,
2013-07-10 00:47:52 +00:00
OPAL_INFO_LVL_4 ,
2013-03-27 21:09:41 +00:00
MCA_BASE_VAR_SCOPE_READONLY ,
& module - > btl_eager_limit ) ;
( void ) mca_base_component_var_register ( version , " max_send_size " , " Maximum size (in bytes) of a single \" phase 2 \" fragment of a long message when using the pipeline protocol (must be >= 1) " ,
MCA_BASE_VAR_TYPE_SIZE_T , NULL , 0 , 0 ,
2013-07-10 00:47:52 +00:00
OPAL_INFO_LVL_4 ,
2013-03-27 21:09:41 +00:00
MCA_BASE_VAR_SCOPE_READONLY ,
& module - > btl_max_send_size ) ;
if ( NULL ! = module - > btl_put ) {
( void ) mca_base_component_var_register ( version , " rdma_pipeline_send_length " , " Length of the \" phase 2 \" portion of a large message (in bytes) when using the pipeline protocol. This part of the message will be split into fragments of size max_send_size and sent using send/receive semantics (must be >= 0; only relevant when the PUT flag is set) " ,
MCA_BASE_VAR_TYPE_SIZE_T , NULL , 0 , 0 ,
2013-07-10 00:47:52 +00:00
OPAL_INFO_LVL_4 ,
2013-03-27 21:09:41 +00:00
MCA_BASE_VAR_SCOPE_READONLY ,
& module - > btl_rdma_pipeline_send_length ) ;
( void ) mca_base_component_var_register ( version , " rdma_pipeline_frag_size " , " Maximum size (in bytes) of a single \" phase 3 \" fragment from a long message when using the pipeline protocol. These fragments will be sent using RDMA semantics (must be >= 1; only relevant when the PUT flag is set) " ,
MCA_BASE_VAR_TYPE_SIZE_T , NULL , 0 , 0 ,
2013-07-10 00:47:52 +00:00
OPAL_INFO_LVL_4 ,
2013-03-27 21:09:41 +00:00
MCA_BASE_VAR_SCOPE_READONLY ,
& module - > btl_rdma_pipeline_frag_size ) ;
( void ) mca_base_component_var_register ( version , " min_rdma_pipeline_size " , " Messages smaller than this size (in bytes) will not use the RDMA pipeline protocol. Instead, they will be split into fragments of max_send_size and sent using send/receive semantics (must be >=0, and is automatically adjusted up to at least (eager_limit+btl_rdma_pipeline_send_length); only relevant when the PUT flag is set) " ,
MCA_BASE_VAR_TYPE_SIZE_T , NULL , 0 , 0 ,
2013-07-10 00:47:52 +00:00
OPAL_INFO_LVL_4 ,
2013-03-27 21:09:41 +00:00
MCA_BASE_VAR_SCOPE_READONLY ,
& module - > btl_min_rdma_pipeline_size ) ;
( void ) mca_base_component_var_register ( version , " bandwidth " , " Approximate maximum bandwidth of interconnect (0 = auto-detect value at run-time [not supported in all BTL modules], >= 1 = bandwidth in Mbps) " ,
MCA_BASE_VAR_TYPE_UNSIGNED_INT , NULL , 0 , 0 ,
2013-07-10 00:47:52 +00:00
OPAL_INFO_LVL_5 ,
2013-03-27 21:09:41 +00:00
MCA_BASE_VAR_SCOPE_READONLY ,
& module - > btl_latency ) ;
2007-05-17 08:41:01 +00:00
}
2013-03-27 21:09:41 +00:00
return mca_btl_base_param_verify ( module ) ;
}
/* Verify btl parameters make sense */
int mca_btl_base_param_verify ( mca_btl_base_module_t * module )
{
if ( module - > btl_min_rdma_pipeline_size <
( module - > btl_eager_limit + module - > btl_rdma_pipeline_send_length ) ) {
module - > btl_min_rdma_pipeline_size =
module - > btl_eager_limit + module - > btl_rdma_pipeline_send_length ;
}
2007-05-17 08:41:01 +00:00
2013-03-27 21:09:41 +00:00
if ( NULL = = module - > btl_put ) {
module - > btl_flags & = ~ MCA_BTL_FLAGS_PUT ;
}
if ( NULL = = module - > btl_get ) {
module - > btl_flags & = ~ MCA_BTL_FLAGS_GET ;
}
2007-05-17 08:41:01 +00:00
2013-03-27 21:09:41 +00:00
return OMPI_SUCCESS ;
2007-05-17 08:41:01 +00:00
}
