xref: /freebsd/sys/sys/khelp.h (revision aa0a1e58)
1 /*-
2  * Copyright (c) 2010 Lawrence Stewart <lstewart@freebsd.org>
3  * Copyright (c) 2010 The FreeBSD Foundation
4  * All rights reserved.
5  *
6  * This software was developed by Lawrence Stewart while studying at the Centre
7  * for Advanced Internet Architectures, Swinburne University, made possible in
8  * part by grants from the FreeBSD Foundation and Cisco University Research
9  * Program Fund at Community Foundation Silicon Valley.
10  *
11  * Portions of this software were developed at the Centre for Advanced
12  * Internet Architectures, Swinburne University of Technology, Melbourne,
13  * Australia by Lawrence Stewart under sponsorship from the FreeBSD Foundation.
14  *
15  * Redistribution and use in source and binary forms, with or without
16  * modification, are permitted provided that the following conditions
17  * are met:
18  * 1. Redistributions of source code must retain the above copyright
19  *    notice, this list of conditions and the following disclaimer.
20  * 2. Redistributions in binary form must reproduce the above copyright
21  *    notice, this list of conditions and the following disclaimer in the
22  *    documentation and/or other materials provided with the distribution.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  * $FreeBSD$
37  */
38 
39 /*
40  * A KPI for managing kernel helper modules which perform useful functionality
41  * within the kernel. Originally released as part of the NewTCP research
42  * project at Swinburne University's Centre for Advanced Internet Architectures,
43  * Melbourne, Australia, which was made possible in part by a grant from the
44  * Cisco University Research Program Fund at Community Foundation Silicon
45  * Valley. More details are available at:
46  *   http://caia.swin.edu.au/urp/newtcp/
47  */
48 
49 #ifndef	_SYS_KHELP_H_
50 #define	_SYS_KHELP_H_
51 
52 struct helper;
53 struct hookinfo;
54 struct osd;
55 
56 /* Helper classes. */
57 #define	HELPER_CLASS_TCP	0x00000001
58 
59 /* Public KPI functions. */
60 int	khelp_register_helper(struct helper *h);
61 
62 int	khelp_deregister_helper(struct helper *h);
63 
64 int	khelp_init_osd(uint32_t classes, struct osd *hosd);
65 
66 int	khelp_destroy_osd(struct osd *hosd);
67 
68 void *	khelp_get_osd(struct osd *hosd, int32_t id);
69 
70 int32_t	khelp_get_id(char *hname);
71 
72 int	khelp_add_hhook(struct hookinfo *hki, uint32_t flags);
73 
74 int	khelp_remove_hhook(struct hookinfo *hki);
75 
76 #endif /* _SYS_KHELP_H_ */
77