OpenMPI  0.1.1
stacktrace.h
1 /*
2  * Copyright (c) 2004-2007 The Trustees of Indiana University and Indiana
3  * University Research and Technology
4  * Corporation. All rights reserved.
5  * Copyright (c) 2004-2008 The University of Tennessee and The University
6  * of Tennessee Research Foundation. All rights
7  * reserved.
8  * Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
9  * University of Stuttgart. All rights reserved.
10  * Copyright (c) 2004-2005 The Regents of the University of California.
11  * All rights reserved.
12  * Copyright (c) 2008 Cisco Systems, Inc. All rights reserved.
13  * $COPYRIGHT$
14  *
15  * Additional copyrights may follow
16  *
17  * $HEADER$
18  *
19  * @file
20  */
21 
22 #ifndef OPAL_STACKTRACE_H
23 #define OPAL_STACKTRACE_H
24 
25 #include "opal_config.h"
26 
27 /**
28  * Output the current stack trace (not including the call to this
29  * function) to the stream indicated.
30  */
31 OPAL_DECLSPEC void opal_stackframe_output(int stream);
32 
33 /**
34  * Return the current stack trace (not including the call to this
35  * function) as a string (which must be freed by the caller).
36  */
37 OPAL_DECLSPEC char *opal_stackframe_output_string(void);
38 
39 /**
40  * Here we register the opal_show_stackframe function for signals
41  * passed to OpenMPI by the mpi_signal-parameter passed to mpirun
42  * by the user.
43  *
44  * @returnvalue OPAL_SUCCESS
45  * @returnvalue OPAL_ERR_BAD_PARAM if the value in the signal-list
46  * is not a valid signal-number
47  *
48  */
49 OPAL_DECLSPEC int opal_util_register_stackhandlers (void);
50 
51 #endif /* OPAL_STACKTRACE_H */