xref: /minix/lib/libexecinfo/unwind.h (revision 0a6a1f1d)
1 /*	$NetBSD: unwind.h,v 1.3 2014/10/22 16:30:21 christos Exp $	*/
2 
3 /*-
4  * Copyright (c) 2012 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
17  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
18  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
20  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  * POSSIBILITY OF SUCH DAMAGE.
27  */
28 #ifndef _UNWIND_H_
29 #define _UNWIND_H_
30 
31 #include <sys/cdefs.h>
32 
33 __BEGIN_DECLS
34 struct _Unwind_Context;
35 struct _Unwind_Exception;
36 typedef int _Unwind_Reason_Code;
37 typedef void *_Unwind_Ptr;
38 typedef long _Unwind_Word;
39 
40 #define	_URC_NO_REASON			0
41 #define	_URC_FOREIGN_EXCEPTION_CAUGHT	1
42 #define	_URC_FATAL_PHASE2_ERROR		2
43 #define	_URC_FATAL_PHASE1_ERROR		3
44 #define	_URC_NORMAL_STOP		4
45 #define	_URC_END_OF_STACK		5
46 #define	_URC_HANDLER_FOUND		6
47 #define	_URC_INSTALL_CONTEXT		7
48 #define	_URC_CONTINUE_UNWIND		8
49 
50 typedef _Unwind_Reason_Code
51     (*_Unwind_Trace_Fn)(struct _Unwind_Context *, void *);
52 #ifdef notyet
53 typedef _Unwind_Reason_Code
54     (*_Unwind_Stop_Fn)(struct _Unwind_Context *, void *);
55 #endif
56 
57 _Unwind_Reason_Code	 _Unwind_Backtrace(_Unwind_Trace_Fn, void *);
58 void 			 _Unwind_DeleteException(struct _Unwind_Exception *);
59 void 	       		*_Unwind_FindEnclosingFunction(void *);
60 #ifdef notyet
61 _Unwind_Reason_Code 	 _Unwind_ForcedUnwind(struct _Unwind_Exception *,
62     _Unwind_Stop_fn, void *);
63 #endif
64 _Unwind_Word		 _Unwind_GetCFA(struct _Unwind_Context *);
65 _Unwind_Ptr		 _Unwind_GetDataRelBase(struct _Unwind_Context *);
66 _Unwind_Word 		 _Unwind_GetGR(struct _Unwind_Context *, int);
67 _Unwind_Ptr		 _Unwind_GetIP(struct _Unwind_Context *);
68 _Unwind_Ptr		 _Unwind_GetIPInfo(struct _Unwind_Context *, int *);
69 _Unwind_Ptr		 _Unwind_GetLanguageSpecificData(
70     struct _Unwind_Context *);
71 _Unwind_Ptr		 _Unwind_GetRegionStart(struct _Unwind_Context *);
72 _Unwind_Ptr		 _Unwind_GetTextRelBase(struct _Unwind_Context *);
73 _Unwind_Reason_Code	 _Unwind_RaiseException(struct _Unwind_Exception *);
74 void			 _Unwind_Resume(struct _Unwind_Exception *);
75 _Unwind_Reason_Code	 _Unwind_Resume_or_Rethrow(struct _Unwind_Exception *);
76 void			 _Unwind_SetGR(struct _Unwind_Context *, int,
77     _Unwind_Ptr);
78 void			 _Unwind_SetIP(struct _Unwind_Context *, _Unwind_Ptr);
79 __END_DECLS
80 #endif /* _UNWIND_H_ */
81