xref: /freebsd/sys/sys/stack.h (revision 0957b409)
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 struct sbuf;
37 
38 /* MI Routines. */
39 struct stack	*stack_create(int);
40 void		 stack_destroy(struct stack *);
41 int		 stack_put(struct stack *, vm_offset_t);
42 void		 stack_copy(const struct stack *, struct stack *);
43 void		 stack_zero(struct stack *);
44 void		 stack_print(const struct stack *);
45 void		 stack_print_ddb(const struct stack *);
46 void		 stack_print_short(const struct stack *);
47 void		 stack_print_short_ddb(const struct stack *);
48 void		 stack_sbuf_print(struct sbuf *, const struct stack *);
49 void		 stack_sbuf_print_ddb(struct sbuf *, const struct stack *);
50 int		 stack_sbuf_print_flags(struct sbuf *, const struct stack *,
51 		 int);
52 #ifdef KTR
53 void		 stack_ktr(u_int, const char *, int, const struct stack *,
54 		    u_int, int);
55 #define	CTRSTACK(m, st, depth, cheap) do {				\
56 	if (KTR_COMPILE & (m))						\
57 		stack_ktr((m), __FILE__, __LINE__, st, depth, cheap);	\
58 	} while(0)
59 #else
60 #define	CTRSTACK(m, st, depth, cheap)
61 #endif
62 
63 /* MD Routines. */
64 struct thread;
65 void		 stack_save(struct stack *);
66 void		 stack_save_td(struct stack *, struct thread *);
67 int		 stack_save_td_running(struct stack *, struct thread *);
68 
69 #endif
70