1 /* $NetBSD: sockaddr.h,v 1.5 2014/12/10 04:38:00 christos Exp $ */ 2 3 /* 4 * Copyright (C) 2004-2007, 2009, 2012 Internet Systems Consortium, Inc. ("ISC") 5 * Copyright (C) 1998-2003 Internet Software Consortium. 6 * 7 * Permission to use, copy, modify, and/or distribute this software for any 8 * purpose with or without fee is hereby granted, provided that the above 9 * copyright notice and this permission notice appear in all copies. 10 * 11 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH 12 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY 13 * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, 14 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM 15 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE 16 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 17 * PERFORMANCE OF THIS SOFTWARE. 18 */ 19 20 /* Id: sockaddr.h,v 1.57 2009/01/18 23:48:14 tbox Exp */ 21 22 #ifndef ISC_SOCKADDR_H 23 #define ISC_SOCKADDR_H 1 24 25 /*! \file isc/sockaddr.h */ 26 27 #include <isc/lang.h> 28 #include <isc/net.h> 29 #include <isc/types.h> 30 #ifdef ISC_PLATFORM_HAVESYSUNH 31 #include <sys/un.h> 32 #endif 33 34 struct isc_sockaddr { 35 union { 36 struct sockaddr sa; 37 struct sockaddr_in sin; 38 struct sockaddr_in6 sin6; 39 struct sockaddr_storage ss; 40 #ifdef ISC_PLATFORM_HAVESYSUNH 41 struct sockaddr_un sunix; 42 #endif 43 } type; 44 unsigned int length; /* XXXRTH beginning? */ 45 ISC_LINK(struct isc_sockaddr) link; 46 }; 47 48 typedef ISC_LIST(struct isc_sockaddr) isc_sockaddrlist_t; 49 50 #define ISC_SOCKADDR_CMPADDR 0x0001 /*%< compare the address 51 * sin_addr/sin6_addr */ 52 #define ISC_SOCKADDR_CMPPORT 0x0002 /*%< compare the port 53 * sin_port/sin6_port */ 54 #define ISC_SOCKADDR_CMPSCOPE 0x0004 /*%< compare the scope 55 * sin6_scope */ 56 #define ISC_SOCKADDR_CMPSCOPEZERO 0x0008 /*%< when comparing scopes 57 * zero scopes always match */ 58 59 ISC_LANG_BEGINDECLS 60 61 isc_boolean_t 62 isc_sockaddr_compare(const isc_sockaddr_t *a, const isc_sockaddr_t *b, 63 unsigned int flags); 64 /*%< 65 * Compare the elements of the two address ('a' and 'b') as specified 66 * by 'flags' and report if they are equal or not. 67 * 68 * 'flags' is set from ISC_SOCKADDR_CMP*. 69 */ 70 71 isc_boolean_t 72 isc_sockaddr_equal(const isc_sockaddr_t *a, const isc_sockaddr_t *b); 73 /*%< 74 * Return ISC_TRUE iff the socket addresses 'a' and 'b' are equal. 75 */ 76 77 isc_boolean_t 78 isc_sockaddr_eqaddr(const isc_sockaddr_t *a, const isc_sockaddr_t *b); 79 /*%< 80 * Return ISC_TRUE iff the address parts of the socket addresses 81 * 'a' and 'b' are equal, ignoring the ports. 82 */ 83 84 isc_boolean_t 85 isc_sockaddr_eqaddrprefix(const isc_sockaddr_t *a, const isc_sockaddr_t *b, 86 unsigned int prefixlen); 87 /*%< 88 * Return ISC_TRUE iff the most significant 'prefixlen' bits of the 89 * socket addresses 'a' and 'b' are equal, ignoring the ports. 90 * If 'b''s scope is zero then 'a''s scope will be ignored. 91 */ 92 93 unsigned int 94 isc_sockaddr_hash(const isc_sockaddr_t *sockaddr, isc_boolean_t address_only); 95 /*%< 96 * Return a hash value for the socket address 'sockaddr'. If 'address_only' 97 * is ISC_TRUE, the hash value will not depend on the port. 98 * 99 * IPv6 addresses containing mapped IPv4 addresses generate the same hash 100 * value as the equivalent IPv4 address. 101 */ 102 103 void 104 isc_sockaddr_any(isc_sockaddr_t *sockaddr); 105 /*%< 106 * Return the IPv4 wildcard address. 107 */ 108 109 void 110 isc_sockaddr_any6(isc_sockaddr_t *sockaddr); 111 /*%< 112 * Return the IPv6 wildcard address. 113 */ 114 115 void 116 isc_sockaddr_anyofpf(isc_sockaddr_t *sockaddr, int family); 117 /*%< 118 * Set '*sockaddr' to the wildcard address of protocol family 119 * 'family'. 120 * 121 * Requires: 122 * \li 'family' is AF_INET or AF_INET6. 123 */ 124 125 void 126 isc_sockaddr_fromin(isc_sockaddr_t *sockaddr, const struct in_addr *ina, 127 in_port_t port); 128 /*%< 129 * Construct an isc_sockaddr_t from an IPv4 address and port. 130 */ 131 132 void 133 isc_sockaddr_fromin6(isc_sockaddr_t *sockaddr, const struct in6_addr *ina6, 134 in_port_t port); 135 /*%< 136 * Construct an isc_sockaddr_t from an IPv6 address and port. 137 */ 138 139 void 140 isc_sockaddr_v6fromin(isc_sockaddr_t *sockaddr, const struct in_addr *ina, 141 in_port_t port); 142 /*%< 143 * Construct an IPv6 isc_sockaddr_t representing a mapped IPv4 address. 144 */ 145 146 void 147 isc_sockaddr_fromnetaddr(isc_sockaddr_t *sockaddr, const isc_netaddr_t *na, 148 in_port_t port); 149 /*%< 150 * Construct an isc_sockaddr_t from an isc_netaddr_t and port. 151 */ 152 153 int 154 isc_sockaddr_pf(const isc_sockaddr_t *sockaddr); 155 /*%< 156 * Get the protocol family of 'sockaddr'. 157 * 158 * Requires: 159 * 160 *\li 'sockaddr' is a valid sockaddr with an address family of AF_INET 161 * or AF_INET6. 162 * 163 * Returns: 164 * 165 *\li The protocol family of 'sockaddr', e.g. PF_INET or PF_INET6. 166 */ 167 168 void 169 isc_sockaddr_setport(isc_sockaddr_t *sockaddr, in_port_t port); 170 /*%< 171 * Set the port of 'sockaddr' to 'port'. 172 */ 173 174 in_port_t 175 isc_sockaddr_getport(const isc_sockaddr_t *sockaddr); 176 /*%< 177 * Get the port stored in 'sockaddr'. 178 */ 179 180 isc_result_t 181 isc_sockaddr_totext(const isc_sockaddr_t *sockaddr, isc_buffer_t *target); 182 /*%< 183 * Append a text representation of 'sockaddr' to the buffer 'target'. 184 * The text will include both the IP address (v4 or v6) and the port. 185 * The text is null terminated, but the terminating null is not 186 * part of the buffer's used region. 187 * 188 * Returns: 189 * \li ISC_R_SUCCESS 190 * \li ISC_R_NOSPACE The text or the null termination did not fit. 191 */ 192 193 void 194 isc_sockaddr_format(const isc_sockaddr_t *sa, char *array, unsigned int size); 195 /*%< 196 * Format a human-readable representation of the socket address '*sa' 197 * into the character array 'array', which is of size 'size'. 198 * The resulting string is guaranteed to be null-terminated. 199 */ 200 201 isc_boolean_t 202 isc_sockaddr_ismulticast(const isc_sockaddr_t *sa); 203 /*%< 204 * Returns #ISC_TRUE if the address is a multicast address. 205 */ 206 207 isc_boolean_t 208 isc_sockaddr_isexperimental(const isc_sockaddr_t *sa); 209 /* 210 * Returns ISC_TRUE if the address is a experimental (CLASS E) address. 211 */ 212 213 isc_boolean_t 214 isc_sockaddr_islinklocal(const isc_sockaddr_t *sa); 215 /*%< 216 * Returns ISC_TRUE if the address is a link local address. 217 */ 218 219 isc_boolean_t 220 isc_sockaddr_issitelocal(const isc_sockaddr_t *sa); 221 /*%< 222 * Returns ISC_TRUE if the address is a sitelocal address. 223 */ 224 225 isc_result_t 226 isc_sockaddr_frompath(isc_sockaddr_t *sockaddr, const char *path); 227 /* 228 * Create a UNIX domain sockaddr that refers to path. 229 * 230 * Returns: 231 * \li ISC_R_NOSPACE 232 * \li ISC_R_NOTIMPLEMENTED 233 * \li ISC_R_SUCCESS 234 */ 235 236 #define ISC_SOCKADDR_FORMATSIZE \ 237 sizeof("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:XXX.XXX.XXX.XXX%SSSSSSSSSS#YYYYY") 238 /*%< 239 * Minimum size of array to pass to isc_sockaddr_format(). 240 */ 241 242 ISC_LANG_ENDDECLS 243 244 #endif /* ISC_SOCKADDR_H */ 245