Ruby  2.4.2p198(2017-09-14revision59899)
ifaddr.c
Go to the documentation of this file.
1 #include "rubysocket.h"
2 
3 #ifdef HAVE_GETIFADDRS
4 
5 /*
6  * ifa_flags is usually unsigned int.
7  * However it is uint64_t on SunOS 5.11 (OpenIndiana).
8  */
9 #ifdef HAVE_LONG_LONG
10 typedef unsigned LONG_LONG ifa_flags_t;
11 #define PRIxIFAFLAGS PRI_LL_PREFIX"x"
12 #define IFAFLAGS2NUM(flags) ULL2NUM(flags)
13 #else
14 typedef unsigned int ifa_flags_t;
15 #define PRIxIFAFLAGS "x"
16 #define IFAFLAGS2NUM(flags) UINT2NUM(flags)
17 #endif
18 
19 VALUE rb_cSockIfaddr;
20 
21 typedef struct rb_ifaddr_tag rb_ifaddr_t;
22 typedef struct rb_ifaddr_root_tag rb_ifaddr_root_t;
23 
24 struct rb_ifaddr_tag {
25  int ord;
26  struct ifaddrs *ifaddr;
27  rb_ifaddr_root_t *root;
28 };
29 
30 struct rb_ifaddr_root_tag {
31  int refcount;
32  int numifaddrs;
33  rb_ifaddr_t ary[1];
34 };
35 
36 static rb_ifaddr_root_t *
37 get_root(const rb_ifaddr_t *ifaddr)
38 {
39  return (rb_ifaddr_root_t *)((char *)&ifaddr[-ifaddr->ord] -
40  offsetof(rb_ifaddr_root_t, ary));
41 }
42 
43 static void
44 ifaddr_free(void *ptr)
45 {
46  rb_ifaddr_t *ifaddr = ptr;
47  rb_ifaddr_root_t *root = get_root(ifaddr);
48  root->refcount--;
49  if (root->refcount == 0) {
50  freeifaddrs(root->ary[0].ifaddr);
51  xfree(root);
52  }
53 }
54 
55 static size_t
56 ifaddr_memsize(const void *ptr)
57 {
58  const rb_ifaddr_t *ifaddr;
59  const rb_ifaddr_root_t *root;
60  ifaddr = ptr;
61  root = get_root(ifaddr);
62  return sizeof(rb_ifaddr_root_t) + (root->numifaddrs - 1) * sizeof(rb_ifaddr_t);
63 }
64 
65 static const rb_data_type_t ifaddr_type = {
66  "socket/ifaddr",
67  {0, ifaddr_free, ifaddr_memsize,},
68 };
69 
70 static inline rb_ifaddr_t *
71 check_ifaddr(VALUE self)
72 {
73  return rb_check_typeddata(self, &ifaddr_type);
74 }
75 
76 static rb_ifaddr_t *
77 get_ifaddr(VALUE self)
78 {
79  rb_ifaddr_t *rifaddr = check_ifaddr(self);
80 
81  if (!rifaddr) {
82  rb_raise(rb_eTypeError, "uninitialized ifaddr");
83  }
84  return rifaddr;
85 }
86 
87 static VALUE
88 rsock_getifaddrs(void)
89 {
90  int ret;
91  int numifaddrs, i;
92  struct ifaddrs *ifaddrs, *ifa;
93  rb_ifaddr_root_t *root;
94  VALUE result, addr;
95 
96  ret = getifaddrs(&ifaddrs);
97  if (ret == -1)
98  rb_sys_fail("getifaddrs");
99 
100  if (!ifaddrs) {
101  return rb_ary_new();
102  }
103 
104  numifaddrs = 0;
105  for (ifa = ifaddrs; ifa != NULL; ifa = ifa->ifa_next)
106  numifaddrs++;
107 
108  addr = TypedData_Wrap_Struct(rb_cSockIfaddr, &ifaddr_type, 0);
109  root = xmalloc(sizeof(rb_ifaddr_root_t) + (numifaddrs-1) * sizeof(rb_ifaddr_t));
110  root->refcount = 0;
111  root->numifaddrs = numifaddrs;
112 
113  ifa = ifaddrs;
114  for (i = 0; i < numifaddrs; i++) {
115  root->ary[i].ord = i;
116  root->ary[i].ifaddr = ifa;
117  root->ary[i].root = root;
118  ifa = ifa->ifa_next;
119  }
120  RTYPEDDATA_DATA(addr) = &root->ary[0];
121  root->refcount++;
122 
123  result = rb_ary_new2(numifaddrs);
124  rb_ary_push(result, addr);
125  for (i = 1; i < numifaddrs; i++) {
126  addr = TypedData_Wrap_Struct(rb_cSockIfaddr, &ifaddr_type, &root->ary[i]);
127  root->refcount++;
128  rb_ary_push(result, addr);
129  }
130 
131  return result;
132 }
133 
134 /*
135  * call-seq:
136  * ifaddr.name => string
137  *
138  * Returns the interface name of _ifaddr_.
139  */
140 
141 static VALUE
142 ifaddr_name(VALUE self)
143 {
144  rb_ifaddr_t *rifaddr = get_ifaddr(self);
145  struct ifaddrs *ifa = rifaddr->ifaddr;
146  return rb_str_new_cstr(ifa->ifa_name);
147 }
148 
149 #ifdef HAVE_IF_NAMETOINDEX
150 /*
151  * call-seq:
152  * ifaddr.ifindex => integer
153  *
154  * Returns the interface index of _ifaddr_.
155  */
156 
157 static VALUE
158 ifaddr_ifindex(VALUE self)
159 {
160  rb_ifaddr_t *rifaddr = get_ifaddr(self);
161  struct ifaddrs *ifa = rifaddr->ifaddr;
162  unsigned int ifindex = if_nametoindex(ifa->ifa_name);
163  if (ifindex == 0) {
164  rb_raise(rb_eArgError, "invalid interface name: %s", ifa->ifa_name);
165  }
166  return UINT2NUM(ifindex);
167 }
168 #else
169 #define ifaddr_ifindex rb_f_notimplement
170 #endif
171 
172 /*
173  * call-seq:
174  * ifaddr.flags => integer
175  *
176  * Returns the flags of _ifaddr_.
177  */
178 
179 static VALUE
180 ifaddr_flags(VALUE self)
181 {
182  rb_ifaddr_t *rifaddr = get_ifaddr(self);
183  struct ifaddrs *ifa = rifaddr->ifaddr;
184  return IFAFLAGS2NUM(ifa->ifa_flags);
185 }
186 
187 /*
188  * call-seq:
189  * ifaddr.addr => addrinfo
190  *
191  * Returns the address of _ifaddr_.
192  * nil is returned if address is not available in _ifaddr_.
193  */
194 
195 static VALUE
196 ifaddr_addr(VALUE self)
197 {
198  rb_ifaddr_t *rifaddr = get_ifaddr(self);
199  struct ifaddrs *ifa = rifaddr->ifaddr;
200  if (ifa->ifa_addr)
202  return Qnil;
203 }
204 
205 /*
206  * call-seq:
207  * ifaddr.netmask => addrinfo
208  *
209  * Returns the netmask address of _ifaddr_.
210  * nil is returned if netmask is not available in _ifaddr_.
211  */
212 
213 static VALUE
214 ifaddr_netmask(VALUE self)
215 {
216  rb_ifaddr_t *rifaddr = get_ifaddr(self);
217  struct ifaddrs *ifa = rifaddr->ifaddr;
218  if (ifa->ifa_netmask)
220  return Qnil;
221 }
222 
223 /*
224  * call-seq:
225  * ifaddr.broadaddr => addrinfo
226  *
227  * Returns the broadcast address of _ifaddr_.
228  * nil is returned if the flags doesn't have IFF_BROADCAST.
229  */
230 
231 static VALUE
232 ifaddr_broadaddr(VALUE self)
233 {
234  rb_ifaddr_t *rifaddr = get_ifaddr(self);
235  struct ifaddrs *ifa = rifaddr->ifaddr;
236  if ((ifa->ifa_flags & IFF_BROADCAST) && ifa->ifa_broadaddr)
238  return Qnil;
239 }
240 
241 /*
242  * call-seq:
243  * ifaddr.dstaddr => addrinfo
244  *
245  * Returns the destination address of _ifaddr_.
246  * nil is returned if the flags doesn't have IFF_POINTOPOINT.
247  */
248 
249 static VALUE
250 ifaddr_dstaddr(VALUE self)
251 {
252  rb_ifaddr_t *rifaddr = get_ifaddr(self);
253  struct ifaddrs *ifa = rifaddr->ifaddr;
254  if ((ifa->ifa_flags & IFF_POINTOPOINT) && ifa->ifa_dstaddr)
256  return Qnil;
257 }
258 
259 static void
260 ifaddr_inspect_flags(ifa_flags_t flags, VALUE result)
261 {
262  const char *sep = " ";
263 #define INSPECT_BIT(bit, name) \
264  if (flags & (bit)) { rb_str_catf(result, "%s" name, sep); flags &= ~(ifa_flags_t)(bit); sep = ","; }
265 #ifdef IFF_UP
266  INSPECT_BIT(IFF_UP, "UP")
267 #endif
268 #ifdef IFF_BROADCAST
269  INSPECT_BIT(IFF_BROADCAST, "BROADCAST")
270 #endif
271 #ifdef IFF_DEBUG
272  INSPECT_BIT(IFF_DEBUG, "DEBUG")
273 #endif
274 #ifdef IFF_LOOPBACK
275  INSPECT_BIT(IFF_LOOPBACK, "LOOPBACK")
276 #endif
277 #ifdef IFF_POINTOPOINT
278  INSPECT_BIT(IFF_POINTOPOINT, "POINTOPOINT")
279 #endif
280 #ifdef IFF_RUNNING
281  INSPECT_BIT(IFF_RUNNING, "RUNNING")
282 #endif
283 #ifdef IFF_NOARP
284  INSPECT_BIT(IFF_NOARP, "NOARP")
285 #endif
286 #ifdef IFF_PROMISC
287  INSPECT_BIT(IFF_PROMISC, "PROMISC")
288 #endif
289 #ifdef IFF_NOTRAILERS
290  INSPECT_BIT(IFF_NOTRAILERS, "NOTRAILERS")
291 #endif
292 #ifdef IFF_ALLMULTI
293  INSPECT_BIT(IFF_ALLMULTI, "ALLMULTI")
294 #endif
295 #ifdef IFF_SIMPLEX
296  INSPECT_BIT(IFF_SIMPLEX, "SIMPLEX")
297 #endif
298 #ifdef IFF_MASTER
299  INSPECT_BIT(IFF_MASTER, "MASTER")
300 #endif
301 #ifdef IFF_SLAVE
302  INSPECT_BIT(IFF_SLAVE, "SLAVE")
303 #endif
304 #ifdef IFF_MULTICAST
305  INSPECT_BIT(IFF_MULTICAST, "MULTICAST")
306 #endif
307 #ifdef IFF_PORTSEL
308  INSPECT_BIT(IFF_PORTSEL, "PORTSEL")
309 #endif
310 #ifdef IFF_AUTOMEDIA
311  INSPECT_BIT(IFF_AUTOMEDIA, "AUTOMEDIA")
312 #endif
313 #ifdef IFF_DYNAMIC
314  INSPECT_BIT(IFF_DYNAMIC, "DYNAMIC")
315 #endif
316 #ifdef IFF_LOWER_UP
317  INSPECT_BIT(IFF_LOWER_UP, "LOWER_UP")
318 #endif
319 #ifdef IFF_DORMANT
320  INSPECT_BIT(IFF_DORMANT, "DORMANT")
321 #endif
322 #ifdef IFF_ECHO
323  INSPECT_BIT(IFF_ECHO, "ECHO")
324 #endif
325 #undef INSPECT_BIT
326  if (flags) {
327  rb_str_catf(result, "%s%#"PRIxIFAFLAGS, sep, flags);
328  }
329 }
330 
331 /*
332  * call-seq:
333  * ifaddr.inspect => string
334  *
335  * Returns a string to show contents of _ifaddr_.
336  */
337 
338 static VALUE
339 ifaddr_inspect(VALUE self)
340 {
341  rb_ifaddr_t *rifaddr = get_ifaddr(self);
342  struct ifaddrs *ifa;
343  VALUE result;
344 
345  ifa = rifaddr->ifaddr;
346 
347  result = rb_str_new_cstr("#<");
348 
349  rb_str_append(result, rb_class_name(CLASS_OF(self)));
350  rb_str_cat2(result, " ");
351  rb_str_cat2(result, ifa->ifa_name);
352 
353  if (ifa->ifa_flags)
354  ifaddr_inspect_flags(ifa->ifa_flags, result);
355 
356  if (ifa->ifa_addr) {
357  rb_str_cat2(result, " ");
360  result);
361  }
362  if (ifa->ifa_netmask) {
363  rb_str_cat2(result, " netmask=");
366  result);
367  }
368 
369  if ((ifa->ifa_flags & IFF_BROADCAST) && ifa->ifa_broadaddr) {
370  rb_str_cat2(result, " broadcast=");
373  result);
374  }
375 
376  if ((ifa->ifa_flags & IFF_POINTOPOINT) && ifa->ifa_dstaddr) {
377  rb_str_cat2(result, " dstaddr=");
380  result);
381  }
382 
383  rb_str_cat2(result, ">");
384  return result;
385 }
386 #endif
387 
388 #ifdef HAVE_GETIFADDRS
389 /*
390  * call-seq:
391  * Socket.getifaddrs => [ifaddr1, ...]
392  *
393  * Returns an array of interface addresses.
394  * An element of the array is an instance of Socket::Ifaddr.
395  *
396  * This method can be used to find multicast-enabled interfaces:
397  *
398  * pp Socket.getifaddrs.reject {|ifaddr|
399  * !ifaddr.addr.ip? || (ifaddr.flags & Socket::IFF_MULTICAST == 0)
400  * }.map {|ifaddr| [ifaddr.name, ifaddr.ifindex, ifaddr.addr] }
401  * #=> [["eth0", 2, #<Addrinfo: 221.186.184.67>],
402  * # ["eth0", 2, #<Addrinfo: fe80::216:3eff:fe95:88bb%eth0>]]
403  *
404  * Example result on GNU/Linux:
405  * pp Socket.getifaddrs
406  * #=> [#<Socket::Ifaddr lo UP,LOOPBACK,RUNNING,0x10000 PACKET[protocol=0 lo hatype=772 HOST hwaddr=00:00:00:00:00:00]>,
407  * # #<Socket::Ifaddr eth0 UP,BROADCAST,RUNNING,MULTICAST,0x10000 PACKET[protocol=0 eth0 hatype=1 HOST hwaddr=00:16:3e:95:88:bb] broadcast=PACKET[protocol=0 eth0 hatype=1 HOST hwaddr=ff:ff:ff:ff:ff:ff]>,
408  * # #<Socket::Ifaddr sit0 NOARP PACKET[protocol=0 sit0 hatype=776 HOST hwaddr=00:00:00:00]>,
409  * # #<Socket::Ifaddr lo UP,LOOPBACK,RUNNING,0x10000 127.0.0.1 netmask=255.0.0.0>,
410  * # #<Socket::Ifaddr eth0 UP,BROADCAST,RUNNING,MULTICAST,0x10000 221.186.184.67 netmask=255.255.255.240 broadcast=221.186.184.79>,
411  * # #<Socket::Ifaddr lo UP,LOOPBACK,RUNNING,0x10000 ::1 netmask=ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff>,
412  * # #<Socket::Ifaddr eth0 UP,BROADCAST,RUNNING,MULTICAST,0x10000 fe80::216:3eff:fe95:88bb%eth0 netmask=ffff:ffff:ffff:ffff::>]
413  *
414  * Example result on FreeBSD:
415  * pp Socket.getifaddrs
416  * #=> [#<Socket::Ifaddr usbus0 UP,0x10000 LINK[usbus0]>,
417  * # #<Socket::Ifaddr re0 UP,BROADCAST,RUNNING,MULTICAST,0x800 LINK[re0 3a:d0:40:9a:fe:e8]>,
418  * # #<Socket::Ifaddr re0 UP,BROADCAST,RUNNING,MULTICAST,0x800 10.250.10.18 netmask=255.255.255.? (7 bytes for 16 bytes sockaddr_in) broadcast=10.250.10.255>,
419  * # #<Socket::Ifaddr re0 UP,BROADCAST,RUNNING,MULTICAST,0x800 fe80:2::38d0:40ff:fe9a:fee8 netmask=ffff:ffff:ffff:ffff::>,
420  * # #<Socket::Ifaddr re0 UP,BROADCAST,RUNNING,MULTICAST,0x800 2001:2e8:408:10::12 netmask=UNSPEC>,
421  * # #<Socket::Ifaddr plip0 POINTOPOINT,MULTICAST,0x800 LINK[plip0]>,
422  * # #<Socket::Ifaddr lo0 UP,LOOPBACK,RUNNING,MULTICAST LINK[lo0]>,
423  * # #<Socket::Ifaddr lo0 UP,LOOPBACK,RUNNING,MULTICAST ::1 netmask=ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff>,
424  * # #<Socket::Ifaddr lo0 UP,LOOPBACK,RUNNING,MULTICAST fe80:4::1 netmask=ffff:ffff:ffff:ffff::>,
425  * # #<Socket::Ifaddr lo0 UP,LOOPBACK,RUNNING,MULTICAST 127.0.0.1 netmask=255.?.?.? (5 bytes for 16 bytes sockaddr_in)>]
426  *
427  */
428 
429 static VALUE
431 {
432  return rsock_getifaddrs();
433 }
434 #else
435 #define socket_s_getifaddrs rb_f_notimplement
436 #endif
437 
438 void
440 {
441 #ifdef HAVE_GETIFADDRS
442  /*
443  * Document-class: Socket::Ifaddr
444  *
445  * Socket::Ifaddr represents a result of getifaddrs() function.
446  */
447  rb_cSockIfaddr = rb_define_class_under(rb_cSocket, "Ifaddr", rb_cData);
448  rb_define_method(rb_cSockIfaddr, "inspect", ifaddr_inspect, 0);
449  rb_define_method(rb_cSockIfaddr, "name", ifaddr_name, 0);
450  rb_define_method(rb_cSockIfaddr, "ifindex", ifaddr_ifindex, 0);
451  rb_define_method(rb_cSockIfaddr, "flags", ifaddr_flags, 0);
452  rb_define_method(rb_cSockIfaddr, "addr", ifaddr_addr, 0);
453  rb_define_method(rb_cSockIfaddr, "netmask", ifaddr_netmask, 0);
454  rb_define_method(rb_cSockIfaddr, "broadaddr", ifaddr_broadaddr, 0);
455  rb_define_method(rb_cSockIfaddr, "dstaddr", ifaddr_dstaddr, 0);
456 #endif
457 
459 }
RUBY_EXTERN VALUE rb_cData
Definition: ruby.h:1881
VALUE rsock_inspect_sockaddr(struct sockaddr *sockaddr_arg, socklen_t socklen, VALUE ret)
Definition: raddrinfo.c:1143
void rb_define_singleton_method(VALUE obj, const char *name, VALUE(*func)(ANYARGS), int argc)
Defines a singleton method for obj.
Definition: class.c:1716
VALUE rsock_sockaddr_obj(struct sockaddr *addr, socklen_t len)
#define CLASS_OF(v)
Definition: ruby.h:453
struct sockaddr * ifa_broadaddr
Definition: win32.h:223
#define TypedData_Wrap_Struct(klass, data_type, sval)
Definition: ruby.h:1169
VALUE rb_eTypeError
Definition: error.c:762
VALUE rb_ary_push(VALUE ary, VALUE item)
Definition: array.c:905
VALUE rb_define_class_under(VALUE outer, const char *name, VALUE super)
Defines a class under the namespace of outer.
Definition: class.c:693
void rb_raise(VALUE exc, const char *fmt,...)
Definition: error.c:2207
void rsock_init_sockifaddr(void)
Definition: ifaddr.c:439
struct sockaddr * ifa_addr
Definition: win32.h:221
#define socket_s_getifaddrs
Definition: ifaddr.c:435
void freeifaddrs(struct ifaddrs *)
Definition: win32.c:4190
#define rb_ary_new2
Definition: intern.h:90
socklen_t rsock_sockaddr_len(struct sockaddr *addr)
int getifaddrs(struct ifaddrs **)
Definition: win32.c:4103
VALUE rb_class_name(VALUE)
Definition: variable.c:443
struct ifaddrs * ifa_next
Definition: win32.h:218
VALUE rb_str_cat2(VALUE, const char *)
VALUE rb_ary_new(void)
Definition: array.c:493
#define UINT2NUM(x)
Definition: ruby.h:1539
u_int ifa_flags
Definition: win32.h:220
#define offsetof(p_type, field)
Definition: addrinfo.h:186
struct sockaddr * ifa_dstaddr
Definition: win32.h:224
VALUE rb_cSocket
Definition: init.c:22
#define Qnil
Definition: ruby.h:438
unsigned long VALUE
Definition: ruby.h:85
static VALUE result
Definition: nkf.c:40
VALUE rb_str_new_cstr(const char *)
Definition: string.c:770
void rb_sys_fail(const char *mesg)
Definition: error.c:2326
void * rb_check_typeddata(VALUE obj, const rb_data_type_t *data_type)
Definition: error.c:730
#define xmalloc
Definition: defines.h:183
VALUE rb_str_catf(VALUE str, const char *format,...)
Definition: sprintf.c:1480
struct sockaddr * ifa_netmask
Definition: win32.h:222
#define RTYPEDDATA_DATA(v)
Definition: ruby.h:1117
void void xfree(void *)
#define NULL
Definition: _sdbm.c:102
void rb_define_method(VALUE klass, const char *name, VALUE(*func)(ANYARGS), int argc)
Definition: class.c:1515
VALUE rb_str_append(VALUE, VALUE)
Definition: string.c:2818
VALUE rb_eArgError
Definition: error.c:763
char * ifa_name
Definition: win32.h:219
Definition: win32.h:217