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