2009-01-14 03:18:31 +00:00
|
|
|
.\" Copyright (c) 2008 Petr Baudis <pasky@suse.cz>
|
|
|
|
.\" and copyright (c) 2009, Linux Foundation, written by Michael Kerrisk
|
|
|
|
.\" <mtk.manpages@gmail.com>
|
|
|
|
.\"
|
intro.1, _exit.2, access.2, alarm.2, alloc_hugepages.2, arch_prctl.2, bind.2, chdir.2, chmod.2, chown.2, chroot.2, clock_getres.2, clock_nanosleep.2, close.2, connect.2, delete_module.2, dup.2, execve.2, exit_group.2, faccessat.2, fchmodat.2, fchownat.2, fcntl.2, fork.2, fstatat.2, fsync.2, futimesat.2, get_robust_list.2, getdents.2, getdomainname.2, getgid.2, getgroups.2, gethostname.2, getpagesize.2, getpid.2, getresuid.2, getrlimit.2, getrusage.2, gettid.2, gettimeofday.2, getuid.2, getunwind.2, idle.2, init_module.2, intro.2, iopl.2, kcmp.2, kexec_load.2, kill.2, link.2, linkat.2, llseek.2, lookup_dcookie.2, madvise.2, mincore.2, mkdirat.2, mknodat.2, mmap.2, mmap2.2, mount.2, mprotect.2, mq_getsetattr.2, msgctl.2, msgget.2, msgop.2, msync.2, nice.2, open.2, openat.2, pause.2, perfmonctl.2, personality.2, pipe.2, poll.2, posix_fadvise.2, prctl.2, pread.2, process_vm_readv.2, quotactl.2, read.2, readahead.2, readdir.2, readlinkat.2, readv.2, reboot.2, recvmmsg.2, remap_file_pages.2, rename.2, renameat.2, rmdir.2, rt_sigqueueinfo.2, select.2, select_tut.2, semctl.2, semget.2, semop.2, sendmmsg.2, set_tid_address.2, seteuid.2, setfsgid.2, setfsuid.2, setgid.2, setresuid.2, setuid.2, setup.2, sgetmask.2, shmctl.2, shmget.2, shmop.2, sigaction.2, sigaltstack.2, signal.2, sigpending.2, sigprocmask.2, sigreturn.2, sigsuspend.2, sigwaitinfo.2, splice.2, stat.2, statfs.2, stime.2, subpage_prot.2, swapon.2, symlink.2, symlinkat.2, sync.2, sync_file_range.2, syscalls.2, sysctl.2, sysfs.2, syslog.2, tee.2, time.2, timer_create.2, timer_delete.2, timer_getoverrun.2, timer_settime.2, times.2, tkill.2, umask.2, umount.2, uname.2, unlink.2, unlinkat.2, uselib.2, ustat.2, utime.2, utimensat.2, vfork.2, vhangup.2, vm86.2, vmsplice.2, wait.2, wait4.2, write.2, CPU_SET.3, INFINITY.3, abort.3, abs.3, acos.3, acosh.3, adjtime.3, aio_init.3, asin.3, asinh.3, asprintf.3, assert.3, assert_perror.3, atan.3, atan2.3, atanh.3, atexit.3, atof.3, atoi.3, basename.3, bcmp.3, bcopy.3, bindresvport.3, bsd_signal.3, bsearch.3, bstring.3, byteorder.3, bzero.3, catgets.3, catopen.3, cbrt.3, ceil.3, clearenv.3, clock.3, clock_getcpuclockid.3, closedir.3, confstr.3, copysign.3, cos.3, cosh.3, ctermid.3, ctime.3, difftime.3, dirfd.3, div.3, dl_iterate_phdr.3, dprintf.3, drand48.3, drand48_r.3, dysize.3, ecvt.3, ecvt_r.3, end.3, endian.3, erf.3, erfc.3, ether_aton.3, euidaccess.3, exit.3, exp.3, exp10.3, exp2.3, expm1.3, fabs.3, fcloseall.3, fexecve.3, ffs.3, fgetgrent.3, fgetpwent.3, finite.3, flockfile.3, floor.3, fmod.3, fnmatch.3, fopencookie.3, fpathconf.3, fpurge.3, frexp.3, fseeko.3, ftok.3, futimes.3, gcvt.3, get_nprocs_conf.3, getaddrinfo.3, getaddrinfo_a.3, getauxval.3, getcontext.3, getcwd.3, getdate.3, getdirentries.3, getdtablesize.3, getenv.3, getfsent.3, getgrent.3, getgrnam.3, getgrouplist.3, gethostbyname.3, gethostid.3, getifaddrs.3, getipnodebyname.3, getline.3, getlogin.3, getmntent.3, getnetent.3, getnetent_r.3, getopt.3, getprotoent.3, getprotoent_r.3, getpw.3, getpwent.3, getpwnam.3, getrpcent_r.3, gets.3, getservent.3, getservent_r.3, getumask.3, getusershell.3, getutmp.3, getw.3, glob.3, gnu_get_libc_version.3, gsignal.3, hypot.3, if_nameindex.3, if_nametoindex.3, ilogb.3, index.3, inet.3, inet_ntop.3, inet_pton.3, infnan.3, initgroups.3, insque.3, intro.3, isalpha.3, isatty.3, j0.3, ldexp.3, localeconv.3, log.3, log10.3, log1p.3, log2.3, logb.3, lrint.3, lround.3, lsearch.3, lseek64.3, makecontext.3, makedev.3, mallinfo.3, malloc.3, malloc_get_state.3, malloc_info.3, malloc_stats.3, malloc_trim.3, malloc_usable_size.3, mallopt.3, matherr.3, mcheck.3, memccpy.3, memchr.3, memcmp.3, memcpy.3, memfrob.3, memmem.3, memmove.3, memset.3, mkdtemp.3, mkfifo.3, mkfifoat.3, mkstemp.3, mktemp.3, modf.3, mq_close.3, mq_getattr.3, mq_notify.3, mq_open.3, mq_receive.3, mq_send.3, mq_unlink.3, mtrace.3, on_exit.3, opendir.3, posix_fallocate.3, posix_memalign.3, posix_openpt.3, pow.3, pow10.3, profil.3, psignal.3, pthread_attr_init.3, pthread_attr_setaffinity_np.3, pthread_attr_setdetachstate.3, pthread_attr_setguardsize.3, pthread_attr_setinheritsched.3, pthread_attr_setschedparam.3, pthread_attr_setschedpolicy.3, pthread_attr_setscope.3, pthread_attr_setstack.3, pthread_attr_setstackaddr.3, pthread_attr_setstacksize.3, pthread_cancel.3, pthread_cleanup_push.3, pthread_cleanup_push_defer_np.3, pthread_create.3, pthread_detach.3, pthread_equal.3, pthread_exit.3, pthread_getattr_np.3, pthread_getcpuclockid.3, pthread_join.3, pthread_kill.3, pthread_kill_other_threads_np.3, pthread_self.3, pthread_setaffinity_np.3, pthread_setcancelstate.3, pthread_setconcurrency.3, pthread_setname_np.3, pthread_setschedparam.3, pthread_setschedprio.3, pthread_sigmask.3, pthread_sigqueue.3, pthread_testcancel.3, pthread_tryjoin_np.3, pthread_yield.3, putenv.3, putpwent.3, puts.3, qecvt.3, qsort.3, raise.3, rand.3, random.3, random_r.3, re_comp.3, readdir.3, realpath.3, regex.3, remainder.3, remove.3, resolver.3, rewinddir.3, rint.3, round.3, scalb.3, scalbln.3, scandir.3, sched_getcpu.3, seekdir.3, sem_close.3, sem_destroy.3, sem_getvalue.3, sem_init.3, sem_open.3, sem_post.3, sem_unlink.3, sem_wait.3, setenv.3, setlocale.3, setlogmask.3, shm_open.3, siginterrupt.3, sigpause.3, sigqueue.3, sigset.3, sigsetops.3, sigvec.3, sigwait.3, sin.3, sinh.3, sleep.3, sockatmark.3, sqrt.3, statvfs.3, stdio_ext.3, stpcpy.3, strcasecmp.3, strcat.3, strchr.3, strcmp.3, strcoll.3, strcpy.3, strdup.3, strerror.3, strfry.3, strftime.3, string.3, strlen.3, strpbrk.3, strptime.3, strsep.3, strsignal.3, strspn.3, strstr.3, strtok.3, strtol.3, strtoul.3, strverscmp.3, strxfrm.3, swab.3, sysconf.3, syslog.3, system.3, sysv_signal.3, tan.3, tanh.3, tcgetpgrp.3, tcgetsid.3, telldir.3, tempnam.3, timegm.3, timeradd.3, tmpfile.3, tmpnam.3, toascii.3, toupper.3, trunc.3, tsearch.3, ttyslot.3, tzset.3, ulimit.3, undocumented.3, unlocked_stdio.3, usleep.3, y0.3, cpuid.4, full.4, initrd.4, mouse.4, msr.4, sd.4, st.4, acct.5, core.5, services.5, slabinfo.5, aio.7, capabilities.7, credentials.7, feature_test_macros.7, hier.7, inotify.7, libc.7, locale.7, man-pages.7, man.7, math_error.7, mq_overview.7, numa.7, path_resolution.7, pipe.7, pthreads.7, pty.7, rtld-audit.7, sem_overview.7, shm_overview.7, sigevent.7, signal.7, suffixes.7, svipc.7, termio.7, time.7, udplite.7, units.7, uri.7, sln.8: s/LICENSE_START(verbatim)/LICENSE_START(VERBATIM)/
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-03-10 09:29:01 +00:00
|
|
|
.\" %%%LICENSE_START(VERBATIM)
|
2009-01-14 03:18:31 +00:00
|
|
|
.\" Permission is granted to make and distribute verbatim copies of this
|
|
|
|
.\" manual provided the copyright notice and this permission notice are
|
|
|
|
.\" preserved on all copies.
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to copy and distribute modified versions of this
|
|
|
|
.\" manual under the conditions for verbatim copying, provided that the
|
|
|
|
.\" entire resulting derived work is distributed under the terms of a
|
|
|
|
.\" permission notice identical to this one.
|
|
|
|
.\"
|
|
|
|
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
|
|
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
|
|
.\" responsibility for errors or omissions, or for damages resulting from
|
|
|
|
.\" the use of the information contained herein. The author(s) may not
|
|
|
|
.\" have taken the same level of care in the production of this manual,
|
|
|
|
.\" which is licensed free of charge, as they might when working
|
|
|
|
.\" professionally.
|
|
|
|
.\"
|
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
intro.1, _exit.2, access.2, alarm.2, alloc_hugepages.2, arch_prctl.2, bind.2, chdir.2, chmod.2, chown.2, chroot.2, clock_getres.2, clock_nanosleep.2, close.2, connect.2, delete_module.2, dup.2, execve.2, exit_group.2, faccessat.2, fchmodat.2, fchownat.2, fcntl.2, fork.2, fstatat.2, fsync.2, futimesat.2, get_robust_list.2, getdents.2, getdomainname.2, getgid.2, getgroups.2, gethostname.2, getpagesize.2, getpid.2, getresuid.2, getrlimit.2, getrusage.2, gettid.2, gettimeofday.2, getuid.2, getunwind.2, idle.2, init_module.2, intro.2, iopl.2, kcmp.2, kexec_load.2, kill.2, link.2, linkat.2, llseek.2, lookup_dcookie.2, madvise.2, mincore.2, mkdirat.2, mknodat.2, mmap.2, mmap2.2, mount.2, mprotect.2, mq_getsetattr.2, msgctl.2, msgget.2, msgop.2, msync.2, nice.2, open.2, openat.2, pause.2, perfmonctl.2, personality.2, pipe.2, poll.2, posix_fadvise.2, prctl.2, pread.2, process_vm_readv.2, quotactl.2, read.2, readahead.2, readdir.2, readlinkat.2, readv.2, reboot.2, recvmmsg.2, remap_file_pages.2, rename.2, renameat.2, rmdir.2, rt_sigqueueinfo.2, select.2, select_tut.2, semctl.2, semget.2, semop.2, sendmmsg.2, set_tid_address.2, seteuid.2, setfsgid.2, setfsuid.2, setgid.2, setresuid.2, setuid.2, setup.2, sgetmask.2, shmctl.2, shmget.2, shmop.2, sigaction.2, sigaltstack.2, signal.2, sigpending.2, sigprocmask.2, sigreturn.2, sigsuspend.2, sigwaitinfo.2, splice.2, stat.2, statfs.2, stime.2, subpage_prot.2, swapon.2, symlink.2, symlinkat.2, sync.2, sync_file_range.2, syscalls.2, sysctl.2, sysfs.2, syslog.2, tee.2, time.2, timer_create.2, timer_delete.2, timer_getoverrun.2, timer_settime.2, times.2, tkill.2, umask.2, umount.2, uname.2, unlink.2, unlinkat.2, uselib.2, ustat.2, utime.2, utimensat.2, vfork.2, vhangup.2, vm86.2, vmsplice.2, wait.2, wait4.2, write.2, CPU_SET.3, INFINITY.3, abort.3, abs.3, acos.3, acosh.3, adjtime.3, aio_init.3, asin.3, asinh.3, asprintf.3, assert.3, assert_perror.3, atan.3, atan2.3, atanh.3, atexit.3, atof.3, atoi.3, basename.3, bcmp.3, bcopy.3, bindresvport.3, bsd_signal.3, bsearch.3, bstring.3, byteorder.3, bzero.3, catgets.3, catopen.3, cbrt.3, ceil.3, clearenv.3, clock.3, clock_getcpuclockid.3, closedir.3, confstr.3, copysign.3, cos.3, cosh.3, ctermid.3, ctime.3, difftime.3, dirfd.3, div.3, dl_iterate_phdr.3, dprintf.3, drand48.3, drand48_r.3, dysize.3, ecvt.3, ecvt_r.3, end.3, endian.3, erf.3, erfc.3, ether_aton.3, euidaccess.3, exit.3, exp.3, exp10.3, exp2.3, expm1.3, fabs.3, fcloseall.3, fexecve.3, ffs.3, fgetgrent.3, fgetpwent.3, finite.3, flockfile.3, floor.3, fmod.3, fnmatch.3, fopencookie.3, fpathconf.3, fpurge.3, frexp.3, fseeko.3, ftok.3, futimes.3, gcvt.3, get_nprocs_conf.3, getaddrinfo.3, getaddrinfo_a.3, getauxval.3, getcontext.3, getcwd.3, getdate.3, getdirentries.3, getdtablesize.3, getenv.3, getfsent.3, getgrent.3, getgrnam.3, getgrouplist.3, gethostbyname.3, gethostid.3, getifaddrs.3, getipnodebyname.3, getline.3, getlogin.3, getmntent.3, getnetent.3, getnetent_r.3, getopt.3, getprotoent.3, getprotoent_r.3, getpw.3, getpwent.3, getpwnam.3, getrpcent_r.3, gets.3, getservent.3, getservent_r.3, getumask.3, getusershell.3, getutmp.3, getw.3, glob.3, gnu_get_libc_version.3, gsignal.3, hypot.3, if_nameindex.3, if_nametoindex.3, ilogb.3, index.3, inet.3, inet_ntop.3, inet_pton.3, infnan.3, initgroups.3, insque.3, intro.3, isalpha.3, isatty.3, j0.3, ldexp.3, localeconv.3, log.3, log10.3, log1p.3, log2.3, logb.3, lrint.3, lround.3, lsearch.3, lseek64.3, makecontext.3, makedev.3, mallinfo.3, malloc.3, malloc_get_state.3, malloc_info.3, malloc_stats.3, malloc_trim.3, malloc_usable_size.3, mallopt.3, matherr.3, mcheck.3, memccpy.3, memchr.3, memcmp.3, memcpy.3, memfrob.3, memmem.3, memmove.3, memset.3, mkdtemp.3, mkfifo.3, mkfifoat.3, mkstemp.3, mktemp.3, modf.3, mq_close.3, mq_getattr.3, mq_notify.3, mq_open.3, mq_receive.3, mq_send.3, mq_unlink.3, mtrace.3, on_exit.3, opendir.3, posix_fallocate.3, posix_memalign.3, posix_openpt.3, pow.3, pow10.3, profil.3, psignal.3, pthread_attr_init.3, pthread_attr_setaffinity_np.3, pthread_attr_setdetachstate.3, pthread_attr_setguardsize.3, pthread_attr_setinheritsched.3, pthread_attr_setschedparam.3, pthread_attr_setschedpolicy.3, pthread_attr_setscope.3, pthread_attr_setstack.3, pthread_attr_setstackaddr.3, pthread_attr_setstacksize.3, pthread_cancel.3, pthread_cleanup_push.3, pthread_cleanup_push_defer_np.3, pthread_create.3, pthread_detach.3, pthread_equal.3, pthread_exit.3, pthread_getattr_np.3, pthread_getcpuclockid.3, pthread_join.3, pthread_kill.3, pthread_kill_other_threads_np.3, pthread_self.3, pthread_setaffinity_np.3, pthread_setcancelstate.3, pthread_setconcurrency.3, pthread_setname_np.3, pthread_setschedparam.3, pthread_setschedprio.3, pthread_sigmask.3, pthread_sigqueue.3, pthread_testcancel.3, pthread_tryjoin_np.3, pthread_yield.3, putenv.3, putpwent.3, puts.3, qecvt.3, qsort.3, raise.3, rand.3, random.3, random_r.3, re_comp.3, readdir.3, realpath.3, regex.3, remainder.3, remove.3, resolver.3, rewinddir.3, rint.3, round.3, scalb.3, scalbln.3, scandir.3, sched_getcpu.3, seekdir.3, sem_close.3, sem_destroy.3, sem_getvalue.3, sem_init.3, sem_open.3, sem_post.3, sem_unlink.3, sem_wait.3, setenv.3, setlocale.3, setlogmask.3, shm_open.3, siginterrupt.3, sigpause.3, sigqueue.3, sigset.3, sigsetops.3, sigvec.3, sigwait.3, sin.3, sinh.3, sleep.3, sockatmark.3, sqrt.3, statvfs.3, stdio_ext.3, stpcpy.3, strcasecmp.3, strcat.3, strchr.3, strcmp.3, strcoll.3, strcpy.3, strdup.3, strerror.3, strfry.3, strftime.3, string.3, strlen.3, strpbrk.3, strptime.3, strsep.3, strsignal.3, strspn.3, strstr.3, strtok.3, strtol.3, strtoul.3, strverscmp.3, strxfrm.3, swab.3, sysconf.3, syslog.3, system.3, sysv_signal.3, tan.3, tanh.3, tcgetpgrp.3, tcgetsid.3, telldir.3, tempnam.3, timegm.3, timeradd.3, tmpfile.3, tmpnam.3, toascii.3, toupper.3, trunc.3, tsearch.3, ttyslot.3, tzset.3, ulimit.3, undocumented.3, unlocked_stdio.3, usleep.3, y0.3, cpuid.4, full.4, initrd.4, mouse.4, msr.4, sd.4, st.4, acct.5, core.5, services.5, slabinfo.5, aio.7, capabilities.7, credentials.7, feature_test_macros.7, hier.7, inotify.7, libc.7, locale.7, man-pages.7, man.7, math_error.7, mq_overview.7, numa.7, path_resolution.7, pipe.7, pthreads.7, pty.7, rtld-audit.7, sem_overview.7, shm_overview.7, sigevent.7, signal.7, suffixes.7, svipc.7, termio.7, time.7, udplite.7, units.7, uri.7, sln.8: Global fix: Add LICENSE_START(verbatim)
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-03-10 09:28:40 +00:00
|
|
|
.\" %%%LICENSE_END
|
2013-03-12 11:13:02 +00:00
|
|
|
.\"
|
2009-01-14 03:18:31 +00:00
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
.\" are met:
|
|
|
|
.\"
|
|
|
|
.\" 2008-12-08 Petr Baudis <pasky@suse.cz>
|
|
|
|
.\" Rewrite the BSD manpage in the Linux man pages style and account
|
|
|
|
.\" for glibc specificities, provide an example.
|
|
|
|
.\" 2009-01-14 mtk, many edits and changes, rewrote example program.
|
|
|
|
.\"
|
2012-11-11 12:02:28 +00:00
|
|
|
.TH GETIFADDRS 3 2012-11-11 "GNU" "Linux Programmer's Manual"
|
2009-01-14 03:18:31 +00:00
|
|
|
.SH NAME
|
|
|
|
getifaddrs, freeifaddrs \- get interface addresses
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
.B #include <sys/types.h>
|
|
|
|
.B #include <ifaddrs.h>
|
|
|
|
.sp
|
|
|
|
.BI "int getifaddrs(struct ifaddrs **" "ifap" );
|
|
|
|
.sp
|
|
|
|
.BI "void freeifaddrs(struct ifaddrs *" "ifa" );
|
|
|
|
.fi
|
|
|
|
.SH DESCRIPTION
|
|
|
|
The
|
|
|
|
.BR getifaddrs ()
|
|
|
|
function creates a linked list of structures describing
|
|
|
|
the network interfaces of the local system,
|
|
|
|
and stores the address of the first item of the list in
|
|
|
|
.IR *ifap .
|
|
|
|
The list consists of
|
|
|
|
.I ifaddrs
|
|
|
|
structures, defined as follows:
|
|
|
|
.sp
|
|
|
|
.in +4n
|
|
|
|
.nf
|
|
|
|
struct ifaddrs {
|
|
|
|
struct ifaddrs *ifa_next; /* Next item in list */
|
|
|
|
char *ifa_name; /* Name of interface */
|
|
|
|
unsigned int ifa_flags; /* Flags from SIOCGIFFLAGS */
|
|
|
|
struct sockaddr *ifa_addr; /* Address of interface */
|
|
|
|
struct sockaddr *ifa_netmask; /* Netmask of interface */
|
|
|
|
union {
|
|
|
|
struct sockaddr *ifu_broadaddr;
|
|
|
|
/* Broadcast address of interface */
|
|
|
|
struct sockaddr *ifu_dstaddr;
|
|
|
|
/* Point-to-point destination address */
|
|
|
|
} ifa_ifu;
|
|
|
|
#define ifa_broadaddr ifa_ifu.ifu_broadaddr
|
|
|
|
#define ifa_dstaddr ifa_ifu.ifu_dstaddr
|
|
|
|
void *ifa_data; /* Address-specific data */
|
|
|
|
};
|
|
|
|
.fi
|
|
|
|
.in
|
|
|
|
.PP
|
|
|
|
The
|
|
|
|
.I ifa_next
|
|
|
|
field contains a pointer to the next structure on the list,
|
|
|
|
or NULL if this is the last item of the list.
|
|
|
|
.PP
|
|
|
|
The
|
|
|
|
.I ifa_name
|
|
|
|
points to the null-terminated interface name.
|
|
|
|
.\" The constant
|
|
|
|
.\" .B IF NAMESIZE
|
|
|
|
.\" indicates the maximum length of this field.
|
|
|
|
.PP
|
|
|
|
The
|
|
|
|
.I ifa_flags
|
|
|
|
field contains the interface flags, as returned by the
|
|
|
|
.B SIOCGIFFLAGS
|
|
|
|
.BR ioctl (2)
|
|
|
|
operation (see
|
|
|
|
.BR netdevice (7)
|
|
|
|
for a list of these flags).
|
|
|
|
.PP
|
|
|
|
The
|
|
|
|
.I ifa_addr
|
|
|
|
field points to a structure containing the interface address.
|
|
|
|
(The
|
|
|
|
.I sa_family
|
ioctl_list.2, mount.2, select_tut.2, stat.2, getifaddrs.3, pthread_cleanup_push_defer_np.3, pthread_getcpuclockid.3, proc.5, bootparam.7: Global fix: s/sub-/sub/
The tendency in English, as prescribed in style guides like
Chicago MoS, is towards removing hyphens after prefixes
like "sub-" etc.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 17:36:10 +00:00
|
|
|
subfield should be consulted to determine the format of the
|
2009-01-14 03:18:31 +00:00
|
|
|
address structure.)
|
epoll_ctl.2, execve.2, recv.2, timer_create.2, wait.2, argz_add.3, basename.3, dlopen.3, exec.3, fopencookie.3, fts.3, getaddrinfo.3, getcwd.3, gethostbyname.3, getifaddrs.3, getipnodebyname.3, getlogin.3, getnetent.3, getprotoent.3, getrpcent.3, getservent.3, getusershell.3, glob.3, if_nameindex.3, inet_ntop.3, lio_listio.3, mblen.3, mbrlen.3, mbrtowc.3, mbsinit.3, mbsnrtowcs.3, mbsrtowcs.3, mbstowcs.3, mq_notify.3, ptsname.3, realpath.3, setnetgrent.3, sigvec.3, strsignal.3, strtok.3, wcrtomb.3, wcsnrtombs.3, wcsrtombs.3, wcstombs.3, xdr.3: Global fix of "NULL pointer"
Change "NULL pointer: to "NUL " or null pointer".
POSIX uses the term "null pointer", not "NULL pointer".
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-03 02:01:50 +00:00
|
|
|
This field may contain a null pointer.
|
2009-01-14 03:18:31 +00:00
|
|
|
.PP
|
|
|
|
The
|
|
|
|
.I ifa_netmask
|
|
|
|
field points to a structure containing the netmask associated with
|
|
|
|
.IR ifa_addr ,
|
|
|
|
if applicable for the address family.
|
epoll_ctl.2, execve.2, recv.2, timer_create.2, wait.2, argz_add.3, basename.3, dlopen.3, exec.3, fopencookie.3, fts.3, getaddrinfo.3, getcwd.3, gethostbyname.3, getifaddrs.3, getipnodebyname.3, getlogin.3, getnetent.3, getprotoent.3, getrpcent.3, getservent.3, getusershell.3, glob.3, if_nameindex.3, inet_ntop.3, lio_listio.3, mblen.3, mbrlen.3, mbrtowc.3, mbsinit.3, mbsnrtowcs.3, mbsrtowcs.3, mbstowcs.3, mq_notify.3, ptsname.3, realpath.3, setnetgrent.3, sigvec.3, strsignal.3, strtok.3, wcrtomb.3, wcsnrtombs.3, wcsrtombs.3, wcstombs.3, xdr.3: Global fix of "NULL pointer"
Change "NULL pointer: to "NUL " or null pointer".
POSIX uses the term "null pointer", not "NULL pointer".
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-01-03 02:01:50 +00:00
|
|
|
This field may contain a null pointer.
|
2009-01-14 03:18:31 +00:00
|
|
|
.PP
|
|
|
|
Depending on whether the bit
|
|
|
|
.B IFF_BROADCAST
|
|
|
|
or
|
|
|
|
.B IFF_POINTOPOINT
|
|
|
|
is set in
|
|
|
|
.I ifa_flags
|
|
|
|
(only one can be set at a time),
|
|
|
|
either
|
|
|
|
.I ifa_broadaddr
|
|
|
|
will contain the broadcast address associated with
|
|
|
|
.I ifa_addr
|
|
|
|
(if applicable for the address family) or
|
|
|
|
.I ifa_dstaddr
|
|
|
|
will contain the destination address of the point-to-point interface.
|
|
|
|
.PP
|
|
|
|
The
|
|
|
|
.I ifa_data
|
|
|
|
field points to a buffer containing address-family-specific data;
|
|
|
|
this field may be NULL if there is no such data for this interface.
|
|
|
|
.PP
|
|
|
|
The data returned by
|
|
|
|
.BR getifaddrs ()
|
|
|
|
is dynamically allocated and should be freed using
|
|
|
|
.BR freeifaddrs ()
|
|
|
|
when no longer needed.
|
2012-03-12 15:06:57 +00:00
|
|
|
.SH RETURN VALUE
|
2009-01-14 03:18:31 +00:00
|
|
|
On success,
|
|
|
|
.BR getifaddrs ()
|
|
|
|
returns zero;
|
fallocate.2, kexec_load.2, poll.2, spu_run.2, atan2.3, cbrt.3, clock_getcpuclockid.3, end.3, frexp.3, getgrouplist.3, getifaddrs.3, matherr.3, modf.3, pow.3, pthread_getattr_np.3, pthread_getcpuclockid.3, sched_getcpu.3, tgamma.3, mouse.4, proc.5, feature_test_macros.7, spufs.7: Global fix: properly escape minus sign
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2011-09-10 01:57:53 +00:00
|
|
|
on error, \-1 is returned, and
|
2009-01-14 03:18:31 +00:00
|
|
|
.I errno
|
|
|
|
is set appropriately.
|
|
|
|
.SH ERRORS
|
|
|
|
.BR getifaddrs ()
|
|
|
|
may fail and set
|
|
|
|
.I errno
|
|
|
|
for any of the errors specified for
|
|
|
|
.BR socket (2),
|
|
|
|
.BR bind (2),
|
|
|
|
.BR getsockname (2),
|
|
|
|
.BR recvmsg (2),
|
|
|
|
.BR sendto (2),
|
|
|
|
.BR malloc (3),
|
|
|
|
or
|
|
|
|
.BR realloc (3).
|
|
|
|
.SH VERSIONS
|
|
|
|
The
|
|
|
|
.BR getifaddrs ()
|
|
|
|
function first appeared in glibc 2.3, but before glibc 2.3.3,
|
intro.1, _syscall.2, access.2, arch_prctl.2, cacheflush.2, chown.2, clock_getres.2, clone.2, create_module.2, fcntl.2, flock.2, get_kernel_syms.2, get_robust_list.2, get_thread_area.2, getcpu.2, getpriority.2, getrlimit.2, getrusage.2, ioprio_set.2, kexec_load.2, madvise.2, mbind.2, migrate_pages.2, mknod.2, mmap.2, mount.2, move_pages.2, mprotect.2, open.2, pause.2, pciconfig_read.2, perf_event_open.2, prctl.2, ptrace.2, query_module.2, read.2, reboot.2, recv.2, s390_runtime_instr.2, sched_setscheduler.2, select_tut.2, send.2, set_mempolicy.2, setfsgid.2, setfsuid.2, sigaction.2, spu_create.2, spu_run.2, stime.2, swapon.2, syslog.2, timer_create.2, timer_getoverrun.2, times.2, tkill.2, umount.2, unimplemented.2, ustat.2, vm86.2, wait.2, abs.3, aio_read.3, aio_write.3, bsd_signal.3, catgets.3, clearenv.3, cmsg.3, dbopen.3, dirfd.3, dlopen.3, exec.3, fenv.3, ferror.3, fmemopen.3, fnmatch.3, fopen.3, futimes.3, getaddrinfo.3, getifaddrs.3, getipnodebyname.3, hsearch.3, if_nameindex.3, inet_pton.3, mblen.3, mbrlen.3, mbsrtowcs.3, mbtowc.3, mcheck.3, memfrob.3, mq_notify.3, netlink.3, posix_memalign.3, printf.3, pthread_attr_setscope.3, pthread_cleanup_push.3, pthread_kill_other_threads_np.3, pthread_self.3, pthread_setcancelstate.3, pthread_setconcurrency.3, raise.3, resolver.3, rpc.3, rtime.3, rtnetlink.3, scanf.3, setbuf.3, setnetgrent.3, shm_open.3, sigpause.3, sigset.3, sigwait.3, sockatmark.3, strcasecmp.3, strcmp.3, strdup.3, strftime.3, strptime.3, strsignal.3, strverscmp.3, sysv_signal.3, termios.3, wcrtomb.3, wcsnlen.3, wcsnrtombs.3, wcsrtombs.3, wctomb.3, wprintf.3, console_codes.4, cpuid.4, msr.4, rtc.4, sk98lin.4, st.4, tty.4, charmap.5, core.5, elf.5, hosts.equiv.5, proc.5, resolv.conf.5, services.5, slabinfo.5, arp.7, bootparam.7, capabilities.7, charsets.7, cpuset.7, ddp.7, epoll.7, feature_test_macros.7, futex.7, hier.7, icmp.7, inotify.7, ip.7, ipv6.7, man-pages.7, mdoc.7, mdoc.samples.7, netdevice.7, netlink.7, numa.7, packet.7, path_resolution.7, posixoptions.7, pthreads.7, raw.7, rtld-audit.7, rtnetlink.7, sem_overview.7, sigevent.7, socket.7, spufs.7, tcp.7, udp.7, unicode.7, uri.7, utf-8.7, intro.8, ldconfig.8, sync.8: Global fix: fix placement of word "only"
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-03-31 08:53:00 +00:00
|
|
|
the implementation supported only IPv4 addresses;
|
2009-01-14 03:18:31 +00:00
|
|
|
IPv6 support was added in glibc 2.3.3.
|
intro.1, _syscall.2, access.2, arch_prctl.2, cacheflush.2, chown.2, clock_getres.2, clone.2, create_module.2, fcntl.2, flock.2, get_kernel_syms.2, get_robust_list.2, get_thread_area.2, getcpu.2, getpriority.2, getrlimit.2, getrusage.2, ioprio_set.2, kexec_load.2, madvise.2, mbind.2, migrate_pages.2, mknod.2, mmap.2, mount.2, move_pages.2, mprotect.2, open.2, pause.2, pciconfig_read.2, perf_event_open.2, prctl.2, ptrace.2, query_module.2, read.2, reboot.2, recv.2, s390_runtime_instr.2, sched_setscheduler.2, select_tut.2, send.2, set_mempolicy.2, setfsgid.2, setfsuid.2, sigaction.2, spu_create.2, spu_run.2, stime.2, swapon.2, syslog.2, timer_create.2, timer_getoverrun.2, times.2, tkill.2, umount.2, unimplemented.2, ustat.2, vm86.2, wait.2, abs.3, aio_read.3, aio_write.3, bsd_signal.3, catgets.3, clearenv.3, cmsg.3, dbopen.3, dirfd.3, dlopen.3, exec.3, fenv.3, ferror.3, fmemopen.3, fnmatch.3, fopen.3, futimes.3, getaddrinfo.3, getifaddrs.3, getipnodebyname.3, hsearch.3, if_nameindex.3, inet_pton.3, mblen.3, mbrlen.3, mbsrtowcs.3, mbtowc.3, mcheck.3, memfrob.3, mq_notify.3, netlink.3, posix_memalign.3, printf.3, pthread_attr_setscope.3, pthread_cleanup_push.3, pthread_kill_other_threads_np.3, pthread_self.3, pthread_setcancelstate.3, pthread_setconcurrency.3, raise.3, resolver.3, rpc.3, rtime.3, rtnetlink.3, scanf.3, setbuf.3, setnetgrent.3, shm_open.3, sigpause.3, sigset.3, sigwait.3, sockatmark.3, strcasecmp.3, strcmp.3, strdup.3, strftime.3, strptime.3, strsignal.3, strverscmp.3, sysv_signal.3, termios.3, wcrtomb.3, wcsnlen.3, wcsnrtombs.3, wcsrtombs.3, wctomb.3, wprintf.3, console_codes.4, cpuid.4, msr.4, rtc.4, sk98lin.4, st.4, tty.4, charmap.5, core.5, elf.5, hosts.equiv.5, proc.5, resolv.conf.5, services.5, slabinfo.5, arp.7, bootparam.7, capabilities.7, charsets.7, cpuset.7, ddp.7, epoll.7, feature_test_macros.7, futex.7, hier.7, icmp.7, inotify.7, ip.7, ipv6.7, man-pages.7, mdoc.7, mdoc.samples.7, netdevice.7, netlink.7, numa.7, packet.7, path_resolution.7, posixoptions.7, pthreads.7, raw.7, rtld-audit.7, rtnetlink.7, sem_overview.7, sigevent.7, socket.7, spufs.7, tcp.7, udp.7, unicode.7, uri.7, utf-8.7, intro.8, ldconfig.8, sync.8: Global fix: fix placement of word "only"
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-03-31 08:53:00 +00:00
|
|
|
Support of address families other than IPv4 is available only
|
2009-01-22 20:22:00 +00:00
|
|
|
on kernels that support netlink.
|
2009-01-14 03:18:31 +00:00
|
|
|
.SH CONFORMING TO
|
|
|
|
Not in POSIX.1-2001.
|
|
|
|
This function first appeared in BSDi and is
|
|
|
|
present on the BSD systems, but with slightly different
|
|
|
|
semantics documented\(emreturning one entry per interface,
|
|
|
|
not per address.
|
|
|
|
This means
|
|
|
|
.I ifa_addr
|
|
|
|
and other fields can actually be NULL if the interface has no address,
|
|
|
|
and no link-level address is returned if the interface has an IP address
|
|
|
|
assigned.
|
|
|
|
Also, the way of choosing either
|
|
|
|
.I ifa_broadaddr
|
|
|
|
or
|
|
|
|
.I ifa_dstaddr
|
|
|
|
differs on various systems.
|
|
|
|
.\" , but the BSD-derived documentation generally
|
|
|
|
.\" appears to be confused and obsolete on this point.
|
|
|
|
.\" i.e., commonly it still says one of them will be NULL, even if
|
|
|
|
.\" the ifa_ifu union is already present
|
|
|
|
.SH NOTES
|
|
|
|
The addresses returned on Linux will usually be the IPv4 and IPv6 addresses
|
|
|
|
assigned to the interface, but also one
|
|
|
|
.B AF_PACKET
|
|
|
|
address per interface containing lower-level details about the interface
|
|
|
|
and its physical layer.
|
|
|
|
In this case, the
|
|
|
|
.I ifa_data
|
|
|
|
field may contain a pointer to a
|
2012-11-11 12:02:28 +00:00
|
|
|
.IR "struct rtnl_link_stats" ,
|
|
|
|
defined in
|
|
|
|
.IR <linux/if_link.h>
|
|
|
|
(in Linux 2.4 and earlier,
|
2009-01-14 03:18:31 +00:00
|
|
|
.IR "struct net_device_stats" ,
|
|
|
|
defined in
|
2012-11-11 12:02:28 +00:00
|
|
|
.IR <linux/netdevice.h> ),
|
2009-01-14 03:18:31 +00:00
|
|
|
which contains various interface attributes and statistics.
|
|
|
|
.SH EXAMPLE
|
|
|
|
The program below demonstrates the use of
|
|
|
|
.BR getifaddrs (),
|
|
|
|
.BR freeifaddrs (),
|
|
|
|
and
|
2009-01-22 20:22:00 +00:00
|
|
|
.BR getnameinfo (3).
|
2009-01-14 03:18:31 +00:00
|
|
|
Here is what we see when running this program on one system:
|
|
|
|
.in +4n
|
|
|
|
.nf
|
|
|
|
|
|
|
|
$ \fB./a.out\fP
|
2014-02-25 07:56:27 +00:00
|
|
|
lo AF_PACKET (17)
|
|
|
|
tx_packets = 524; rx_packets = 524
|
|
|
|
tx_bytes = 38788; rx_bytes = 38788
|
|
|
|
wlp3s0 AF_PACKET (17)
|
|
|
|
tx_packets = 108391; rx_packets = 130245
|
|
|
|
tx_bytes = 30420659; rx_bytes = 94230014
|
|
|
|
em1 AF_PACKET (17)
|
|
|
|
tx_packets = 0; rx_packets = 0
|
|
|
|
tx_bytes = 0; rx_bytes = 0
|
|
|
|
lo AF_INET (2)
|
|
|
|
address: <127.0.0.1>
|
|
|
|
wlp3s0 AF_INET (2)
|
|
|
|
address: <192.168.235.137>
|
|
|
|
lo AF_INET6 (10)
|
|
|
|
address: <::1>
|
|
|
|
wlp3s0 AF_INET6 (10)
|
|
|
|
address: <fe80::7ee9:d3ff:fef5:1a91%wlp3s0>
|
2009-01-14 03:18:31 +00:00
|
|
|
.fi
|
|
|
|
.in
|
|
|
|
.SS Program source
|
|
|
|
\&
|
|
|
|
.nf
|
2014-02-25 07:56:27 +00:00
|
|
|
#define _GNU_SOURCE /* To get defns of NI_MAXSERV and NI_MAXHOST */
|
2009-01-14 03:18:31 +00:00
|
|
|
#include <arpa/inet.h>
|
|
|
|
#include <sys/socket.h>
|
|
|
|
#include <netdb.h>
|
|
|
|
#include <ifaddrs.h>
|
|
|
|
#include <stdio.h>
|
|
|
|
#include <stdlib.h>
|
|
|
|
#include <unistd.h>
|
2014-02-25 07:56:27 +00:00
|
|
|
#include <linux/if_link.h>
|
2009-01-14 03:18:31 +00:00
|
|
|
|
2014-02-25 07:56:27 +00:00
|
|
|
int main(int argc, char *argv[])
|
2009-01-14 03:18:31 +00:00
|
|
|
{
|
2009-01-22 20:08:56 +00:00
|
|
|
struct ifaddrs *ifaddr, *ifa;
|
2014-02-25 07:56:27 +00:00
|
|
|
int family, s, n;
|
2009-01-14 03:18:31 +00:00
|
|
|
char host[NI_MAXHOST];
|
|
|
|
|
|
|
|
if (getifaddrs(&ifaddr) == \-1) {
|
|
|
|
perror("getifaddrs");
|
|
|
|
exit(EXIT_FAILURE);
|
|
|
|
}
|
|
|
|
|
2009-01-22 20:08:56 +00:00
|
|
|
/* Walk through linked list, maintaining head pointer so we
|
|
|
|
can free list later */
|
|
|
|
|
2014-02-25 07:56:27 +00:00
|
|
|
for (ifa = ifaddr, n = 0; ifa != NULL; ifa = ifa\->ifa_next, n++) {
|
2010-10-06 05:34:09 +00:00
|
|
|
if (ifa\->ifa_addr == NULL)
|
|
|
|
continue;
|
|
|
|
|
2009-01-22 20:08:56 +00:00
|
|
|
family = ifa\->ifa_addr\->sa_family;
|
2009-01-14 03:18:31 +00:00
|
|
|
|
|
|
|
/* Display interface name and family (including symbolic
|
|
|
|
form of the latter for the common families) */
|
|
|
|
|
2014-02-25 07:56:27 +00:00
|
|
|
printf("%\-8s %s (%d)\\n",
|
|
|
|
ifa\->ifa_name,
|
|
|
|
(family == AF_PACKET) ? "AF_PACKET" :
|
|
|
|
(family == AF_INET) ? "AF_INET" :
|
|
|
|
(family == AF_INET6) ? "AF_INET6" : "???",
|
|
|
|
family);
|
2009-01-14 03:18:31 +00:00
|
|
|
|
|
|
|
/* For an AF_INET* interface address, display the address */
|
|
|
|
|
|
|
|
if (family == AF_INET || family == AF_INET6) {
|
2009-01-22 20:08:56 +00:00
|
|
|
s = getnameinfo(ifa\->ifa_addr,
|
2009-01-14 03:18:31 +00:00
|
|
|
(family == AF_INET) ? sizeof(struct sockaddr_in) :
|
|
|
|
sizeof(struct sockaddr_in6),
|
2014-02-25 07:56:27 +00:00
|
|
|
host, NI_MAXHOST,
|
|
|
|
NULL, 0, NI_NUMERICHOST);
|
2009-01-14 03:18:31 +00:00
|
|
|
if (s != 0) {
|
|
|
|
printf("getnameinfo() failed: %s\\n", gai_strerror(s));
|
|
|
|
exit(EXIT_FAILURE);
|
|
|
|
}
|
2014-02-25 07:56:27 +00:00
|
|
|
|
|
|
|
printf("\\t\\taddress: <%s>\\n", host);
|
|
|
|
|
|
|
|
} else if (family == AF_PACKET && ifa\->ifa_data != NULL) {
|
|
|
|
struct rtnl_link_stats *stats = ifa\->ifa_data;
|
|
|
|
|
|
|
|
printf("\\t\\ttx_packets = %10u; rx_packets = %10u\\n"
|
|
|
|
"\\t\\ttx_bytes = %10u; rx_bytes = %10u\\n",
|
|
|
|
stats\->tx_packets, stats\->rx_packets,
|
|
|
|
stats\->tx_bytes, stats\->rx_bytes);
|
2009-01-14 03:18:31 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
freeifaddrs(ifaddr);
|
|
|
|
exit(EXIT_SUCCESS);
|
|
|
|
}
|
|
|
|
.fi
|
|
|
|
.SH SEE ALSO
|
|
|
|
.BR bind (2),
|
|
|
|
.BR getsockname (2),
|
|
|
|
.BR socket (2),
|
|
|
|
.BR packet (7),
|
|
|
|
.BR ifconfig (8)
|