xref: /netbsd-src/sys/sys/crashme.h (revision e992ccea30394ecf888d489cadf6ce37bf584647)
1 /*	$NetBSD: crashme.h,v 1.2 2022/09/21 10:50:11 riastradh Exp $	*/
2 
3 /*
4  * Copyright (c) 2018, 2019 Matthew R. Green
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  * 3. The name of the author may not be used to endorse or promote products
16  *    derived from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
23  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
25  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
26  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  */
30 
31 /* header for kernel crashme node handling. */
32 
33 #ifndef _SYS_CRASHME_H_
34 #define _SYS_CRASHME_H_
35 
36 /*
37  * don't mark this __dead.  crashme nodes failures should return to
38  * the caller so it can be handled.
39  *
40  * return zero if successful, and should return to user (may be part
41  * of the setup needed.)  return non-zero otherwise (will call plain
42  * panic().)
43  */
44 typedef int (*crashme_fn)(int);
45 
46 typedef struct crashme_node {
47 	const char		*cn_name;
48 	const char		*cn_longname;
49 	crashme_fn		 cn_fn;
50 	int			 cn_sysctl;
51 	struct crashme_node	*cn_next;
52 } crashme_node;
53 
54 int crashme_add(crashme_node *ncn);
55 int crashme_remove(crashme_node *ncn);
56 
57 #endif /* _SYS_CRASHME_H_ */
58