corosync  3.0.3
totemip.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2005-2019 Red Hat, Inc.
3  *
4  * All rights reserved.
5  *
6  * Author: Patrick Caulfield (pcaulfie@redhat.com)
7  *
8  * This software licensed under BSD license, the text of which follows:
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions are met:
12  *
13  * - Redistributions of source code must retain the above copyright notice,
14  * this list of conditions and the following disclaimer.
15  * - Redistributions in binary form must reproduce the above copyright notice,
16  * this list of conditions and the following disclaimer in the documentation
17  * and/or other materials provided with the distribution.
18  * - Neither the name of the MontaVista Software, Inc. nor the names of its
19  * contributors may be used to endorse or promote products derived from this
20  * software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
23  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
26  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
32  * THE POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 /* IPv4/6 abstraction */
36 
37 #ifndef TOTEMIP_H_DEFINED
38 #define TOTEMIP_H_DEFINED
39 
40 #include <sys/types.h>
41 #include <sys/socket.h>
42 #include <netinet/in.h>
43 #include <stdint.h>
44 #include <qb/qblist.h>
45 
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49 
50 #ifdef SO_NOSIGPIPE
51 #ifndef MSG_NOSIGNAL
52 #define MSG_NOSIGNAL 0
53 #endif
54 void totemip_nosigpipe(int s);
55 #else
56 #define totemip_nosigpipe(s)
57 #endif
58 
59 #define TOTEMIP_ADDRLEN (sizeof(struct in6_addr))
60 
61 /* These are the things that get passed around */
62 #define TOTEM_IP_ADDRESS
63 struct totem_ip_address
64 {
65  unsigned int nodeid;
66  unsigned short family;
67  unsigned char addr[TOTEMIP_ADDRLEN];
68 } __attribute__((packed));
69 
71  TOTEM_IP_VERSION_4, /* Use only AF_INET */
72  TOTEM_IP_VERSION_6, /* Use only AF_INET6 */
73  TOTEM_IP_VERSION_4_6, /* Use AF_UNSPEC and filter result preferring AF_INET */
74  TOTEM_IP_VERSION_6_4 /* Use AF_UNSPEC and filter result preferring AF_INET6 */
75 };
76 
78 {
83  char *name;
84  struct qb_list_head list;
85 };
86 
87 extern int totemip_equal(const struct totem_ip_address *addr1,
88  const struct totem_ip_address *addr2);
89 extern int totemip_sa_equal(const struct totem_ip_address *totem_ip,
90  const struct sockaddr *sa);
91 extern int totemip_compare(const void *a, const void *b);
92 extern int totemip_is_mcast(struct totem_ip_address *addr);
93 extern void totemip_copy(struct totem_ip_address *addr1,
94  const struct totem_ip_address *addr2);
95 extern void totemip_copy_endian_convert(struct totem_ip_address *addr1,
96  const struct totem_ip_address *addr2);
97 int totemip_localhost(int family, struct totem_ip_address *localhost);
98 extern int totemip_localhost_check(const struct totem_ip_address *addr);
99 extern const char *totemip_print(const struct totem_ip_address *addr);
100 extern const char *totemip_sa_print(const struct sockaddr *sa);
101 extern int totemip_sockaddr_to_totemip_convert(const struct sockaddr_storage *saddr,
102  struct totem_ip_address *ip_addr);
103 extern int totemip_totemip_to_sockaddr_convert(struct totem_ip_address *ip_addr,
104  uint16_t port, struct sockaddr_storage *saddr, int *addrlen);
105 extern int totemip_parse(struct totem_ip_address *totemip, const char *addr,
106  enum totem_ip_version_enum ip_version);
107 extern int totemip_iface_check(struct totem_ip_address *bindnet,
108  struct totem_ip_address *boundto,
109  int *interface_up,
110  int *interface_num,
111  int mask_high_bit);
112 
113 extern int totemip_getifaddrs(struct qb_list_head *addrs);
114 
115 extern void totemip_freeifaddrs(struct qb_list_head *addrs);
116 
117 /* These two simulate a zero in_addr by clearing the family field */
118 static inline void totemip_zero_set(struct totem_ip_address *addr)
119 {
120  addr->family = 0;
121 }
122 static inline int totemip_zero_check(const struct totem_ip_address *addr)
123 {
124  return (addr->family == 0);
125 }
126 
127 extern size_t totemip_udpip_header_size(int family);
128 
129 #ifdef __cplusplus
130 }
131 #endif
132 
133 #endif
totem_ip_version_enum
totem_ip_version_enum
Definition: totemip.h:70
TOTEMIP_ADDRLEN
#define TOTEMIP_ADDRLEN
Definition: totemip.h:59
totemip_copy_endian_convert
void totemip_copy_endian_convert(struct totem_ip_address *addr1, const struct totem_ip_address *addr2)
Definition: totemip.c:129
family
unsigned short family
Definition: totemip.h:244
TOTEM_IP_VERSION_6_4
Definition: totemip.h:74
totemip_print
const char * totemip_print(const struct totem_ip_address *addr)
Definition: totemip.c:264
TOTEM_IP_VERSION_4
Definition: totemip.h:71
TOTEM_IP_VERSION_6
Definition: totemip.h:72
totemip_compare
int totemip_compare(const void *a, const void *b)
Definition: totemip.c:158
TOTEM_IP_VERSION_4_6
Definition: totemip.h:73
totem_ip_if_address::list
struct qb_list_head list
Definition: totemip.h:84
totem_ip_address::nodeid
unsigned int nodeid
Definition: coroapi.h:112
totemip_is_mcast
int totemip_is_mcast(struct totem_ip_address *addr)
Definition: totemip.c:142
totemip_sa_equal
int totemip_sa_equal(const struct totem_ip_address *totem_ip, const struct sockaddr *sa)
Definition: totemip.c:95
totemip_copy
void totemip_copy(struct totem_ip_address *addr1, const struct totem_ip_address *addr2)
Definition: totemip.c:123
totemip_nosigpipe
#define totemip_nosigpipe(s)
Definition: totemip.h:56
totemip_iface_check
int totemip_iface_check(struct totem_ip_address *bindnet, struct totem_ip_address *boundto, int *interface_up, int *interface_num, int mask_high_bit)
Definition: totemip.c:537
totemip_freeifaddrs
void totemip_freeifaddrs(struct qb_list_head *addrs)
Definition: totemip.c:522
addr
unsigned char addr[TOTEMIP_ADDRLEN]
Definition: totemip.h:245
totem_ip_if_address::name
char * name
Definition: totemip.h:83
totem_ip_if_address::mask_addr
struct totem_ip_address mask_addr
Definition: totemip.h:80
totemip_udpip_header_size
size_t totemip_udpip_header_size(int family)
Definition: totemip.c:616
totem_ip_address::family
unsigned short family
Definition: coroapi.h:113
totemip_localhost_check
int totemip_localhost_check(const struct totem_ip_address *addr)
Definition: totemip.c:233
totem_ip_if_address
Definition: totemip.h:77
totem_ip_address
The totem_ip_address struct.
Definition: coroapi.h:111
totemip_sa_print
const char * totemip_sa_print(const struct sockaddr *sa)
Definition: totemip.c:242
totemip_getifaddrs
int totemip_getifaddrs(struct qb_list_head *addrs)
Definition: totemip.c:454
totem_ip_address::addr
unsigned char addr[TOTEMIP_ADDRLEN]
Definition: coroapi.h:114
totemip_parse
int totemip_parse(struct totem_ip_address *totemip, const char *addr, enum totem_ip_version_enum ip_version)
Definition: totemip.c:314
totem_ip_if_address::interface_up
int interface_up
Definition: totemip.h:81
totem_ip_if_address::ip_addr
struct totem_ip_address ip_addr
Definition: totemip.h:79
__attribute__
enum totem_ip_version_enum __attribute__
totem_ip_if_address::interface_num
int interface_num
Definition: totemip.h:82
totemip_equal
int totemip_equal(const struct totem_ip_address *addr1, const struct totem_ip_address *addr2)
Definition: totemip.c:72
totemip_sockaddr_to_totemip_convert
int totemip_sockaddr_to_totemip_convert(const struct sockaddr_storage *saddr, struct totem_ip_address *ip_addr)
Definition: totemip.c:428
totemip_totemip_to_sockaddr_convert
int totemip_totemip_to_sockaddr_convert(struct totem_ip_address *ip_addr, uint16_t port, struct sockaddr_storage *saddr, int *addrlen)
Definition: totemip.c:272
totemip_localhost
int totemip_localhost(int family, struct totem_ip_address *localhost)
Definition: totemip.c:210