rx: Remove obsolete comment
[openafs.git] / src / rx / LINUX / rx_knet.c
1 /*
2  * Copyright 2000, International Business Machines Corporation and others.
3  * All Rights Reserved.
4  * 
5  * This software has been released under the terms of the IBM Public
6  * License.  For details, see the LICENSE file in the top-level source
7  * directory or online at http://www.openafs.org/dl/license10.html
8  */
9
10 /*
11  * rx_knet.c - RX kernel send, receive and timer routines.
12  *
13  * Linux implementation.
14  */
15 #include <afsconfig.h>
16 #include "afs/param.h"
17
18
19 #include <linux/version.h>
20 #include "rx/rx_kcommon.h"
21 #include "rx.h"
22 #include "rx_atomic.h"
23 #include "rx_globals.h"
24 #include "rx_stats.h"
25 #include "rx_peer.h"
26 #include "rx_packet.h"
27 #include "rx_internal.h"
28 #include <asm/uaccess.h>
29 #ifdef AFS_RXERRQ_ENV
30 #include <linux/errqueue.h>
31 #include <linux/icmp.h>
32 #endif
33
34 #include "osi_compat.h"
35
36 /* rxk_NewSocket
37  * open and bind RX socket
38  */
39 osi_socket *
40 rxk_NewSocketHost(afs_uint32 ahost, short aport)
41 {
42     struct socket *sockp;
43     struct sockaddr_in myaddr;
44     int code;
45 #ifdef AFS_ADAPT_PMTU
46     int pmtu = IP_PMTUDISC_WANT;
47 #else
48     int pmtu = IP_PMTUDISC_DONT;
49 #endif
50
51 #ifdef LINUX_KERNEL_SOCK_CREATE_V
52     code = sock_create(AF_INET, SOCK_DGRAM, IPPROTO_UDP, &sockp, 0);
53 #else
54     code = sock_create(AF_INET, SOCK_DGRAM, IPPROTO_UDP, &sockp);
55 #endif
56     if (code < 0)
57         return NULL;
58
59     /* Bind socket */
60     myaddr.sin_family = AF_INET;
61     myaddr.sin_addr.s_addr = ahost;
62     myaddr.sin_port = aport;
63     code =
64         sockp->ops->bind(sockp, (struct sockaddr *)&myaddr, sizeof(myaddr));
65
66     if (code < 0) {
67         printk("sock_release(rx_socket) FIXME\n");
68         return NULL;
69     }
70
71     kernel_setsockopt(sockp, SOL_IP, IP_MTU_DISCOVER, (char *)&pmtu,
72                       sizeof(pmtu));
73 #ifdef AFS_RXERRQ_ENV
74     {
75         int recverr = 1;
76         kernel_setsockopt(sockp, SOL_IP, IP_RECVERR, (char *)&recverr,
77                           sizeof(recverr));
78     }
79 #endif
80     return (osi_socket *)sockp;
81 }
82
83 osi_socket *
84 rxk_NewSocket(short aport)
85 {
86     return rxk_NewSocketHost(htonl(INADDR_ANY), aport);
87 }
88
89 /* free socket allocated by osi_NetSocket */
90 int
91 rxk_FreeSocket(struct socket *asocket)
92 {
93     AFS_STATCNT(osi_FreeSocket);
94     return 0;
95 }
96
97 #ifdef AFS_RXERRQ_ENV
98 static int
99 osi_HandleSocketError(osi_socket so, char *cmsgbuf, size_t cmsgbuf_len)
100 {
101     struct msghdr msg;
102     struct cmsghdr *cmsg;
103     struct sock_extended_err *err;
104     struct sockaddr_in addr;
105     int code;
106     struct socket *sop = (struct socket *)so;
107
108     msg.msg_name = &addr;
109     msg.msg_namelen = sizeof(addr);
110     msg.msg_control = cmsgbuf;
111     msg.msg_controllen = cmsgbuf_len;
112     msg.msg_flags = 0;
113
114     code = kernel_recvmsg(sop, &msg, NULL, 0, 0,
115                           MSG_ERRQUEUE|MSG_DONTWAIT|MSG_TRUNC);
116
117     if (code < 0 || !(msg.msg_flags & MSG_ERRQUEUE))
118         return 0;
119
120     /* kernel_recvmsg changes msg_control to point at the _end_ of the buffer,
121      * and msg_controllen is set to the number of bytes remaining */
122     msg.msg_controllen = ((char*)msg.msg_control - (char*)cmsgbuf);
123     msg.msg_control = cmsgbuf;
124
125     for (cmsg = CMSG_FIRSTHDR(&msg); cmsg && CMSG_OK(&msg, cmsg);
126          cmsg = CMSG_NXTHDR(&msg, cmsg)) {
127
128         if (cmsg->cmsg_level != SOL_IP || cmsg->cmsg_type != IP_RECVERR) {
129             continue;
130         }
131
132         err = CMSG_DATA(cmsg);
133         rxi_ProcessNetError(err, addr.sin_addr.s_addr, addr.sin_port);
134     }
135
136     return 1;
137 }
138 #endif
139
140 static void
141 do_handlesocketerror(osi_socket so)
142 {
143 #ifdef AFS_RXERRQ_ENV
144     char *cmsgbuf;
145     size_t cmsgbuf_len;
146
147     cmsgbuf_len = 256;
148     cmsgbuf = rxi_Alloc(cmsgbuf_len);
149     if (!cmsgbuf) {
150         return;
151     }
152
153     while (osi_HandleSocketError(so, cmsgbuf, cmsgbuf_len))
154         ;
155
156     rxi_Free(cmsgbuf, cmsgbuf_len);
157 #endif
158 }
159
160 /* osi_NetSend
161  *
162  * Return codes:
163  * 0 = success
164  * non-zero = failure
165  */
166 int
167 osi_NetSend(osi_socket sop, struct sockaddr_in *to, struct iovec *iovec,
168             int iovcnt, afs_int32 size, int istack)
169 {
170     struct msghdr msg;
171     int code;
172
173
174     msg.msg_name = to;
175     msg.msg_namelen = sizeof(*to);
176     msg.msg_control = NULL;
177     msg.msg_controllen = 0;
178     msg.msg_flags = 0;
179
180     code = kernel_sendmsg(sop, &msg, (struct kvec *) iovec, iovcnt, size);
181
182     if (code < 0) {
183         do_handlesocketerror(sop);
184     }
185
186     return (code < 0) ? code : 0;
187 }
188
189
190 /* osi_NetReceive
191  * OS dependent part of kernel RX listener thread.
192  *
193  * Arguments:
194  *      so      socket to receive on, typically rx_socket
195  *      from    pointer to a sockaddr_in. 
196  *      iov     array of iovecs to fill in.
197  *      iovcnt  how many iovecs there are.
198  *      lengthp IN/OUT in: total space available in iovecs. out: size of read.
199  *
200  * Return
201  * 0 if successful
202  * error code (such as EINTER) if not
203  *
204  * Environment
205  *      Note that the maximum number of iovecs is 2 + RX_MAXWVECS. This is
206  *      so we have a little space to look for packets larger than 
207  *      rx_maxReceiveSize.
208  */
209 int rxk_lastSocketError;
210 int rxk_nSocketErrors;
211 int
212 osi_NetReceive(osi_socket so, struct sockaddr_in *from, struct iovec *iov,
213                int iovcnt, int *lengthp)
214 {
215     struct msghdr msg;
216     int code;
217     struct iovec tmpvec[RX_MAXWVECS + 2];
218     struct socket *sop = (struct socket *)so;
219
220     if (iovcnt > RX_MAXWVECS + 2) {
221         osi_Panic("Too many (%d) iovecs passed to osi_NetReceive\n", iovcnt);
222     }
223
224     memcpy(tmpvec, iov, iovcnt * sizeof(struct iovec));
225     msg.msg_name = from;
226     msg.msg_iov = tmpvec;
227     msg.msg_iovlen = iovcnt;
228     msg.msg_control = NULL;
229     msg.msg_controllen = 0;
230     msg.msg_flags = 0;
231
232     code = kernel_recvmsg(sop, &msg, (struct kvec *)tmpvec, iovcnt,
233                           *lengthp, 0);
234     if (code < 0) {
235         afs_try_to_freeze();
236
237         /* Clear the error before using the socket again.
238          * Oh joy, Linux has hidden header files as well. It appears we can
239          * simply call again and have it clear itself via sock_error().
240          */
241         flush_signals(current); /* We don't want no stinkin' signals. */
242         rxk_lastSocketError = code;
243         rxk_nSocketErrors++;
244
245         do_handlesocketerror(so);
246     } else {
247         *lengthp = code;
248         code = 0;
249     }
250
251     return code;
252 }
253
254 void
255 osi_StopListener(void)
256 {
257     extern struct task_struct *rxk_ListenerTask;
258
259     while (rxk_ListenerTask) {
260         if (rxk_ListenerTask) {
261             flush_signals(rxk_ListenerTask);
262             force_sig(SIGKILL, rxk_ListenerTask);
263         }
264         if (!rxk_ListenerTask)
265             break;
266         afs_osi_Sleep(&rxk_ListenerTask);
267     }
268     sock_release(rx_socket);
269     rx_socket = NULL;
270 }
271