Introduce access methods for making protocol requests.
[dragonfly.git] / sys / netproto / smb / smb_trantcp.c
1 /*
2  * Copyright (c) 2000-2001 Boris Popov
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *    This product includes software developed by Boris Popov.
16  * 4. Neither the name of the author nor the names of any co-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 AUTHOR 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 AUTHOR 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  * $FreeBSD: src/sys/netsmb/smb_trantcp.c,v 1.3.2.1 2001/05/22 08:32:34 bp Exp $
33  * $DragonFly: src/sys/netproto/smb/smb_trantcp.c,v 1.8 2004/03/04 10:29:24 hsu Exp $
34  */
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 #include <sys/kernel.h>
38 #include <sys/malloc.h>
39 #include <sys/mbuf.h>
40 #include <sys/proc.h>
41 #include <sys/protosw.h>
42 #include <sys/socket.h>
43 #include <sys/socketvar.h>
44 #include <sys/socketops.h>
45 #include <sys/poll.h>
46 #include <sys/uio.h>
47 #include <sys/sysctl.h>
48
49 #include <net/if.h>
50 #include <net/route.h>
51
52 #include <netinet/in.h>
53 #include <netinet/tcp.h>
54
55 #include <sys/mchain.h>
56
57 #include "netbios.h"
58
59 #include "smb.h"
60 #include "smb_conn.h"
61 #include "smb_tran.h"
62 #include "smb_trantcp.h"
63 #include "smb_subr.h"
64
65 #define M_NBDATA        M_PCB
66
67 static int smb_tcpsndbuf = 10 * 1024;
68 static int smb_tcprcvbuf = 10 * 1024;
69
70 SYSCTL_DECL(_net_smb);
71 SYSCTL_INT(_net_smb, OID_AUTO, tcpsndbuf, CTLFLAG_RW, &smb_tcpsndbuf, 0, "");
72 SYSCTL_INT(_net_smb, OID_AUTO, tcprcvbuf, CTLFLAG_RW, &smb_tcprcvbuf, 0, "");
73
74 #define nb_sosend(so,m,flags,p)                                 \
75     so_pru_sosend(so, NULL, NULL, m, NULL, flags, td)
76
77 static int  nbssn_recv(struct nbpcb *nbp, struct mbuf **mpp, int *lenp,
78         u_int8_t *rpcodep, struct thread *td);
79 static int  smb_nbst_disconnect(struct smb_vc *vcp, struct thread *td);
80
81 static int
82 nb_setsockopt_int(struct socket *so, int level, int name, int val)
83 {
84         struct sockopt sopt;
85
86         bzero(&sopt, sizeof(sopt));
87         sopt.sopt_level = level;
88         sopt.sopt_name = name;
89         sopt.sopt_val = &val;
90         sopt.sopt_valsize = sizeof(val);
91         return sosetopt(so, &sopt);
92 }
93
94 static __inline int
95 nb_poll(struct nbpcb *nbp, int events, struct thread *td)
96 {
97         return so_pru_sopoll(nbp->nbp_tso, events, NULL, td);
98 }
99
100 static int
101 nbssn_rselect(struct nbpcb *nbp, struct timeval *tv, int events, struct thread *td)
102 {
103         struct proc *p = td->td_proc;
104         struct timeval atv, rtv, ttv;
105         int s, timo, error;
106
107         if (tv) {
108                 atv = *tv;
109                 if (itimerfix(&atv)) {
110                         error = EINVAL;
111                         goto done;
112                 }
113                 getmicrouptime(&rtv);
114                 timevaladd(&atv, &rtv);
115         }
116         timo = 0;
117         KKASSERT(p);
118 retry:
119         p->p_flag |= P_SELECT;
120         error = nb_poll(nbp, events, td);
121         if (error) {
122                 error = 0;
123                 goto done;
124         }
125         if (tv) {
126                 getmicrouptime(&rtv);
127                 if (timevalcmp(&rtv, &atv, >=))
128                         goto done;
129                 ttv = atv;
130                 timevalsub(&ttv, &rtv);
131                 timo = tvtohz_high(&ttv);
132         }
133         s = splhigh();
134         if ((p->p_flag & P_SELECT) == 0) {
135                 splx(s);
136                 goto retry;
137         }
138         p->p_flag &= ~P_SELECT;
139         error = tsleep((caddr_t)&selwait, 0, "nbsel", timo);
140         splx(s);
141 done:
142         p->p_flag &= ~P_SELECT;
143         if (error == ERESTART)
144                 return 0;
145         return error;
146 }
147
148 static int
149 nb_intr(struct nbpcb *nbp, struct thread *td)
150 {
151         return 0;
152 }
153
154 static void
155 nb_upcall(struct socket *so, void *arg, int waitflag)
156 {
157         struct nbpcb *nbp = arg;
158
159         if (arg == NULL || nbp->nbp_selectid == NULL)
160                 return;
161         wakeup(nbp->nbp_selectid);
162 }
163
164 static int
165 nb_sethdr(struct mbuf *m, u_int8_t type, u_int32_t len)
166 {
167         u_int32_t *p = mtod(m, u_int32_t *);
168
169         *p = htonl((len & 0x1FFFF) | (type << 24));
170         return 0;
171 }
172
173 static int
174 nb_put_name(struct mbchain *mbp, struct sockaddr_nb *snb)
175 {
176         int error;
177         u_char seglen, *cp;
178
179         cp = snb->snb_name;
180         if (*cp == 0)
181                 return EINVAL;
182         NBDEBUG("[%s]\n", cp);
183         for (;;) {
184                 seglen = (*cp) + 1;
185                 error = mb_put_mem(mbp, cp, seglen, MB_MSYSTEM);
186                 if (error)
187                         return error;
188                 if (seglen == 1)
189                         break;
190                 cp += seglen;
191         }
192         return 0;
193 }
194
195 static int
196 nb_connect_in(struct nbpcb *nbp, struct sockaddr_in *to, struct thread *td)
197 {
198         struct socket *so;
199         int error, s;
200
201         error = socreate(AF_INET, &so, SOCK_STREAM, IPPROTO_TCP, td);
202         if (error)
203                 return error;
204         nbp->nbp_tso = so;
205         so->so_upcallarg = (caddr_t)nbp;
206         so->so_upcall = nb_upcall;
207         so->so_rcv.sb_flags |= SB_UPCALL;
208         so->so_rcv.sb_timeo = (5 * hz);
209         so->so_snd.sb_timeo = (5 * hz);
210         error = soreserve(so, nbp->nbp_sndbuf, nbp->nbp_rcvbuf);
211         if (error)
212                 goto bad;
213         nb_setsockopt_int(so, SOL_SOCKET, SO_KEEPALIVE, 1);
214         nb_setsockopt_int(so, IPPROTO_TCP, TCP_NODELAY, 1);
215         so->so_rcv.sb_flags &= ~SB_NOINTR;
216         so->so_snd.sb_flags &= ~SB_NOINTR;
217         error = soconnect(so, (struct sockaddr*)to, td);
218         if (error)
219                 goto bad;
220         s = splnet();
221         while ((so->so_state & SS_ISCONNECTING) && so->so_error == 0) {
222                 tsleep(&so->so_timeo, 0, "nbcon", 2 * hz);
223                 if ((so->so_state & SS_ISCONNECTING) && so->so_error == 0 &&
224                         (error = nb_intr(nbp, td)) != 0) {
225                         so->so_state &= ~SS_ISCONNECTING;
226                         splx(s);
227                         goto bad;
228                 }
229         }
230         if (so->so_error) {
231                 error = so->so_error;
232                 so->so_error = 0;
233                 splx(s);
234                 goto bad;
235         }
236         splx(s);
237         return 0;
238 bad:
239         smb_nbst_disconnect(nbp->nbp_vc, td);
240         return error;
241 }
242
243 static int
244 nbssn_rq_request(struct nbpcb *nbp, struct thread *td)
245 {
246         struct mbchain mb, *mbp = &mb;
247         struct mdchain md, *mdp = &md;
248         struct mbuf *m0;
249         struct timeval tv;
250         struct sockaddr_in sin;
251         u_short port;
252         u_int8_t rpcode;
253         int error, rplen;
254
255         error = mb_init(mbp);
256         if (error)
257                 return error;
258         mb_put_uint32le(mbp, 0);
259         nb_put_name(mbp, nbp->nbp_paddr);
260         nb_put_name(mbp, nbp->nbp_laddr);
261         nb_sethdr(mbp->mb_top, NB_SSN_REQUEST, mb_fixhdr(mbp) - 4);
262         error = nb_sosend(nbp->nbp_tso, mbp->mb_top, 0, td);
263         if (!error) {
264                 nbp->nbp_state = NBST_RQSENT;
265         }
266         mb_detach(mbp);
267         mb_done(mbp);
268         if (error)
269                 return error;
270         TIMESPEC_TO_TIMEVAL(&tv, &nbp->nbp_timo);
271         error = nbssn_rselect(nbp, &tv, POLLIN, td);
272         if (error == EWOULDBLOCK) {     /* Timeout */
273                 NBDEBUG("initial request timeout\n");
274                 return ETIMEDOUT;
275         }
276         if (error)                      /* restart or interrupt */
277                 return error;
278         error = nbssn_recv(nbp, &m0, &rplen, &rpcode, td);
279         if (error) {
280                 NBDEBUG("recv() error %d\n", error);
281                 return error;
282         }
283         /*
284          * Process NETBIOS reply
285          */
286         if (m0)
287                 md_initm(mdp, m0);
288         error = 0;
289         do {
290                 if (rpcode == NB_SSN_POSRESP) {
291                         nbp->nbp_state = NBST_SESSION;
292                         nbp->nbp_flags |= NBF_CONNECTED;
293                         break;
294                 }
295                 if (rpcode != NB_SSN_RTGRESP) {
296                         error = ECONNABORTED;
297                         break;
298                 }
299                 if (rplen != 6) {
300                         error = ECONNABORTED;
301                         break;
302                 }
303                 md_get_mem(mdp, (caddr_t)&sin.sin_addr, 4, MB_MSYSTEM);
304                 md_get_uint16(mdp, &port);
305                 sin.sin_port = port;
306                 nbp->nbp_state = NBST_RETARGET;
307                 smb_nbst_disconnect(nbp->nbp_vc, td);
308                 error = nb_connect_in(nbp, &sin, td);
309                 if (!error)
310                         error = nbssn_rq_request(nbp, td);
311                 if (error) {
312                         smb_nbst_disconnect(nbp->nbp_vc, td);
313                         break;
314                 }
315         } while(0);
316         if (m0)
317                 md_done(mdp);
318         return error;
319 }
320
321 static int
322 nbssn_recvhdr(struct nbpcb *nbp, int *lenp,
323         u_int8_t *rpcodep, int flags, struct thread *td)
324 {
325         struct socket *so = nbp->nbp_tso;
326         struct uio auio;
327         struct iovec aio;
328         u_int32_t len;
329         int error;
330
331         aio.iov_base = (caddr_t)&len;
332         aio.iov_len = sizeof(len);
333         auio.uio_iov = &aio;
334         auio.uio_iovcnt = 1;
335         auio.uio_segflg = UIO_SYSSPACE;
336         auio.uio_rw = UIO_READ;
337         auio.uio_offset = 0;
338         auio.uio_resid = sizeof(len);
339         auio.uio_td = td;
340         error = so_pru_soreceive(so, NULL, &auio, NULL, NULL, &flags);
341         if (error)
342                 return error;
343         if (auio.uio_resid > 0) {
344                 SMBSDEBUG("short reply\n");
345                 return EPIPE;
346         }
347         len = ntohl(len);
348         *rpcodep = (len >> 24) & 0xFF;
349         len &= 0x1ffff;
350         if (len > SMB_MAXPKTLEN) {
351                 SMBERROR("packet too long (%d)\n", len);
352                 return EFBIG;
353         }
354         *lenp = len;
355         return 0;
356 }
357
358 static int
359 nbssn_recv(struct nbpcb *nbp, struct mbuf **mpp, int *lenp,
360         u_int8_t *rpcodep, struct thread *td)
361 {
362         struct socket *so = nbp->nbp_tso;
363         struct uio auio;
364         struct mbuf *m;
365         u_int8_t rpcode;
366         int len;
367         int error, rcvflg;
368
369         if (so == NULL)
370                 return ENOTCONN;
371
372         if (mpp)
373                 *mpp = NULL;
374         for(;;) {
375                 m = NULL;
376                 error = nbssn_recvhdr(nbp, &len, &rpcode, MSG_DONTWAIT, td);
377                 if (so->so_state &
378                     (SS_ISDISCONNECTING | SS_ISDISCONNECTED | SS_CANTRCVMORE)) {
379                         nbp->nbp_state = NBST_CLOSED;
380                         NBDEBUG("session closed by peer\n");
381                         return ECONNRESET;
382                 }
383                 if (error)
384                         return error;
385                 if (len == 0 && nbp->nbp_state != NBST_SESSION)
386                         break;
387                 if (rpcode == NB_SSN_KEEPALIVE)
388                         continue;
389                 bzero(&auio, sizeof(auio));
390                 auio.uio_resid = len;
391                 auio.uio_td = td;
392                 do {
393                         rcvflg = MSG_WAITALL;
394                         error = so_pru_soreceive(so, NULL, &auio, &m, NULL,
395                             &rcvflg);
396                 } while (error == EWOULDBLOCK || error == EINTR ||
397                                  error == ERESTART);
398                 if (error)
399                         break;
400                 if (auio.uio_resid > 0) {
401                         SMBERROR("packet is shorter than expected\n");
402                         error = EPIPE;
403                         break;
404                 }
405                 if (nbp->nbp_state == NBST_SESSION &&
406                     rpcode == NB_SSN_MESSAGE)
407                         break;
408                 NBDEBUG("non-session packet %x\n", rpcode);
409                 if (m)
410                         m_freem(m);
411         }
412         if (error) {
413                 if (m)
414                         m_freem(m);
415                 return error;
416         }
417         if (mpp)
418                 *mpp = m;
419         else
420                 m_freem(m);
421         *lenp = len;
422         *rpcodep = rpcode;
423         return 0;
424 }
425
426 /*
427  * SMB transport interface
428  */
429 static int
430 smb_nbst_create(struct smb_vc *vcp, struct thread *td)
431 {
432         struct nbpcb *nbp;
433
434         MALLOC(nbp, struct nbpcb *, sizeof *nbp, M_NBDATA, M_WAITOK);
435         bzero(nbp, sizeof *nbp);
436         nbp->nbp_timo.tv_sec = 15;      /* XXX: sysctl ? */
437         nbp->nbp_state = NBST_CLOSED;
438         nbp->nbp_vc = vcp;
439         nbp->nbp_sndbuf = smb_tcpsndbuf;
440         nbp->nbp_rcvbuf = smb_tcprcvbuf;
441         vcp->vc_tdata = nbp;
442         return 0;
443 }
444
445 static int
446 smb_nbst_done(struct smb_vc *vcp, struct thread *td)
447 {
448         struct nbpcb *nbp = vcp->vc_tdata;
449
450         if (nbp == NULL)
451                 return ENOTCONN;
452         smb_nbst_disconnect(vcp, td);
453         if (nbp->nbp_laddr)
454                 free(nbp->nbp_laddr, M_SONAME);
455         if (nbp->nbp_paddr)
456                 free(nbp->nbp_paddr, M_SONAME);
457         free(nbp, M_NBDATA);
458         return 0;
459 }
460
461 static int
462 smb_nbst_bind(struct smb_vc *vcp, struct sockaddr *sap, struct thread *td)
463 {
464         struct nbpcb *nbp = vcp->vc_tdata;
465         struct sockaddr_nb *snb;
466         int error, slen;
467
468         NBDEBUG("\n");
469         error = EINVAL;
470         do {
471                 if (nbp->nbp_flags & NBF_LOCADDR)
472                         break;
473                 /*
474                  * It is possible to create NETBIOS name in the kernel,
475                  * but nothing prevents us to do it in the user space.
476                  */
477                 if (sap == NULL)
478                         break;
479                 slen = sap->sa_len;
480                 if (slen < NB_MINSALEN)
481                         break;
482                 snb = (struct sockaddr_nb*)dup_sockaddr(sap, 1);
483                 if (snb == NULL) {
484                         error = ENOMEM;
485                         break;
486                 }
487                 nbp->nbp_laddr = snb;
488                 nbp->nbp_flags |= NBF_LOCADDR;
489                 error = 0;
490         } while(0);
491         return error;
492 }
493
494 static int
495 smb_nbst_connect(struct smb_vc *vcp, struct sockaddr *sap, struct thread *td)
496 {
497         struct nbpcb *nbp = vcp->vc_tdata;
498         struct sockaddr_in sin;
499         struct sockaddr_nb *snb;
500         struct timespec ts1, ts2;
501         int error, slen;
502
503         NBDEBUG("\n");
504         if (nbp->nbp_tso != NULL)
505                 return EISCONN;
506         if (nbp->nbp_laddr == NULL)
507                 return EINVAL;
508         slen = sap->sa_len;
509         if (slen < NB_MINSALEN)
510                 return EINVAL;
511         if (nbp->nbp_paddr) {
512                 free(nbp->nbp_paddr, M_SONAME);
513                 nbp->nbp_paddr = NULL;
514         }
515         snb = (struct sockaddr_nb*)dup_sockaddr(sap, 1);
516         if (snb == NULL)
517                 return ENOMEM;
518         nbp->nbp_paddr = snb;
519         sin = snb->snb_addrin;
520         getnanotime(&ts1);
521         error = nb_connect_in(nbp, &sin, td);
522         if (error)
523                 return error;
524         getnanotime(&ts2);
525         timespecsub(&ts2, &ts1);
526         if (ts2.tv_sec == 0 && ts2.tv_sec == 0)
527                 ts2.tv_sec = 1;
528         nbp->nbp_timo = ts2;
529         timespecadd(&nbp->nbp_timo, &ts2);
530         timespecadd(&nbp->nbp_timo, &ts2);
531         timespecadd(&nbp->nbp_timo, &ts2);      /*  * 4 */
532         error = nbssn_rq_request(nbp, td);
533         if (error)
534                 smb_nbst_disconnect(vcp, td);
535         return error;
536 }
537
538 static int
539 smb_nbst_disconnect(struct smb_vc *vcp, struct thread *td)
540 {
541         struct nbpcb *nbp = vcp->vc_tdata;
542         struct socket *so;
543
544         if (nbp == NULL || nbp->nbp_tso == NULL)
545                 return ENOTCONN;
546         if ((so = nbp->nbp_tso) != NULL) {
547                 nbp->nbp_flags &= ~NBF_CONNECTED;
548                 nbp->nbp_tso = (struct socket *)NULL;
549                 soshutdown(so, 2);
550                 soclose(so);
551         }
552         if (nbp->nbp_state != NBST_RETARGET) {
553                 nbp->nbp_state = NBST_CLOSED;
554         }
555         return 0;
556 }
557
558 static int
559 smb_nbst_send(struct smb_vc *vcp, struct mbuf *m0, struct thread *td)
560 {
561         struct nbpcb *nbp = vcp->vc_tdata;
562         int error;
563
564         if (nbp->nbp_state != NBST_SESSION) {
565                 error = ENOTCONN;
566                 goto abort;
567         }
568         M_PREPEND(m0, 4, M_TRYWAIT);
569         if (m0 == NULL)
570                 return ENOBUFS;
571         nb_sethdr(m0, NB_SSN_MESSAGE, m_fixhdr(m0) - 4);
572         error = nb_sosend(nbp->nbp_tso, m0, 0, td);
573         return error;
574 abort:
575         if (m0)
576                 m_freem(m0);
577         return error;
578 }
579
580
581 static int
582 smb_nbst_recv(struct smb_vc *vcp, struct mbuf **mpp, struct thread *td)
583 {
584         struct nbpcb *nbp = vcp->vc_tdata;
585         u_int8_t rpcode;
586         int error, rplen;
587
588         nbp->nbp_flags |= NBF_RECVLOCK;
589         error = nbssn_recv(nbp, mpp, &rplen, &rpcode, td);
590         nbp->nbp_flags &= ~NBF_RECVLOCK;
591         return error;
592 }
593
594 static void
595 smb_nbst_timo(struct smb_vc *vcp)
596 {
597         return;
598 }
599
600 static void
601 smb_nbst_intr(struct smb_vc *vcp)
602 {
603         struct nbpcb *nbp = vcp->vc_tdata;
604
605         if (nbp == NULL || nbp->nbp_tso == NULL)
606                 return;
607         sorwakeup(nbp->nbp_tso);
608         sowwakeup(nbp->nbp_tso);
609 }
610
611 static int
612 smb_nbst_getparam(struct smb_vc *vcp, int param, void *data)
613 {
614         struct nbpcb *nbp = vcp->vc_tdata;
615
616         switch (param) {
617             case SMBTP_SNDSZ:
618                 *(int*)data = nbp->nbp_sndbuf;
619                 break;
620             case SMBTP_RCVSZ:
621                 *(int*)data = nbp->nbp_rcvbuf;
622                 break;
623             case SMBTP_TIMEOUT:
624                 *(struct timespec*)data = nbp->nbp_timo;
625                 break;
626             default:
627                 return EINVAL;
628         }
629         return 0;
630 }
631
632 static int
633 smb_nbst_setparam(struct smb_vc *vcp, int param, void *data)
634 {
635         struct nbpcb *nbp = vcp->vc_tdata;
636
637         switch (param) {
638             case SMBTP_SELECTID:
639                 nbp->nbp_selectid = data;
640                 break;
641             default:
642                 return EINVAL;
643         }
644         return 0;
645 }
646
647 /*
648  * Check for fatal errors
649  */
650 static int
651 smb_nbst_fatal(struct smb_vc *vcp, int error)
652 {
653         switch (error) {
654             case ENOTCONN:
655             case ENETRESET:
656             case ECONNABORTED:
657                 return 1;
658         }
659         return 0;
660 }
661
662
663 struct smb_tran_desc smb_tran_nbtcp_desc = {
664         SMBT_NBTCP,
665         smb_nbst_create, smb_nbst_done,
666         smb_nbst_bind, smb_nbst_connect, smb_nbst_disconnect,
667         smb_nbst_send, smb_nbst_recv,
668         smb_nbst_timo, smb_nbst_intr,
669         smb_nbst_getparam, smb_nbst_setparam,
670         smb_nbst_fatal
671 };
672