ca2553b22b21ef341eed7b6db95f21f75631d0f1
[openafs.git] / src / afs / SOLARIS / osi_vfsops.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  * osi_vfsops.c for SOLARIS
12  */
13 #include <afsconfig.h>
14 #include "afs/param.h"
15
16
17 #include "afs/sysincludes.h"    /* Standard vendor system headers */
18 #include "afsincludes.h"        /* Afs-based standard headers */
19 #include "afs/afs_stats.h"      /* statistics stuff */
20 #include "h/modctl.h"
21 #include "h/syscall.h"
22 #if defined(AFS_SUN511_ENV)
23 #include <sys/vfs_opreg.h>
24 #endif
25 #include <sys/kobj.h>
26
27 #include <sys/mount.h>
28
29 struct vfs *afs_globalVFS = 0;
30 struct vcache *afs_globalVp = 0;
31
32 #if defined(AFS_SUN5_64BIT_ENV)
33 extern struct sysent sysent32[];
34 #endif
35
36 int afsfstype = 0;
37
38 int
39 afs_mount(struct vfs *afsp, struct vnode *amvp, struct mounta *uap,
40           afs_ucred_t *credp)
41 {
42
43     AFS_GLOCK();
44
45     AFS_STATCNT(afs_mount);
46
47 #if defined(AFS_SUN510_ENV)
48     if (secpolicy_fs_mount(credp, amvp, afsp) != 0) {
49 #else
50     if (!afs_osi_suser(credp)) {
51 #endif
52         AFS_GUNLOCK();
53         return (EPERM);
54     }
55     afsp->vfs_fstype = afsfstype;
56
57     if (afs_globalVFS) {        /* Don't allow remounts. */
58         AFS_GUNLOCK();
59         return (EBUSY);
60     }
61
62     afs_globalVFS = afsp;
63     afsp->vfs_bsize = 8192;
64     afsp->vfs_fsid.val[0] = AFS_VFSMAGIC;       /* magic */
65     afsp->vfs_fsid.val[1] = AFS_VFSFSID;
66     afsp->vfs_dev = AFS_VFSMAGIC;
67
68     AFS_GUNLOCK();
69     return 0;
70 }
71
72 static void
73 afs_freevfs(void)
74 {
75     int i;
76     struct vcache *vc, *nvc;
77     extern struct vcache *afs_vhashT[VCSIZE];
78
79     afs_globalVFS = 0;
80
81     afs_shutdown();
82 }
83
84 int
85 afs_unmount(struct vfs *afsp, int flag, afs_ucred_t *credp)
86 {
87     struct vcache *rootvp = NULL;
88
89     AFS_GLOCK();
90     AFS_STATCNT(afs_unmount);
91
92 #if defined(AFS_SUN510_ENV)
93     if (secpolicy_fs_unmount(credp, afsp) != 0) {
94 #else
95     if (!afs_osi_suser(credp)) {
96 #endif
97         AFS_GUNLOCK();
98         return (EPERM);
99     }
100
101     if (flag & MS_FORCE) {
102         AFS_GUNLOCK();
103         return ENOTSUP;
104     }
105
106     /* We should have one reference from the caller, and one reference for the
107      * root vnode; any more and someone is still referencing something */
108     if (afsp->vfs_count > 2) {
109         AFS_GUNLOCK();
110         return EBUSY;
111     }
112
113     /* The root vnode should have one ref for the mount; any more, and someone
114      * else is using the root vnode */
115     if (afs_globalVp && VREFCOUNT_GT(afs_globalVp, 1)) {
116         AFS_GUNLOCK();
117         return EBUSY;
118     }
119
120     afsp->vfs_flag |= VFS_UNMOUNTED;
121
122     if (afs_globalVp) {
123         /* release the root vnode, which should be the last reference to us
124          * besides the caller of afs_unmount */
125         rootvp = afs_globalVp;
126         afs_globalVp = NULL;
127         AFS_RELE(rootvp);
128     }
129
130     AFS_GUNLOCK();
131     return 0;
132 }
133
134 void
135 gafs_freevfs(struct vfs *afsp)
136 {
137     AFS_GLOCK();
138
139     afs_freevfs();
140
141     AFS_GUNLOCK();
142 }
143
144 int
145 afs_root(struct vfs *afsp, struct vnode **avpp)
146 {
147     afs_int32 code = 0;
148     struct vrequest treq;
149     struct vcache *tvp = 0;
150     struct vcache *gvp;
151     struct proc *proc = ttoproc(curthread);
152     struct vnode *vp = afsp->vfs_vnodecovered;
153     int locked = 0;
154
155     /* Potential deadlock:
156      * afs_root is called with the Vnode's v_lock locked. Set VVFSLOCK
157      * and drop the v_lock if we need to make an RPC to complete this
158      * request. There used to be a deadlock on the global lock until
159      * we stopped calling iget while holding the global lock.
160      */
161
162     AFS_GLOCK();
163
164     AFS_STATCNT(afs_root);
165
166 again:
167     if (afs_globalVp && (afs_globalVp->f.states & CStatd)) {
168         tvp = afs_globalVp;
169     } else {
170         if (MUTEX_HELD(&vp->v_lock)) {
171             vp->v_flag |= VVFSLOCK;
172             locked = 1;
173             mutex_exit(&vp->v_lock);
174         }
175
176         if (afs_globalVp) {
177             gvp = afs_globalVp;
178             afs_globalVp = NULL;
179             afs_PutVCache(gvp);
180         }
181
182         if (!(code = afs_InitReq(&treq, proc->p_cred))
183             && !(code = afs_CheckInit())) {
184             tvp = afs_GetVCache(&afs_rootFid, &treq, NULL, NULL);
185             /* we really want this to stay around */
186             if (tvp) {
187                 if (afs_globalVp) {
188                     /* someone else got there before us! */
189                     afs_PutVCache(tvp);
190                     tvp = 0;
191                     goto again;
192                 }
193                 afs_globalVp = tvp;
194             } else
195                 code = ENOENT;
196         }
197     }
198     if (tvp) {
199         AFS_FAST_HOLD(tvp);
200         mutex_enter(&AFSTOV(tvp)->v_lock);
201         AFSTOV(tvp)->v_flag |= VROOT;
202         mutex_exit(&AFSTOV(tvp)->v_lock);
203
204         afs_globalVFS = afsp;
205         *avpp = AFSTOV(tvp);
206     }
207
208     afs_Trace2(afs_iclSetp, CM_TRACE_VFSROOT, ICL_TYPE_POINTER, *avpp,
209                ICL_TYPE_INT32, code);
210
211     AFS_GUNLOCK();
212     if (locked) {
213         mutex_enter(&vp->v_lock);
214         vp->v_flag &= ~VVFSLOCK;
215         if (vp->v_flag & VVFSWAIT) {
216             vp->v_flag &= ~VVFSWAIT;
217             cv_broadcast(&vp->v_cv);
218         }
219     }
220
221     return code;
222 }
223
224 int
225 afs_statvfs(struct vfs *afsp, struct statvfs64 *abp)
226 {
227     AFS_GLOCK();
228
229     AFS_STATCNT(afs_statfs);
230
231     abp->f_frsize = 1024;
232     abp->f_bsize = afsp->vfs_bsize;
233     abp->f_blocks = abp->f_bfree = abp->f_bavail = abp->f_files =
234         abp->f_favail = abp->f_ffree = AFS_VFS_FAKEFREE;
235     abp->f_fsid = (AFS_VFSMAGIC << 16) || AFS_VFSFSID;
236
237     AFS_GUNLOCK();
238     return 0;
239 }
240
241 int
242 afs_sync(struct vfs *afsp, short flags, afs_ucred_t *credp)
243 {
244     return 0;
245 }
246
247 int
248 afs_vget(struct vfs *afsp, struct vnode **avcp, struct fid *fidp)
249 {
250     cred_t *credp = CRED();
251     struct vrequest treq;
252     int code;
253
254     AFS_GLOCK();
255
256     AFS_STATCNT(afs_vget);
257
258     *avcp = NULL;
259     if (!(code = afs_InitReq(&treq, credp))) {
260         code = afs_osi_vget((struct vcache **)avcp, fidp, &treq);
261     }
262
263     afs_Trace3(afs_iclSetp, CM_TRACE_VGET, ICL_TYPE_POINTER, *avcp,
264                ICL_TYPE_INT32, treq.uid, ICL_TYPE_FID, fidp);
265     code = afs_CheckCode(code, &treq, 42);
266
267     AFS_GUNLOCK();
268     return code;
269 }
270
271 /* This is only called by vfs_mount when afs is going to be mounted as root.
272  * Since we don't support diskless clients we shouldn't come here.
273  */
274 int afsmountroot = 0;
275 afs_mountroot(struct vfs *afsp, whymountroot_t why)
276 {
277     AFS_GLOCK();
278     AFS_STATCNT(afs_mountroot);
279     afsmountroot++;
280     AFS_GUNLOCK();
281     return EINVAL;
282 }
283
284 /* afs_swapvp is called to setup swapping over the net for diskless clients.
285  * Again not for us.
286  */
287 int afsswapvp = 0;
288 afs_swapvp(struct vfs *afsp, struct vnode **avpp, char *nm)
289 {
290     AFS_GLOCK();
291     AFS_STATCNT(afs_swapvp);
292     afsswapvp++;
293     AFS_GUNLOCK();
294     return EINVAL;
295 }
296
297
298 #if defined(AFS_SUN511_ENV)
299 /* The following list must always be NULL-terminated */
300 static const fs_operation_def_t afs_vfsops_template[] = {
301     VFSNAME_MOUNT,              { .vfs_mount = afs_mount },
302     VFSNAME_UNMOUNT,            { .vfs_unmount = afs_unmount },
303     VFSNAME_ROOT,               { .vfs_root = afs_root },
304     VFSNAME_STATVFS,            { .vfs_statvfs = afs_statvfs },
305     VFSNAME_SYNC,               { .vfs_sync = afs_sync },
306     VFSNAME_VGET,               { .vfs_vget = afs_vget },
307     VFSNAME_MOUNTROOT,          { .vfs_mountroot = afs_mountroot },
308     VFSNAME_FREEVFS,            { .vfs_freevfs = gafs_freevfs },
309     NULL,                       NULL
310 };
311 struct vfsops *afs_vfsopsp;
312 #elif defined(AFS_SUN510_ENV)
313 /* The following list must always be NULL-terminated */
314 const fs_operation_def_t afs_vfsops_template[] = {
315     VFSNAME_MOUNT,              afs_mount,
316     VFSNAME_UNMOUNT,            afs_unmount,
317     VFSNAME_ROOT,               afs_root,
318     VFSNAME_STATVFS,            afs_statvfs,
319     VFSNAME_SYNC,               afs_sync,
320     VFSNAME_VGET,               afs_vget,
321     VFSNAME_MOUNTROOT,          afs_mountroot,
322     VFSNAME_FREEVFS,            gafs_freevfs,
323     NULL,                       NULL
324 };
325 struct vfsops *afs_vfsopsp;
326 #else
327 struct vfsops Afs_vfsops = {
328     afs_mount,
329     afs_unmount,
330     afs_root,
331     afs_statvfs,
332     afs_sync,
333     afs_vget,
334     afs_mountroot,
335     afs_swapvp,
336     gafs_freevfs,
337 };
338 #endif
339
340
341 /*
342  * afsinit - intialize VFS
343  */
344 int (*ufs_iallocp) ();
345 void (*ufs_iupdatp) ();
346 int (*ufs_igetp) ();
347 void (*ufs_itimes_nolockp) ();
348
349 int (*afs_orig_ioctl) (), (*afs_orig_ioctl32) ();
350 int (*afs_orig_setgroups) (), (*afs_orig_setgroups32) ();
351
352 #ifndef AFS_SUN510_ENV
353 struct ill_s *ill_g_headp = 0;
354 #endif
355
356 int afs_sinited = 0;
357
358 extern struct fs_operation_def afs_vnodeops_template[];
359
360 #if     !defined(AFS_NONFSTRANS)
361 int (*nfs_rfsdisptab_v2) ();
362 int (*nfs_rfsdisptab_v3) ();
363 int (*nfs_acldisptab_v2) ();
364 int (*nfs_acldisptab_v3) ();
365
366 int (*nfs_checkauth) ();
367 #endif
368
369 extern Afs_syscall();
370
371 static void *
372 do_mod_lookup(const char * mod, const char * sym)
373 {
374     void * ptr;
375
376     ptr = modlookup(mod, sym);
377     if (ptr == NULL) {
378         afs_warn("modlookup failed for symbol '%s' in module '%s'\n",
379                  sym, mod);
380     }
381
382     return ptr;
383 }
384
385 #ifdef AFS_SUN510_ENV
386 afsinit(int fstype, char *dummy)
387 #else
388 afsinit(struct vfssw *vfsswp, int fstype)
389 #endif
390 {
391     extern int afs_xioctl();
392     extern int afs_xsetgroups();
393
394     AFS_STATCNT(afsinit);
395
396     afs_orig_setgroups = sysent[SYS_setgroups].sy_callc;
397     afs_orig_ioctl = sysent[SYS_ioctl].sy_call;
398     sysent[SYS_setgroups].sy_callc = afs_xsetgroups;
399     sysent[SYS_ioctl].sy_call = afs_xioctl;
400
401 #if defined(AFS_SUN5_64BIT_ENV)
402     afs_orig_setgroups32 = sysent32[SYS_setgroups].sy_callc;
403     afs_orig_ioctl32 = sysent32[SYS_ioctl].sy_call;
404     sysent32[SYS_setgroups].sy_callc = afs_xsetgroups;
405     sysent32[SYS_ioctl].sy_call = afs_xioctl;
406 #endif /* AFS_SUN5_64BIT_ENV */
407
408 #ifdef AFS_SUN510_ENV
409     vfs_setfsops(fstype, afs_vfsops_template, &afs_vfsopsp);
410     afsfstype = fstype;
411     vn_make_ops("afs", afs_vnodeops_template, &afs_ops);
412 #else /* !AFS_SUN510_ENV */
413     vfsswp->vsw_vfsops = &Afs_vfsops;
414     afsfstype = fstype;
415 #endif /* !AFS_SUN510_ENV */
416
417
418 #if !defined(AFS_NONFSTRANS)
419     nfs_rfsdisptab_v2 = (int (*)()) do_mod_lookup("nfssrv", "rfsdisptab_v2");
420     if (nfs_rfsdisptab_v2 != NULL) {
421         nfs_acldisptab_v2 = (int (*)()) do_mod_lookup("nfssrv", "acldisptab_v2");
422         if (nfs_acldisptab_v2 != NULL) {
423             afs_xlatorinit_v2(nfs_rfsdisptab_v2, nfs_acldisptab_v2);
424         }
425     }
426     nfs_rfsdisptab_v3 = (int (*)()) do_mod_lookup("nfssrv", "rfsdisptab_v3");
427     if (nfs_rfsdisptab_v3 != NULL) {
428         nfs_acldisptab_v3 = (int (*)()) do_mod_lookup("nfssrv", "acldisptab_v3");
429         if (nfs_acldisptab_v3 != NULL) {
430             afs_xlatorinit_v3(nfs_rfsdisptab_v3, nfs_acldisptab_v3);
431         }
432     }
433
434     nfs_checkauth = (int (*)()) do_mod_lookup("nfssrv", "checkauth");
435 #endif /* !AFS_NONFSTRANS */
436
437     ufs_iallocp = (int (*)()) do_mod_lookup("ufs", "ufs_ialloc");
438     ufs_iupdatp = (void (*)()) do_mod_lookup("ufs", "ufs_iupdat");
439     ufs_igetp = (int (*)()) do_mod_lookup("ufs", "ufs_iget");
440     ufs_itimes_nolockp = (void (*)()) do_mod_lookup("ufs", "ufs_itimes_nolock");
441
442     if (!ufs_iallocp || !ufs_iupdatp || !ufs_itimes_nolockp || !ufs_igetp) {
443         afs_warn("AFS to UFS mapping cannot be fully initialised\n");
444     }
445
446 #if !defined(AFS_SUN510_ENV)
447     ill_g_headp = (struct ill_s *) do_mod_lookup("ip", "ill_g_head");
448 #endif /* !AFS_SUN510_ENV */
449
450     afs_sinited = 1;
451     return 0;
452
453 }
454
455 #ifdef AFS_SUN510_ENV
456 #ifdef AFS_SUN511_ENV
457 static vfsdef_t afs_vfsdef = {
458     VFSDEF_VERSION,
459     "afs",
460     afsinit,
461     VSW_STATS,
462     NULL
463 };
464 #else
465 static struct vfsdef_v3 afs_vfsdef = {
466     VFSDEF_VERSION,
467     "afs",
468     afsinit,
469     VSW_STATS
470 };
471 #endif
472 #else
473 static struct vfssw afs_vfw = {
474     "afs",
475     afsinit,
476     &Afs_vfsops,
477     0
478 };
479 #endif
480
481 #ifndef AFS_SUN511_ENV
482 static struct sysent afssysent = {
483     6,
484     0,
485     Afs_syscall
486 };
487 #endif /* AFS_SUN511_ENV */
488
489 /* inter-module dependencies */
490 char _depends_on[] = 
491 #if AFS_SUN510_ENV
492         "drv/ip drv/udp strmod/rpcmod fs/ufs";
493 #else
494         "drv/ip drv/udp strmod/rpcmod";
495 #endif
496
497 /*
498  * Info/Structs to link the afs module into the kernel
499  */
500 extern struct mod_ops mod_fsops;
501
502 static struct modlfs afsmodlfs = {
503     &mod_fsops,
504     "afs filesystem",
505 #ifdef AFS_SUN510_ENV
506     &afs_vfsdef
507 #else
508     &afs_vfw
509 #endif
510 };
511
512 #ifdef AFS_SUN511_ENV
513
514 extern struct modldrv afs_modldrv;
515
516 #else /* AFS_SUN511_ENV */
517
518 extern struct mod_ops mod_syscallops;
519 static struct modlsys afsmodlsys = {
520     &mod_syscallops,
521     "afs syscall interface",
522     &afssysent
523 };
524
525 /** The two structures afssysent32 and afsmodlsys32 are being added
526   * for supporting 32 bit syscalls. In Solaris 7 there are two system
527   * tables viz. sysent ans sysent32. 32 bit applications use sysent32.
528   * Since most of our user space binaries are going to be 32 bit
529   * we need to attach to sysent32 also. Note that the entry into AFS
530   * land still happens through Afs_syscall irrespective of whether we
531   * land here from sysent or sysent32
532   */
533
534 # if defined(AFS_SUN5_64BIT_ENV)
535 extern struct mod_ops mod_syscallops32;
536
537 static struct modlsys afsmodlsys32 = {
538     &mod_syscallops32,
539     "afs syscall interface(32 bit)",
540     &afssysent
541 };
542 # endif
543 #endif /* !AFS_SUN511_ENV */
544
545
546 static struct modlinkage afs_modlinkage = {
547     MODREV_1,
548     (void *)&afsmodlfs,
549 #ifdef AFS_SUN511_ENV
550     (void *)&afs_modldrv,
551 #else
552     (void *)&afsmodlsys,
553 # ifdef AFS_SUN5_64BIT_ENV
554     (void *)&afsmodlsys32,
555 # endif
556 #endif /* !AFS_SUN511_ENV */
557     NULL
558 };
559
560 static void
561 reset_sysent(void)
562 {
563     if (afs_sinited) {
564         sysent[SYS_setgroups].sy_callc = afs_orig_setgroups;
565         sysent[SYS_ioctl].sy_call = afs_orig_ioctl;
566 #if defined(AFS_SUN5_64BIT_ENV)
567         sysent32[SYS_setgroups].sy_callc = afs_orig_setgroups32;
568         sysent32[SYS_ioctl].sy_call = afs_orig_ioctl32;
569 #endif
570     }
571 }
572
573 /** This is the function that modload calls when loading the afs kernel
574   * extensions. The solaris modload program searches for the _init
575   * function in a module and calls it when modloading
576   */
577
578 _init()
579 {
580     char *sysn, *mod_getsysname();
581     int code;
582     extern char *sysbind;
583     extern struct bind *sb_hashtab[];
584     struct modctl *mp = 0;
585
586     if (afs_sinited)
587         return EBUSY;
588
589     if ((!(mp = mod_find_by_filename("fs", "ufs"))
590          && !(mp = mod_find_by_filename(NULL, "/kernel/fs/ufs"))
591          && !(mp = mod_find_by_filename(NULL, "sys/ufs"))) || (mp
592                                                                && !mp->
593                                                                mod_installed))
594     {
595         printf
596             ("ufs module must be loaded before loading afs; use modload /kernel/fs/ufs\n");
597         return (ENOSYS);
598     }
599 #ifndef AFS_NONFSTRANS
600     if ((!(mp = mod_find_by_filename("misc", "nfssrv"))
601          && !(mp = mod_find_by_filename(NULL, NFSSRV))
602          && !(mp = mod_find_by_filename(NULL, NFSSRV_V9))
603          && !(mp = mod_find_by_filename(NULL, NFSSRV_AMD64))) || (mp
604                                                                && !mp->
605                                                                mod_installed))
606     {
607         printf
608             ("misc/nfssrv module must be loaded before loading afs with nfs-xlator\n");
609         return (ENOSYS);
610     }
611 #endif /* !AFS_NONFSTRANS */
612
613
614     osi_Init();                 /* initialize global lock, etc */
615
616     code = mod_install(&afs_modlinkage);
617     if (code) {
618         /* we failed to load, so make sure we don't leave behind any
619          * references to our syscall handlers */
620         reset_sysent();
621     }
622     return code;
623 }
624
625 _info(modp)
626      struct modinfo *modp;
627 {
628     int code;
629
630     code = mod_info(&afs_modlinkage, modp);
631     return code;
632 }
633
634 _fini()
635 {
636     int code;
637
638     if (afs_globalVFS)
639         return EBUSY;
640
641     reset_sysent();
642     code = mod_remove(&afs_modlinkage);
643     return code;
644 }