xref: /xnu-10002.1.13/bsd/net/sockaddr_utils.h (revision 1031c584a5e37aff177559b9f69dbd3c8c3fd30a)
1*1031c584SApple OSS Distributions /*
2*1031c584SApple OSS Distributions  * Copyright (c) 2023 Apple Inc. All rights reserved.
3*1031c584SApple OSS Distributions  *
4*1031c584SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*1031c584SApple OSS Distributions  *
6*1031c584SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*1031c584SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*1031c584SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*1031c584SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*1031c584SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*1031c584SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*1031c584SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*1031c584SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*1031c584SApple OSS Distributions  *
15*1031c584SApple OSS Distributions  * Please obtain a copy of the License at
16*1031c584SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*1031c584SApple OSS Distributions  *
18*1031c584SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*1031c584SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*1031c584SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*1031c584SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*1031c584SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*1031c584SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*1031c584SApple OSS Distributions  * limitations under the License.
25*1031c584SApple OSS Distributions  *
26*1031c584SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*1031c584SApple OSS Distributions  */
28*1031c584SApple OSS Distributions #ifndef _NET_SOCKADDRD_UTILS_H_
29*1031c584SApple OSS Distributions #define _NET_SOCKADDRD_UTILS_H_
30*1031c584SApple OSS Distributions 
31*1031c584SApple OSS Distributions #ifdef XNU_KERNEL_PRIVATE
32*1031c584SApple OSS Distributions 
33*1031c584SApple OSS Distributions #include <sys/mcache.h>
34*1031c584SApple OSS Distributions #include <sys/socket.h>
35*1031c584SApple OSS Distributions 
36*1031c584SApple OSS Distributions /*
37*1031c584SApple OSS Distributions  * Various helper routines for dealing with socket addreses.
38*1031c584SApple OSS Distributions  */
39*1031c584SApple OSS Distributions 
40*1031c584SApple OSS Distributions /*
41*1031c584SApple OSS Distributions  * Copy the contents of the sockadddr `from' into the memory pointed by `to',
42*1031c584SApple OSS Distributions  * which has at least `len' bytes.
43*1031c584SApple OSS Distributions  */
44*1031c584SApple OSS Distributions #define SOCKADDR_COPY_LEN(from, to, len) do {                               \
45*1031c584SApple OSS Distributions     caddr_t from_bytes __bidi_indexable = NULL;                             \
46*1031c584SApple OSS Distributions     caddr_t to_bytes __bidi_indexable = NULL;                               \
47*1031c584SApple OSS Distributions     uint32_t from_len;                                                      \
48*1031c584SApple OSS Distributions     VERIFY((to) != NULL && (from) != NULL);                                 \
49*1031c584SApple OSS Distributions     VERIFY(offsetof(struct sockaddr, sa_data) <= (len));                    \
50*1031c584SApple OSS Distributions     from_len = *((uint8_t*)(void*)(from));                                  \
51*1031c584SApple OSS Distributions     VERIFY(from_len <= (len));                                              \
52*1031c584SApple OSS Distributions     from_bytes = __unsafe_forge_bidi_indexable(caddr_t, (from), from_len);  \
53*1031c584SApple OSS Distributions     to_bytes = __unsafe_forge_bidi_indexable(caddr_t, (to), from_len);      \
54*1031c584SApple OSS Distributions     *to_bytes = *from_bytes;                                                \
55*1031c584SApple OSS Distributions     *(to_bytes + offsetof(struct sockaddr, sa_family)) =                    \
56*1031c584SApple OSS Distributions 	*(from_bytes + offsetof(struct sockaddr, sa_family));               \
57*1031c584SApple OSS Distributions     if (offsetof(struct sockaddr, sa_data) < from_len) {                    \
58*1031c584SApple OSS Distributions 	bcopy(from_bytes + offsetof(struct sockaddr, sa_data),              \
59*1031c584SApple OSS Distributions 	        to_bytes + offsetof(struct sockaddr, sa_data),              \
60*1031c584SApple OSS Distributions 	        from_len - offsetof(struct sockaddr, sa_data));             \
61*1031c584SApple OSS Distributions     }                                                                       \
62*1031c584SApple OSS Distributions } while(0)
63*1031c584SApple OSS Distributions 
64*1031c584SApple OSS Distributions /*
65*1031c584SApple OSS Distributions  * Copy the contents of the sockaddr `from' into the pointee of `to'.
66*1031c584SApple OSS Distributions  */
67*1031c584SApple OSS Distributions #define SOCKADDR_COPY(from, to) do {                                        \
68*1031c584SApple OSS Distributions     VERIFY((to) != NULL && (from) != NULL);                                 \
69*1031c584SApple OSS Distributions     SOCKADDR_COPY_LEN(from, to, sizeof(*(to)));                             \
70*1031c584SApple OSS Distributions } while(0)
71*1031c584SApple OSS Distributions 
72*1031c584SApple OSS Distributions #endif /* XNU_KERNEL_PRIVATE */
73*1031c584SApple OSS Distributions 
74*1031c584SApple OSS Distributions #endif /* _NET_SOCKADDRD_UTILS_H_ */
75