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
  25 #include "afs/sysincludes.h"    /* Standard vendor system headers */
  26 #include "afsincludes.h"        /* Afs-based standard headers */
  27 #include "afs/afs_stats.h"      /* statistics */
  28 #include "afs/afs_cbqueue.h"
  29 #include "afs/nfsclient.h"
  30 #include "afs/afs_osidnlc.h"
  31
  32 extern afs_rwlock_t afs_xvcache;
  33 extern afs_rwlock_t afs_xcbhash;
  34
  35 /* Note: There is the bare bones beginning of symlink hints in the now
  36  * defunct afs/afs_lookup.c file. Since they are not in use, making the call
  37  * is just a performance hit.
  38  */
  39
  40 #ifdef AFS_DISCON_ENV
  41 static int
  42 afs_DisconCreateSymlink(struct vcache *avc, char *aname,
  43                         struct vrequest *areq) {
  44     struct dcache *tdc;
  45     struct osi_file *tfile;
  46     afs_size_t offset, len;
  47
  48     tdc = afs_GetDCache(avc, 0, areq, &offset, &len, 0);
  49     if (!tdc) {
  50         printf("afs_DisconCreateSymlink: can't get new dcache for symlink.\n");
  51         return ENOENT;
  52     }
  53
  54     len = strlen(aname);
  55     avc->f.m.Length = len;
  56
  57     ObtainWriteLock(&tdc->lock, 720);
  58     afs_AdjustSize(tdc, len);
  59     tdc->validPos = len;
  60     tfile = afs_CFileOpen(&tdc->f.inode);
  61     afs_CFileWrite(tfile, 0, aname, len);
  62     afs_CFileClose(tfile);
  63     ReleaseWriteLock(&tdc->lock);
  64     return 0;
  65 }
  66 #endif
  67
  68 /* don't set CDirty in here because RPC is called synchronously */
  69 int
  70 afs_symlink(OSI_VC_DECL(adp), char *aname, struct vattr *attrs,
  71             char *atargetName, AFS_UCRED *acred)
  72 {
  73     afs_uint32 now = 0;
  74     struct vrequest treq;
  75     afs_int32 code = 0;
  76     struct afs_conn *tc;
  77     struct VenusFid newFid;
  78     struct dcache *tdc;
  79     afs_size_t offset, len;
  80     afs_int32 alen;
  81     struct server *hostp = 0;
  82     struct vcache *tvc;
  83     struct AFSStoreStatus InStatus;
  84     struct AFSFetchStatus OutFidStatus, OutDirStatus;
  85     struct AFSCallBack CallBack;
  86     struct AFSVolSync tsync;
  87     struct volume *volp = 0;
  88     struct afs_fakestat_state fakestate;
  89     XSTATS_DECLS;
  90     OSI_VC_CONVERT(adp);
  91
  92     AFS_STATCNT(afs_symlink);
  93     afs_Trace2(afs_iclSetp, CM_TRACE_SYMLINK, ICL_TYPE_POINTER, adp,
  94                ICL_TYPE_STRING, aname);
  95
  96     if ((code = afs_InitReq(&treq, acred)))
  97         goto done2;
  98
  99     afs_InitFakeStat(&fakestate);
 100
 101     AFS_DISCON_LOCK();
 102
 103     code = afs_EvalFakeStat(&adp, &fakestate, &treq);
 104     if (code)
 105         goto done;
 106
 107     if (strlen(aname) > AFSNAMEMAX || strlen(atargetName) > AFSPATHMAX) {
 108         code = ENAMETOOLONG;
 109         goto done;
 110     }
 111
 112     if (afs_IsDynroot(adp)) {
 113         code = afs_DynrootVOPSymlink(adp, acred, aname, atargetName);
 114         goto done;
 115     }
 116     if (afs_IsDynrootMount(adp)) {
 117         code = EROFS;
 118         goto done;
 119     }
 120
 121     code = afs_VerifyVCache(adp, &treq);
 122     if (code) {
 123         code = afs_CheckCode(code, &treq, 30);
 124         goto done;
 125     }
 126
 127     /** If the volume is read-only, return error without making an RPC to the
 128       * fileserver
 129       */
 130     if (adp->f.states & CRO) {
 131         code = EROFS;
 132         goto done;
 133     }
 134
 135     if (AFS_IS_DISCONNECTED && !AFS_IS_DISCON_RW) {
 136         code = ENETDOWN;
 137         goto done;
 138     }
 139
 140     InStatus.Mask = AFS_SETMODTIME | AFS_SETMODE;
 141     InStatus.ClientModTime = osi_Time();
 142     alen = strlen(atargetName); /* we want it to include the null */
 143     if ( (*atargetName == '#' || *atargetName == '%') && alen > 1 && atargetName[alen-1] == '.') {
 144         InStatus.UnixModeBits = 0644;   /* mt pt: null from "." at end */
 145         if (alen == 1)
 146             alen++;             /* Empty string */
 147     } else {
 148         InStatus.UnixModeBits = 0755;
 149         alen++;                 /* add in the null */
 150     }
 151     tdc = afs_GetDCache(adp, (afs_size_t) 0, &treq, &offset, &len, 1);
 152     volp = afs_FindVolume(&adp->f.fid, READ_LOCK);      /*parent is also in same vol */
 153     ObtainWriteLock(&adp->lock, 156);
 154     if (tdc)
 155         ObtainWriteLock(&tdc->lock, 636);
 156     ObtainSharedLock(&afs_xvcache, 17); /* prevent others from creating this entry */
 157     /* XXX Pay attention to afs_xvcache around the whole thing!! XXX */
 158     if (!AFS_IS_DISCON_RW) {
 159         do {
 160             tc = afs_Conn(&adp->f.fid, &treq, SHARED_LOCK);
 161             if (tc) {
 162                 hostp = tc->srvr->server;
 163                 XSTATS_START_TIME(AFS_STATS_FS_RPCIDX_SYMLINK);
 164                 if (adp->f.states & CForeign) {
 165                     now = osi_Time();
 166                     RX_AFS_GUNLOCK();
 167                     code =
 168                         RXAFS_DFSSymlink(tc->id,
 169                                          (struct AFSFid *)&adp->f.fid.Fid,
 170                                          aname, atargetName, &InStatus,
 171                                          (struct AFSFid *)&newFid.Fid,
 172                                          &OutFidStatus, &OutDirStatus,
 173                                          &CallBack, &tsync);
 174                     RX_AFS_GLOCK();
 175                 } else {
 176                     RX_AFS_GUNLOCK();
 177                     code =
 178                         RXAFS_Symlink(tc->id, (struct AFSFid *)&adp->f.fid.Fid,
 179                                       aname, atargetName, &InStatus,
 180                                       (struct AFSFid *)&newFid.Fid,
 181                                       &OutFidStatus, &OutDirStatus, &tsync);
 182                     RX_AFS_GLOCK();
 183                 }
 184                 XSTATS_END_TIME;
 185             } else
 186                 code = -1;
 187         } while (afs_Analyze
 188                     (tc, code, &adp->f.fid, &treq, AFS_STATS_FS_RPCIDX_SYMLINK,
 189                      SHARED_LOCK, NULL));
 190     } else {
 191 #ifdef AFS_DISCON_ENV
 192         newFid.Cell = adp->f.fid.Cell;
 193         newFid.Fid.Volume = adp->f.fid.Fid.Volume;
 194         afs_GenFakeFid(&newFid, VREG, 0);
 195 #endif
 196     }
 197
 198     UpgradeSToWLock(&afs_xvcache, 40);
 199     if (code) {
 200         if (code < 0) {
 201             ObtainWriteLock(&afs_xcbhash, 499);
 202             afs_DequeueCallback(adp);
 203             adp->f.states &= ~CStatd;
 204             ReleaseWriteLock(&afs_xcbhash);
 205             osi_dnlc_purgedp(adp);
 206         }
 207         ReleaseWriteLock(&adp->lock);
 208         ReleaseWriteLock(&afs_xvcache);
 209         if (tdc) {
 210             ReleaseWriteLock(&tdc->lock);
 211             afs_PutDCache(tdc);
 212         }
 213         goto done;
 214     }
 215     /* otherwise, we should see if we can make the change to the dir locally */
 216     if (AFS_IS_DISCON_RW || afs_LocalHero(adp, tdc, &OutDirStatus, 1)) {
 217         /* we can do it locally */
 218         ObtainWriteLock(&afs_xdcache, 293);
 219         code = afs_dir_Create(tdc, aname, &newFid.Fid);
 220         ReleaseWriteLock(&afs_xdcache);
 221         if (code && !AFS_IS_DISCON_RW) {
 222             ZapDCE(tdc);        /* surprise error -- use invalid value */
 223             DZap(tdc);
 224         }
 225     }
 226     if (tdc) {
 227         ReleaseWriteLock(&tdc->lock);
 228         afs_PutDCache(tdc);
 229     }
 230     newFid.Cell = adp->f.fid.Cell;
 231     newFid.Fid.Volume = adp->f.fid.Fid.Volume;
 232     ReleaseWriteLock(&adp->lock);
 233
 234     /* now we're done with parent dir, create the link's entry.  Note that
 235      * no one can get a pointer to the new cache entry until we release
 236      * the xvcache lock. */
 237     tvc = afs_NewVCache(&newFid, hostp);
 238     if (!tvc)
 239     {
 240         code = -2;
 241         ReleaseWriteLock(&afs_xvcache);
 242         goto done;
 243     }
 244     ObtainWriteLock(&tvc->lock, 157);
 245     ObtainWriteLock(&afs_xcbhash, 500);
 246     tvc->f.states |= CStatd;    /* have valid info */
 247     tvc->f.states &= ~CBulkFetching;
 248
 249     if (adp->f.states & CForeign) {
 250         tvc->f.states |= CForeign;
 251         /* We don't have to worry about losing the callback since we're doing it
 252          * under the afs_xvcache lock actually, afs_NewVCache may drop the
 253          * afs_xvcache lock, if it calls afs_FlushVCache */
 254         tvc->cbExpires = CallBack.ExpirationTime + now;
 255         afs_QueueCallback(tvc, CBHash(CallBack.ExpirationTime), volp);
 256     } else {
 257         tvc->cbExpires = 0x7fffffff;    /* never expires, they can't change */
 258         /* since it never expires, we don't have to queue the callback */
 259     }
 260     ReleaseWriteLock(&afs_xcbhash);
 261
 262     if (AFS_IS_DISCON_RW) {
 263 #ifdef AFS_DISCON_ENV
 264         attrs->va_mode = InStatus.UnixModeBits;
 265         afs_GenDisconStatus(adp, tvc, &newFid, attrs, &treq, VLNK);
 266         code = afs_DisconCreateSymlink(tvc, atargetName, &treq);
 267         if (code) {
 268             /* XXX - When this goes wrong, we need to tidy up the changes we made to
 269              * the parent, and get rid of the vcache we just created */
 270             ReleaseWriteLock(&tvc->lock);
 271             ReleaseWriteLock(&afs_xvcache);
 272             afs_PutVCache(tvc);
 273             goto done;
 274         }
 275         afs_DisconAddDirty(tvc, VDisconCreate, 0);
 276 #endif
 277     } else {
 278         afs_ProcessFS(tvc, &OutFidStatus, &treq);
 279     }
 280
 281     if (!tvc->linkData) {
 282         tvc->linkData = (char *)afs_osi_Alloc(alen);
 283         strncpy(tvc->linkData, atargetName, alen - 1);
 284         tvc->linkData[alen - 1] = 0;
 285     }
 286     ReleaseWriteLock(&tvc->lock);
 287     ReleaseWriteLock(&afs_xvcache);
 288     afs_PutVCache(tvc);
 289     code = 0;
 290   done:
 291     afs_PutFakeStat(&fakestate);
 292     if (volp)
 293         afs_PutVolume(volp, READ_LOCK);
 294     AFS_DISCON_UNLOCK();
 295     code = afs_CheckCode(code, &treq, 31);
 296   done2:
 297     return code;
 298 }
 299
 300 int
 301 afs_MemHandleLink(register struct vcache *avc, struct vrequest *areq)
 302 {
 303     register struct dcache *tdc;
 304     register char *tp, *rbuf;
 305     afs_size_t offset, len;
 306     afs_int32 tlen, alen;
 307     register afs_int32 code;
 308
 309     AFS_STATCNT(afs_MemHandleLink);
 310     /* two different formats, one for links protected 644, have a "." at
 311      * the end of the file name, which we turn into a null.  Others,
 312      * protected 755, we add a null to the end of */
 313     if (!avc->linkData) {
 314         void *addr;
 315         tdc = afs_GetDCache(avc, (afs_size_t) 0, areq, &offset, &len, 0);
 316         if (!tdc) {
 317             return EIO;
 318         }
 319         /* otherwise we have the data loaded, go for it */
 320         if (len > 1024) {
 321             afs_PutDCache(tdc);
 322             return EFAULT;
 323         }
 324         if (avc->f.m.Mode & 0111)
 325             alen = len + 1;     /* regular link */
 326         else
 327             alen = len;         /* mt point */
 328         rbuf = (char *)osi_AllocLargeSpace(AFS_LRALLOCSIZ);
 329         ObtainReadLock(&tdc->lock);
 330         addr = afs_MemCacheOpen(&tdc->f.inode);
 331         tlen = len;
 332         code = afs_MemReadBlk(addr, 0, rbuf, tlen);
 333         afs_MemCacheClose(addr);
 334         ReleaseReadLock(&tdc->lock);
 335         afs_PutDCache(tdc);
 336         rbuf[alen - 1] = 0;
 337         alen = strlen(rbuf) + 1;
 338         tp = afs_osi_Alloc(alen);       /* make room for terminating null */
 339         memcpy(tp, rbuf, alen);
 340         osi_FreeLargeSpace(rbuf);
 341         if (code != len) {
 342             afs_osi_Free(tp, alen);
 343             return EIO;
 344         }
 345         avc->linkData = tp;
 346     }
 347     return 0;
 348 }
 349
 350 int
 351 afs_UFSHandleLink(register struct vcache *avc, struct vrequest *areq)
 352 {
 353     register struct dcache *tdc;
 354     register char *tp, *rbuf;
 355     void *tfile;
 356     afs_size_t offset, len;
 357     afs_int32 tlen, alen;
 358     register afs_int32 code;
 359
 360     /* two different formats, one for links protected 644, have a "." at the
 361      * end of the file name, which we turn into a null.  Others, protected
 362      * 755, we add a null to the end of */
 363     AFS_STATCNT(afs_UFSHandleLink);
 364     if (!avc->linkData) {
 365         tdc = afs_GetDCache(avc, (afs_size_t) 0, areq, &offset, &len, 0);
 366         afs_Trace3(afs_iclSetp, CM_TRACE_UFSLINK, ICL_TYPE_POINTER, avc,
 367                    ICL_TYPE_POINTER, tdc, ICL_TYPE_OFFSET,
 368                    ICL_HANDLE_OFFSET(avc->f.m.Length));
 369         if (!tdc) {
 370             if (AFS_IS_DISCONNECTED)
 371                 return ENETDOWN;
 372             else
 373                 return EIO;
 374         }
 375         /* otherwise we have the data loaded, go for it */
 376         if (len > 1024) {
 377             afs_PutDCache(tdc);
 378             return EFAULT;
 379         }
 380         if (avc->f.m.Mode & 0111)
 381             alen = len + 1;     /* regular link */
 382         else
 383             alen = len;         /* mt point */
 384         rbuf = (char *)osi_AllocLargeSpace(AFS_LRALLOCSIZ);
 385         tlen = len;
 386         ObtainReadLock(&tdc->lock);
 387         tfile = osi_UFSOpen(&tdc->f.inode);
 388         code = afs_osi_Read(tfile, -1, rbuf, tlen);
 389         osi_UFSClose(tfile);
 390         ReleaseReadLock(&tdc->lock);
 391         afs_PutDCache(tdc);
 392         rbuf[alen - 1] = '\0';
 393         alen = strlen(rbuf) + 1;
 394         tp = afs_osi_Alloc(alen);       /* make room for terminating null */
 395         memcpy(tp, rbuf, alen);
 396         osi_FreeLargeSpace(rbuf);
 397         if (code != tlen) {
 398             afs_osi_Free(tp, alen);
 399             return EIO;
 400         }
 401         avc->linkData = tp;
 402     }
 403     return 0;
 404 }
 405
 406 int
 407 afs_readlink(OSI_VC_DECL(avc), struct uio *auio, AFS_UCRED *acred)
 408 {
 409     register afs_int32 code;
 410     struct vrequest treq;
 411     register char *tp;
 412     struct afs_fakestat_state fakestat;
 413     OSI_VC_CONVERT(avc);
 414
 415     AFS_STATCNT(afs_readlink);
 416     afs_Trace1(afs_iclSetp, CM_TRACE_READLINK, ICL_TYPE_POINTER, avc);
 417     if ((code = afs_InitReq(&treq, acred)))
 418         return code;
 419     afs_InitFakeStat(&fakestat);
 420
 421     AFS_DISCON_LOCK();
 422
 423     code = afs_EvalFakeStat(&avc, &fakestat, &treq);
 424     if (code)
 425         goto done;
 426     code = afs_VerifyVCache(avc, &treq);
 427     if (code)
 428         goto done;
 429     if (vType(avc) != VLNK) {
 430         code = EINVAL;
 431         goto done;
 432     }
 433     ObtainWriteLock(&avc->lock, 158);
 434     code = afs_HandleLink(avc, &treq);
 435     /* finally uiomove it to user-land */
 436     if (code == 0) {
 437         tp = avc->linkData;
 438         if (tp)
 439             AFS_UIOMOVE(tp, strlen(tp), UIO_READ, auio, code);
 440         else {
 441             code = EIO;
 442         }
 443     }
 444     ReleaseWriteLock(&avc->lock);
 445   done:
 446     afs_PutFakeStat(&fakestat);
 447     AFS_DISCON_UNLOCK();
 448     code = afs_CheckCode(code, &treq, 32);
 449     return code;
 450 }