ports/openmpi
ports/openmpi
1
1
Форкнуть 0
Код Релизы Активность
2aec094d56
openmpi/ompi/mca/crcp/crcp.h
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

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

/*
* Copyright (c) 2004-2008 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$
*/
/**
* @file
*
* Checkpoint/Restart Coordination Protocol (CRCP) Interface
*
*/
#ifndef MCA_CRCP_H
#define MCA_CRCP_H
#include "ompi_config.h"
#include "opal/mca/mca.h"
#include "opal/mca/base/base.h"
#include "opal/mca/crs/crs.h"
#include "opal/mca/crs/base/base.h"
#include "opal/class/opal_object.h"
#include "ompi/datatype/datatype.h"
#include "ompi/request/request.h"
#include "ompi/class/ompi_free_list.h"
#include "ompi/mca/pml/pml.h"
#include "ompi/mca/pml/base/base.h"
#include "ompi/mca/btl/btl.h"
#include "ompi/mca/btl/base/base.h"
#if defined(c_plusplus) || defined(__cplusplus)
extern "C" {
#endif
/**
* Module initialization function.
* Returns OMPI_SUCCESS
*/
typedef int (*ompi_crcp_base_module_init_fn_t)
(void);
/**
* Module finalization function.
* Returns OMPI_SUCCESS
*/
typedef int (*ompi_crcp_base_module_finalize_fn_t)
(void);
/************************
* PML Wrapper hooks
* PML Wrapper is the CRCPW PML component
************************/
/**
* To allow us to work before and after a PML command
*/
enum ompi_crcp_base_pml_states_t {
OMPI_CRCP_PML_PRE,
OMPI_CRCP_PML_POST,
OMPI_CRCP_PML_SKIP,
OMPI_CRCP_PML_DONE
};
typedef enum ompi_crcp_base_pml_states_t ompi_crcp_base_pml_states_t;
OMPI_DECLSPEC struct ompi_crcp_base_pml_state_t {
ompi_free_list_item_t super;
ompi_crcp_base_pml_states_t state;
int error_code;
mca_pml_base_component_t *wrapped_pml_component;
mca_pml_base_module_t *wrapped_pml_module;
};
typedef struct ompi_crcp_base_pml_state_t ompi_crcp_base_pml_state_t;
OMPI_DECLSPEC OBJ_CLASS_DECLARATION(ompi_crcp_base_pml_state_t);
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_enable_fn_t)
(bool enable, ompi_crcp_base_pml_state_t* );
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_add_comm_fn_t)
( struct ompi_communicator_t* comm , ompi_crcp_base_pml_state_t*);
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_del_comm_fn_t)
( struct ompi_communicator_t* comm , ompi_crcp_base_pml_state_t*);
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_add_procs_fn_t)
( struct ompi_proc_t **procs, size_t nprocs , ompi_crcp_base_pml_state_t*);
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_del_procs_fn_t)
( struct ompi_proc_t **procs, size_t nprocs , ompi_crcp_base_pml_state_t*);
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_progress_fn_t)
(ompi_crcp_base_pml_state_t*);
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_iprobe_fn_t)
(int dst, int tag, struct ompi_communicator_t* comm, int *matched,
ompi_status_public_t* status, ompi_crcp_base_pml_state_t* );
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_probe_fn_t)
( int dst, int tag, struct ompi_communicator_t* comm,
ompi_status_public_t* status, ompi_crcp_base_pml_state_t* );
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_isend_init_fn_t)
( void *buf, size_t count, ompi_datatype_t *datatype, int dst, int tag,
mca_pml_base_send_mode_t mode, struct ompi_communicator_t* comm,
struct ompi_request_t **request, ompi_crcp_base_pml_state_t* );
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_isend_fn_t)
( void *buf, size_t count, ompi_datatype_t *datatype, int dst, int tag,
mca_pml_base_send_mode_t mode, struct ompi_communicator_t* comm,
struct ompi_request_t **request, ompi_crcp_base_pml_state_t* );
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_send_fn_t)
( void *buf, size_t count, ompi_datatype_t *datatype, int dst, int tag,
mca_pml_base_send_mode_t mode, struct ompi_communicator_t* comm,
ompi_crcp_base_pml_state_t* );
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_irecv_init_fn_t)
( void *buf, size_t count, ompi_datatype_t *datatype, int src, int tag,
struct ompi_communicator_t* comm, struct ompi_request_t **request,
ompi_crcp_base_pml_state_t*);
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_irecv_fn_t)
( void *buf, size_t count, ompi_datatype_t *datatype, int src, int tag,
struct ompi_communicator_t* comm, struct ompi_request_t **request,
ompi_crcp_base_pml_state_t* );
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_recv_fn_t)
( void *buf, size_t count, ompi_datatype_t *datatype, int src, int tag,
struct ompi_communicator_t* comm, ompi_status_public_t* status,
ompi_crcp_base_pml_state_t*);
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_dump_fn_t)
( struct ompi_communicator_t* comm, int verbose, ompi_crcp_base_pml_state_t* );
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_start_fn_t)
( size_t count, ompi_request_t** requests, ompi_crcp_base_pml_state_t* );
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_ft_event_fn_t)
(int state, ompi_crcp_base_pml_state_t*);
/* Request Interface */
typedef int (*ompi_crcp_base_request_complete_fn_t)
(struct ompi_request_t *request);
/************************
* BTL Wrapper hooks
* JJH: Wrapper BTL not currently implemented.
************************/
/**
* To allow us to work before and after a BTL command
*/
enum ompi_crcp_base_btl_states_t {
OMPI_CRCP_BTL_PRE,
OMPI_CRCP_BTL_POST,
OMPI_CRCP_BTL_SKIP,
OMPI_CRCP_BTL_DONE
};
typedef enum ompi_crcp_base_btl_states_t ompi_crcp_base_btl_states_t;
struct ompi_crcp_base_btl_state_t {
ompi_free_list_item_t super;
ompi_crcp_base_btl_states_t state;
int error_code;
mca_btl_base_descriptor_t* des;
mca_btl_base_component_t *wrapped_btl_component;
mca_btl_base_module_t *wrapped_btl_module;
};
typedef struct ompi_crcp_base_btl_state_t ompi_crcp_base_btl_state_t;
OBJ_CLASS_DECLARATION(ompi_crcp_base_btl_state_t);
typedef ompi_crcp_base_btl_state_t* (*mca_crcp_base_btl_module_add_procs_fn_t)
( struct mca_btl_base_module_t* btl,
size_t nprocs,
struct ompi_proc_t** procs,
struct mca_btl_base_endpoint_t** endpoints,
struct ompi_bitmap_t* reachable,
ompi_crcp_base_btl_state_t* );
typedef ompi_crcp_base_btl_state_t* (*mca_crcp_base_btl_module_del_procs_fn_t)
( struct mca_btl_base_module_t* btl,
size_t nprocs,
struct ompi_proc_t** procs,
struct mca_btl_base_endpoint_t**,
ompi_crcp_base_btl_state_t*);
typedef ompi_crcp_base_btl_state_t* (*mca_crcp_base_btl_module_register_fn_t)
( struct mca_btl_base_module_t* btl,
mca_btl_base_tag_t tag,
mca_btl_base_module_recv_cb_fn_t cbfunc,
void* cbdata,
ompi_crcp_base_btl_state_t*);
typedef ompi_crcp_base_btl_state_t* (*mca_crcp_base_btl_module_finalize_fn_t)
( struct mca_btl_base_module_t* btl,
ompi_crcp_base_btl_state_t*);
typedef ompi_crcp_base_btl_state_t* (*mca_crcp_base_btl_module_alloc_fn_t)
( struct mca_btl_base_module_t* btl,
size_t size,
ompi_crcp_base_btl_state_t*);
typedef ompi_crcp_base_btl_state_t* (*mca_crcp_base_btl_module_free_fn_t)
( struct mca_btl_base_module_t* btl,
mca_btl_base_descriptor_t* descriptor,
ompi_crcp_base_btl_state_t*);
typedef ompi_crcp_base_btl_state_t* (*mca_crcp_base_btl_module_prepare_fn_t)
( struct mca_btl_base_module_t* btl,
struct mca_btl_base_endpoint_t* endpoint,
mca_mpool_base_registration_t* registration,
struct ompi_convertor_t* convertor,
size_t reserve,
size_t* size,
ompi_crcp_base_btl_state_t*);
typedef ompi_crcp_base_btl_state_t* (*mca_crcp_base_btl_module_send_fn_t)
( struct mca_btl_base_module_t* btl,
struct mca_btl_base_endpoint_t* endpoint,
struct mca_btl_base_descriptor_t* descriptor,
mca_btl_base_tag_t tag,
ompi_crcp_base_btl_state_t*);
typedef ompi_crcp_base_btl_state_t* (*mca_crcp_base_btl_module_put_fn_t)
( struct mca_btl_base_module_t* btl,
struct mca_btl_base_endpoint_t* endpoint,
struct mca_btl_base_descriptor_t* descriptor,
ompi_crcp_base_btl_state_t*);
typedef ompi_crcp_base_btl_state_t* (*mca_crcp_base_btl_module_get_fn_t)
( struct mca_btl_base_module_t* btl,
struct mca_btl_base_endpoint_t* endpoint,
struct mca_btl_base_descriptor_t* descriptor,
ompi_crcp_base_btl_state_t*);
typedef ompi_crcp_base_btl_state_t* (*mca_crcp_base_btl_module_dump_fn_t)
( struct mca_btl_base_module_t* btl,
struct mca_btl_base_endpoint_t* endpoint,
int verbose,
ompi_crcp_base_btl_state_t*);
typedef ompi_crcp_base_btl_state_t* (*mca_crcp_base_btl_module_ft_event_fn_t)
(int state,
ompi_crcp_base_btl_state_t*);
/**
* Structure for CRCP v1.0.0 components.
*/
struct ompi_crcp_base_component_1_0_0_t {
/** MCA base component */
mca_base_component_t base_version;
/** MCA base data */
mca_base_component_data_1_0_0_t base_data;
/** Verbosity Level */
int verbose;
/** Output Handle for orte_output */
int output_handle;
/** Default Priority */
int priority;
};
typedef struct ompi_crcp_base_component_1_0_0_t ompi_crcp_base_component_1_0_0_t;
typedef struct ompi_crcp_base_component_1_0_0_t ompi_crcp_base_component_t;
/**
* Structure for CRCP v1.0.0 modules
*/
struct ompi_crcp_base_module_1_0_0_t {
/** Initialization Function */
ompi_crcp_base_module_init_fn_t crcp_init;
/** Finalization Function */
ompi_crcp_base_module_finalize_fn_t crcp_finalize;
/**< PML Wrapper Functions ****************************/
ompi_crcp_base_pml_enable_fn_t pml_enable;
ompi_crcp_base_pml_add_comm_fn_t pml_add_comm;
ompi_crcp_base_pml_del_comm_fn_t pml_del_comm;
ompi_crcp_base_pml_add_procs_fn_t pml_add_procs;
ompi_crcp_base_pml_del_procs_fn_t pml_del_procs;
ompi_crcp_base_pml_progress_fn_t pml_progress;
ompi_crcp_base_pml_iprobe_fn_t pml_iprobe;
ompi_crcp_base_pml_probe_fn_t pml_probe;
ompi_crcp_base_pml_isend_init_fn_t pml_isend_init;
ompi_crcp_base_pml_isend_fn_t pml_isend;
ompi_crcp_base_pml_send_fn_t pml_send;
ompi_crcp_base_pml_irecv_init_fn_t pml_irecv_init;
ompi_crcp_base_pml_irecv_fn_t pml_irecv;
ompi_crcp_base_pml_recv_fn_t pml_recv;
ompi_crcp_base_pml_dump_fn_t pml_dump;
ompi_crcp_base_pml_start_fn_t pml_start;
ompi_crcp_base_pml_ft_event_fn_t pml_ft_event;
/**< Request complete Function ****************************/
ompi_crcp_base_request_complete_fn_t request_complete;
/**< BTL Wrapper Functions ****************************/
mca_crcp_base_btl_module_add_procs_fn_t btl_add_procs;
mca_crcp_base_btl_module_del_procs_fn_t btl_del_procs;
mca_crcp_base_btl_module_register_fn_t btl_register;
mca_crcp_base_btl_module_finalize_fn_t btl_finalize;
mca_crcp_base_btl_module_alloc_fn_t btl_alloc;
mca_crcp_base_btl_module_free_fn_t btl_free;
mca_crcp_base_btl_module_prepare_fn_t btl_prepare_src;
mca_crcp_base_btl_module_prepare_fn_t btl_prepare_dst;
mca_crcp_base_btl_module_send_fn_t btl_send;
mca_crcp_base_btl_module_put_fn_t btl_put;
mca_crcp_base_btl_module_get_fn_t btl_get;
mca_crcp_base_btl_module_dump_fn_t btl_dump;
mca_crcp_base_btl_module_ft_event_fn_t btl_ft_event;
};
typedef struct ompi_crcp_base_module_1_0_0_t ompi_crcp_base_module_1_0_0_t;
typedef struct ompi_crcp_base_module_1_0_0_t ompi_crcp_base_module_t;
OMPI_DECLSPEC extern ompi_crcp_base_module_t ompi_crcp;
/**
* Macro for use in components that are of type CRCP v1.0.0
*/
#define OMPI_CRCP_BASE_VERSION_1_0_0 \
/* CRCP v1.0 is chained to MCA v1.0 */ \
MCA_BASE_VERSION_1_0_0, \
/* CRCP v1.0 */ \
"crcp", 1, 0, 0
/**
* Macro to call the CRCP Request Complete function
*/
#if OPAL_ENABLE_FT == 1
#define OMPI_CRCP_REQUEST_COMPLETE(req) \
if( NULL != ompi_crcp.request_complete) { \
ompi_crcp.request_complete(req); \
}
#else
#define OMPI_CRCP_REQUEST_COMPLETE(req) ;
#endif
#if defined(c_plusplus) || defined(__cplusplus)
}
#endif
#endif /* OMPI_CRCP_H */
Показать git blame Копировать постоянную ссылку