1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
/*
* Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
* University Research and Technology
* Corporation. All rights reserved.
* Copyright (c) 2004-2005 The University of Tennessee and The University
* of Tennessee Research Foundation. All rights
* reserved.
* Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
* University of Stuttgart. All rights reserved.
* Copyright (c) 2004-2005 The Regents of the University of California.
* All rights reserved.
* Copyright (c) 2007 Los Alamos National Security, LLC. All rights
* reserved.
* Copyright (c) 2008 Sun Microsystems, Inc. All rights reserved.
* Copyright (c) 2013 Cisco Systems, Inc. All rights reserved.
* $COPYRIGHT$
*
* Additional copyrights may follow
*
* $HEADER$
*/
/* @file */
#ifndef OPAL_IF_UTIL_
#define OPAL_IF_UTIL_
#include "opal_config.h"
#ifdef HAVE_SYS_TYPES_H
# include <sys/types.h>
#endif
#ifdef HAVE_SYS_SOCKET_H
# include <sys/socket.h>
#endif
#ifdef HAVE_NETINET_IN_H
# include <netinet/in.h>
#endif
/*
* We previously defined IF_NAMESIZE to 32 if not already defined.
* Due to this macro being reused from net/if.h, we could encounter
* a macro mismatch. In particular, in cases where opal/util/if.h was
* included, but net/if.h was not, IF_NAMESIZE would be 32. If net/if.h
* was included on Linux systems, IF_NAMESIZE would be 16. To avoid this
* issue, we define our own OPAL_IF_NAMESIZE macro instead.
*/
#define OPAL_IF_NAMESIZE 32
BEGIN_C_DECLS
#define OPAL_IF_FORMAT_ADDR(n) \
(((n) >> 24) & 0x000000FF), (((n) >> 16) & 0x000000FF), (((n) >> 8) & 0x000000FF), \
((n) &0x000000FF)
#define OPAL_IF_ASSEMBLE_NETWORK(n1, n2, n3, n4) \
(((n1) << 24) & 0xFF000000) | (((n2) << 16) & 0x00FF0000) | (((n3) << 8) & 0x0000FF00) \
| ((n4) &0x000000FF)
/**
* Lookup an interface by name and return its primary address.
*
* @param if_name (IN) Interface name
* @param if_addr (OUT) Interface address buffer
* @param size (IN) Interface address buffer size
*/
OPAL_DECLSPEC int opal_ifnametoaddr(const char *if_name, struct sockaddr *if_addr, int size);
/**
* Lookup an interface by address and return its name.
*
* @param if_addr (IN) Interface address (hostname or dotted-quad)
* @param if_name (OUT) Interface name buffer
* @param size (IN) Interface name buffer size
*/
OPAL_DECLSPEC int opal_ifaddrtoname(const char *if_addr, char *if_name, int size);
/**
* Lookup an interface by name and return its opal_list index.
*
* @param if_name (IN) Interface name
* @return Interface opal_list index
*/
OPAL_DECLSPEC int opal_ifnametoindex(const char *if_name);
/**
* Lookup an interface by name and return its kernel index.
*
* @param if_name (IN) Interface name
* @return Interface kernel index
*/
OPAL_DECLSPEC int opal_ifnametokindex(const char *if_name);
/*
* Attempt to resolve an address (given as either IPv4/IPv6 string
* or hostname) and return the kernel index of the interface
* that is on the same network as the specified address
*/
OPAL_DECLSPEC int opal_ifaddrtokindex(const char *if_addr);
/**
* Lookup an interface by opal_list index and return its kernel index.
*
* @param if_name (IN) Interface opal_list index
* @return Interface kernel index
*/
OPAL_DECLSPEC int opal_ifindextokindex(int if_index);
/**
* Returns the number of available interfaces.
*/
OPAL_DECLSPEC int opal_ifcount(void);
/**
* Returns the index of the first available interface.
*/
OPAL_DECLSPEC int opal_ifbegin(void);
/**
* Lookup the current position in the interface list by
* index and return the next available index (if it exists).
*
* @param if_index Returns the next available index from the
* current position.
*/
OPAL_DECLSPEC int opal_ifnext(int if_index);
/**
* Lookup an interface by index and return its name.
*
* @param if_index (IN) Interface index
* @param if_name (OUT) Interface name buffer
* @param size (IN) Interface name buffer size
*/
OPAL_DECLSPEC int opal_ifindextoname(int if_index, char *if_name, int);
/**
* Lookup an interface by kernel index and return its name.
*
* @param if_index (IN) Interface kernel index
* @param if_name (OUT) Interface name buffer
* @param size (IN) Interface name buffer size
*/
OPAL_DECLSPEC int opal_ifkindextoname(int if_kindex, char *if_name, int);
/**
* Lookup an interface by index and return its primary address.
*
* @param if_index (IN) Interface index
* @param if_name (OUT) Interface address buffer
* @param size (IN) Interface address buffer size
*/
OPAL_DECLSPEC int opal_ifindextoaddr(int if_index, struct sockaddr *, unsigned int);
OPAL_DECLSPEC int opal_ifkindextoaddr(int if_kindex, struct sockaddr *if_addr, unsigned int length);
/**
* Lookup an interface by index and return its network mask (in CIDR
* notation -- NOT the actual netmask itself!).
*
* @param if_index (IN) Interface index
* @param if_name (OUT) Interface address buffer
* @param size (IN) Interface address buffer size
*/
OPAL_DECLSPEC int opal_ifindextomask(int if_index, uint32_t *, int);
/**
* Lookup an interface by index and return its MAC address.
*
* @param if_index (IN) Interface index
* @param if_mac (OUT) Interface's MAC address
*/
OPAL_DECLSPEC int opal_ifindextomac(int if_index, uint8_t if_mac[6]);
/**
* Lookup an interface by index and return its MTU.
*
* @param if_index (IN) Interface index
* @param if_mtu (OUT) Interface's MTU
*/
OPAL_DECLSPEC int opal_ifindextomtu(int if_index, int *mtu);
/**
* Lookup an interface by index and return its flags.
*
* @param if_index (IN) Interface index
* @param if_flags (OUT) Interface flags
*/
OPAL_DECLSPEC int opal_ifindextoflags(int if_index, uint32_t *);
/**
* Determine if given hostname / IP address is a local address
*
* @param hostname (IN) Hostname (or stringified IP address)
* @return true if \c hostname is local, false otherwise
*/
OPAL_DECLSPEC bool opal_ifislocal(const char *hostname);
/**
* Convert a dot-delimited network tuple to an IP address
*
* @param addr (IN) character string tuple
* @param net (IN) Pointer to returned network address
* @param mask (IN) Pointer to returned netmask
* @return OPAL_SUCCESS if no problems encountered
* @return OPAL_ERROR if data could not be released
*/
OPAL_DECLSPEC int opal_iftupletoaddr(const char *addr, uint32_t *net, uint32_t *mask);
/**
* Determine if given interface is loopback
*
* @param if_index (IN) Interface index
*/
OPAL_DECLSPEC bool opal_ifisloopback(int if_index);
/*
* Determine if a specified interface is included in a NULL-terminated argv array
*/
OPAL_DECLSPEC int opal_ifmatches(int kidx, char **nets);
/*
* Provide a list of strings that contain all known aliases for this node
*/
OPAL_DECLSPEC void opal_ifgetaliases(char ***aliases);
END_C_DECLS
#endif
|
