xref: /freebsd/sys/sys/stack.h (revision 95ee2897)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
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 
29 #ifndef _SYS_STACK_H_
30 #define	_SYS_STACK_H_
31 
32 #include <sys/_stack.h>
33 
34 #ifdef _SYS_MALLOC_H_
35 MALLOC_DECLARE(M_STACK);
36 #endif
37 
38 struct sbuf;
39 
40 enum stack_sbuf_fmt {
41 	STACK_SBUF_FMT_NONE	= 0,
42 	STACK_SBUF_FMT_LONG	= 1,
43 	STACK_SBUF_FMT_COMPACT	= 2,
44 };
45 
46 /* MI Routines. */
47 struct stack	*stack_create(int);
48 void		 stack_destroy(struct stack *);
49 int		 stack_put(struct stack *, vm_offset_t);
50 void		 stack_copy(const struct stack *, struct stack *);
51 void		 stack_zero(struct stack *);
52 void		 stack_print(const struct stack *);
53 void		 stack_print_ddb(const struct stack *);
54 void		 stack_print_short(const struct stack *);
55 void		 stack_print_short_ddb(const struct stack *);
56 void		 stack_sbuf_print(struct sbuf *, const struct stack *);
57 void		 stack_sbuf_print_ddb(struct sbuf *, const struct stack *);
58 int		 stack_sbuf_print_flags(struct sbuf *, const struct stack *,
59 		     int, enum stack_sbuf_fmt);
60 #ifdef KTR
61 void		 stack_ktr(u_int, const char *, int, const struct stack *,
62 		    u_int);
63 #define	CTRSTACK(m, st, depth) do {					\
64 	if (KTR_COMPILE & (m))						\
65 		stack_ktr((m), __FILE__, __LINE__, st, depth);		\
66 	} while (0)
67 #else
68 #define	CTRSTACK(m, st, depth)
69 #endif
70 
71 /* MD Routines. */
72 struct thread;
73 void		 stack_save(struct stack *);
74 int		 stack_save_td(struct stack *, struct thread *);
75 
76 #endif
77