1
1
openmpi/opal/util/stacktrace.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

59 строки
1.8 KiB
C

/*
* Copyright (c) 2004-2007 The Trustees of Indiana University and Indiana
* University Research and Technology
* Corporation. All rights reserved.
* Copyright (c) 2004-2008 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 (c) 2017 IBM Corporation. All rights reserved.
* $COPYRIGHT$
*
* Additional copyrights may follow
*
* $HEADER$
*
* @file
*/
#ifndef OPAL_STACKTRACE_H
#define OPAL_STACKTRACE_H
#include "opal_config.h"
/*
* File descriptor to be used by the backtrace framework if opal_backtrace_print
* is passed NULL for it's FILE file pointer.
*/
extern int opal_stacktrace_output_fileno;
/**
* Output the current stack trace (not including the call to this
* function) to the stream indicated.
*/
OPAL_DECLSPEC void opal_stackframe_output(int stream);
/**
* Return the current stack trace (not including the call to this
* function) as a string (which must be freed by the caller).
*/
OPAL_DECLSPEC char *opal_stackframe_output_string(void);
/**
* Here we register the opal_show_stackframe function for signals
* passed to OpenMPI by the mpi_signal-parameter passed to mpirun
* by the user.
*
* @returnvalue OPAL_SUCCESS
* @returnvalue OPAL_ERR_BAD_PARAM if the value in the signal-list
* is not a valid signal-number
*
*/
OPAL_DECLSPEC int opal_util_register_stackhandlers (void);
#endif /* OPAL_STACKTRACE_H */