xref: /f-stack/freebsd/sys/stack.h (revision 22ce4aff)
1a9643ea8Slogwang /*-
2*22ce4affSfengbojiang  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3*22ce4affSfengbojiang  *
4a9643ea8Slogwang  * Copyright (c) 2005 Antoine Brodin
5a9643ea8Slogwang  * All rights reserved.
6a9643ea8Slogwang  *
7a9643ea8Slogwang  * Redistribution and use in source and binary forms, with or without
8a9643ea8Slogwang  * modification, are permitted provided that the following conditions
9a9643ea8Slogwang  * are met:
10a9643ea8Slogwang  * 1. Redistributions of source code must retain the above copyright
11a9643ea8Slogwang  *    notice, this list of conditions and the following disclaimer.
12a9643ea8Slogwang  * 2. Redistributions in binary form must reproduce the above copyright
13a9643ea8Slogwang  *    notice, this list of conditions and the following disclaimer in the
14a9643ea8Slogwang  *    documentation and/or other materials provided with the distribution.
15a9643ea8Slogwang  *
16a9643ea8Slogwang  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17a9643ea8Slogwang  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18a9643ea8Slogwang  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19a9643ea8Slogwang  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20a9643ea8Slogwang  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21a9643ea8Slogwang  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22a9643ea8Slogwang  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23a9643ea8Slogwang  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24a9643ea8Slogwang  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25a9643ea8Slogwang  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26a9643ea8Slogwang  * SUCH DAMAGE.
27a9643ea8Slogwang  *
28a9643ea8Slogwang  * $FreeBSD$
29a9643ea8Slogwang  */
30a9643ea8Slogwang 
31a9643ea8Slogwang #ifndef _SYS_STACK_H_
32a9643ea8Slogwang #define	_SYS_STACK_H_
33a9643ea8Slogwang 
34a9643ea8Slogwang #include <sys/_stack.h>
35a9643ea8Slogwang 
36*22ce4affSfengbojiang #ifdef _SYS_MALLOC_H_
37*22ce4affSfengbojiang MALLOC_DECLARE(M_STACK);
38*22ce4affSfengbojiang #endif
39*22ce4affSfengbojiang 
40a9643ea8Slogwang struct sbuf;
41a9643ea8Slogwang 
42*22ce4affSfengbojiang enum stack_sbuf_fmt {
43*22ce4affSfengbojiang 	STACK_SBUF_FMT_NONE	= 0,
44*22ce4affSfengbojiang 	STACK_SBUF_FMT_LONG	= 1,
45*22ce4affSfengbojiang 	STACK_SBUF_FMT_COMPACT	= 2,
46*22ce4affSfengbojiang };
47*22ce4affSfengbojiang 
48a9643ea8Slogwang /* MI Routines. */
49*22ce4affSfengbojiang struct stack	*stack_create(int);
50a9643ea8Slogwang void		 stack_destroy(struct stack *);
51a9643ea8Slogwang int		 stack_put(struct stack *, vm_offset_t);
52a9643ea8Slogwang void		 stack_copy(const struct stack *, struct stack *);
53a9643ea8Slogwang void		 stack_zero(struct stack *);
54a9643ea8Slogwang void		 stack_print(const struct stack *);
55a9643ea8Slogwang void		 stack_print_ddb(const struct stack *);
56a9643ea8Slogwang void		 stack_print_short(const struct stack *);
57a9643ea8Slogwang void		 stack_print_short_ddb(const struct stack *);
58a9643ea8Slogwang void		 stack_sbuf_print(struct sbuf *, const struct stack *);
59a9643ea8Slogwang void		 stack_sbuf_print_ddb(struct sbuf *, const struct stack *);
60*22ce4affSfengbojiang int		 stack_sbuf_print_flags(struct sbuf *, const struct stack *,
61*22ce4affSfengbojiang 		     int, enum stack_sbuf_fmt);
62a9643ea8Slogwang #ifdef KTR
63a9643ea8Slogwang void		 stack_ktr(u_int, const char *, int, const struct stack *,
64*22ce4affSfengbojiang 		    u_int);
65*22ce4affSfengbojiang #define	CTRSTACK(m, st, depth) do {					\
66a9643ea8Slogwang 	if (KTR_COMPILE & (m))						\
67*22ce4affSfengbojiang 		stack_ktr((m), __FILE__, __LINE__, st, depth);		\
68a9643ea8Slogwang 	} while(0)
69a9643ea8Slogwang #else
70*22ce4affSfengbojiang #define	CTRSTACK(m, st, depth)
71a9643ea8Slogwang #endif
72a9643ea8Slogwang 
73a9643ea8Slogwang /* MD Routines. */
74a9643ea8Slogwang struct thread;
75a9643ea8Slogwang void		 stack_save(struct stack *);
76*22ce4affSfengbojiang int		 stack_save_td(struct stack *, struct thread *);
77a9643ea8Slogwang 
78a9643ea8Slogwang #endif
79