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