1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21 
  22 /*
  23  * Copyright (c) 1991, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Copyright (c) 1990 Mentat Inc.
  25  */
  26 
  27 #ifndef _INET_IP_H
  28 #define _INET_IP_H
  29 
  30 #ifdef  __cplusplus
  31 extern "C" {
  32 #endif
  33 
  34 #include <sys/isa_defs.h>
  35 #include <sys/types.h>
  36 #include <inet/mib2.h>
  37 #include <inet/nd.h>
  38 #include <sys/atomic.h>
  39 #include <net/if_dl.h>
  40 #include <net/if.h>
  41 #include <netinet/ip.h>
  42 #include <netinet/igmp.h>
  43 #include <sys/neti.h>
  44 #include <sys/hook.h>
  45 #include <sys/hook_event.h>
  46 #include <sys/hook_impl.h>
  47 #include <inet/ip_stack.h>
  48 
  49 #ifdef _KERNEL
  50 #include <netinet/ip6.h>
  51 #include <sys/avl.h>
  52 #include <sys/list.h>
  53 #include <sys/vmem.h>
  54 #include <sys/squeue.h>
  55 #include <net/route.h>
  56 #include <sys/systm.h>
  57 #include <net/radix.h>
  58 #include <sys/modhash.h>
  59 
  60 #ifdef DEBUG
  61 #define CONN_DEBUG
  62 #endif
  63 
  64 #define IP_DEBUG
  65 /*
  66  * The mt-streams(9F) flags for the IP module; put here so that other
  67  * "drivers" that are actually IP (e.g., ICMP, UDP) can use the same set
  68  * of flags.
  69  */
  70 #define IP_DEVMTFLAGS D_MP
  71 #endif  /* _KERNEL */
  72 
  73 #define IP_MOD_NAME     "ip"
  74 #define IP_DEV_NAME     "/dev/ip"
  75 #define IP6_DEV_NAME    "/dev/ip6"
  76 
  77 #define UDP_MOD_NAME    "udp"
  78 #define UDP_DEV_NAME    "/dev/udp"
  79 #define UDP6_DEV_NAME   "/dev/udp6"
  80 
  81 #define TCP_MOD_NAME    "tcp"
  82 #define TCP_DEV_NAME    "/dev/tcp"
  83 #define TCP6_DEV_NAME   "/dev/tcp6"
  84 
  85 #define SCTP_MOD_NAME   "sctp"
  86 
  87 #ifndef _IPADDR_T
  88 #define _IPADDR_T
  89 typedef uint32_t ipaddr_t;
  90 #endif
  91 
  92 /* Number of bits in an address */
  93 #define IP_ABITS                32
  94 #define IPV4_ABITS              IP_ABITS
  95 #define IPV6_ABITS              128
  96 #define IP_MAX_HW_LEN   40
  97 
  98 #define IP_HOST_MASK            (ipaddr_t)0xffffffffU
  99 
 100 #define IP_CSUM(mp, off, sum)           (~ip_cksum(mp, off, sum) & 0xFFFF)
 101 #define IP_CSUM_PARTIAL(mp, off, sum)   ip_cksum(mp, off, sum)
 102 #define IP_BCSUM_PARTIAL(bp, len, sum)  bcksum(bp, len, sum)
 103 
 104 #define ILL_FRAG_HASH_TBL_COUNT ((unsigned int)64)
 105 #define ILL_FRAG_HASH_TBL_SIZE  (ILL_FRAG_HASH_TBL_COUNT * sizeof (ipfb_t))
 106 
 107 #define IPV4_ADDR_LEN                   4
 108 #define IP_ADDR_LEN                     IPV4_ADDR_LEN
 109 #define IP_ARP_PROTO_TYPE               0x0800
 110 
 111 #define IPV4_VERSION                    4
 112 #define IP_VERSION                      IPV4_VERSION
 113 #define IP_SIMPLE_HDR_LENGTH_IN_WORDS   5
 114 #define IP_SIMPLE_HDR_LENGTH            20
 115 #define IP_MAX_HDR_LENGTH               60
 116 
 117 #define IP_MAX_OPT_LENGTH (IP_MAX_HDR_LENGTH-IP_SIMPLE_HDR_LENGTH)
 118 
 119 #define IP_MIN_MTU                      (IP_MAX_HDR_LENGTH + 8) /* 68 bytes */
 120 
 121 /*
 122  * XXX IP_MAXPACKET is defined in <netinet/ip.h> as well. At some point the
 123  * 2 files should be cleaned up to remove all redundant definitions.
 124  */
 125 #define IP_MAXPACKET                    65535
 126 #define IP_SIMPLE_HDR_VERSION \
 127         ((IP_VERSION << 4) | IP_SIMPLE_HDR_LENGTH_IN_WORDS)
 128 
 129 #define UDPH_SIZE                       8
 130 
 131 /*
 132  * Constants and type definitions to support IP IOCTL commands
 133  */
 134 #define IP_IOCTL                        (('i'<<8)|'p')
 135 #define IP_IOC_IRE_DELETE               4
 136 #define IP_IOC_IRE_DELETE_NO_REPLY      5
 137 #define IP_IOC_RTS_REQUEST              7
 138 
 139 /* Common definitions used by IP IOCTL data structures */
 140 typedef struct ipllcmd_s {
 141         uint_t  ipllc_cmd;
 142         uint_t  ipllc_name_offset;
 143         uint_t  ipllc_name_length;
 144 } ipllc_t;
 145 
 146 /* IP IRE Delete Command Structure. */
 147 typedef struct ipid_s {
 148         ipllc_t ipid_ipllc;
 149         uint_t  ipid_ire_type;
 150         uint_t  ipid_addr_offset;
 151         uint_t  ipid_addr_length;
 152         uint_t  ipid_mask_offset;
 153         uint_t  ipid_mask_length;
 154 } ipid_t;
 155 
 156 #define ipid_cmd                ipid_ipllc.ipllc_cmd
 157 
 158 #ifdef _KERNEL
 159 /*
 160  * Temporary state for ip options parser.
 161  */
 162 typedef struct ipoptp_s
 163 {
 164         uint8_t         *ipoptp_next;   /* next option to look at */
 165         uint8_t         *ipoptp_end;    /* end of options */
 166         uint8_t         *ipoptp_cur;    /* start of current option */
 167         uint8_t         ipoptp_len;     /* length of current option */
 168         uint32_t        ipoptp_flags;
 169 } ipoptp_t;
 170 
 171 /*
 172  * Flag(s) for ipoptp_flags
 173  */
 174 #define IPOPTP_ERROR    0x00000001
 175 #endif  /* _KERNEL */
 176 
 177 /* Controls forwarding of IP packets, set via ipadm(1M)/ndd(1M) */
 178 #define IP_FORWARD_NEVER        0
 179 #define IP_FORWARD_ALWAYS       1
 180 
 181 #define WE_ARE_FORWARDING(ipst) ((ipst)->ips_ip_forwarding == IP_FORWARD_ALWAYS)
 182 
 183 #define IPH_HDR_LENGTH(ipha)                                            \
 184         ((int)(((ipha_t *)ipha)->ipha_version_and_hdr_length & 0xF) << 2)
 185 
 186 #define IPH_HDR_VERSION(ipha)                                           \
 187         ((int)(((ipha_t *)ipha)->ipha_version_and_hdr_length) >> 4)
 188 
 189 #ifdef _KERNEL
 190 /*
 191  * IP reassembly macros.  We hide starting and ending offsets in b_next and
 192  * b_prev of messages on the reassembly queue.  The messages are chained using
 193  * b_cont.  These macros are used in ip_reassemble() so we don't have to see
 194  * the ugly casts and assignments.
 195  * Note that the offsets are <= 64k i.e. a uint_t is sufficient to represent
 196  * them.
 197  */
 198 #define IP_REASS_START(mp)              ((uint_t)(uintptr_t)((mp)->b_next))
 199 #define IP_REASS_SET_START(mp, u)       \
 200         ((mp)->b_next = (mblk_t *)(uintptr_t)(u))
 201 #define IP_REASS_END(mp)                ((uint_t)(uintptr_t)((mp)->b_prev))
 202 #define IP_REASS_SET_END(mp, u)         \
 203         ((mp)->b_prev = (mblk_t *)(uintptr_t)(u))
 204 
 205 #define IP_REASS_COMPLETE       0x1
 206 #define IP_REASS_PARTIAL        0x2
 207 #define IP_REASS_FAILED         0x4
 208 
 209 /*
 210  * Test to determine whether this is a module instance of IP or a
 211  * driver instance of IP.
 212  */
 213 #define CONN_Q(q)       (WR(q)->q_next == NULL)
 214 
 215 #define Q_TO_CONN(q)    ((conn_t *)(q)->q_ptr)
 216 #define Q_TO_TCP(q)     (Q_TO_CONN((q))->conn_tcp)
 217 #define Q_TO_UDP(q)     (Q_TO_CONN((q))->conn_udp)
 218 #define Q_TO_ICMP(q)    (Q_TO_CONN((q))->conn_icmp)
 219 #define Q_TO_RTS(q)     (Q_TO_CONN((q))->conn_rts)
 220 
 221 #define CONNP_TO_WQ(connp)      ((connp)->conn_wq)
 222 #define CONNP_TO_RQ(connp)      ((connp)->conn_rq)
 223 
 224 #define GRAB_CONN_LOCK(q)       {                               \
 225         if (q != NULL && CONN_Q(q))                             \
 226                 mutex_enter(&(Q_TO_CONN(q))->conn_lock); \
 227 }
 228 
 229 #define RELEASE_CONN_LOCK(q)    {                               \
 230         if (q != NULL && CONN_Q(q))                             \
 231                 mutex_exit(&(Q_TO_CONN(q))->conn_lock);          \
 232 }
 233 
 234 /*
 235  * Ref counter macros for ioctls. This provides a guard for TCP to stop
 236  * tcp_close from removing the rq/wq whilst an ioctl is still in flight on the
 237  * stream. The ioctl could have been queued on e.g. an ipsq. tcp_close will wait
 238  * until the ioctlref count is zero before proceeding.
 239  * Ideally conn_oper_pending_ill would be used for this purpose. However, in the
 240  * case where an ioctl is aborted or interrupted, it can be cleared prematurely.
 241  * There are also some race possibilities between ip and the stream head which
 242  * can also end up with conn_oper_pending_ill being cleared prematurely. So, to
 243  * avoid these situations, we use a dedicated ref counter for ioctls which is
 244  * used in addition to and in parallel with the normal conn_ref count.
 245  */
 246 #define CONN_INC_IOCTLREF_LOCKED(connp) {                       \
 247         ASSERT(MUTEX_HELD(&(connp)->conn_lock));         \
 248         DTRACE_PROBE1(conn__inc__ioctlref, conn_t *, (connp));  \
 249         (connp)->conn_ioctlref++;                            \
 250         mutex_exit(&(connp)->conn_lock);                 \
 251 }
 252 
 253 #define CONN_INC_IOCTLREF(connp)        {                       \
 254         mutex_enter(&(connp)->conn_lock);                        \
 255         CONN_INC_IOCTLREF_LOCKED(connp);                        \
 256 }
 257 
 258 #define CONN_DEC_IOCTLREF(connp)        {                       \
 259         mutex_enter(&(connp)->conn_lock);                        \
 260         DTRACE_PROBE1(conn__dec__ioctlref, conn_t *, (connp));  \
 261         /* Make sure conn_ioctlref will not underflow. */       \
 262         ASSERT((connp)->conn_ioctlref != 0);                 \
 263         if ((--(connp)->conn_ioctlref == 0) &&                       \
 264             ((connp)->conn_state_flags & CONN_CLOSING)) {        \
 265                 cv_broadcast(&(connp)->conn_cv);         \
 266         }                                                       \
 267         mutex_exit(&(connp)->conn_lock);                 \
 268 }
 269 
 270 
 271 /*
 272  * Complete the pending operation. Usually an ioctl. Can also
 273  * be a bind or option management request that got enqueued
 274  * in an ipsq_t. Called on completion of the operation.
 275  */
 276 #define CONN_OPER_PENDING_DONE(connp)   {                       \
 277         mutex_enter(&(connp)->conn_lock);                        \
 278         (connp)->conn_oper_pending_ill = NULL;                       \
 279         cv_broadcast(&(connp)->conn_refcv);                      \
 280         mutex_exit(&(connp)->conn_lock);                 \
 281         CONN_DEC_REF(connp);                                    \
 282 }
 283 
 284 /*
 285  * Values for squeue switch:
 286  */
 287 #define IP_SQUEUE_ENTER_NODRAIN 1
 288 #define IP_SQUEUE_ENTER 2
 289 #define IP_SQUEUE_FILL 3
 290 
 291 extern int ip_squeue_flag;
 292 
 293 /* IP Fragmentation Reassembly Header */
 294 typedef struct ipf_s {
 295         struct ipf_s    *ipf_hash_next;
 296         struct ipf_s    **ipf_ptphn;    /* Pointer to previous hash next. */
 297         uint32_t        ipf_ident;      /* Ident to match. */
 298         uint8_t         ipf_protocol;   /* Protocol to match. */
 299         uchar_t         ipf_last_frag_seen : 1; /* Last fragment seen ? */
 300         time_t          ipf_timestamp;  /* Reassembly start time. */
 301         mblk_t          *ipf_mp;        /* mblk we live in. */
 302         mblk_t          *ipf_tail_mp;   /* Frag queue tail pointer. */
 303         int             ipf_hole_cnt;   /* Number of holes (hard-case). */
 304         int             ipf_end;        /* Tail end offset (0 -> hard-case). */
 305         uint_t          ipf_gen;        /* Frag queue generation */
 306         size_t          ipf_count;      /* Count of bytes used by frag */
 307         uint_t          ipf_nf_hdr_len; /* Length of nonfragmented header */
 308         in6_addr_t      ipf_v6src;      /* IPv6 source address */
 309         in6_addr_t      ipf_v6dst;      /* IPv6 dest address */
 310         uint_t          ipf_prev_nexthdr_offset; /* Offset for nexthdr value */
 311         uint8_t         ipf_ecn;        /* ECN info for the fragments */
 312         uint8_t         ipf_num_dups;   /* Number of times dup frags recvd */
 313         uint16_t        ipf_checksum_flags; /* Hardware checksum flags */
 314         uint32_t        ipf_checksum;   /* Partial checksum of fragment data */
 315 } ipf_t;
 316 
 317 /*
 318  * IPv4 Fragments
 319  */
 320 #define IS_V4_FRAGMENT(ipha_fragment_offset_and_flags)                  \
 321         (((ntohs(ipha_fragment_offset_and_flags) & IPH_OFFSET) != 0) ||     \
 322         ((ntohs(ipha_fragment_offset_and_flags) & IPH_MF) != 0))
 323 
 324 #define ipf_src V4_PART_OF_V6(ipf_v6src)
 325 #define ipf_dst V4_PART_OF_V6(ipf_v6dst)
 326 
 327 #endif /* _KERNEL */
 328 
 329 /* ICMP types */
 330 #define ICMP_ECHO_REPLY                 0
 331 #define ICMP_DEST_UNREACHABLE           3
 332 #define ICMP_SOURCE_QUENCH              4
 333 #define ICMP_REDIRECT                   5
 334 #define ICMP_ECHO_REQUEST               8
 335 #define ICMP_ROUTER_ADVERTISEMENT       9
 336 #define ICMP_ROUTER_SOLICITATION        10
 337 #define ICMP_TIME_EXCEEDED              11
 338 #define ICMP_PARAM_PROBLEM              12
 339 #define ICMP_TIME_STAMP_REQUEST         13
 340 #define ICMP_TIME_STAMP_REPLY           14
 341 #define ICMP_INFO_REQUEST               15
 342 #define ICMP_INFO_REPLY                 16
 343 #define ICMP_ADDRESS_MASK_REQUEST       17
 344 #define ICMP_ADDRESS_MASK_REPLY         18
 345 
 346 /* Evaluates to true if the ICMP type is an ICMP error */
 347 #define ICMP_IS_ERROR(type)     (               \
 348         (type) == ICMP_DEST_UNREACHABLE ||      \
 349         (type) == ICMP_SOURCE_QUENCH ||         \
 350         (type) == ICMP_TIME_EXCEEDED ||         \
 351         (type) == ICMP_PARAM_PROBLEM)
 352 
 353 /* ICMP_TIME_EXCEEDED codes */
 354 #define ICMP_TTL_EXCEEDED               0
 355 #define ICMP_REASSEMBLY_TIME_EXCEEDED   1
 356 
 357 /* ICMP_DEST_UNREACHABLE codes */
 358 #define ICMP_NET_UNREACHABLE            0
 359 #define ICMP_HOST_UNREACHABLE           1
 360 #define ICMP_PROTOCOL_UNREACHABLE       2
 361 #define ICMP_PORT_UNREACHABLE           3
 362 #define ICMP_FRAGMENTATION_NEEDED       4
 363 #define ICMP_SOURCE_ROUTE_FAILED        5
 364 #define ICMP_DEST_NET_UNKNOWN           6
 365 #define ICMP_DEST_HOST_UNKNOWN          7
 366 #define ICMP_SRC_HOST_ISOLATED          8
 367 #define ICMP_DEST_NET_UNREACH_ADMIN     9
 368 #define ICMP_DEST_HOST_UNREACH_ADMIN    10
 369 #define ICMP_DEST_NET_UNREACH_TOS       11
 370 #define ICMP_DEST_HOST_UNREACH_TOS      12
 371 
 372 /* ICMP Header Structure */
 373 typedef struct icmph_s {
 374         uint8_t         icmph_type;
 375         uint8_t         icmph_code;
 376         uint16_t        icmph_checksum;
 377         union {
 378                 struct { /* ECHO request/response structure */
 379                         uint16_t        u_echo_ident;
 380                         uint16_t        u_echo_seqnum;
 381                 } u_echo;
 382                 struct { /* Destination unreachable structure */
 383                         uint16_t        u_du_zero;
 384                         uint16_t        u_du_mtu;
 385                 } u_du;
 386                 struct { /* Parameter problem structure */
 387                         uint8_t         u_pp_ptr;
 388                         uint8_t         u_pp_rsvd[3];
 389                 } u_pp;
 390                 struct { /* Redirect structure */
 391                         ipaddr_t        u_rd_gateway;
 392                 } u_rd;
 393         } icmph_u;
 394 } icmph_t;
 395 
 396 #define icmph_echo_ident        icmph_u.u_echo.u_echo_ident
 397 #define icmph_echo_seqnum       icmph_u.u_echo.u_echo_seqnum
 398 #define icmph_du_zero           icmph_u.u_du.u_du_zero
 399 #define icmph_du_mtu            icmph_u.u_du.u_du_mtu
 400 #define icmph_pp_ptr            icmph_u.u_pp.u_pp_ptr
 401 #define icmph_rd_gateway        icmph_u.u_rd.u_rd_gateway
 402 
 403 #define ICMPH_SIZE      8
 404 
 405 /*
 406  * Minimum length of transport layer header included in an ICMP error
 407  * message for it to be considered valid.
 408  */
 409 #define ICMP_MIN_TP_HDR_LEN     8
 410 
 411 /* Aligned IP header */
 412 typedef struct ipha_s {
 413         uint8_t         ipha_version_and_hdr_length;
 414         uint8_t         ipha_type_of_service;
 415         uint16_t        ipha_length;
 416         uint16_t        ipha_ident;
 417         uint16_t        ipha_fragment_offset_and_flags;
 418         uint8_t         ipha_ttl;
 419         uint8_t         ipha_protocol;
 420         uint16_t        ipha_hdr_checksum;
 421         ipaddr_t        ipha_src;
 422         ipaddr_t        ipha_dst;
 423 } ipha_t;
 424 
 425 /*
 426  * IP Flags
 427  *
 428  * Some of these constant names are copied for the DTrace IP provider in
 429  * usr/src/lib/libdtrace/common/{ip.d.in, ip.sed.in}, which should be kept
 430  * in sync.
 431  */
 432 #define IPH_DF          0x4000  /* Don't fragment */
 433 #define IPH_MF          0x2000  /* More fragments to come */
 434 #define IPH_OFFSET      0x1FFF  /* Where the offset lives */
 435 
 436 /* Byte-order specific values */
 437 #ifdef  _BIG_ENDIAN
 438 #define IPH_DF_HTONS    0x4000  /* Don't fragment */
 439 #define IPH_MF_HTONS    0x2000  /* More fragments to come */
 440 #define IPH_OFFSET_HTONS 0x1FFF /* Where the offset lives */
 441 #else
 442 #define IPH_DF_HTONS    0x0040  /* Don't fragment */
 443 #define IPH_MF_HTONS    0x0020  /* More fragments to come */
 444 #define IPH_OFFSET_HTONS 0xFF1F /* Where the offset lives */
 445 #endif
 446 
 447 /* ECN code points for IPv4 TOS byte and IPv6 traffic class octet. */
 448 #define IPH_ECN_NECT    0x0     /* Not ECN-Capable Transport */
 449 #define IPH_ECN_ECT1    0x1     /* ECN-Capable Transport, ECT(1) */
 450 #define IPH_ECN_ECT0    0x2     /* ECN-Capable Transport, ECT(0) */
 451 #define IPH_ECN_CE      0x3     /* ECN-Congestion Experienced (CE) */
 452 
 453 struct ill_s;
 454 
 455 typedef void ip_v6intfid_func_t(struct ill_s *, in6_addr_t *);
 456 typedef void ip_v6mapinfo_func_t(struct ill_s *, uchar_t *, uchar_t *);
 457 typedef void ip_v4mapinfo_func_t(struct ill_s *, uchar_t *, uchar_t *);
 458 
 459 /* IP Mac info structure */
 460 typedef struct ip_m_s {
 461         t_uscalar_t             ip_m_mac_type;  /* From <sys/dlpi.h> */
 462         int                     ip_m_type;      /* From <net/if_types.h> */
 463         t_uscalar_t             ip_m_ipv4sap;
 464         t_uscalar_t             ip_m_ipv6sap;
 465         ip_v4mapinfo_func_t     *ip_m_v4mapping;
 466         ip_v6mapinfo_func_t     *ip_m_v6mapping;
 467         ip_v6intfid_func_t      *ip_m_v6intfid;
 468         ip_v6intfid_func_t      *ip_m_v6destintfid;
 469 } ip_m_t;
 470 
 471 /*
 472  * The following functions attempt to reduce the link layer dependency
 473  * of the IP stack. The current set of link specific operations are:
 474  * a. map from IPv4 class D (224.0/4) multicast address range or the
 475  * IPv6 multicast address range (ff00::/8) to the link layer multicast
 476  * address.
 477  * b. derive the default IPv6 interface identifier from the interface.
 478  * c. derive the default IPv6 destination interface identifier from
 479  * the interface (point-to-point only).
 480  */
 481 extern  void ip_mcast_mapping(struct ill_s *, uchar_t *, uchar_t *);
 482 /* ip_m_v6*intfid return void and are never NULL */
 483 #define MEDIA_V6INTFID(ip_m, ill, v6ptr) (ip_m)->ip_m_v6intfid(ill, v6ptr)
 484 #define MEDIA_V6DESTINTFID(ip_m, ill, v6ptr) \
 485         (ip_m)->ip_m_v6destintfid(ill, v6ptr)
 486 
 487 /* Router entry types */
 488 #define IRE_BROADCAST           0x0001  /* Route entry for broadcast address */
 489 #define IRE_DEFAULT             0x0002  /* Route entry for default gateway */
 490 #define IRE_LOCAL               0x0004  /* Route entry for local address */
 491 #define IRE_LOOPBACK            0x0008  /* Route entry for loopback address */
 492 #define IRE_PREFIX              0x0010  /* Route entry for prefix routes */
 493 #ifndef _KERNEL
 494 /* Keep so user-level still compiles */
 495 #define IRE_CACHE               0x0020  /* Cached Route entry */
 496 #endif
 497 #define IRE_IF_NORESOLVER       0x0040  /* Route entry for local interface */
 498                                         /* net without any address mapping. */
 499 #define IRE_IF_RESOLVER         0x0080  /* Route entry for local interface */
 500                                         /* net with resolver. */
 501 #define IRE_HOST                0x0100  /* Host route entry */
 502 /* Keep so user-level still compiles */
 503 #define IRE_HOST_REDIRECT       0x0200  /* only used for T_SVR4_OPTMGMT_REQ */
 504 #define IRE_IF_CLONE            0x0400  /* Per host clone of IRE_IF */
 505 #define IRE_MULTICAST           0x0800  /* Special - not in table */
 506 #define IRE_NOROUTE             0x1000  /* Special - not in table */
 507 
 508 #define IRE_INTERFACE           (IRE_IF_NORESOLVER | IRE_IF_RESOLVER)
 509 
 510 #define IRE_IF_ALL              (IRE_IF_NORESOLVER | IRE_IF_RESOLVER | \
 511                                     IRE_IF_CLONE)
 512 #define IRE_OFFSUBNET           (IRE_DEFAULT | IRE_PREFIX | IRE_HOST)
 513 #define IRE_OFFLINK             IRE_OFFSUBNET
 514 /*
 515  * Note that we view IRE_NOROUTE as ONLINK since we can "send" to them without
 516  * going through a router; the result of sending will be an error/icmp error.
 517  */
 518 #define IRE_ONLINK              (IRE_IF_ALL|IRE_LOCAL|IRE_LOOPBACK| \
 519                                     IRE_BROADCAST|IRE_MULTICAST|IRE_NOROUTE)
 520 
 521 /* Arguments to ire_flush_cache() */
 522 #define IRE_FLUSH_DELETE        0
 523 #define IRE_FLUSH_ADD           1
 524 #define IRE_FLUSH_GWCHANGE      2
 525 
 526 /*
 527  * Flags to ire_route_recursive
 528  */
 529 #define IRR_NONE                0
 530 #define IRR_ALLOCATE            1       /* OK to allocate IRE_IF_CLONE */
 531 #define IRR_INCOMPLETE          2       /* OK to return incomplete chain */
 532 
 533 /*
 534  * Open/close synchronization flags.
 535  * These are kept in a separate field in the conn and the synchronization
 536  * depends on the atomic 32 bit access to that field.
 537  */
 538 #define CONN_CLOSING            0x01    /* ip_close waiting for ip_wsrv */
 539 #define CONN_CONDEMNED          0x02    /* conn is closing, no more refs */
 540 #define CONN_INCIPIENT          0x04    /* conn not yet visible, no refs */
 541 #define CONN_QUIESCED           0x08    /* conn is now quiescent */
 542 #define CONN_UPDATE_ILL         0x10    /* conn_update_ill in progress */
 543 
 544 /*
 545  * Flags for dce_flags field. Specifies which information has been set.
 546  * dce_ident is always present, but the other ones are identified by the flags.
 547  */
 548 #define DCEF_DEFAULT            0x0001  /* Default DCE - no pmtu or uinfo */
 549 #define DCEF_PMTU               0x0002  /* Different than interface MTU */
 550 #define DCEF_UINFO              0x0004  /* dce_uinfo set */
 551 #define DCEF_TOO_SMALL_PMTU     0x0008  /* Smaller than IPv4/IPv6 MIN */
 552 
 553 #ifdef _KERNEL
 554 /*
 555  * Extra structures need for per-src-addr filtering (IGMPv3/MLDv2)
 556  */
 557 #define MAX_FILTER_SIZE 64
 558 
 559 typedef struct slist_s {
 560         int             sl_numsrc;
 561         in6_addr_t      sl_addr[MAX_FILTER_SIZE];
 562 } slist_t;
 563 
 564 /*
 565  * Following struct is used to maintain retransmission state for
 566  * a multicast group.  One rtx_state_t struct is an in-line field
 567  * of the ilm_t struct; the slist_ts in the rtx_state_t struct are
 568  * alloc'd as needed.
 569  */
 570 typedef struct rtx_state_s {
 571         uint_t          rtx_timer;      /* retrans timer */
 572         int             rtx_cnt;        /* retrans count */
 573         int             rtx_fmode_cnt;  /* retrans count for fmode change */
 574         slist_t         *rtx_allow;
 575         slist_t         *rtx_block;
 576 } rtx_state_t;
 577 
 578 /*
 579  * Used to construct list of multicast address records that will be
 580  * sent in a single listener report.
 581  */
 582 typedef struct mrec_s {
 583         struct mrec_s   *mrec_next;
 584         uint8_t         mrec_type;
 585         uint8_t         mrec_auxlen;    /* currently unused */
 586         in6_addr_t      mrec_group;
 587         slist_t         mrec_srcs;
 588 } mrec_t;
 589 
 590 /* Group membership list per upper conn */
 591 
 592 /*
 593  * We record the multicast information from the socket option in
 594  * ilg_ifaddr/ilg_ifindex. This allows rejoining the group in the case when
 595  * the ifaddr (or ifindex) disappears and later reappears, potentially on
 596  * a different ill. The IPv6 multicast socket options and ioctls all specify
 597  * the interface using an ifindex. For IPv4 some socket options/ioctls use
 598  * the interface address and others use the index. We record here the method
 599  * that was actually used (and leave the other of ilg_ifaddr or ilg_ifindex)
 600  * at zero so that we can rejoin the way the application intended.
 601  *
 602  * We track the ill on which we will or already have joined an ilm using
 603  * ilg_ill. When we have succeeded joining the ilm and have a refhold on it
 604  * then we set ilg_ilm. Thus intentionally there is a window where ilg_ill is
 605  * set and ilg_ilm is not set. This allows clearing ilg_ill as a signal that
 606  * the ill is being unplumbed and the ilm should be discarded.
 607  *
 608  * ilg records the state of multicast memberships of a socket end point.
 609  * ilm records the state of multicast memberships with the driver and is
 610  * maintained per interface.
 611  *
 612  * The ilg state is protected by conn_ilg_lock.
 613  * The ilg will not be freed until ilg_refcnt drops to zero.
 614  */
 615 typedef struct ilg_s {
 616         struct ilg_s    *ilg_next;
 617         struct ilg_s    **ilg_ptpn;
 618         struct conn_s   *ilg_connp;     /* Back pointer to get lock */
 619         in6_addr_t      ilg_v6group;
 620         ipaddr_t        ilg_ifaddr;     /* For some IPv4 cases */
 621         uint_t          ilg_ifindex;    /* IPv6 and some other IPv4 cases */
 622         struct ill_s    *ilg_ill;       /* Where ilm is joined. No refhold */
 623         struct ilm_s    *ilg_ilm;       /* With ilm_refhold */
 624         uint_t          ilg_refcnt;
 625         mcast_record_t  ilg_fmode;      /* MODE_IS_INCLUDE/MODE_IS_EXCLUDE */
 626         slist_t         *ilg_filter;
 627         boolean_t       ilg_condemned;  /* Conceptually deleted */
 628 } ilg_t;
 629 
 630 /*
 631  * Multicast address list entry for ill.
 632  * ilm_ill is used by IPv4 and IPv6
 633  *
 634  * The ilm state (and other multicast state on the ill) is protected by
 635  * ill_mcast_lock. Operations that change state on both an ilg and ilm
 636  * in addition use ill_mcast_serializer to ensure that we can't have
 637  * interleaving between e.g., add and delete operations for the same conn_t,
 638  * group, and ill. The ill_mcast_serializer is also used to ensure that
 639  * multicast group joins do not occur on an interface that is in the process
 640  * of joining an IPMP group.
 641  *
 642  * The comment below (and for other netstack_t references) refers
 643  * to the fact that we only do netstack_hold in particular cases,
 644  * such as the references from open endpoints (ill_t and conn_t's
 645  * pointers). Internally within IP we rely on IP's ability to cleanup e.g.
 646  * ire_t's when an ill goes away.
 647  */
 648 typedef struct ilm_s {
 649         in6_addr_t      ilm_v6addr;
 650         int             ilm_refcnt;
 651         uint_t          ilm_timer;      /* IGMP/MLD query resp timer, in msec */
 652         struct ilm_s    *ilm_next;      /* Linked list for each ill */
 653         uint_t          ilm_state;      /* state of the membership */
 654         struct ill_s    *ilm_ill;       /* Back pointer to ill - ill_ilm_cnt */
 655         zoneid_t        ilm_zoneid;
 656         int             ilm_no_ilg_cnt; /* number of joins w/ no ilg */
 657         mcast_record_t  ilm_fmode;      /* MODE_IS_INCLUDE/MODE_IS_EXCLUDE */
 658         slist_t         *ilm_filter;    /* source filter list */
 659         slist_t         *ilm_pendsrcs;  /* relevant src addrs for pending req */
 660         rtx_state_t     ilm_rtx;        /* SCR retransmission state */
 661         ipaddr_t        ilm_ifaddr;     /* For IPv4 netstat */
 662         ip_stack_t      *ilm_ipst;      /* Does not have a netstack_hold */
 663 } ilm_t;
 664 
 665 #define ilm_addr        V4_PART_OF_V6(ilm_v6addr)
 666 
 667 /*
 668  * Soft reference to an IPsec SA.
 669  *
 670  * On relative terms, conn's can be persistent (living as long as the
 671  * processes which create them), while SA's are ephemeral (dying when
 672  * they hit their time-based or byte-based lifetimes).
 673  *
 674  * We could hold a hard reference to an SA from an ipsec_latch_t,
 675  * but this would cause expired SA's to linger for a potentially
 676  * unbounded time.
 677  *
 678  * Instead, we remember the hash bucket number and bucket generation
 679  * in addition to the pointer.  The bucket generation is incremented on
 680  * each deletion.
 681  */
 682 typedef struct ipsa_ref_s
 683 {
 684         struct ipsa_s   *ipsr_sa;
 685         struct isaf_s   *ipsr_bucket;
 686         uint64_t        ipsr_gen;
 687 } ipsa_ref_t;
 688 
 689 /*
 690  * IPsec "latching" state.
 691  *
 692  * In the presence of IPsec policy, fully-bound conn's bind a connection
 693  * to more than just the 5-tuple, but also a specific IPsec action and
 694  * identity-pair.
 695  * The identity pair is accessed from both the receive and transmit side
 696  * hence it is maintained in the ipsec_latch_t structure. conn_latch and
 697  * ixa_ipsec_latch points to it.
 698  * The policy and actions are stored in conn_latch_in_policy and
 699  * conn_latch_in_action for the inbound side, and in ixa_ipsec_policy and
 700  * ixa_ipsec_action for the transmit side.
 701  *
 702  * As an optimization, we also cache soft references to IPsec SA's in
 703  * ip_xmit_attr_t so that we can fast-path around most of the work needed for
 704  * outbound IPsec SA selection.
 705  */
 706 typedef struct ipsec_latch_s
 707 {
 708         kmutex_t        ipl_lock;
 709         uint32_t        ipl_refcnt;
 710 
 711         struct ipsid_s  *ipl_local_cid;
 712         struct ipsid_s  *ipl_remote_cid;
 713         unsigned int
 714                         ipl_ids_latched : 1,
 715 
 716                         ipl_pad_to_bit_31 : 31;
 717 } ipsec_latch_t;
 718 
 719 #define IPLATCH_REFHOLD(ipl) { \
 720         atomic_add_32(&(ipl)->ipl_refcnt, 1);            \
 721         ASSERT((ipl)->ipl_refcnt != 0);                      \
 722 }
 723 
 724 #define IPLATCH_REFRELE(ipl) {                          \
 725         ASSERT((ipl)->ipl_refcnt != 0);                              \
 726         membar_exit();                                          \
 727         if (atomic_add_32_nv(&(ipl)->ipl_refcnt, -1) == 0)       \
 728                 iplatch_free(ipl);                              \
 729 }
 730 
 731 /*
 732  * peer identity structure.
 733  */
 734 typedef struct conn_s conn_t;
 735 
 736 /*
 737  * This is used to match an inbound/outbound datagram with policy.
 738  */
 739 typedef struct ipsec_selector {
 740         in6_addr_t      ips_local_addr_v6;
 741         in6_addr_t      ips_remote_addr_v6;
 742         uint16_t        ips_local_port;
 743         uint16_t        ips_remote_port;
 744         uint8_t         ips_icmp_type;
 745         uint8_t         ips_icmp_code;
 746         uint8_t         ips_protocol;
 747         uint8_t         ips_isv4 : 1,
 748                         ips_is_icmp_inv_acq: 1;
 749 } ipsec_selector_t;
 750 
 751 /*
 752  * Note that we put v4 addresses in the *first* 32-bit word of the
 753  * selector rather than the last to simplify the prefix match/mask code
 754  * in spd.c
 755  */
 756 #define ips_local_addr_v4 ips_local_addr_v6.s6_addr32[0]
 757 #define ips_remote_addr_v4 ips_remote_addr_v6.s6_addr32[0]
 758 
 759 /* Values used in IP by IPSEC Code */
 760 #define         IPSEC_OUTBOUND          B_TRUE
 761 #define         IPSEC_INBOUND           B_FALSE
 762 
 763 /*
 764  * There are two variants in policy failures. The packet may come in
 765  * secure when not needed (IPSEC_POLICY_???_NOT_NEEDED) or it may not
 766  * have the desired level of protection (IPSEC_POLICY_MISMATCH).
 767  */
 768 #define IPSEC_POLICY_NOT_NEEDED         0
 769 #define IPSEC_POLICY_MISMATCH           1
 770 #define IPSEC_POLICY_AUTH_NOT_NEEDED    2
 771 #define IPSEC_POLICY_ENCR_NOT_NEEDED    3
 772 #define IPSEC_POLICY_SE_NOT_NEEDED      4
 773 #define IPSEC_POLICY_MAX                5       /* Always max + 1. */
 774 
 775 /*
 776  * Check with IPSEC inbound policy if
 777  *
 778  * 1) per-socket policy is present - indicated by conn_in_enforce_policy.
 779  * 2) Or if we have not cached policy on the conn and the global policy is
 780  *    non-empty.
 781  */
 782 #define CONN_INBOUND_POLICY_PRESENT(connp, ipss)        \
 783         ((connp)->conn_in_enforce_policy ||          \
 784         (!((connp)->conn_policy_cached) &&           \
 785         (ipss)->ipsec_inbound_v4_policy_present))
 786 
 787 #define CONN_INBOUND_POLICY_PRESENT_V6(connp, ipss)     \
 788         ((connp)->conn_in_enforce_policy ||          \
 789         (!(connp)->conn_policy_cached &&             \
 790         (ipss)->ipsec_inbound_v6_policy_present))
 791 
 792 #define CONN_OUTBOUND_POLICY_PRESENT(connp, ipss)       \
 793         ((connp)->conn_out_enforce_policy ||         \
 794         (!((connp)->conn_policy_cached) &&           \
 795         (ipss)->ipsec_outbound_v4_policy_present))
 796 
 797 #define CONN_OUTBOUND_POLICY_PRESENT_V6(connp, ipss)    \
 798         ((connp)->conn_out_enforce_policy ||         \
 799         (!(connp)->conn_policy_cached &&             \
 800         (ipss)->ipsec_outbound_v6_policy_present))
 801 
 802 /*
 803  * Information cached in IRE for upper layer protocol (ULP).
 804  */
 805 typedef struct iulp_s {
 806         boolean_t       iulp_set;       /* Is any metric set? */
 807         uint32_t        iulp_ssthresh;  /* Slow start threshold (TCP). */
 808         clock_t         iulp_rtt;       /* Guestimate in millisecs. */
 809         clock_t         iulp_rtt_sd;    /* Cached value of RTT variance. */
 810         uint32_t        iulp_spipe;     /* Send pipe size. */
 811         uint32_t        iulp_rpipe;     /* Receive pipe size. */
 812         uint32_t        iulp_rtomax;    /* Max round trip timeout. */
 813         uint32_t        iulp_sack;      /* Use SACK option (TCP)? */
 814         uint32_t        iulp_mtu;       /* Setable with routing sockets */
 815 
 816         uint32_t
 817                 iulp_tstamp_ok : 1,     /* Use timestamp option (TCP)? */
 818                 iulp_wscale_ok : 1,     /* Use window scale option (TCP)? */
 819                 iulp_ecn_ok : 1,        /* Enable ECN (for TCP)? */
 820                 iulp_pmtud_ok : 1,      /* Enable PMTUd? */
 821 
 822                 /* These three are passed out by ip_set_destination */
 823                 iulp_localnet: 1,       /* IRE_ONLINK */
 824                 iulp_loopback: 1,       /* IRE_LOOPBACK */
 825                 iulp_local: 1,          /* IRE_LOCAL */
 826 
 827                 iulp_not_used : 25;
 828 } iulp_t;
 829 
 830 /*
 831  * The conn drain list structure (idl_t), protected by idl_lock.  Each conn_t
 832  * inserted in the list points back at this idl_t using conn_idl, and is
 833  * chained by conn_drain_next and conn_drain_prev, which are also protected by
 834  * idl_lock.  When flow control is relieved, either ip_wsrv() (STREAMS) or
 835  * ill_flow_enable() (non-STREAMS) will call conn_drain().
 836  *
 837  * The conn drain list, idl_t, itself is part of tx cookie list structure.
 838  * A tx cookie list points to a blocked Tx ring and contains the list of
 839  * all conn's that are blocked due to the flow-controlled Tx ring (via
 840  * the idl drain list). Note that a link can have multiple Tx rings. The
 841  * drain list will store the conn's blocked due to Tx ring being flow
 842  * controlled.
 843  */
 844 
 845 typedef uintptr_t ip_mac_tx_cookie_t;
 846 typedef struct idl_s idl_t;
 847 typedef struct idl_tx_list_s idl_tx_list_t;
 848 
 849 struct idl_tx_list_s {
 850         ip_mac_tx_cookie_t      txl_cookie;
 851         kmutex_t                txl_lock;       /* Lock for this list */
 852         idl_t                   *txl_drain_list;
 853         int                     txl_drain_index;
 854 };
 855 
 856 struct idl_s {
 857         conn_t          *idl_conn;              /* Head of drain list */
 858         kmutex_t        idl_lock;               /* Lock for this list */
 859         idl_tx_list_t   *idl_itl;
 860 };
 861 
 862 /*
 863  * Interface route structure which holds the necessary information to recreate
 864  * routes that are tied to an interface i.e. have ire_ill set.
 865  *
 866  * These routes which were initially created via a routing socket or via the
 867  * SIOCADDRT ioctl may be gateway routes (RTF_GATEWAY being set) or may be
 868  * traditional interface routes.  When an ill comes back up after being
 869  * down, this information will be used to recreate the routes.  These
 870  * are part of an mblk_t chain that hangs off of the ILL (ill_saved_ire_mp).
 871  */
 872 typedef struct ifrt_s {
 873         ushort_t        ifrt_type;              /* Type of IRE */
 874         in6_addr_t      ifrt_v6addr;            /* Address IRE represents. */
 875         in6_addr_t      ifrt_v6gateway_addr;    /* Gateway if IRE_OFFLINK */
 876         in6_addr_t      ifrt_v6setsrc_addr;     /* Src addr if RTF_SETSRC */
 877         in6_addr_t      ifrt_v6mask;            /* Mask for matching IRE. */
 878         uint32_t        ifrt_flags;             /* flags related to route */
 879         iulp_t          ifrt_metrics;           /* Routing socket metrics */
 880         zoneid_t        ifrt_zoneid;            /* zoneid for route */
 881 } ifrt_t;
 882 
 883 #define ifrt_addr               V4_PART_OF_V6(ifrt_v6addr)
 884 #define ifrt_gateway_addr       V4_PART_OF_V6(ifrt_v6gateway_addr)
 885 #define ifrt_mask               V4_PART_OF_V6(ifrt_v6mask)
 886 #define ifrt_setsrc_addr        V4_PART_OF_V6(ifrt_v6setsrc_addr)
 887 
 888 /* Number of IP addresses that can be hosted on a physical interface */
 889 #define MAX_ADDRS_PER_IF        8192
 890 /*
 891  * Number of Source addresses to be considered for source address
 892  * selection. Used by ipif_select_source_v4/v6.
 893  */
 894 #define MAX_IPIF_SELECT_SOURCE  50
 895 
 896 #ifdef IP_DEBUG
 897 /*
 898  * Trace refholds and refreles for debugging.
 899  */
 900 #define TR_STACK_DEPTH  14
 901 typedef struct tr_buf_s {
 902         int     tr_depth;
 903         clock_t tr_time;
 904         pc_t    tr_stack[TR_STACK_DEPTH];
 905 } tr_buf_t;
 906 
 907 typedef struct th_trace_s {
 908         int             th_refcnt;
 909         uint_t          th_trace_lastref;
 910         kthread_t       *th_id;
 911 #define TR_BUF_MAX      38
 912         tr_buf_t        th_trbuf[TR_BUF_MAX];
 913 } th_trace_t;
 914 
 915 typedef struct th_hash_s {
 916         list_node_t     thh_link;
 917         mod_hash_t      *thh_hash;
 918         ip_stack_t      *thh_ipst;
 919 } th_hash_t;
 920 #endif
 921 
 922 /* The following are ipif_state_flags */
 923 #define IPIF_CONDEMNED          0x1     /* The ipif is being removed */
 924 #define IPIF_CHANGING           0x2     /* A critcal ipif field is changing */
 925 #define IPIF_SET_LINKLOCAL      0x10    /* transient flag during bringup */
 926 
 927 /* IP interface structure, one per local address */
 928 typedef struct ipif_s {
 929         struct  ipif_s  *ipif_next;
 930         struct  ill_s   *ipif_ill;      /* Back pointer to our ill */
 931         int     ipif_id;                /* Logical unit number */
 932         in6_addr_t ipif_v6lcl_addr;     /* Local IP address for this if. */
 933         in6_addr_t ipif_v6subnet;       /* Subnet prefix for this if. */
 934         in6_addr_t ipif_v6net_mask;     /* Net mask for this interface. */
 935         in6_addr_t ipif_v6brd_addr;     /* Broadcast addr for this interface. */
 936         in6_addr_t ipif_v6pp_dst_addr;  /* Point-to-point dest address. */
 937         uint64_t ipif_flags;            /* Interface flags. */
 938         uint_t  ipif_ire_type;          /* IRE_LOCAL or IRE_LOOPBACK */
 939 
 940         /*
 941          * The packet count in the ipif contain the sum of the
 942          * packet counts in dead IRE_LOCAL/LOOPBACK for this ipif.
 943          */
 944         uint_t  ipif_ib_pkt_count;      /* Inbound packets for our dead IREs */
 945 
 946         /* Exclusive bit fields, protected by ipsq_t */
 947         unsigned int
 948                 ipif_was_up : 1,        /* ipif was up before */
 949                 ipif_addr_ready : 1,    /* DAD is done */
 950                 ipif_was_dup : 1,       /* DAD had failed */
 951                 ipif_added_nce : 1,     /* nce added for local address */
 952 
 953                 ipif_pad_to_31 : 28;
 954 
 955         ilm_t   *ipif_allhosts_ilm;     /* For all-nodes join */
 956         ilm_t   *ipif_solmulti_ilm;     /* For IPv6 solicited multicast join */
 957 
 958         uint_t  ipif_seqid;             /* unique index across all ills */
 959         uint_t  ipif_state_flags;       /* See IPIF_* flag defs above */
 960         uint_t  ipif_refcnt;            /* active consistent reader cnt */
 961 
 962         zoneid_t ipif_zoneid;           /* zone ID number */
 963         timeout_id_t ipif_recovery_id;  /* Timer for DAD recovery */
 964         boolean_t ipif_trace_disable;   /* True when alloc fails */
 965         /*
 966          * For an IPMP interface, ipif_bound_ill tracks the ill whose hardware
 967          * information this ipif is associated with via ARP/NDP.  We can use
 968          * an ill pointer (rather than an index) because only ills that are
 969          * part of a group will be pointed to, and an ill cannot disappear
 970          * while it's in a group.
 971          */
 972         struct ill_s    *ipif_bound_ill;
 973         struct ipif_s   *ipif_bound_next; /* bound ipif chain */
 974         boolean_t       ipif_bound;     /* B_TRUE if we successfully bound */
 975 
 976         struct ire_s    *ipif_ire_local; /* Our IRE_LOCAL or LOOPBACK */
 977         struct ire_s    *ipif_ire_if;    /* Our IRE_INTERFACE */
 978 } ipif_t;
 979 
 980 /*
 981  * The following table lists the protection levels of the various members
 982  * of the ipif_t. The following notation is used.
 983  *
 984  * Write once - Written to only once at the time of bringing up
 985  * the interface and can be safely read after the bringup without any lock.
 986  *
 987  * ipsq - Need to execute in the ipsq to perform the indicated access.
 988  *
 989  * ill_lock - Need to hold this mutex to perform the indicated access.
 990  *
 991  * ill_g_lock - Need to hold this rw lock as reader/writer for read access or
 992  * write access respectively.
 993  *
 994  * down ill - Written to only when the ill is down (i.e all ipifs are down)
 995  * up ill - Read only when the ill is up (i.e. at least 1 ipif is up)
 996  *
 997  *               Table of ipif_t members and their protection
 998  *
 999  * ipif_next            ipsq + ill_lock +       ipsq OR ill_lock OR
1000  *                      ill_g_lock              ill_g_lock
1001  * ipif_ill             ipsq + down ipif        write once
1002  * ipif_id              ipsq + down ipif        write once
1003  * ipif_v6lcl_addr      ipsq + down ipif        up ipif
1004  * ipif_v6subnet        ipsq + down ipif        up ipif
1005  * ipif_v6net_mask      ipsq + down ipif        up ipif
1006  *
1007  * ipif_v6brd_addr
1008  * ipif_v6pp_dst_addr
1009  * ipif_flags           ill_lock                ill_lock
1010  * ipif_ire_type        ipsq + down ill         up ill
1011  *
1012  * ipif_ib_pkt_count    Approx
1013  *
1014  * bit fields           ill_lock                ill_lock
1015  *
1016  * ipif_allhosts_ilm    ipsq                    ipsq
1017  * ipif_solmulti_ilm    ipsq                    ipsq
1018  *
1019  * ipif_seqid           ipsq                    Write once
1020  *
1021  * ipif_state_flags     ill_lock                ill_lock
1022  * ipif_refcnt          ill_lock                ill_lock
1023  * ipif_bound_ill       ipsq + ipmp_lock        ipsq OR ipmp_lock
1024  * ipif_bound_next      ipsq                    ipsq
1025  * ipif_bound           ipsq                    ipsq
1026  *
1027  * ipif_ire_local       ipsq + ips_ill_g_lock   ipsq OR ips_ill_g_lock
1028  * ipif_ire_if          ipsq + ips_ill_g_lock   ipsq OR ips_ill_g_lock
1029  */
1030 
1031 /*
1032  * Return values from ip_laddr_verify_{v4,v6}
1033  */
1034 typedef enum { IPVL_UNICAST_UP, IPVL_UNICAST_DOWN, IPVL_MCAST, IPVL_BCAST,
1035             IPVL_BAD} ip_laddr_t;
1036 
1037 
1038 #define IP_TR_HASH(tid) ((((uintptr_t)tid) >> 6) & (IP_TR_HASH_MAX - 1))
1039 
1040 #ifdef DEBUG
1041 #define IPIF_TRACE_REF(ipif)    ipif_trace_ref(ipif)
1042 #define ILL_TRACE_REF(ill)      ill_trace_ref(ill)
1043 #define IPIF_UNTRACE_REF(ipif)  ipif_untrace_ref(ipif)
1044 #define ILL_UNTRACE_REF(ill)    ill_untrace_ref(ill)
1045 #else
1046 #define IPIF_TRACE_REF(ipif)
1047 #define ILL_TRACE_REF(ill)
1048 #define IPIF_UNTRACE_REF(ipif)
1049 #define ILL_UNTRACE_REF(ill)
1050 #endif
1051 
1052 /* IPv4 compatibility macros */
1053 #define ipif_lcl_addr           V4_PART_OF_V6(ipif_v6lcl_addr)
1054 #define ipif_subnet             V4_PART_OF_V6(ipif_v6subnet)
1055 #define ipif_net_mask           V4_PART_OF_V6(ipif_v6net_mask)
1056 #define ipif_brd_addr           V4_PART_OF_V6(ipif_v6brd_addr)
1057 #define ipif_pp_dst_addr        V4_PART_OF_V6(ipif_v6pp_dst_addr)
1058 
1059 /* Macros for easy backreferences to the ill. */
1060 #define ipif_isv6               ipif_ill->ill_isv6
1061 
1062 #define SIOCLIFADDR_NDX 112     /* ndx of SIOCLIFADDR in the ndx ioctl table */
1063 
1064 /*
1065  * mode value for ip_ioctl_finish for finishing an ioctl
1066  */
1067 #define CONN_CLOSE      1               /* No mi_copy */
1068 #define COPYOUT         2               /* do an mi_copyout if needed */
1069 #define NO_COPYOUT      3               /* do an mi_copy_done */
1070 #define IPI2MODE(ipi)   ((ipi)->ipi_flags & IPI_GET_CMD ? COPYOUT : NO_COPYOUT)
1071 
1072 /*
1073  * The IP-MT design revolves around the serialization objects ipsq_t (IPSQ)
1074  * and ipxop_t (exclusive operation or "xop").  Becoming "writer" on an IPSQ
1075  * ensures that no other threads can become "writer" on any IPSQs sharing that
1076  * IPSQ's xop until the writer thread is done.
1077  *
1078  * Each phyint points to one IPSQ that remains fixed over the phyint's life.
1079  * Each IPSQ points to one xop that can change over the IPSQ's life.  If a
1080  * phyint is *not* in an IPMP group, then its IPSQ will refer to the IPSQ's
1081  * "own" xop (ipsq_ownxop).  If a phyint *is* part of an IPMP group, then its
1082  * IPSQ will refer to the "group" xop, which is shorthand for the xop of the
1083  * IPSQ of the IPMP meta-interface's phyint.  Thus, all phyints that are part
1084  * of the same IPMP group will have their IPSQ's point to the group xop, and
1085  * thus becoming "writer" on any phyint in the group will prevent any other
1086  * writer on any other phyint in the group.  All IPSQs sharing the same xop
1087  * are chained together through ipsq_next (in the degenerate common case,
1088  * ipsq_next simply refers to itself).  Note that the group xop is guaranteed
1089  * to exist at least as long as there are members in the group, since the IPMP
1090  * meta-interface can only be destroyed if the group is empty.
1091  *
1092  * Incoming exclusive operation requests are enqueued on the IPSQ they arrived
1093  * on rather than the xop.  This makes switching xop's (as would happen when a
1094  * phyint leaves an IPMP group) simple, because after the phyint leaves the
1095  * group, any operations enqueued on its IPSQ can be safely processed with
1096  * respect to its new xop, and any operations enqueued on the IPSQs of its
1097  * former group can be processed with respect to their existing group xop.
1098  * Even so, switching xops is a subtle dance; see ipsq_dq() for details.
1099  *
1100  * An IPSQ's "own" xop is embedded within the IPSQ itself since they have have
1101  * identical lifetimes, and because doing so simplifies pointer management.
1102  * While each phyint and IPSQ point to each other, it is not possible to free
1103  * the IPSQ when the phyint is freed, since we may still *inside* the IPSQ
1104  * when the phyint is being freed.  Thus, ipsq_phyint is set to NULL when the
1105  * phyint is freed, and the IPSQ free is later done in ipsq_exit().
1106  *
1107  * ipsq_t synchronization:      read                    write
1108  *
1109  *      ipsq_xopq_mphead        ipx_lock                ipx_lock
1110  *      ipsq_xopq_mptail        ipx_lock                ipx_lock
1111  *      ipsq_xop_switch_mp      ipsq_lock               ipsq_lock
1112  *      ipsq_phyint             write once              write once
1113  *      ipsq_next               RW_READER ill_g_lock    RW_WRITER ill_g_lock
1114  *      ipsq_xop                ipsq_lock or ipsq       ipsq_lock + ipsq
1115  *      ipsq_swxop              ipsq                    ipsq
1116  *      ipsq_ownxop             see ipxop_t             see ipxop_t
1117  *      ipsq_ipst               write once              write once
1118  *
1119  * ipxop_t synchronization:     read                    write
1120  *
1121  *      ipx_writer              ipx_lock                ipx_lock
1122  *      ipx_xop_queued          ipx_lock                ipx_lock
1123  *      ipx_mphead              ipx_lock                ipx_lock
1124  *      ipx_mptail              ipx_lock                ipx_lock
1125  *      ipx_ipsq                write once              write once
1126  *      ips_ipsq_queued         ipx_lock                ipx_lock
1127  *      ipx_waitfor             ipsq or ipx_lock        ipsq + ipx_lock
1128  *      ipx_reentry_cnt         ipsq or ipx_lock        ipsq + ipx_lock
1129  *      ipx_current_done        ipsq                    ipsq
1130  *      ipx_current_ioctl       ipsq                    ipsq
1131  *      ipx_current_ipif        ipsq or ipx_lock        ipsq + ipx_lock
1132  *      ipx_pending_ipif        ipsq or ipx_lock        ipsq + ipx_lock
1133  *      ipx_pending_mp          ipsq or ipx_lock        ipsq + ipx_lock
1134  *      ipx_forced              ipsq                    ipsq
1135  *      ipx_depth               ipsq                    ipsq
1136  *      ipx_stack               ipsq                    ipsq
1137  */
1138 typedef struct ipxop_s {
1139         kmutex_t        ipx_lock;       /* see above */
1140         kthread_t       *ipx_writer;    /* current owner */
1141         mblk_t          *ipx_mphead;    /* messages tied to this op */
1142         mblk_t          *ipx_mptail;
1143         struct ipsq_s   *ipx_ipsq;      /* associated ipsq */
1144         boolean_t       ipx_ipsq_queued; /* ipsq using xop has queued op */
1145         int             ipx_waitfor;    /* waiting; values encoded below */
1146         int             ipx_reentry_cnt;
1147         boolean_t       ipx_current_done;  /* is the current operation done? */
1148         int             ipx_current_ioctl; /* current ioctl, or 0 if no ioctl */
1149         ipif_t          *ipx_current_ipif; /* ipif for current op */
1150         ipif_t          *ipx_pending_ipif; /* ipif for ipx_pending_mp */
1151         mblk_t          *ipx_pending_mp;   /* current ioctl mp while waiting */
1152         boolean_t       ipx_forced;                     /* debugging aid */
1153 #ifdef DEBUG
1154         int             ipx_depth;                      /* debugging aid */
1155 #define IPX_STACK_DEPTH 15
1156         pc_t            ipx_stack[IPX_STACK_DEPTH];     /* debugging aid */
1157 #endif
1158 } ipxop_t;
1159 
1160 typedef struct ipsq_s {
1161         kmutex_t ipsq_lock;             /* see above */
1162         mblk_t  *ipsq_switch_mp;        /* op to handle right after switch */
1163         mblk_t  *ipsq_xopq_mphead;      /* list of excl ops (mostly ioctls) */
1164         mblk_t  *ipsq_xopq_mptail;
1165         struct phyint   *ipsq_phyint;   /* associated phyint */
1166         struct ipsq_s   *ipsq_next;     /* next ipsq sharing ipsq_xop */
1167         struct ipxop_s  *ipsq_xop;      /* current xop synchronization info */
1168         struct ipxop_s  *ipsq_swxop;    /* switch xop to on ipsq_exit() */
1169         struct ipxop_s  ipsq_ownxop;    /* our own xop (may not be in-use) */
1170         ip_stack_t      *ipsq_ipst;     /* does not have a netstack_hold */
1171 } ipsq_t;
1172 
1173 /*
1174  * ipx_waitfor values:
1175  */
1176 enum {
1177         IPIF_DOWN = 1,  /* ipif_down() waiting for refcnts to drop */
1178         ILL_DOWN,       /* ill_down() waiting for refcnts to drop */
1179         IPIF_FREE,      /* ipif_free() waiting for refcnts to drop */
1180         ILL_FREE        /* ill unplumb waiting for refcnts to drop */
1181 };
1182 
1183 /* Operation types for ipsq_try_enter() */
1184 #define CUR_OP 0        /* request writer within current operation */
1185 #define NEW_OP 1        /* request writer for a new operation */
1186 #define SWITCH_OP 2     /* request writer once IPSQ XOP switches */
1187 
1188 /*
1189  * Kstats tracked on each IPMP meta-interface.  Order here must match
1190  * ipmp_kstats[] in ip/ipmp.c.
1191  */
1192 enum {
1193         IPMP_KSTAT_OBYTES,      IPMP_KSTAT_OBYTES64,    IPMP_KSTAT_RBYTES,
1194         IPMP_KSTAT_RBYTES64,    IPMP_KSTAT_OPACKETS,    IPMP_KSTAT_OPACKETS64,
1195         IPMP_KSTAT_OERRORS,     IPMP_KSTAT_IPACKETS,    IPMP_KSTAT_IPACKETS64,
1196         IPMP_KSTAT_IERRORS,     IPMP_KSTAT_MULTIRCV,    IPMP_KSTAT_MULTIXMT,
1197         IPMP_KSTAT_BRDCSTRCV,   IPMP_KSTAT_BRDCSTXMT,   IPMP_KSTAT_LINK_UP,
1198         IPMP_KSTAT_MAX          /* keep last */
1199 };
1200 
1201 /*
1202  * phyint represents state that is common to both IPv4 and IPv6 interfaces.
1203  * There is a separate ill_t representing IPv4 and IPv6 which has a
1204  * backpointer to the phyint structure for accessing common state.
1205  */
1206 typedef struct phyint {
1207         struct ill_s    *phyint_illv4;
1208         struct ill_s    *phyint_illv6;
1209         uint_t          phyint_ifindex;         /* SIOCSLIFINDEX */
1210         uint64_t        phyint_flags;
1211         avl_node_t      phyint_avl_by_index;    /* avl tree by index */
1212         avl_node_t      phyint_avl_by_name;     /* avl tree by name */
1213         kmutex_t        phyint_lock;
1214         struct ipsq_s   *phyint_ipsq;           /* back pointer to ipsq */
1215         struct ipmp_grp_s *phyint_grp;          /* associated IPMP group */
1216         char            phyint_name[LIFNAMSIZ]; /* physical interface name */
1217         uint64_t        phyint_kstats0[IPMP_KSTAT_MAX]; /* baseline kstats */
1218 } phyint_t;
1219 
1220 #define CACHE_ALIGN_SIZE 64
1221 #define CACHE_ALIGN(align_struct)       P2ROUNDUP(sizeof (struct align_struct),\
1222                                                         CACHE_ALIGN_SIZE)
1223 struct _phyint_list_s_ {
1224         avl_tree_t      phyint_list_avl_by_index;       /* avl tree by index */
1225         avl_tree_t      phyint_list_avl_by_name;        /* avl tree by name */
1226 };
1227 
1228 typedef union phyint_list_u {
1229         struct  _phyint_list_s_ phyint_list_s;
1230         char    phyint_list_filler[CACHE_ALIGN(_phyint_list_s_)];
1231 } phyint_list_t;
1232 
1233 #define phyint_list_avl_by_index        phyint_list_s.phyint_list_avl_by_index
1234 #define phyint_list_avl_by_name         phyint_list_s.phyint_list_avl_by_name
1235 
1236 /*
1237  * Fragmentation hash bucket
1238  */
1239 typedef struct ipfb_s {
1240         struct ipf_s    *ipfb_ipf;      /* List of ... */
1241         size_t          ipfb_count;     /* Count of bytes used by frag(s) */
1242         kmutex_t        ipfb_lock;      /* Protect all ipf in list */
1243         uint_t          ipfb_frag_pkts; /* num of distinct fragmented pkts */
1244 } ipfb_t;
1245 
1246 /*
1247  * IRE bucket structure. Usually there is an array of such structures,
1248  * each pointing to a linked list of ires. irb_refcnt counts the number
1249  * of walkers of a given hash bucket. Usually the reference count is
1250  * bumped up if the walker wants no IRES to be DELETED while walking the
1251  * list. Bumping up does not PREVENT ADDITION. This allows walking a given
1252  * hash bucket without stumbling up on a free pointer.
1253  *
1254  * irb_t structures in ip_ftable are dynamically allocated and freed.
1255  * In order to identify the irb_t structures that can be safely kmem_free'd
1256  * we need to ensure that
1257  *  - the irb_refcnt is quiescent, indicating no other walkers,
1258  *  - no other threads or ire's are holding references to the irb,
1259  *      i.e., irb_nire == 0,
1260  *  - there are no active ire's in the bucket, i.e., irb_ire_cnt == 0
1261  */
1262 typedef struct irb {
1263         struct ire_s    *irb_ire;       /* First ire in this bucket */
1264                                         /* Should be first in this struct */
1265         krwlock_t       irb_lock;       /* Protect this bucket */
1266         uint_t          irb_refcnt;     /* Protected by irb_lock */
1267         uchar_t         irb_marks;      /* CONDEMNED ires in this bucket ? */
1268 #define IRB_MARK_CONDEMNED      0x0001  /* Contains some IRE_IS_CONDEMNED */
1269 #define IRB_MARK_DYNAMIC        0x0002  /* Dynamically allocated */
1270         /* Once IPv6 uses radix then IRB_MARK_DYNAMIC will be always be set */
1271         uint_t          irb_ire_cnt;    /* Num of active IRE in this bucket */
1272         int             irb_nire;       /* Num of ftable ire's that ref irb */
1273         ip_stack_t      *irb_ipst;      /* Does not have a netstack_hold */
1274 } irb_t;
1275 
1276 /*
1277  * This is the structure used to store the multicast physical addresses
1278  * that an interface has joined.
1279  * The refcnt keeps track of the number of multicast IP addresses mapping
1280  * to a physical multicast address.
1281  */
1282 typedef struct multiphysaddr_s {
1283         struct  multiphysaddr_s  *mpa_next;
1284         char    mpa_addr[IP_MAX_HW_LEN];
1285         int     mpa_refcnt;
1286 } multiphysaddr_t;
1287 
1288 #define IRB2RT(irb)     (rt_t *)((caddr_t)(irb) - offsetof(rt_t, rt_irb))
1289 
1290 /* Forward declarations */
1291 struct dce_s;
1292 typedef struct dce_s dce_t;
1293 struct ire_s;
1294 typedef struct ire_s ire_t;
1295 struct ncec_s;
1296 typedef struct ncec_s ncec_t;
1297 struct nce_s;
1298 typedef struct nce_s nce_t;
1299 struct ip_recv_attr_s;
1300 typedef struct ip_recv_attr_s ip_recv_attr_t;
1301 struct ip_xmit_attr_s;
1302 typedef struct ip_xmit_attr_s ip_xmit_attr_t;
1303 
1304 struct tsol_ire_gw_secattr_s;
1305 typedef struct tsol_ire_gw_secattr_s tsol_ire_gw_secattr_t;
1306 
1307 /*
1308  * This is a structure for a one-element route cache that is passed
1309  * by reference between ip_input and ill_inputfn.
1310  */
1311 typedef struct {
1312         ire_t           *rtc_ire;
1313         ipaddr_t        rtc_ipaddr;
1314         in6_addr_t      rtc_ip6addr;
1315 } rtc_t;
1316 
1317 /*
1318  * Note: Temporarily use 64 bits, and will probably go back to 32 bits after
1319  * more cleanup work is done.
1320  */
1321 typedef uint64_t iaflags_t;
1322 
1323 /* The ill input function pointer type */
1324 typedef void (*pfillinput_t)(mblk_t *, void *, void *, ip_recv_attr_t *,
1325     rtc_t *);
1326 
1327 /* The ire receive function pointer type */
1328 typedef void (*pfirerecv_t)(ire_t *, mblk_t *, void *, ip_recv_attr_t *);
1329 
1330 /* The ire send and postfrag function pointer types */
1331 typedef int (*pfiresend_t)(ire_t *, mblk_t *, void *,
1332     ip_xmit_attr_t *, uint32_t *);
1333 typedef int (*pfirepostfrag_t)(mblk_t *, nce_t *, iaflags_t, uint_t, uint32_t,
1334     zoneid_t, zoneid_t, uintptr_t *);
1335 
1336 
1337 #define IP_V4_G_HEAD    0
1338 #define IP_V6_G_HEAD    1
1339 
1340 #define MAX_G_HEADS     2
1341 
1342 /*
1343  * unpadded ill_if structure
1344  */
1345 struct  _ill_if_s_ {
1346         union ill_if_u  *illif_next;
1347         union ill_if_u  *illif_prev;
1348         avl_tree_t      illif_avl_by_ppa;       /* AVL tree sorted on ppa */
1349         vmem_t          *illif_ppa_arena;       /* ppa index space */
1350         uint16_t        illif_mcast_v1;         /* hints for              */
1351         uint16_t        illif_mcast_v2;         /* [igmp|mld]_slowtimo    */
1352         int             illif_name_len;         /* name length */
1353         char            illif_name[LIFNAMSIZ];  /* name of interface type */
1354 };
1355 
1356 /* cache aligned ill_if structure */
1357 typedef union   ill_if_u {
1358         struct  _ill_if_s_ ill_if_s;
1359         char    illif_filler[CACHE_ALIGN(_ill_if_s_)];
1360 } ill_if_t;
1361 
1362 #define illif_next              ill_if_s.illif_next
1363 #define illif_prev              ill_if_s.illif_prev
1364 #define illif_avl_by_ppa        ill_if_s.illif_avl_by_ppa
1365 #define illif_ppa_arena         ill_if_s.illif_ppa_arena
1366 #define illif_mcast_v1          ill_if_s.illif_mcast_v1
1367 #define illif_mcast_v2          ill_if_s.illif_mcast_v2
1368 #define illif_name              ill_if_s.illif_name
1369 #define illif_name_len          ill_if_s.illif_name_len
1370 
1371 typedef struct ill_walk_context_s {
1372         int     ctx_current_list; /* current list being searched */
1373         int     ctx_last_list;   /* last list to search */
1374 } ill_walk_context_t;
1375 
1376 /*
1377  * ill_g_heads structure, one for IPV4 and one for IPV6
1378  */
1379 struct _ill_g_head_s_ {
1380         ill_if_t        *ill_g_list_head;
1381         ill_if_t        *ill_g_list_tail;
1382 };
1383 
1384 typedef union ill_g_head_u {
1385         struct _ill_g_head_s_ ill_g_head_s;
1386         char    ill_g_head_filler[CACHE_ALIGN(_ill_g_head_s_)];
1387 } ill_g_head_t;
1388 
1389 #define ill_g_list_head ill_g_head_s.ill_g_list_head
1390 #define ill_g_list_tail ill_g_head_s.ill_g_list_tail
1391 
1392 #define IP_V4_ILL_G_LIST(ipst)  \
1393         (ipst)->ips_ill_g_heads[IP_V4_G_HEAD].ill_g_list_head
1394 #define IP_V6_ILL_G_LIST(ipst)  \
1395         (ipst)->ips_ill_g_heads[IP_V6_G_HEAD].ill_g_list_head
1396 #define IP_VX_ILL_G_LIST(i, ipst)       \
1397         (ipst)->ips_ill_g_heads[i].ill_g_list_head
1398 
1399 #define ILL_START_WALK_V4(ctx_ptr, ipst)        \
1400         ill_first(IP_V4_G_HEAD, IP_V4_G_HEAD, ctx_ptr, ipst)
1401 #define ILL_START_WALK_V6(ctx_ptr, ipst)        \
1402         ill_first(IP_V6_G_HEAD, IP_V6_G_HEAD, ctx_ptr, ipst)
1403 #define ILL_START_WALK_ALL(ctx_ptr, ipst)       \
1404         ill_first(MAX_G_HEADS, MAX_G_HEADS, ctx_ptr, ipst)
1405 
1406 /*
1407  * Capabilities, possible flags for ill_capabilities.
1408  */
1409 #define ILL_CAPAB_LSO           0x04            /* Large Send Offload */
1410 #define ILL_CAPAB_HCKSUM        0x08            /* Hardware checksumming */
1411 #define ILL_CAPAB_ZEROCOPY      0x10            /* Zero-copy */
1412 #define ILL_CAPAB_DLD           0x20            /* DLD capabilities */
1413 #define ILL_CAPAB_DLD_POLL      0x40            /* Polling */
1414 #define ILL_CAPAB_DLD_DIRECT    0x80            /* Direct function call */
1415 
1416 /*
1417  * Per-ill Hardware Checksumming capbilities.
1418  */
1419 typedef struct ill_hcksum_capab_s ill_hcksum_capab_t;
1420 
1421 /*
1422  * Per-ill Zero-copy capabilities.
1423  */
1424 typedef struct ill_zerocopy_capab_s ill_zerocopy_capab_t;
1425 
1426 /*
1427  * DLD capbilities.
1428  */
1429 typedef struct ill_dld_capab_s ill_dld_capab_t;
1430 
1431 /*
1432  * Per-ill polling resource map.
1433  */
1434 typedef struct ill_rx_ring ill_rx_ring_t;
1435 
1436 /*
1437  * Per-ill Large Send Offload capabilities.
1438  */
1439 typedef struct ill_lso_capab_s ill_lso_capab_t;
1440 
1441 /* The following are ill_state_flags */
1442 #define ILL_LL_SUBNET_PENDING   0x01    /* Waiting for DL_INFO_ACK from drv */
1443 #define ILL_CONDEMNED           0x02    /* No more new ref's to the ILL */
1444 #define ILL_DL_UNBIND_IN_PROGRESS       0x04    /* UNBIND_REQ is sent */
1445 /*
1446  * ILL_DOWN_IN_PROGRESS is set to ensure the following:
1447  * - no packets are sent to the driver after the DL_UNBIND_REQ is sent,
1448  * - no longstanding references will be acquired on objects that are being
1449  *   brought down.
1450  */
1451 #define ILL_DOWN_IN_PROGRESS    0x08
1452 
1453 /* Is this an ILL whose source address is used by other ILL's ? */
1454 #define IS_USESRC_ILL(ill)                      \
1455         (((ill)->ill_usesrc_ifindex == 0) && \
1456         ((ill)->ill_usesrc_grp_next != NULL))
1457 
1458 /* Is this a client/consumer of the usesrc ILL ? */
1459 #define IS_USESRC_CLI_ILL(ill)                  \
1460         (((ill)->ill_usesrc_ifindex != 0) && \
1461         ((ill)->ill_usesrc_grp_next != NULL))
1462 
1463 /* Is this an virtual network interface (vni) ILL ? */
1464 #define IS_VNI(ill)                                                     \
1465         (((ill)->ill_phyint->phyint_flags & (PHYI_LOOPBACK|PHYI_VIRTUAL)) == \
1466         PHYI_VIRTUAL)
1467 
1468 /* Is this a loopback ILL? */
1469 #define IS_LOOPBACK(ill) \
1470         ((ill)->ill_phyint->phyint_flags & PHYI_LOOPBACK)
1471 
1472 /* Is this an IPMP meta-interface ILL? */
1473 #define IS_IPMP(ill)                                                    \
1474         ((ill)->ill_phyint->phyint_flags & PHYI_IPMP)
1475 
1476 /* Is this ILL under an IPMP meta-interface? (aka "in a group?") */
1477 #define IS_UNDER_IPMP(ill)                                              \
1478         ((ill)->ill_grp != NULL && !IS_IPMP(ill))
1479 
1480 /* Is ill1 in the same illgrp as ill2? */
1481 #define IS_IN_SAME_ILLGRP(ill1, ill2)                                   \
1482         ((ill1)->ill_grp != NULL && ((ill1)->ill_grp == (ill2)->ill_grp))
1483 
1484 /* Is ill1 on the same LAN as ill2? */
1485 #define IS_ON_SAME_LAN(ill1, ill2)                                      \
1486         ((ill1) == (ill2) || IS_IN_SAME_ILLGRP(ill1, ill2))
1487 
1488 #define ILL_OTHER(ill)                                                  \
1489         ((ill)->ill_isv6 ? (ill)->ill_phyint->phyint_illv4 :           \
1490             (ill)->ill_phyint->phyint_illv6)
1491 
1492 /*
1493  * IPMP group ILL state structure -- up to two per IPMP group (V4 and V6).
1494  * Created when the V4 and/or V6 IPMP meta-interface is I_PLINK'd.  It is
1495  * guaranteed to persist while there are interfaces of that type in the group.
1496  * In general, most fields are accessed outside of the IPSQ (e.g., in the
1497  * datapath), and thus use locks in addition to the IPSQ for protection.
1498  *
1499  * synchronization:             read                    write
1500  *
1501  *      ig_if                   ipsq or ill_g_lock      ipsq and ill_g_lock
1502  *      ig_actif                ipsq or ipmp_lock       ipsq and ipmp_lock
1503  *      ig_nactif               ipsq or ipmp_lock       ipsq and ipmp_lock
1504  *      ig_next_ill             ipsq or ipmp_lock       ipsq and ipmp_lock
1505  *      ig_ipmp_ill             write once              write once
1506  *      ig_cast_ill             ipsq or ipmp_lock       ipsq and ipmp_lock
1507  *      ig_arpent               ipsq                    ipsq
1508  *      ig_mtu                  ipsq                    ipsq
1509  *      ig_mc_mtu               ipsq                    ipsq
1510  */
1511 typedef struct ipmp_illgrp_s {
1512         list_t          ig_if;          /* list of all interfaces */
1513         list_t          ig_actif;       /* list of active interfaces */
1514         uint_t          ig_nactif;      /* number of active interfaces */
1515         struct ill_s    *ig_next_ill;   /* next active interface to use */
1516         struct ill_s    *ig_ipmp_ill;   /* backpointer to IPMP meta-interface */
1517         struct ill_s    *ig_cast_ill;   /* nominated ill for multi/broadcast */
1518         list_t          ig_arpent;      /* list of ARP entries */
1519         uint_t          ig_mtu;         /* ig_ipmp_ill->ill_mtu */
1520         uint_t          ig_mc_mtu;      /* ig_ipmp_ill->ill_mc_mtu */
1521 } ipmp_illgrp_t;
1522 
1523 /*
1524  * IPMP group state structure -- one per IPMP group.  Created when the
1525  * IPMP meta-interface is plumbed; it is guaranteed to persist while there
1526  * are interfaces in it.
1527  *
1528  * ipmp_grp_t synchronization:          read                    write
1529  *
1530  *      gr_name                         ipmp_lock               ipmp_lock
1531  *      gr_ifname                       write once              write once
1532  *      gr_mactype                      ipmp_lock               ipmp_lock
1533  *      gr_phyint                       write once              write once
1534  *      gr_nif                          ipmp_lock               ipmp_lock
1535  *      gr_nactif                       ipsq                    ipsq
1536  *      gr_v4                           ipmp_lock               ipmp_lock
1537  *      gr_v6                           ipmp_lock               ipmp_lock
1538  *      gr_nv4                          ipmp_lock               ipmp_lock
1539  *      gr_nv6                          ipmp_lock               ipmp_lock
1540  *      gr_pendv4                       ipmp_lock               ipmp_lock
1541  *      gr_pendv6                       ipmp_lock               ipmp_lock
1542  *      gr_linkdownmp                   ipsq                    ipsq
1543  *      gr_ksp                          ipmp_lock               ipmp_lock
1544  *      gr_kstats0                      atomic                  atomic
1545  */
1546 typedef struct ipmp_grp_s {
1547         char            gr_name[LIFGRNAMSIZ];   /* group name */
1548         char            gr_ifname[LIFNAMSIZ];   /* interface name */
1549         t_uscalar_t     gr_mactype;     /* DLPI mactype of group */
1550         phyint_t        *gr_phyint;     /* IPMP group phyint */
1551         uint_t          gr_nif;         /* number of interfaces in group */
1552         uint_t          gr_nactif;      /* number of active interfaces */
1553         ipmp_illgrp_t   *gr_v4;         /* V4 group information */
1554         ipmp_illgrp_t   *gr_v6;         /* V6 group information */
1555         uint_t          gr_nv4;         /* number of ills in V4 group */
1556         uint_t          gr_nv6;         /* number of ills in V6 group */
1557         uint_t          gr_pendv4;      /* number of pending ills in V4 group */
1558         uint_t          gr_pendv6;      /* number of pending ills in V6 group */
1559         mblk_t          *gr_linkdownmp; /* message used to bring link down */
1560         kstat_t         *gr_ksp;        /* group kstat pointer */
1561         uint64_t        gr_kstats0[IPMP_KSTAT_MAX]; /* baseline group kstats */
1562 } ipmp_grp_t;
1563 
1564 /*
1565  * IPMP ARP entry -- one per SIOCS*ARP entry tied to the group.  Used to keep
1566  * ARP up-to-date as the active set of interfaces in the group changes.
1567  */
1568 typedef struct ipmp_arpent_s {
1569         ipaddr_t        ia_ipaddr;      /* IP address for this entry */
1570         boolean_t       ia_proxyarp;    /* proxy ARP entry? */
1571         boolean_t       ia_notified;    /* ARP notified about this entry? */
1572         list_node_t     ia_node;        /* next ARP entry in list */
1573         uint16_t        ia_flags;       /* nce_flags for the address */
1574         size_t          ia_lladdr_len;
1575         uchar_t         *ia_lladdr;
1576 } ipmp_arpent_t;
1577 
1578 struct arl_s;
1579 
1580 /*
1581  * Per-ill capabilities.
1582  */
1583 struct ill_hcksum_capab_s {
1584         uint_t  ill_hcksum_version;     /* interface version */
1585         uint_t  ill_hcksum_txflags;     /* capabilities on transmit */
1586 };
1587 
1588 struct ill_zerocopy_capab_s {
1589         uint_t  ill_zerocopy_version;   /* interface version */
1590         uint_t  ill_zerocopy_flags;     /* capabilities */
1591 };
1592 
1593 struct ill_lso_capab_s {
1594         uint_t  ill_lso_flags;          /* capabilities */
1595         uint_t  ill_lso_max;            /* maximum size of payload */
1596 };
1597 
1598 /*
1599  * IP Lower level Structure.
1600  * Instance data structure in ip_open when there is a device below us.
1601  */
1602 typedef struct ill_s {
1603         pfillinput_t ill_inputfn;       /* Fast input function selector */
1604         ill_if_t *ill_ifptr;            /* pointer to interface type */
1605         queue_t *ill_rq;                /* Read queue. */
1606         queue_t *ill_wq;                /* Write queue. */
1607 
1608         int     ill_error;              /* Error value sent up by device. */
1609 
1610         ipif_t  *ill_ipif;              /* Interface chain for this ILL. */
1611 
1612         uint_t  ill_ipif_up_count;      /* Number of IPIFs currently up. */
1613         uint_t  ill_max_frag;           /* Max IDU from DLPI. */
1614         uint_t  ill_current_frag;       /* Current IDU from DLPI. */
1615         uint_t  ill_mtu;                /* User-specified MTU; SIOCSLIFMTU */
1616         uint_t  ill_mc_mtu;             /* MTU for multi/broadcast */
1617         uint_t  ill_metric;             /* BSD if metric, for compatibility. */
1618         char    *ill_name;              /* Our name. */
1619         uint_t  ill_ipif_dup_count;     /* Number of duplicate addresses. */
1620         uint_t  ill_name_length;        /* Name length, incl. terminator. */
1621         uint_t  ill_net_type;           /* IRE_IF_RESOLVER/IRE_IF_NORESOLVER. */
1622         /*
1623          * Physical Point of Attachment num.  If DLPI style 1 provider
1624          * then this is derived from the devname.
1625          */
1626         uint_t  ill_ppa;
1627         t_uscalar_t     ill_sap;
1628         t_scalar_t      ill_sap_length; /* Including sign (for position) */
1629         uint_t  ill_phys_addr_length;   /* Excluding the sap. */
1630         uint_t  ill_bcast_addr_length;  /* Only set when the DL provider */
1631                                         /* supports broadcast. */
1632         t_uscalar_t     ill_mactype;
1633         uint8_t *ill_frag_ptr;          /* Reassembly state. */
1634         timeout_id_t ill_frag_timer_id; /* timeout id for the frag timer */
1635         ipfb_t  *ill_frag_hash_tbl;     /* Fragment hash list head. */
1636 
1637         krwlock_t ill_mcast_lock;       /* Protects multicast state */
1638         kmutex_t ill_mcast_serializer;  /* Serialize across ilg and ilm state */
1639         ilm_t   *ill_ilm;               /* Multicast membership for ill */
1640         uint_t  ill_global_timer;       /* for IGMPv3/MLDv2 general queries */
1641         int     ill_mcast_type;         /* type of router which is querier */
1642                                         /* on this interface */
1643         uint16_t ill_mcast_v1_time;     /* # slow timeouts since last v1 qry */
1644         uint16_t ill_mcast_v2_time;     /* # slow timeouts since last v2 qry */
1645         uint8_t ill_mcast_v1_tset;      /* 1 => timer is set; 0 => not set */
1646         uint8_t ill_mcast_v2_tset;      /* 1 => timer is set; 0 => not set */
1647 
1648         uint8_t ill_mcast_rv;           /* IGMPv3/MLDv2 robustness variable */
1649         int     ill_mcast_qi;           /* IGMPv3/MLDv2 query interval var */
1650 
1651         /*
1652          * All non-NULL cells between 'ill_first_mp_to_free' and
1653          * 'ill_last_mp_to_free' are freed in ill_delete.
1654          */
1655 #define ill_first_mp_to_free    ill_bcast_mp
1656         mblk_t  *ill_bcast_mp;          /* DLPI header for broadcasts. */
1657         mblk_t  *ill_unbind_mp;         /* unbind mp from ill_dl_up() */
1658         mblk_t  *ill_promiscoff_mp;     /* for ill_leave_allmulti() */
1659         mblk_t  *ill_dlpi_deferred;     /* b_next chain of control messages */
1660         mblk_t  *ill_dest_addr_mp;      /* mblk which holds ill_dest_addr */
1661         mblk_t  *ill_replumb_mp;        /* replumb mp from ill_replumb() */
1662         mblk_t  *ill_phys_addr_mp;      /* mblk which holds ill_phys_addr */
1663         mblk_t  *ill_mcast_deferred;    /* b_next chain of IGMP/MLD packets */
1664 #define ill_last_mp_to_free     ill_mcast_deferred
1665 
1666         cred_t  *ill_credp;             /* opener's credentials */
1667         uint8_t *ill_phys_addr;         /* ill_phys_addr_mp->b_rptr + off */
1668         uint8_t *ill_dest_addr;         /* ill_dest_addr_mp->b_rptr + off */
1669 
1670         uint_t  ill_state_flags;        /* see ILL_* flags above */
1671 
1672         /* Following bit fields protected by ipsq_t */
1673         uint_t
1674                 ill_needs_attach : 1,
1675                 ill_reserved : 1,
1676                 ill_isv6 : 1,
1677                 ill_dlpi_style_set : 1,
1678 
1679                 ill_ifname_pending : 1,
1680                 ill_logical_down : 1,
1681                 ill_dl_up : 1,
1682                 ill_up_ipifs : 1,
1683 
1684                 ill_note_link : 1,      /* supports link-up notification */
1685                 ill_capab_reneg : 1, /* capability renegotiation to be done */
1686                 ill_dld_capab_inprog : 1, /* direct dld capab call in prog */
1687                 ill_need_recover_multicast : 1,
1688 
1689                 ill_replumbing : 1,
1690                 ill_arl_dlpi_pending : 1,
1691                 ill_grp_pending : 1,
1692 
1693                 ill_pad_to_bit_31 : 17;
1694 
1695         /* Following bit fields protected by ill_lock */
1696         uint_t
1697                 ill_fragtimer_executing : 1,
1698                 ill_fragtimer_needrestart : 1,
1699                 ill_manual_token : 1,   /* system won't override ill_token */
1700                 /*
1701                  * ill_manual_linklocal : system will not change the
1702                  * linklocal whenever ill_token changes.
1703                  */
1704                 ill_manual_linklocal : 1,
1705 
1706                 ill_manual_dst_linklocal : 1, /* same for pt-pt dst linklocal */
1707 
1708                 ill_pad_bit_31 : 27;
1709 
1710         /*
1711          * Used in SIOCSIFMUXID and SIOCGIFMUXID for 'ifconfig unplumb'.
1712          */
1713         int     ill_muxid;              /* muxid returned from plink */
1714 
1715         /* Used for IP frag reassembly throttling on a per ILL basis.  */
1716         uint_t  ill_ipf_gen;            /* Generation of next fragment queue */
1717         uint_t  ill_frag_count;         /* Count of all reassembly mblk bytes */
1718         uint_t  ill_frag_free_num_pkts;  /* num of fragmented packets to free */
1719         clock_t ill_last_frag_clean_time; /* time when frag's were pruned */
1720         int     ill_type;               /* From <net/if_types.h> */
1721         uint_t  ill_dlpi_multicast_state;       /* See below IDS_* */
1722         uint_t  ill_dlpi_fastpath_state;        /* See below IDS_* */
1723 
1724         /*
1725          * Capabilities related fields.
1726          */
1727         uint_t  ill_dlpi_capab_state;   /* State of capability query, IDCS_* */
1728         uint_t  ill_capab_pending_cnt;
1729         uint64_t ill_capabilities;      /* Enabled capabilities, ILL_CAPAB_* */
1730         ill_hcksum_capab_t *ill_hcksum_capab; /* H/W cksumming capabilities */
1731         ill_zerocopy_capab_t *ill_zerocopy_capab; /* Zero-copy capabilities */
1732         ill_dld_capab_t *ill_dld_capab; /* DLD capabilities */
1733         ill_lso_capab_t *ill_lso_capab; /* Large Segment Offload capabilities */
1734         mblk_t  *ill_capab_reset_mp;    /* Preallocated mblk for capab reset */
1735 
1736         uint8_t ill_max_hops;   /* Maximum hops for any logical interface */
1737         uint_t  ill_user_mtu;   /* User-specified MTU via SIOCSLIFLNKINFO */
1738         uint32_t ill_reachable_time;    /* Value for ND algorithm in msec */
1739         uint32_t ill_reachable_retrans_time; /* Value for ND algorithm msec */
1740         uint_t  ill_max_buf;            /* Max # of req to buffer for ND */
1741         in6_addr_t      ill_token;      /* IPv6 interface id */
1742         in6_addr_t      ill_dest_token; /* Destination IPv6 interface id */
1743         uint_t          ill_token_length;
1744         uint32_t        ill_xmit_count;         /* ndp max multicast xmits */
1745         mib2_ipIfStatsEntry_t   *ill_ip_mib;    /* ver indep. interface mib */
1746         mib2_ipv6IfIcmpEntry_t  *ill_icmp6_mib; /* Per interface mib */
1747 
1748         phyint_t                *ill_phyint;
1749         uint64_t                ill_flags;
1750 
1751         kmutex_t        ill_lock;       /* Please see table below */
1752         /*
1753          * The ill_nd_lla* fields handle the link layer address option
1754          * from neighbor discovery. This is used for external IPv6
1755          * address resolution.
1756          */
1757         mblk_t          *ill_nd_lla_mp; /* mblk which holds ill_nd_lla */
1758         uint8_t         *ill_nd_lla;    /* Link Layer Address */
1759         uint_t          ill_nd_lla_len; /* Link Layer Address length */
1760         /*
1761          * We have 4 phys_addr_req's sent down. This field keeps track
1762          * of which one is pending.
1763          */
1764         t_uscalar_t     ill_phys_addr_pend; /* which dl_phys_addr_req pending */
1765         /*
1766          * Used to save errors that occur during plumbing
1767          */
1768         uint_t          ill_ifname_pending_err;
1769         avl_node_t      ill_avl_byppa; /* avl node based on ppa */
1770         list_t          ill_nce; /* pointer to nce_s list */
1771         uint_t          ill_refcnt;     /* active refcnt by threads */
1772         uint_t          ill_ire_cnt;    /* ires associated with this ill */
1773         kcondvar_t      ill_cv;
1774         uint_t          ill_ncec_cnt;   /* ncecs associated with this ill */
1775         uint_t          ill_nce_cnt;    /* nces associated with this ill */
1776         uint_t          ill_waiters;    /* threads waiting in ipsq_enter */
1777         /*
1778          * Contains the upper read queue pointer of the module immediately
1779          * beneath IP.  This field allows IP to validate sub-capability
1780          * acknowledgments coming up from downstream.
1781          */
1782         queue_t         *ill_lmod_rq;   /* read queue pointer of module below */
1783         uint_t          ill_lmod_cnt;   /* number of modules beneath IP */
1784         ip_m_t          *ill_media;     /* media specific params/functions */
1785         t_uscalar_t     ill_dlpi_pending; /* Last DLPI primitive issued */
1786         uint_t          ill_usesrc_ifindex; /* use src addr from this ILL */
1787         struct ill_s    *ill_usesrc_grp_next; /* Next ILL in the usesrc group */
1788         boolean_t       ill_trace_disable;      /* True when alloc fails */
1789         zoneid_t        ill_zoneid;
1790         ip_stack_t      *ill_ipst;      /* Corresponds to a netstack_hold */
1791         uint32_t        ill_dhcpinit;   /* IP_DHCPINIT_IFs for ill */
1792         void            *ill_flownotify_mh; /* Tx flow ctl, mac cb handle */
1793         uint_t          ill_ilm_cnt;    /* ilms referencing this ill */
1794         uint_t          ill_ipallmulti_cnt; /* ip_join_allmulti() calls */
1795         ilm_t           *ill_ipallmulti_ilm;
1796 
1797         mblk_t          *ill_saved_ire_mp; /* Allocated for each extra IRE */
1798                                         /* with ire_ill set so they can */
1799                                         /* survive the ill going down and up. */
1800         kmutex_t        ill_saved_ire_lock; /* Protects ill_saved_ire_mp, cnt */
1801         uint_t          ill_saved_ire_cnt;      /* # entries */
1802         struct arl_ill_common_s    *ill_common;
1803         ire_t           *ill_ire_multicast; /* IRE_MULTICAST for ill */
1804         clock_t         ill_defend_start;   /* start of 1 hour period */
1805         uint_t          ill_defend_count;   /* # of announce/defends per ill */
1806         /*
1807          * IPMP fields.
1808          */
1809         ipmp_illgrp_t   *ill_grp;       /* IPMP group information */
1810         list_node_t     ill_actnode;    /* next active ill in group */
1811         list_node_t     ill_grpnode;    /* next ill in group */
1812         ipif_t          *ill_src_ipif;  /* source address selection rotor */
1813         ipif_t          *ill_move_ipif; /* ipif awaiting move to new ill */
1814         boolean_t       ill_nom_cast;   /* nominated for mcast/bcast */
1815         uint_t          ill_bound_cnt;  /* # of data addresses bound to ill */
1816         ipif_t          *ill_bound_ipif; /* ipif chain bound to ill */
1817         timeout_id_t    ill_refresh_tid; /* ill refresh retry timeout id */
1818 
1819         uint32_t        ill_mrouter_cnt; /* mrouter allmulti joins */
1820         uint32_t        ill_allowed_ips_cnt;
1821         in6_addr_t      *ill_allowed_ips;
1822 
1823         /* list of multicast physical addresses joined on this ill */
1824         multiphysaddr_t *ill_mphysaddr_list;
1825 } ill_t;
1826 
1827 /*
1828  * ILL_FREE_OK() means that there are no incoming pointer references
1829  * to the ill.
1830  */
1831 #define ILL_FREE_OK(ill)                                        \
1832         ((ill)->ill_ire_cnt == 0 && (ill)->ill_ilm_cnt == 0 &&    \
1833         (ill)->ill_ncec_cnt == 0 && (ill)->ill_nce_cnt == 0)
1834 
1835 /*
1836  * An ipif/ill can be marked down only when the ire and ncec references
1837  * to that ipif/ill goes to zero. ILL_DOWN_OK() is a necessary condition
1838  * quiescence checks. See comments above IPIF_DOWN_OK for details
1839  * on why ires and nces are selectively considered for this macro.
1840  */
1841 #define ILL_DOWN_OK(ill)                                        \
1842         (ill->ill_ire_cnt == 0 && ill->ill_ncec_cnt == 0 &&       \
1843         ill->ill_nce_cnt == 0)
1844 
1845 /*
1846  * The following table lists the protection levels of the various members
1847  * of the ill_t. Same notation as that used for ipif_t above is used.
1848  *
1849  *                              Write                   Read
1850  *
1851  * ill_ifptr                    ill_g_lock + s          Write once
1852  * ill_rq                       ipsq                    Write once
1853  * ill_wq                       ipsq                    Write once
1854  *
1855  * ill_error                    ipsq                    None
1856  * ill_ipif                     ill_g_lock + ipsq       ill_g_lock OR ipsq
1857  * ill_ipif_up_count            ill_lock + ipsq         ill_lock OR ipsq
1858  * ill_max_frag                 ill_lock                ill_lock
1859  * ill_current_frag             ill_lock                ill_lock
1860  *
1861  * ill_name                     ill_g_lock + ipsq       Write once
1862  * ill_name_length              ill_g_lock + ipsq       Write once
1863  * ill_ndd_name                 ipsq                    Write once
1864  * ill_net_type                 ipsq                    Write once
1865  * ill_ppa                      ill_g_lock + ipsq       Write once
1866  * ill_sap                      ipsq + down ill         Write once
1867  * ill_sap_length               ipsq + down ill         Write once
1868  * ill_phys_addr_length         ipsq + down ill         Write once
1869  *
1870  * ill_bcast_addr_length        ipsq                    ipsq
1871  * ill_mactype                  ipsq                    ipsq
1872  * ill_frag_ptr                 ipsq                    ipsq
1873  *
1874  * ill_frag_timer_id            ill_lock                ill_lock
1875  * ill_frag_hash_tbl            ipsq                    up ill
1876  * ill_ilm                      ill_mcast_lock(WRITER)  ill_mcast_lock(READER)
1877  * ill_global_timer             ill_mcast_lock(WRITER)  ill_mcast_lock(READER)
1878  * ill_mcast_type               ill_mcast_lock(WRITER)  ill_mcast_lock(READER)
1879  * ill_mcast_v1_time            ill_mcast_lock(WRITER)  ill_mcast_lock(READER)
1880  * ill_mcast_v2_time            ill_mcast_lock(WRITER)  ill_mcast_lock(READER)
1881  * ill_mcast_v1_tset            ill_mcast_lock(WRITER)  ill_mcast_lock(READER)
1882  * ill_mcast_v2_tset            ill_mcast_lock(WRITER)  ill_mcast_lock(READER)
1883  * ill_mcast_rv                 ill_mcast_lock(WRITER)  ill_mcast_lock(READER)
1884  * ill_mcast_qi                 ill_mcast_lock(WRITER)  ill_mcast_lock(READER)
1885  *
1886  * ill_down_mp                  ipsq                    ipsq
1887  * ill_dlpi_deferred            ill_lock                ill_lock
1888  * ill_dlpi_pending             ipsq + ill_lock         ipsq or ill_lock or
1889  *                                                      absence of ipsq writer.
1890  * ill_phys_addr_mp             ipsq + down ill         only when ill is up
1891  * ill_mcast_deferred           ill_lock                ill_lock
1892  * ill_phys_addr                ipsq + down ill         only when ill is up
1893  * ill_dest_addr_mp             ipsq + down ill         only when ill is up
1894  * ill_dest_addr                ipsq + down ill         only when ill is up
1895  *
1896  * ill_state_flags              ill_lock                ill_lock
1897  * exclusive bit flags          ipsq_t                  ipsq_t
1898  * shared bit flags             ill_lock                ill_lock
1899  *
1900  * ill_muxid                    ipsq                    Not atomic
1901  *
1902  * ill_ipf_gen                  Not atomic
1903  * ill_frag_count               atomics                 atomics
1904  * ill_type                     ipsq + down ill         only when ill is up
1905  * ill_dlpi_multicast_state     ill_lock                ill_lock
1906  * ill_dlpi_fastpath_state      ill_lock                ill_lock
1907  * ill_dlpi_capab_state         ipsq                    ipsq
1908  * ill_max_hops                 ipsq                    Not atomic
1909  *
1910  * ill_mtu                      ill_lock                None
1911  * ill_mc_mtu                   ill_lock                None
1912  *
1913  * ill_user_mtu                 ipsq + ill_lock         ill_lock
1914  * ill_reachable_time           ipsq + ill_lock         ill_lock
1915  * ill_reachable_retrans_time   ipsq + ill_lock         ill_lock
1916  * ill_max_buf                  ipsq + ill_lock         ill_lock
1917  *
1918  * Next 2 fields need ill_lock because of the get ioctls. They should not
1919  * report partially updated results without executing in the ipsq.
1920  * ill_token                    ipsq + ill_lock         ill_lock
1921  * ill_token_length             ipsq + ill_lock         ill_lock
1922  * ill_dest_token               ipsq + down ill         only when ill is up
1923  * ill_xmit_count               ipsq + down ill         write once
1924  * ill_ip6_mib                  ipsq + down ill         only when ill is up
1925  * ill_icmp6_mib                ipsq + down ill         only when ill is up
1926  *
1927  * ill_phyint                   ipsq, ill_g_lock, ill_lock      Any of them
1928  * ill_flags                    ill_lock                ill_lock
1929  * ill_nd_lla_mp                ipsq + down ill         only when ill is up
1930  * ill_nd_lla                   ipsq + down ill         only when ill is up
1931  * ill_nd_lla_len               ipsq + down ill         only when ill is up
1932  * ill_phys_addr_pend           ipsq + down ill         only when ill is up
1933  * ill_ifname_pending_err       ipsq                    ipsq
1934  * ill_avl_byppa                ipsq, ill_g_lock        write once
1935  *
1936  * ill_fastpath_list            ill_lock                ill_lock
1937  * ill_refcnt                   ill_lock                ill_lock
1938  * ill_ire_cnt                  ill_lock                ill_lock
1939  * ill_cv                       ill_lock                ill_lock
1940  * ill_ncec_cnt                 ill_lock                ill_lock
1941  * ill_nce_cnt                  ill_lock                ill_lock
1942  * ill_ilm_cnt                  ill_lock                ill_lock
1943  * ill_src_ipif                 ill_g_lock              ill_g_lock
1944  * ill_trace                    ill_lock                ill_lock
1945  * ill_usesrc_grp_next          ill_g_usesrc_lock       ill_g_usesrc_lock
1946  * ill_dhcpinit                 atomics                 atomics
1947  * ill_flownotify_mh            write once              write once
1948  * ill_capab_pending_cnt        ipsq                    ipsq
1949  * ill_ipallmulti_cnt           ill_lock                ill_lock
1950  * ill_ipallmulti_ilm           ill_lock                ill_lock
1951  * ill_saved_ire_mp             ill_saved_ire_lock      ill_saved_ire_lock
1952  * ill_saved_ire_cnt            ill_saved_ire_lock      ill_saved_ire_lock
1953  * ill_arl                      ???                     ???
1954  * ill_ire_multicast            ipsq + quiescent        none
1955  * ill_bound_ipif               ipsq                    ipsq
1956  * ill_actnode                  ipsq + ipmp_lock        ipsq OR ipmp_lock
1957  * ill_grpnode                  ipsq + ill_g_lock       ipsq OR ill_g_lock
1958  * ill_src_ipif                 ill_g_lock              ill_g_lock
1959  * ill_move_ipif                ipsq                    ipsq
1960  * ill_nom_cast                 ipsq                    ipsq OR advisory
1961  * ill_refresh_tid              ill_lock                ill_lock
1962  * ill_grp (for IPMP ill)       write once              write once
1963  * ill_grp (for underlying ill) ipsq + ill_g_lock       ipsq OR ill_g_lock
1964  * ill_grp_pending              ill_mcast_serializer    ill_mcast_serializer
1965  * ill_mrouter_cnt              atomics                 atomics
1966  * ill_mphysaddr_list   ill_lock                ill_lock
1967  *
1968  * NOTE: It's OK to make heuristic decisions on an underlying interface
1969  *       by using IS_UNDER_IPMP() or comparing ill_grp's raw pointer value.
1970  */
1971 
1972 /*
1973  * For ioctl restart mechanism see ip_reprocess_ioctl()
1974  */
1975 struct ip_ioctl_cmd_s;
1976 
1977 typedef int (*ifunc_t)(ipif_t *, struct sockaddr_in *, queue_t *, mblk_t *,
1978     struct ip_ioctl_cmd_s *, void *);
1979 
1980 typedef struct ip_ioctl_cmd_s {
1981         int     ipi_cmd;
1982         size_t  ipi_copyin_size;
1983         uint_t  ipi_flags;
1984         uint_t  ipi_cmd_type;
1985         ifunc_t ipi_func;
1986         ifunc_t ipi_func_restart;
1987 } ip_ioctl_cmd_t;
1988 
1989 /*
1990  * ipi_cmd_type:
1991  *
1992  * IF_CMD               1       old style ifreq cmd
1993  * LIF_CMD              2       new style lifreq cmd
1994  * ARP_CMD              3       arpreq cmd
1995  * XARP_CMD             4       xarpreq cmd
1996  * MSFILT_CMD           5       multicast source filter cmd
1997  * MISC_CMD             6       misc cmd (not a more specific one above)
1998  */
1999 
2000 enum { IF_CMD = 1, LIF_CMD, ARP_CMD, XARP_CMD, MSFILT_CMD, MISC_CMD };
2001 
2002 #define IPI_DONTCARE    0       /* For ioctl encoded values that don't matter */
2003 
2004 /* Flag values in ipi_flags */
2005 #define IPI_PRIV        0x1     /* Root only command */
2006 #define IPI_MODOK       0x2     /* Permitted on mod instance of IP */
2007 #define IPI_WR          0x4     /* Need to grab writer access */
2008 #define IPI_GET_CMD     0x8     /* branch to mi_copyout on success */
2009 /*      unused          0x10    */
2010 #define IPI_NULL_BCONT  0x20    /* ioctl has not data and hence no b_cont */
2011 
2012 extern ip_ioctl_cmd_t   ip_ndx_ioctl_table[];
2013 extern ip_ioctl_cmd_t   ip_misc_ioctl_table[];
2014 extern int ip_ndx_ioctl_count;
2015 extern int ip_misc_ioctl_count;
2016 
2017 /* Passed down by ARP to IP during I_PLINK/I_PUNLINK */
2018 typedef struct ipmx_s {
2019         char    ipmx_name[LIFNAMSIZ];           /* if name */
2020         uint_t
2021                 ipmx_arpdev_stream : 1,         /* This is the arp stream */
2022                 ipmx_notused : 31;
2023 } ipmx_t;
2024 
2025 /*
2026  * State for detecting if a driver supports certain features.
2027  * Support for DL_ENABMULTI_REQ uses ill_dlpi_multicast_state.
2028  * Support for DLPI M_DATA fastpath uses ill_dlpi_fastpath_state.
2029  */
2030 #define IDS_UNKNOWN     0       /* No DLPI request sent */
2031 #define IDS_INPROGRESS  1       /* DLPI request sent */
2032 #define IDS_OK          2       /* DLPI request completed successfully */
2033 #define IDS_FAILED      3       /* DLPI request failed */
2034 
2035 /* Support for DL_CAPABILITY_REQ uses ill_dlpi_capab_state. */
2036 enum {
2037         IDCS_UNKNOWN,
2038         IDCS_PROBE_SENT,
2039         IDCS_OK,
2040         IDCS_RESET_SENT,
2041         IDCS_RENEG,
2042         IDCS_FAILED
2043 };
2044 
2045 /* Extended NDP Management Structure */
2046 typedef struct ipndp_s {
2047         ndgetf_t        ip_ndp_getf;
2048         ndsetf_t        ip_ndp_setf;
2049         caddr_t         ip_ndp_data;
2050         char            *ip_ndp_name;
2051 } ipndp_t;
2052 
2053 /* IXA Notification types */
2054 typedef enum {
2055         IXAN_LSO,       /* LSO capability change */
2056         IXAN_PMTU,      /* PMTU change */
2057         IXAN_ZCOPY      /* ZEROCOPY capability change */
2058 } ixa_notify_type_t;
2059 
2060 typedef uint_t ixa_notify_arg_t;
2061 
2062 typedef void    (*ixa_notify_t)(void *, ip_xmit_attr_t *ixa, ixa_notify_type_t,
2063     ixa_notify_arg_t);
2064 
2065 /*
2066  * Attribute flags that are common to the transmit and receive attributes
2067  */
2068 #define IAF_IS_IPV4             0x80000000      /* ipsec_*_v4 */
2069 #define IAF_TRUSTED_ICMP        0x40000000      /* ipsec_*_icmp_loopback */
2070 #define IAF_NO_LOOP_ZONEID_SET  0x20000000      /* Zone that shouldn't have */
2071                                                 /* a copy */
2072 #define IAF_LOOPBACK_COPY       0x10000000      /* For multi and broadcast */
2073 
2074 #define IAF_MASK                0xf0000000      /* Flags that are common */
2075 
2076 /*
2077  * Transmit side attributes used between the transport protocols and IP as
2078  * well as inside IP. It is also used to cache information in the conn_t i.e.
2079  * replaces conn_ire and the IPsec caching in the conn_t.
2080  */
2081 struct ip_xmit_attr_s {
2082         iaflags_t       ixa_flags;      /* IXAF_*. See below */
2083 
2084         uint32_t        ixa_free_flags; /* IXA_FREE_*. See below */
2085         uint32_t        ixa_refcnt;     /* Using atomics */
2086 
2087         /*
2088          * Always initialized independently of ixa_flags settings.
2089          * Used by ip_xmit so we keep them up front for cache locality.
2090          */
2091         uint32_t        ixa_xmit_hint;  /* For ECMP and GLD TX ring fanout */
2092         uint_t          ixa_pktlen;     /* Always set. For frag and stats */
2093         zoneid_t        ixa_zoneid;     /* Assumed always set */
2094 
2095         /* Always set for conn_ip_output(); might be stale */
2096         /*
2097          * Since TCP keeps the conn_t around past the process going away
2098          * we need to use the "notr" (e.g, ire_refhold_notr) for ixa_ire,
2099          * ixa_nce, and ixa_dce.
2100          */
2101         ire_t           *ixa_ire;       /* Forwarding table entry */
2102         uint_t          ixa_ire_generation;
2103         nce_t           *ixa_nce;       /* Neighbor cache entry */
2104         dce_t           *ixa_dce;       /* Destination cache entry */
2105         uint_t          ixa_dce_generation;
2106         uint_t          ixa_src_generation;     /* If IXAF_VERIFY_SOURCE */
2107 
2108         uint32_t        ixa_src_preferences;    /* prefs for src addr select */
2109         uint32_t        ixa_pmtu;               /* IXAF_VERIFY_PMTU */
2110 
2111         /* Set by ULP if IXAF_VERIFY_PMTU; otherwise set by IP */
2112         uint32_t        ixa_fragsize;
2113 
2114         int8_t          ixa_use_min_mtu;        /* IXAF_USE_MIN_MTU values */
2115 
2116         pfirepostfrag_t ixa_postfragfn;         /* Set internally in IP */
2117 
2118         in6_addr_t      ixa_nexthop_v6;         /* IXAF_NEXTHOP_SET */
2119 #define ixa_nexthop_v4  V4_PART_OF_V6(ixa_nexthop_v6)
2120 
2121         zoneid_t        ixa_no_loop_zoneid;     /* IXAF_NO_LOOP_ZONEID_SET */
2122 
2123         uint_t          ixa_scopeid;            /* For IPv6 link-locals */
2124 
2125         uint_t          ixa_broadcast_ttl;      /* IXAF_BROACAST_TTL_SET */
2126 
2127         uint_t          ixa_multicast_ttl;      /* Assumed set for multicast */
2128         uint_t          ixa_multicast_ifindex;  /* Assumed set for multicast */
2129         ipaddr_t        ixa_multicast_ifaddr;   /* Assumed set for multicast */
2130 
2131         int             ixa_raw_cksum_offset;   /* If IXAF_SET_RAW_CKSUM */
2132 
2133         uint32_t        ixa_ident;              /* For IPv6 fragment header */
2134 
2135         uint64_t        ixa_conn_id;            /* Used by DTrace */
2136         /*
2137          * Cached LSO information.
2138          */
2139         ill_lso_capab_t ixa_lso_capab;          /* Valid when IXAF_LSO_CAPAB */
2140 
2141         uint64_t        ixa_ipsec_policy_gen;   /* Generation from iph_gen */
2142         /*
2143          * The following IPsec fields are only initialized when
2144          * IXAF_IPSEC_SECURE is set. Otherwise they contain garbage.
2145          */
2146         ipsec_latch_t   *ixa_ipsec_latch;       /* Just the ids */
2147         struct ipsa_s   *ixa_ipsec_ah_sa;       /* Hard reference SA for AH */
2148         struct ipsa_s   *ixa_ipsec_esp_sa;      /* Hard reference SA for ESP */
2149         struct ipsec_policy_s   *ixa_ipsec_policy; /* why are we here? */
2150         struct ipsec_action_s   *ixa_ipsec_action; /* For reflected packets */
2151         ipsa_ref_t      ixa_ipsec_ref[2];       /* Soft reference to SA */
2152                                                 /* 0: ESP, 1: AH */
2153 
2154         /*
2155          * The selectors here are potentially different than the SPD rule's
2156          * selectors, and we need to have both available for IKEv2.
2157          *
2158          * NOTE: "Source" and "Dest" are w.r.t. outbound datagrams.  Ports can
2159          *       be zero, and the protocol number is needed to make the ports
2160          *       significant.
2161          */
2162         uint16_t ixa_ipsec_src_port;    /* Source port number of d-gram. */
2163         uint16_t ixa_ipsec_dst_port;    /* Destination port number of d-gram. */
2164         uint8_t  ixa_ipsec_icmp_type;   /* ICMP type of d-gram */
2165         uint8_t  ixa_ipsec_icmp_code;   /* ICMP code of d-gram */
2166 
2167         sa_family_t ixa_ipsec_inaf;     /* Inner address family */
2168 #define IXA_MAX_ADDRLEN 4       /* Max addr len. (in 32-bit words) */
2169         uint32_t ixa_ipsec_insrc[IXA_MAX_ADDRLEN];      /* Inner src address */
2170         uint32_t ixa_ipsec_indst[IXA_MAX_ADDRLEN];      /* Inner dest address */
2171         uint8_t  ixa_ipsec_insrcpfx;    /* Inner source prefix */
2172         uint8_t  ixa_ipsec_indstpfx;    /* Inner destination prefix */
2173 
2174         uint8_t ixa_ipsec_proto;        /* IP protocol number for d-gram. */
2175 
2176         /* Always initialized independently of ixa_flags settings */
2177         uint_t          ixa_ifindex;    /* Assumed always set */
2178         uint16_t        ixa_ip_hdr_length; /* Points to ULP header */
2179         uint8_t         ixa_protocol;   /* Protocol number for ULP cksum */
2180         ts_label_t      *ixa_tsl;       /* Always set. NULL if not TX */
2181         ip_stack_t      *ixa_ipst;      /* Always set */
2182         uint32_t        ixa_extra_ident; /* Set if LSO */
2183         cred_t          *ixa_cred;      /* For getpeerucred */
2184         pid_t           ixa_cpid;       /* For getpeerucred */
2185 
2186 #ifdef DEBUG
2187         kthread_t       *ixa_curthread; /* For serialization assert */
2188 #endif
2189         squeue_t        *ixa_sqp;       /* Set from conn_sqp as a hint */
2190         uintptr_t       ixa_cookie;     /* cookie to use for tx flow control */
2191 
2192         /*
2193          * Must be set by ULP if any of IXAF_VERIFY_LSO, IXAF_VERIFY_PMTU,
2194          * or IXAF_VERIFY_ZCOPY is set.
2195          */
2196         ixa_notify_t    ixa_notify;     /* Registered upcall notify function */
2197         void            *ixa_notify_cookie; /* ULP cookie for ixa_notify */
2198 };
2199 
2200 /*
2201  * Flags to indicate which transmit attributes are set.
2202  * Split into "xxx_SET" ones which indicate that the "xxx" field it set, and
2203  * single flags.
2204  */
2205 #define IXAF_REACH_CONF         0x00000001      /* Reachability confirmation */
2206 #define IXAF_BROADCAST_TTL_SET  0x00000002      /* ixa_broadcast_ttl valid */
2207 #define IXAF_SET_SOURCE         0x00000004      /* Replace if broadcast */
2208 #define IXAF_USE_MIN_MTU        0x00000008      /* IPV6_USE_MIN_MTU */
2209 
2210 #define IXAF_DONTFRAG           0x00000010      /* IP*_DONTFRAG */
2211 #define IXAF_VERIFY_PMTU        0x00000020      /* ixa_pmtu/ixa_fragsize set */
2212 #define IXAF_PMTU_DISCOVERY     0x00000040      /* Create/use PMTU state */
2213 #define IXAF_MULTICAST_LOOP     0x00000080      /* IP_MULTICAST_LOOP */
2214 
2215 #define IXAF_IPSEC_SECURE       0x00000100      /* Need IPsec processing */
2216 #define IXAF_UCRED_TSL          0x00000200      /* ixa_tsl from SCM_UCRED */
2217 #define IXAF_DONTROUTE          0x00000400      /* SO_DONTROUTE */
2218 #define IXAF_NO_IPSEC           0x00000800      /* Ignore policy */
2219 
2220 #define IXAF_PMTU_TOO_SMALL     0x00001000      /* PMTU too small */
2221 #define IXAF_SET_ULP_CKSUM      0x00002000      /* Calculate ULP checksum */
2222 #define IXAF_VERIFY_SOURCE      0x00004000      /* Check that source is ok */
2223 #define IXAF_NEXTHOP_SET        0x00008000      /* ixa_nexthop set */
2224 
2225 #define IXAF_PMTU_IPV4_DF       0x00010000      /* Set IPv4 DF */
2226 #define IXAF_NO_DEV_FLOW_CTL    0x00020000      /* Protocol needs no flow ctl */
2227 #define IXAF_NO_TTL_CHANGE      0x00040000      /* Internal to IP */
2228 #define IXAF_IPV6_ADD_FRAGHDR   0x00080000      /* Add fragment header */
2229 
2230 #define IXAF_IPSEC_TUNNEL       0x00100000      /* Tunnel mode */
2231 #define IXAF_NO_PFHOOK          0x00200000      /* Skip xmit pfhook */
2232 #define IXAF_NO_TRACE           0x00400000      /* When back from ARP/ND */
2233 #define IXAF_SCOPEID_SET        0x00800000      /* ixa_scopeid set */
2234 
2235 #define IXAF_MULTIRT_MULTICAST  0x01000000      /* MULTIRT for multicast */
2236 #define IXAF_NO_HW_CKSUM        0x02000000      /* Force software cksum */
2237 #define IXAF_SET_RAW_CKSUM      0x04000000      /* Use ixa_raw_cksum_offset */
2238 #define IXAF_IPSEC_GLOBAL_POLICY 0x08000000     /* Policy came from global */
2239 
2240 /* Note the following uses bits 0x10000000 through 0x80000000 */
2241 #define IXAF_IS_IPV4            IAF_IS_IPV4
2242 #define IXAF_TRUSTED_ICMP       IAF_TRUSTED_ICMP
2243 #define IXAF_NO_LOOP_ZONEID_SET IAF_NO_LOOP_ZONEID_SET
2244 #define IXAF_LOOPBACK_COPY      IAF_LOOPBACK_COPY
2245 
2246 /* Note: use the upper 32 bits */
2247 #define IXAF_VERIFY_LSO         0x100000000     /* Check LSO capability */
2248 #define IXAF_LSO_CAPAB          0x200000000     /* Capable of LSO */
2249 #define IXAF_VERIFY_ZCOPY       0x400000000     /* Check Zero Copy capability */
2250 #define IXAF_ZCOPY_CAPAB        0x800000000     /* Capable of ZEROCOPY */
2251 
2252 /*
2253  * The normal flags for sending packets e.g., icmp errors
2254  */
2255 #define IXAF_BASIC_SIMPLE_V4    \
2256         (IXAF_SET_ULP_CKSUM | IXAF_IS_IPV4 | IXAF_VERIFY_SOURCE)
2257 #define IXAF_BASIC_SIMPLE_V6    (IXAF_SET_ULP_CKSUM | IXAF_VERIFY_SOURCE)
2258 
2259 /*
2260  * Normally these fields do not have a hold. But in some cases they do, for
2261  * instance when we've gone through ip_*_attr_to/from_mblk.
2262  * We use ixa_free_flags to indicate that they have a hold and need to be
2263  * released on cleanup.
2264  */
2265 #define IXA_FREE_CRED           0x00000001      /* ixa_cred needs to be rele */
2266 #define IXA_FREE_TSL            0x00000002      /* ixa_tsl needs to be rele */
2267 
2268 /*
2269  * Simplistic way to set the ixa_xmit_hint for locally generated traffic
2270  * and forwarded traffic. The shift amount are based on the size of the
2271  * structs to discard the low order bits which don't have much if any variation
2272  * (coloring in kmem_cache_alloc might provide some variation).
2273  *
2274  * Basing the locally generated hint on the address of the conn_t means that
2275  * the packets from the same socket/connection do not get reordered.
2276  * Basing the hint for forwarded traffic on the ill_ring_t means that
2277  * packets from the same NIC+ring are likely to use the same outbound ring
2278  * hence we get low contention on the ring in the transmitting driver.
2279  */
2280 #define CONN_TO_XMIT_HINT(connp)        ((uint32_t)(((uintptr_t)connp) >> 11))
2281 #define ILL_RING_TO_XMIT_HINT(ring)     ((uint32_t)(((uintptr_t)ring) >> 7))
2282 
2283 /*
2284  * IP set Destination Flags used by function ip_set_destination,
2285  * ip_attr_connect, and conn_connect.
2286  */
2287 #define IPDF_ALLOW_MCBC         0x1     /* Allow multi/broadcast */
2288 #define IPDF_VERIFY_DST         0x2     /* Verify destination addr */
2289 #define IPDF_SELECT_SRC         0x4     /* Select source address */
2290 #define IPDF_LSO                0x8     /* Try LSO */
2291 #define IPDF_IPSEC              0x10    /* Set IPsec policy */
2292 #define IPDF_ZONE_IS_GLOBAL     0x20    /* From conn_zone_is_global */
2293 #define IPDF_ZCOPY              0x40    /* Try ZEROCOPY */
2294 #define IPDF_UNIQUE_DCE         0x80    /* Get a per-destination DCE */
2295 
2296 /*
2297  * Receive side attributes used between the transport protocols and IP as
2298  * well as inside IP.
2299  */
2300 struct ip_recv_attr_s {
2301         iaflags_t       ira_flags;      /* See below */
2302 
2303         uint32_t        ira_free_flags; /* IRA_FREE_*. See below */
2304 
2305         /*
2306          * This is a hint for TCP SYN packets.
2307          * Always initialized independently of ira_flags settings
2308          */
2309         squeue_t        *ira_sqp;
2310         ill_rx_ring_t   *ira_ring;      /* Internal to IP */
2311 
2312         /* For ip_accept_tcp when IRAF_TARGET_SQP is set */
2313         squeue_t        *ira_target_sqp;
2314         mblk_t          *ira_target_sqp_mp;
2315 
2316         /* Always initialized independently of ira_flags settings */
2317         uint32_t        ira_xmit_hint;  /* For ECMP and GLD TX ring fanout */
2318         zoneid_t        ira_zoneid;     /* ALL_ZONES unless local delivery */
2319         uint_t          ira_pktlen;     /* Always set. For frag and stats */
2320         uint16_t        ira_ip_hdr_length; /* Points to ULP header */
2321         uint8_t         ira_protocol;   /* Protocol number for ULP cksum */
2322         uint_t          ira_rifindex;   /* Received ifindex */
2323         uint_t          ira_ruifindex;  /* Received upper ifindex */
2324         ts_label_t      *ira_tsl;       /* Always set. NULL if not TX */
2325         /*
2326          * ira_rill and ira_ill is set inside IP, but not when conn_recv is
2327          * called; ULPs should use ira_ruifindex instead.
2328          */
2329         ill_t           *ira_rill;      /* ill where packet came */
2330         ill_t           *ira_ill;       /* ill where IP address hosted */
2331         cred_t          *ira_cred;      /* For getpeerucred */
2332         pid_t           ira_cpid;       /* For getpeerucred */
2333 
2334         /* Used when IRAF_VERIFIED_SRC is set; this source was ok */
2335         ipaddr_t        ira_verified_src;
2336 
2337         /*
2338          * The following IPsec fields are only initialized when
2339          * IRAF_IPSEC_SECURE is set. Otherwise they contain garbage.
2340          */
2341         struct ipsec_action_s *ira_ipsec_action; /* how we made it in.. */
2342         struct ipsa_s   *ira_ipsec_ah_sa;       /* SA for AH */
2343         struct ipsa_s   *ira_ipsec_esp_sa;      /* SA for ESP */
2344 
2345         ipaddr_t        ira_mroute_tunnel;      /* IRAF_MROUTE_TUNNEL_SET */
2346 
2347         zoneid_t        ira_no_loop_zoneid;     /* IRAF_NO_LOOP_ZONEID_SET */
2348 
2349         uint32_t        ira_esp_udp_ports;      /* IRAF_ESP_UDP_PORTS */
2350 
2351         /*
2352          * For IP_RECVSLLA and ip_ndp_conflict/find_solicitation.
2353          * Same size as max for sockaddr_dl
2354          */
2355 #define IRA_L2SRC_SIZE  244
2356         uint8_t         ira_l2src[IRA_L2SRC_SIZE];      /* If IRAF_L2SRC_SET */
2357 
2358         /*
2359          * Local handle that we use to do lazy setting of ira_l2src.
2360          * We defer setting l2src until needed but we do before any
2361          * ip_input pullupmsg or copymsg.
2362          */
2363         struct mac_header_info_s *ira_mhip;     /* Could be NULL */
2364 };
2365 
2366 /*
2367  * Flags to indicate which receive attributes are set.
2368  */
2369 #define IRAF_SYSTEM_LABELED     0x00000001      /* is_system_labeled() */
2370 #define IRAF_IPV4_OPTIONS       0x00000002      /* Performance */
2371 #define IRAF_MULTICAST          0x00000004      /* Was multicast at L3 */
2372 #define IRAF_BROADCAST          0x00000008      /* Was broadcast at L3 */
2373 #define IRAF_MULTIBROADCAST     (IRAF_MULTICAST|IRAF_BROADCAST)
2374 
2375 #define IRAF_LOOPBACK           0x00000010      /* Looped back by IP */
2376 #define IRAF_VERIFY_IP_CKSUM    0x00000020      /* Need to verify IP */
2377 #define IRAF_VERIFY_ULP_CKSUM   0x00000040      /* Need to verify TCP,UDP,etc */
2378 #define IRAF_SCTP_CSUM_ERR      0x00000080      /* sctp pkt has failed chksum */
2379 
2380 #define IRAF_IPSEC_SECURE       0x00000100      /* Passed AH and/or ESP */
2381 #define IRAF_DHCP_UNICAST       0x00000200
2382 #define IRAF_IPSEC_DECAPS       0x00000400      /* Was packet decapsulated */
2383                                         /* from a matching inner packet? */
2384 #define IRAF_TARGET_SQP         0x00000800      /* ira_target_sqp is set */
2385 #define IRAF_VERIFIED_SRC       0x00001000      /* ira_verified_src set */
2386 #define IRAF_RSVP               0x00002000      /* RSVP packet for rsvpd */
2387 #define IRAF_MROUTE_TUNNEL_SET  0x00004000      /* From ip_mroute_decap */
2388 #define IRAF_PIM_REGISTER       0x00008000      /* From register_mforward */
2389 
2390 #define IRAF_TX_MAC_EXEMPTABLE  0x00010000      /* Allow MAC_EXEMPT readdown */
2391 #define IRAF_TX_SHARED_ADDR     0x00020000      /* Arrived on ALL_ZONES addr */
2392 #define IRAF_ESP_UDP_PORTS      0x00040000      /* NAT-traversal packet */
2393 #define IRAF_NO_HW_CKSUM        0x00080000      /* Force software cksum */
2394 
2395 #define IRAF_ICMP_ERROR         0x00100000      /* Send to conn_recvicmp */
2396 #define IRAF_ROUTER_ALERT       0x00200000      /* IPv6 router alert */
2397 #define IRAF_L2SRC_SET          0x00400000      /* ira_l2src has been set */
2398 #define IRAF_L2SRC_LOOPBACK     0x00800000      /* Came from us */
2399 
2400 #define IRAF_L2DST_MULTICAST    0x01000000      /* Multicast at L2 */
2401 #define IRAF_L2DST_BROADCAST    0x02000000      /* Broadcast at L2 */
2402 /* Unused 0x04000000 */
2403 /* Unused 0x08000000 */
2404 
2405 /* Below starts with 0x10000000 */
2406 #define IRAF_IS_IPV4            IAF_IS_IPV4
2407 #define IRAF_TRUSTED_ICMP       IAF_TRUSTED_ICMP
2408 #define IRAF_NO_LOOP_ZONEID_SET IAF_NO_LOOP_ZONEID_SET
2409 #define IRAF_LOOPBACK_COPY      IAF_LOOPBACK_COPY
2410 
2411 /*
2412  * Normally these fields do not have a hold. But in some cases they do, for
2413  * instance when we've gone through ip_*_attr_to/from_mblk.
2414  * We use ira_free_flags to indicate that they have a hold and need to be
2415  * released on cleanup.
2416  */
2417 #define IRA_FREE_CRED           0x00000001      /* ira_cred needs to be rele */
2418 #define IRA_FREE_TSL            0x00000002      /* ira_tsl needs to be rele */
2419 
2420 /*
2421  * Optional destination cache entry for path MTU information,
2422  * and ULP metrics.
2423  */
2424 struct dce_s {
2425         uint_t          dce_generation; /* Changed since cached? */
2426         uint_t          dce_flags;      /* See below */
2427         uint_t          dce_ipversion;  /* IPv4/IPv6 version */
2428         uint32_t        dce_pmtu;       /* Path MTU if DCEF_PMTU */
2429         uint32_t        dce_ident;      /* Per destination IP ident. */
2430         iulp_t          dce_uinfo;      /* Metrics if DCEF_UINFO */
2431 
2432         struct dce_s    *dce_next;
2433         struct dce_s    **dce_ptpn;
2434         struct dcb_s    *dce_bucket;
2435 
2436         union {
2437                 in6_addr_t      dceu_v6addr;
2438                 ipaddr_t        dceu_v4addr;
2439         } dce_u;
2440 #define dce_v4addr      dce_u.dceu_v4addr
2441 #define dce_v6addr      dce_u.dceu_v6addr
2442         /* Note that for IPv6+IPMP we use the ifindex for the upper interface */
2443         uint_t          dce_ifindex;    /* For IPv6 link-locals */
2444 
2445         kmutex_t        dce_lock;
2446         uint_t          dce_refcnt;
2447         uint64_t        dce_last_change_time;   /* Path MTU. In seconds */
2448 
2449         ip_stack_t      *dce_ipst;      /* Does not have a netstack_hold */
2450 };
2451 
2452 /*
2453  * Values for dce_generation.
2454  *
2455  * If a DCE has DCE_GENERATION_CONDEMNED, the last dce_refrele should delete
2456  * it.
2457  *
2458  * DCE_GENERATION_VERIFY is never stored in dce_generation but it is
2459  * stored in places that cache DCE (such as ixa_dce_generation).
2460  * It is used as a signal that the cache is stale and needs to be reverified.
2461  */
2462 #define DCE_GENERATION_CONDEMNED        0
2463 #define DCE_GENERATION_VERIFY           1
2464 #define DCE_GENERATION_INITIAL          2
2465 #define DCE_IS_CONDEMNED(dce) \
2466         ((dce)->dce_generation == DCE_GENERATION_CONDEMNED)
2467 
2468 
2469 /*
2470  * Values for ips_src_generation.
2471  *
2472  * SRC_GENERATION_VERIFY is never stored in ips_src_generation but it is
2473  * stored in places that cache IREs (ixa_src_generation). It is used as a
2474  * signal that the cache is stale and needs to be reverified.
2475  */
2476 #define SRC_GENERATION_VERIFY           0
2477 #define SRC_GENERATION_INITIAL          1
2478 
2479 /*
2480  * The kernel stores security attributes of all gateways in a database made
2481  * up of one or more tsol_gcdb_t elements.  Each tsol_gcdb_t contains the
2482  * security-related credentials of the gateway.  More than one gateways may
2483  * share entries in the database.
2484  *
2485  * The tsol_gc_t structure represents the gateway to credential association,
2486  * and refers to an entry in the database.  One or more tsol_gc_t entities are
2487  * grouped together to form one or more tsol_gcgrp_t, each representing the
2488  * list of security attributes specific to the gateway.  A gateway may be
2489  * associated with at most one credentials group.
2490  */
2491 struct tsol_gcgrp_s;
2492 
2493 extern uchar_t  ip6opt_ls;      /* TX IPv6 enabler */
2494 
2495 /*
2496  * Gateway security credential record.
2497  */
2498 typedef struct tsol_gcdb_s {
2499         uint_t          gcdb_refcnt;    /* reference count */
2500         struct rtsa_s   gcdb_attr;      /* security attributes */
2501 #define gcdb_mask       gcdb_attr.rtsa_mask
2502 #define gcdb_doi        gcdb_attr.rtsa_doi
2503 #define gcdb_slrange    gcdb_attr.rtsa_slrange
2504 } tsol_gcdb_t;
2505 
2506 /*
2507  * Gateway to credential association.
2508  */
2509 typedef struct tsol_gc_s {
2510         uint_t          gc_refcnt;      /* reference count */
2511         struct tsol_gcgrp_s *gc_grp;    /* pointer to group */
2512         struct tsol_gc_s *gc_prev;      /* previous in list */
2513         struct tsol_gc_s *gc_next;      /* next in list */
2514         tsol_gcdb_t     *gc_db;         /* pointer to actual credentials */
2515 } tsol_gc_t;
2516 
2517 /*
2518  * Gateway credentials group address.
2519  */
2520 typedef struct tsol_gcgrp_addr_s {
2521         int             ga_af;          /* address family */
2522         in6_addr_t      ga_addr;        /* IPv4 mapped or IPv6 address */
2523 } tsol_gcgrp_addr_t;
2524 
2525 /*
2526  * Gateway credentials group.
2527  */
2528 typedef struct tsol_gcgrp_s {
2529         uint_t          gcgrp_refcnt;   /* reference count */
2530         krwlock_t       gcgrp_rwlock;   /* lock to protect following */
2531         uint_t          gcgrp_count;    /* number of credentials */
2532         tsol_gc_t       *gcgrp_head;    /* first credential in list */
2533         tsol_gc_t       *gcgrp_tail;    /* last credential in list */
2534         tsol_gcgrp_addr_t gcgrp_addr;   /* next-hop gateway address */
2535 } tsol_gcgrp_t;
2536 
2537 extern kmutex_t gcgrp_lock;
2538 
2539 #define GC_REFRELE(p) {                         \
2540         ASSERT((p)->gc_grp != NULL);         \
2541         rw_enter(&(p)->gc_grp->gcgrp_rwlock, RW_WRITER); \
2542         ASSERT((p)->gc_refcnt > 0);               \
2543         if (--((p)->gc_refcnt) == 0)         \
2544                 gc_inactive(p);                 \
2545         else                                    \
2546                 rw_exit(&(p)->gc_grp->gcgrp_rwlock); \
2547 }
2548 
2549 #define GCGRP_REFHOLD(p) {                      \
2550         mutex_enter(&gcgrp_lock);           \
2551         ++((p)->gcgrp_refcnt);                       \
2552         ASSERT((p)->gcgrp_refcnt != 0);              \
2553         mutex_exit(&gcgrp_lock);            \
2554 }
2555 
2556 #define GCGRP_REFRELE(p) {                      \
2557         mutex_enter(&gcgrp_lock);           \
2558         ASSERT((p)->gcgrp_refcnt > 0);            \
2559         if (--((p)->gcgrp_refcnt) == 0)              \
2560                 gcgrp_inactive(p);              \
2561         ASSERT(MUTEX_HELD(&gcgrp_lock));    \
2562         mutex_exit(&gcgrp_lock);            \
2563 }
2564 
2565 /*
2566  * IRE gateway security attributes structure, pointed to by tsol_ire_gw_secattr
2567  */
2568 struct tsol_tnrhc;
2569 
2570 struct tsol_ire_gw_secattr_s {
2571         kmutex_t        igsa_lock;      /* lock to protect following */
2572         struct tsol_tnrhc *igsa_rhc;    /* host entry for gateway */
2573         tsol_gc_t       *igsa_gc;       /* for prefix IREs */
2574 };
2575 
2576 void irb_refrele_ftable(irb_t *);
2577 
2578 extern struct kmem_cache *rt_entry_cache;
2579 
2580 typedef struct ire4 {
2581         ipaddr_t ire4_mask;             /* Mask for matching this IRE. */
2582         ipaddr_t ire4_addr;             /* Address this IRE represents. */
2583         ipaddr_t ire4_gateway_addr;     /* Gateway including for IRE_ONLINK */
2584         ipaddr_t ire4_setsrc_addr;      /* RTF_SETSRC */
2585 } ire4_t;
2586 
2587 typedef struct ire6 {
2588         in6_addr_t ire6_mask;           /* Mask for matching this IRE. */
2589         in6_addr_t ire6_addr;           /* Address this IRE represents. */
2590         in6_addr_t ire6_gateway_addr;   /* Gateway including for IRE_ONLINK */
2591         in6_addr_t ire6_setsrc_addr;    /* RTF_SETSRC */
2592 } ire6_t;
2593 
2594 typedef union ire_addr {
2595         ire6_t  ire6_u;
2596         ire4_t  ire4_u;
2597 } ire_addr_u_t;
2598 
2599 /*
2600  * Internet Routing Entry
2601  * When we have multiple identical IREs we logically add them by manipulating
2602  * ire_identical_ref and ire_delete first decrements
2603  * that and when it reaches 1 we know it is the last IRE.
2604  * "identical" is defined as being the same for:
2605  * ire_addr, ire_netmask, ire_gateway, ire_ill, ire_zoneid, and ire_type
2606  * For instance, multiple IRE_BROADCASTs for the same subnet number are
2607  * viewed as identical, and so are the IRE_INTERFACEs when there are
2608  * multiple logical interfaces (on the same ill) with the same subnet prefix.
2609  */
2610 struct ire_s {
2611         struct  ire_s   *ire_next;      /* The hash chain must be first. */
2612         struct  ire_s   **ire_ptpn;     /* Pointer to previous next. */
2613         uint32_t        ire_refcnt;     /* Number of references */
2614         ill_t           *ire_ill;
2615         uint32_t        ire_identical_ref; /* IRE_INTERFACE, IRE_BROADCAST */
2616         uchar_t         ire_ipversion;  /* IPv4/IPv6 version */
2617         ushort_t        ire_type;       /* Type of IRE */
2618         uint_t          ire_generation; /* Generation including CONDEMNED */
2619         uint_t  ire_ib_pkt_count;       /* Inbound packets for ire_addr */
2620         uint_t  ire_ob_pkt_count;       /* Outbound packets to ire_addr */
2621         time_t  ire_create_time;        /* Time (in secs) IRE was created. */
2622         uint32_t        ire_flags;      /* flags related to route (RTF_*) */
2623         /*
2624          * ire_testhidden is TRUE for INTERFACE IREs of IS_UNDER_IPMP(ill)
2625          * interfaces
2626          */
2627         boolean_t       ire_testhidden;
2628         pfirerecv_t     ire_recvfn;     /* Receive side handling */
2629         pfiresend_t     ire_sendfn;     /* Send side handling */
2630         pfirepostfrag_t ire_postfragfn; /* Bottom end of send handling */
2631 
2632         uint_t          ire_masklen;    /* # bits in ire_mask{,_v6} */
2633         ire_addr_u_t    ire_u;          /* IPv4/IPv6 address info. */
2634 
2635         irb_t           *ire_bucket;    /* Hash bucket when ire_ptphn is set */
2636         kmutex_t        ire_lock;
2637         clock_t         ire_last_used_time;     /* For IRE_LOCAL reception */
2638         tsol_ire_gw_secattr_t *ire_gw_secattr; /* gateway security attributes */
2639         zoneid_t        ire_zoneid;
2640 
2641         /*
2642          * Cached information of where to send packets that match this route.
2643          * The ire_dep_* information is used to determine when ire_nce_cache
2644          * needs to be updated.
2645          * ire_nce_cache is the fastpath for the Neighbor Cache Entry
2646          * for IPv6; arp info for IPv4
2647          * Since this is a cache setup and torn down independently of
2648          * applications we need to use nce_ref{rele,hold}_notr for it.
2649          */
2650         nce_t           *ire_nce_cache;
2651 
2652         /*
2653          * Quick check whether the ire_type and ire_masklen indicates
2654          * that the IRE can have ire_nce_cache set i.e., whether it is
2655          * IRE_ONLINK and for a single destination.
2656          */
2657         boolean_t       ire_nce_capable;
2658 
2659         /*
2660          * Dependency tracking so we can safely cache IRE and NCE pointers
2661          * in offlink and onlink IREs.
2662          * These are locked under the ips_ire_dep_lock rwlock. Write held
2663          * when modifying the linkage.
2664          * ire_dep_parent (Also chain towards IRE for nexthop)
2665          * ire_dep_parent_generation: ire_generation of ire_dep_parent
2666          * ire_dep_children (From parent to first child)
2667          * ire_dep_sib_next (linked list of siblings)
2668          * ire_dep_sib_ptpn (linked list of siblings)
2669          *
2670          * The parent has a ire_refhold on each child, and each child has
2671          * an ire_refhold on its parent.
2672          * Since ire_dep_parent is a cache setup and torn down independently of
2673          * applications we need to use ire_ref{rele,hold}_notr for it.
2674          */
2675         ire_t           *ire_dep_parent;
2676         ire_t           *ire_dep_children;
2677         ire_t           *ire_dep_sib_next;
2678         ire_t           **ire_dep_sib_ptpn;     /* Pointer to previous next */
2679         uint_t          ire_dep_parent_generation;
2680 
2681         uint_t          ire_badcnt;     /* Number of times ND_UNREACHABLE */
2682         uint64_t        ire_last_badcnt;        /* In seconds */
2683 
2684         /* ire_defense* and ire_last_used_time are only used on IRE_LOCALs */
2685         uint_t          ire_defense_count;      /* number of ARP conflicts */
2686         uint_t          ire_defense_time;       /* last time defended (secs) */
2687 
2688         boolean_t       ire_trace_disable;      /* True when alloc fails */
2689         ip_stack_t      *ire_ipst;      /* Does not have a netstack_hold */
2690         iulp_t          ire_metrics;
2691         /*
2692          * default and prefix routes that are added without explicitly
2693          * specifying the interface are termed "unbound" routes, and will
2694          * have ire_unbound set to true.
2695          */
2696         boolean_t       ire_unbound;
2697 };
2698 
2699 /* IPv4 compatibility macros */
2700 #define ire_mask                ire_u.ire4_u.ire4_mask
2701 #define ire_addr                ire_u.ire4_u.ire4_addr
2702 #define ire_gateway_addr        ire_u.ire4_u.ire4_gateway_addr
2703 #define ire_setsrc_addr         ire_u.ire4_u.ire4_setsrc_addr
2704 
2705 #define ire_mask_v6             ire_u.ire6_u.ire6_mask
2706 #define ire_addr_v6             ire_u.ire6_u.ire6_addr
2707 #define ire_gateway_addr_v6     ire_u.ire6_u.ire6_gateway_addr
2708 #define ire_setsrc_addr_v6      ire_u.ire6_u.ire6_setsrc_addr
2709 
2710 /*
2711  * Values for ire_generation.
2712  *
2713  * If an IRE is marked with IRE_IS_CONDEMNED, the last walker of
2714  * the bucket should delete this IRE from this bucket.
2715  *
2716  * IRE_GENERATION_VERIFY is never stored in ire_generation but it is
2717  * stored in places that cache IREs (such as ixa_ire_generation and
2718  * ire_dep_parent_generation). It is used as a signal that the cache is
2719  * stale and needs to be reverified.
2720  */
2721 #define IRE_GENERATION_CONDEMNED        0
2722 #define IRE_GENERATION_VERIFY           1
2723 #define IRE_GENERATION_INITIAL          2
2724 #define IRE_IS_CONDEMNED(ire) \
2725         ((ire)->ire_generation == IRE_GENERATION_CONDEMNED)
2726 
2727 /* Convenient typedefs for sockaddrs */
2728 typedef struct sockaddr_in      sin_t;
2729 typedef struct sockaddr_in6     sin6_t;
2730 
2731 /* Name/Value Descriptor. */
2732 typedef struct nv_s {
2733         uint64_t nv_value;
2734         char    *nv_name;
2735 } nv_t;
2736 
2737 #define ILL_FRAG_HASH(s, i) \
2738         ((ntohl(s) ^ ((i) ^ ((i) >> 8))) % ILL_FRAG_HASH_TBL_COUNT)
2739 
2740 /*
2741  * The MAX number of allowed fragmented packets per hash bucket
2742  * calculation is based on the most common mtu size of 1500. This limit
2743  * will work well for other mtu sizes as well.
2744  */
2745 #define COMMON_IP_MTU 1500
2746 #define MAX_FRAG_MIN 10
2747 #define MAX_FRAG_PKTS(ipst)     \
2748         MAX(MAX_FRAG_MIN, (2 * (ipst->ips_ip_reass_queue_bytes / \
2749             (COMMON_IP_MTU * ILL_FRAG_HASH_TBL_COUNT))))
2750 
2751 /*
2752  * Maximum dups allowed per packet.
2753  */
2754 extern uint_t ip_max_frag_dups;
2755 
2756 /*
2757  * Per-packet information for received packets and transmitted.
2758  * Used by the transport protocols when converting between the packet
2759  * and ancillary data and socket options.
2760  *
2761  * Note: This private data structure and related IPPF_* constant
2762  * definitions are exposed to enable compilation of some debugging tools
2763  * like lsof which use struct tcp_t in <inet/tcp.h>. This is intended to be
2764  * a temporary hack and long term alternate interfaces should be defined
2765  * to support the needs of such tools and private definitions moved to
2766  * private headers.
2767  */
2768 struct ip_pkt_s {
2769         uint_t          ipp_fields;             /* Which fields are valid */
2770         in6_addr_t      ipp_addr;               /* pktinfo src/dst addr */
2771 #define ipp_addr_v4     V4_PART_OF_V6(ipp_addr)
2772         uint_t          ipp_unicast_hops;       /* IPV6_UNICAST_HOPS, IP_TTL */
2773         uint_t          ipp_hoplimit;           /* IPV6_HOPLIMIT */
2774         uint_t          ipp_hopoptslen;
2775         uint_t          ipp_rthdrdstoptslen;
2776         uint_t          ipp_rthdrlen;
2777         uint_t          ipp_dstoptslen;
2778         uint_t          ipp_fraghdrlen;
2779         ip6_hbh_t       *ipp_hopopts;
2780         ip6_dest_t      *ipp_rthdrdstopts;
2781         ip6_rthdr_t     *ipp_rthdr;
2782         ip6_dest_t      *ipp_dstopts;
2783         ip6_frag_t      *ipp_fraghdr;
2784         uint8_t         ipp_tclass;             /* IPV6_TCLASS */
2785         uint8_t         ipp_type_of_service;    /* IP_TOS */
2786         uint_t          ipp_ipv4_options_len;   /* Len of IPv4 options */
2787         uint8_t         *ipp_ipv4_options;      /* Ptr to IPv4 options */
2788         uint_t          ipp_label_len_v4;       /* Len of TX label for IPv4 */
2789         uint8_t         *ipp_label_v4;          /* TX label for IPv4 */
2790         uint_t          ipp_label_len_v6;       /* Len of TX label for IPv6 */
2791         uint8_t         *ipp_label_v6;          /* TX label for IPv6 */
2792 };
2793 typedef struct ip_pkt_s ip_pkt_t;
2794 
2795 extern void ip_pkt_free(ip_pkt_t *);    /* free storage inside ip_pkt_t */
2796 extern ipaddr_t ip_pkt_source_route_v4(const ip_pkt_t *);
2797 extern in6_addr_t *ip_pkt_source_route_v6(const ip_pkt_t *);
2798 extern int ip_pkt_copy(ip_pkt_t *, ip_pkt_t *, int);
2799 extern void ip_pkt_source_route_reverse_v4(ip_pkt_t *);
2800 
2801 /* ipp_fields values */
2802 #define IPPF_ADDR               0x0001  /* Part of in6_pktinfo: src/dst addr */
2803 #define IPPF_HOPLIMIT           0x0002  /* Overrides unicast and multicast */
2804 #define IPPF_TCLASS             0x0004  /* Overrides class in sin6_flowinfo */
2805 
2806 #define IPPF_HOPOPTS            0x0010  /* ipp_hopopts set */
2807 #define IPPF_RTHDR              0x0020  /* ipp_rthdr set */
2808 #define IPPF_RTHDRDSTOPTS       0x0040  /* ipp_rthdrdstopts set */
2809 #define IPPF_DSTOPTS            0x0080  /* ipp_dstopts set */
2810 
2811 #define IPPF_IPV4_OPTIONS       0x0100  /* ipp_ipv4_options set */
2812 #define IPPF_LABEL_V4           0x0200  /* ipp_label_v4 set */
2813 #define IPPF_LABEL_V6           0x0400  /* ipp_label_v6 set */
2814 
2815 #define IPPF_FRAGHDR            0x0800  /* Used for IPsec receive side */
2816 
2817 /*
2818  * Data structure which is passed to conn_opt_get/set.
2819  * The conn_t is included even though it can be inferred from queue_t.
2820  * setsockopt and getsockopt use conn_ixa and conn_xmit_ipp. However,
2821  * when handling ancillary data we use separate ixa and ipps.
2822  */
2823 typedef struct conn_opt_arg_s {
2824         conn_t          *coa_connp;
2825         ip_xmit_attr_t  *coa_ixa;
2826         ip_pkt_t        *coa_ipp;
2827         boolean_t       coa_ancillary;  /* Ancillary data and not setsockopt */
2828         uint_t          coa_changed;    /* See below */
2829 } conn_opt_arg_t;
2830 
2831 /*
2832  * Flags for what changed.
2833  * If we want to be more efficient in the future we can have more fine
2834  * grained flags e.g., a flag for just IP_TOS changing.
2835  * For now we either call ip_set_destination (for "route changed")
2836  * and/or conn_build_hdr_template/conn_prepend_hdr (for "header changed").
2837  */
2838 #define COA_HEADER_CHANGED      0x0001
2839 #define COA_ROUTE_CHANGED       0x0002
2840 #define COA_RCVBUF_CHANGED      0x0004  /* SO_RCVBUF */
2841 #define COA_SNDBUF_CHANGED      0x0008  /* SO_SNDBUF */
2842 #define COA_WROFF_CHANGED       0x0010  /* Header size changed */
2843 #define COA_ICMP_BIND_NEEDED    0x0020
2844 #define COA_OOBINLINE_CHANGED   0x0040
2845 
2846 #define TCP_PORTS_OFFSET        0
2847 #define UDP_PORTS_OFFSET        0
2848 
2849 /*
2850  * lookups return the ill/ipif only if the flags are clear OR Iam writer.
2851  * ill / ipif lookup functions increment the refcnt on the ill / ipif only
2852  * after calling these macros. This ensures that the refcnt on the ipif or
2853  * ill will eventually drop down to zero.
2854  */
2855 #define ILL_LOOKUP_FAILED       1       /* Used as error code */
2856 #define IPIF_LOOKUP_FAILED      2       /* Used as error code */
2857 
2858 #define ILL_CAN_LOOKUP(ill)                                             \
2859         (!((ill)->ill_state_flags & ILL_CONDEMNED) ||                    \
2860         IAM_WRITER_ILL(ill))
2861 
2862 #define ILL_IS_CONDEMNED(ill)   \
2863         ((ill)->ill_state_flags & ILL_CONDEMNED)
2864 
2865 #define IPIF_CAN_LOOKUP(ipif)   \
2866         (!((ipif)->ipif_state_flags & IPIF_CONDEMNED) || \
2867         IAM_WRITER_IPIF(ipif))
2868 
2869 #define IPIF_IS_CONDEMNED(ipif) \
2870         ((ipif)->ipif_state_flags & IPIF_CONDEMNED)
2871 
2872 #define IPIF_IS_CHANGING(ipif)  \
2873         ((ipif)->ipif_state_flags & IPIF_CHANGING)
2874 
2875 /* Macros used to assert that this thread is a writer */
2876 #define IAM_WRITER_IPSQ(ipsq)   ((ipsq)->ipsq_xop->ipx_writer == curthread)
2877 #define IAM_WRITER_ILL(ill)     IAM_WRITER_IPSQ((ill)->ill_phyint->phyint_ipsq)
2878 #define IAM_WRITER_IPIF(ipif)   IAM_WRITER_ILL((ipif)->ipif_ill)
2879 
2880 /*
2881  * Grab ill locks in the proper order. The order is highest addressed
2882  * ill is locked first.
2883  */
2884 #define GRAB_ILL_LOCKS(ill_1, ill_2)                            \
2885 {                                                               \
2886         if ((ill_1) > (ill_2)) {                             \
2887                 if (ill_1 != NULL)                              \
2888                         mutex_enter(&(ill_1)->ill_lock); \
2889                 if (ill_2 != NULL)                              \
2890                         mutex_enter(&(ill_2)->ill_lock); \
2891         } else {                                                \
2892                 if (ill_2 != NULL)                              \
2893                         mutex_enter(&(ill_2)->ill_lock); \
2894                 if (ill_1 != NULL && ill_1 != ill_2)            \
2895                         mutex_enter(&(ill_1)->ill_lock); \
2896         }                                                       \
2897 }
2898 
2899 #define RELEASE_ILL_LOCKS(ill_1, ill_2)         \
2900 {                                               \
2901         if (ill_1 != NULL)                      \
2902                 mutex_exit(&(ill_1)->ill_lock);  \
2903         if (ill_2 != NULL && ill_2 != ill_1)    \
2904                 mutex_exit(&(ill_2)->ill_lock);  \
2905 }
2906 
2907 /* Get the other protocol instance ill */
2908 #define ILL_OTHER(ill)                                          \
2909         ((ill)->ill_isv6 ? (ill)->ill_phyint->phyint_illv4 :   \
2910             (ill)->ill_phyint->phyint_illv6)
2911 
2912 /* ioctl command info: Ioctl properties extracted and stored in here */
2913 typedef struct cmd_info_s
2914 {
2915         ipif_t  *ci_ipif;       /* ipif associated with [l]ifreq ioctl's */
2916         sin_t   *ci_sin;        /* the sin struct passed down */
2917         sin6_t  *ci_sin6;       /* the sin6_t struct passed down */
2918         struct lifreq *ci_lifr; /* the lifreq struct passed down */
2919 } cmd_info_t;
2920 
2921 extern struct kmem_cache *ire_cache;
2922 
2923 extern ipaddr_t ip_g_all_ones;
2924 
2925 extern uint_t   ip_loopback_mtu;        /* /etc/system */
2926 extern uint_t   ip_loopback_mtuplus;
2927 extern uint_t   ip_loopback_mtu_v6plus;
2928 
2929 extern vmem_t *ip_minor_arena_sa;
2930 extern vmem_t *ip_minor_arena_la;
2931 
2932 /*
2933  * ip_g_forward controls IP forwarding.  It takes two values:
2934  *      0: IP_FORWARD_NEVER     Don't forward packets ever.
2935  *      1: IP_FORWARD_ALWAYS    Forward packets for elsewhere.
2936  *
2937  * RFC1122 says there must be a configuration switch to control forwarding,
2938  * but that the default MUST be to not forward packets ever.  Implicit
2939  * control based on configuration of multiple interfaces MUST NOT be
2940  * implemented (Section 3.1).  SunOS 4.1 did provide the "automatic" capability
2941  * and, in fact, it was the default.  That capability is now provided in the
2942  * /etc/rc2.d/S69inet script.
2943  */
2944 
2945 #define ips_ip_respond_to_address_mask_broadcast \
2946                                         ips_propinfo_tbl[0].prop_cur_bval
2947 #define ips_ip_g_resp_to_echo_bcast     ips_propinfo_tbl[1].prop_cur_bval
2948 #define ips_ip_g_resp_to_echo_mcast     ips_propinfo_tbl[2].prop_cur_bval
2949 #define ips_ip_g_resp_to_timestamp      ips_propinfo_tbl[3].prop_cur_bval
2950 #define ips_ip_g_resp_to_timestamp_bcast ips_propinfo_tbl[4].prop_cur_bval
2951 #define ips_ip_g_send_redirects         ips_propinfo_tbl[5].prop_cur_bval
2952 #define ips_ip_g_forward_directed_bcast ips_propinfo_tbl[6].prop_cur_bval
2953 #define ips_ip_mrtdebug                 ips_propinfo_tbl[7].prop_cur_uval
2954 #define ips_ip_ire_reclaim_fraction     ips_propinfo_tbl[8].prop_cur_uval
2955 #define ips_ip_nce_reclaim_fraction     ips_propinfo_tbl[9].prop_cur_uval
2956 #define ips_ip_dce_reclaim_fraction     ips_propinfo_tbl[10].prop_cur_uval
2957 #define ips_ip_def_ttl                  ips_propinfo_tbl[11].prop_cur_uval
2958 #define ips_ip_forward_src_routed       ips_propinfo_tbl[12].prop_cur_bval
2959 #define ips_ip_wroff_extra              ips_propinfo_tbl[13].prop_cur_uval
2960 #define ips_ip_pathmtu_interval         ips_propinfo_tbl[14].prop_cur_uval
2961 #define ips_ip_icmp_return              ips_propinfo_tbl[15].prop_cur_uval
2962 #define ips_ip_path_mtu_discovery       ips_propinfo_tbl[16].prop_cur_bval
2963 #define ips_ip_pmtu_min                 ips_propinfo_tbl[17].prop_cur_uval
2964 #define ips_ip_ignore_redirect          ips_propinfo_tbl[18].prop_cur_bval
2965 #define ips_ip_arp_icmp_error           ips_propinfo_tbl[19].prop_cur_bval
2966 #define ips_ip_broadcast_ttl            ips_propinfo_tbl[20].prop_cur_uval
2967 #define ips_ip_icmp_err_interval        ips_propinfo_tbl[21].prop_cur_uval
2968 #define ips_ip_icmp_err_burst           ips_propinfo_tbl[22].prop_cur_uval
2969 #define ips_ip_reass_queue_bytes        ips_propinfo_tbl[23].prop_cur_uval
2970 #define ips_ip_strict_dst_multihoming   ips_propinfo_tbl[24].prop_cur_uval
2971 #define ips_ip_addrs_per_if             ips_propinfo_tbl[25].prop_cur_uval
2972 #define ips_ipsec_override_persocket_policy ips_propinfo_tbl[26].prop_cur_bval
2973 #define ips_icmp_accept_clear_messages  ips_propinfo_tbl[27].prop_cur_bval
2974 #define ips_igmp_accept_clear_messages  ips_propinfo_tbl[28].prop_cur_bval
2975 
2976 /* IPv6 configuration knobs */
2977 #define ips_delay_first_probe_time      ips_propinfo_tbl[29].prop_cur_uval
2978 #define ips_max_unicast_solicit         ips_propinfo_tbl[30].prop_cur_uval
2979 #define ips_ipv6_def_hops               ips_propinfo_tbl[31].prop_cur_uval
2980 #define ips_ipv6_icmp_return            ips_propinfo_tbl[32].prop_cur_uval
2981 #define ips_ipv6_forward_src_routed     ips_propinfo_tbl[33].prop_cur_bval
2982 #define ips_ipv6_resp_echo_mcast        ips_propinfo_tbl[34].prop_cur_bval
2983 #define ips_ipv6_send_redirects         ips_propinfo_tbl[35].prop_cur_bval
2984 #define ips_ipv6_ignore_redirect        ips_propinfo_tbl[36].prop_cur_bval
2985 #define ips_ipv6_strict_dst_multihoming ips_propinfo_tbl[37].prop_cur_uval
2986 #define ips_src_check                   ips_propinfo_tbl[38].prop_cur_uval
2987 #define ips_ipsec_policy_log_interval   ips_propinfo_tbl[39].prop_cur_uval
2988 #define ips_pim_accept_clear_messages   ips_propinfo_tbl[40].prop_cur_bval
2989 #define ips_ip_ndp_unsolicit_interval   ips_propinfo_tbl[41].prop_cur_uval
2990 #define ips_ip_ndp_unsolicit_count      ips_propinfo_tbl[42].prop_cur_uval
2991 #define ips_ipv6_ignore_home_address_opt ips_propinfo_tbl[43].prop_cur_bval
2992 
2993 /* Misc IP configuration knobs */
2994 #define ips_ip_policy_mask              ips_propinfo_tbl[44].prop_cur_uval
2995 #define ips_ip_ecmp_behavior            ips_propinfo_tbl[45].prop_cur_uval
2996 #define ips_ip_multirt_ttl              ips_propinfo_tbl[46].prop_cur_uval
2997 #define ips_ip_ire_badcnt_lifetime      ips_propinfo_tbl[47].prop_cur_uval
2998 #define ips_ip_max_temp_idle            ips_propinfo_tbl[48].prop_cur_uval
2999 #define ips_ip_max_temp_defend          ips_propinfo_tbl[49].prop_cur_uval
3000 #define ips_ip_max_defend               ips_propinfo_tbl[50].prop_cur_uval
3001 #define ips_ip_defend_interval          ips_propinfo_tbl[51].prop_cur_uval
3002 #define ips_ip_dup_recovery             ips_propinfo_tbl[52].prop_cur_uval
3003 #define ips_ip_restrict_interzone_loopback ips_propinfo_tbl[53].prop_cur_bval
3004 #define ips_ip_lso_outbound             ips_propinfo_tbl[54].prop_cur_bval
3005 #define ips_igmp_max_version            ips_propinfo_tbl[55].prop_cur_uval
3006 #define ips_mld_max_version             ips_propinfo_tbl[56].prop_cur_uval
3007 #define ips_ip_forwarding               ips_propinfo_tbl[57].prop_cur_bval
3008 #define ips_ipv6_forwarding             ips_propinfo_tbl[58].prop_cur_bval
3009 #define ips_ip_reassembly_timeout       ips_propinfo_tbl[59].prop_cur_uval
3010 #define ips_ipv6_reassembly_timeout     ips_propinfo_tbl[60].prop_cur_uval
3011 #define ips_ip_cgtp_filter              ips_propinfo_tbl[61].prop_cur_bval
3012 #define ips_arp_probe_delay             ips_propinfo_tbl[62].prop_cur_uval
3013 #define ips_arp_fastprobe_delay         ips_propinfo_tbl[63].prop_cur_uval
3014 #define ips_arp_probe_interval          ips_propinfo_tbl[64].prop_cur_uval
3015 #define ips_arp_fastprobe_interval      ips_propinfo_tbl[65].prop_cur_uval
3016 #define ips_arp_probe_count             ips_propinfo_tbl[66].prop_cur_uval
3017 #define ips_arp_fastprobe_count         ips_propinfo_tbl[67].prop_cur_uval
3018 #define ips_ipv4_dad_announce_interval  ips_propinfo_tbl[68].prop_cur_uval
3019 #define ips_ipv6_dad_announce_interval  ips_propinfo_tbl[69].prop_cur_uval
3020 #define ips_arp_defend_interval         ips_propinfo_tbl[70].prop_cur_uval
3021 #define ips_arp_defend_rate             ips_propinfo_tbl[71].prop_cur_uval
3022 #define ips_ndp_defend_interval         ips_propinfo_tbl[72].prop_cur_uval
3023 #define ips_ndp_defend_rate             ips_propinfo_tbl[73].prop_cur_uval
3024 #define ips_arp_defend_period           ips_propinfo_tbl[74].prop_cur_uval
3025 #define ips_ndp_defend_period           ips_propinfo_tbl[75].prop_cur_uval
3026 #define ips_ipv4_icmp_return_pmtu       ips_propinfo_tbl[76].prop_cur_bval
3027 #define ips_ipv6_icmp_return_pmtu       ips_propinfo_tbl[77].prop_cur_bval
3028 #define ips_ip_arp_publish_count        ips_propinfo_tbl[78].prop_cur_uval
3029 #define ips_ip_arp_publish_interval     ips_propinfo_tbl[79].prop_cur_uval
3030 #define ips_ip_strict_src_multihoming   ips_propinfo_tbl[80].prop_cur_uval
3031 #define ips_ipv6_strict_src_multihoming ips_propinfo_tbl[81].prop_cur_uval
3032 #define ips_ipv6_drop_inbound_icmpv6    ips_propinfo_tbl[82].prop_cur_bval
3033 
3034 extern int      dohwcksum;      /* use h/w cksum if supported by the h/w */
3035 #ifdef ZC_TEST
3036 extern int      noswcksum;
3037 #endif
3038 
3039 extern char     ipif_loopback_name[];
3040 
3041 extern nv_t     *ire_nv_tbl;
3042 
3043 extern struct module_info ip_mod_info;
3044 
3045 #define HOOKS4_INTERESTED_PHYSICAL_IN(ipst)     \
3046         ((ipst)->ips_ip4_physical_in_event.he_interested)
3047 #define HOOKS6_INTERESTED_PHYSICAL_IN(ipst)     \
3048         ((ipst)->ips_ip6_physical_in_event.he_interested)
3049 #define HOOKS4_INTERESTED_PHYSICAL_OUT(ipst)    \
3050         ((ipst)->ips_ip4_physical_out_event.he_interested)
3051 #define HOOKS6_INTERESTED_PHYSICAL_OUT(ipst)    \
3052         ((ipst)->ips_ip6_physical_out_event.he_interested)
3053 #define HOOKS4_INTERESTED_FORWARDING(ipst)      \
3054         ((ipst)->ips_ip4_forwarding_event.he_interested)
3055 #define HOOKS6_INTERESTED_FORWARDING(ipst)      \
3056         ((ipst)->ips_ip6_forwarding_event.he_interested)
3057 #define HOOKS4_INTERESTED_LOOPBACK_IN(ipst)     \
3058         ((ipst)->ips_ip4_loopback_in_event.he_interested)
3059 #define HOOKS6_INTERESTED_LOOPBACK_IN(ipst)     \
3060         ((ipst)->ips_ip6_loopback_in_event.he_interested)
3061 #define HOOKS4_INTERESTED_LOOPBACK_OUT(ipst)    \
3062         ((ipst)->ips_ip4_loopback_out_event.he_interested)
3063 #define HOOKS6_INTERESTED_LOOPBACK_OUT(ipst)    \
3064         ((ipst)->ips_ip6_loopback_out_event.he_interested)
3065 /*
3066  * Hooks marcos used inside of ip
3067  * The callers use the above INTERESTED macros first, hence
3068  * the he_interested check is superflous.
3069  */
3070 #define FW_HOOKS(_hook, _event, _ilp, _olp, _iph, _fm, _m, _llm, ipst, _err) \
3071         if ((_hook).he_interested) {                                    \
3072                 hook_pkt_event_t info;                                  \
3073                                                                         \
3074                 _NOTE(CONSTCOND)                                        \
3075                 ASSERT((_ilp != NULL) || (_olp != NULL));               \
3076                                                                         \
3077                 FW_SET_ILL_INDEX(info.hpe_ifp, (ill_t *)_ilp);          \
3078                 FW_SET_ILL_INDEX(info.hpe_ofp, (ill_t *)_olp);          \
3079                 info.hpe_protocol = ipst->ips_ipv4_net_data;         \
3080                 info.hpe_hdr = _iph;                                    \
3081                 info.hpe_mp = &(_fm);                                       \
3082                 info.hpe_mb = _m;                                       \
3083                 info.hpe_flags = _llm;                                  \
3084                 _err = hook_run(ipst->ips_ipv4_net_data->netd_hooks,      \
3085                     _event, (hook_data_t)&info);                    \
3086                 if (_err != 0) {                                        \
3087                         ip2dbg(("%s hook dropped mblk chain %p hdr %p\n",\
3088                             (_hook).he_name, (void *)_fm, (void *)_m)); \
3089                         if (_fm != NULL) {                              \
3090                                 freemsg(_fm);                           \
3091                                 _fm = NULL;                             \
3092                         }                                               \
3093                         _iph = NULL;                                    \
3094                         _m = NULL;                                      \
3095                 } else {                                                \
3096                         _iph = info.hpe_hdr;                            \
3097                         _m = info.hpe_mb;                               \
3098                 }                                                       \
3099         }
3100 
3101 #define FW_HOOKS6(_hook, _event, _ilp, _olp, _iph, _fm, _m, _llm, ipst, _err) \
3102         if ((_hook).he_interested) {                                    \
3103                 hook_pkt_event_t info;                                  \
3104                                                                         \
3105                 _NOTE(CONSTCOND)                                        \
3106                 ASSERT((_ilp != NULL) || (_olp != NULL));               \
3107                                                                         \
3108                 FW_SET_ILL_INDEX(info.hpe_ifp, (ill_t *)_ilp);          \
3109                 FW_SET_ILL_INDEX(info.hpe_ofp, (ill_t *)_olp);          \
3110                 info.hpe_protocol = ipst->ips_ipv6_net_data;         \
3111                 info.hpe_hdr = _iph;                                    \
3112                 info.hpe_mp = &(_fm);                                       \
3113                 info.hpe_mb = _m;                                       \
3114                 info.hpe_flags = _llm;                                  \
3115                 _err = hook_run(ipst->ips_ipv6_net_data->netd_hooks,      \
3116                     _event, (hook_data_t)&info);                    \
3117                 if (_err != 0) {                                        \
3118                         ip2dbg(("%s hook dropped mblk chain %p hdr %p\n",\
3119                             (_hook).he_name, (void *)_fm, (void *)_m)); \
3120                         if (_fm != NULL) {                              \
3121                                 freemsg(_fm);                           \
3122                                 _fm = NULL;                             \
3123                         }                                               \
3124                         _iph = NULL;                                    \
3125                         _m = NULL;                                      \
3126                 } else {                                                \
3127                         _iph = info.hpe_hdr;                            \
3128                         _m = info.hpe_mb;                               \
3129                 }                                                       \
3130         }
3131 
3132 #define FW_SET_ILL_INDEX(fp, ill)                                       \
3133         _NOTE(CONSTCOND)                                                \
3134         if ((ill) == NULL || (ill)->ill_phyint == NULL) {            \
3135                 (fp) = 0;                                               \
3136                 _NOTE(CONSTCOND)                                        \
3137         } else if (IS_UNDER_IPMP(ill)) {                                \
3138                 (fp) = ipmp_ill_get_ipmp_ifindex(ill);                  \
3139         } else {                                                        \
3140                 (fp) = (ill)->ill_phyint->phyint_ifindex;         \
3141         }
3142 
3143 /*
3144  * Network byte order macros
3145  */
3146 #ifdef  _BIG_ENDIAN
3147 #define N_IN_CLASSA_NET         IN_CLASSA_NET
3148 #define N_IN_CLASSD_NET         IN_CLASSD_NET
3149 #define N_INADDR_UNSPEC_GROUP   INADDR_UNSPEC_GROUP
3150 #define N_IN_LOOPBACK_NET       (ipaddr_t)0x7f000000U
3151 #else /* _BIG_ENDIAN */
3152 #define N_IN_CLASSA_NET         (ipaddr_t)0x000000ffU
3153 #define N_IN_CLASSD_NET         (ipaddr_t)0x000000f0U
3154 #define N_INADDR_UNSPEC_GROUP   (ipaddr_t)0x000000e0U
3155 #define N_IN_LOOPBACK_NET       (ipaddr_t)0x0000007fU
3156 #endif /* _BIG_ENDIAN */
3157 #define CLASSD(addr)    (((addr) & N_IN_CLASSD_NET) == N_INADDR_UNSPEC_GROUP)
3158 #define CLASSE(addr)    (((addr) & N_IN_CLASSD_NET) == N_IN_CLASSD_NET)
3159 #define IP_LOOPBACK_ADDR(addr)                  \
3160         (((addr) & N_IN_CLASSA_NET == N_IN_LOOPBACK_NET))
3161 
3162 extern int      ip_debug;
3163 extern uint_t   ip_thread_data;
3164 extern krwlock_t ip_thread_rwlock;
3165 extern list_t   ip_thread_list;
3166 
3167 #ifdef IP_DEBUG
3168 #include <sys/debug.h>
3169 #include <sys/promif.h>
3170 
3171 #define ip0dbg(a)       printf a
3172 #define ip1dbg(a)       if (ip_debug > 2) printf a
3173 #define ip2dbg(a)       if (ip_debug > 3) printf a
3174 #define ip3dbg(a)       if (ip_debug > 4) printf a
3175 #else
3176 #define ip0dbg(a)       /* */
3177 #define ip1dbg(a)       /* */
3178 #define ip2dbg(a)       /* */
3179 #define ip3dbg(a)       /* */
3180 #endif  /* IP_DEBUG */
3181 
3182 /* Default MAC-layer address string length for mac_colon_addr */
3183 #define MAC_STR_LEN     128
3184 
3185 struct  mac_header_info_s;
3186 
3187 extern void     ill_frag_timer(void *);
3188 extern ill_t    *ill_first(int, int, ill_walk_context_t *, ip_stack_t *);
3189 extern ill_t    *ill_next(ill_walk_context_t *, ill_t *);
3190 extern void     ill_frag_timer_start(ill_t *);
3191 extern void     ill_nic_event_dispatch(ill_t *, lif_if_t, nic_event_t,
3192     nic_event_data_t, size_t);
3193 extern mblk_t   *ip_carve_mp(mblk_t **, ssize_t);
3194 extern mblk_t   *ip_dlpi_alloc(size_t, t_uscalar_t);
3195 extern mblk_t   *ip_dlnotify_alloc(uint_t, uint_t);
3196 extern mblk_t   *ip_dlnotify_alloc2(uint_t, uint_t, uint_t);
3197 extern char     *ip_dot_addr(ipaddr_t, char *);
3198 extern const char *mac_colon_addr(const uint8_t *, size_t, char *, size_t);
3199 extern void     ip_lwput(queue_t *, mblk_t *);
3200 extern boolean_t icmp_err_rate_limit(ip_stack_t *);
3201 extern void     icmp_frag_needed(mblk_t *, int, ip_recv_attr_t *);
3202 extern mblk_t   *icmp_inbound_v4(mblk_t *, ip_recv_attr_t *);
3203 extern void     icmp_time_exceeded(mblk_t *, uint8_t, ip_recv_attr_t *);
3204 extern void     icmp_unreachable(mblk_t *, uint8_t, ip_recv_attr_t *);
3205 extern boolean_t ip_ipsec_policy_inherit(conn_t *, conn_t *, ip_recv_attr_t *);
3206 extern void     *ip_pullup(mblk_t *, ssize_t, ip_recv_attr_t *);
3207 extern void     ip_setl2src(mblk_t *, ip_recv_attr_t *, ill_t *);
3208 extern mblk_t   *ip_check_and_align_header(mblk_t *, uint_t, ip_recv_attr_t *);
3209 extern mblk_t   *ip_check_length(mblk_t *, uchar_t *, ssize_t, uint_t, uint_t,
3210     ip_recv_attr_t *);
3211 extern mblk_t   *ip_check_optlen(mblk_t *, ipha_t *, uint_t, uint_t,
3212     ip_recv_attr_t *);
3213 extern mblk_t   *ip_fix_dbref(mblk_t *, ip_recv_attr_t *);
3214 extern uint_t   ip_cksum(mblk_t *, int, uint32_t);
3215 extern int      ip_close(queue_t *, int);
3216 extern uint16_t ip_csum_hdr(ipha_t *);
3217 extern void     ip_forward_xmit_v4(nce_t *, ill_t *, mblk_t *, ipha_t *,
3218     ip_recv_attr_t *, uint32_t, uint32_t);
3219 extern boolean_t ip_forward_options(mblk_t *, ipha_t *, ill_t *,
3220     ip_recv_attr_t *);
3221 extern int      ip_fragment_v4(mblk_t *, nce_t *, iaflags_t, uint_t, uint32_t,
3222     uint32_t, zoneid_t, zoneid_t, pfirepostfrag_t postfragfn,
3223     uintptr_t *cookie);
3224 extern void     ip_proto_not_sup(mblk_t *, ip_recv_attr_t *);
3225 extern void     ip_ire_g_fini(void);
3226 extern void     ip_ire_g_init(void);
3227 extern void     ip_ire_fini(ip_stack_t *);
3228 extern void     ip_ire_init(ip_stack_t *);
3229 extern void     ip_mdata_to_mhi(ill_t *, mblk_t *, struct mac_header_info_s *);
3230 extern int      ip_openv4(queue_t *q, dev_t *devp, int flag, int sflag,
3231                     cred_t *credp);
3232 extern int      ip_openv6(queue_t *q, dev_t *devp, int flag, int sflag,
3233                     cred_t *credp);
3234 extern int      ip_reassemble(mblk_t *, ipf_t *, uint_t, boolean_t, ill_t *,
3235     size_t);
3236 extern void     ip_rput(queue_t *, mblk_t *);
3237 extern void     ip_input(ill_t *, ill_rx_ring_t *, mblk_t *,
3238     struct mac_header_info_s *);
3239 extern void     ip_input_v6(ill_t *, ill_rx_ring_t *, mblk_t *,
3240     struct mac_header_info_s *);
3241 extern mblk_t   *ip_input_common_v4(ill_t *, ill_rx_ring_t *, mblk_t *,
3242     struct mac_header_info_s *, squeue_t *, mblk_t **, uint_t *);
3243 extern mblk_t   *ip_input_common_v6(ill_t *, ill_rx_ring_t *, mblk_t *,
3244     struct mac_header_info_s *, squeue_t *, mblk_t **, uint_t *);
3245 extern void     ill_input_full_v4(mblk_t *, void *, void *,
3246     ip_recv_attr_t *, rtc_t *);
3247 extern void     ill_input_short_v4(mblk_t *, void *, void *,
3248     ip_recv_attr_t *, rtc_t *);
3249 extern void     ill_input_full_v6(mblk_t *, void *, void *,
3250     ip_recv_attr_t *, rtc_t *);
3251 extern void     ill_input_short_v6(mblk_t *, void *, void *,
3252     ip_recv_attr_t *, rtc_t *);
3253 extern ipaddr_t ip_input_options(ipha_t *, ipaddr_t, mblk_t *,
3254     ip_recv_attr_t *, int *);
3255 extern boolean_t ip_input_local_options(mblk_t *, ipha_t *, ip_recv_attr_t *);
3256 extern mblk_t   *ip_input_fragment(mblk_t *, ipha_t *, ip_recv_attr_t *);
3257 extern mblk_t   *ip_input_fragment_v6(mblk_t *, ip6_t *, ip6_frag_t *, uint_t,
3258     ip_recv_attr_t *);
3259 extern void     ip_input_post_ipsec(mblk_t *, ip_recv_attr_t *);
3260 extern void     ip_fanout_v4(mblk_t *, ipha_t *, ip_recv_attr_t *);
3261 extern void     ip_fanout_v6(mblk_t *, ip6_t *, ip_recv_attr_t *);
3262 extern void     ip_fanout_proto_conn(conn_t *, mblk_t *, ipha_t *, ip6_t *,
3263     ip_recv_attr_t *);
3264 extern void     ip_fanout_proto_v4(mblk_t *, ipha_t *, ip_recv_attr_t *);
3265 extern void     ip_fanout_send_icmp_v4(mblk_t *, uint_t, uint_t,
3266     ip_recv_attr_t *);
3267 extern void     ip_fanout_udp_conn(conn_t *, mblk_t *, ipha_t *, ip6_t *,
3268     ip_recv_attr_t *);
3269 extern void     ip_fanout_udp_multi_v4(mblk_t *, ipha_t *, uint16_t, uint16_t,
3270     ip_recv_attr_t *);
3271 extern mblk_t   *zero_spi_check(mblk_t *, ip_recv_attr_t *);
3272 extern void     ip_build_hdrs_v4(uchar_t *, uint_t, const ip_pkt_t *, uint8_t);
3273 extern int      ip_find_hdr_v4(ipha_t *, ip_pkt_t *, boolean_t);
3274 extern int      ip_total_hdrs_len_v4(const ip_pkt_t *);
3275 
3276 extern mblk_t   *ip_accept_tcp(ill_t *, ill_rx_ring_t *, squeue_t *,
3277     mblk_t *, mblk_t **, uint_t *cnt);
3278 extern void     ip_rput_dlpi(ill_t *, mblk_t *);
3279 extern void     ip_rput_notdata(ill_t *, mblk_t *);
3280 
3281 extern void     ip_mib2_add_ip_stats(mib2_ipIfStatsEntry_t *,
3282                     mib2_ipIfStatsEntry_t *);
3283 extern void     ip_mib2_add_icmp6_stats(mib2_ipv6IfIcmpEntry_t *,
3284                     mib2_ipv6IfIcmpEntry_t *);
3285 extern void     ip_rput_other(ipsq_t *, queue_t *, mblk_t *, void *);
3286 extern ire_t    *ip_check_multihome(void *, ire_t *, ill_t *);
3287 extern void     ip_send_potential_redirect_v4(mblk_t *, ipha_t *, ire_t *,
3288     ip_recv_attr_t *);
3289 extern int      ip_set_destination_v4(ipaddr_t *, ipaddr_t, ipaddr_t,
3290     ip_xmit_attr_t *, iulp_t *, uint32_t, uint_t);
3291 extern int      ip_set_destination_v6(in6_addr_t *, const in6_addr_t *,
3292     const in6_addr_t *, ip_xmit_attr_t *, iulp_t *, uint32_t, uint_t);
3293 
3294 extern int      ip_output_simple(mblk_t *, ip_xmit_attr_t *);
3295 extern int      ip_output_simple_v4(mblk_t *, ip_xmit_attr_t *);
3296 extern int      ip_output_simple_v6(mblk_t *, ip_xmit_attr_t *);
3297 extern int      ip_output_options(mblk_t *, ipha_t *, ip_xmit_attr_t *,
3298     ill_t *);
3299 extern void     ip_output_local_options(ipha_t *, ip_stack_t *);
3300 
3301 extern ip_xmit_attr_t *conn_get_ixa(conn_t *, boolean_t);
3302 extern ip_xmit_attr_t *conn_get_ixa_tryhard(conn_t *, boolean_t);
3303 extern ip_xmit_attr_t *conn_replace_ixa(conn_t *, ip_xmit_attr_t *);
3304 extern ip_xmit_attr_t *conn_get_ixa_exclusive(conn_t *);
3305 extern ip_xmit_attr_t *ip_xmit_attr_duplicate(ip_xmit_attr_t *);
3306 extern void     ip_xmit_attr_replace_tsl(ip_xmit_attr_t *, ts_label_t *);
3307 extern void     ip_xmit_attr_restore_tsl(ip_xmit_attr_t *, cred_t *);
3308 boolean_t       ip_recv_attr_replace_label(ip_recv_attr_t *, ts_label_t *);
3309 extern void     ixa_inactive(ip_xmit_attr_t *);
3310 extern void     ixa_refrele(ip_xmit_attr_t *);
3311 extern boolean_t ixa_check_drain_insert(conn_t *, ip_xmit_attr_t *);
3312 extern void     ixa_cleanup(ip_xmit_attr_t *);
3313 extern void     ira_cleanup(ip_recv_attr_t *, boolean_t);
3314 extern void     ixa_safe_copy(ip_xmit_attr_t *, ip_xmit_attr_t *);
3315 
3316 extern int      conn_ip_output(mblk_t *, ip_xmit_attr_t *);
3317 extern boolean_t ip_output_verify_local(ip_xmit_attr_t *);
3318 extern mblk_t   *ip_output_process_local(mblk_t *, ip_xmit_attr_t *, boolean_t,
3319     boolean_t, conn_t *);
3320 
3321 extern int      conn_opt_get(conn_opt_arg_t *, t_scalar_t, t_scalar_t,
3322     uchar_t *);
3323 extern int      conn_opt_set(conn_opt_arg_t *, t_scalar_t, t_scalar_t, uint_t,
3324     uchar_t *, boolean_t, cred_t *);
3325 extern boolean_t        conn_same_as_last_v4(conn_t *, sin_t *);
3326 extern boolean_t        conn_same_as_last_v6(conn_t *, sin6_t *);
3327 extern int      conn_update_label(const conn_t *, const ip_xmit_attr_t *,
3328     const in6_addr_t *, ip_pkt_t *);
3329 
3330 extern int      ip_opt_set_multicast_group(conn_t *, t_scalar_t,
3331     uchar_t *, boolean_t, boolean_t);
3332 extern int      ip_opt_set_multicast_sources(conn_t *, t_scalar_t,
3333     uchar_t *, boolean_t, boolean_t);
3334 extern int      conn_getsockname(conn_t *, struct sockaddr *, uint_t *);
3335 extern int      conn_getpeername(conn_t *, struct sockaddr *, uint_t *);
3336 
3337 extern int      conn_build_hdr_template(conn_t *, uint_t, uint_t,
3338     const in6_addr_t *, const in6_addr_t *, uint32_t);
3339 extern mblk_t   *conn_prepend_hdr(ip_xmit_attr_t *, const ip_pkt_t *,
3340     const in6_addr_t *, const in6_addr_t *, uint8_t, uint32_t, uint_t,
3341     mblk_t *, uint_t, uint_t, uint32_t *, int *);
3342 extern void     ip_attr_newdst(ip_xmit_attr_t *);
3343 extern void     ip_attr_nexthop(const ip_pkt_t *, const ip_xmit_attr_t *,
3344     const in6_addr_t *, in6_addr_t *);
3345 extern int      conn_connect(conn_t *, iulp_t *, uint32_t);
3346 extern int      ip_attr_connect(const conn_t *, ip_xmit_attr_t *,
3347     const in6_addr_t *, const in6_addr_t *, const in6_addr_t *, in_port_t,
3348     in6_addr_t *, iulp_t *, uint32_t);
3349 extern int      conn_inherit_parent(conn_t *, conn_t *);
3350 
3351 extern void     conn_ixa_cleanup(conn_t *connp, void *arg);
3352 
3353 extern boolean_t conn_wantpacket(conn_t *, ip_recv_attr_t *, ipha_t *);
3354 extern uint_t   ip_type_v4(ipaddr_t, ip_stack_t *);
3355 extern uint_t   ip_type_v6(const in6_addr_t *, ip_stack_t *);
3356 
3357 extern void     ip_wput_nondata(queue_t *, mblk_t *);
3358 extern void     ip_wsrv(queue_t *);
3359 extern char     *ip_nv_lookup(nv_t *, int);
3360 extern boolean_t ip_local_addr_ok_v6(const in6_addr_t *, const in6_addr_t *);
3361 extern boolean_t ip_remote_addr_ok_v6(const in6_addr_t *, const in6_addr_t *);
3362 extern ipaddr_t ip_massage_options(ipha_t *, netstack_t *);
3363 extern ipaddr_t ip_net_mask(ipaddr_t);
3364 extern void     arp_bringup_done(ill_t *, int);
3365 extern void     arp_replumb_done(ill_t *, int);
3366 
3367 extern struct qinit iprinitv6;
3368 
3369 extern void     ipmp_init(ip_stack_t *);
3370 extern void     ipmp_destroy(ip_stack_t *);
3371 extern ipmp_grp_t *ipmp_grp_create(const char *, phyint_t *);
3372 extern void     ipmp_grp_destroy(ipmp_grp_t *);
3373 extern void     ipmp_grp_info(const ipmp_grp_t *, lifgroupinfo_t *);
3374 extern int      ipmp_grp_rename(ipmp_grp_t *, const char *);
3375 extern ipmp_grp_t *ipmp_grp_lookup(const char *, ip_stack_t *);
3376 extern int      ipmp_grp_vet_phyint(ipmp_grp_t *, phyint_t *);
3377 extern ipmp_illgrp_t *ipmp_illgrp_create(ill_t *);
3378 extern void     ipmp_illgrp_destroy(ipmp_illgrp_t *);
3379 extern ill_t    *ipmp_illgrp_add_ipif(ipmp_illgrp_t *, ipif_t *);
3380 extern void     ipmp_illgrp_del_ipif(ipmp_illgrp_t *, ipif_t *);
3381 extern ill_t    *ipmp_illgrp_next_ill(ipmp_illgrp_t *);
3382 extern ill_t    *ipmp_illgrp_hold_next_ill(ipmp_illgrp_t *);
3383 extern ill_t    *ipmp_illgrp_hold_cast_ill(ipmp_illgrp_t *);
3384 extern ill_t    *ipmp_illgrp_ipmp_ill(ipmp_illgrp_t *);
3385 extern void     ipmp_illgrp_refresh_mtu(ipmp_illgrp_t *);
3386 extern ipmp_arpent_t *ipmp_illgrp_create_arpent(ipmp_illgrp_t *,
3387     boolean_t, ipaddr_t, uchar_t *, size_t, uint16_t);
3388 extern void     ipmp_illgrp_destroy_arpent(ipmp_illgrp_t *, ipmp_arpent_t *);
3389 extern ipmp_arpent_t *ipmp_illgrp_lookup_arpent(ipmp_illgrp_t *, ipaddr_t *);
3390 extern void     ipmp_illgrp_refresh_arpent(ipmp_illgrp_t *);
3391 extern void     ipmp_illgrp_mark_arpent(ipmp_illgrp_t *, ipmp_arpent_t *);
3392 extern ill_t    *ipmp_illgrp_find_ill(ipmp_illgrp_t *, uchar_t *, uint_t);
3393 extern void     ipmp_illgrp_link_grp(ipmp_illgrp_t *, ipmp_grp_t *);
3394 extern int      ipmp_illgrp_unlink_grp(ipmp_illgrp_t *);
3395 extern uint_t   ipmp_ill_get_ipmp_ifindex(const ill_t *);
3396 extern void     ipmp_ill_join_illgrp(ill_t *, ipmp_illgrp_t *);
3397 extern void     ipmp_ill_leave_illgrp(ill_t *);
3398 extern ill_t    *ipmp_ill_hold_ipmp_ill(ill_t *);
3399 extern ill_t    *ipmp_ill_hold_xmit_ill(ill_t *, boolean_t);
3400 extern boolean_t ipmp_ill_is_active(ill_t *);
3401 extern void     ipmp_ill_refresh_active(ill_t *);
3402 extern void     ipmp_phyint_join_grp(phyint_t *, ipmp_grp_t *);
3403 extern void     ipmp_phyint_leave_grp(phyint_t *);
3404 extern void     ipmp_phyint_refresh_active(phyint_t *);
3405 extern ill_t    *ipmp_ipif_bound_ill(const ipif_t *);
3406 extern ill_t    *ipmp_ipif_hold_bound_ill(const ipif_t *);
3407 extern boolean_t ipmp_ipif_is_dataaddr(const ipif_t *);
3408 extern boolean_t ipmp_ipif_is_stubaddr(const ipif_t *);
3409 extern boolean_t ipmp_packet_is_probe(mblk_t *, ill_t *);
3410 extern void     ipmp_ncec_delete_nce(ncec_t *);
3411 extern void     ipmp_ncec_refresh_nce(ncec_t *);
3412 
3413 extern void     conn_drain_insert(conn_t *, idl_tx_list_t *);
3414 extern void     conn_setqfull(conn_t *, boolean_t *);
3415 extern void     conn_clrqfull(conn_t *, boolean_t *);
3416 extern int      conn_ipsec_length(conn_t *);
3417 extern ipaddr_t ip_get_dst(ipha_t *);
3418 extern uint_t   ip_get_pmtu(ip_xmit_attr_t *);
3419 extern uint_t   ip_get_base_mtu(ill_t *, ire_t *);
3420 extern mblk_t *ip_output_attach_policy(mblk_t *, ipha_t *, ip6_t *,
3421     const conn_t *, ip_xmit_attr_t *);
3422 extern int      ipsec_out_extra_length(ip_xmit_attr_t *);
3423 extern int      ipsec_out_process(mblk_t *, ip_xmit_attr_t *);
3424 extern int      ip_output_post_ipsec(mblk_t *, ip_xmit_attr_t *);
3425 extern void     ipsec_out_to_in(ip_xmit_attr_t *, ill_t *ill,
3426     ip_recv_attr_t *);
3427 
3428 extern void     ire_cleanup(ire_t *);
3429 extern void     ire_inactive(ire_t *);
3430 extern boolean_t irb_inactive(irb_t *);
3431 extern ire_t    *ire_unlink(irb_t *);
3432 
3433 #ifdef DEBUG
3434 extern  boolean_t th_trace_ref(const void *, ip_stack_t *);
3435 extern  void    th_trace_unref(const void *);
3436 extern  void    th_trace_cleanup(const void *, boolean_t);
3437 extern  void    ire_trace_ref(ire_t *);
3438 extern  void    ire_untrace_ref(ire_t *);
3439 #endif
3440 
3441 extern int      ip_srcid_insert(const in6_addr_t *, zoneid_t, ip_stack_t *);
3442 extern int      ip_srcid_remove(const in6_addr_t *, zoneid_t, ip_stack_t *);
3443 extern void     ip_srcid_find_id(uint_t, in6_addr_t *, zoneid_t, netstack_t *);
3444 extern uint_t   ip_srcid_find_addr(const in6_addr_t *, zoneid_t, netstack_t *);
3445 
3446 extern uint8_t  ipoptp_next(ipoptp_t *);
3447 extern uint8_t  ipoptp_first(ipoptp_t *, ipha_t *);
3448 extern int      ip_opt_get_user(conn_t *, uchar_t *);
3449 extern int      ipsec_req_from_conn(conn_t *, ipsec_req_t *, int);
3450 extern int      ip_snmp_get(queue_t *q, mblk_t *mctl, int level, boolean_t);
3451 extern int      ip_snmp_set(queue_t *q, int, int, uchar_t *, int);
3452 extern void     ip_process_ioctl(ipsq_t *, queue_t *, mblk_t *, void *);
3453 extern void     ip_quiesce_conn(conn_t *);
3454 extern  void    ip_reprocess_ioctl(ipsq_t *, queue_t *, mblk_t *, void *);
3455 extern void     ip_ioctl_finish(queue_t *, mblk_t *, int, int, ipsq_t *);
3456 
3457 extern boolean_t ip_cmpbuf(const void *, uint_t, boolean_t, const void *,
3458     uint_t);
3459 extern boolean_t ip_allocbuf(void **, uint_t *, boolean_t, const void *,
3460     uint_t);
3461 extern void     ip_savebuf(void **, uint_t *, boolean_t, const void *, uint_t);
3462 
3463 extern boolean_t        ipsq_pending_mp_cleanup(ill_t *, conn_t *);
3464 extern void     conn_ioctl_cleanup(conn_t *);
3465 
3466 extern void     ip_unbind(conn_t *);
3467 
3468 extern void tnet_init(void);
3469 extern void tnet_fini(void);
3470 
3471 /*
3472  * Hook functions to enable cluster networking
3473  * On non-clustered systems these vectors must always be NULL.
3474  */
3475 extern int (*cl_inet_isclusterwide)(netstackid_t stack_id, uint8_t protocol,
3476     sa_family_t addr_family, uint8_t *laddrp, void *args);
3477 extern uint32_t (*cl_inet_ipident)(netstackid_t stack_id, uint8_t protocol,
3478     sa_family_t addr_family, uint8_t *laddrp, uint8_t *faddrp,
3479     void *args);
3480 extern int (*cl_inet_connect2)(netstackid_t stack_id, uint8_t protocol,
3481     boolean_t is_outgoing, sa_family_t addr_family, uint8_t *laddrp,
3482     in_port_t lport, uint8_t *faddrp, in_port_t fport, void *args);
3483 extern void (*cl_inet_getspi)(netstackid_t, uint8_t, uint8_t *, size_t,
3484     void *);
3485 extern void (*cl_inet_getspi)(netstackid_t stack_id, uint8_t protocol,
3486     uint8_t *ptr, size_t len, void *args);
3487 extern int (*cl_inet_checkspi)(netstackid_t stack_id, uint8_t protocol,
3488     uint32_t spi, void *args);
3489 extern void (*cl_inet_deletespi)(netstackid_t stack_id, uint8_t protocol,
3490     uint32_t spi, void *args);
3491 extern void (*cl_inet_idlesa)(netstackid_t, uint8_t, uint32_t,
3492     sa_family_t, in6_addr_t, in6_addr_t, void *);
3493 
3494 
3495 /* Hooks for CGTP (multirt routes) filtering module */
3496 #define CGTP_FILTER_REV_1       1
3497 #define CGTP_FILTER_REV_2       2
3498 #define CGTP_FILTER_REV_3       3
3499 #define CGTP_FILTER_REV         CGTP_FILTER_REV_3
3500 
3501 /* cfo_filter and cfo_filter_v6 hooks return values */
3502 #define CGTP_IP_PKT_NOT_CGTP    0
3503 #define CGTP_IP_PKT_PREMIUM     1
3504 #define CGTP_IP_PKT_DUPLICATE   2
3505 
3506 /* Version 3 of the filter interface */
3507 typedef struct cgtp_filter_ops {
3508         int     cfo_filter_rev;                 /* CGTP_FILTER_REV_3 */
3509         int     (*cfo_change_state)(netstackid_t, int);
3510         int     (*cfo_add_dest_v4)(netstackid_t, ipaddr_t, ipaddr_t,
3511                     ipaddr_t, ipaddr_t);
3512         int     (*cfo_del_dest_v4)(netstackid_t, ipaddr_t, ipaddr_t);
3513         int     (*cfo_add_dest_v6)(netstackid_t, in6_addr_t *, in6_addr_t *,
3514                     in6_addr_t *, in6_addr_t *);
3515         int     (*cfo_del_dest_v6)(netstackid_t, in6_addr_t *, in6_addr_t *);
3516         int     (*cfo_filter)(netstackid_t, uint_t, mblk_t *);
3517         int     (*cfo_filter_v6)(netstackid_t, uint_t, ip6_t *,
3518                     ip6_frag_t *);
3519 } cgtp_filter_ops_t;
3520 
3521 #define CGTP_MCAST_SUCCESS      1
3522 
3523 /*
3524  * The separate CGTP module needs this global symbol so that it
3525  * can check the version and determine whether to use the old or the new
3526  * version of the filtering interface.
3527  */
3528 extern int      ip_cgtp_filter_rev;
3529 
3530 extern int      ip_cgtp_filter_supported(void);
3531 extern int      ip_cgtp_filter_register(netstackid_t, cgtp_filter_ops_t *);
3532 extern int      ip_cgtp_filter_unregister(netstackid_t);
3533 extern int      ip_cgtp_filter_is_registered(netstackid_t);
3534 
3535 /*
3536  * rr_ring_state cycles in the order shown below from RR_FREE through
3537  * RR_FREE_IN_PROG and  back to RR_FREE.
3538  */
3539 typedef enum {
3540         RR_FREE,                        /* Free slot */
3541         RR_SQUEUE_UNBOUND,              /* Ring's squeue is unbound */
3542         RR_SQUEUE_BIND_INPROG,          /* Ring's squeue bind in progress */
3543         RR_SQUEUE_BOUND,                /* Ring's squeue bound to cpu */
3544         RR_FREE_INPROG                  /* Ring is being freed */
3545 } ip_ring_state_t;
3546 
3547 #define ILL_MAX_RINGS           256     /* Max num of rx rings we can manage */
3548 #define ILL_POLLING             0x01    /* Polling in use */
3549 
3550 /*
3551  * These functions pointer types are exported by the mac/dls layer.
3552  * we need to duplicate the definitions here because we cannot
3553  * include mac/dls header files here.
3554  */
3555 typedef boolean_t               (*ip_mac_intr_disable_t)(void *);
3556 typedef void                    (*ip_mac_intr_enable_t)(void *);
3557 typedef ip_mac_tx_cookie_t      (*ip_dld_tx_t)(void *, mblk_t *,
3558     uint64_t, uint16_t);
3559 typedef void                    (*ip_flow_enable_t)(void *, ip_mac_tx_cookie_t);
3560 typedef void                    *(*ip_dld_callb_t)(void *,
3561     ip_flow_enable_t, void *);
3562 typedef boolean_t               (*ip_dld_fctl_t)(void *, ip_mac_tx_cookie_t);
3563 typedef int                     (*ip_capab_func_t)(void *, uint_t,
3564     void *, uint_t);
3565 
3566 /*
3567  * POLLING README
3568  * sq_get_pkts() is called to pick packets from softring in poll mode. It
3569  * calls rr_rx to get the chain and process it with rr_ip_accept.
3570  * rr_rx = mac_soft_ring_poll() to pick packets
3571  * rr_ip_accept = ip_accept_tcp() to process packets
3572  */
3573 
3574 /*
3575  * XXX: With protocol, service specific squeues, they will have
3576  * specific acceptor functions.
3577  */
3578 typedef mblk_t *(*ip_mac_rx_t)(void *, size_t);
3579 typedef mblk_t *(*ip_accept_t)(ill_t *, ill_rx_ring_t *,
3580     squeue_t *, mblk_t *, mblk_t **, uint_t *);
3581 
3582 /*
3583  * rr_intr_enable, rr_intr_disable, rr_rx_handle, rr_rx:
3584  * May be accessed while in the squeue AND after checking that SQS_POLL_CAPAB
3585  * is set.
3586  *
3587  * rr_ring_state: Protected by ill_lock.
3588  */
3589 struct ill_rx_ring {
3590         ip_mac_intr_disable_t   rr_intr_disable; /* Interrupt disabling func */
3591         ip_mac_intr_enable_t    rr_intr_enable; /* Interrupt enabling func */
3592         void                    *rr_intr_handle; /* Handle interrupt funcs */
3593         ip_mac_rx_t             rr_rx;          /* Driver receive function */
3594         ip_accept_t             rr_ip_accept;   /* IP accept function */
3595         void                    *rr_rx_handle;  /* Handle for Rx ring */
3596         squeue_t                *rr_sqp; /* Squeue the ring is bound to */
3597         ill_t                   *rr_ill;        /* back pointer to ill */
3598         ip_ring_state_t         rr_ring_state;  /* State of this ring */
3599 };
3600 
3601 /*
3602  * IP - DLD direct function call capability
3603  * Suffixes, df - dld function, dh - dld handle,
3604  * cf - client (IP) function, ch - client handle
3605  */
3606 typedef struct ill_dld_direct_s {               /* DLD provided driver Tx */
3607         ip_dld_tx_t             idd_tx_df;      /* str_mdata_fastpath_put */
3608         void                    *idd_tx_dh;     /* dld_str_t *dsp */
3609         ip_dld_callb_t          idd_tx_cb_df;   /* mac_tx_srs_notify */
3610         void                    *idd_tx_cb_dh;  /* mac_client_handle_t *mch */
3611         ip_dld_fctl_t           idd_tx_fctl_df; /* mac_tx_is_flow_blocked */
3612         void                    *idd_tx_fctl_dh;        /* mac_client_handle */
3613 } ill_dld_direct_t;
3614 
3615 /* IP - DLD polling capability */
3616 typedef struct ill_dld_poll_s {
3617         ill_rx_ring_t           idp_ring_tbl[ILL_MAX_RINGS];
3618 } ill_dld_poll_t;
3619 
3620 /* Describes ill->ill_dld_capab */
3621 struct ill_dld_capab_s {
3622         ip_capab_func_t         idc_capab_df;   /* dld_capab_func */
3623         void                    *idc_capab_dh;  /* dld_str_t *dsp */
3624         ill_dld_direct_t        idc_direct;
3625         ill_dld_poll_t          idc_poll;
3626 };
3627 
3628 /*
3629  * IP squeues exports
3630  */
3631 extern boolean_t        ip_squeue_fanout;
3632 
3633 #define IP_SQUEUE_GET(hint) ip_squeue_random(hint)
3634 
3635 extern void ip_squeue_init(void (*)(squeue_t *));
3636 extern squeue_t *ip_squeue_random(uint_t);
3637 extern squeue_t *ip_squeue_get(ill_rx_ring_t *);
3638 extern squeue_t *ip_squeue_getfree(pri_t);
3639 extern int ip_squeue_cpu_move(squeue_t *, processorid_t);
3640 extern void *ip_squeue_add_ring(ill_t *, void *);
3641 extern void ip_squeue_bind_ring(ill_t *, ill_rx_ring_t *, processorid_t);
3642 extern void ip_squeue_clean_ring(ill_t *, ill_rx_ring_t *);
3643 extern void ip_squeue_quiesce_ring(ill_t *, ill_rx_ring_t *);
3644 extern void ip_squeue_restart_ring(ill_t *, ill_rx_ring_t *);
3645 extern void ip_squeue_clean_all(ill_t *);
3646 extern boolean_t        ip_source_routed(ipha_t *, ip_stack_t *);
3647 
3648 extern void tcp_wput(queue_t *, mblk_t *);
3649 
3650 extern int      ip_fill_mtuinfo(conn_t *, ip_xmit_attr_t *,
3651     struct ip6_mtuinfo *);
3652 extern hook_t *ipobs_register_hook(netstack_t *, pfv_t);
3653 extern void ipobs_unregister_hook(netstack_t *, hook_t *);
3654 extern void ipobs_hook(mblk_t *, int, zoneid_t, zoneid_t, const ill_t *,
3655     ip_stack_t *);
3656 typedef void    (*ipsq_func_t)(ipsq_t *, queue_t *, mblk_t *, void *);
3657 
3658 extern void     dce_g_init(void);
3659 extern void     dce_g_destroy(void);
3660 extern void     dce_stack_init(ip_stack_t *);
3661 extern void     dce_stack_destroy(ip_stack_t *);
3662 extern void     dce_cleanup(uint_t, ip_stack_t *);
3663 extern dce_t    *dce_get_default(ip_stack_t *);
3664 extern dce_t    *dce_lookup_pkt(mblk_t *, ip_xmit_attr_t *, uint_t *);
3665 extern dce_t    *dce_lookup_v4(ipaddr_t, ip_stack_t *, uint_t *);
3666 extern dce_t    *dce_lookup_v6(const in6_addr_t *, uint_t, ip_stack_t *,
3667     uint_t *);
3668 extern dce_t    *dce_lookup_and_add_v4(ipaddr_t, ip_stack_t *);
3669 extern dce_t    *dce_lookup_and_add_v6(const in6_addr_t *, uint_t,
3670     ip_stack_t *);
3671 extern int      dce_update_uinfo_v4(ipaddr_t, iulp_t *, ip_stack_t *);
3672 extern int      dce_update_uinfo_v6(const in6_addr_t *, uint_t, iulp_t *,
3673     ip_stack_t *);
3674 extern int      dce_update_uinfo(const in6_addr_t *, uint_t, iulp_t *,
3675     ip_stack_t *);
3676 extern void     dce_increment_generation(dce_t *);
3677 extern void     dce_increment_all_generations(boolean_t, ip_stack_t *);
3678 extern void     dce_refrele(dce_t *);
3679 extern void     dce_refhold(dce_t *);
3680 extern void     dce_refrele_notr(dce_t *);
3681 extern void     dce_refhold_notr(dce_t *);
3682 mblk_t          *ip_snmp_get_mib2_ip_dce(queue_t *, mblk_t *, ip_stack_t *ipst);
3683 
3684 extern ip_laddr_t ip_laddr_verify_v4(ipaddr_t, zoneid_t,
3685     ip_stack_t *, boolean_t);
3686 extern ip_laddr_t ip_laddr_verify_v6(const in6_addr_t *, zoneid_t,
3687     ip_stack_t *, boolean_t, uint_t);
3688 extern int      ip_laddr_fanout_insert(conn_t *);
3689 
3690 extern boolean_t ip_verify_src(mblk_t *, ip_xmit_attr_t *, uint_t *);
3691 extern int      ip_verify_ire(mblk_t *, ip_xmit_attr_t *);
3692 
3693 extern mblk_t   *ip_xmit_attr_to_mblk(ip_xmit_attr_t *);
3694 extern boolean_t ip_xmit_attr_from_mblk(mblk_t *, ip_xmit_attr_t *);
3695 extern mblk_t   *ip_xmit_attr_free_mblk(mblk_t *);
3696 extern mblk_t   *ip_recv_attr_to_mblk(ip_recv_attr_t *);
3697 extern boolean_t ip_recv_attr_from_mblk(mblk_t *, ip_recv_attr_t *);
3698 extern mblk_t   *ip_recv_attr_free_mblk(mblk_t *);
3699 extern boolean_t ip_recv_attr_is_mblk(mblk_t *);
3700 
3701 /*
3702  * Squeue tags. Tags only need to be unique when the callback function is the
3703  * same to distinguish between different calls, but we use unique tags for
3704  * convenience anyway.
3705  */
3706 #define SQTAG_IP_INPUT                  1
3707 #define SQTAG_TCP_INPUT_ICMP_ERR        2
3708 #define SQTAG_TCP6_INPUT_ICMP_ERR       3
3709 #define SQTAG_IP_TCP_INPUT              4
3710 #define SQTAG_IP6_TCP_INPUT             5
3711 #define SQTAG_IP_TCP_CLOSE              6
3712 #define SQTAG_TCP_OUTPUT                7
3713 #define SQTAG_TCP_TIMER                 8
3714 #define SQTAG_TCP_TIMEWAIT              9
3715 #define SQTAG_TCP_ACCEPT_FINISH         10
3716 #define SQTAG_TCP_ACCEPT_FINISH_Q0      11
3717 #define SQTAG_TCP_ACCEPT_PENDING        12
3718 #define SQTAG_TCP_LISTEN_DISCON         13
3719 #define SQTAG_TCP_CONN_REQ_1            14
3720 #define SQTAG_TCP_EAGER_BLOWOFF         15
3721 #define SQTAG_TCP_EAGER_CLEANUP         16
3722 #define SQTAG_TCP_EAGER_CLEANUP_Q0      17
3723 #define SQTAG_TCP_CONN_IND              18
3724 #define SQTAG_TCP_RSRV                  19
3725 #define SQTAG_TCP_ABORT_BUCKET          20
3726 #define SQTAG_TCP_REINPUT               21
3727 #define SQTAG_TCP_REINPUT_EAGER         22
3728 #define SQTAG_TCP_INPUT_MCTL            23
3729 #define SQTAG_TCP_RPUTOTHER             24
3730 #define SQTAG_IP_PROTO_AGAIN            25
3731 #define SQTAG_IP_FANOUT_TCP             26
3732 #define SQTAG_IPSQ_CLEAN_RING           27
3733 #define SQTAG_TCP_WPUT_OTHER            28
3734 #define SQTAG_TCP_CONN_REQ_UNBOUND      29
3735 #define SQTAG_TCP_SEND_PENDING          30
3736 #define SQTAG_BIND_RETRY                31
3737 #define SQTAG_UDP_FANOUT                32
3738 #define SQTAG_UDP_INPUT                 33
3739 #define SQTAG_UDP_WPUT                  34
3740 #define SQTAG_UDP_OUTPUT                35
3741 #define SQTAG_TCP_KSSL_INPUT            36
3742 #define SQTAG_TCP_DROP_Q0               37
3743 #define SQTAG_TCP_CONN_REQ_2            38
3744 #define SQTAG_IP_INPUT_RX_RING          39
3745 #define SQTAG_SQUEUE_CHANGE             40
3746 #define SQTAG_CONNECT_FINISH            41
3747 #define SQTAG_SYNCHRONOUS_OP            42
3748 #define SQTAG_TCP_SHUTDOWN_OUTPUT       43
3749 #define SQTAG_TCP_IXA_CLEANUP           44
3750 #define SQTAG_TCP_SEND_SYNACK           45
3751 
3752 extern sin_t    sin_null;       /* Zero address for quick clears */
3753 extern sin6_t   sin6_null;      /* Zero address for quick clears */
3754 
3755 #endif  /* _KERNEL */
3756 
3757 #ifdef  __cplusplus
3758 }
3759 #endif
3760 
3761 #endif  /* _INET_IP_H */