sys/netinet/udp_var.h

   1 /*-
   2  * Copyright (c) 1982, 1986, 1989, 1993
   3  *      The Regents of the University of California.
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  * 4. Neither the name of the University nor the names of its contributors
  15  *    may be used to endorse or promote products derived from this software
  16  *    without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  *
  30  *      @(#)udp_var.h   8.1 (Berkeley) 6/10/93
  31  * $FreeBSD$
  32  */
  33
  34 #ifndef _NETINET_UDP_VAR_H_
  35 #define _NETINET_UDP_VAR_H_
  36
  37 /*
  38  * UDP kernel structures and variables.
  39  */
  40 struct udpiphdr {
  41         struct ipovly   ui_i;           /* overlaid ip structure */
  42         struct udphdr   ui_u;           /* udp header */
  43 };
  44 #define ui_x1           ui_i.ih_x1
  45 #define ui_v            ui_i.ih_x1[0]
  46 #define ui_pr           ui_i.ih_pr
  47 #define ui_len          ui_i.ih_len
  48 #define ui_src          ui_i.ih_src
  49 #define ui_dst          ui_i.ih_dst
  50 #define ui_sport        ui_u.uh_sport
  51 #define ui_dport        ui_u.uh_dport
  52 #define ui_ulen         ui_u.uh_ulen
  53 #define ui_sum          ui_u.uh_sum
  54
  55 struct inpcb;
  56 struct mbuf;
  57
  58 typedef void(*udp_tun_func_t)(struct mbuf *, int, struct inpcb *,
  59                               const struct sockaddr *, void *);
  60 typedef void(*udp_tun_icmp_t)(int, struct sockaddr *, void *, void *);
  61
  62 /*
  63  * UDP control block; one per udp.
  64  */
  65 struct udpcb {
  66         udp_tun_func_t  u_tun_func;     /* UDP kernel tunneling callback. */
  67         udp_tun_icmp_t  u_icmp_func;    /* UDP kernel tunneling icmp callback */
  68         u_int           u_flags;        /* Generic UDP flags. */
  69         uint16_t        u_rxcslen;      /* Coverage for incoming datagrams. */
  70         uint16_t        u_txcslen;      /* Coverage for outgoing datagrams. */
  71         void            *u_tun_ctx;     /* Tunneling callback context. */
  72 };
  73
  74 #define intoudpcb(ip)   ((struct udpcb *)(ip)->inp_ppcb)
  75 #define sotoudpcb(so)   (intoudpcb(sotoinpcb(so)))
  76
  77                                 /* IPsec: ESP in UDP tunneling: */
  78 #define UF_ESPINUDP_NON_IKE     0x00000001      /* w/ non-IKE marker .. */
  79         /* .. per draft-ietf-ipsec-nat-t-ike-0[01],
  80          * and draft-ietf-ipsec-udp-encaps-(00/)01.txt */
  81 #define UF_ESPINUDP             0x00000002      /* w/ non-ESP marker. */
  82
  83 struct udpstat {
  84                                 /* input statistics: */
  85         uint64_t udps_ipackets;         /* total input packets */
  86         uint64_t udps_hdrops;           /* packet shorter than header */
  87         uint64_t udps_badsum;           /* checksum error */
  88         uint64_t udps_nosum;            /* no checksum */
  89         uint64_t udps_badlen;           /* data length larger than packet */
  90         uint64_t udps_noport;           /* no socket on port */
  91         uint64_t udps_noportbcast;      /* of above, arrived as broadcast */
  92         uint64_t udps_fullsock;         /* not delivered, input socket full */
  93         uint64_t udpps_pcbcachemiss;    /* input packets missing pcb cache */
  94         uint64_t udpps_pcbhashmiss;     /* input packets not for hashed pcb */
  95                                 /* output statistics: */
  96         uint64_t udps_opackets;         /* total output packets */
  97         uint64_t udps_fastout;          /* output packets on fast path */
  98         /* of no socket on port, arrived as multicast */
  99         uint64_t udps_noportmcast;
 100         uint64_t udps_filtermcast;      /* blocked by multicast filter */
 101 };
 102
 103 #ifdef _KERNEL
 104 #include <sys/counter.h>
 105
 106 VNET_PCPUSTAT_DECLARE(struct udpstat, udpstat);
 107 /*
 108  * In-kernel consumers can use these accessor macros directly to update
 109  * stats.
 110  */
 111 #define UDPSTAT_ADD(name, val)  \
 112     VNET_PCPUSTAT_ADD(struct udpstat, udpstat, name, (val))
 113 #define UDPSTAT_INC(name)       UDPSTAT_ADD(name, 1)
 114
 115 /*
 116  * Kernel module consumers must use this accessor macro.
 117  */
 118 void    kmod_udpstat_inc(int statnum);
 119 #define KMOD_UDPSTAT_INC(name)  \
 120     kmod_udpstat_inc(offsetof(struct udpstat, name) / sizeof(uint64_t))
 121 #endif
 122
 123 /*
 124  * Identifiers for UDP sysctl nodes.
 125  */
 126 #define UDPCTL_CHECKSUM         1       /* checksum UDP packets */
 127 #define UDPCTL_STATS            2       /* statistics (read-only) */
 128 #define UDPCTL_MAXDGRAM         3       /* max datagram size */
 129 #define UDPCTL_RECVSPACE        4       /* default receive buffer space */
 130 #define UDPCTL_PCBLIST          5       /* list of PCBs for UDP sockets */
 131
 132 #ifdef _KERNEL
 133 #include <netinet/in_pcb.h>
 134 SYSCTL_DECL(_net_inet_udp);
 135
 136 extern struct pr_usrreqs        udp_usrreqs;
 137 VNET_DECLARE(struct inpcbhead, udb);
 138 VNET_DECLARE(struct inpcbinfo, udbinfo);
 139 VNET_DECLARE(struct inpcbhead, ulitecb);
 140 VNET_DECLARE(struct inpcbinfo, ulitecbinfo);
 141 #define V_udb                   VNET(udb)
 142 #define V_udbinfo               VNET(udbinfo)
 143 #define V_ulitecb               VNET(ulitecb)
 144 #define V_ulitecbinfo           VNET(ulitecbinfo)
 145
 146 extern u_long                   udp_sendspace;
 147 extern u_long                   udp_recvspace;
 148 VNET_DECLARE(int, udp_cksum);
 149 VNET_DECLARE(int, udp_blackhole);
 150 #define V_udp_cksum             VNET(udp_cksum)
 151 #define V_udp_blackhole         VNET(udp_blackhole)
 152 extern int                      udp_log_in_vain;
 153
 154 static __inline struct inpcbinfo *
 155 udp_get_inpcbinfo(int protocol)
 156 {
 157         return (protocol == IPPROTO_UDP) ? &V_udbinfo : &V_ulitecbinfo;
 158 }
 159
 160 static __inline struct inpcbhead *
 161 udp_get_pcblist(int protocol)
 162 {
 163         return (protocol == IPPROTO_UDP) ? &V_udb : &V_ulitecb;
 164 }
 165
 166 int             udp_newudpcb(struct inpcb *);
 167 void            udp_discardcb(struct udpcb *);
 168
 169 void            udp_ctlinput(int, struct sockaddr *, void *);
 170 void            udplite_ctlinput(int, struct sockaddr *, void *);
 171 int             udp_ctloutput(struct socket *, struct sockopt *);
 172 void            udp_init(void);
 173 void            udplite_init(void);
 174 int             udp_input(struct mbuf **, int *, int);
 175 void            udplite_input(struct mbuf *, int);
 176 struct inpcb    *udp_notify(struct inpcb *inp, int errno);
 177 int             udp_shutdown(struct socket *so);
 178
 179 int             udp_set_kernel_tunneling(struct socket *so, udp_tun_func_t f,
 180                     udp_tun_icmp_t i, void *ctx);
 181
 182 #endif /* _KERNEL */
 183
 184 #endif /* _NETINET_UDP_VAR_H_ */