xref: /freebsd/sys/sys/stack.h (revision 19261079)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2005 Antoine Brodin
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 AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30 
31 #ifndef _SYS_STACK_H_
32 #define	_SYS_STACK_H_
33 
34 #include <sys/_stack.h>
35 
36 #ifdef _SYS_MALLOC_H_
37 MALLOC_DECLARE(M_STACK);
38 #endif
39 
40 struct sbuf;
41 
42 enum stack_sbuf_fmt {
43 	STACK_SBUF_FMT_NONE	= 0,
44 	STACK_SBUF_FMT_LONG	= 1,
45 	STACK_SBUF_FMT_COMPACT	= 2,
46 };
47 
48 /* MI Routines. */
49 struct stack	*stack_create(int);
50 void		 stack_destroy(struct stack *);
51 int		 stack_put(struct stack *, vm_offset_t);
52 void		 stack_copy(const struct stack *, struct stack *);
53 void		 stack_zero(struct stack *);
54 void		 stack_print(const struct stack *);
55 void		 stack_print_ddb(const struct stack *);
56 void		 stack_print_short(const struct stack *);
57 void		 stack_print_short_ddb(const struct stack *);
58 void		 stack_sbuf_print(struct sbuf *, const struct stack *);
59 void		 stack_sbuf_print_ddb(struct sbuf *, const struct stack *);
60 int		 stack_sbuf_print_flags(struct sbuf *, const struct stack *,
61 		     int, enum stack_sbuf_fmt);
62 #ifdef KTR
63 void		 stack_ktr(u_int, const char *, int, const struct stack *,
64 		    u_int);
65 #define	CTRSTACK(m, st, depth) do {					\
66 	if (KTR_COMPILE & (m))						\
67 		stack_ktr((m), __FILE__, __LINE__, st, depth);		\
68 	} while (0)
69 #else
70 #define	CTRSTACK(m, st, depth)
71 #endif
72 
73 /* MD Routines. */
74 struct thread;
75 void		 stack_save(struct stack *);
76 int		 stack_save_td(struct stack *, struct thread *);
77 
78 #endif
79