contrib/bind9/lib/isc/include/isc/sockaddr.h

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