1
1
openmpi/opal/mca/backtrace/backtrace.h
Joshua Hursey 6d98559be9 stacktrace: Add flexibility in stacktrace ouptut
- New MCA option: opal_stacktrace_output
   - Specifies where the stack trace output stream goes.
   - Accepts: none, stdout, stderr, file[:filename]
   - Default filename 'stacktrace'
     - Filename will be `stacktrace.PID`, or if VPID is available,
       then the filename will be `stacktrace.VPID.PID`
 - Update util/stacktrace to allow for different output avenues
   including files. Previously this was hardcoded to 'stderr'.
 - Since opal_backtrace_print needs to be signal safe, passing it a
   FILE object that actually represents a file stream is difficult. This
   is because we cannot open the file in the signal handler using
   `fopen` (not safe), but have to use `open` (safe). Additionally, we
   cannot use `fdopen` to convert the `int fd` to a `FILE *fh` since it
   is also not signal safe.
   - I did not want to break the backtrace.h API so I introduced a new
     rule (documented in `backtrace.c`) that if the `FILE *file`
     argument is `NULL` then look for the `opal_stacktrace_output_fileno`
     variable to tell you which file descriptor to use for output.

Signed-off-by: Joshua Hursey <jhursey@us.ibm.com>
2017-01-26 11:55:32 -06:00

84 строки
2.5 KiB
C

/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
/*
* 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-2006 The Regents of the University of California.
* All rights reserved.
* Copyright (c) 2015 Los Alamos National Security, LLC. All rights
* reserved.
* Copyright (c) 2017 IBM Corporation. All rights reserved.
* $COPYRIGHT$
*
* Additional copyrights may follow
*
* $HEADER$
*/
#ifndef OPAL_MCA_BACKTRACE_BACKTRACE_H
#define OPAL_MCA_BACKTRACE_BACKTRACE_H
#include "opal_config.h"
#include "opal/mca/mca.h"
#include "opal/mca/base/base.h"
#include "opal/util/stacktrace.h"
BEGIN_C_DECLS
/*
* Most of this file is just for ompi_info. There are two interface
* functions, both of which are called directly. The joy of link-time
* components.
*/
/*
* Print back trace to FILE file with a prefix for each line.
* First strip lines are not printed.
* If 'file' is NULL then the component should try to use the file descriptor
* saved in opal_stacktrace_output_fileno
*
* \note some attempts made to be signal safe.
*/
OPAL_DECLSPEC int opal_backtrace_print(FILE *file, char *prefix, int strip);
/*
* Return back trace in buffer. buffer will be allocated by the
* backtrace component, but should be free'ed by the caller.
*
* \note Probably bad to call this from a signal handler.
*
*/
OPAL_DECLSPEC int opal_backtrace_buffer(char*** messages, int *len);
/**
* Structure for backtrace components.
*/
struct opal_backtrace_base_component_2_0_0_t {
/** MCA base component */
mca_base_component_t backtracec_version;
/** MCA base data */
mca_base_component_data_t backtracec_data;
};
/**
* Convenience typedef
*/
typedef struct opal_backtrace_base_component_2_0_0_t opal_backtrace_base_component_2_0_0_t;
/*
* Macro for use in components that are of type backtrace
*/
#define OPAL_BACKTRACE_BASE_VERSION_2_0_0 \
OPAL_MCA_BASE_VERSION_2_1_0("backtrace", 2, 0, 0)
END_C_DECLS
#endif /* OPAL_MCA_BACKTRACE_BACKTRACE_H */