src/afs/LINUX/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  * VFS operations for Linux
  12  *
  13  * super_block operations should return negated errno to Linux.
  14  */
  15 #include <afsconfig.h>
  16 #include "../afs/param.h"
  17
  18 RCSID("$Header$");
  19
  20 #include "../afs/sysincludes.h"
  21 #include "../afs/afsincludes.h"
  22 #include "../afs/afs_stats.h"
  23 #include "../h/locks.h"
  24 #if defined(AFS_LINUX24_ENV)
  25 #include "../h/smp_lock.h"
  26 #endif
  27
  28 #define __NO_VERSION__ /* don't define kernel_verion in module.h */
  29 #include <linux/module.h>
  30
  31
  32 struct vcache *afs_globalVp = 0;
  33 struct vfs *afs_globalVFS = 0;
  34 int afs_was_mounted = 0; /* Used to force reload if mount/unmount/mount */
  35
  36 extern struct super_operations afs_sops;
  37 extern afs_rwlock_t afs_xvcache;
  38 extern struct afs_q VLRU;
  39
  40 extern struct dentry_operations afs_dentry_operations;
  41
  42 /* Forward declarations */
  43 static void iattr2vattr(struct vattr *vattrp, struct iattr *iattrp);
  44 static void update_inode_cache(struct inode *ip, struct vattr *vp);
  45 static int afs_root(struct super_block *afsp);
  46 struct super_block *afs_read_super(struct super_block *sb, void *data,
  47                                    int silent);
  48 void put_inode_on_dummy_list(struct inode *ip);
  49
  50 /* afs_file_system
  51  * VFS entry for Linux - installed in init_module
  52  * Linux mounts file systems by:
  53  * 1) register_filesystem(&afs_file_system) - done in init_module
  54  * 2) Mount call comes to us via do_mount -> read_super -> afs_read_super.
  55  *    We are expected to setup the super_block. See afs_read_super.
  56  */
  57 #if defined(AFS_LINUX24_ENV)
  58 DECLARE_FSTYPE(afs_file_system, "afs", afs_read_super, 0);
  59 #else
  60 struct file_system_type afs_file_system = {
  61     "afs",      /* name - used by mount operation. */
  62     0,          /* requires_dev - no for network filesystems. mount() will
  63                  * pass us an "unnamed" device. */
  64     afs_read_super, /* wrapper to afs_mount */
  65     NULL        /* pointer to next file_system_type once registered. */
  66 };
  67 #endif
  68
  69 /* afs_read_super
  70  * read the "super block" for AFS - roughly eguivalent to struct vfs.
  71  * dev, covered, s_rd_only, s_dirt, and s_type will be set by read_super.
  72  */
  73 struct super_block *afs_read_super(struct super_block *sb, void *data,
  74                                    int silent)
  75 {
  76     int code = 0;
  77
  78     AFS_GLOCK();
  79     if (afs_was_mounted) {
  80         printf("You must reload the AFS kernel extensions before remounting AFS.\n");
  81         AFS_GUNLOCK();
  82         return NULL;
  83     }
  84     afs_was_mounted = 1;
  85
  86     /* Set basics of super_block */
  87 #if !defined(AFS_LINUX24_ENV)
  88     lock_super(sb);
  89 #endif
  90     MOD_INC_USE_COUNT;
  91
  92     afs_globalVFS = sb;
  93     sb->s_blocksize = 1024;
  94     sb->s_blocksize_bits = 10;
  95     sb->s_magic = AFS_VFSMAGIC;
  96     sb->s_op = &afs_sops;       /* Super block (vfs) ops */
  97 #if defined(MAX_NON_LFS)
  98     sb->s_maxbytes = MAX_NON_LFS;
  99 #endif
 100     code = afs_root(sb);
 101     if (code)
 102         MOD_DEC_USE_COUNT;
 103
 104 #if !defined(AFS_LINUX24_ENV)
 105     unlock_super(sb);
 106 #endif
 107
 108     AFS_GUNLOCK();
 109     return code ? NULL : sb;
 110 }
 111
 112
 113 /* afs_root - stat the root of the file system. AFS global held on entry. */
 114 static int afs_root(struct super_block *afsp)
 115 {
 116     register afs_int32 code = 0;
 117     struct vrequest treq;
 118     register struct vcache *tvp=0;
 119
 120     AFS_STATCNT(afs_root);
 121     if (afs_globalVp && (afs_globalVp->states & CStatd)) {
 122         tvp = afs_globalVp;
 123     } else {
 124         cred_t *credp = crref();
 125         afs_globalVp = 0;
 126         if (!(code = afs_InitReq(&treq, credp)) &&
 127             !(code = afs_CheckInit())) {
 128             tvp = afs_GetVCache(&afs_rootFid, &treq, (afs_int32 *)0,
 129                                 (struct vcache*)0, WRITE_LOCK);
 130             if (tvp) {
 131                 extern struct inode_operations afs_dir_iops;
 132 #if defined(AFS_LINUX24_ENV)
 133                 extern struct file_operations afs_dir_fops;
 134 #endif
 135
 136                 /* "/afs" is a directory, reset inode ops accordingly. */
 137                 AFSTOV(tvp)->v_op = &afs_dir_iops;
 138 #if defined(AFS_LINUX24_ENV)
 139                 AFSTOV(tvp)->v_fop = &afs_dir_fops;
 140 #endif
 141
 142                 /* setup super_block and mount point inode. */
 143                 afs_globalVp = tvp;
 144 #if defined(AFS_LINUX24_ENV)
 145                 afsp->s_root = d_alloc_root(AFSTOI(tvp));
 146 #else
 147                 afsp->s_root = d_alloc_root(AFSTOI(tvp), NULL);
 148 #endif
 149                 afsp->s_root->d_op = &afs_dentry_operations;
 150             } else
 151                 code = ENOENT;
 152         }
 153         crfree(credp);
 154     }
 155
 156     afs_Trace2(afs_iclSetp, CM_TRACE_VFSROOT, ICL_TYPE_POINTER, afs_globalVp,
 157                ICL_TYPE_INT32, code);
 158     return code;
 159 }
 160
 161 /* super_operations */
 162
 163 /* afs_read_inode
 164  * called via iget to read in the inode. The passed in inode has i_ino, i_dev
 165  * and i_sb setup on input. Linux file systems use this to get super block
 166  * inode information, so we don't really care what happens here.
 167  * For Linux 2.2, we'll be called if we participate in the inode pool.
 168  */
 169 void afs_read_inode(struct inode *ip)
 170 {
 171     /* I don't think we ever get called with this. So print if we do. */
 172     printf("afs_read_inode: Called for inode %d\n", ip->i_ino);
 173 }
 174
 175
 176 /* afs_notify_change
 177  * Linux version of setattr call. What to change is in the iattr struct.
 178  * We need to set bits in both the Linux inode as well as the vcache.
 179  */
 180 int afs_notify_change(struct dentry *dp, struct iattr* iattrp)
 181 {
 182     struct vattr vattr;
 183     int code;
 184     cred_t *credp = crref();
 185     struct inode *ip = dp->d_inode;
 186
 187     AFS_GLOCK();
 188     VATTR_NULL(&vattr);
 189     iattr2vattr(&vattr, iattrp); /* Convert for AFS vnodeops call. */
 190     update_inode_cache(ip, &vattr);
 191     code = afs_setattr(ITOAFS(ip), &vattr, credp);
 192     afs_CopyOutAttrs(ITOAFS(ip), &vattr);
 193     /* Note that the inode may still not have all the correct info. But at
 194      * least we've got the newest version of what was supposed to be set.
 195      */
 196
 197     AFS_GUNLOCK();
 198     crfree(credp);
 199     return -code;
 200 }
 201
 202
 203 /* This list is simply used to initialize the i_list member of the
 204  * linux inode. This stops linux inode syncing code from choking on our
 205  * inodes.
 206  */
 207 static LIST_HEAD(dummy_inode_list);
 208
 209
 210 /* This is included for documentation only. */
 211 /* afs_write_inode
 212  * Used to flush in core inode to disk. We don't need to do this. Top level
 213  * write_inode() routine will clear i_dirt. If this routine is in the table,
 214  * it's expected to do the cleaning and clear i_dirt.
 215  *
 216  * 9/24/99: This is what we thought until we discovered msync() does end up calling
 217  * this function to sync a single inode to disk. msync() only flushes selective
 218  * pages to disk. So it needs an inode syncing function to update metadata when it
 219  * has synced some pages of a file to disk.
 220  */
 221 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,4,0)
 222 void afs_write_inode(struct inode *ip, int unused)
 223 #else
 224 void afs_write_inode(struct inode *ip)
 225 #endif
 226 {
 227     /* and put it back on our dummy list. */
 228     list_del(&ip->i_list);
 229     list_add(&ip->i_list, &dummy_inode_list);
 230
 231     /* for now we don't actually update the metadata during msync. This
 232      * is just to keep linux happy.  */
 233 }
 234
 235
 236 /* afs_put_inode
 237  * called from iput when count goes to zero. Linux version of inactive.
 238  * For Linux 2.2, this funcionality has moved to the delete inode super op.
 239  * If we use the common inode pool, we'll need to set i_nlink to 0 here.
 240  * That will trigger the call to delete routine.
 241  */
 242
 243 void afs_delete_inode(struct inode *ip)
 244 {
 245     struct vcache *vc = ITOAFS(ip);
 246
 247     AFS_GLOCK();
 248     osi_clear_inode(ip);
 249     AFS_GUNLOCK();
 250 }
 251
 252
 253 /* afs_put_super
 254  * Called from unmount to release super_block. */
 255 void afs_put_super(struct super_block *sbp)
 256 {
 257     extern int afs_afs_cold_shutdown;
 258     int code = 0;
 259     int fv_slept;
 260
 261     AFS_GLOCK();
 262     AFS_STATCNT(afs_unmount);
 263
 264     if (!suser()) {
 265         AFS_GUNLOCK();
 266         return;
 267     }
 268
 269     afs_globalVFS = 0;
 270     afs_globalVp = 0;
 271     afs_shutdown();
 272
 273     osi_linux_verify_alloced_memory();
 274  done:
 275     AFS_GUNLOCK();
 276
 277     if (!code) {
 278         sbp->s_dev = 0;
 279         MOD_DEC_USE_COUNT;
 280     }
 281 }
 282
 283 #ifdef NOTUSED
 284 /* afs_write_super
 285  * Not required since we don't write out a super block. */
 286 void afs_write_super(struct super_block *sbp)
 287 {
 288 }
 289
 290 /* afs_remount_fs
 291  * Used to remount filesystems with different flags. Not relevant for AFS.
 292  */
 293 int afs_remount_fs(struct super_block *sbp, int *, char *)
 294 {
 295     return -EINVAL;
 296 }
 297 #endif
 298
 299 /* afs_statfs
 300  * statp is in user space, so we need to cobble together a statfs, then
 301  * copy it.
 302  */
 303 #if defined(AFS_LINUX24_ENV)
 304 int afs_statfs(struct super_block *sbp, struct statfs *statp)
 305 #else
 306 int afs_statfs(struct super_block *sbp, struct statfs *statp, int size)
 307 #endif
 308 {
 309     struct statfs stat;
 310
 311     AFS_STATCNT(afs_statfs);
 312
 313 #if !defined(AFS_LINUX24_ENV)
 314     if (size < sizeof(struct statfs))
 315         return;
 316
 317     memset(&stat, 0, size);
 318 #endif
 319     stat.f_type = 0; /* Can we get a real type sometime? */
 320     stat.f_bsize = sbp->s_blocksize;
 321     stat.f_blocks =  stat.f_bfree =  stat.f_bavail =  stat.f_files =
 322         stat.f_ffree = 9000000;
 323     stat.f_fsid.val[0] = AFS_VFSMAGIC;
 324     stat.f_fsid.val[1] = AFS_VFSFSID;
 325     stat.f_namelen = 256;
 326
 327 #if defined(AFS_LINUX24_ENV)
 328     *statp = stat;
 329 #else
 330     memcpy_tofs(statp, &stat, size);
 331 #endif
 332     return 0;
 333 }
 334
 335
 336 void
 337 afs_umount_begin(struct super_block *sbp)
 338 {
 339     afs_put_super(sbp);
 340     afs_shuttingdown=1;
 341     afs_was_mounted=0;
 342 }
 343
 344 #if defined(AFS_LINUX24_ENV)
 345 struct super_operations afs_sops = {
 346     read_inode:        afs_read_inode,
 347     write_inode:       afs_write_inode,
 348     delete_inode:      afs_delete_inode,
 349     put_super:         afs_put_super,
 350     statfs:            afs_statfs,
 351     umount_begin:      NULL /* afs_umount_begin */
 352 };
 353 #else
 354 struct super_operations afs_sops = {
 355     afs_read_inode,
 356     afs_write_inode,            /* afs_write_inode - see doc above. */
 357     NULL,               /* afs_put_inode */
 358     afs_delete_inode,
 359     afs_notify_change,
 360     afs_put_super,
 361     NULL,               /* afs_write_super - see doc above */
 362     afs_statfs,
 363     NULL,               /* afs_remount_fs - see doc above */
 364     NULL,               /* afs_clear_inode */
 365     NULL                /* afs_umount_begin */
 366 };
 367 #endif
 368
 369 /************** Support routines ************************/
 370
 371 /* vattr_setattr
 372  * Set iattr data into vattr. Assume vattr cleared before call.
 373  */
 374 static void iattr2vattr(struct vattr *vattrp, struct iattr *iattrp)
 375 {
 376     vattrp->va_mask = iattrp->ia_valid;
 377     if (iattrp->ia_valid & ATTR_MODE)
 378         vattrp->va_mode = iattrp->ia_mode;
 379     if (iattrp->ia_valid & ATTR_UID)
 380         vattrp->va_uid = iattrp->ia_uid;
 381     if (iattrp->ia_valid & ATTR_GID)
 382         vattrp->va_gid = iattrp->ia_gid;
 383     if (iattrp->ia_valid & ATTR_SIZE)
 384         vattrp->va_size = iattrp->ia_size;
 385     if (iattrp->ia_valid & ATTR_ATIME) {
 386         vattrp->va_atime.tv_sec = iattrp->ia_atime;
 387         vattrp->va_atime.tv_usec = 0;
 388     }
 389     if (iattrp->ia_valid & ATTR_MTIME) {
 390         vattrp->va_mtime.tv_sec = iattrp->ia_mtime;
 391         vattrp->va_mtime.tv_usec = 0;
 392     }
 393     if (iattrp->ia_valid & ATTR_CTIME) {
 394         vattrp->va_ctime.tv_sec = iattrp->ia_ctime;
 395         vattrp->va_ctime.tv_usec = 0;
 396     }
 397 }
 398
 399 /* update_inode_cache
 400  * Update inode with info from vattr struct. Use va_mask to determine what
 401  * to update.
 402  */
 403 static void update_inode_cache(struct inode *ip, struct vattr *vp)
 404 {
 405     if (vp->va_mask & ATTR_MODE)
 406         ip->i_mode = vp->va_mode;
 407     if (vp->va_mask & ATTR_UID)
 408         ip->i_uid = vp->va_uid;
 409     if (vp->va_mask & ATTR_GID)
 410         ip->i_gid = vp->va_gid;
 411     if (vp->va_mask & ATTR_SIZE)
 412         ip->i_size = vp->va_size;
 413     if (vp->va_mask & ATTR_ATIME)
 414         ip->i_atime = vp->va_atime.tv_sec;
 415     if (vp->va_mask & ATTR_MTIME)
 416         ip->i_mtime = vp->va_mtime.tv_sec;
 417     if (vp->va_mask & ATTR_CTIME)
 418         ip->i_ctime = vp->va_ctime.tv_sec;
 419 }
 420
 421 /* vattr2inode
 422  * Rewrite the inode cache from the attr. Assumes all vattr fields are valid.
 423  */
 424 void vattr2inode(struct inode *ip, struct vattr *vp)
 425 {
 426     ip->i_ino = vp->va_nodeid;
 427     ip->i_nlink = vp->va_nlink;
 428     ip->i_blocks = vp->va_blocks;
 429     ip->i_blksize = vp->va_blocksize;
 430     ip->i_rdev = vp->va_rdev;
 431     ip->i_mode = vp->va_mode;
 432     ip->i_uid = vp->va_uid;
 433     ip->i_gid = vp->va_gid;
 434     ip->i_size = vp->va_size;
 435     ip->i_atime = vp->va_atime.tv_sec;
 436     ip->i_mtime = vp->va_mtime.tv_sec;
 437     ip->i_ctime = vp->va_ctime.tv_sec;
 438
 439     /* we should put our inodes on a dummy inode list to keep linux happy.*/
 440     if (!ip->i_list.prev && !ip->i_list.next) {
 441         /* this might be bad as we are reaching under the covers of the
 442          * list structure but we want to avoid putting the inode
 443          * on the list more than once.   */
 444         put_inode_on_dummy_list(ip);
 445     }
 446 }
 447
 448 /* Put this afs inode on our own dummy list. Linux expects to see inodes
 449  * nicely strung up in lists. Linux inode syncing code chokes on our inodes if
 450  * they're not on any lists.
 451  */
 452 void put_inode_on_dummy_list(struct inode *ip)
 453 {
 454     /* Initialize list. See explanation above. */
 455     list_add(&ip->i_list, &dummy_inode_list);
 456 }
 457
 458 /* And yet another routine to update the inode cache - called from ProcessFS */
 459 void vcache2inode(struct vcache *avc)
 460 {
 461     struct vattr vattr;
 462
 463     VATTR_NULL(&vattr);
 464     afs_CopyOutAttrs(avc, &vattr); /* calls vattr2inode */
 465 }
 466
 467 /* Yet another one for fakestat'ed mountpoints */
 468 void vcache2fakeinode(struct vcache *rootvp, struct vcache *mpvp)
 469 {
 470     struct vattr vattr;
 471
 472     VATTR_NULL(&vattr);
 473     afs_CopyOutAttrs(rootvp, &vattr);
 474     vattr2inode(AFSTOV(mpvp), &vattr);
 475 }