darwin module prototype and cleanup
[openafs.git] / src / afs / OBSD / osi_vfsops.c
1 /*
2  * OpenBSD specific assistance routines & VFS ops
3  * Original NetBSD version for Transarc afs by John Kohl <jtk@MIT.EDU>
4  * OpenBSD version by Jim Rees <rees@umich.edu>
5  *
6  * $Id$
7  */
8
9 /*
10 copyright 2002
11 the regents of the university of michigan
12 all rights reserved
13
14 permission is granted to use, copy, create derivative works 
15 and redistribute this software and such derivative works 
16 for any purpose, so long as the name of the university of 
17 michigan is not used in any advertising or publicity 
18 pertaining to the use or distribution of this software 
19 without specific, written prior authorization.  if the 
20 above copyright notice or any other identification of the 
21 university of michigan is included in any copy of any 
22 portion of this software, then the disclaimer below must 
23 also be included.
24
25 this software is provided as is, without representation 
26 from the university of michigan as to its fitness for any 
27 purpose, and without warranty by the university of 
28 michigan of any kind, either express or implied, including 
29 without limitation the implied warranties of 
30 merchantability and fitness for a particular purpose. the 
31 regents of the university of michigan shall not be liable 
32 for any damages, including special, indirect, incidental, or 
33 consequential damages, with respect to any claim arising 
34 out of or in connection with the use of the software, even 
35 if it has been or is hereafter advised of the possibility of 
36 such damages.
37 */
38
39 /*
40 Copyright 1995 Massachusetts Institute of Technology.  All Rights
41 Reserved.
42
43 You are hereby granted a worldwide, irrevocable, paid-up, right and
44 license to use, execute, display, modify, copy and distribute MIT's
45 Modifications, provided that (i) you abide by the terms and conditions
46 of the OpenAFS License Agreement, and (ii) you do not use the name
47 of MIT in any advertising or publicity without the prior written consent
48 of MIT.  MIT disclaims all liability for your use of MIT's
49 Modifications.  MIT's Modifications are provided "AS IS" WITHOUT
50 WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO,
51 ANY WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR
52 NONINFRINGEMENT.
53 */
54
55 /*
56  * Some code cribbed from ffs_vfsops and other NetBSD sources, which
57  * are marked:
58  */
59 /*
60  * Copyright (c) 1989, 1991, 1993, 1994
61  *      The Regents of the University of California.  All rights reserved.
62  *
63  * Redistribution and use in source and binary forms, with or without
64  * modification, are permitted provided that the following conditions
65  * are met:
66  * 1. Redistributions of source code must retain the above copyright
67  *    notice, this list of conditions and the following disclaimer.
68  * 2. Redistributions in binary form must reproduce the above copyright
69  *    notice, this list of conditions and the following disclaimer in the
70  *    documentation and/or other materials provided with the distribution.
71  * 3. All advertising materials mentioning features or use of this software
72  *    must display the following acknowledgement:
73  *      This product includes software developed by the University of
74  *      California, Berkeley and its contributors.
75  * 4. Neither the name of the University nor the names of its contributors
76  *    may be used to endorse or promote products derived from this software
77  *    without specific prior written permission.
78  *
79  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
80  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
81  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
82  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
83  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
84  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
85  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
86  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
87  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
88  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
89  * SUCH DAMAGE.
90  *
91  */
92
93 #include <afsconfig.h>
94 #include "afs/param.h"
95
96
97 #include "afs/sysincludes.h"    /* Standard vendor system headers */
98 #include "afs/afsincludes.h"    /* Afs-based standard headers */
99 #include "afs/afs_stats.h"      /* statistics */
100
101 #include <sys/conf.h>
102 #include <sys/exec.h>
103 #include <sys/lkm.h>
104 #include <sys/namei.h>
105 #include <sys/syscall.h>
106 #include <sys/syscallargs.h>
107
108 /* from /usr/src/sys/kern/vfs_subr.c */
109 extern void insmntque(struct vnode *, struct mount *);
110
111 extern int sys_lkmnosys(), afs_xioctl(), Afs_xsetgroups();
112
113 static int lkmid = -1;
114 static int afs_badcall(struct proc *p, void *xx, register_t * yy);
115 static struct sysent old_sysent;
116
117 struct osi_vfs *afs_globalVFS;
118 struct vcache *afs_globalVp;
119
120 int afs_quotactl();
121 int afs_fhtovp();
122 int afs_vptofh();
123 int afsinit();
124 int afs_start();
125 int afs_mount();
126 int afs_unmount();
127 int afs_root();
128 int afs_statfs();
129 int afs_sync();
130 int afs_vget();
131 int afs_sysctl();
132 int afs_checkexp();
133
134 struct vfsops afs_vfsops = {
135     afs_mount,
136     afs_start,
137     afs_unmount,
138     afs_root,
139     afs_quotactl,
140     afs_statfs,
141     afs_sync,
142     afs_vget,
143     afs_fhtovp,
144     afs_vptofh,
145     afsinit,
146     afs_sysctl,
147     afs_checkexp,
148 };
149
150 int
151 afs_nbsd_lookupname(char *fnamep, enum uio_seg segflg, int followlink,
152                     struct vnode **compvpp)
153 {
154     struct nameidata nd;
155     int niflag;
156     int error;
157
158     /*
159      * Lookup pathname "fnamep", returning leaf in *compvpp.  segflg says
160      * whether the pathname is user or system space.
161      */
162     /* XXX LOCKLEAF ? */
163     niflag = followlink ? FOLLOW : NOFOLLOW;
164     NDINIT(&nd, LOOKUP, niflag, segflg, fnamep, osi_curproc());
165     if ((error = namei(&nd)))
166         return error;
167     *compvpp = nd.ni_vp;
168     return error;
169 }
170
171 int
172 afs_quotactl()
173 {
174     return EOPNOTSUPP;
175 }
176
177 int
178 afs_sysctl()
179 {
180     return EOPNOTSUPP;
181 }
182
183 int
184 afs_checkexp()
185 {
186     return EOPNOTSUPP;
187 }
188
189 int
190 afs_fhtovp(mp, fhp, vpp)
191      struct mount *mp;
192      struct fid *fhp;
193      struct vnode **vpp;
194 {
195
196     return (EINVAL);
197 }
198
199 int
200 afs_vptofh(vp, fhp)
201      struct vnode *vp;
202      struct fid *fhp;
203 {
204
205     return (EINVAL);
206 }
207
208 int
209 afs_start(mp, flags, p)
210      struct mount *mp;
211      int flags;
212      struct proc *p;
213 {
214     return (0);                 /* nothing to do. ? */
215 }
216
217 int
218 afs_mount(mp, path, data, ndp, p)
219      register struct mount *mp;
220      char *path;
221      caddr_t data;
222      struct nameidata *ndp;
223      struct proc *p;
224 {
225     /* ndp contains the mounted-from device.  Just ignore it.
226      * we also don't care about our proc struct. */
227     int size;
228
229     if (mp->mnt_flag & MNT_UPDATE)
230         return EINVAL;
231
232     if (afs_globalVFS) {
233         /* Don't allow remounts */
234         return EBUSY;
235     }
236
237     AFS_STATCNT(afs_mount);
238     AFS_GLOCK();
239
240 #ifdef AFS_DISCON_ENV
241     /* initialize the vcache entries before we start using them */
242
243     /* XXX find a better place for this if possible  */
244     init_vcache_entries();
245 #endif
246     afs_globalVFS = mp;
247     mp->osi_vfs_bsize = 8192;
248     mp->osi_vfs_fsid.val[0] = AFS_VFSMAGIC;     /* magic */
249     mp->osi_vfs_fsid.val[1] = (int)AFS_VFSFSID;
250
251     (void)copyinstr(path, mp->mnt_stat.f_mntonname, MNAMELEN - 1, &size);
252     bzero(mp->mnt_stat.f_mntonname + size, MNAMELEN - size);
253     bzero(mp->mnt_stat.f_mntfromname, MNAMELEN);
254     strcpy(mp->mnt_stat.f_mntfromname, "AFS");
255     /* null terminated string "AFS" will fit, just leave it be. */
256     strcpy(mp->mnt_stat.f_fstypename, MOUNT_AFS);
257     AFS_GUNLOCK();
258     (void)afs_statfs(mp, &mp->mnt_stat);
259
260     return 0;
261 }
262
263 int
264 afs_unmount(afsp, flags, p)
265      struct mount *afsp;
266      int flags;
267      struct proc *p;
268 {
269     extern int sys_ioctl(), sys_setgroups();
270
271     AFS_STATCNT(afs_unmount);
272 #ifdef AFS_DISCON_ENV
273     give_up_cbs();
274 #endif
275     if (afs_globalVFS == NULL) {
276         printf("afs already unmounted\n");
277         return 0;
278     }
279     if (afs_globalVp)
280         vrele(AFSTOV(afs_globalVp));
281     afs_globalVp = NULL;
282
283     vflush(afsp, NULLVP, 0);    /* don't support forced */
284     afsp->mnt_data = NULL;
285     AFS_GLOCK();
286     afs_globalVFS = 0;
287     afs_cold_shutdown = 1;
288     afs_shutdown();             /* XXX */
289     AFS_GUNLOCK();
290
291     /* give up syscall entries for ioctl & setgroups, which we've stolen */
292     sysent[SYS_ioctl].sy_call = sys_ioctl;
293     sysent[SYS_setgroups].sy_call = sys_setgroups;
294
295     /* give up the stolen syscall entry */
296     sysent[AFS_SYSCALL].sy_narg = 0;
297     sysent[AFS_SYSCALL].sy_argsize = 0;
298     sysent[AFS_SYSCALL].sy_call = afs_badcall;
299     printf
300         ("AFS unmounted--use `/sbin/modunload -i %d' to unload before restarting AFS\n",
301          lkmid);
302     return 0;
303 }
304
305 static int
306 afs_badcall(struct proc *p, void *xx, register_t * yy)
307 {
308     return ENOSYS;
309 }
310
311 void
312 afs_nbsd_getnewvnode(struct vcache *tvc)
313 {
314     while (getnewvnode(VT_AFS, afs_globalVFS, afs_vnodeop_p, &tvc->v)) {
315         /* no vnodes available, force an alloc (limits be damned)! */
316         desiredvnodes++;
317     }
318     tvc->v->v_data = (void *)tvc;
319 }
320
321 int
322 afs_root(struct mount *mp, struct vnode **vpp)
323 {
324     struct vrequest treq;
325     struct vcache *tvp;
326     int code;
327
328     AFS_STATCNT(afs_root);
329
330     AFS_GLOCK();
331     if (!(code = afs_InitReq(&treq, osi_curcred()))
332         && !(code = afs_CheckInit())) {
333         tvp = afs_GetVCache(&afs_rootFid, &treq, NULL, NULL);
334         if (tvp) {
335             /* There is really no reason to over-hold this bugger--it's held
336              * by the root filesystem reference. */
337             if (afs_globalVp != tvp) {
338 #ifdef AFS_DONT_OVERHOLD_GLOBALVP
339                 if (afs_globalVp)
340                     AFS_RELE(AFSTOV(afs_globalVp));
341 #endif
342                 afs_globalVp = tvp;
343                 VREF(AFSTOV(afs_globalVp));
344             }
345             AFSTOV(tvp)->v_flag |= VROOT;
346             afs_globalVFS = mp;
347             *vpp = AFSTOV(tvp);
348         } else
349             code = ENOENT;
350     }
351     AFS_GUNLOCK();
352
353     if (!code)
354         vn_lock(*vpp, LK_EXCLUSIVE | LK_RETRY, curproc);        /* return it locked */
355     return code;
356 }
357
358 int
359 afs_statfs(struct osi_vfs *afsp, struct statfs *abp)
360 {
361     AFS_STATCNT(afs_statfs);
362     abp->f_bsize = afsp->osi_vfs_bsize;
363
364     /*
365      * Fake a high number below to satisfy programs that use the ustat (for
366      * * AIX), or statfs (for the rest) call to make sure that there's
367      * enough * space in the device partition before storing something there
368      * (like * ed(1))
369      */
370     abp->f_blocks = abp->f_bfree = abp->f_bavail = abp->f_files =
371         abp->f_ffree = 9000000;
372     abp->f_fsid.val[0] = AFS_VFSMAGIC;  /* magic */
373     abp->f_fsid.val[1] = (int)AFS_VFSFSID;
374     return 0;
375 }
376
377 int
378 afs_sync(struct osi_vfs *afsp)
379 {
380     AFS_STATCNT(afs_sync);
381 #if defined(AFS_DISCON_ENV) && !defined(AFS_OBSD_ENV)
382     /* Can't do this in OpenBSD 2.7, it faults when called from apm_suspend() */
383     store_dirty_vcaches();
384 #endif
385     return 0;
386 }
387
388 int
389 afs_vget(vp, lfl)
390      struct vnode *vp;
391      int lfl;
392 {
393     int error;
394
395     if (vp->v_usecount < 0) {
396         vprint("bad usecount", vp);
397         panic("afs_vget");
398     }
399     error = vget(vp, lfl, curproc);
400     if (!error && vp->v_usecount == 1) {
401         /* vget() took it off the freelist; put it on our mount queue */
402         insmntque(vp, afs_globalVFS);
403     }
404     return error;
405 }
406
407 extern struct vfsops afs_vfsops;
408 extern struct vnodeopv_desc afs_vnodeop_opv_desc;
409
410 static struct vfsconf afs_vfsconf = {
411     &afs_vfsops,
412     "afs",
413     0,
414     0,
415     0,
416     NULL,
417     NULL,
418 };
419
420 MOD_VFS("afs", 0, &afs_vfsconf);
421
422 static char afsgenmem[] = "afsgenmem";
423 static char afsfidmem[] = "afsfidmem";
424 static char afsbhdrmem[] = "afsbhdrmem";
425 static char afsbfrmem[] = "afsbfrmem";
426
427 int
428 afsinit()
429 {
430     old_sysent = sysent[AFS_SYSCALL];
431
432     sysent[AFS_SYSCALL].sy_call = afs3_syscall;
433     sysent[AFS_SYSCALL].sy_narg = 6;
434     sysent[AFS_SYSCALL].sy_argsize = 6 * sizeof(long);
435     sysent[SYS_ioctl].sy_call = afs_xioctl;
436     sysent[SYS_setgroups].sy_call = Afs_xsetgroups;
437     osi_Init();
438
439     return 0;
440 }
441
442 int
443 afs_vfs_load(struct lkm_table *lkmtp, int cmd)
444 {
445     extern char *memname[];
446
447     vfs_opv_init_explicit(&afs_vnodeop_opv_desc);
448     vfs_opv_init_default(&afs_vnodeop_opv_desc);
449     if (memname[M_AFSGENERIC] == NULL)
450         memname[M_AFSGENERIC] = afsgenmem;
451     if (memname[M_AFSFID] == NULL)
452         memname[M_AFSFID] = afsfidmem;
453     if (memname[M_AFSBUFHDR] == NULL)
454         memname[M_AFSBUFHDR] = afsbhdrmem;
455     if (memname[M_AFSBUFFER] == NULL)
456         memname[M_AFSBUFFER] = afsbfrmem;
457     lkmid = lkmtp->id;
458     printf("OpenAFS ($Revision$) lkm loaded\n");
459     return 0;
460 }
461
462 int
463 afs_vfs_unload(struct lkm_table *lktmp, int cmd)
464 {
465     extern char *memname[];
466
467     if (afs_globalVp)
468         return EBUSY;
469     if (sysent[SYS_ioctl].sy_call != sys_ioctl)
470         return EBUSY;
471
472     if (memname[M_AFSGENERIC] == afsgenmem)
473         memname[M_AFSGENERIC] = NULL;
474     if (memname[M_AFSFID] == afsfidmem)
475         memname[M_AFSFID] = NULL;
476     if (memname[M_AFSBUFHDR] == afsbhdrmem)
477         memname[M_AFSBUFHDR] = NULL;
478     if (memname[M_AFSBUFFER] == afsbfrmem)
479         memname[M_AFSBUFFER] = NULL;
480
481     sysent[AFS_SYSCALL] = old_sysent;
482     printf("OpenAFS unloaded\n");
483     return 0;
484 }
485
486 int
487 libafs_lkmentry(struct lkm_table *lkmtp, int cmd, int ver)
488 {
489     if (cmd == LKM_E_LOAD) {
490         if (sysent[AFS_SYSCALL].sy_call == afs3_syscall
491             || sysent[AFS_SYSCALL].sy_call == afs_badcall) {
492             printf("AFS already loaded\n");
493             return EINVAL;
494         }
495     }
496     DISPATCH(lkmtp, cmd, ver, afs_vfs_load, afs_vfs_unload, lkm_nofunc);
497 }