src/afs/VNOPS/afs_vnop_symlink.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  * afs_vnop_symlink.c - symlink and readlink vnodeops.
  12  *
  13  * Implements:
  14  * afs_symlink
  15  * afs_MemHandleLink
  16  * afs_UFSHandleLink
  17  * afs_readlink
  18  *
  19  */
  20
  21 #include <afsconfig.h>
  22 #include "../afs/param.h"
  23
  24 RCSID("$Header$");
  25
  26 #include "../afs/sysincludes.h" /* Standard vendor system headers */
  27 #include "../afs/afsincludes.h" /* Afs-based standard headers */
  28 #include "../afs/afs_stats.h" /* statistics */
  29 #include "../afs/afs_cbqueue.h"
  30 #include "../afs/nfsclient.h"
  31 #include "../afs/afs_osidnlc.h"
  32
  33 extern afs_rwlock_t afs_xvcache;
  34 extern afs_rwlock_t afs_xcbhash;
  35
  36 /* Note: There is the bare bones beginning of symlink hints in the now
  37  * defunct afs/afs_lookup.c file. Since they are not in use, making the call
  38  * is just a performance hit.
  39  */
  40
  41
  42 /* don't set CDirty in here because RPC is called synchronously */
  43 afs_symlink
  44 #ifdef  AFS_OSF_ENV
  45   (ndp, attrs, atargetName)
  46     struct nameidata *ndp;
  47     struct vattr *attrs;
  48     register char *atargetName; {
  49     register struct vcache *adp = (struct vcache *)ndp->ni_dvp;
  50     char *aname = ndp->ni_dent.d_name;
  51     struct ucred *acred = ndp->ni_cred;
  52 #else   /* AFS_OSF_ENV */
  53   (OSI_VC_ARG(adp), aname, attrs, atargetName, acred)
  54     OSI_VC_DECL(adp);
  55     char *atargetName;
  56     char *aname;
  57     struct vattr *attrs;
  58     struct AFS_UCRED *acred; {
  59 #endif
  60     afs_uint32 now;
  61     struct vrequest treq;
  62     afs_int32 code;
  63     struct conn *tc;
  64     struct VenusFid newFid;
  65     struct dcache *tdc;
  66     afs_size_t offset, len;
  67     afs_int32 alen;
  68     struct server *hostp=0;
  69     struct vcache *tvc;
  70     struct AFSStoreStatus InStatus;
  71     struct AFSFetchStatus OutFidStatus, OutDirStatus;
  72     struct AFSCallBack CallBack;
  73     struct AFSVolSync tsync;
  74     struct volume*    volp=0;
  75     XSTATS_DECLS
  76     OSI_VC_CONVERT(adp)
  77
  78     AFS_STATCNT(afs_symlink);
  79     afs_Trace2(afs_iclSetp, CM_TRACE_SYMLINK, ICL_TYPE_POINTER, adp,
  80                 ICL_TYPE_STRING, aname);
  81
  82     if (afs_IsDynroot(adp))
  83         return afs_DynrootVOPSymlink(adp, acred, aname, atargetName);
  84
  85     if (code = afs_InitReq(&treq, acred))
  86        return code;
  87
  88     code = afs_VerifyVCache(adp, &treq);
  89     if (code) {
  90       code = afs_CheckCode(code, &treq, 30);
  91       return code;
  92     }
  93
  94     /** If the volume is read-only, return error without making an RPC to the
  95       * fileserver
  96       */
  97     if ( adp->states & CRO ) {
  98         code = EROFS;
  99         return code;
 100     }
 101
 102     InStatus.Mask = AFS_SETMODTIME | AFS_SETMODE;
 103     InStatus.ClientModTime = osi_Time();
 104     alen = strlen(atargetName);     /* we want it to include the null */
 105     if (*atargetName == '#' || *atargetName == '%') {
 106         InStatus.UnixModeBits = 0644;   /* mt pt: null from "." at end */
 107         if (alen == 1) alen++;  /* Empty string */
 108     } else {
 109         InStatus.UnixModeBits = 0755;
 110         alen++;     /* add in the null */
 111     }
 112     tdc = afs_GetDCache(adp, (afs_size_t) 0, &treq, &offset, &len, 1);
 113     volp = afs_FindVolume(&adp->fid, READ_LOCK); /*parent is also in same vol*/
 114     ObtainWriteLock(&adp->lock,156);
 115     ObtainWriteLock(&tdc->lock, 636);
 116     ObtainSharedLock(&afs_xvcache,17);  /* prevent others from creating this entry */
 117     /* XXX Pay attention to afs_xvcache around the whole thing!! XXX */
 118     do {
 119         tc = afs_Conn(&adp->fid, &treq, SHARED_LOCK);
 120         if (tc) {
 121             hostp = tc->srvr->server;
 122             XSTATS_START_TIME(AFS_STATS_FS_RPCIDX_SYMLINK);
 123             if (adp->states & CForeign) {
 124                 now = osi_Time();
 125 #ifdef RX_ENABLE_LOCKS
 126                 AFS_GUNLOCK();
 127 #endif /* RX_ENABLE_LOCKS */
 128                 code = RXAFS_DFSSymlink(tc->id, (struct AFSFid *) &adp->fid.Fid, aname,
 129                                      atargetName, &InStatus, (struct AFSFid *) &newFid.Fid,
 130                                      &OutFidStatus, &OutDirStatus, &CallBack, &tsync);
 131 #ifdef RX_ENABLE_LOCKS
 132                 AFS_GLOCK();
 133 #endif /* RX_ENABLE_LOCKS */
 134             } else {
 135 #ifdef RX_ENABLE_LOCKS
 136                 AFS_GUNLOCK();
 137 #endif /* RX_ENABLE_LOCKS */
 138                 code = RXAFS_Symlink(tc->id, (struct AFSFid *) &adp->fid.Fid, aname,
 139                                      atargetName, &InStatus, (struct AFSFid *) &newFid.Fid,
 140                                      &OutFidStatus, &OutDirStatus, &tsync);
 141 #ifdef RX_ENABLE_LOCKS
 142                 AFS_GLOCK();
 143 #endif /* RX_ENABLE_LOCKS */
 144             }
 145           XSTATS_END_TIME;
 146         }
 147         else code = -1;
 148     } while
 149        (afs_Analyze(tc, code, &adp->fid, &treq,
 150                    AFS_STATS_FS_RPCIDX_SYMLINK, SHARED_LOCK, (struct cell *)0));
 151
 152     UpgradeSToWLock(&afs_xvcache,40);
 153     if (code) {
 154         if (code < 0) {
 155           ObtainWriteLock(&afs_xcbhash, 499);
 156           afs_DequeueCallback(adp);
 157           adp->states &= ~CStatd;
 158           ReleaseWriteLock(&afs_xcbhash);
 159           osi_dnlc_purgedp(adp);
 160         }
 161         ReleaseWriteLock(&adp->lock);
 162         ReleaseWriteLock(&afs_xvcache);
 163         if (tdc) {
 164             ReleaseWriteLock(&tdc->lock);
 165             afs_PutDCache(tdc);
 166         }
 167         goto done;
 168     }
 169     /* otherwise, we should see if we can make the change to the dir locally */
 170     if (afs_LocalHero(adp, tdc, &OutDirStatus, 1)) {
 171         /* we can do it locally */
 172         code = afs_dir_Create(&tdc->f.inode, aname, &newFid.Fid);
 173         if (code) {
 174             ZapDCE(tdc);        /* surprise error -- use invalid value */
 175             DZap(&tdc->f.inode);
 176         }
 177     }
 178     if (tdc) {
 179         ReleaseWriteLock(&tdc->lock);
 180         afs_PutDCache(tdc);
 181     }
 182     newFid.Cell = adp->fid.Cell;
 183     newFid.Fid.Volume = adp->fid.Fid.Volume;
 184     ReleaseWriteLock(&adp->lock);
 185
 186     /* now we're done with parent dir, create the link's entry.  Note that
 187      * no one can get a pointer to the new cache entry until we release
 188      * the xvcache lock. */
 189     tvc = afs_NewVCache(&newFid, hostp, 1, WRITE_LOCK);
 190     ObtainWriteLock(&tvc->lock,157);
 191     ObtainWriteLock(&afs_xcbhash, 500);
 192     tvc->states |= CStatd;              /* have valid info */
 193     tvc->states &= ~CBulkFetching;
 194
 195     if (adp->states & CForeign) {
 196         tvc->states |= CForeign;
 197         /* We don't have to worry about losing the callback since we're doing it
 198          * under the afs_xvcache lock actually, afs_NewVCache may drop the
 199          * afs_xvcache lock, if it calls afs_FlushVCache */
 200         tvc->cbExpires = CallBack.ExpirationTime + now;
 201         afs_QueueCallback(tvc, CBHash(CallBack.ExpirationTime), volp);
 202     } else {
 203         tvc->cbExpires = 0x7fffffff;    /* never expires, they can't change */
 204      /* since it never expires, we don't have to queue the callback */
 205     }
 206     ReleaseWriteLock(&afs_xcbhash);
 207     afs_ProcessFS(tvc, &OutFidStatus, &treq);
 208
 209     if (!tvc->linkData) {
 210         tvc->linkData = (char *) afs_osi_Alloc(alen);
 211         strncpy(tvc->linkData, atargetName, alen-1);
 212         tvc->linkData[alen-1] = 0;
 213     }
 214     ReleaseWriteLock(&tvc->lock);
 215     ReleaseWriteLock(&afs_xvcache);
 216     afs_PutVCache(tvc, WRITE_LOCK);
 217     code = 0;
 218 done:
 219 #ifdef  AFS_OSF_ENV
 220     AFS_RELE(ndp->ni_dvp);
 221 #endif  /* AFS_OSF_ENV */
 222     if ( volp )
 223         afs_PutVolume(volp, READ_LOCK);
 224     code = afs_CheckCode(code, &treq, 31);
 225     return code;
 226 }
 227
 228 afs_MemHandleLink(avc, areq)
 229      register struct vcache *avc;
 230      struct vrequest *areq;
 231   {
 232       register struct dcache *tdc;
 233       register char *tp, *rbuf;
 234       afs_size_t offset, len;
 235       afs_int32 tlen, alen;
 236       register afs_int32 code;
 237
 238       AFS_STATCNT(afs_MemHandleLink);
 239       /* two different formats, one for links protected 644, have a "." at
 240          the end of the file name, which we turn into a null.  Others,
 241          protected 755, we add a null to the end of */
 242       if (!avc->linkData) {
 243           void *addr;
 244           tdc = afs_GetDCache(avc, (afs_size_t) 0, areq, &offset, &len, 0);
 245           if (!tdc) {
 246               return EIO;
 247           }
 248           /* otherwise we have the data loaded, go for it */
 249           if (len > 1024) {
 250               afs_PutDCache(tdc);
 251               return EFAULT;
 252           }
 253           if (avc->m.Mode       & 0111) alen = len+1;   /* regular link */
 254           else alen = len;                      /* mt point */
 255           rbuf = (char *) osi_AllocLargeSpace(AFS_LRALLOCSIZ);
 256           ObtainReadLock(&tdc->lock);
 257           addr = afs_MemCacheOpen(tdc->f.inode);
 258           tlen = len;
 259           code = afs_MemReadBlk(addr, 0, rbuf, tlen);
 260           afs_MemCacheClose(addr);
 261           ReleaseReadLock(&tdc->lock);
 262           afs_PutDCache(tdc);
 263           rbuf[alen-1] = 0;
 264           alen = strlen(rbuf) + 1;
 265           tp = afs_osi_Alloc(alen); /* make room for terminating null */
 266           memcpy(tp, rbuf, alen);
 267           osi_FreeLargeSpace(rbuf);
 268           if (code != len) {
 269               afs_osi_Free(tp, alen);
 270               return EIO;
 271           }
 272           avc->linkData = tp;
 273       }
 274       return 0;
 275   }
 276
 277 afs_UFSHandleLink(avc, areq)
 278     register struct vcache *avc;
 279     struct vrequest *areq;
 280 {
 281     register struct dcache *tdc;
 282     register char *tp, *rbuf;
 283     char *tfile;
 284     afs_size_t offset, len;
 285     afs_int32 tlen, alen;
 286     register afs_int32 code;
 287
 288     /* two different formats, one for links protected 644, have a "." at the end
 289         of the file name, which we turn into a null.  Others, protected 755,
 290         we add a null to the end of */
 291    AFS_STATCNT(afs_UFSHandleLink);
 292     if (!avc->linkData) {
 293         tdc = afs_GetDCache(avc, (afs_size_t) 0, areq, &offset, &len, 0);
 294         afs_Trace3(afs_iclSetp, CM_TRACE_UFSLINK, ICL_TYPE_POINTER, avc,
 295                         ICL_TYPE_POINTER, tdc,
 296                         ICL_TYPE_OFFSET, ICL_HANDLE_OFFSET(avc->m.Length));
 297         if (!tdc) {
 298             return EIO;
 299         }
 300         /* otherwise we have the data loaded, go for it */
 301         if (len > 1024) {
 302             afs_PutDCache(tdc);
 303             return EFAULT;
 304         }
 305         if (avc->m.Mode & 0111) alen = len+1;   /* regular link */
 306         else alen = len;                        /* mt point */
 307         rbuf = (char *) osi_AllocLargeSpace(AFS_LRALLOCSIZ);
 308         tlen = len;
 309         ObtainReadLock(&tdc->lock);
 310         tfile = osi_UFSOpen (tdc->f.inode);
 311         code = afs_osi_Read(tfile, -1, rbuf, tlen);
 312         osi_UFSClose(tfile);
 313         ReleaseReadLock(&tdc->lock);
 314         afs_PutDCache(tdc);
 315         rbuf[alen-1] = '\0';
 316         alen = strlen(rbuf) + 1;
 317         tp = afs_osi_Alloc(alen);       /* make room for terminating null */
 318         memcpy(tp, rbuf, alen);
 319         osi_FreeLargeSpace(rbuf);
 320         if (code != tlen) {
 321             afs_osi_Free(tp, alen);
 322             return EIO;
 323         }
 324         avc->linkData = tp;
 325     }
 326     return 0;
 327 }
 328
 329 afs_readlink(OSI_VC_ARG(avc), auio, acred)
 330     OSI_VC_DECL(avc);
 331     struct uio *auio;
 332     struct AFS_UCRED *acred;
 333 {
 334     register afs_int32 code;
 335     struct vrequest treq;
 336     register char *tp;
 337     OSI_VC_CONVERT(avc)
 338
 339     AFS_STATCNT(afs_readlink);
 340     afs_Trace1(afs_iclSetp, CM_TRACE_READLINK, ICL_TYPE_POINTER, avc);
 341     if (code = afs_InitReq(&treq, acred)) return code;
 342     code = afs_VerifyVCache(avc, &treq);
 343     if (code) goto done;
 344     if (vType(avc) != VLNK) {
 345         code = EINVAL;
 346         goto done;
 347     }
 348     ObtainWriteLock(&avc->lock,158);
 349     code = afs_HandleLink(avc, &treq);
 350     /* finally uiomove it to user-land */
 351     if (code == 0) {
 352         tp = avc->linkData;
 353         if (tp) AFS_UIOMOVE(tp, strlen(tp), UIO_READ, auio, code);
 354         else {
 355             code = EIO;
 356         }
 357     }
 358     ReleaseWriteLock(&avc->lock);
 359 done:
 360     code = afs_CheckCode(code, &treq, 32);
 361     return code;
 362 }