sys/netinet/udp_var.h

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