1
1
openmpi/orte/util/show_help.h
Jeff Squyres f1a7b5cc33 Make "processor affinity not supported" error message a little better:
* Remove OPAL_ERR_PAFFINITY_NOT_SUPPORTED; fit it into the generic
   OPAL_ERR_NOT_SUPPORTED case.
 * When odls_default detects that processor affinity is not supported,
   it prints a specific message about it, and then it suppressed a
   generic HNP help message that would normally follow it (i.e., it's
   easier to have the "processor affinity is not supported" show_help
   message last).
 * Use some symbolic names in odls_default instead of fixed int's,
   just for slight readability improvements in the code.
 * Introduce orte_show_help_suppress(), which gives the ability to
   suppress any future showings of any arbitrary show_help() message.
   This is useful if you display message X and want to suppress
   message Y.  This suppression *only* works in environments where
   orte_show_help() does coalescing.

This commit was SVN r23249.
2010-06-08 20:16:07 +00:00

96 строки
2.8 KiB
C

/*
* Copyright (c) 2004-2008 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-2010 Cisco Systems, Inc. All rights reserved.
* $COPYRIGHT$
*
* Additional copyrights may follow
*
* $HEADER$
*/
/** @file:
*
* Populates global structure with system-specific information.
*
* Notes: add limits.h, compute size of integer and other types via sizeof(type)*CHAR_BIT
*
*/
#ifndef _ORTE_SHOW_HELP_H_
#define _ORTE_SHOW_HELP_H_
#include "orte_config.h"
#include "orte/types.h"
#include "orte/mca/rml/rml_types.h"
BEGIN_C_DECLS
/**
* Initializes the output stream system and opens a default
* "verbose" stream.
*
* @retval success Upon success.
* @retval error Upon failure.
*
* This should be the first function invoked in the output
* subsystem. After this call, the default "verbose" stream is open
* and can be written to via calls to orte_output_verbose() and
* orte_output_error().
*
* By definition, the default verbose stream has a handle ID of 0,
* and has a verbose level of 0.
*/
ORTE_DECLSPEC int orte_show_help_init(void);
/**
* Shut down the output stream system.
*
* Shut down the output stream system, including the default verbose
* stream.
*/
ORTE_DECLSPEC void orte_show_help_finalize(void);
/**
* Show help.
*
* Sends show help messages to the HNP if on a backend node. Note
* that aggregation is not currently supported on HNP-less systems
* (e.g., cray).
*/
ORTE_DECLSPEC int orte_show_help(const char *filename, const char *topic,
bool want_error_header, ...);
/**
* Pretend that this message has already been shown.
*
* Sends a control message to the HNP that will effecitvely suppress
* this message from being shown. Primitive *-wildcarding is
* possible.
*
* Not currently supported on HNP-less systems (e.g., cray).
*/
ORTE_DECLSPEC int orte_show_help_suppress(const char *filename,
const char *topic);
#if !ORTE_DISABLE_FULL_SUPPORT
ORTE_DECLSPEC void orte_show_help_recv(int status, orte_process_name_t* sender,
opal_buffer_t *buffer, orte_rml_tag_t tag,
void* cbdata);
#endif /* ORTE_DISABLE_FULL_SUPPORT */
END_C_DECLS
#endif