2 * Copyright 2000, International Business Machines Corporation and others.
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
9 * Portions Copyright (c) 2003 Apple Computer, Inc.
13 * afs_vnop_attrs.c - setattr and getattr vnodeops
25 #include <afsconfig.h>
26 #include "afs/param.h"
29 #include "afs/sysincludes.h" /* Standard vendor system headers */
30 #include "afsincludes.h" /* Afs-based standard headers */
31 #include "afs/afs_stats.h" /* statistics */
32 #include "afs/afs_cbqueue.h"
33 #include "afs/nfsclient.h"
34 #include "afs/afs_osidnlc.h"
36 struct afs_exporter *afs_nfsexporter;
37 extern struct vcache *afs_globalVp;
38 #if defined(AFS_HPUX110_ENV)
39 extern struct vfs *afs_globalVFS;
43 /* copy out attributes from cache entry */
45 afs_CopyOutAttrs(struct vcache *avc, struct vattr *attrs)
49 #if defined(AFS_FBSD_ENV) || defined(AFS_DFBSD_ENV)
50 struct vnode *vp = AFSTOV(avc);
54 AFS_STATCNT(afs_CopyOutAttrs);
55 if (afs_fakestat_enable && avc->mvstat == AFS_MVSTAT_MTPT)
57 attrs->va_type = fakedir ? VDIR : vType(avc);
58 #if defined(AFS_SGI_ENV) || defined(AFS_AIX32_ENV) || defined(AFS_SUN5_ENV) || defined(AFS_DARWIN_ENV)
59 attrs->va_mode = fakedir ? S_IFDIR | 0755 : (mode_t) (avc->f.m.Mode & 0xffff);
61 attrs->va_mode = fakedir ? VDIR | 0755 : avc->f.m.Mode;
64 if (avc->f.m.Mode & (VSUID | VSGID)) {
65 /* setuid or setgid, make sure we're allowed to run them from this cell */
66 tcell = afs_GetCell(avc->f.fid.Cell, 0);
67 if (tcell && (tcell->states & CNoSUID))
68 attrs->va_mode &= ~(VSUID | VSGID);
70 #if defined(AFS_DARWIN_ENV)
72 if (!afs_darwin_realmodes) {
73 /* Mac OS X uses the mode bits to determine whether a file or
74 * directory is accessible, and believes them, even though under
75 * AFS they're almost assuredly wrong, especially if the local uid
76 * does not match the AFS ID. So we set the mode bits
79 if (S_ISDIR(attrs->va_mode)) {
80 /* all access bits need to be set for directories, since even
81 * a mode 0 directory can still be used normally.
83 attrs->va_mode |= ACCESSPERMS;
85 /* for other files, replicate the user bits to group and other */
86 mode_t ubits = (attrs->va_mode & S_IRWXU) >> 6;
87 attrs->va_mode |= ubits | (ubits << 3);
91 #endif /* AFS_DARWIN_ENV */
92 attrs->va_uid = fakedir ? 0 : avc->f.m.Owner;
93 attrs->va_gid = fakedir ? 0 : avc->f.m.Group; /* yeah! */
94 #if defined(AFS_SUN5_ENV)
95 attrs->va_fsid = AFSTOV(avc)->v_vfsp->vfs_fsid.val[0];
96 #elif defined(AFS_DARWIN80_ENV)
97 VATTR_RETURN(attrs, va_fsid, vfs_statfs(vnode_mount(AFSTOV(avc)))->f_fsid.val[0]);
98 #elif defined(AFS_DARWIN_ENV)
99 attrs->va_fsid = avc->v->v_mount->mnt_stat.f_fsid.val[0];
100 #else /* ! AFS_DARWIN_ENV */
103 if (avc->mvstat == AFS_MVSTAT_ROOT) {
104 tvp = afs_GetVolume(&avc->f.fid, 0, READ_LOCK);
105 /* The mount point's vnode. */
108 afs_calc_inum(tvp->mtpoint.Cell,
109 tvp->mtpoint.Fid.Volume,
110 tvp->mtpoint.Fid.Vnode);
111 if (FidCmp(&afs_rootFid, &avc->f.fid) && !attrs->va_nodeid)
112 attrs->va_nodeid = 2;
113 afs_PutVolume(tvp, READ_LOCK);
115 attrs->va_nodeid = 2;
118 afs_calc_inum(avc->f.fid.Cell,
119 avc->f.fid.Fid.Volume,
120 avc->f.fid.Fid.Vnode);
121 attrs->va_nodeid &= 0x7fffffff; /* Saber C hates negative inode #s! */
122 attrs->va_nlink = fakedir ? 100 : avc->f.m.LinkCount;
123 attrs->va_size = fakedir ? 4096 : avc->f.m.Length;
124 #if defined(AFS_FBSD_ENV) || defined(AFS_DFBSD_ENV)
125 vnode_pager_setsize(vp, (u_long) attrs->va_size);
127 attrs->va_atime.tv_sec = attrs->va_mtime.tv_sec = attrs->va_ctime.tv_sec =
128 fakedir ? 0 : (int)avc->f.m.Date;
129 /* set microseconds to be dataversion # so that we approximate NFS-style
130 * use of mtime as a dataversion #. We take it mod 512K because
131 * microseconds *must* be less than a million, and 512K is the biggest
132 * power of 2 less than such. DataVersions are typically pretty small
133 * anyway, so the difference between 512K and 1000000 shouldn't matter
134 * much, and "&" is a lot faster than "%".
136 #if defined(AFS_DARWIN_ENV) || defined(AFS_FBSD_ENV)
137 /* nfs on these systems puts an 0 in nsec and stores the nfs usec (aka
138 * dataversion) in va_gen */
140 attrs->va_atime.tv_nsec = attrs->va_mtime.tv_nsec =
141 attrs->va_ctime.tv_nsec = 0;
142 attrs->va_gen = hgetlo(avc->f.m.DataVersion);
143 #elif defined(AFS_SGI_ENV) || defined(AFS_SUN5_ENV) || defined(AFS_AIX41_ENV) || defined(AFS_OBSD_ENV) || defined(AFS_NBSD_ENV) || defined(AFS_LINUX26_ENV)
144 attrs->va_atime.tv_nsec = attrs->va_mtime.tv_nsec =
145 attrs->va_ctime.tv_nsec =
146 (hgetlo(avc->f.m.DataVersion) & 0x7ffff) * 1000;
148 attrs->va_atime.tv_usec = attrs->va_mtime.tv_usec =
149 attrs->va_ctime.tv_usec = (hgetlo(avc->f.m.DataVersion) & 0x7ffff);
151 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
154 #if defined(AFS_SGI_ENV) || defined(AFS_SUN5_ENV)
155 attrs->va_blksize = AFS_BLKSIZE; /* XXX Was 8192 XXX */
157 attrs->va_blocksize = AFS_BLKSIZE; /* XXX Was 8192 XXX */
160 #if defined(AFS_HPUX110_ENV)
162 attrs->va_fstype = afs_globalVFS->vfs_mtype;
166 * Below return 0 (and not 1) blocks if the file is zero length. This conforms
167 * better with the other filesystems that do return 0.
169 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
170 attrs->va_bytes = (attrs->va_size ? (attrs->va_size + 1023) : 1024);
172 attrs->va_bytes_rsv = -1;
174 #elif defined(AFS_HPUX_ENV)
175 attrs->va_blocks = (attrs->va_size ? ((attrs->va_size + 1023)>>10) : 0);
176 #elif defined(AFS_SGI_ENV)
177 attrs->va_blocks = BTOBB(attrs->va_size);
178 #elif defined(AFS_SUN5_ENV)
179 attrs->va_nblocks = (attrs->va_size ? ((attrs->va_size + 1023)>>10)<<1:0);
180 #else /* everything else */
181 attrs->va_blocks = (attrs->va_size ? ((attrs->va_size + 1023)>>10)<<1:0);
188 #if defined(AFS_SUN5_ENV) || defined(AFS_SGI_ENV)
190 afs_getattr(OSI_VC_DECL(avc), struct vattr *attrs, int flags,
194 afs_getattr(OSI_VC_DECL(avc), struct vattr *attrs, afs_ucred_t *acred)
198 struct vrequest *treq = NULL;
203 AFS_STATCNT(afs_getattr);
204 afs_Trace2(afs_iclSetp, CM_TRACE_GETATTR, ICL_TYPE_POINTER, avc,
205 ICL_TYPE_OFFSET, ICL_HANDLE_OFFSET(avc->f.m.Length));
207 if (afs_fakestat_enable && avc->mvstat == AFS_MVSTAT_MTPT) {
208 struct afs_fakestat_state fakestat;
209 struct vrequest *ureq = NULL;
211 code = afs_CreateReq(&ureq, acred);
215 afs_InitFakeStat(&fakestat);
216 code = afs_TryEvalFakeStat(&avc, &fakestat, ureq);
218 afs_PutFakeStat(&fakestat);
219 afs_DestroyReq(ureq);
223 code = afs_CopyOutAttrs(avc, attrs);
224 afs_PutFakeStat(&fakestat);
225 afs_DestroyReq(ureq);
228 #if defined(AFS_SUN5_ENV)
229 if (flags & ATTR_HINT) {
230 code = afs_CopyOutAttrs(avc, attrs);
234 #if defined(AFS_DARWIN_ENV) && !defined(AFS_DARWIN80_ENV)
235 if (avc->f.states & CUBCinit) {
236 code = afs_CopyOutAttrs(avc, attrs);
243 if (afs_shuttingdown != AFS_RUNNING) {
248 if (!(avc->f.states & CStatd)) {
249 if (!(code = afs_CreateReq(&treq, acred))) {
250 code = afs_VerifyVCache(avc, treq);
256 #if defined(AFS_SUN5_ENV)
258 osi_FlushPages(avc, acred);
262 osi_FlushText(avc); /* only needed to flush text if text locked last time */
263 code = afs_CopyOutAttrs(avc, attrs);
265 if (afs_nfsexporter) {
267 if ((code = afs_CreateReq(&treq, acred))) {
272 if (AFS_NFSXLATORREQ(acred)) {
273 if ((vType(avc) != VDIR)
274 && !afs_AccessOK(avc, PRSFS_READ, treq,
276 CMB_ALLOW_EXEC_AS_READ)) {
277 afs_DestroyReq(treq);
281 if ((au = afs_FindUser(treq->uid, -1, READ_LOCK))) {
282 struct afs_exporter *exporter = au->exporter;
284 if (exporter && !(afs_nfsexporter->exp_states & EXP_UNIXMODE)) {
287 * If the remote user wishes to enforce default Unix mode semantics,
288 * like in the nfs exporter case, we OR in the user bits
289 * into the group and other bits. We need to do this
290 * because there is no RFS_ACCESS call and thus nfs
291 * clients implement nfs_access by interpreting the
292 * mode bits in the traditional way, which of course
295 ubits = (attrs->va_mode & 0700) >> 6;
296 attrs->va_mode = attrs->va_mode | ubits | (ubits << 3);
297 /* If it's the root of AFS, replace the inode number with the
298 * inode number of the mounted on directory; otherwise this
299 * confuses getwd()... */
300 #ifdef AFS_LINUX22_ENV
301 if (avc == afs_globalVp) {
302 struct inode *ip = AFSTOV(avc)->i_sb->s_root->d_inode;
303 attrs->va_nodeid = ip->i_ino; /* VTOI()? */
307 #if defined(AFS_DARWIN_ENV)
308 vnode_isvroot(AFSTOV(avc))
309 #elif defined(AFS_NBSD50_ENV)
310 AFSTOV(avc)->v_vflag & VV_ROOT
312 AFSTOV(avc)->v_flag & VROOT
315 struct vnode *vp = AFSTOV(avc);
317 #ifdef AFS_DARWIN80_ENV
318 /* XXX vp = vnode_mount(vp)->mnt_vnodecovered; */
321 vp = vp->v_vfsp->vfs_vnodecovered;
322 if (vp) { /* Ignore weird failures */
324 attrs->va_nodeid = VnodeToIno(vp);
328 ip = (struct inode *)VTOI(vp);
329 if (ip) /* Ignore weird failures */
330 attrs->va_nodeid = ip->i_number;
335 #endif /* AFS_LINUX22_ENV */
337 afs_PutUser(au, READ_LOCK);
345 afs_DestroyReq(treq);
348 code = afs_CheckCode(code, treq, 14);
349 afs_DestroyReq(treq);
353 /* convert a Unix request into a status store request */
355 afs_VAttrToAS(struct vcache *avc, struct vattr *av,
356 struct AFSStoreStatus *as)
361 AFS_STATCNT(afs_VAttrToAS);
362 #if defined(AFS_DARWIN80_ENV)
363 if (VATTR_IS_ACTIVE(av, va_mode)) {
364 #elif defined(AFS_AIX_ENV)
365 /* Boy, was this machine dependent bogosity hard to swallow????.... */
366 if (av->va_mode != -1) {
367 #elif defined(AFS_LINUX22_ENV) || defined(UKERNEL)
368 if (av->va_mask & ATTR_MODE) {
369 #elif defined(AFS_SUN5_ENV) || defined(AFS_SGI_ENV)
370 if (av->va_mask & AT_MODE) {
371 #elif defined(AFS_XBSD_ENV)
372 if (av->va_mode != (mode_t)VNOVAL) {
374 if (av->va_mode != ((unsigned short)-1)) {
377 as->UnixModeBits = av->va_mode & 0xffff;
378 if (avc->f.states & CForeign) {
379 ObtainWriteLock(&avc->lock, 127);
380 afs_FreeAllAxs(&(avc->Access));
381 ReleaseWriteLock(&avc->lock);
384 #if defined(AFS_DARWIN80_ENV)
385 if (VATTR_IS_ACTIVE(av, va_gid)) {
386 #elif defined(AFS_LINUX22_ENV) || defined(UKERNEL)
387 if (av->va_mask & ATTR_GID) {
388 #elif defined(AFS_SUN5_ENV) || defined(AFS_SGI_ENV)
389 if (av->va_mask & AT_GID) {
390 #elif defined(AFS_HPUX_ENV)
391 #if defined(AFS_HPUX102_ENV)
392 if (av->va_gid != GID_NO_CHANGE) {
394 if (av->va_gid != ((unsigned short)-1)) {
396 #elif defined(AFS_XBSD_ENV)
397 if (av->va_gid != (gid_t)VNOVAL) {
399 if (av->va_gid != -1) {
400 #endif /* AFS_LINUX22_ENV */
401 mask |= AFS_SETGROUP;
402 as->Group = av->va_gid;
404 #if defined(AFS_DARWIN80_ENV)
405 if (VATTR_IS_ACTIVE(av, va_uid)) {
406 #elif defined(AFS_LINUX22_ENV) || defined(UKERNEL)
407 if (av->va_mask & ATTR_UID) {
408 #elif defined(AFS_SUN5_ENV) || defined(AFS_SGI_ENV)
409 if (av->va_mask & AT_UID) {
410 #elif defined(AFS_HPUX_ENV)
411 #if defined(AFS_HPUX102_ENV)
412 if (av->va_uid != UID_NO_CHANGE) {
414 if (av->va_uid != ((unsigned short)-1)) {
416 #elif defined(AFS_XBSD_ENV)
417 if (av->va_uid != (uid_t)VNOVAL) {
419 if (av->va_uid != -1) {
420 #endif /* AFS_LINUX22_ENV */
421 mask |= AFS_SETOWNER;
422 as->Owner = av->va_uid;
424 #if defined(AFS_DARWIN80_ENV)
425 if (VATTR_IS_ACTIVE(av, va_modify_time)) {
426 #elif defined(AFS_LINUX22_ENV) || defined(UKERNEL)
427 if (av->va_mask & ATTR_MTIME) {
428 #elif defined(AFS_SUN5_ENV) || defined(AFS_SGI_ENV)
429 if (av->va_mask & AT_MTIME) {
431 if (av->va_mtime.tv_sec != -1) {
433 mask |= AFS_SETMODTIME;
435 #if defined(AFS_SUN5_ENV) || defined(AFS_AIX41_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV) || defined(AFS_LINUX26_ENV)
436 if (av->va_mtime.tv_nsec == -1)
438 if (av->va_mtime.tv_usec == -1)
440 as->ClientModTime = osi_Time(); /* special Sys V compat hack for Suns */
443 as->ClientModTime = av->va_mtime.tv_sec;
449 /* We don't set CDirty bit in avc->f.states because setattr calls WriteVCache
450 * synchronously, therefore, it's not needed.
452 #if defined(AFS_SUN5_ENV) || defined(AFS_SGI_ENV)
454 afs_setattr(OSI_VC_DECL(avc), struct vattr *attrs, int flags,
458 afs_setattr(OSI_VC_DECL(avc), struct vattr *attrs,
462 struct vrequest *treq = NULL;
463 struct AFSStoreStatus astat;
465 #if defined(AFS_FBSD_ENV) || defined(AFS_DFBSD_ENV)
466 struct vnode *vp = AFSTOV(avc);
468 struct afs_fakestat_state fakestate;
471 AFS_STATCNT(afs_setattr);
472 #if defined(AFS_SUN5_ENV) || defined(AFS_SGI_ENV) || defined(AFS_LINUX22_ENV)
473 afs_Trace4(afs_iclSetp, CM_TRACE_SETATTR, ICL_TYPE_POINTER, avc,
474 ICL_TYPE_INT32, attrs->va_mask, ICL_TYPE_OFFSET,
475 ICL_HANDLE_OFFSET(attrs->va_size), ICL_TYPE_OFFSET,
476 ICL_HANDLE_OFFSET(avc->f.m.Length));
478 afs_Trace4(afs_iclSetp, CM_TRACE_SETATTR, ICL_TYPE_POINTER, avc,
479 ICL_TYPE_INT32, attrs->va_mode, ICL_TYPE_OFFSET,
480 ICL_HANDLE_OFFSET(attrs->va_size), ICL_TYPE_OFFSET,
481 ICL_HANDLE_OFFSET(avc->f.m.Length));
483 if ((code = afs_CreateReq(&treq, acred)))
486 memset(&astat, 0, sizeof(astat));
490 afs_InitFakeStat(&fakestate);
491 code = afs_EvalFakeStat(&avc, &fakestate, treq);
495 if (avc->f.states & CRO) {
499 #if defined(AFS_SGI_ENV)
500 /* ignore ATTR_LAZY calls - they are really only for keeping
501 * the access/mtime of mmaped files up to date
503 if (flags & ATTR_LAZY)
506 /* if file size has changed, we need write access, otherwise (e.g.
507 * chmod) give it a shot; if it fails, we'll discard the status
510 #if defined(AFS_DARWIN80_ENV)
511 if (VATTR_IS_ACTIVE(attrs, va_data_size)) {
512 #elif defined(AFS_LINUX22_ENV) || defined(UKERNEL)
513 if (attrs->va_mask & ATTR_SIZE) {
514 #elif defined(AFS_SUN5_ENV) || defined(AFS_SGI_ENV)
515 if (attrs->va_mask & AT_SIZE) {
516 #elif defined(AFS_XBSD_ENV)
517 if (attrs->va_size != VNOVAL) {
518 #elif defined(AFS_AIX41_ENV)
519 if (attrs->va_size != -1) {
521 if (attrs->va_size != ~0) {
523 if (!afs_AccessOK(avc, PRSFS_WRITE, treq, DONT_CHECK_MODE_BITS)) {
529 if (AFS_IS_DISCONNECTED && !AFS_IS_DISCON_RW) {
534 afs_VAttrToAS(avc, attrs, &astat); /* interpret request */
536 #if defined(AFS_SUN5_ENV) || defined(AFS_SGI_ENV)
537 if (AFS_NFSXLATORREQ(acred)) {
538 avc->execsOrWriters++;
542 #if defined(AFS_SGI_ENV)
543 AFS_RWLOCK((vnode_t *) avc, VRWLOCK_WRITE);
545 #if defined(AFS_DARWIN80_ENV)
546 if (VATTR_IS_ACTIVE(attrs, va_data_size)) {
547 #elif defined(AFS_LINUX22_ENV) || defined(UKERNEL)
548 if (attrs->va_mask & ATTR_SIZE) {
549 #elif defined(AFS_SUN5_ENV) || defined(AFS_SGI_ENV)
550 if (attrs->va_mask & AT_SIZE) {
551 #elif defined(AFS_XBSD_ENV)
552 if (attrs->va_size != VNOVAL) {
553 #elif defined(AFS_AIX41_ENV)
554 if (attrs->va_size != -1) {
556 if (attrs->va_size != ~0) {
558 afs_size_t tsize = attrs->va_size;
559 ObtainWriteLock(&avc->lock, 128);
560 avc->f.states |= CDirty;
562 if (AFS_IS_DISCONNECTED && tsize >=avc->f.m.Length) {
563 /* If we're growing the file, and we're disconnected, we need
564 * to make the relevant dcache chunks appear ourselves. */
565 code = afs_ExtendSegments(avc, tsize, treq);
567 code = afs_TruncateAllSegments(avc, tsize, treq, acred);
569 #ifdef AFS_LINUX26_ENV
570 /* We must update the Linux kernel's idea of file size as soon as
571 * possible, to avoid racing with delayed writepages delivered by
574 i_size_write(AFSTOV(avc), tsize);
576 #if defined(AFS_FBSD_ENV) || defined(AFS_DFBSD_ENV)
577 vnode_pager_setsize(vp, (u_long) tsize);
579 /* if date not explicitly set by this call, set it ourselves, since we
580 * changed the data */
581 if (!(astat.Mask & AFS_SETMODTIME)) {
582 astat.Mask |= AFS_SETMODTIME;
583 astat.ClientModTime = osi_Time();
587 if (((avc->execsOrWriters <= 0) && (avc->f.states & CCreating) == 0)
588 || (avc->execsOrWriters == 1 && AFS_NFSXLATORREQ(acred))) {
590 /* Store files now if not disconnected. */
591 /* XXX: AFS_IS_DISCON_RW handled. */
592 if (!AFS_IS_DISCONNECTED) {
593 code = afs_StoreAllSegments(avc, treq, AFS_ASYNC);
595 avc->f.states &= ~CDirty;
599 avc->f.states &= ~CDirty;
601 ReleaseWriteLock(&avc->lock);
603 osi_FlushText(avc); /* do this after releasing all locks */
606 if (!AFS_IS_DISCONNECTED) {
608 ObtainSharedLock(&avc->lock, 16); /* lock entry */
609 code = afs_WriteVCache(avc, &astat, treq); /* send request */
610 ReleaseSharedLock(&avc->lock); /* release lock */
613 /* error? erase any changes we made to vcache entry */
614 afs_StaleVCache(avc);
617 ObtainSharedLock(&avc->lock, 712);
618 /* Write changes locally. */
619 code = afs_WriteVCacheDiscon(avc, &astat, attrs);
620 ReleaseSharedLock(&avc->lock);
621 } /* if (!AFS_IS_DISCONNECTED) */
623 #if defined(AFS_SUN5_ENV) || defined(AFS_SGI_ENV)
624 if (AFS_NFSXLATORREQ(acred)) {
625 avc->execsOrWriters--;
628 #if defined(AFS_SGI_ENV)
629 AFS_RWUNLOCK((vnode_t *) avc, VRWLOCK_WRITE);
632 afs_PutFakeStat(&fakestate);
635 code = afs_CheckCode(code, treq, 15);
636 afs_DestroyReq(treq);
643 * \note The caller must free the allocated vattr with
644 * afs_DestroyAttr() if this function returns successfully (zero).
646 * \note The GLOCK must be held on platforms which require the GLOCK
647 * for osi_AllocSmallSpace() and osi_FreeSmallSpace().
649 * \param[out] out address of the vattr pointer
650 * \return 0 on success
653 afs_CreateAttr(struct vattr **out)
655 struct vattr *vattr = NULL;
660 vattr = osi_AllocSmallSpace(sizeof(struct vattr));
664 memset(vattr, 0, sizeof(struct vattr));
670 * Deallocate a vattr.
672 * \note The GLOCK must be held on platforms which require the GLOCK
673 * for osi_FreeSmallSpace().
675 * \param[in] vattr pointer to the vattr to free; may be NULL
678 afs_DestroyAttr(struct vattr *vattr)
681 osi_FreeSmallSpace(vattr);