lib/sockunion.h

   1 /*
   2  * Socket union header.
   3  * Copyright (c) 1997 Kunihiro Ishiguro
   4  *
   5  * This file is part of GNU Zebra.
   6  *
   7  * GNU Zebra is free software; you can redistribute it and/or modify it
   8  * under the terms of the GNU General Public License as published by the
   9  * Free Software Foundation; either version 2, or (at your option) any
  10  * later version.
  11  *
  12  * GNU Zebra is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; see the file COPYING; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 #ifndef _ZEBRA_SOCKUNION_H
  23 #define _ZEBRA_SOCKUNION_H
  24
  25 #include "privs.h"
  26 #include "if.h"
  27 #ifdef __OpenBSD__
  28 #include <netmpls/mpls.h>
  29 #endif
  30
  31 union sockunion
  32 {
  33   struct sockaddr sa;
  34   struct sockaddr_in sin;
  35   struct sockaddr_in6 sin6;
  36 #ifdef __OpenBSD__
  37   struct sockaddr_mpls smpls;
  38 #endif
  39 };
  40
  41 enum connect_result
  42 {
  43   connect_error,
  44   connect_success,
  45   connect_in_progress
  46 };
  47
  48 /* Default address family. */
  49 #define AF_INET_UNION AF_INET6
  50
  51 /* Sockunion address string length.  Same as INET6_ADDRSTRLEN. */
  52 #define SU_ADDRSTRLEN 46
  53
  54 /* Macro to set link local index to the IPv6 address.  For KAME IPv6
  55    stack. */
  56 #ifdef KAME
  57 #define IN6_LINKLOCAL_IFINDEX(a)  ((a).s6_addr[2] << 8 | (a).s6_addr[3])
  58 #define SET_IN6_LINKLOCAL_IFINDEX(a, i) \
  59   do { \
  60     (a).s6_addr[2] = ((i) >> 8) & 0xff; \
  61     (a).s6_addr[3] = (i) & 0xff; \
  62   } while (0)
  63 #else
  64 #define IN6_LINKLOCAL_IFINDEX(a)
  65 #define SET_IN6_LINKLOCAL_IFINDEX(a, i)
  66 #endif /* KAME */
  67
  68 #define sockunion_family(X)  (X)->sa.sa_family
  69
  70 #define sockunion2ip(X)      (X)->sin.sin_addr.s_addr
  71
  72 /* Prototypes. */
  73 extern int str2sockunion (const char *, union sockunion *);
  74 extern const char *sockunion2str (const union sockunion *, char *, size_t);
  75 extern int sockunion_cmp (const union sockunion *, const union sockunion *);
  76 extern int sockunion_same (const union sockunion *, const union sockunion *);
  77 extern unsigned int sockunion_hash (const union sockunion *);
  78
  79 extern size_t family2addrsize(int family);
  80 extern size_t sockunion_get_addrlen(const union sockunion *);
  81 extern const u_char *sockunion_get_addr(const union sockunion *);
  82 extern void sockunion_set(union sockunion *, int family, const u_char *addr, size_t bytes);
  83
  84 extern union sockunion *sockunion_str2su (const char *str);
  85 extern int sockunion_accept (int sock, union sockunion *);
  86 extern int sockunion_stream_socket (union sockunion *);
  87 extern int sockopt_reuseaddr (int);
  88 extern int sockopt_reuseport (int);
  89 extern int sockopt_v6only (int family, int sock);
  90 extern int sockunion_bind (int sock, union sockunion *,
  91                            unsigned short, union sockunion *);
  92 extern int sockopt_ttl (int family, int sock, int ttl);
  93 extern int sockopt_minttl (int family, int sock, int minttl);
  94 extern int sockopt_cork (int sock, int onoff);
  95 extern int sockopt_mark_default(int sock, int mark, struct zebra_privs_t *);
  96 extern int sockunion_socket (const union sockunion *su);
  97 extern const char *inet_sutop (const union sockunion *su, char *str);
  98 extern enum connect_result sockunion_connect (int fd, const union sockunion *su,
  99                                               unsigned short port,
 100                                               ifindex_t);
 101 extern union sockunion *sockunion_getsockname (int);
 102 extern union sockunion *sockunion_getpeername (int);
 103 extern union sockunion *sockunion_dup (const union sockunion *);
 104 extern void sockunion_free (union sockunion *);
 105 extern void sockunion_init (union sockunion *);
 106
 107 #endif /* _ZEBRA_SOCKUNION_H */