1/*
2 * Copyright (c) 2019 Apple Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
14 *
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28#ifndef _SKYWALK_NAMESPACE_PROTONS_H_
29#define _SKYWALK_NAMESPACE_PROTONS_H_
30
31
32/*
33 * The protons module arbitrates IP protocol number usage across Skywalk and
34 * the BSD networking stack. The IP protocol number is managed globally
35 * regardless of interface or IP address.
36 */
37
38extern int protons_init(void);
39extern void protons_fini(void);
40
41/* opaque token representing a protocol namespace reservation. */
42struct protons_token;
43
44/*
45 * Reserve a IP protocol number globally.
46 * Reserved protocol namespace token is return via @ptp.
47 */
48extern int protons_reserve(struct protons_token **ptp, pid_t pid, pid_t epid,
49 uint8_t proto);
50
51/*
52 * Release a IP protocol reservation recorded by the provided token.
53 * *ptp will be reset to NULL after release.
54 */
55extern void protons_release(struct protons_token **ptp);
56
57extern int protons_token_get_use_count(struct protons_token *pt);
58extern bool protons_token_is_valid(struct protons_token *pt);
59extern bool protons_token_has_matching_pid(struct protons_token *pt, pid_t pid,
60 pid_t epid);
61
62#endif /* !_SKYWALK_NAMESPACE_PROTONS_H_ */
63