blob: 3e55a99b0ba3836441804f33b7c6880d21a3d9cb [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * INET An implementation of the TCP/IP protocol suite for the LINUX
3 * operating system. INET is implemented using the BSD Socket
4 * interface as the means of communication with the user level.
5 *
6 * Definitions for the UDP module.
7 *
8 * Version: @(#)udp.h 1.0.2 05/07/93
9 *
Jesper Juhl02c30a82005-05-05 16:16:16 -070010 * Authors: Ross Biro
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 * Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
12 *
13 * Fixes:
14 * Alan Cox : Turned on udp checksums. I don't want to
15 * chase 'memory corruption' bugs that aren't!
16 *
17 * This program is free software; you can redistribute it and/or
18 * modify it under the terms of the GNU General Public License
19 * as published by the Free Software Foundation; either version
20 * 2 of the License, or (at your option) any later version.
21 */
22#ifndef _UDP_H
23#define _UDP_H
24
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/list.h>
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -020026#include <net/inet_sock.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <net/sock.h>
28#include <net/snmp.h>
Gerrit Renkerba4e58e2006-11-27 11:10:57 -080029#include <net/ip.h>
30#include <linux/ipv6.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#include <linux/seq_file.h>
Al Virobd01f842006-10-19 17:23:57 -040032#include <linux/poll.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033
Gerrit Renkerba4e58e2006-11-27 11:10:57 -080034/**
35 * struct udp_skb_cb - UDP(-Lite) private variables
36 *
37 * @header: private variables used by IPv4/IPv6
38 * @cscov: checksum coverage length (UDP-Lite only)
39 * @partial_cov: if set indicates partial csum coverage
40 */
41struct udp_skb_cb {
42 union {
43 struct inet_skb_parm h4;
44#if defined(CONFIG_IPV6) || defined (CONFIG_IPV6_MODULE)
45 struct inet6_skb_parm h6;
46#endif
47 } header;
48 __u16 cscov;
49 __u8 partial_cov;
50};
51#define UDP_SKB_CB(__skb) ((struct udp_skb_cb *)((__skb)->cb))
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
Linus Torvalds1da177e2005-04-16 15:20:36 -070053extern struct hlist_head udp_hash[UDP_HTABLE_SIZE];
54extern rwlock_t udp_hash_lock;
55
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
57/* Note: this must match 'valbool' in sock_setsockopt */
58#define UDP_CSUM_NOXMIT 1
59
60/* Used by SunRPC/xprt layer. */
61#define UDP_CSUM_NORCV 2
62
63/* Default, as per the RFC, is to always do csums. */
64#define UDP_CSUM_DEFAULT 0
65
66extern struct proto udp_prot;
67
Hideo Aoki95766ff2007-12-31 00:29:24 -080068extern atomic_t udp_memory_allocated;
69
70/* sysctl variables for udp */
71extern int sysctl_udp_mem[3];
72extern int sysctl_udp_rmem_min;
73extern int sysctl_udp_wmem_min;
74
Arnaldo Carvalho de Melo14c85022005-12-27 02:43:12 -020075struct sk_buff;
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
Gerrit Renkerba4e58e2006-11-27 11:10:57 -080077/*
78 * Generic checksumming routines for UDP(-Lite) v4 and v6
79 */
Al Virob51655b2006-11-14 21:40:42 -080080static inline __sum16 __udp_lib_checksum_complete(struct sk_buff *skb)
Gerrit Renkerba4e58e2006-11-27 11:10:57 -080081{
Herbert Xu759e5d02007-03-25 20:10:56 -070082 return __skb_checksum_complete_head(skb, UDP_SKB_CB(skb)->cscov);
Gerrit Renkerba4e58e2006-11-27 11:10:57 -080083}
84
Al Viro8e5200f2006-11-20 18:06:37 -080085static inline int udp_lib_checksum_complete(struct sk_buff *skb)
Gerrit Renkerba4e58e2006-11-27 11:10:57 -080086{
Herbert Xu60476372007-04-09 11:59:39 -070087 return !skb_csum_unnecessary(skb) &&
Gerrit Renkerba4e58e2006-11-27 11:10:57 -080088 __udp_lib_checksum_complete(skb);
89}
90
91/**
92 * udp_csum_outgoing - compute UDPv4/v6 checksum over fragments
93 * @sk: socket we are writing to
94 * @skb: sk_buff containing the filled-in UDP header
95 * (checksum field must be zeroed out)
96 */
Al Viro868c86b2006-11-14 21:35:48 -080097static inline __wsum udp_csum_outgoing(struct sock *sk, struct sk_buff *skb)
Gerrit Renkerba4e58e2006-11-27 11:10:57 -080098{
Arnaldo Carvalho de Melo9c702202007-04-25 18:04:18 -070099 __wsum csum = csum_partial(skb_transport_header(skb),
100 sizeof(struct udphdr), 0);
Gerrit Renkerba4e58e2006-11-27 11:10:57 -0800101 skb_queue_walk(&sk->sk_write_queue, skb) {
102 csum = csum_add(csum, skb->csum);
103 }
104 return csum;
105}
106
107/* hash routines shared between UDPv4/6 and UDP-Litev4/6 */
108static inline void udp_lib_hash(struct sock *sk)
109{
110 BUG();
111}
112
113static inline void udp_lib_unhash(struct sock *sk)
114{
115 write_lock_bh(&udp_hash_lock);
116 if (sk_del_node_init(sk)) {
117 inet_sk(sk)->num = 0;
Pavel Emelyanovc29a0bc2008-03-31 19:41:46 -0700118 sock_prot_inuse_add(sock_net(sk), sk->sk_prot, -1);
Gerrit Renkerba4e58e2006-11-27 11:10:57 -0800119 }
120 write_unlock_bh(&udp_hash_lock);
121}
122
123static inline void udp_lib_close(struct sock *sk, long timeout)
124{
125 sk_common_release(sk);
126}
127
Pavel Emelyanov6ba5a3c2008-03-22 16:51:21 -0700128extern int udp_lib_get_port(struct sock *sk, unsigned short snum,
129 int (*)(const struct sock*,const struct sock*));
Gerrit Renkerba4e58e2006-11-27 11:10:57 -0800130
131/* net/ipv4/udp.c */
Gerrit Renker25030a72006-08-26 20:06:05 -0700132extern int udp_get_port(struct sock *sk, unsigned short snum,
David S. Millerdf2bc452007-06-05 15:18:43 -0700133 int (*saddr_cmp)(const struct sock *, const struct sock *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134extern void udp_err(struct sk_buff *, u32);
135
136extern int udp_sendmsg(struct kiocb *iocb, struct sock *sk,
137 struct msghdr *msg, size_t len);
138
139extern int udp_rcv(struct sk_buff *skb);
140extern int udp_ioctl(struct sock *sk, int cmd, unsigned long arg);
141extern int udp_disconnect(struct sock *sk, int flags);
142extern unsigned int udp_poll(struct file *file, struct socket *sock,
143 poll_table *wait);
Gerrit Renker4c0a6cb2006-11-27 09:29:59 -0800144extern int udp_lib_getsockopt(struct sock *sk, int level, int optname,
145 char __user *optval, int __user *optlen);
146extern int udp_lib_setsockopt(struct sock *sk, int level, int optname,
147 char __user *optval, int optlen,
148 int (*push_pending_frames)(struct sock *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149
150DECLARE_SNMP_STAT(struct udp_mib, udp_statistics);
Herbert Xu1781f7f2007-12-11 11:30:32 -0800151DECLARE_SNMP_STAT(struct udp_mib, udp_stats_in6);
152
153/* UDP-Lite does not have a standardized MIB yet, so we inherit from UDP */
154DECLARE_SNMP_STAT(struct udp_mib, udplite_statistics);
155DECLARE_SNMP_STAT(struct udp_mib, udplite_stats_in6);
156
Gerrit Renkerba4e58e2006-11-27 11:10:57 -0800157/*
158 * SNMP statistics for UDP and UDP-Lite
159 */
160#define UDP_INC_STATS_USER(field, is_udplite) do { \
161 if (is_udplite) SNMP_INC_STATS_USER(udplite_statistics, field); \
162 else SNMP_INC_STATS_USER(udp_statistics, field); } while(0)
163#define UDP_INC_STATS_BH(field, is_udplite) do { \
164 if (is_udplite) SNMP_INC_STATS_BH(udplite_statistics, field); \
165 else SNMP_INC_STATS_BH(udp_statistics, field); } while(0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166
Herbert Xu1781f7f2007-12-11 11:30:32 -0800167#define UDP6_INC_STATS_BH(field, is_udplite) do { \
168 if (is_udplite) SNMP_INC_STATS_BH(udplite_stats_in6, field); \
169 else SNMP_INC_STATS_BH(udp_stats_in6, field); } while(0)
170#define UDP6_INC_STATS_USER(field, is_udplite) do { \
171 if (is_udplite) SNMP_INC_STATS_USER(udplite_stats_in6, field); \
172 else SNMP_INC_STATS_USER(udp_stats_in6, field); } while(0)
173
174#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
175#define UDPX_INC_STATS_BH(sk, field) \
176 do { \
177 if ((sk)->sk_family == AF_INET) \
178 UDP_INC_STATS_BH(field, 0); \
179 else \
180 UDP6_INC_STATS_BH(field, 0); \
181 } while (0);
182#else
183#define UDPX_INC_STATS_BH(sk, field) UDP_INC_STATS_BH(field, 0)
184#endif
185
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186/* /proc */
187struct udp_seq_afinfo {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 char *name;
189 sa_family_t family;
Gerrit Renkerba4e58e2006-11-27 11:10:57 -0800190 struct hlist_head *hashtable;
Denis V. Lunev3ba94412008-03-28 18:25:32 -0700191 struct file_operations seq_fops;
Denis V. Lunevdda61922008-03-28 18:24:26 -0700192 struct seq_operations seq_ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193};
194
195struct udp_iter_state {
Denis V. Lunev6f191ef2008-03-28 18:23:33 -0700196 struct seq_net_private p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 sa_family_t family;
Gerrit Renkerba4e58e2006-11-27 11:10:57 -0800198 struct hlist_head *hashtable;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 int bucket;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200};
201
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -0300202#ifdef CONFIG_PROC_FS
Daniel Lezcano0c96d8c2008-03-21 04:14:17 -0700203extern int udp_proc_register(struct net *net, struct udp_seq_afinfo *afinfo);
204extern void udp_proc_unregister(struct net *net, struct udp_seq_afinfo *afinfo);
Arnaldo Carvalho de Melo20380732005-08-16 02:18:02 -0300205
206extern int udp4_proc_init(void);
207extern void udp4_proc_exit(void);
208#endif
Hideo Aoki95766ff2007-12-31 00:29:24 -0800209
210extern void udp_init(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211#endif /* _UDP_H */