1 /* 2 * Copyright 2006 Sun Microsystems, Inc. All rights reserved. 3 * Use is subject to license terms. 4 */ 5 6 /* 7 * Copyright (c) 1982, 1986 Regents of the University of California. 8 * All rights reserved. The Berkeley software License Agreement 9 * specifies the terms and conditions for redistribution. 10 */ 11 12 #ifndef _NET_IF_H 13 #define _NET_IF_H 14 15 #pragma ident "%Z%%M% %I% %E% SMI" 16 /* if.h 1.26 90/05/29 SMI; from UCB 7.1 6/4/86 */ 17 18 #include <sys/feature_tests.h> 19 20 #if !defined(_XOPEN_SOURCE) || defined(__EXTENSIONS__) 21 #include <sys/socket.h> 22 #include <netinet/in.h> 23 #if defined(_LP64) 24 #include <sys/types32.h> 25 #endif 26 #endif 27 28 #ifdef __cplusplus 29 extern "C" { 30 #endif 31 32 /* 33 * Structures defining a network interface, providing a packet 34 * transport mechanism (ala level 0 of the PUP protocols). 35 * 36 * Each interface accepts output datagrams of a specified maximum 37 * length, and provides higher level routines with input datagrams 38 * received from its medium. 39 * 40 * Output occurs when the routine if_output is called, with three parameters: 41 * (*ifp->if_output)(ifp, m, dst) 42 * Here m is the mbuf chain to be sent and dst is the destination address. 43 * The output routine encapsulates the supplied datagram if necessary, 44 * and then transmits it on its medium. 45 * 46 * On input, each interface unwraps the data received by it, and either 47 * places it on the input queue of a internetwork datagram routine 48 * and posts the associated software interrupt, or passes the datagram to a raw 49 * packet input routine. 50 * 51 * Routines exist for locating interfaces by their addresses 52 * or for locating a interface on a certain network, as well as more general 53 * routing and gateway routines maintaining information used to locate 54 * interfaces. These routines live in the files if.c and route.c 55 */ 56 57 #if !defined(_XOPEN_SOURCE) || defined(__EXTENSIONS__) 58 59 /* 60 * Structure defining a queue for a network interface. 61 * 62 * (Would like to call this struct ``if'', but C isn't PL/1.) 63 */ 64 struct ifnet { 65 char *if_name; /* name, e.g. ``en'' or ``lo'' */ 66 short if_unit; /* sub-unit for lower level driver */ 67 short if_mtu; /* maximum transmission unit */ 68 short if_flags; /* up/down, broadcast, etc. */ 69 short if_timer; /* time 'til if_watchdog called */ 70 ushort_t if_promisc; /* net # of requests for promisc mode */ 71 int if_metric; /* routing metric (external only) */ 72 struct ifaddr *if_addrlist; /* linked list of addresses per if */ 73 struct ifqueue { 74 struct mbuf *ifq_head; 75 struct mbuf *ifq_tail; 76 int ifq_len; 77 int ifq_maxlen; 78 int ifq_drops; 79 } if_snd; /* output queue */ 80 /* procedure handles */ 81 int (*if_init)(); /* init routine */ 82 int (*if_output)(); /* output routine */ 83 int (*if_ioctl)(); /* ioctl routine */ 84 int (*if_reset)(); /* bus reset routine */ 85 int (*if_watchdog)(); /* timer routine */ 86 /* generic interface statistics */ 87 int if_ipackets; /* packets received on interface */ 88 int if_ierrors; /* input errors on interface */ 89 int if_opackets; /* packets sent on interface */ 90 int if_oerrors; /* output errors on interface */ 91 int if_collisions; /* collisions on csma interfaces */ 92 /* end statistics */ 93 struct ifnet *if_next; 94 struct ifnet *if_upper; /* next layer up */ 95 struct ifnet *if_lower; /* next layer down */ 96 int (*if_input)(); /* input routine */ 97 int (*if_ctlin)(); /* control input routine */ 98 int (*if_ctlout)(); /* control output routine */ 99 struct map *if_memmap; /* rmap for interface specific memory */ 100 }; 101 102 /* 103 * NOTE : These flags are not directly used within IP. 104 * ip_if.h has definitions derived from this which is used within IP. 105 * If you define a flag here, you need to define one in ip_if.h before 106 * using the new flag in IP. Don't use these flags directly in IP. 107 */ 108 #define IFF_UP 0x0000000001 /* interface is up */ 109 #define IFF_BROADCAST 0x0000000002 /* broadcast address valid */ 110 #define IFF_DEBUG 0x0000000004 /* turn on debugging */ 111 #define IFF_LOOPBACK 0x0000000008 /* is a loopback net */ 112 113 #define IFF_POINTOPOINT 0x0000000010 /* interface is point-to-point link */ 114 #define IFF_NOTRAILERS 0x0000000020 /* avoid use of trailers */ 115 #define IFF_RUNNING 0x0000000040 /* resources allocated */ 116 #define IFF_NOARP 0x0000000080 /* no address resolution protocol */ 117 118 #define IFF_PROMISC 0x0000000100 /* receive all packets */ 119 #define IFF_ALLMULTI 0x0000000200 /* receive all multicast packets */ 120 #define IFF_INTELLIGENT 0x0000000400 /* protocol code on board */ 121 #define IFF_MULTICAST 0x0000000800 /* supports multicast */ 122 123 #define IFF_MULTI_BCAST 0x0000001000 /* multicast using broadcast address */ 124 #define IFF_UNNUMBERED 0x0000002000 /* non-unique address */ 125 #define IFF_DHCPRUNNING 0x0000004000 /* DHCP controls this interface */ 126 #define IFF_PRIVATE 0x0000008000 /* do not advertise */ 127 128 /* 129 * The following flags can't be grabbed or altered by SIOC[GS]IFFLAGS. 130 * Should use SIOC[GS]LIFFLAGS which has a larger flags field. 131 */ 132 #define IFF_NOXMIT 0x0000010000 /* Do not transmit packets */ 133 #define IFF_NOLOCAL 0x0000020000 /* No address - just on-link subnet */ 134 #define IFF_DEPRECATED 0x0000040000 /* interface address deprecated */ 135 #define IFF_ADDRCONF 0x0000080000 /* address from stateless addrconf */ 136 137 #define IFF_ROUTER 0x0000100000 /* router on this interface */ 138 #define IFF_NONUD 0x0000200000 /* No NUD on this interface */ 139 #define IFF_ANYCAST 0x0000400000 /* Anycast address */ 140 #define IFF_NORTEXCH 0x0000800000 /* Do not exchange routing info */ 141 142 #define IFF_IPV4 0x0001000000 /* IPv4 interface */ 143 #define IFF_IPV6 0x0002000000 /* IPv6 interface */ 144 #define IFF_MIPRUNNING 0x0004000000 /* Mobile IP controls this interface */ 145 #define IFF_NOFAILOVER 0x0008000000 /* Don't failover on NIC failure */ 146 147 #define IFF_FAILED 0x0010000000 /* NIC has failed */ 148 #define IFF_STANDBY 0x0020000000 /* Standby NIC to be used on failures */ 149 #define IFF_INACTIVE 0x0040000000 /* NIC active or not ? */ 150 /* Used for Standby NIC or */ 151 /* when FAILBACK is disabled by user */ 152 #define IFF_OFFLINE 0x0080000000 /* NIC has been offlined */ 153 154 /* 155 * The IFF_XRESOLV flag is an evolving interface and is subject 156 * to change without notice. 157 */ 158 #define IFF_XRESOLV 0x0100000000ll /* IPv6 external resolver */ 159 #define IFF_COS_ENABLED 0x0200000000ll /* If interface supports CoS marking */ 160 #define IFF_PREFERRED 0x0400000000ll /* Prefer as source address */ 161 #define IFF_TEMPORARY 0x0800000000ll /* RFC3041 */ 162 163 #define IFF_FIXEDMTU 0x1000000000ll /* MTU manually set with SIOCSLIFMTU */ 164 165 #define IFF_VIRTUAL 0x2000000000ll /* Does not send or receive packets */ 166 167 /* 168 * The IFF_MULTICAST flag indicates that the network can support the 169 * transmission and reception of higher-level (e.g., IP) multicast packets. 170 * It is independent of hardware support for multicasting; for example, 171 * point-to-point links or pure broadcast networks may well support 172 * higher-level multicasts. 173 */ 174 175 /* flags set internally only: */ 176 #define IFF_CANTCHANGE \ 177 (IFF_BROADCAST | IFF_POINTOPOINT | IFF_RUNNING | IFF_PROMISC | \ 178 IFF_MULTICAST | IFF_MULTI_BCAST | IFF_UNNUMBERED | IFF_IPV4 | \ 179 IFF_IPV6 | IFF_INACTIVE | IFF_FIXEDMTU | IFF_VIRTUAL | \ 180 IFF_LOOPBACK | IFF_ALLMULTI) 181 182 /* 183 * Output queues (ifp->if_snd) and internetwork datagram level (pup level 1) 184 * input routines have queues of messages stored on ifqueue structures 185 * (defined above). Entries are added to and deleted from these structures 186 * by these macros, which should be called with ipl raised to splimp(). 187 */ 188 #define IF_QFULL(ifq) ((ifq)->ifq_len >= (ifq)->ifq_maxlen) 189 #define IF_DROP(ifq) ((ifq)->ifq_drops++) 190 #define IF_ENQUEUE(ifq, m) { \ 191 (m)->m_act = 0; \ 192 if ((ifq)->ifq_tail == 0) \ 193 (ifq)->ifq_head = m; \ 194 else \ 195 (ifq)->ifq_tail->m_act = m; \ 196 (ifq)->ifq_tail = m; \ 197 (ifq)->ifq_len++; \ 198 } 199 #define IF_PREPEND(ifq, m) { \ 200 (m)->m_act = (ifq)->ifq_head; \ 201 if ((ifq)->ifq_tail == 0) \ 202 (ifq)->ifq_tail = (m); \ 203 (ifq)->ifq_head = (m); \ 204 (ifq)->ifq_len++; \ 205 } 206 207 /* 208 * Packets destined for level-1 protocol input routines 209 * have a pointer to the receiving interface prepended to the data. 210 * IF_DEQUEUEIF extracts and returns this pointer when dequeuing the packet. 211 * IF_ADJ should be used otherwise to adjust for its presence. 212 */ 213 #define IF_ADJ(m) { \ 214 (m)->m_off += sizeof (struct ifnet *); \ 215 (m)->m_len -= sizeof (struct ifnet *); \ 216 if ((m)->m_len == 0) { \ 217 struct mbuf *n; \ 218 MFREE((m), n); \ 219 (m) = n; \ 220 } \ 221 } 222 #define IF_DEQUEUEIF(ifq, m, ifp) { \ 223 (m) = (ifq)->ifq_head; \ 224 if (m) { \ 225 if (((ifq)->ifq_head = (m)->m_act) == 0) \ 226 (ifq)->ifq_tail = 0; \ 227 (m)->m_act = 0; \ 228 (ifq)->ifq_len--; \ 229 (ifp) = *(mtod((m), struct ifnet **)); \ 230 IF_ADJ(m); \ 231 } \ 232 } 233 #define IF_DEQUEUE(ifq, m) { \ 234 (m) = (ifq)->ifq_head; \ 235 if (m) { \ 236 if (((ifq)->ifq_head = (m)->m_act) == 0) \ 237 (ifq)->ifq_tail = 0; \ 238 (m)->m_act = 0; \ 239 (ifq)->ifq_len--; \ 240 } \ 241 } 242 243 #define IFQ_MAXLEN 50 244 #define IFNET_SLOWHZ 1 /* granularity is 1 second */ 245 246 /* 247 * The ifaddr structure contains information about one address 248 * of an interface. They are maintained by the different address families, 249 * are allocated and attached when an address is set, and are linked 250 * together so all addresses for an interface can be located. 251 */ 252 struct ifaddr { 253 struct sockaddr ifa_addr; /* address of interface */ 254 union { 255 struct sockaddr ifu_broadaddr; 256 struct sockaddr ifu_dstaddr; 257 } ifa_ifu; 258 #define ifa_broadaddr ifa_ifu.ifu_broadaddr /* broadcast address */ 259 #define ifa_dstaddr ifa_ifu.ifu_dstaddr /* other end of p-to-p link */ 260 struct ifnet *ifa_ifp; /* back-pointer to interface */ 261 struct ifaddr *ifa_next; /* next address for interface */ 262 }; 263 264 /* 265 * For SIOCLIF*ND ioctls. 266 * 267 * The lnr_state_* fields use the ND_* neighbor reachability states. 268 * The 3 different fields are for use with SIOCLIFSETND to cover the cases 269 * when 270 * A new entry is created 271 * The entry already exists and the link-layer address is the same 272 * The entry already exists and the link-layer address differs 273 * 274 * Use ND_UNCHANGED and ND_ISROUTER_UNCHANGED to not change any state. 275 */ 276 #define ND_MAX_HDW_LEN 64 277 typedef struct lif_nd_req { 278 struct sockaddr_storage lnr_addr; 279 uint8_t lnr_state_create; /* When creating */ 280 uint8_t lnr_state_same_lla; /* Update same addr */ 281 uint8_t lnr_state_diff_lla; /* Update w/ diff. */ 282 int lnr_hdw_len; 283 int lnr_flags; /* See below */ 284 /* padding because ia32 "long long"s are only 4-byte aligned. */ 285 int lnr_pad0; 286 char lnr_hdw_addr[ND_MAX_HDW_LEN]; 287 } lif_nd_req_t; 288 289 /* 290 * Neighbor reachability states 291 * Used with SIOCLIF*ND ioctls. 292 */ 293 #define ND_UNCHANGED 0 /* For ioctls that don't modify state */ 294 #define ND_INCOMPLETE 1 /* addr resolution in progress */ 295 #define ND_REACHABLE 2 /* have recently been reachable */ 296 #define ND_STALE 3 /* may be unreachable, don't do anything */ 297 #define ND_DELAY 4 /* wait for upper layer hint */ 298 #define ND_PROBE 5 /* send probes */ 299 #define ND_UNREACHABLE 6 /* delete this route */ 300 #define ND_INITIAL 7 /* ipv4: arp resolution has not been sent yet */ 301 302 #define ND_STATE_VALID_MIN 0 303 #define ND_STATE_VALID_MAX 7 304 305 /* 306 * lnr_flags value of lif_nd_req. 307 * Used with SIOCLIF*ND ioctls. 308 */ 309 #define NDF_ISROUTER_ON 0x1 310 #define NDF_ISROUTER_OFF 0x2 311 #define NDF_ANYCAST_ON 0x4 312 #define NDF_ANYCAST_OFF 0x8 313 #define NDF_PROXY_ON 0x10 314 #define NDF_PROXY_OFF 0x20 315 316 /* For SIOC[GS]LIFLNKINFO */ 317 typedef struct lif_ifinfo_req { 318 uint8_t lir_maxhops; 319 uint32_t lir_reachtime; /* Reachable time in msec */ 320 uint32_t lir_reachretrans; /* Retransmission timer msec */ 321 uint32_t lir_maxmtu; 322 } lif_ifinfo_req_t; 323 324 #endif /* !defined(_XOPEN_SOURCE) || defined(__EXTENSIONS__) */ 325 326 /* 327 * Maximum lengths of interface name and IPMP group name; these are the same 328 * for historical reasons. Note that the actual maximum length of a name is 329 * one byte less than these constants since the kernel always sets the final 330 * byte of lifr_name and lifr_groupname to NUL. 331 */ 332 #define _LIFNAMSIZ 32 333 334 #if !defined(_XOPEN_SOURCE) || defined(__EXTENSIONS__) 335 336 #define LIFNAMSIZ _LIFNAMSIZ 337 #define LIFGRNAMSIZ LIFNAMSIZ 338 339 /* 340 * Interface request structure used for socket 341 * ioctl's. All interface ioctl's must have parameter 342 * definitions which begin with ifr_name. The 343 * remainder may be interface specific. 344 * Note: This data structure uses 64bit type uint64_t which is not 345 * a valid type for strict ANSI/ISO C compilation for ILP32. 346 * Applications with ioctls using this structure that insist on 347 * building with strict ANSI/ISO C (-Xc) will need to be LP64. 348 */ 349 #if defined(_INT64_TYPE) 350 struct lifreq { 351 char lifr_name[LIFNAMSIZ]; /* if name, e.g. "en0" */ 352 union { 353 int lifru_addrlen; /* for subnet/token etc */ 354 uint_t lifru_ppa; /* SIOCSLIFNAME */ 355 } lifr_lifru1; 356 #define lifr_addrlen lifr_lifru1.lifru_addrlen 357 #define lifr_ppa lifr_lifru1.lifru_ppa /* Driver's ppa */ 358 uint_t lifr_movetoindex; /* FAILOVER/FAILBACK ifindex */ 359 union { 360 struct sockaddr_storage lifru_addr; 361 struct sockaddr_storage lifru_dstaddr; 362 struct sockaddr_storage lifru_broadaddr; 363 struct sockaddr_storage lifru_token; /* With lifr_addrlen */ 364 struct sockaddr_storage lifru_subnet; /* With lifr_addrlen */ 365 int lifru_index; /* interface index */ 366 uint64_t lifru_flags; /* Flags for SIOC?LIFFLAGS */ 367 int lifru_metric; 368 uint_t lifru_mtu; 369 char lifru_data[1]; /* interface dependent data */ 370 char lifru_enaddr[6]; 371 int lif_muxid[2]; /* mux id's for arp and ip */ 372 struct lif_nd_req lifru_nd_req; 373 struct lif_ifinfo_req lifru_ifinfo_req; 374 char lifru_groupname[LIFGRNAMSIZ]; /* SIOC[GS]LIFGROUPNAME */ 375 uint_t lifru_delay; /* SIOC[GS]LIFNOTIFYDELAY */ 376 zoneid_t lifru_zoneid; /* SIOC[GS]LIFZONE */ 377 } lifr_lifru; 378 379 #define lifr_addr lifr_lifru.lifru_addr /* address */ 380 #define lifr_dstaddr lifr_lifru.lifru_dstaddr /* other end of p-to-p link */ 381 #define lifr_broadaddr lifr_lifru.lifru_broadaddr /* broadcast address */ 382 #define lifr_token lifr_lifru.lifru_token /* address token */ 383 #define lifr_subnet lifr_lifru.lifru_subnet /* subnet prefix */ 384 #define lifr_index lifr_lifru.lifru_index /* interface index */ 385 #define lifr_flags lifr_lifru.lifru_flags /* flags */ 386 #define lifr_metric lifr_lifru.lifru_metric /* metric */ 387 #define lifr_mtu lifr_lifru.lifru_mtu /* mtu */ 388 #define lifr_data lifr_lifru.lifru_data /* for use by interface */ 389 #define lifr_enaddr lifr_lifru.lifru_enaddr /* ethernet address */ 390 #define lifr_index lifr_lifru.lifru_index /* interface index */ 391 #define lifr_ip_muxid lifr_lifru.lif_muxid[0] 392 #define lifr_arp_muxid lifr_lifru.lif_muxid[1] 393 #define lifr_nd lifr_lifru.lifru_nd_req /* SIOCLIF*ND */ 394 #define lifr_ifinfo lifr_lifru.lifru_ifinfo_req /* SIOC[GS]LIFLNKINFO */ 395 #define lifr_groupname lifr_lifru.lifru_groupname 396 #define lifr_delay lifr_lifru.lifru_delay 397 #define lifr_zoneid lifr_lifru.lifru_zoneid 398 }; 399 #endif /* defined(_INT64_TYPE) */ 400 401 /* 402 * Argument structure for SIOCT* address testing ioctls. 403 */ 404 struct sioc_addrreq { 405 struct sockaddr_storage sa_addr; /* Address to test */ 406 int sa_res; /* Result - 0/1 */ 407 int sa_pad; 408 }; 409 410 /* 411 * Argument structure used by mrouted to get src-grp pkt counts using 412 * SIOCGETLSGCNT. See <netinet/ip_mroute.h>. 413 */ 414 struct sioc_lsg_req { 415 struct sockaddr_storage slr_src; 416 struct sockaddr_storage slr_grp; 417 uint_t slr_pktcnt; 418 uint_t slr_bytecnt; 419 uint_t slr_wrong_if; 420 uint_t slr_pad; 421 }; 422 423 /* 424 * OBSOLETE: Replaced by struct lifreq. Supported for compatibility. 425 * 426 * Interface request structure used for socket 427 * ioctl's. All interface ioctl's must have parameter 428 * definitions which begin with ifr_name. The 429 * remainder may be interface specific. 430 */ 431 struct ifreq { 432 #define IFNAMSIZ 16 433 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 434 union { 435 struct sockaddr ifru_addr; 436 struct sockaddr ifru_dstaddr; 437 char ifru_oname[IFNAMSIZ]; /* other if name */ 438 struct sockaddr ifru_broadaddr; 439 int ifru_index; /* interface index */ 440 short ifru_flags; 441 int ifru_metric; 442 char ifru_data[1]; /* interface dependent data */ 443 char ifru_enaddr[6]; 444 int if_muxid[2]; /* mux id's for arp and ip */ 445 446 /* Struct for flags/ppa */ 447 struct ifr_ppaflags { 448 short ifrup_flags; /* Space of ifru_flags. */ 449 short ifrup_filler; 450 uint_t ifrup_ppa; 451 } ifru_ppaflags; 452 453 /* Struct for FDDI ioctl's */ 454 struct ifr_dnld_reqs { 455 uint32_t v_addr; 456 uint32_t m_addr; 457 uint32_t ex_addr; 458 uint32_t size; 459 } ifru_dnld_req; 460 461 /* Struct for FDDI stats */ 462 struct ifr_fddi_stats { 463 uint32_t stat_size; 464 uint32_t fddi_stats; 465 } ifru_fddi_stat; 466 467 struct ifr_netmapents { 468 uint32_t map_ent_size, /* size of netmap structure */ 469 entry_number; /* index into netmap list */ 470 uint32_t fddi_map_ent; /* pointer to user structure */ 471 } ifru_netmapent; 472 473 /* Field for generic ioctl for fddi */ 474 475 struct ifr_fddi_gen_struct { 476 uint32_t ifru_fddi_gioctl; /* field for gen ioctl */ 477 uint32_t ifru_fddi_gaddr; /* Generic ptr to a field */ 478 } ifru_fddi_gstruct; 479 480 } ifr_ifru; 481 482 #define ifr_addr ifr_ifru.ifru_addr /* address */ 483 #define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */ 484 #define ifr_oname ifr_ifru.ifru_oname /* other if name */ 485 #define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */ 486 #define ifr_flags ifr_ifru.ifru_flags /* flags */ 487 #define ifr_metric ifr_ifru.ifru_metric /* metric */ 488 #define ifr_data ifr_ifru.ifru_data /* for use by interface */ 489 #define ifr_enaddr ifr_ifru.ifru_enaddr /* ethernet address */ 490 #define ifr_index ifr_ifru.ifru_index /* interface index */ 491 /* For setting ppa */ 492 #define ifr_ppa ifr_ifru.ifru_ppaflags.ifrup_ppa 493 494 /* FDDI specific */ 495 #define ifr_dnld_req ifr_ifru.ifru_dnld_req 496 #define ifr_fddi_stat ifr_ifru.ifru_fddi_stat 497 #define ifr_fddi_netmap ifr_ifru.ifru_netmapent /* FDDI network map entries */ 498 #define ifr_fddi_gstruct ifr_ifru.ifru_fddi_gstruct 499 500 #define ifr_ip_muxid ifr_ifru.if_muxid[0] 501 #define ifr_arp_muxid ifr_ifru.if_muxid[1] 502 }; 503 504 /* Used by SIOCGLIFNUM. Uses same flags as in struct lifconf */ 505 struct lifnum { 506 sa_family_t lifn_family; 507 int lifn_flags; /* request specific interfaces */ 508 int lifn_count; /* Result */ 509 }; 510 511 /* 512 * Structure used in SIOCGLIFCONF request. 513 * Used to retrieve interface configuration 514 * for machine (useful for programs which 515 * must know all networks accessible) for a given address family. 516 * Using AF_UNSPEC will retrieve all address families. 517 */ 518 struct lifconf { 519 sa_family_t lifc_family; 520 int lifc_flags; /* request specific interfaces */ 521 int lifc_len; /* size of associated buffer */ 522 union { 523 caddr_t lifcu_buf; 524 struct lifreq *lifcu_req; 525 } lifc_lifcu; 526 #define lifc_buf lifc_lifcu.lifcu_buf /* buffer address */ 527 #define lifc_req lifc_lifcu.lifcu_req /* array of structures returned */ 528 }; 529 530 /* 531 * Structure used in SIOCGLIFSRCOF to get the interface 532 * configuration list for those interfaces that use an address 533 * hosted on the interface (set in lifs_ifindex), as the source 534 * address. 535 */ 536 struct lifsrcof { 537 uint_t lifs_ifindex; /* interface of interest */ 538 size_t lifs_maxlen; /* size of buffer: input */ 539 size_t lifs_len; /* size of buffer: output */ 540 union { 541 caddr_t lifsu_buf; 542 struct lifreq *lifsu_req; 543 } lifs_lifsu; 544 #define lifs_buf lifs_lifsu.lifsu_buf /* buffer address */ 545 #define lifs_req lifs_lifsu.lifsu_req /* array returned */ 546 }; 547 548 /* Flags */ 549 #define LIFC_NOXMIT 0x01 /* Include IFF_NOXMIT interfaces */ 550 #define LIFC_EXTERNAL_SOURCE 0x02 /* Exclude the interfaces which can't */ 551 /* be used to communicate outside the */ 552 /* node (exclude interfaces which are */ 553 /* IFF_NOXMIT, IFF_NOLOCAL, */ 554 /* IFF_LOOPBACK, IFF_DEPRECATED, or */ 555 /* not IFF_UP). Has priority over */ 556 /* LIFC_NOXMIT. */ 557 #define LIFC_TEMPORARY 0x04 /* Include IFF_TEMPORARY interfaces */ 558 #define LIFC_ALLZONES 0x08 /* Include all zones */ 559 /* (must be issued from global zone) */ 560 561 #if defined(_SYSCALL32) 562 563 struct lifconf32 { 564 sa_family_t lifc_family; 565 int lifc_flags; /* request specific interfaces */ 566 int32_t lifc_len; /* size of associated buffer */ 567 union { 568 caddr32_t lifcu_buf; 569 caddr32_t lifcu_req; 570 } lifc_lifcu; 571 }; 572 573 struct lifsrcof32 { 574 uint_t lifs_ifindex; /* interface of interest */ 575 size32_t lifs_maxlen; /* size of buffer: input */ 576 size32_t lifs_len; /* size of buffer: output */ 577 union { 578 caddr32_t lifsu_buf; 579 caddr32_t lifsu_req; 580 } lifs_lifsu; 581 }; 582 583 #endif /* _SYSCALL32 */ 584 585 /* 586 * OBSOLETE: Structure used in SIOCGIFCONF request. 587 * Used to retrieve interface configuration 588 * for machine (useful for programs which 589 * must know all networks accessible). 590 */ 591 struct ifconf { 592 int ifc_len; /* size of associated buffer */ 593 union { 594 caddr_t ifcu_buf; 595 struct ifreq *ifcu_req; 596 } ifc_ifcu; 597 #define ifc_buf ifc_ifcu.ifcu_buf /* buffer address */ 598 #define ifc_req ifc_ifcu.ifcu_req /* array of structures returned */ 599 }; 600 601 #if defined(_SYSCALL32) 602 603 struct ifconf32 { 604 int32_t ifc_len; /* size of associated buffer */ 605 union { 606 caddr32_t ifcu_buf; 607 caddr32_t ifcu_req; 608 } ifc_ifcu; 609 }; 610 611 #endif /* _SYSCALL32 */ 612 613 typedef struct if_data { 614 /* generic interface information */ 615 uchar_t ifi_type; /* ethernet, tokenring, etc */ 616 uchar_t ifi_addrlen; /* media address length */ 617 uchar_t ifi_hdrlen; /* media header length */ 618 uint_t ifi_mtu; /* maximum transmission unit */ 619 uint_t ifi_metric; /* routing metric (external only) */ 620 uint_t ifi_baudrate; /* linespeed */ 621 /* volatile statistics */ 622 uint_t ifi_ipackets; /* packets received on interface */ 623 uint_t ifi_ierrors; /* input errors on interface */ 624 uint_t ifi_opackets; /* packets sent on interface */ 625 uint_t ifi_oerrors; /* output errors on interface */ 626 uint_t ifi_collisions; /* collisions on csma interfaces */ 627 uint_t ifi_ibytes; /* total number of octets received */ 628 uint_t ifi_obytes; /* total number of octets sent */ 629 uint_t ifi_imcasts; /* packets received via multicast */ 630 uint_t ifi_omcasts; /* packets sent via multicast */ 631 uint_t ifi_iqdrops; /* dropped on input, this interface */ 632 uint_t ifi_noproto; /* destined for unsupported protocol */ 633 #if defined(_LP64) 634 struct timeval32 ifi_lastchange; /* last updated */ 635 #else 636 struct timeval ifi_lastchange; /* last updated */ 637 #endif 638 } if_data_t; 639 640 /* 641 * Message format for use in obtaining information about interfaces 642 * from the routing socket 643 */ 644 typedef struct if_msghdr { 645 ushort_t ifm_msglen; /* to skip over non-understood messages */ 646 uchar_t ifm_version; /* future binary compatibility */ 647 uchar_t ifm_type; /* message type */ 648 int ifm_addrs; /* like rtm_addrs */ 649 int ifm_flags; /* value of if_flags */ 650 ushort_t ifm_index; /* index for associated ifp */ 651 struct if_data ifm_data; /* statistics and other data about if */ 652 } if_msghdr_t; 653 654 /* 655 * Message format for use in obtaining information about interface addresses 656 * from the routing socket 657 */ 658 typedef struct ifa_msghdr { 659 ushort_t ifam_msglen; /* to skip over non-understood messages */ 660 uchar_t ifam_version; /* future binary compatibility */ 661 uchar_t ifam_type; /* message type */ 662 int ifam_addrs; /* like rtm_addrs */ 663 int ifam_flags; /* route flags */ 664 ushort_t ifam_index; /* index for associated ifp */ 665 int ifam_metric; /* value of ipif_metric */ 666 } ifa_msghdr_t; 667 668 /* currently tunnels only support IPv4 or IPv6 */ 669 enum ifta_proto { 670 IFTAP_INVALID, 671 IFTAP_IPV4, 672 IFTAP_IPV6 673 }; 674 675 #define IFTUN_SECINFOLEN 8 /* In units of 32-bit words. */ 676 #define IFTUN_VERSION 1 /* Current version number. */ 677 678 /* 679 * Used by tunneling module to get/set a tunnel parameters using 680 * SIOCTUN[SG]PARAM. 681 * 682 * There is a version number and an array of uint32_t at the end of this 683 * ioctl because in a perfect world, the ipsec_req_t would be inside 684 * tun_addreq. Since this file is independent of IP (and IPsec), I have to 685 * just leave room there, and have the appropriate handlers deal with the 686 * security information. 687 * 688 * In the future, the sockaddr types and the ta_vers could be used together 689 * to determine the nature of the security information that is at the end 690 * of this ioctl. 691 */ 692 struct iftun_req { 693 char ifta_lifr_name[LIFNAMSIZ]; /* if name */ 694 struct sockaddr_storage ifta_saddr; /* source address */ 695 struct sockaddr_storage ifta_daddr; /* destination address */ 696 uint_t ifta_flags; /* See below */ 697 /* IP version information is read only */ 698 enum ifta_proto ifta_upper; /* IP version above tunnel */ 699 enum ifta_proto ifta_lower; /* IP version below tunnel */ 700 uint_t ifta_vers; /* Version number */ 701 uint32_t ifta_secinfo[IFTUN_SECINFOLEN]; /* Security prefs. */ 702 int16_t ifta_encap_lim; /* Encapsulation limit */ 703 uint8_t ifta_hop_limit; /* Hop limit */ 704 uint8_t ifta_spare0; /* Pad to 64-bit boundary */ 705 uint32_t ifta_spare1; 706 }; 707 708 /* ifta_flags are set to indicate which members are valid */ 709 #define IFTUN_SRC 0x01 710 #define IFTUN_DST 0x02 711 #define IFTUN_SECURITY 0x04 /* Pay attention to secinfo */ 712 #define IFTUN_ENCAP 0x08 /* Pay attention to encap */ 713 #define IFTUN_HOPLIMIT 0x10 /* Pay attention to hoplimit */ 714 715 #endif /* !defined(_XOPEN_SOURCE) || defined(__EXTENSIONS__) */ 716 717 /* 718 * The if_nameindex structure holds the interface index value about 719 * a single interface. An array of this structure is used to return 720 * all interfaces and indexes. 721 */ 722 struct if_nameindex { 723 unsigned if_index; /* positive interface index */ 724 char *if_name; /* if name, e.g. "en0" */ 725 }; 726 727 /* Interface index identification API definitions */ 728 extern unsigned if_nametoindex(const char *); 729 extern char *if_indextoname(unsigned, char *); 730 extern struct if_nameindex *if_nameindex(void); 731 extern void if_freenameindex(struct if_nameindex *); 732 733 #define IF_NAMESIZE _LIFNAMSIZ 734 735 #ifdef __cplusplus 736 } 737 #endif 738 739 #endif /* _NET_IF_H */ 740