xref: /xnu-10002.61.3/bsd/net/sockaddr_utils.h (revision 0f4c859e951fba394238ab619495c4e1d54d0f34)
1 /*
2  * Copyright (c) 2023 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 _NET_SOCKADDRD_UTILS_H_
29 #define _NET_SOCKADDRD_UTILS_H_
30 
31 #ifdef XNU_KERNEL_PRIVATE
32 
33 #include <sys/mcache.h>
34 #include <sys/socket.h>
35 
36 /*
37  * Various helper routines for dealing with socket addreses.
38  */
39 
40 /*
41  * Copy the contents of the sockadddr `from' into the memory pointed by `to',
42  * which has at least `len' bytes.
43  */
44 #define SOCKADDR_COPY_LEN(from, to, len) do {                               \
45     caddr_t from_bytes __bidi_indexable = NULL;                             \
46     caddr_t to_bytes __bidi_indexable = NULL;                               \
47     uint32_t from_len;                                                      \
48     VERIFY((to) != NULL && (from) != NULL);                                 \
49     VERIFY(offsetof(struct sockaddr, sa_data) <= (len));                    \
50     from_len = *((uint8_t*)(void*)(from));                                  \
51     VERIFY(from_len <= (len));                                              \
52     from_bytes = __unsafe_forge_bidi_indexable(caddr_t, (from), from_len);  \
53     to_bytes = __unsafe_forge_bidi_indexable(caddr_t, (to), from_len);      \
54     *to_bytes = *from_bytes;                                                \
55     *(to_bytes + offsetof(struct sockaddr, sa_family)) =                    \
56 	*(from_bytes + offsetof(struct sockaddr, sa_family));               \
57     if (offsetof(struct sockaddr, sa_data) < from_len) {                    \
58 	bcopy(from_bytes + offsetof(struct sockaddr, sa_data),              \
59 	        to_bytes + offsetof(struct sockaddr, sa_data),              \
60 	        from_len - offsetof(struct sockaddr, sa_data));             \
61     }                                                                       \
62 } while(0)
63 
64 /*
65  * Copy the contents of the sockaddr `from' into the pointee of `to'.
66  */
67 #define SOCKADDR_COPY(from, to) do {                                        \
68     VERIFY((to) != NULL && (from) != NULL);                                 \
69     SOCKADDR_COPY_LEN(from, to, sizeof(*(to)));                             \
70 } while(0)
71 
72 #endif /* XNU_KERNEL_PRIVATE */
73 
74 #endif /* _NET_SOCKADDRD_UTILS_H_ */
75