xref: /xnu-11215.1.10/bsd/net/net_sysctl.h (revision 8d741a5de7ff4191bf97d57b9f54c2f6d4a15585)
1*8d741a5dSApple OSS Distributions /*
2*8d741a5dSApple OSS Distributions  * Copyright (c) 2000-2024 Apple Inc. All rights reserved.
3*8d741a5dSApple OSS Distributions  *
4*8d741a5dSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*8d741a5dSApple OSS Distributions  *
6*8d741a5dSApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*8d741a5dSApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*8d741a5dSApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*8d741a5dSApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*8d741a5dSApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*8d741a5dSApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*8d741a5dSApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*8d741a5dSApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*8d741a5dSApple OSS Distributions  *
15*8d741a5dSApple OSS Distributions  * Please obtain a copy of the License at
16*8d741a5dSApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*8d741a5dSApple OSS Distributions  *
18*8d741a5dSApple OSS Distributions  * The Original Code and all software distributed under the License are
19*8d741a5dSApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*8d741a5dSApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*8d741a5dSApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*8d741a5dSApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*8d741a5dSApple OSS Distributions  * Please see the License for the specific language governing rights and
24*8d741a5dSApple OSS Distributions  * limitations under the License.
25*8d741a5dSApple OSS Distributions  *
26*8d741a5dSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*8d741a5dSApple OSS Distributions  */
28*8d741a5dSApple OSS Distributions 
29*8d741a5dSApple OSS Distributions  #ifndef _NET_SYSCTL_H_
30*8d741a5dSApple OSS Distributions  #define _NET_SYSCTL_H_
31*8d741a5dSApple OSS Distributions 
32*8d741a5dSApple OSS Distributions #include <sys/cdefs.h>
33*8d741a5dSApple OSS Distributions #include <sys/sysctl.h>
34*8d741a5dSApple OSS Distributions /*
35*8d741a5dSApple OSS Distributions  * Helper utilities for the sysctl procedures used
36*8d741a5dSApple OSS Distributions  * by bsd networking.
37*8d741a5dSApple OSS Distributions  */
38*8d741a5dSApple OSS Distributions 
39*8d741a5dSApple OSS Distributions /*
40*8d741a5dSApple OSS Distributions  * DECLARE_SYSCTL_HANDLER_ARG_ARRAY
41*8d741a5dSApple OSS Distributions  *
42*8d741a5dSApple OSS Distributions  * Helper macro to be invoked from a sysctl handler function.
43*8d741a5dSApple OSS Distributions  *
44*8d741a5dSApple OSS Distributions  * The macro compares the `arg2' sysctl handler argument
45*8d741a5dSApple OSS Distributions  * with the `expected_array_size' macro parameter.
46*8d741a5dSApple OSS Distributions  *
47*8d741a5dSApple OSS Distributions  * If `arg2' is equal to `expected_array_size', the macro will
48*8d741a5dSApple OSS Distributions  * define two local variables, the names of which are controlled
49*8d741a5dSApple OSS Distributions  * by macro parameters:
50*8d741a5dSApple OSS Distributions  *
51*8d741a5dSApple OSS Distributions  *    element_type  *`array_var';
52*8d741a5dSApple OSS Distributions  *    unsigned int   `len_var';
53*8d741a5dSApple OSS Distributions  *
54*8d741a5dSApple OSS Distributions  * The `array_var' local variable will be sized in accordance
55*8d741a5dSApple OSS Distributions  * to the parameters. It does not use `__sized_by` annotation,
56*8d741a5dSApple OSS Distributions  * to allow the body of the handler function to change the values,
57*8d741a5dSApple OSS Distributions  * if needed.
58*8d741a5dSApple OSS Distributions  *
59*8d741a5dSApple OSS Distributions  * If `arg2' is not equal to `expected_array_size', the macro
60*8d741a5dSApple OSS Distributions  * will return from the sysctl handler function with the
61*8d741a5dSApple OSS Distributions  * EINVAL code.
62*8d741a5dSApple OSS Distributions  */
63*8d741a5dSApple OSS Distributions #define DECLARE_SYSCTL_HANDLER_ARG_ARRAY(element_type,                     \
64*8d741a5dSApple OSS Distributions 	    expected_array_size,                                               \
65*8d741a5dSApple OSS Distributions 	    array_var,                                                         \
66*8d741a5dSApple OSS Distributions 	    len_var)                                                           \
67*8d741a5dSApple OSS Distributions     unsigned int len_var = (unsigned int)arg2;                             \
68*8d741a5dSApple OSS Distributions     if (len_var != (expected_array_size)) {                                \
69*8d741a5dSApple OSS Distributions 	    return EINVAL;                                                     \
70*8d741a5dSApple OSS Distributions     }                                                                      \
71*8d741a5dSApple OSS Distributions     element_type * array_var = __unsafe_forge_bidi_indexable(              \
72*8d741a5dSApple OSS Distributions 	element_type *, arg1, len_var * sizeof(element_type))
73*8d741a5dSApple OSS Distributions 
74*8d741a5dSApple OSS Distributions 
75*8d741a5dSApple OSS Distributions  #endif /* _NET_SYSCTL_H_ */
76