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