Rename all the functions and structures for the old VOP namespace API
[dragonfly.git] / sys / vfs / portal / portal_vnops.c
1 /*
2  * Copyright (c) 1992, 1993
3  *      The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software donated to Berkeley by
6  * Jan-Simon Pendry.
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. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *      This product includes software developed by the University of
19  *      California, Berkeley and its contributors.
20  * 4. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  *      @(#)portal_vnops.c      8.14 (Berkeley) 5/21/95
37  *
38  * $FreeBSD: src/sys/miscfs/portal/portal_vnops.c,v 1.38 1999/12/21 06:29:00 chris Exp $
39  * $DragonFly: src/sys/vfs/portal/portal_vnops.c,v 1.23 2005/09/14 01:13:43 dillon Exp $
40  */
41
42 /*
43  * Portal Filesystem
44  */
45
46 #include <sys/param.h>
47 #include <sys/systm.h>
48 #include <sys/sysproto.h>
49 #include <sys/kernel.h>
50 #include <sys/time.h>
51 #include <sys/proc.h>
52 #include <sys/filedesc.h>
53 #include <sys/vnode.h>
54 #include <sys/fcntl.h>
55 #include <sys/file.h>
56 #include <sys/stat.h>
57 #include <sys/mount.h>
58 #include <sys/malloc.h>
59 #include <sys/namei.h>
60 #include <sys/mbuf.h>
61 #include <sys/resourcevar.h>
62 #include <sys/socket.h>
63 #include <sys/socketvar.h>
64 #include <sys/un.h>
65 #include <sys/unpcb.h>
66 #include "portal.h"
67
68 #include <sys/thread2.h>
69
70 static int portal_fileid = PORTAL_ROOTFILEID+1;
71
72 static int      portal_badop (void);
73 static void     portal_closefd (struct thread *td, int fd);
74 static int      portal_connect (struct socket *so, struct socket *so2);
75 static int      portal_getattr (struct vop_getattr_args *ap);
76 static int      portal_inactive (struct vop_inactive_args *ap);
77 static int      portal_lookup (struct vop_old_lookup_args *ap);
78 static int      portal_open (struct vop_open_args *ap);
79 static int      portal_print (struct vop_print_args *ap);
80 static int      portal_readdir (struct vop_readdir_args *ap);
81 static int      portal_reclaim (struct vop_reclaim_args *ap);
82 static int      portal_setattr (struct vop_setattr_args *ap);
83
84 static void
85 portal_closefd(struct thread *td, int fd)
86 {
87         int error;
88         struct close_args ua;
89
90         ua.fd = fd;
91         error = close(&ua);
92         /*
93          * We should never get an error, and there isn't anything
94          * we could do if we got one, so just print a message.
95          */
96         if (error)
97                 printf("portal_closefd: error = %d\n", error);
98 }
99
100 /*
101  * vp is the current namei directory
102  * cnp is the name to locate in that directory...
103  *
104  * portal_lookup(struct vnode *a_dvp, struct vnode **a_vpp,
105  *               struct componentname *a_cnp)
106  */
107 static int
108 portal_lookup(struct vop_old_lookup_args *ap)
109 {
110         struct componentname *cnp = ap->a_cnp;
111         struct vnode **vpp = ap->a_vpp;
112         struct vnode *dvp = ap->a_dvp;
113         char *pname = cnp->cn_nameptr;
114         struct portalnode *pt;
115         int error;
116         struct vnode *fvp = 0;
117         char *path;
118         int size;
119
120         *vpp = NULLVP;
121
122         if (cnp->cn_nameiop == NAMEI_DELETE || cnp->cn_nameiop == NAMEI_RENAME)
123                 return (EROFS);
124
125         if (cnp->cn_namelen == 1 && *pname == '.') {
126                 *vpp = dvp;
127                 vref(dvp);
128                 /*VOP_LOCK(dvp);*/
129                 return (0);
130         }
131
132         /*
133          * Do the MALLOC before the getnewvnode since doing so afterward
134          * might cause a bogus v_data pointer to get dereferenced
135          * elsewhere if MALLOC should block.
136          */
137         MALLOC(pt, struct portalnode *, sizeof(struct portalnode),
138                 M_TEMP, M_WAITOK);
139
140         error = getnewvnode(VT_PORTAL, dvp->v_mount, &fvp, 0, 0);
141         if (error) {
142                 FREE(pt, M_TEMP);
143                 goto bad;
144         }
145         fvp->v_type = VREG;
146         fvp->v_data = pt;
147         /*
148          * Save all of the remaining pathname and
149          * advance the namei next pointer to the end
150          * of the string.
151          */
152         for (size = 0, path = pname; *path; path++)
153                 size++;
154         cnp->cn_consume = size - cnp->cn_namelen;
155
156         pt->pt_arg = malloc(size+1, M_TEMP, M_WAITOK);
157         pt->pt_size = size+1;
158         bcopy(pname, pt->pt_arg, pt->pt_size);
159         pt->pt_fileid = portal_fileid++;
160
161         *vpp = fvp;
162         vx_unlock(fvp);
163         /*VOP_LOCK(fvp);*/
164         return (0);
165
166 bad:;
167         if (fvp)
168                 vrele(fvp);
169         return (error);
170 }
171
172 static int
173 portal_connect(struct socket *so, struct socket *so2)
174 {
175         /* from unp_connect, bypassing the namei stuff... */
176         struct socket *so3;
177         struct unpcb *unp2;
178         struct unpcb *unp3;
179
180         if (so2 == 0)
181                 return (ECONNREFUSED);
182
183         if (so->so_type != so2->so_type)
184                 return (EPROTOTYPE);
185
186         if ((so2->so_options & SO_ACCEPTCONN) == 0)
187                 return (ECONNREFUSED);
188
189         if ((so3 = sonewconn(so2, 0)) == 0)
190                 return (ECONNREFUSED);
191
192         unp2 = so2->so_pcb;
193         unp3 = so3->so_pcb;
194         if (unp2->unp_addr)
195                 unp3->unp_addr = (struct sockaddr_un *)
196                         dup_sockaddr((struct sockaddr *)unp2->unp_addr);
197         so2 = so3;
198
199         return (unp_connect2(so, so2));
200 }
201
202 /*
203  * portal_open(struct vnode *a_vp, int a_mode, struct ucred *a_cred,
204  *              struct thread *a_td)
205  */
206 static int
207 portal_open(struct vop_open_args *ap)
208 {
209         struct socket *so = 0;
210         struct portalnode *pt;
211         struct thread *td = ap->a_td;
212         struct vnode *vp = ap->a_vp;
213         struct uio auio;
214         struct iovec aiov[2];
215         int res;
216         struct mbuf *cm = 0;
217         struct cmsghdr *cmsg;
218         int newfds;
219         int *ip;
220         int fd;
221         int error;
222         int len;
223         struct portalmount *fmp;
224         struct file *fp;
225         struct portal_cred pcred;
226
227         /*
228          * Nothing to do when opening the root node.
229          */
230         if (vp->v_flag & VROOT)
231                 return (0);
232
233         /*
234          * Can't be opened unless the caller is set up
235          * to deal with the side effects.  Check for this
236          * by testing whether the p_dupfd has been set.
237          */
238         KKASSERT(td->td_proc);
239         if (td->td_proc->p_dupfd >= 0)
240                 return (ENODEV);
241
242         pt = VTOPORTAL(vp);
243         fmp = VFSTOPORTAL(vp->v_mount);
244
245         /*
246          * Create a new socket.
247          */
248         error = socreate(AF_UNIX, &so, SOCK_STREAM, 0, ap->a_td);
249         if (error)
250                 goto bad;
251
252         /*
253          * Reserve some buffer space
254          */
255         res = pt->pt_size + sizeof(pcred) + 512;        /* XXX */
256         error = soreserve(so, res, res, &td->td_proc->p_rlimit[RLIMIT_SBSIZE]);
257         if (error)
258                 goto bad;
259
260         /*
261          * Kick off connection
262          */
263         error = portal_connect(so, (struct socket *)fmp->pm_server->f_data);
264         if (error)
265                 goto bad;
266
267         /*
268          * Wait for connection to complete
269          */
270         /*
271          * XXX: Since the mount point is holding a reference on the
272          * underlying server socket, it is not easy to find out whether
273          * the server process is still running.  To handle this problem
274          * we loop waiting for the new socket to be connected (something
275          * which will only happen if the server is still running) or for
276          * the reference count on the server socket to drop to 1, which
277          * will happen if the server dies.  Sleep for 5 second intervals
278          * and keep polling the reference count.   XXX.
279          */
280         crit_enter();
281         while ((so->so_state & SS_ISCONNECTING) && so->so_error == 0) {
282                 if (fmp->pm_server->f_count == 1) {
283                         error = ECONNREFUSED;
284                         crit_exit();
285                         goto bad;
286                 }
287                 (void) tsleep((caddr_t) &so->so_timeo, 0, "portalcon", 5 * hz);
288         }
289         crit_exit();
290
291         if (so->so_error) {
292                 error = so->so_error;
293                 goto bad;
294         }
295
296         /*
297          * Set miscellaneous flags
298          */
299         so->so_rcv.sb_timeo = 0;
300         so->so_snd.sb_timeo = 0;
301         so->so_rcv.sb_flags |= SB_NOINTR;
302         so->so_snd.sb_flags |= SB_NOINTR;
303
304
305         pcred.pcr_flag = ap->a_mode;
306         pcred.pcr_uid = ap->a_cred->cr_uid;
307         pcred.pcr_ngroups = ap->a_cred->cr_ngroups;
308         bcopy(ap->a_cred->cr_groups, pcred.pcr_groups, NGROUPS * sizeof(gid_t));
309         aiov[0].iov_base = (caddr_t) &pcred;
310         aiov[0].iov_len = sizeof(pcred);
311         aiov[1].iov_base = pt->pt_arg;
312         aiov[1].iov_len = pt->pt_size;
313         auio.uio_iov = aiov;
314         auio.uio_iovcnt = 2;
315         auio.uio_rw = UIO_WRITE;
316         auio.uio_segflg = UIO_SYSSPACE;
317         auio.uio_td = td;
318         auio.uio_offset = 0;
319         auio.uio_resid = aiov[0].iov_len + aiov[1].iov_len;
320
321         error = sosend(so, (struct sockaddr *) 0, &auio,
322                         (struct mbuf *) 0, (struct mbuf *) 0, 0, td);
323         if (error)
324                 goto bad;
325
326         len = auio.uio_resid = sizeof(int);
327         do {
328                 struct mbuf *m = 0;
329                 int flags = MSG_WAITALL;
330                 error = soreceive(so, (struct sockaddr **) 0, &auio,
331                                         &m, &cm, &flags);
332                 if (error)
333                         goto bad;
334
335                 /*
336                  * Grab an error code from the mbuf.
337                  */
338                 if (m) {
339                         m = m_pullup(m, sizeof(int));   /* Needed? */
340                         if (m) {
341                                 error = *(mtod(m, int *));
342                                 m_freem(m);
343                         } else {
344                                 error = EINVAL;
345                         }
346                 } else {
347                         if (cm == 0) {
348                                 error = ECONNRESET;      /* XXX */
349 #ifdef notdef
350                                 break;
351 #endif
352                         }
353                 }
354         } while (cm == 0 && auio.uio_resid == len && !error);
355
356         if (cm == 0)
357                 goto bad;
358
359         if (auio.uio_resid) {
360                 error = 0;
361 #ifdef notdef
362                 error = EMSGSIZE;
363                 goto bad;
364 #endif
365         }
366
367         /*
368          * XXX: Break apart the control message, and retrieve the
369          * received file descriptor.  Note that more than one descriptor
370          * may have been received, or that the rights chain may have more
371          * than a single mbuf in it.  What to do?
372          */
373         cmsg = mtod(cm, struct cmsghdr *);
374         newfds = (cmsg->cmsg_len - sizeof(*cmsg)) / sizeof (int);
375         if (newfds == 0) {
376                 error = ECONNREFUSED;
377                 goto bad;
378         }
379         /*
380          * At this point the rights message consists of a control message
381          * header, followed by a data region containing a vector of
382          * integer file descriptors.  The fds were allocated by the action
383          * of receiving the control message.
384          */
385         ip = (int *) (cmsg + 1);
386         fd = *ip++;
387         if (newfds > 1) {
388                 /*
389                  * Close extra fds.
390                  */
391                 int i;
392                 printf("portal_open: %d extra fds\n", newfds - 1);
393                 for (i = 1; i < newfds; i++) {
394                         portal_closefd(td, *ip);
395                         ip++;
396                 }
397         }
398
399         /*
400          * Check that the mode the file is being opened for is a subset
401          * of the mode of the existing descriptor.
402          */
403         KKASSERT(td->td_proc);
404         fp = td->td_proc->p_fd->fd_files[fd].fp;
405         if (((ap->a_mode & (FREAD|FWRITE)) | fp->f_flag) != fp->f_flag) {
406                 portal_closefd(td, fd);
407                 error = EACCES;
408                 goto bad;
409         }
410
411         /*
412          * Save the dup fd in the proc structure then return the
413          * special error code (ENXIO) which causes magic things to
414          * happen in vn_open.  The whole concept is, well, hmmm.
415          */
416         td->td_proc->p_dupfd = fd;
417         error = ENXIO;
418
419 bad:;
420         /*
421          * And discard the control message.
422          */
423         if (cm) {
424                 m_freem(cm);
425         }
426
427         if (so) {
428                 soshutdown(so, 2);
429                 soclose(so);
430         }
431         return (error);
432 }
433
434 /*
435  * portal_getattr(struct vnode *a_vp, struct vattr *a_vap,
436  *                struct ucred *a_cred, struct thread *a_td)
437  */
438 static int
439 portal_getattr(struct vop_getattr_args *ap)
440 {
441         struct vnode *vp = ap->a_vp;
442         struct vattr *vap = ap->a_vap;
443
444         bzero(vap, sizeof(*vap));
445         vattr_null(vap);
446         vap->va_uid = 0;
447         vap->va_gid = 0;
448         vap->va_size = DEV_BSIZE;
449         vap->va_blocksize = DEV_BSIZE;
450         nanotime(&vap->va_atime);
451         vap->va_mtime = vap->va_atime;
452         vap->va_ctime = vap->va_mtime;
453         vap->va_gen = 0;
454         vap->va_flags = 0;
455         vap->va_rdev = 0;
456         /* vap->va_qbytes = 0; */
457         vap->va_bytes = 0;
458         /* vap->va_qsize = 0; */
459         if (vp->v_flag & VROOT) {
460                 vap->va_type = VDIR;
461                 vap->va_mode = S_IRUSR|S_IWUSR|S_IXUSR|
462                                 S_IRGRP|S_IWGRP|S_IXGRP|
463                                 S_IROTH|S_IWOTH|S_IXOTH;
464                 vap->va_nlink = 2;
465                 vap->va_fileid = 2;
466         } else {
467                 vap->va_type = VREG;
468                 vap->va_mode = S_IRUSR|S_IWUSR|
469                                 S_IRGRP|S_IWGRP|
470                                 S_IROTH|S_IWOTH;
471                 vap->va_nlink = 1;
472                 vap->va_fileid = VTOPORTAL(vp)->pt_fileid;
473         }
474         return (0);
475 }
476
477 /*
478  * portal_setattr(struct vnode *a_vp, struct vattr *a_vap,
479  *                struct ucred *a_cred, struct thread *a_td)
480  */
481 static int
482 portal_setattr(struct vop_setattr_args *ap)
483 {
484         /*
485          * Can't mess with the root vnode
486          */
487         if (ap->a_vp->v_flag & VROOT)
488                 return (EACCES);
489
490         if (ap->a_vap->va_flags != VNOVAL)
491                 return (EOPNOTSUPP);
492
493         return (0);
494 }
495
496 /*
497  * Fake readdir, just return empty directory.
498  * It is hard to deal with '.' and '..' so don't bother.
499  *
500  * portal_readdir(struct vnode *a_vp, struct uio *a_uio,
501  *                struct ucred *a_cred, int *a_eofflag,
502  *                u_long *a_cookies, int a_ncookies)
503  */
504 static int
505 portal_readdir(struct vop_readdir_args *ap)
506 {
507         /*
508          * We don't allow exporting portal mounts, and currently local
509          * requests do not need cookies.
510          */
511         if (ap->a_ncookies)
512                 panic("portal_readdir: not hungry");
513
514         return (0);
515 }
516
517 /*
518  * portal_inactive(struct vnode *a_vp, struct thread *a_td)
519  */
520 static int
521 portal_inactive(struct vop_inactive_args *ap)
522 {
523         return (0);
524 }
525
526 /*
527  * portal_reclaim(struct vnode *a_vp)
528  */
529 static int
530 portal_reclaim(struct vop_reclaim_args *ap)
531 {
532         struct portalnode *pt = VTOPORTAL(ap->a_vp);
533
534         if (pt->pt_arg) {
535                 free((caddr_t) pt->pt_arg, M_TEMP);
536                 pt->pt_arg = 0;
537         }
538         FREE(ap->a_vp->v_data, M_TEMP);
539         ap->a_vp->v_data = 0;
540
541         return (0);
542 }
543
544
545 /*
546  * Print out the contents of a Portal vnode.
547  *
548  * portal_print(struct vnode *a_vp)
549  */
550 /* ARGSUSED */
551 static int
552 portal_print(struct vop_print_args *ap)
553 {
554         printf("tag VT_PORTAL, portal vnode\n");
555         return (0);
556 }
557
558
559 /*
560  * Portal "should never get here" operation
561  */
562 static int
563 portal_badop(void)
564 {
565
566         panic("portal: bad op");
567         /* NOTREACHED */
568 }
569
570 struct vnodeopv_entry_desc portal_vnodeop_entries[] = {
571         { &vop_default_desc,            vop_defaultop },
572         { &vop_access_desc,             vop_null },
573         { &vop_bmap_desc,               (vnodeopv_entry_t) portal_badop },
574         { &vop_getattr_desc,            (vnodeopv_entry_t) portal_getattr },
575         { &vop_inactive_desc,           (vnodeopv_entry_t) portal_inactive },
576         { &vop_old_lookup_desc,         (vnodeopv_entry_t) portal_lookup },
577         { &vop_open_desc,               (vnodeopv_entry_t) portal_open },
578         { &vop_pathconf_desc,           (vnodeopv_entry_t) vop_stdpathconf },
579         { &vop_print_desc,              (vnodeopv_entry_t) portal_print },
580         { &vop_readdir_desc,            (vnodeopv_entry_t) portal_readdir },
581         { &vop_reclaim_desc,            (vnodeopv_entry_t) portal_reclaim },
582         { &vop_setattr_desc,            (vnodeopv_entry_t) portal_setattr },
583         { NULL, NULL }
584 };
585