src/WINNT/afsd/cm_vnodeops.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 #include <afsconfig.h>
  11 #include <afs/param.h>
  12 #include <roken.h>
  13
  14 #include <afs/stds.h>
  15
  16 #include <windows.h>
  17 #include <winsock2.h>
  18 #include <stddef.h>
  19 #include <malloc.h>
  20 #include <string.h>
  21 #include <stdlib.h>
  22 #include <errno.h>
  23
  24 #include <osi.h>
  25
  26 #include "afsd.h"
  27 #include "smb.h"
  28 #include "cm_btree.h"
  29
  30 #include <strsafe.h>
  31
  32 #ifdef DEBUG
  33 extern void afsi_log(char *pattern, ...);
  34 #endif
  35
  36 int cm_enableServerLocks = 1;
  37
  38 int cm_followBackupPath = 0;
  39
  40 /*
  41  * Case-folding array.  This was constructed by inspecting of SMBtrace output.
  42  * I do not know anything more about it.
  43  */
  44 unsigned char cm_foldUpper[256] = {
  45      0x0,  0x1,  0x2,  0x3,  0x4,  0x5,  0x6,  0x7,
  46      0x8,  0x9,  0xa,  0xb,  0xc,  0xd,  0xe,  0xf,
  47     0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17,
  48     0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f,
  49     0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27,
  50     0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d, 0x2e, 0x2f,
  51     0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37,
  52     0x38, 0x39, 0x3a, 0x3b, 0x3c, 0x3d, 0x3e, 0x3f,
  53     0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47,
  54     0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f,
  55     0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57,
  56     0x58, 0x59, 0x5a, 0x5b, 0x5c, 0x5d, 0x5e, 0x5f,
  57     0x60, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47,
  58     0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f,
  59     0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57,
  60     0x58, 0x59, 0x5a, 0x7b, 0x7c, 0x7d, 0x7e, 0x7f,
  61     0x80, 0x9a, 0x90, 0x41, 0x8e, 0x41, 0x8f, 0x80,
  62     0x45, 0x45, 0x45, 0x49, 0x49, 0x49, 0x8e, 0x8f,
  63     0x90, 0x92, 0x92, 0x4f, 0x99, 0x4f, 0x55, 0x55,
  64     0x59, 0x99, 0x9a, 0x9b, 0x9c, 0x9d, 0x9e, 0x9f,
  65     0x41, 0x49, 0x4f, 0x55, 0xa5, 0xa5, 0x56, 0xa7,
  66     0xa8, 0xa9, 0xaa, 0xab, 0xac, 0xad, 0xae, 0xaf,
  67     0xb0, 0xb1, 0xb2, 0xb3, 0xb4, 0xb5, 0xb6, 0xb7,
  68     0xb8, 0xb9, 0xba, 0xbb, 0xbc, 0xbd, 0xbe, 0xbf,
  69     0xc0, 0xc1, 0xc2, 0xc3, 0xc4, 0xc5, 0xc6, 0xc7,
  70     0xc8, 0xc9, 0xca, 0xcb, 0xcc, 0xcd, 0xce, 0xcf,
  71     0xd0, 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7,
  72     0xd8, 0xd9, 0xda, 0xdb, 0xdc, 0xdd, 0xde, 0xdf,
  73     0xe0, 0xe1, 0xe2, 0xe3, 0xe4, 0xe5, 0xe6, 0xe7,
  74     0xe8, 0xe9, 0xea, 0xeb, 0xec, 0xed, 0xee, 0xef,
  75     0xf0, 0xf1, 0xf2, 0xf3, 0xf4, 0xf5, 0xf6, 0xf7,
  76     0xf8, 0xf9, 0xfa, 0xfb, 0xfc, 0xfd, 0xfe, 0xff
  77 };
  78
  79 /*
  80  * Case-insensitive string comparison.  We used to use stricmp, but it doesn't
  81  * know about 8-bit characters (e.g. 129 is lowercase u-umlaut, 154 is
  82  * upper-case u-umlaut).
  83  */
  84 int cm_stricmp(const char *str1, const char *str2)
  85 {
  86     char c1, c2;
  87
  88     while (1) {
  89         if (*str1 == 0)
  90             if (*str2 == 0)
  91                 return 0;
  92             else
  93                 return -1;
  94         if (*str2 == 0)
  95             return 1;
  96         c1 = (char) cm_foldUpper[(unsigned char)(*str1++)];
  97         c2 = (char) cm_foldUpper[(unsigned char)(*str2++)];
  98         if (c1 < c2)
  99             return -1;
 100         if (c1 > c2)
 101             return 1;
 102     }
 103 }
 104
 105
 106
 107 /* return success if we can open this file in this mode */
 108 long cm_CheckOpen(cm_scache_t *scp, int openMode, int trunc, cm_user_t *userp,
 109                   cm_req_t *reqp)
 110 {
 111     long rights;
 112     long code;
 113
 114     rights = 0;
 115     if (openMode != 1)
 116         rights |= PRSFS_READ;
 117     if (openMode == 1 || openMode == 2 || trunc)
 118         rights |= PRSFS_WRITE;
 119
 120     lock_ObtainWrite(&scp->rw);
 121
 122     code = cm_SyncOp(scp, NULL, userp, reqp, rights,
 123                       CM_SCACHESYNC_GETSTATUS
 124                      | CM_SCACHESYNC_NEEDCALLBACK
 125                      | CM_SCACHESYNC_LOCK);
 126
 127     if (code == 0 &&
 128         ((rights & PRSFS_WRITE) || (rights & PRSFS_READ)) &&
 129         scp->fileType == CM_SCACHETYPE_FILE) {
 130
 131         cm_key_t key;
 132         unsigned int sLockType;
 133         LARGE_INTEGER LOffset, LLength;
 134
 135         /* Check if there's some sort of lock on the file at the
 136            moment. */
 137
 138         key = cm_GenerateKey(CM_SESSION_CMINT,0,0);
 139
 140         if (rights & PRSFS_WRITE)
 141             sLockType = 0;
 142         else
 143             sLockType = LOCKING_ANDX_SHARED_LOCK;
 144
 145         LOffset.HighPart = CM_FLSHARE_OFFSET_HIGH;
 146         LOffset.LowPart  = CM_FLSHARE_OFFSET_LOW;
 147         LLength.HighPart = CM_FLSHARE_LENGTH_HIGH;
 148         LLength.LowPart  = CM_FLSHARE_LENGTH_LOW;
 149
 150         code = cm_Lock(scp, sLockType, LOffset, LLength, key, 0, userp, reqp, NULL);
 151
 152         if (code == 0) {
 153             cm_Unlock(scp, sLockType, LOffset, LLength, key, 0, userp, reqp);
 154         } else {
 155             /* In this case, we allow the file open to go through even
 156                though we can't enforce mandatory locking on the
 157                file. */
 158             if (code == CM_ERROR_NOACCESS &&
 159                 !(rights & PRSFS_WRITE))
 160                 code = 0;
 161             else {
 162                 if (code == CM_ERROR_LOCK_NOT_GRANTED)
 163                     code = CM_ERROR_SHARING_VIOLATION;
 164             }
 165         }
 166
 167     } else if (code != 0) {
 168         goto _done;
 169     }
 170
 171     cm_SyncOpDone(scp, NULL, CM_SCACHESYNC_LOCK);
 172
 173  _done:
 174
 175     lock_ReleaseWrite(&scp->rw);
 176
 177     return code;
 178 }
 179
 180 /* return success if we can open this file in this mode */
 181 long cm_CheckNTOpen(cm_scache_t *scp,
 182                     unsigned int desiredAccess,
 183                     unsigned int shareAccess,
 184                     unsigned int createDisp,
 185                     afs_offs_t process_id,
 186                     afs_offs_t handle_id,
 187                     cm_user_t *userp, cm_req_t *reqp,
 188                     cm_lock_data_t **ldpp)
 189 {
 190     long rights;
 191     long code = 0;
 192     afs_uint16 session_id;
 193
 194     osi_assertx(ldpp != NULL, "null cm_lock_data_t");
 195     *ldpp = NULL;
 196
 197     /* compute the session id */
 198     if (reqp->flags & CM_REQ_SOURCE_SMB)
 199         session_id = CM_SESSION_SMB;
 200     else if (reqp->flags & CM_REQ_SOURCE_REDIR)
 201         session_id = CM_SESSION_IFS;
 202     else
 203         session_id = CM_SESSION_CMINT;
 204
 205     /* Ignore the SYNCHRONIZE privilege */
 206     desiredAccess &= ~SYNCHRONIZE;
 207
 208     /* Always allow delete; the RPC will tell us if it's OK */
 209     rights = 0;
 210
 211     if (desiredAccess == DELETE)
 212         goto done_2;
 213
 214     /* Always allow reading attributes (Hidden, System, Readonly, ...) */
 215     if (desiredAccess == FILE_READ_ATTRIBUTES)
 216         goto done_2;
 217
 218     if (desiredAccess & (AFS_ACCESS_READ|AFS_ACCESS_EXECUTE))
 219         rights |= (scp->fileType == CM_SCACHETYPE_DIRECTORY ? PRSFS_LOOKUP : PRSFS_READ);
 220
 221     /* We used to require PRSFS_WRITE if createDisp was 4
 222        (OPEN_ALWAYS) even if AFS_ACCESS_WRITE was not requested.
 223        However, we don't need to do that since the existence of the
 224        scp implies that we don't need to create it. */
 225     if (desiredAccess & AFS_ACCESS_WRITE)
 226         rights |= PRSFS_WRITE;
 227
 228     if (desiredAccess & DELETE)
 229         rights |= PRSFS_DELETE;
 230
 231     lock_ObtainWrite(&scp->rw);
 232
 233     code = cm_SyncOp(scp, NULL, userp, reqp, rights,
 234                       CM_SCACHESYNC_GETSTATUS
 235                      | CM_SCACHESYNC_NEEDCALLBACK
 236                      | CM_SCACHESYNC_LOCK);
 237
 238     /*
 239      * If the open will fail because the volume is readonly, then we will
 240      * return an access denied error instead.  This is to help brain-dead
 241      * apps run correctly on replicated volumes.
 242      * See defect 10007 for more information.
 243      */
 244     if (code == CM_ERROR_READONLY)
 245         code = CM_ERROR_NOACCESS;
 246
 247     if (code == 0 &&
 248         !(shareAccess & FILE_SHARE_WRITE) &&
 249         ((rights & PRSFS_WRITE) || (rights & PRSFS_READ)) &&
 250         scp->fileType == CM_SCACHETYPE_FILE) {
 251         cm_key_t key;
 252         unsigned int sLockType;
 253         LARGE_INTEGER LOffset, LLength;
 254
 255         /* Check if there's some sort of lock on the file at the
 256            moment. */
 257
 258         if (rights & PRSFS_WRITE)
 259             sLockType = 0;
 260         else
 261             sLockType = LOCKING_ANDX_SHARED_LOCK;
 262
 263         key = cm_GenerateKey(session_id, process_id, 0);
 264
 265         /* single byte lock at offset 0x0100 0000 0000 0000 */
 266         LOffset.HighPart = CM_FLSHARE_OFFSET_HIGH;
 267         LOffset.LowPart  = CM_FLSHARE_OFFSET_LOW;
 268         LLength.HighPart = CM_FLSHARE_LENGTH_HIGH;
 269         LLength.LowPart  = CM_FLSHARE_LENGTH_LOW;
 270
 271         code = cm_Lock(scp, sLockType, LOffset, LLength, key, 0, userp, reqp, NULL);
 272
 273         if (code == 0) {
 274             (*ldpp) = (cm_lock_data_t *)malloc(sizeof(cm_lock_data_t));
 275             if (!*ldpp) {
 276                 code = ENOMEM;
 277                 goto _done;
 278             }
 279
 280             (*ldpp)->key = key;
 281             (*ldpp)->sLockType = sLockType;
 282             (*ldpp)->LOffset.HighPart = LOffset.HighPart;
 283             (*ldpp)->LOffset.LowPart = LOffset.LowPart;
 284             (*ldpp)->LLength.HighPart = LLength.HighPart;
 285             (*ldpp)->LLength.LowPart = LLength.LowPart;
 286         } else {
 287             /*
 288              * In this case, we allow the file open to go through even
 289              * though we can't enforce mandatory locking on the
 290              * file. */
 291             if (code == CM_ERROR_NOACCESS &&
 292                  !(rights & PRSFS_WRITE))
 293                 code = 0;
 294             else {
 295                 if (code == CM_ERROR_LOCK_NOT_GRANTED)
 296                     code = CM_ERROR_SHARING_VIOLATION;
 297             }
 298         }
 299     } else if (code != 0) {
 300         goto _done;
 301     }
 302
 303  _done:
 304     lock_ReleaseWrite(&scp->rw);
 305
 306  done_2:
 307     osi_Log3(afsd_logp,"cm_CheckNTOpen scp 0x%p ldp 0x%p code 0x%x", scp, *ldpp, code);
 308     return code;
 309 }
 310
 311 extern long cm_CheckNTOpenDone(cm_scache_t *scp, cm_user_t *userp, cm_req_t *reqp,
 312                                cm_lock_data_t ** ldpp)
 313 {
 314         osi_Log2(afsd_logp,"cm_CheckNTOpenDone scp 0x%p ldp 0x%p", scp, ldpp ? *ldpp : 0);
 315     lock_ObtainWrite(&scp->rw);
 316     if (ldpp && *ldpp) {
 317         cm_Unlock(scp, (*ldpp)->sLockType, (*ldpp)->LOffset, (*ldpp)->LLength,
 318                   (*ldpp)->key, 0, userp, reqp);
 319         free(*ldpp);
 320         *ldpp = NULL;
 321     }
 322     cm_SyncOpDone(scp, NULL, CM_SCACHESYNC_LOCK);
 323     lock_ReleaseWrite(&scp->rw);
 324     return 0;
 325 }
 326 /*
 327  * When CAP_NT_SMBS has been negotiated, deletion (of files or directories) is
 328  * done in three steps:
 329  * (1) open for deletion (NT_CREATE_AND_X)
 330  * (2) set for deletion on close (NT_TRANSACTION2, SET_FILE_INFO)
 331  * (3) close (CLOSE)
 332  * We must not do the RPC until step 3.  But if we are going to return an error
 333  * code (e.g. directory not empty), we must return it by step 2, otherwise most
 334  * clients will not notice it.  So we do a preliminary check.  For deleting
 335  * files, this is almost free, since we have already done the RPC to get the
 336  * parent directory's status bits.  But for deleting directories, we must do an
 337  * additional RPC to get the directory's data to check if it is empty.  Sigh.
 338  */
 339 long cm_CheckNTDelete(cm_scache_t *dscp, cm_scache_t *scp, cm_user_t *userp,
 340         cm_req_t *reqp)
 341 {
 342     long code;
 343     osi_hyper_t thyper;
 344     cm_buf_t *bufferp;
 345     cm_dirEntry_t *dep = 0;
 346     unsigned short *hashTable;
 347     unsigned int i, idx;
 348     int BeyondPage = 0, HaveDot = 0, HaveDotDot = 0;
 349     int releaseLock = 0;
 350
 351     /* First check permissions */
 352     lock_ObtainWrite(&scp->rw);
 353     code = cm_SyncOp(scp, NULL, userp, reqp, PRSFS_DELETE,
 354                       CM_SCACHESYNC_GETSTATUS | CM_SCACHESYNC_NEEDCALLBACK);
 355     if (!code)
 356         cm_SyncOpDone(scp, NULL, CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS);
 357     lock_ReleaseWrite(&scp->rw);
 358     if (code)
 359         return code;
 360
 361     /* If deleting directory, must be empty */
 362
 363     if (scp->fileType != CM_SCACHETYPE_DIRECTORY)
 364         return code;
 365
 366     thyper.HighPart = 0; thyper.LowPart = 0;
 367     code = buf_Get(scp, &thyper, reqp, &bufferp);
 368     if (code)
 369         return code;
 370
 371     lock_ObtainMutex(&bufferp->mx);
 372     lock_ObtainWrite(&scp->rw);
 373     releaseLock = 1;
 374     while (1) {
 375         code = cm_SyncOp(scp, bufferp, userp, reqp, 0,
 376                           CM_SCACHESYNC_NEEDCALLBACK
 377                           | CM_SCACHESYNC_READ
 378                           | CM_SCACHESYNC_BUFLOCKED);
 379         if (code)
 380             goto done;
 381
 382         if (cm_HaveBuffer(scp, bufferp, 1))
 383             break;
 384
 385         /* otherwise, load the buffer and try again */
 386         lock_ReleaseMutex(&bufferp->mx);
 387         code = cm_GetBuffer(scp, bufferp, NULL, userp, reqp);
 388         lock_ReleaseWrite(&scp->rw);
 389         lock_ObtainMutex(&bufferp->mx);
 390         lock_ObtainWrite(&scp->rw);
 391         cm_SyncOpDone(scp, bufferp, CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_READ | CM_SCACHESYNC_BUFLOCKED);
 392         if (code)
 393             goto done;
 394     }
 395
 396     lock_ReleaseWrite(&scp->rw);
 397     releaseLock = 0;
 398
 399     /* We try to determine emptiness without looking beyond the first page,
 400      * and without assuming "." and ".." are present and are on the first
 401      * page (though these assumptions might, after all, be reasonable).
 402      */
 403     hashTable = (unsigned short *)(bufferp->datap + (32 * 5));
 404     for (i=0; i<128; i++) {
 405         idx = ntohs(hashTable[i]);
 406         while (idx) {
 407             if (idx >= 64) {
 408                 BeyondPage = 1;
 409                 break;
 410             }
 411             dep = (cm_dirEntry_t *)(bufferp->datap + (32 * idx));
 412             if (strcmp(dep->name, ".") == 0)
 413                 HaveDot = 1;
 414             else if (strcmp(dep->name, "..") == 0)
 415                 HaveDotDot = 1;
 416             else {
 417                 code = CM_ERROR_NOTEMPTY;
 418                 goto done;
 419             }
 420             idx = ntohs(dep->next);
 421         }
 422     }
 423     if (BeyondPage && HaveDot && HaveDotDot)
 424         code = CM_ERROR_NOTEMPTY;
 425     else
 426         code = 0;
 427   done:
 428     lock_ReleaseMutex(&bufferp->mx);
 429     buf_Release(bufferp);
 430     if (releaseLock)
 431         lock_ReleaseWrite(&scp->rw);
 432     return code;
 433 }
 434
 435 /*
 436  * Iterate through all entries in a directory.
 437  * When the function funcp is called, the buffer is locked but the
 438  * directory vnode is not.
 439  *
 440  * If the retscp parameter is not NULL, the parmp must be a
 441  * cm_lookupSearch_t object.
 442  */
 443 long cm_ApplyDir(cm_scache_t *scp, cm_DirFuncp_t funcp, void *parmp,
 444                  osi_hyper_t *startOffsetp, cm_user_t *userp, cm_req_t *reqp,
 445                  cm_scache_t **retscp)
 446 {
 447     char *tp;
 448     long code;
 449     cm_dirEntry_t *dep = 0;
 450     cm_buf_t *bufferp;
 451     long temp;
 452     osi_hyper_t dirLength;
 453     osi_hyper_t bufferOffset;
 454     osi_hyper_t curOffset;
 455     osi_hyper_t thyper;
 456     long entryInDir;
 457     long entryInBuffer;
 458     cm_pageHeader_t *pageHeaderp;
 459     int slotInPage;
 460     long nextEntryCookie;
 461     int numDirChunks;   /* # of 32 byte dir chunks in this entry */
 462
 463     /* get the directory size */
 464     lock_ObtainWrite(&scp->rw);
 465     code = cm_SyncOp(scp, NULL, userp, reqp, PRSFS_LOOKUP,
 466                       CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS);
 467     lock_ReleaseWrite(&scp->rw);
 468     if (code)
 469         return code;
 470
 471     if (scp->fileType != CM_SCACHETYPE_DIRECTORY)
 472         return CM_ERROR_NOTDIR;
 473
 474     if (retscp)                         /* if this is a lookup call */
 475     {
 476         cm_lookupSearch_t*      sp = parmp;
 477
 478         if (
 479 #ifdef AFS_FREELANCE_CLIENT
 480         /* Freelance entries never end up in the DNLC because they
 481          * do not have an associated cm_server_t
 482          */
 483             !(cm_freelanceEnabled &&
 484             sp->fid.cell==AFS_FAKE_ROOT_CELL_ID &&
 485               sp->fid.volume==AFS_FAKE_ROOT_VOL_ID )
 486 #else /* !AFS_FREELANCE_CLIENT */
 487             TRUE
 488 #endif
 489             )
 490         {
 491             int casefold = sp->caseFold;
 492             sp->caseFold = 0; /* we have a strong preference for exact matches */
 493             if ( *retscp = cm_dnlcLookup(scp, sp))      /* dnlc hit */
 494             {
 495                 sp->caseFold = casefold;
 496                 return 0;
 497             }
 498             sp->caseFold = casefold;
 499         }
 500
 501         /*
 502          * see if we can find it using the directory hash tables.
 503          * we can only do exact matches, since the hash is case
 504          * sensitive.
 505          */
 506         if (funcp != (cm_DirFuncp_t)cm_BPlusDirFoo)
 507         {
 508             cm_dirOp_t dirop;
 509 #ifdef USE_BPLUS
 510             int usedBplus = 0;
 511 #endif
 512
 513             code = ENOENT;
 514
 515             code = cm_BeginDirOp(scp, userp, reqp, CM_DIRLOCK_READ,
 516                                  CM_DIROP_FLAG_NONE, &dirop);
 517             if (code == 0) {
 518
 519 #ifdef USE_BPLUS
 520                 code = cm_BPlusDirLookup(&dirop, sp->nsearchNamep, &sp->fid);
 521                 if (code != EINVAL)
 522                     usedBplus = 1;
 523                 else
 524 #endif
 525                     code = cm_DirLookup(&dirop, sp->searchNamep, &sp->fid);
 526
 527                 cm_EndDirOp(&dirop);
 528             }
 529
 530             if (code == 0) {
 531                 /* found it */
 532                 sp->found = TRUE;
 533                 sp->ExactFound = TRUE;
 534                 *retscp = NULL; /* force caller to call cm_GetSCache() */
 535                 return 0;
 536             }
 537 #ifdef USE_BPLUS
 538             if (usedBplus) {
 539                 if (sp->caseFold && code == CM_ERROR_INEXACT_MATCH) {
 540                     /* found it */
 541                     sp->found = TRUE;
 542                     sp->ExactFound = FALSE;
 543                     *retscp = NULL; /* force caller to call cm_GetSCache() */
 544                     return 0;
 545                 }
 546
 547                 return CM_ERROR_BPLUS_NOMATCH;
 548             }
 549 #endif
 550         }
 551     }
 552
 553     /*
 554      * XXX We only get the length once.  It might change when we drop the
 555      * lock.
 556      */
 557     dirLength = scp->length;
 558
 559     bufferp = NULL;
 560     bufferOffset.LowPart = bufferOffset.HighPart = 0;
 561     if (startOffsetp)
 562         curOffset = *startOffsetp;
 563     else {
 564         curOffset.HighPart = 0;
 565         curOffset.LowPart = 0;
 566     }
 567
 568     while (1) {
 569         /* make sure that curOffset.LowPart doesn't point to the first
 570          * 32 bytes in the 2nd through last dir page, and that it
 571          * doesn't point at the first 13 32-byte chunks in the first
 572          * dir page, since those are dir and page headers, and don't
 573          * contain useful information.
 574          */
 575         temp = curOffset.LowPart & (2048-1);
 576         if (curOffset.HighPart == 0 && curOffset.LowPart < 2048) {
 577             /* we're in the first page */
 578             if (temp < 13*32) temp = 13*32;
 579         }
 580         else {
 581             /* we're in a later dir page */
 582             if (temp < 32) temp = 32;
 583         }
 584
 585         /* make sure the low order 5 bits are zero */
 586         temp &= ~(32-1);
 587
 588         /* now put temp bits back ito curOffset.LowPart */
 589         curOffset.LowPart &= ~(2048-1);
 590         curOffset.LowPart |= temp;
 591
 592         /* check if we've passed the dir's EOF */
 593         if (LargeIntegerGreaterThanOrEqualTo(curOffset, dirLength))
 594             break;
 595
 596         /* see if we can use the bufferp we have now; compute in which
 597          * page the current offset would be, and check whether that's
 598          * the offset of the buffer we have.  If not, get the buffer.
 599          */
 600         thyper.HighPart = curOffset.HighPart;
 601         thyper.LowPart = curOffset.LowPart & ~(cm_data.buf_blockSize-1);
 602         if (!bufferp || !LargeIntegerEqualTo(thyper, bufferOffset)) {
 603             /* wrong buffer */
 604             if (bufferp) {
 605                 lock_ReleaseMutex(&bufferp->mx);
 606                 buf_Release(bufferp);
 607                 bufferp = NULL;
 608             }
 609
 610             code = buf_Get(scp, &thyper, reqp, &bufferp);
 611             if (code) {
 612                 /* if buf_Get() fails we do not have a buffer object to lock */
 613                 bufferp = NULL;
 614                 break;
 615             }
 616
 617             lock_ObtainMutex(&bufferp->mx);
 618             bufferOffset = thyper;
 619
 620             /* now get the data in the cache */
 621             while (1) {
 622                 lock_ObtainWrite(&scp->rw);
 623                 code = cm_SyncOp(scp, bufferp, userp, reqp,
 624                                   PRSFS_LOOKUP,
 625                                   CM_SCACHESYNC_NEEDCALLBACK
 626                                   | CM_SCACHESYNC_READ
 627                                   | CM_SCACHESYNC_BUFLOCKED);
 628                 if (code) {
 629                     lock_ReleaseWrite(&scp->rw);
 630                     break;
 631                 }
 632                 cm_SyncOpDone(scp, bufferp, CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_READ | CM_SCACHESYNC_BUFLOCKED);
 633
 634                 if (cm_HaveBuffer(scp, bufferp, 1)) {
 635                     lock_ReleaseWrite(&scp->rw);
 636                     break;
 637                 }
 638
 639                 /* otherwise, load the buffer and try again */
 640                 lock_ReleaseMutex(&bufferp->mx);
 641                 code = cm_GetBuffer(scp, bufferp, NULL, userp,
 642                                     reqp);
 643                 lock_ReleaseWrite(&scp->rw);
 644                 lock_ObtainMutex(&bufferp->mx);
 645                 if (code)
 646                     break;
 647             }
 648             if (code) {
 649                 lock_ReleaseMutex(&bufferp->mx);
 650                 buf_Release(bufferp);
 651                 bufferp = NULL;
 652                 break;
 653             }
 654         }       /* if (wrong buffer) ... */
 655
 656         /* now we have the buffer containing the entry we're interested
 657          * in; copy it out if it represents a non-deleted entry.
 658          */
 659         entryInDir = curOffset.LowPart & (2048-1);
 660         entryInBuffer = curOffset.LowPart & (cm_data.buf_blockSize - 1);
 661
 662         /* page header will help tell us which entries are free.  Page
 663          * header can change more often than once per buffer, since
 664          * AFS 3 dir page size may be less than (but not more than) a
 665          * buffer package buffer.
 666          */
 667         /* only look intra-buffer */
 668         temp = curOffset.LowPart & (cm_data.buf_blockSize - 1);
 669         temp &= ~(2048 - 1);    /* turn off intra-page bits */
 670         pageHeaderp = (cm_pageHeader_t *) (bufferp->datap + temp);
 671
 672         /* now determine which entry we're looking at in the page.  If
 673          * it is free (there's a free bitmap at the start of the dir),
 674          * we should skip these 32 bytes.
 675          */
 676         slotInPage = (entryInDir & 0x7e0) >> 5;
 677         if (!(pageHeaderp->freeBitmap[slotInPage>>3]
 678                & (1 << (slotInPage & 0x7)))) {
 679             /* this entry is free */
 680             numDirChunks = 1;   /* only skip this guy */
 681             goto nextEntry;
 682         }
 683
 684         tp = bufferp->datap + entryInBuffer;
 685         dep = (cm_dirEntry_t *) tp;     /* now points to AFS3 dir entry */
 686
 687         /*
 688          * here are some consistency checks
 689          */
 690         if (dep->flag != CM_DIR_FFIRST ||
 691             strlen(dep->name) > 256) {
 692             code = CM_ERROR_INVAL;
 693             osi_Log2(afsd_logp,
 694                      "cm_ApplyDir invalid directory entry for scp %p bufp %p",
 695                      scp, bufferp);
 696             osi_Log4(afsd_logp,"... cell %u vol %u vnode %u uniq %u",
 697                      scp->fid.cell, scp->fid.volume, scp->fid.vnode, scp->fid.unique);
 698             bufferp->dataVersion = CM_BUF_VERSION_BAD;
 699             break;
 700         }
 701
 702         /* while we're here, compute the next entry's location, too,
 703          * since we'll need it when writing out the cookie into the
 704          * dir listing stream.
 705          */
 706         numDirChunks = cm_NameEntries(dep->name, NULL);
 707
 708         /* compute the offset of the cookie representing the next entry */
 709         nextEntryCookie = curOffset.LowPart
 710             + (CM_DIR_CHUNKSIZE * numDirChunks);
 711
 712         if (dep->fid.vnode != 0) {
 713             /* this is one of the entries to use: it is not deleted */
 714             code = (*funcp)(scp, dep, parmp, &curOffset);
 715             if (code)
 716                 break;
 717         }       /* if we're including this name */
 718
 719       nextEntry:
 720         /* and adjust curOffset to be where the new cookie is */
 721         thyper.HighPart = 0;
 722         thyper.LowPart = CM_DIR_CHUNKSIZE * numDirChunks;
 723         curOffset = LargeIntegerAdd(thyper, curOffset);
 724     }           /* while copying data for dir listing */
 725
 726     /* release the mutex */
 727     if (bufferp) {
 728         lock_ReleaseMutex(&bufferp->mx);
 729         buf_Release(bufferp);
 730     }
 731     return code;
 732 }
 733
 734 int cm_NoneUpper(normchar_t *s)
 735 {
 736     normchar_t c;
 737     while (c = *s++)
 738         if (c >= 'A' && c <= 'Z')
 739             return 0;
 740     return 1;
 741 }
 742
 743 int cm_NoneLower(normchar_t *s)
 744 {
 745     normchar_t c;
 746     while (c = *s++)
 747         if (c >= 'a' && c <= 'z')
 748             return 0;
 749     return 1;
 750 }
 751
 752 long cm_LookupSearchProc(cm_scache_t *scp, cm_dirEntry_t *dep, void *rockp,
 753                          osi_hyper_t *offp)
 754 {
 755     cm_lookupSearch_t *sp;
 756     int match;
 757     normchar_t matchName[MAX_PATH];
 758     int looking_for_short_name = FALSE;
 759
 760     sp = (cm_lookupSearch_t *) rockp;
 761
 762     if (cm_FsStringToNormString(dep->name, -1, matchName, lengthof(matchName)) == 0) {
 763         /* Can't normalize FS string. */
 764         return 0;
 765     }
 766
 767     if (sp->caseFold)
 768         match = cm_NormStrCmpI(matchName, sp->nsearchNamep);
 769     else
 770         match = cm_NormStrCmp(matchName, sp->nsearchNamep);
 771
 772     if (match != 0
 773         && sp->hasTilde
 774         && !cm_Is8Dot3(matchName)) {
 775
 776         cm_Gen8Dot3NameInt(dep->name, &dep->fid, matchName, NULL);
 777         if (sp->caseFold)
 778             match = cm_NormStrCmpI(matchName, sp->nsearchNamep);
 779         else
 780             match = cm_NormStrCmp(matchName, sp->nsearchNamep);
 781         looking_for_short_name = TRUE;
 782     }
 783
 784     if (match != 0)
 785         return 0;
 786
 787     sp->found = 1;
 788     if (!sp->caseFold)
 789         sp->ExactFound = 1;
 790
 791     if (!sp->caseFold || looking_for_short_name) {
 792         cm_SetFid(&sp->fid, sp->fid.cell, sp->fid.volume, ntohl(dep->fid.vnode), ntohl(dep->fid.unique));
 793         return CM_ERROR_STOPNOW;
 794     }
 795
 796     /*
 797      * If we get here, we are doing a case-insensitive search, and we
 798      * have found a match.  Now we determine what kind of match it is:
 799      * exact, lower-case, upper-case, or none of the above.  This is done
 800      * in order to choose among matches, if there are more than one.
 801      */
 802
 803     /* Exact matches are the best. */
 804     match = cm_NormStrCmp(matchName, sp->nsearchNamep);
 805     if (match == 0) {
 806         sp->ExactFound = 1;
 807         cm_SetFid(&sp->fid, sp->fid.cell, sp->fid.volume, ntohl(dep->fid.vnode), ntohl(dep->fid.unique));
 808         return CM_ERROR_STOPNOW;
 809     }
 810
 811     /* Lower-case matches are next. */
 812     if (sp->LCfound)
 813         return 0;
 814     if (cm_NoneUpper(matchName)) {
 815         sp->LCfound = 1;
 816         goto inexact;
 817     }
 818
 819     /* Upper-case matches are next. */
 820     if (sp->UCfound)
 821         return 0;
 822     if (cm_NoneLower(matchName)) {
 823         sp->UCfound = 1;
 824         goto inexact;
 825     }
 826
 827     /* General matches are last. */
 828     if (sp->NCfound)
 829         return 0;
 830     sp->NCfound = 1;
 831
 832   inexact:
 833     cm_SetFid(&sp->fid, sp->fid.cell, sp->fid.volume, ntohl(dep->fid.vnode), ntohl(dep->fid.unique));
 834     return 0;
 835 }
 836
 837 /* read the contents of a mount point into the appropriate string.
 838  * called with write locked scp, and returns with locked scp.
 839  */
 840 long cm_ReadMountPoint(cm_scache_t *scp, cm_user_t *userp, cm_req_t *reqp)
 841 {
 842     long code;
 843
 844     if (scp->mountPointStringp[0])
 845         return 0;
 846
 847 #ifdef AFS_FREELANCE_CLIENT
 848     /* File servers do not have data for freelance entries */
 849     if (cm_freelanceEnabled &&
 850         scp->fid.cell==AFS_FAKE_ROOT_CELL_ID &&
 851         scp->fid.volume==AFS_FAKE_ROOT_VOL_ID )
 852     {
 853         code = cm_FreelanceFetchMountPointString(scp);
 854     } else
 855 #endif /* AFS_FREELANCE_CLIENT */
 856     {
 857         char temp[MOUNTPOINTLEN];
 858         osi_hyper_t offset;
 859
 860         /* otherwise, we have to read it in */
 861         offset.LowPart = offset.HighPart = 0;
 862         code = cm_GetData(scp, &offset, temp, MOUNTPOINTLEN, userp, reqp);
 863         if (code)
 864             return code;
 865
 866         /*
 867          * scp->length is the actual length of the mount point string.
 868          * It is current because cm_GetData merged the most up to date
 869          * status info into scp and has not dropped the rwlock since.
 870          */
 871         if (scp->length.LowPart > MOUNTPOINTLEN - 1)
 872             return CM_ERROR_TOOBIG;
 873         if (scp->length.LowPart == 0)
 874             return CM_ERROR_INVAL;
 875
 876         /* convert the terminating dot to a NUL */
 877         temp[scp->length.LowPart - 1] = 0;
 878         memcpy(scp->mountPointStringp, temp, scp->length.LowPart);
 879     }
 880
 881     return code;
 882 }
 883
 884
 885 /* called with a locked scp and chases the mount point, yielding outScpp.
 886  * scp remains write locked, just for simplicity of describing the interface.
 887  */
 888 long cm_FollowMountPoint(cm_scache_t *scp, cm_scache_t *dscp, cm_user_t *userp,
 889                          cm_req_t *reqp, cm_scache_t **outScpp)
 890 {
 891     fschar_t *cellNamep = NULL;
 892     fschar_t *volNamep = NULL;
 893     afs_uint32 code;
 894     fschar_t *cp;
 895     fschar_t *mpNamep;
 896     cm_volume_t *volp = NULL;
 897     cm_cell_t *cellp;
 898     fschar_t mtType;
 899     cm_fid_t tfid;
 900     size_t vnLength;
 901     int targetType;
 902
 903     *outScpp = NULL;
 904
 905     if (scp->mountRootFid.cell != 0 && scp->mountRootGen >= cm_data.mountRootGen) {
 906         tfid = scp->mountRootFid;
 907         lock_ReleaseWrite(&scp->rw);
 908         code = cm_GetSCache(&tfid, outScpp, userp, reqp);
 909         lock_ObtainWrite(&scp->rw);
 910         return code;
 911     }
 912
 913     /* parse the volume name */
 914     mpNamep = scp->mountPointStringp;
 915     if (!mpNamep[0])
 916         return CM_ERROR_NOSUCHPATH;
 917     mtType = *scp->mountPointStringp;
 918
 919     cp = cm_FsStrChr(mpNamep, _FS(':'));
 920     if (cp) {
 921         /* cellular mount point */
 922         cellNamep = (fschar_t *)malloc((cp - mpNamep) * sizeof(fschar_t));
 923         cm_FsStrCpyN(cellNamep, cp - mpNamep, mpNamep + 1, cp - mpNamep - 1);
 924         volNamep = cm_FsStrDup(cp+1);
 925
 926         /* now look up the cell */
 927         lock_ReleaseWrite(&scp->rw);
 928         cellp = cm_GetCell(cellNamep, CM_FLAG_CREATE);
 929         lock_ObtainWrite(&scp->rw);
 930     } else {
 931         /* normal mt pt */
 932         volNamep = cm_FsStrDup(mpNamep + 1);
 933
 934 #ifdef AFS_FREELANCE_CLIENT
 935         /*
 936          * Mount points in the Freelance cell should default
 937          * to the workstation cell.
 938          */
 939         if (cm_freelanceEnabled &&
 940              scp->fid.cell==AFS_FAKE_ROOT_CELL_ID &&
 941              scp->fid.volume==AFS_FAKE_ROOT_VOL_ID )
 942         {
 943             fschar_t rootCellName[256]="";
 944             cm_GetRootCellName(rootCellName);
 945             cellp = cm_GetCell(rootCellName, 0);
 946         } else
 947 #endif /* AFS_FREELANCE_CLIENT */
 948             cellp = cm_FindCellByID(scp->fid.cell, 0);
 949     }
 950
 951     if (!cellp) {
 952         code = CM_ERROR_NOSUCHCELL;
 953         goto done;
 954     }
 955
 956     vnLength = cm_FsStrLen(volNamep);
 957     if (vnLength >= 8 && cm_FsStrCmp(volNamep + vnLength - 7, ".backup") == 0)
 958         targetType = BACKVOL;
 959     else if (vnLength >= 10
 960              && cm_FsStrCmp(volNamep + vnLength - 9, ".readonly") == 0)
 961         targetType = ROVOL;
 962     else
 963         targetType = RWVOL;
 964
 965     /* check for backups within backups */
 966     if (targetType == BACKVOL
 967          && (scp->flags & (CM_SCACHEFLAG_RO | CM_SCACHEFLAG_PURERO))
 968          == CM_SCACHEFLAG_RO) {
 969         code = CM_ERROR_NOSUCHVOLUME;
 970         goto done;
 971     }
 972
 973     /* now we need to get the volume */
 974     lock_ReleaseWrite(&scp->rw);
 975     if (cm_VolNameIsID(volNamep)) {
 976         code = cm_FindVolumeByID(cellp, atoi(volNamep), userp, reqp,
 977                                 CM_GETVOL_FLAG_CREATE, &volp);
 978     } else {
 979         code = cm_FindVolumeByName(cellp, volNamep, userp, reqp,
 980                                   CM_GETVOL_FLAG_CREATE, &volp);
 981     }
 982     lock_ObtainWrite(&scp->rw);
 983
 984     if (code == 0) {
 985         afs_uint32 cell, volume;
 986         cm_vol_state_t *statep;
 987
 988         cell = cellp->cellID;
 989
 990         /* if the mt pt originates in a .backup volume (not a .readonly)
 991          * and FollowBackupPath is active, and if there is a .backup
 992          * volume for the target, then use the .backup of the target
 993          * instead of the read-write.
 994          */
 995         if (cm_followBackupPath &&
 996             volp->vol[BACKVOL].ID != 0 &&
 997             (dscp->flags & (CM_SCACHEFLAG_RO|CM_SCACHEFLAG_PURERO)) == CM_SCACHEFLAG_RO &&
 998             (targetType == RWVOL || targetType == ROVOL && volp->vol[ROVOL].ID == 0)
 999             ) {
1000             targetType = BACKVOL;
1001         }
1002         /* if the mt pt is in a read-only volume (not just a
1003          * backup), and if there is a read-only volume for the
1004          * target, and if this is a targetType '#' mount point, use
1005          * the read-only, otherwise use the one specified.
1006          */
1007         else if (mtType == '#' && targetType == RWVOL &&
1008                  (scp->flags & CM_SCACHEFLAG_PURERO) &&
1009                  volp->vol[ROVOL].ID != 0) {
1010             targetType = ROVOL;
1011         }
1012
1013         lock_ObtainWrite(&volp->rw);
1014         statep = cm_VolumeStateByType(volp, targetType);
1015         volume = statep->ID;
1016         statep->dotdotFid = dscp->fid;
1017         lock_ReleaseWrite(&volp->rw);
1018
1019         /* the rest of the fid is a magic number */
1020         cm_SetFid(&scp->mountRootFid, cell, volume, 1, 1);
1021         scp->mountRootGen = cm_data.mountRootGen;
1022
1023         tfid = scp->mountRootFid;
1024         lock_ReleaseWrite(&scp->rw);
1025         code = cm_GetSCache(&tfid, outScpp, userp, reqp);
1026         lock_ObtainWrite(&scp->rw);
1027     }
1028
1029   done:
1030     if (volp)
1031         cm_PutVolume(volp);
1032     if (cellNamep)
1033         free(cellNamep);
1034     if (volNamep)
1035         free(volNamep);
1036     return code;
1037 }
1038
1039 long cm_LookupInternal(cm_scache_t *dscp, clientchar_t *cnamep, long flags, cm_user_t *userp,
1040                        cm_req_t *reqp, cm_scache_t **outScpp)
1041 {
1042     long code;
1043     int dnlcHit = 1;    /* did we hit in the dnlc? yes, we did */
1044     cm_scache_t *tscp = NULL;
1045     cm_scache_t *mountedScp;
1046     cm_lookupSearch_t rock;
1047     int getroot;
1048     normchar_t *nnamep = NULL;
1049     fschar_t *fnamep = NULL;
1050     size_t fnlen;
1051
1052     *outScpp = NULL;
1053
1054     memset(&rock, 0, sizeof(rock));
1055
1056     if (dscp->fid.vnode == 1 && dscp->fid.unique == 1
1057         && cm_ClientStrCmp(cnamep, _C("..")) == 0) {
1058         if (dscp->dotdotFid.volume == 0)
1059             return CM_ERROR_NOSUCHVOLUME;
1060         rock.fid = dscp->dotdotFid;
1061         goto haveFid;
1062     } else if (cm_ClientStrCmp(cnamep, _C(".")) == 0) {
1063         rock.fid = dscp->fid;
1064         goto haveFid;
1065     }
1066
1067     nnamep = cm_ClientStringToNormStringAlloc(cnamep, -1, NULL);
1068     if (!nnamep) {
1069         code = CM_ERROR_NOSUCHFILE;
1070         goto done;
1071     }
1072     fnamep = cm_ClientStringToFsStringAlloc(cnamep, -1, NULL);
1073     if (!fnamep) {
1074         code = CM_ERROR_NOSUCHFILE;
1075         goto done;
1076     }
1077
1078 retry_lookup:
1079     if (flags & CM_FLAG_NOMOUNTCHASE) {
1080         /* In this case, we should go and call cm_Dir* functions
1081            directly since the following cm_ApplyDir() function will
1082            not. */
1083
1084         cm_dirOp_t dirop;
1085 #ifdef USE_BPLUS
1086         int usedBplus = 0;
1087 #endif
1088
1089         code = cm_BeginDirOp(dscp, userp, reqp, CM_DIRLOCK_READ,
1090                              CM_DIROP_FLAG_NONE, &dirop);
1091         if (code == 0) {
1092 #ifdef USE_BPLUS
1093             code = cm_BPlusDirLookup(&dirop, nnamep, &rock.fid);
1094             if (code != EINVAL)
1095                 usedBplus = 1;
1096             else
1097 #endif
1098                 code = cm_DirLookup(&dirop, fnamep, &rock.fid);
1099
1100             cm_EndDirOp(&dirop);
1101         }
1102
1103         if (code == 0) {
1104             /* found it */
1105             rock.found = TRUE;
1106             goto haveFid;
1107         }
1108 #ifdef USE_BPLUS
1109         if (usedBplus) {
1110             if (code == CM_ERROR_INEXACT_MATCH && (flags & CM_FLAG_CASEFOLD)) {
1111                 /* found it */
1112                 code = 0;
1113                 rock.found = TRUE;
1114                 goto haveFid;
1115             }
1116
1117             code = CM_ERROR_BPLUS_NOMATCH;
1118             goto notfound;
1119         }
1120 #endif
1121     }
1122
1123     rock.fid.cell = dscp->fid.cell;
1124     rock.fid.volume = dscp->fid.volume;
1125     rock.searchNamep = fnamep;
1126     rock.nsearchNamep = nnamep;
1127     rock.caseFold = (flags & CM_FLAG_CASEFOLD);
1128     rock.hasTilde = ((cm_ClientStrChr(cnamep, '~') != NULL) ? 1 : 0);
1129
1130     /* If NOMOUNTCHASE, bypass DNLC by passing NULL scp pointer */
1131     code = cm_ApplyDir(dscp, cm_LookupSearchProc, &rock, NULL, userp, reqp,
1132                        (flags & CM_FLAG_NOMOUNTCHASE) ? NULL : &tscp);
1133
1134     /* code == 0 means we fell off the end of the dir, while stopnow means
1135      * that we stopped early, probably because we found the entry we're
1136      * looking for.  Any other non-zero code is an error.
1137      */
1138     if (code && code != CM_ERROR_STOPNOW && code != CM_ERROR_BPLUS_NOMATCH) {
1139         /* if the cm_scache_t we are searching in is not a directory
1140          * we must return path not found because the error
1141          * is to describe the final component not an intermediary
1142          */
1143         if (code == CM_ERROR_NOTDIR) {
1144             if (flags & CM_FLAG_CHECKPATH)
1145                 code = CM_ERROR_NOSUCHPATH;
1146             else
1147                 code = CM_ERROR_NOSUCHFILE;
1148         }
1149         goto done;
1150     }
1151
1152 notfound:
1153     getroot = (dscp==cm_data.rootSCachep) ;
1154     if (!rock.found) {
1155         if (!cm_freelanceEnabled || !getroot) {
1156             if (flags & CM_FLAG_CHECKPATH)
1157                 code = CM_ERROR_NOSUCHPATH;
1158             else
1159                 code = CM_ERROR_NOSUCHFILE;
1160             goto done;
1161         }
1162         else if (!cm_ClientStrChr(cnamep, '#') &&
1163                  !cm_ClientStrChr(cnamep, '%') &&
1164                  cm_ClientStrCmpI(cnamep, _C("srvsvc")) &&
1165                  cm_ClientStrCmpI(cnamep, _C("wkssvc")) &&
1166                  cm_ClientStrCmpI(cnamep, _C("ipc$")))
1167         {
1168             /* nonexistent dir on freelance root, so add it */
1169             fschar_t fullname[CELL_MAXNAMELEN + 1] = ".";  /* +1 so that when we skip the . the size is still CELL_MAXNAMELEN */
1170             int  found = 0;
1171             int  retry = 0;
1172
1173             osi_Log1(afsd_logp,"cm_Lookup adding mount for non-existent directory: %S",
1174                      osi_LogSaveClientString(afsd_logp,cnamep));
1175
1176             /*
1177              * There is an ugly behavior where a share name "foo" will be searched
1178              * for as "fo".  If the searched for name differs by an already existing
1179              * symlink or mount point in the Freelance directory, do not add the
1180              * new value automatically.
1181              */
1182
1183             code = -1;
1184             fnlen = strlen(fnamep);
1185             if ( fnamep[fnlen-1] == '.') {
1186                 fnamep[fnlen-1] = '\0';
1187                 fnlen--;
1188                 retry = 1;
1189             }
1190
1191             if (cnamep[0] == '.') {
1192                 if (cm_GetCell_Gen(&fnamep[1], &fullname[1], CM_FLAG_CREATE)) {
1193                     found = 1;
1194                     code = cm_FreelanceAddMount(fullname, &fullname[1], "root.cell", 1, &rock.fid);
1195                     if ( cm_FsStrCmpI(&fnamep[1], &fullname[1])) {
1196                         /*
1197                          * Do not permit symlinks that are one of:
1198                          *  . the cellname followed by a dot
1199                          *  . the cellname minus a single character
1200                          *  . a substring of the cellname that does not consist of full components
1201                          */
1202                         if ( cm_strnicmp_utf8(&fnamep[1], fullname, (int)fnlen-1) == 0 &&
1203                              (fnlen-1 == strlen(fullname)-1 || fullname[fnlen-1] != '.'))
1204                         {
1205                             /* do not add; substitute fullname for the search */
1206                             free(fnamep);
1207                             fnamep = malloc(strlen(fullname)+2);
1208                             fnamep[0] = '.';
1209                             strncpy(&fnamep[1], fullname, strlen(fullname)+1);
1210                             retry = 1;
1211                         } else {
1212                             code = cm_FreelanceAddSymlink(fnamep, fullname, &rock.fid);
1213                         }
1214                     }
1215                 }
1216             } else {
1217                 if (cm_GetCell_Gen(fnamep, fullname, CM_FLAG_CREATE)) {
1218                     found = 1;
1219                     code = cm_FreelanceAddMount(fullname, fullname, "root.cell", 0, &rock.fid);
1220                     if ( cm_FsStrCmpI(fnamep, fullname)) {
1221                         /*
1222                          * Do not permit symlinks that are one of:
1223                          *  . the cellname followed by a dot
1224                          *  . the cellname minus a single character
1225                          *  . a substring of the cellname that does not consist of full components
1226                          */
1227                         if ( cm_strnicmp_utf8(fnamep, fullname, (int)fnlen-1) == 0 &&
1228                              (fnlen == strlen(fullname)-1 || fullname[fnlen] != '.'))
1229                         {
1230                             /* do not add; substitute fullname for the search */
1231                                 free(fnamep);
1232                                 fnamep = strdup(fullname);
1233                                 code = 0;
1234                                 retry = 1;
1235                         } else {
1236                             code = cm_FreelanceAddSymlink(fnamep, fullname, &rock.fid);
1237                         }
1238                     }
1239                 }
1240             }
1241
1242             if (retry) {
1243                 if (nnamep)
1244                     free(nnamep);
1245                 nnamep = cm_FsStringToNormStringAlloc(fnamep, -1, NULL);
1246                 goto retry_lookup;
1247             }
1248
1249             if (!found || code) {   /* add mount point failed, so give up */
1250                 if (flags & CM_FLAG_CHECKPATH)
1251                     code = CM_ERROR_NOSUCHPATH;
1252                 else
1253                     code = CM_ERROR_NOSUCHFILE;
1254                 goto done;
1255             }
1256             tscp = NULL;   /* to force call of cm_GetSCache */
1257         } else {
1258             if (flags & CM_FLAG_CHECKPATH)
1259                 code = CM_ERROR_NOSUCHPATH;
1260             else
1261                 code = CM_ERROR_NOSUCHFILE;
1262             goto done;
1263         }
1264     }
1265
1266   haveFid:
1267     if ( !tscp )    /* we did not find it in the dnlc */
1268     {
1269         dnlcHit = 0;
1270         code = cm_GetSCache(&rock.fid, &tscp, userp, reqp);
1271         if (code)
1272             goto done;
1273     }
1274     /* tscp is now held */
1275
1276     lock_ObtainWrite(&tscp->rw);
1277
1278     /*
1279      * Do not get status if we do not already have a callback.
1280      * The process of reading the mount point string will obtain status information
1281      * in a single RPC.  No reason to add a second round trip.
1282      *
1283      * If we do have a callback, use cm_SyncOp to get status in case the
1284      * current cm_user_t is not the same as the one that obtained the
1285      * mount point string contents.
1286      */
1287     if (cm_HaveCallback(tscp)) {
1288         code = cm_SyncOp(tscp, NULL, userp, reqp, 0,
1289                           CM_SCACHESYNC_GETSTATUS | CM_SCACHESYNC_NEEDCALLBACK);
1290         if (code) {
1291             lock_ReleaseWrite(&tscp->rw);
1292             cm_ReleaseSCache(tscp);
1293             goto done;
1294         }
1295         cm_SyncOpDone(tscp, NULL, CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS);
1296     }
1297     /* tscp is now locked */
1298
1299     if (!(flags & CM_FLAG_NOMOUNTCHASE)
1300          && tscp->fileType == CM_SCACHETYPE_MOUNTPOINT) {
1301         /* mount points are funny: they have a volume name to mount
1302          * the root of.
1303          */
1304         code = cm_ReadMountPoint(tscp, userp, reqp);
1305         if (code == 0)
1306             code = cm_FollowMountPoint(tscp, dscp, userp, reqp,
1307                                        &mountedScp);
1308         lock_ReleaseWrite(&tscp->rw);
1309         cm_ReleaseSCache(tscp);
1310         if (code)
1311             goto done;
1312
1313         tscp = mountedScp;
1314     }
1315     else {
1316         lock_ReleaseWrite(&tscp->rw);
1317     }
1318
1319     /* copy back pointer */
1320     *outScpp = tscp;
1321
1322     /* insert scache in dnlc */
1323     if ( !dnlcHit && !(flags & CM_FLAG_NOMOUNTCHASE) && rock.ExactFound ) {
1324         /* lock the directory entry to prevent racing callback revokes */
1325         lock_ObtainRead(&dscp->rw);
1326         if ( dscp->cbServerp != NULL && dscp->cbExpires > 0 ) {
1327             /* TODO: reuse nnamep from above */
1328             if (nnamep)
1329                 free(nnamep);
1330             nnamep = cm_ClientStringToNormStringAlloc(cnamep, -1, NULL);
1331             if (nnamep)
1332                 cm_dnlcEnter(dscp, nnamep, tscp);
1333         }
1334         lock_ReleaseRead(&dscp->rw);
1335     }
1336
1337     /* and return */
1338   done:
1339     if (fnamep) {
1340         free (fnamep);
1341         fnamep = NULL;
1342     }
1343     if (nnamep) {
1344         free (nnamep);
1345         nnamep = NULL;
1346     }
1347
1348     return code;
1349 }
1350
1351 int cm_ExpandSysName(cm_req_t * reqp, clientchar_t *inp, clientchar_t *outp, long outSizeCch, unsigned int index)
1352 {
1353     clientchar_t *tp;
1354     int prefixCount;
1355 #ifdef _WIN64
1356     int use_sysname64 = 0;
1357
1358     if (cm_sysName64Count > 0 && reqp && (reqp->flags & CM_REQ_WOW64) && (reqp->flags & CM_REQ_SOURCE_REDIR))
1359         use_sysname64 = 1;
1360 #endif
1361
1362     tp = cm_ClientStrRChr(inp, '@');
1363     if (tp == NULL)
1364         return 0;               /* no @sys */
1365
1366     if (cm_ClientStrCmp(tp, _C("@sys")) != 0)
1367         return 0;       /* no @sys */
1368
1369     /* caller just wants to know if this is a valid @sys type of name */
1370     if (outp == NULL)
1371         return 1;
1372
1373 #ifdef _WIN64
1374     if (use_sysname64 && index >= cm_sysName64Count)
1375         return -1;
1376     else
1377 #endif
1378     if (index >= cm_sysNameCount)
1379         return -1;
1380
1381     /* otherwise generate the properly expanded @sys name */
1382     prefixCount = (int)(tp - inp);
1383
1384     cm_ClientStrCpyN(outp, outSizeCch, inp, prefixCount);       /* copy out "a." from "a.@sys" */
1385     outp[prefixCount] = 0;                                      /* null terminate the "a." */
1386 #ifdef _WIN64
1387     if (use_sysname64)
1388         cm_ClientStrCat(outp, outSizeCch, cm_sysName64List[index]);
1389     else
1390 #endif
1391         cm_ClientStrCat(outp, outSizeCch, cm_sysNameList[index]);
1392
1393     return 1;
1394 }
1395
1396 long cm_EvaluateVolumeReference(clientchar_t * namep, long flags, cm_user_t * userp,
1397                                 cm_req_t *reqp, cm_scache_t ** outScpp)
1398 {
1399     afs_uint32    code = 0;
1400     fschar_t      cellName[CELL_MAXNAMELEN];
1401     fschar_t      volumeName[VL_MAXNAMELEN];
1402     size_t        len;
1403     fschar_t *        cp;
1404     fschar_t *        tp;
1405     fschar_t *        fnamep = NULL;
1406
1407     cm_cell_t *   cellp = NULL;
1408     cm_volume_t * volp = NULL;
1409     cm_fid_t      fid;
1410     afs_uint32    volume;
1411     int           volType;
1412     int           mountType = RWVOL;
1413
1414     osi_Log1(afsd_logp, "cm_EvaluateVolumeReference for string [%S]",
1415              osi_LogSaveClientString(afsd_logp, namep));
1416
1417     if (cm_ClientStrCmpNI(namep, _C(CM_PREFIX_VOL), CM_PREFIX_VOL_CCH) != 0) {
1418         goto _exit_invalid_path;
1419     }
1420
1421     /* namep is assumed to look like the following:
1422
1423        @vol:<cellname>%<volume>\0
1424        or
1425        @vol:<cellname>#<volume>\0
1426
1427      */
1428
1429     fnamep = cm_ClientStringToFsStringAlloc(namep, -1, NULL);
1430     cp = fnamep + CM_PREFIX_VOL_CCH; /* cp points to cell name, hopefully */
1431     tp = cm_FsStrChr(cp, '%');
1432     if (tp == NULL)
1433         tp = cm_FsStrChr(cp, '#');
1434     if (tp == NULL ||
1435         (len = tp - cp) == 0 ||
1436         len > CELL_MAXNAMELEN)
1437         goto _exit_invalid_path;
1438     cm_FsStrCpyN(cellName, lengthof(cellName), cp, len);
1439
1440     if (*tp == '#')
1441         mountType = ROVOL;
1442
1443     cp = tp+1;                  /* cp now points to volume, supposedly */
1444     cm_FsStrCpy(volumeName, lengthof(volumeName), cp);
1445
1446     /* OK, now we have the cell and the volume */
1447     osi_Log2(afsd_logp, "   Found cell [%s] and volume [%s]",
1448              osi_LogSaveFsString(afsd_logp, cellName),
1449              osi_LogSaveFsString(afsd_logp, volumeName));
1450
1451     cellp = cm_GetCell(cellName, CM_FLAG_CREATE);
1452     if (cellp == NULL) {
1453         goto _exit_invalid_path;
1454     }
1455
1456     len = cm_FsStrLen(volumeName);
1457     if (len >= 8 && cm_FsStrCmp(volumeName + len - 7, ".backup") == 0)
1458         volType = BACKVOL;
1459     else if (len >= 10 &&
1460              cm_FsStrCmp(volumeName + len - 9, ".readonly") == 0)
1461         volType = ROVOL;
1462     else
1463         volType = RWVOL;
1464
1465     if (cm_VolNameIsID(volumeName)) {
1466         code = cm_FindVolumeByID(cellp, atoi(volumeName), userp, reqp,
1467                                 CM_GETVOL_FLAG_CREATE, &volp);
1468     } else {
1469         code = cm_FindVolumeByName(cellp, volumeName, userp, reqp,
1470                                   CM_GETVOL_FLAG_CREATE, &volp);
1471     }
1472
1473     if (code != 0)
1474         goto _exit_cleanup;
1475
1476     if (volType == BACKVOL)
1477         volume = volp->vol[BACKVOL].ID;
1478     else if (volType == ROVOL ||
1479              (volType == RWVOL && mountType == ROVOL && volp->vol[ROVOL].ID != 0))
1480         volume = volp->vol[ROVOL].ID;
1481     else
1482         volume = volp->vol[RWVOL].ID;
1483
1484     cm_SetFid(&fid, cellp->cellID, volume, 1, 1);
1485
1486     code = cm_GetSCache(&fid, outScpp, userp, reqp);
1487
1488   _exit_cleanup:
1489     if (fnamep)
1490         free(fnamep);
1491
1492     if (volp)
1493         cm_PutVolume(volp);
1494
1495     if (code == 0)
1496         return code;
1497
1498  _exit_invalid_path:
1499     if (flags & CM_FLAG_CHECKPATH)
1500         return CM_ERROR_NOSUCHPATH;
1501     else
1502         return CM_ERROR_NOSUCHFILE;
1503 }
1504
1505 #ifdef DEBUG_REFCOUNT
1506 long cm_LookupDbg(cm_scache_t *dscp, clientchar_t *namep, long flags, cm_user_t *userp,
1507                cm_req_t *reqp, cm_scache_t **outScpp, char * file, long line)
1508 #else
1509 long cm_Lookup(cm_scache_t *dscp, clientchar_t *namep, long flags, cm_user_t *userp,
1510                cm_req_t *reqp, cm_scache_t **outScpp)
1511 #endif
1512 {
1513     long code;
1514     clientchar_t tname[AFSPATHMAX];
1515     int sysNameIndex = 0;
1516     cm_scache_t *scp = NULL;
1517
1518 #ifdef DEBUG_REFCOUNT
1519     afsi_log("%s:%d cm_Lookup dscp 0x%p ref %d", file, line, dscp, dscp->refCount, file, line);
1520     osi_Log2(afsd_logp, "cm_Lookup dscp 0x%p ref %d", dscp, dscp->refCount);
1521 #endif
1522
1523     if ( cm_ClientStrCmpI(namep,_C(SMB_IOCTL_FILENAME_NOSLASH)) == 0 ) {
1524         if (flags & CM_FLAG_CHECKPATH)
1525             return CM_ERROR_NOSUCHPATH;
1526         else
1527             return CM_ERROR_NOSUCHFILE;
1528     }
1529
1530     if (dscp == cm_data.rootSCachep &&
1531         cm_ClientStrCmpNI(namep, _C(CM_PREFIX_VOL), CM_PREFIX_VOL_CCH) == 0) {
1532         return cm_EvaluateVolumeReference(namep, flags, userp, reqp, outScpp);
1533     }
1534
1535     if (cm_ExpandSysName(reqp, namep, NULL, 0, 0) > 0) {
1536         for ( sysNameIndex = 0; sysNameIndex < MAXNUMSYSNAMES; sysNameIndex++) {
1537             code = cm_ExpandSysName(reqp, namep, tname, lengthof(tname), sysNameIndex);
1538             if (code > 0) {
1539                 code = cm_LookupInternal(dscp, tname, flags, userp, reqp, &scp);
1540 #ifdef DEBUG_REFCOUNT
1541                 afsi_log("%s:%d cm_LookupInternal (1) code 0x%x dscp 0x%p ref %d scp 0x%p ref %d", file, line, code, dscp, dscp->refCount, scp, scp ? scp->refCount : 0);
1542                 osi_Log3(afsd_logp, "cm_LookupInternal (1) code 0x%x dscp 0x%p scp 0x%p", code, dscp, scp);
1543 #endif
1544
1545                 if (code == 0) {
1546                     *outScpp = scp;
1547                     return 0;
1548                 }
1549                 if (scp) {
1550                     cm_ReleaseSCache(scp);
1551                     scp = NULL;
1552                 }
1553             } else {
1554                 code = cm_LookupInternal(dscp, namep, flags, userp, reqp, &scp);
1555 #ifdef DEBUG_REFCOUNT
1556                 afsi_log("%s:%d cm_LookupInternal (2) code 0x%x dscp 0x%p ref %d scp 0x%p ref %d", file, line, code, dscp, dscp->refCount, scp, scp ? scp->refCount : 0);
1557                 osi_Log3(afsd_logp, "cm_LookupInternal (2) code 0x%x dscp 0x%p scp 0x%p", code, dscp, scp);
1558 #endif
1559                 *outScpp = scp;
1560                 return code;
1561             }
1562         }
1563     } else {
1564         code = cm_LookupInternal(dscp, namep, flags, userp, reqp, &scp);
1565 #ifdef DEBUG_REFCOUNT
1566         afsi_log("%s:%d cm_LookupInternal (2) code 0x%x dscp 0x%p ref %d scp 0x%p ref %d", file, line, code, dscp, dscp->refCount, scp, scp ? scp->refCount : 0);
1567         osi_Log3(afsd_logp, "cm_LookupInternal (2) code 0x%x dscp 0x%p scp 0x%p", code, dscp, scp);
1568 #endif
1569         *outScpp = scp;
1570         return code;
1571     }
1572
1573     /* None of the possible sysName expansions could be found */
1574     if (flags & CM_FLAG_CHECKPATH)
1575         return CM_ERROR_NOSUCHPATH;
1576     else
1577         return CM_ERROR_NOSUCHFILE;
1578 }
1579
1580 /*! \brief Unlink a file name
1581
1582   Encapsulates a call to RXAFS_RemoveFile().
1583
1584   \param[in] dscp cm_scache_t pointing at the directory containing the
1585       name to be unlinked.
1586
1587   \param[in] fnamep Original name to be unlinked.  This is the
1588       name that will be passed into the RXAFS_RemoveFile() call.
1589       This parameter is optional.  If not provided, the value will
1590       be looked up.
1591
1592   \param[in] came Client name to be unlinked.  This name will be used
1593       to update the local directory caches.
1594
1595   \param[in] userp cm_user_t for the request.
1596
1597   \param[in] reqp Request tracker.
1598
1599  */
1600 long cm_Unlink(cm_scache_t *dscp, fschar_t *fnamep, clientchar_t * cnamep,
1601                cm_user_t *userp, cm_req_t *reqp)
1602 {
1603     long code;
1604     cm_conn_t *connp;
1605     AFSFid afsFid;
1606     int sflags;
1607     AFSFetchStatus newDirStatus;
1608     AFSVolSync volSync;
1609     struct rx_connection * rxconnp;
1610     cm_dirOp_t dirop;
1611     cm_scache_t *scp = NULL;
1612     int free_fnamep = FALSE;
1613     int invalidate = 0;
1614
1615     memset(&volSync, 0, sizeof(volSync));
1616
1617     if (fnamep == NULL) {
1618         code = -1;
1619 #ifdef USE_BPLUS
1620         code = cm_BeginDirOp(dscp, userp, reqp, CM_DIRLOCK_READ,
1621                              CM_DIROP_FLAG_NONE, &dirop);
1622         if (code == 0) {
1623             code = cm_BPlusDirLookupOriginalName(&dirop, cnamep, &fnamep);
1624             if (code == 0)
1625                 free_fnamep = TRUE;
1626             cm_EndDirOp(&dirop);
1627         }
1628 #endif
1629         if (code)
1630             goto done;
1631     }
1632
1633 #ifdef AFS_FREELANCE_CLIENT
1634     if (cm_freelanceEnabled && dscp == cm_data.rootSCachep) {
1635         /* deleting a mount point from the root dir. */
1636         code = cm_FreelanceRemoveMount(fnamep);
1637         goto done;
1638     }
1639 #endif
1640
1641     code = cm_Lookup(dscp, cnamep, CM_FLAG_NOMOUNTCHASE, userp, reqp, &scp);
1642     if (code)
1643         goto done;
1644
1645     /* Check for RO volume */
1646     if (dscp->flags & CM_SCACHEFLAG_RO) {
1647         code = CM_ERROR_READONLY;
1648         goto done;
1649     }
1650
1651     /* make sure we don't screw up the dir status during the merge */
1652     code = cm_BeginDirOp(dscp, userp, reqp, CM_DIRLOCK_NONE,
1653                          CM_DIROP_FLAG_NONE, &dirop);
1654
1655     lock_ObtainWrite(&dscp->rw);
1656     sflags = CM_SCACHESYNC_STOREDATA;
1657     code = cm_SyncOp(dscp, NULL, userp, reqp, 0, sflags);
1658     lock_ReleaseWrite(&dscp->rw);
1659     if (code) {
1660         cm_EndDirOp(&dirop);
1661         goto done;
1662     }
1663
1664     /* make the RPC */
1665     InterlockedIncrement(&dscp->activeRPCs);
1666
1667     afsFid.Volume = dscp->fid.volume;
1668     afsFid.Vnode = dscp->fid.vnode;
1669     afsFid.Unique = dscp->fid.unique;
1670
1671     osi_Log1(afsd_logp, "CALL RemoveFile scp 0x%p", dscp);
1672     do {
1673         code = cm_ConnFromFID(&dscp->fid, userp, reqp, &connp);
1674         if (code)
1675             continue;
1676
1677         rxconnp = cm_GetRxConn(connp);
1678         code = RXAFS_RemoveFile(rxconnp, &afsFid, fnamep,
1679                                 &newDirStatus, &volSync);
1680         rx_PutConnection(rxconnp);
1681
1682     } while (cm_Analyze(connp, userp, reqp, &dscp->fid, &volSync, NULL, NULL, code));
1683     code = cm_MapRPCError(code, reqp);
1684
1685     if (code)
1686         osi_Log1(afsd_logp, "CALL RemoveFile FAILURE, code 0x%x", code);
1687     else
1688         osi_Log0(afsd_logp, "CALL RemoveFile SUCCESS");
1689
1690     if (dirop.scp) {
1691         lock_ObtainWrite(&dirop.scp->dirlock);
1692         dirop.lockType = CM_DIRLOCK_WRITE;
1693     }
1694     lock_ObtainWrite(&dscp->rw);
1695     cm_dnlcRemove(dscp, cnamep);
1696     if (code == 0) {
1697         cm_MergeStatus(NULL, dscp, &newDirStatus, &volSync, userp, reqp, CM_MERGEFLAG_DIROP);
1698         invalidate = 1;
1699         if (cm_CheckDirOpForSingleChange(&dirop) && cnamep) {
1700             lock_ReleaseWrite(&dscp->rw);
1701             cm_DirDeleteEntry(&dirop, fnamep);
1702 #ifdef USE_BPLUS
1703             cm_BPlusDirDeleteEntry(&dirop, cnamep);
1704 #endif
1705             lock_ObtainWrite(&dscp->rw);
1706         }
1707     } else {
1708         InterlockedDecrement(&scp->activeRPCs);
1709         if (code == CM_ERROR_NOSUCHFILE) {
1710             /* windows would not have allowed the request to delete the file
1711              * if it did not believe the file existed.  therefore, we must
1712              * have an inconsistent view of the world.
1713              */
1714             dscp->cbServerp = NULL;
1715         }
1716     }
1717
1718     cm_SyncOpDone(dscp, NULL, sflags);
1719     lock_ReleaseWrite(&dscp->rw);
1720
1721     cm_EndDirOp(&dirop);
1722
1723     if (invalidate && RDR_Initialized &&
1724         scp->fileType != CM_SCACHETYPE_FILE && scp->fileType != CM_SCACHETYPE_DIRECTORY)
1725         RDR_InvalidateObject(dscp->fid.cell, dscp->fid.volume, dscp->fid.vnode,
1726                               dscp->fid.unique, dscp->fid.hash,
1727                               dscp->fileType, AFS_INVALIDATE_DATA_VERSION);
1728
1729     if (scp) {
1730         cm_ReleaseSCache(scp);
1731         if (code == 0) {
1732             lock_ObtainWrite(&scp->rw);
1733             if (--scp->linkCount == 0) {
1734                 scp->flags |= CM_SCACHEFLAG_DELETED;
1735                 lock_ObtainWrite(&cm_scacheLock);
1736                 cm_AdjustScacheLRU(scp);
1737                 cm_RemoveSCacheFromHashTable(scp);
1738                 lock_ReleaseWrite(&cm_scacheLock);
1739             }
1740             cm_DiscardSCache(scp);
1741             lock_ReleaseWrite(&scp->rw);
1742             if (RDR_Initialized && !(reqp->flags & CM_REQ_SOURCE_REDIR) &&
1743                 !RDR_InvalidateObject(scp->fid.cell, scp->fid.volume, scp->fid.vnode,
1744                                       scp->fid.unique, scp->fid.hash,
1745                                       scp->fileType, AFS_INVALIDATE_DELETED))
1746                 buf_ClearRDRFlag(scp, "unlink");
1747         }
1748     }
1749
1750   done:
1751     if (free_fnamep)
1752         free(fnamep);
1753
1754     return code;
1755 }
1756
1757 /* called with a write locked vnode, and fills in the link info.
1758  * returns this the vnode still write locked.
1759  */
1760 long cm_HandleLink(cm_scache_t *linkScp, cm_user_t *userp, cm_req_t *reqp)
1761 {
1762     long code = 0;
1763
1764     lock_AssertWrite(&linkScp->rw);
1765     if (!linkScp->mountPointStringp[0]) {
1766
1767 #ifdef AFS_FREELANCE_CLIENT
1768         /* File servers do not have data for freelance entries */
1769         if (cm_freelanceEnabled &&
1770             linkScp->fid.cell==AFS_FAKE_ROOT_CELL_ID &&
1771             linkScp->fid.volume==AFS_FAKE_ROOT_VOL_ID )
1772         {
1773             code = cm_FreelanceFetchMountPointString(linkScp);
1774         } else
1775 #endif /* AFS_FREELANCE_CLIENT */
1776         {
1777             char temp[MOUNTPOINTLEN];
1778             osi_hyper_t offset;
1779
1780             /* read the link data from the file server */
1781             offset.LowPart = offset.HighPart = 0;
1782             code = cm_GetData(linkScp, &offset, temp, MOUNTPOINTLEN, userp, reqp);
1783             if (code)
1784                 return code;
1785
1786             /*
1787              * linkScp->length is the actual length of the symlink target string.
1788              * It is current because cm_GetData merged the most up to date
1789              * status info into scp and has not dropped the rwlock since.
1790              */
1791             if (linkScp->length.LowPart > MOUNTPOINTLEN - 1)
1792                 return CM_ERROR_TOOBIG;
1793             if (linkScp->length.LowPart == 0)
1794                 return CM_ERROR_INVAL;
1795
1796             /* make sure we are NUL terminated */
1797             temp[linkScp->length.LowPart] = 0;
1798             memcpy(linkScp->mountPointStringp, temp, linkScp->length.LowPart + 1);
1799         }
1800
1801         if ( !strnicmp(linkScp->mountPointStringp, "msdfs:", strlen("msdfs:")) )
1802             linkScp->fileType = CM_SCACHETYPE_DFSLINK;
1803
1804     }   /* don't have symlink contents cached */
1805
1806     return code;
1807 }
1808
1809 /* called with a held vnode and a path suffix, with the held vnode being a
1810  * symbolic link.  Our goal is to generate a new path to interpret, and return
1811  * this new path in newSpaceBufferp.  If the new vnode is relative to a dir
1812  * other than the directory containing the symbolic link, then the new root is
1813  * returned in *newRootScpp, otherwise a null is returned there.
1814  */
1815 long cm_AssembleLink(cm_scache_t *linkScp, fschar_t *pathSuffixp,
1816                      cm_scache_t **newRootScpp, cm_space_t **newSpaceBufferp,
1817                      cm_user_t *userp, cm_req_t *reqp)
1818 {
1819     long code = 0;
1820     long len;
1821     fschar_t *linkp;
1822     cm_space_t *tsp;
1823
1824     *newRootScpp = NULL;
1825     *newSpaceBufferp = NULL;
1826
1827     lock_ObtainWrite(&linkScp->rw);
1828     /*
1829      * Do not get status if we do not already have a callback.
1830      * The process of reading the symlink string will obtain status information
1831      * in a single RPC.  No reason to add a second round trip.
1832      *
1833      * If we do have a callback, use cm_SyncOp to get status in case the
1834      * current cm_user_t is not the same as the one that obtained the
1835      * symlink string contents.
1836      */
1837     if (cm_HaveCallback(linkScp)) {
1838         code = cm_SyncOp(linkScp, NULL, userp, reqp, 0,
1839                           CM_SCACHESYNC_GETSTATUS | CM_SCACHESYNC_NEEDCALLBACK);
1840         if (code) {
1841             lock_ReleaseWrite(&linkScp->rw);
1842             cm_ReleaseSCache(linkScp);
1843             goto done;
1844         }
1845         cm_SyncOpDone(linkScp, NULL, CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS);
1846     }
1847     code = cm_HandleLink(linkScp, userp, reqp);
1848     if (code)
1849         goto done;
1850
1851     /* if we may overflow the buffer, bail out; buffer is signficantly
1852      * bigger than max path length, so we don't really have to worry about
1853      * being a little conservative here.
1854      */
1855     if (cm_FsStrLen(linkScp->mountPointStringp) + cm_FsStrLen(pathSuffixp) + 2
1856         >= CM_UTILS_SPACESIZE) {
1857         code = CM_ERROR_TOOBIG;
1858         goto done;
1859     }
1860
1861     tsp = cm_GetSpace();
1862     linkp = linkScp->mountPointStringp;
1863     if (strncmp(linkp, cm_mountRoot, cm_mountRootLen) == 0) {
1864         if (strlen(linkp) > cm_mountRootLen)
1865             StringCbCopyA((char *) tsp->data, sizeof(tsp->data), linkp+cm_mountRootLen+1);
1866         else
1867             tsp->data[0] = 0;
1868         *newRootScpp = cm_RootSCachep(userp, reqp);
1869         cm_HoldSCache(*newRootScpp);
1870     } else if (linkp[0] == '\\' && linkp[1] == '\\') {
1871         if (!strnicmp(&linkp[2], cm_NetbiosName, (len = (long)strlen(cm_NetbiosName))))
1872         {
1873             char * p = &linkp[len + 3];
1874             if (strnicmp(p, "all", 3) == 0)
1875                 p += 4;
1876
1877             StringCbCopyA(tsp->data, sizeof(tsp->data), p);
1878             for (p = tsp->data; *p; p++) {
1879                 if (*p == '\\')
1880                     *p = '/';
1881             }
1882             *newRootScpp = cm_RootSCachep(userp, reqp);
1883             cm_HoldSCache(*newRootScpp);
1884         } else {
1885             linkScp->fileType = CM_SCACHETYPE_DFSLINK;
1886             StringCchCopyA(tsp->data,lengthof(tsp->data), linkp);
1887             code = CM_ERROR_PATH_NOT_COVERED;
1888         }
1889     } else if ( linkScp->fileType == CM_SCACHETYPE_DFSLINK ||
1890                 !strnicmp(linkp, "msdfs:", (len = (long)strlen("msdfs:"))) ) {
1891         linkScp->fileType = CM_SCACHETYPE_DFSLINK;
1892         StringCchCopyA(tsp->data,lengthof(tsp->data), linkp);
1893         code = CM_ERROR_PATH_NOT_COVERED;
1894     } else if (*linkp == '\\' || *linkp == '/') {
1895 #if 0
1896         /* formerly, this was considered to be from the AFS root,
1897          * but this seems to create problems.  instead, we will just
1898          * reject the link */
1899         StringCchCopyA(tsp->data,lengthof(tsp->data), linkp+1);
1900         *newRootScpp = cm_RootSCachep(userp, reqp);
1901         cm_HoldSCache(*newRootScpp);
1902 #else
1903         /* we still copy the link data into the response so that
1904          * the user can see what the link points to
1905          */
1906         linkScp->fileType = CM_SCACHETYPE_INVALID;
1907         StringCchCopyA(tsp->data,lengthof(tsp->data), linkp);
1908         code = CM_ERROR_NOSUCHPATH;
1909 #endif
1910     } else {
1911         /* a relative link */
1912         StringCchCopyA(tsp->data,lengthof(tsp->data), linkp);
1913     }
1914     if (pathSuffixp[0] != 0) {  /* if suffix string is non-null */
1915         StringCchCatA(tsp->data,lengthof(tsp->data), "\\");
1916         StringCchCatA(tsp->data,lengthof(tsp->data), pathSuffixp);
1917     }
1918
1919     if (code == 0) {
1920         clientchar_t * cpath = cm_FsStringToClientStringAlloc(tsp->data, -1, NULL);
1921         if (cpath != NULL) {
1922         cm_ClientStrCpy(tsp->wdata, lengthof(tsp->wdata), cpath);
1923         free(cpath);
1924         *newSpaceBufferp = tsp;
1925     } else {
1926             code = CM_ERROR_NOSUCHPATH;
1927         }
1928     }
1929
1930     if (code != 0) {
1931         cm_FreeSpace(tsp);
1932
1933         if (code == CM_ERROR_PATH_NOT_COVERED && reqp->tidPathp && reqp->relPathp) {
1934             cm_VolStatus_Notify_DFS_Mapping(linkScp, reqp->tidPathp, reqp->relPathp);
1935         }
1936     }
1937
1938  done:
1939     lock_ReleaseWrite(&linkScp->rw);
1940     return code;
1941 }
1942 #ifdef DEBUG_REFCOUNT
1943 long cm_NameIDbg(cm_scache_t *rootSCachep, clientchar_t *pathp, long flags,
1944                  cm_user_t *userp, clientchar_t *tidPathp, cm_req_t *reqp,
1945                  cm_scache_t **outScpp,
1946                  char * file, long line)
1947 #else
1948 long cm_NameI(cm_scache_t *rootSCachep, clientchar_t *pathp, long flags,
1949               cm_user_t *userp, clientchar_t *tidPathp,
1950               cm_req_t *reqp, cm_scache_t **outScpp)
1951 #endif
1952 {
1953     long code;
1954     clientchar_t *tp;                   /* ptr moving through input buffer */
1955     clientchar_t tc;                    /* temp char */
1956     int haveComponent;          /* has new component started? */
1957     clientchar_t component[AFSPATHMAX]; /* this is the new component */
1958     clientchar_t *cp;                   /* component name being assembled */
1959     cm_scache_t *tscp;          /* current location in the hierarchy */
1960     cm_scache_t *nscp;          /* next dude down */
1961     cm_scache_t *dirScp;        /* last dir we searched */
1962     cm_scache_t *linkScp;       /* new root for the symlink we just
1963     * looked up */
1964     cm_space_t *psp;            /* space for current path, if we've hit
1965     * any symlinks */
1966     cm_space_t *tempsp;         /* temp vbl */
1967     clientchar_t *restp;                /* rest of the pathname to interpret */
1968     int symlinkCount;           /* count of # of symlinks traversed */
1969     int extraFlag;              /* avoid chasing mt pts for dir cmd */
1970     int phase = 1;              /* 1 = tidPathp, 2 = pathp */
1971 #define MAX_FID_COUNT 512
1972     cm_fid_t fids[MAX_FID_COUNT]; /* array of fids processed in this path walk */
1973     int fid_count = 0;          /* number of fids processed in this path walk */
1974     int i;
1975
1976     *outScpp = NULL;
1977
1978 #ifdef DEBUG_REFCOUNT
1979     afsi_log("%s:%d cm_NameI rootscp 0x%p ref %d", file, line, rootSCachep, rootSCachep->refCount);
1980     osi_Log4(afsd_logp,"cm_NameI rootscp 0x%p path %S tidpath %S flags 0x%x",
1981              rootSCachep, pathp ? pathp : L"<NULL>", tidPathp ? tidPathp : L"<NULL>",
1982              flags);
1983 #endif
1984
1985     tp = tidPathp;
1986     if (tp == NULL) {
1987         tp = pathp;
1988         phase = 2;
1989     }
1990     if (tp == NULL) {
1991         tp = _C("");
1992     }
1993     haveComponent = 0;
1994     psp = NULL;
1995     tscp = rootSCachep;
1996     cm_HoldSCache(tscp);
1997     symlinkCount = 0;
1998     dirScp = NULL;
1999
2000
2001     while (1) {
2002         tc = *tp++;
2003
2004         /* map Unix slashes into DOS ones so we can interpret Unix
2005          * symlinks properly
2006          */
2007         if (tc == '/')
2008             tc = '\\';
2009
2010         if (!haveComponent) {
2011             if (tc == '\\') {
2012                 continue;
2013             } else if (tc == 0) {
2014                 if (phase == 1) {
2015                     phase = 2;
2016                     tp = pathp;
2017                     continue;
2018                 }
2019                 code = 0;
2020                 break;
2021             } else {
2022                 haveComponent = 1;
2023                 cp = component;
2024                 *cp++ = tc;
2025             }
2026         } else {
2027             /* we have a component here */
2028             if (tc == 0 || tc == '\\') {
2029                 /* end of the component; we're at the last
2030                  * component if tc == 0.  However, if the last
2031                  * is a symlink, we have more to do.
2032                  */
2033                 *cp++ = 0;      /* add null termination */
2034                 extraFlag = 0;
2035                 if ((flags & CM_FLAG_DIRSEARCH) && tc == 0)
2036                     extraFlag = CM_FLAG_NOMOUNTCHASE;
2037                 code = cm_Lookup(tscp, component,
2038                                  flags | extraFlag,
2039                                  userp, reqp, &nscp);
2040
2041                 if (code == 0) {
2042                     if (!cm_ClientStrCmp(component,_C("..")) ||
2043                         !cm_ClientStrCmp(component,_C("."))) {
2044                         /*
2045                          * roll back the fid list until we find the
2046                          * fid that matches where we are now.  Its not
2047                          * necessarily one or two fids because they
2048                          * might have been symlinks or mount points or
2049                          * both that were crossed.
2050                          */
2051                         for ( i=fid_count-1; i>=0; i--) {
2052                             if (!cm_FidCmp(&nscp->fid, &fids[i]))
2053                                 break;
2054                         }
2055                         fid_count = i+1;
2056                     } else {
2057                         /* add the new fid to the list */
2058                         if (fid_count == MAX_FID_COUNT) {
2059                             code = CM_ERROR_TOO_MANY_SYMLINKS;
2060                             cm_ReleaseSCache(nscp);
2061                             nscp = NULL;
2062                             break;
2063                         }
2064                         fids[fid_count++] = nscp->fid;
2065                     }
2066                 }
2067
2068                 if (code) {
2069                     cm_ReleaseSCache(tscp);
2070                     if (dirScp)
2071                         cm_ReleaseSCache(dirScp);
2072                     if (psp)
2073                         cm_FreeSpace(psp);
2074                     if ((code == CM_ERROR_NOSUCHFILE || code == CM_ERROR_BPLUS_NOMATCH) &&
2075                         tscp->fileType == CM_SCACHETYPE_SYMLINK) {
2076                         osi_Log0(afsd_logp,"cm_NameI code CM_ERROR_NOSUCHPATH");
2077                         return CM_ERROR_NOSUCHPATH;
2078                     } else {
2079                         osi_Log1(afsd_logp,"cm_NameI code 0x%x", code);
2080                         return code;
2081                     }
2082                 }
2083
2084                 haveComponent = 0;      /* component done */
2085                 if (dirScp)
2086                     cm_ReleaseSCache(dirScp);
2087                 dirScp = tscp;          /* for some symlinks */
2088                 tscp = nscp;            /* already held */
2089                 nscp = NULL;
2090                 if (tc == 0 && !(flags & CM_FLAG_FOLLOW) && phase == 2) {
2091                     code = 0;
2092                     if (dirScp) {
2093                         cm_ReleaseSCache(dirScp);
2094                         dirScp = NULL;
2095                     }
2096                     break;
2097                 }
2098
2099                 /* now, if tscp is a symlink, we should follow it and
2100                  * assemble the path again.
2101                  */
2102                 lock_ObtainWrite(&tscp->rw);
2103                 code = cm_SyncOp(tscp, NULL, userp, reqp, 0,
2104                                   CM_SCACHESYNC_GETSTATUS
2105                                   | CM_SCACHESYNC_NEEDCALLBACK);
2106                 if (code) {
2107                     lock_ReleaseWrite(&tscp->rw);
2108                     cm_ReleaseSCache(tscp);
2109                     tscp = NULL;
2110                     if (dirScp) {
2111                         cm_ReleaseSCache(dirScp);
2112                         dirScp = NULL;
2113                     }
2114                     break;
2115                 }
2116                 cm_SyncOpDone(tscp, NULL, CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS);
2117
2118                 if (tscp->fileType == CM_SCACHETYPE_SYMLINK) {
2119                     /* this is a symlink; assemble a new buffer */
2120                     lock_ReleaseWrite(&tscp->rw);
2121                     if (symlinkCount++ >= MAX_SYMLINK_COUNT) {
2122                         cm_ReleaseSCache(tscp);
2123                         tscp = NULL;
2124                         if (dirScp) {
2125                             cm_ReleaseSCache(dirScp);
2126                             dirScp = NULL;
2127                         }
2128                         if (psp)
2129                             cm_FreeSpace(psp);
2130                         osi_Log0(afsd_logp,"cm_NameI code CM_ERROR_TOO_MANY_SYMLINKS");
2131                         return CM_ERROR_TOO_MANY_SYMLINKS;
2132                     }
2133                     if (tc == 0)
2134                         restp = _C("");
2135                     else
2136                         restp = tp;
2137
2138                     {
2139                         fschar_t * frestp;
2140
2141                         /* TODO: make this better */
2142                         frestp = cm_ClientStringToFsStringAlloc(restp, -1, NULL);
2143                         code = cm_AssembleLink(tscp, frestp, &linkScp, &tempsp, userp, reqp);
2144                         free(frestp);
2145                     }
2146
2147                     if (code == 0 && linkScp != NULL) {
2148                         if (linkScp == cm_data.rootSCachep) {
2149                             fid_count = 0;
2150                             i = 0;
2151                         } else {
2152                             for ( i=0; i<fid_count; i++) {
2153                                 if ( !cm_FidCmp(&linkScp->fid, &fids[i]) ) {
2154                                     code = CM_ERROR_TOO_MANY_SYMLINKS;
2155                                     cm_ReleaseSCache(linkScp);
2156                                     nscp = NULL;
2157                                     break;
2158                                 }
2159                             }
2160                         }
2161                         if (i == fid_count && fid_count < MAX_FID_COUNT) {
2162                             fids[fid_count++] = linkScp->fid;
2163                         }
2164                     }
2165
2166                     if (code) {
2167                         /* something went wrong */
2168                         cm_ReleaseSCache(tscp);
2169                         tscp = NULL;
2170                         if (dirScp) {
2171                             cm_ReleaseSCache(dirScp);
2172                             dirScp = NULL;
2173                         }
2174                         break;
2175                     }
2176
2177                     /* otherwise, tempsp has the new path,
2178                      * and linkScp is the new root from
2179                      * which to interpret that path.
2180                      * Continue with the namei processing,
2181                      * also doing the bookkeeping for the
2182                      * space allocation and tracking the
2183                      * vnode reference counts.
2184                      */
2185                     if (psp)
2186                         cm_FreeSpace(psp);
2187                     psp = tempsp;
2188                     tp = psp->wdata;
2189                     cm_ReleaseSCache(tscp);
2190                     tscp = linkScp;
2191                     linkScp = NULL;
2192                     /* already held
2193                      * by AssembleLink
2194                      * now, if linkScp is null, that's
2195                      * AssembleLink's way of telling us that
2196                      * the sym link is relative to the dir
2197                      * containing the link.  We have a ref
2198                      * to it in dirScp, and we hold it now
2199                      * and reuse it as the new spot in the
2200                      * dir hierarchy.
2201                      */
2202                     if (tscp == NULL) {
2203                         tscp = dirScp;
2204                         dirScp = NULL;
2205                     }
2206                 } else {
2207                     /* not a symlink, we may be done */
2208                     lock_ReleaseWrite(&tscp->rw);
2209                     if (tc == 0) {
2210                         if (phase == 1) {
2211                             phase = 2;
2212                             tp = pathp;
2213                             continue;
2214                         }
2215                         if (dirScp) {
2216                             cm_ReleaseSCache(dirScp);
2217                             dirScp = NULL;
2218                         }
2219                         code = 0;
2220                         break;
2221                     }
2222                 }
2223                 if (dirScp) {
2224                     cm_ReleaseSCache(dirScp);
2225                     dirScp = NULL;
2226                 }
2227             } /* end of a component */
2228             else
2229                 *cp++ = tc;
2230         } /* we have a component */
2231     } /* big while loop over all components */
2232
2233     /* already held */
2234     if (dirScp)
2235         cm_ReleaseSCache(dirScp);
2236     if (psp)
2237         cm_FreeSpace(psp);
2238     if (code == 0)
2239         *outScpp = tscp;
2240     else if (tscp)
2241         cm_ReleaseSCache(tscp);
2242
2243 #ifdef DEBUG_REFCOUNT
2244     afsi_log("%s:%d cm_NameI code 0x%x outScpp 0x%p ref %d", file, line, code, *outScpp, (*outScpp) ? (*outScpp)->refCount : 0);
2245 #endif
2246     osi_Log2(afsd_logp,"cm_NameI code 0x%x outScpp 0x%p", code, *outScpp);
2247     return code;
2248 }
2249
2250 /* called with a dir, and a vnode within the dir that happens to be a symlink.
2251  * We chase the link, and return a held pointer to the target, if it exists,
2252  * in *outScpp.  If we succeed, we return 0, otherwise we return an error code
2253  * and do not hold or return a target vnode.
2254  *
2255  * This is very similar to calling cm_NameI with the last component of a name,
2256  * which happens to be a symlink, except that we've already passed by the name.
2257  *
2258  * This function is typically called by the directory listing functions, which
2259  * encounter symlinks but need to return the proper file length so programs
2260  * like "more" work properly when they make use of the attributes retrieved from
2261  * the dir listing.
2262  *
2263  * The input vnode should not be locked when this function is called.
2264  */
2265 long cm_EvaluateSymLink(cm_scache_t *dscp, cm_scache_t *linkScp,
2266                          cm_scache_t **outScpp, cm_user_t *userp, cm_req_t *reqp)
2267 {
2268     long code;
2269     cm_space_t *spacep;
2270     cm_scache_t *newRootScp;
2271
2272     *outScpp = NULL;
2273
2274     osi_Log1(afsd_logp, "Evaluating symlink scp 0x%p", linkScp);
2275
2276     code = cm_AssembleLink(linkScp, "", &newRootScp, &spacep, userp, reqp);
2277     if (code)
2278         return code;
2279
2280     /* now, if newRootScp is NULL, we're really being told that the symlink
2281      * is relative to the current directory (dscp).
2282      */
2283     if (newRootScp == NULL) {
2284         newRootScp = dscp;
2285         cm_HoldSCache(dscp);
2286     }
2287
2288     code = cm_NameI(newRootScp, spacep->wdata,
2289                     CM_FLAG_CASEFOLD | CM_FLAG_FOLLOW | CM_FLAG_DIRSEARCH,
2290                     userp, NULL, reqp, outScpp);
2291
2292     if (code == CM_ERROR_NOSUCHFILE || code == CM_ERROR_BPLUS_NOMATCH)
2293         code = CM_ERROR_NOSUCHPATH;
2294
2295     /* this stuff is allocated no matter what happened on the namei call,
2296      * so free it */
2297     cm_FreeSpace(spacep);
2298     cm_ReleaseSCache(newRootScp);
2299
2300     if (linkScp == *outScpp) {
2301         cm_ReleaseSCache(*outScpp);
2302         *outScpp = NULL;
2303         code = CM_ERROR_NOSUCHPATH;
2304     }
2305
2306     return code;
2307 }
2308
2309 /* for a given entry, make sure that it isn't in the stat cache, and then
2310  * add it to the list of file IDs to be obtained.
2311  *
2312  * Don't bother adding it if we already have a vnode.  Note that the dir
2313  * is locked, so we have to be careful checking the vnode we're thinking of
2314  * processing, to avoid deadlocks.
2315  */
2316 long cm_TryBulkProc(cm_scache_t *scp, cm_dirEntry_t *dep, void *rockp,
2317                      osi_hyper_t *offp)
2318 {
2319     osi_hyper_t thyper;
2320     cm_bulkStat_t *bsp;
2321     int i;
2322     cm_scache_t *tscp;
2323     cm_fid_t tfid;
2324
2325     bsp = rockp;
2326
2327     /* Don't overflow bsp. */
2328     if (bsp->counter >= CM_BULKMAX)
2329         return CM_ERROR_STOPNOW;
2330
2331     thyper.LowPart = cm_data.buf_blockSize;
2332     thyper.HighPart = 0;
2333     thyper = LargeIntegerAdd(thyper, bsp->bufOffset);
2334
2335     /* thyper is now the first byte past the end of the record we're
2336      * interested in, and bsp->bufOffset is the first byte of the record
2337      * we're interested in.
2338      * Skip data in the others.
2339      * Skip '.' and '..'
2340      */
2341     if (LargeIntegerLessThan(*offp, bsp->bufOffset))
2342         return 0;
2343     if (LargeIntegerGreaterThanOrEqualTo(*offp, thyper))
2344         return CM_ERROR_STOPNOW;
2345     if (strcmp(dep->name, ".") == 0 || strcmp(dep->name, "..") == 0)
2346         return 0;
2347
2348     cm_SetFid(&tfid, scp->fid.cell, scp->fid.volume, ntohl(dep->fid.vnode), ntohl(dep->fid.unique));
2349     tscp = cm_FindSCache(&tfid);
2350     if (tscp) {
2351         if (lock_TryWrite(&tscp->rw)) {
2352             /* we have an entry that we can look at */
2353             if (!(tscp->flags & CM_SCACHEFLAG_EACCESS) && cm_HaveCallback(tscp)) {
2354                 /* we have a callback on it.  Don't bother
2355                  * fetching this stat entry, since we're happy
2356                  * with the info we have.
2357                  */
2358                 lock_ReleaseWrite(&tscp->rw);
2359                 cm_ReleaseSCache(tscp);
2360                 return 0;
2361             }
2362             lock_ReleaseWrite(&tscp->rw);
2363         }       /* got lock */
2364         cm_ReleaseSCache(tscp);
2365     }   /* found entry */
2366
2367 #ifdef AFS_FREELANCE_CLIENT
2368     // yj: if this is a mountpoint under root.afs then we don't want it
2369     // to be bulkstat-ed, instead, we call getSCache directly and under
2370     // getSCache, it is handled specially.
2371     if  ( cm_freelanceEnabled &&
2372           tfid.cell==AFS_FAKE_ROOT_CELL_ID &&
2373           tfid.volume==AFS_FAKE_ROOT_VOL_ID &&
2374           !(tfid.vnode==0x1 && tfid.unique==0x1) )
2375     {
2376         osi_Log0(afsd_logp, "cm_TryBulkProc Freelance calls cm_SCache on root.afs mountpoint");
2377         return cm_GetSCache(&tfid, &tscp, NULL, NULL);
2378     }
2379 #endif /* AFS_FREELANCE_CLIENT */
2380
2381     i = bsp->counter++;
2382     bsp->fids[i].Volume = scp->fid.volume;
2383     bsp->fids[i].Vnode = tfid.vnode;
2384     bsp->fids[i].Unique = tfid.unique;
2385     return 0;
2386 }
2387
2388 afs_int32
2389 cm_TryBulkStatRPC(cm_scache_t *dscp, cm_bulkStat_t *bbp, cm_user_t *userp, cm_req_t *reqp)
2390 {
2391     afs_int32 code = 0;
2392     AFSCBFids fidStruct;
2393     AFSBulkStats statStruct;
2394     cm_conn_t *connp;
2395     AFSCBs callbackStruct;
2396     long filex;
2397     AFSVolSync volSync;
2398     cm_callbackRequest_t cbReq;
2399     int lostRace;
2400     long filesThisCall;
2401     long i;
2402     long j;
2403     cm_scache_t *scp;
2404     cm_fid_t tfid;
2405     struct rx_connection * rxconnp;
2406     int inlinebulk;             /* Did we use InlineBulkStatus RPC or not? */
2407
2408     memset(&volSync, 0, sizeof(volSync));
2409
2410     /* otherwise, we may have one or more bulk stat's worth of stuff in bb;
2411      * make the calls to create the entries.  Handle AFSCBMAX files at a
2412      * time.
2413      */
2414     for (filex = 0; filex < bbp->counter; filex += filesThisCall) {
2415         filesThisCall = bbp->counter - filex;
2416         if (filesThisCall > AFSCBMAX)
2417             filesThisCall = AFSCBMAX;
2418
2419         fidStruct.AFSCBFids_len = filesThisCall;
2420         fidStruct.AFSCBFids_val = &bbp->fids[filex];
2421         statStruct.AFSBulkStats_len = filesThisCall;
2422         statStruct.AFSBulkStats_val = &bbp->stats[filex];
2423         callbackStruct.AFSCBs_len = filesThisCall;
2424         callbackStruct.AFSCBs_val = &bbp->callbacks[filex];
2425         cm_StartCallbackGrantingCall(NULL, &cbReq);
2426         osi_Log1(afsd_logp, "CALL BulkStatus, %d entries", filesThisCall);
2427
2428         /*
2429          * Whenever cm_Analyze is called for a RXAFS_ RPC there must
2430          * be a FID provided.  However, the error code from RXAFS_BulkStatus
2431          * or RXAFS_InlinkBulkStatus does not apply to any FID.  Therefore,
2432          * we generate an invalid FID to match with the RPC error.
2433          */
2434         cm_SetFid(&tfid, dscp->fid.cell, dscp->fid.volume, 0, 0);
2435
2436         do {
2437             inlinebulk = 0;
2438
2439             code = cm_ConnFromFID(&tfid, userp, reqp, &connp);
2440             if (code)
2441                 continue;
2442
2443             rxconnp = cm_GetRxConn(connp);
2444             if (!(connp->serverp->flags & CM_SERVERFLAG_NOINLINEBULK)) {
2445                 code = RXAFS_InlineBulkStatus(rxconnp, &fidStruct,
2446                                               &statStruct, &callbackStruct, &volSync);
2447                 if (code == RXGEN_OPCODE) {
2448                     cm_SetServerNoInlineBulk(connp->serverp, 0);
2449                 } else {
2450                     inlinebulk = 1;
2451                 }
2452             }
2453             if (!inlinebulk) {
2454                 code = RXAFS_BulkStatus(rxconnp, &fidStruct,
2455                                         &statStruct, &callbackStruct, &volSync);
2456             }
2457             rx_PutConnection(rxconnp);
2458
2459             /*
2460              * If InlineBulk RPC was called and it succeeded,
2461              * then pull out the return code from the status info
2462              * and use it for cm_Analyze so that we can failover to other
2463              * .readonly volume instances.  But only do it for errors that
2464              * are volume global.
2465              */
2466             if (inlinebulk && code == 0 && (&bbp->stats[0])->errorCode) {
2467                 osi_Log1(afsd_logp, "cm_TryBulkStat inline-bulk stat error: %d",
2468                           (&bbp->stats[0])->errorCode);
2469                 switch ((&bbp->stats[0])->errorCode) {
2470                 case VBUSY:
2471                 case VRESTARTING:
2472                 case VNOVOL:
2473                 case VMOVED:
2474                 case VOFFLINE:
2475                 case VSALVAGE:
2476                 case VNOSERVICE:
2477                 case VIO:
2478                     code = (&bbp->stats[0])->errorCode;
2479                     break;
2480                 default:
2481                     /* Rx and Rxkad errors are volume global */
2482                     if ( (&bbp->stats[0])->errorCode >= -64 && (&bbp->stats[0])->errorCode < 0 ||
2483                          (&bbp->stats[0])->errorCode >= ERROR_TABLE_BASE_RXK && (&bbp->stats[0])->errorCode < ERROR_TABLE_BASE_RXK + 256)
2484                         code = (&bbp->stats[0])->errorCode;
2485                 }
2486             }
2487         } while (cm_Analyze(connp, userp, reqp, &tfid, &volSync, NULL, &cbReq, code));
2488         code = cm_MapRPCError(code, reqp);
2489
2490         /*
2491          * might as well quit on an error, since we're not going to do
2492          * much better on the next immediate call, either.
2493          */
2494         if (code) {
2495             osi_Log2(afsd_logp, "CALL %sBulkStatus FAILURE code 0x%x",
2496                       inlinebulk ? "Inline" : "", code);
2497             cm_EndCallbackGrantingCall(NULL, &cbReq, NULL, NULL, 0);
2498             break;
2499         }
2500
2501         /*
2502          * The bulk RPC has succeeded or at least not failed with a
2503          * volume global error result.  For items that have inlineBulk
2504          * errors we must call cm_Analyze in order to perform required
2505          * logging of errors.
2506          *
2507          * If the RPC was not inline bulk or the entry either has no error
2508          * the status must be merged.
2509          */
2510         osi_Log1(afsd_logp, "CALL %sBulkStatus SUCCESS", inlinebulk ? "Inline" : "");
2511
2512         for (i = 0; i<filesThisCall; i++) {
2513             j = filex + i;
2514             cm_SetFid(&tfid, dscp->fid.cell, bbp->fids[j].Volume, bbp->fids[j].Vnode, bbp->fids[j].Unique);
2515
2516             if (inlinebulk && (&bbp->stats[j])->errorCode) {
2517                 cm_req_t treq = *reqp;
2518                 cm_Analyze(NULL, userp, &treq, &tfid, &volSync, NULL, &cbReq, (&bbp->stats[j])->errorCode);
2519             } else {
2520                 code = cm_GetSCache(&tfid, &scp, userp, reqp);
2521                 if (code != 0)
2522                     continue;
2523
2524                 /*
2525                  * otherwise, if this entry has no callback info,
2526                  * merge in this.  If there is existing callback info
2527                  * we skip the merge because the existing data must be
2528                  * current (we have a callback) and the response from
2529                  * a non-inline bulk rpc might actually be wrong.
2530                  *
2531                  * now, we have to be extra paranoid on merging in this
2532                  * information, since we didn't use cm_SyncOp before
2533                  * starting the fetch to make sure that no bad races
2534                  * were occurring.  Specifically, we need to make sure
2535                  * we don't obliterate any newer information in the
2536                  * vnode than have here.
2537                  *
2538                  * Right now, be pretty conservative: if there's a
2539                  * callback or a pending call, skip it.
2540                  * However, if the prior attempt to obtain status
2541                  * was refused access or the volume is .readonly,
2542                  * take the data in any case since we have nothing
2543                  * better for the in flight directory enumeration that
2544                  * resulted in this function being called.
2545                  */
2546                 lock_ObtainRead(&scp->rw);
2547                 if ((scp->cbServerp == NULL &&
2548                      !(scp->flags & (CM_SCACHEFLAG_FETCHING | CM_SCACHEFLAG_STORING | CM_SCACHEFLAG_SIZESTORING))) ||
2549                      (scp->flags & CM_SCACHEFLAG_PURERO) ||
2550                      (scp->flags & CM_SCACHEFLAG_EACCESS))
2551                 {
2552                     lock_ConvertRToW(&scp->rw);
2553                     lostRace = cm_EndCallbackGrantingCall(scp, &cbReq,
2554                                                           &bbp->callbacks[j],
2555                                                           &volSync,
2556                                                           CM_CALLBACK_MAINTAINCOUNT);
2557                     InterlockedIncrement(&scp->activeRPCs);
2558                     if (!lostRace)
2559                         cm_MergeStatus(dscp, scp, &bbp->stats[j], &volSync, userp, reqp, 0);
2560                     lock_ReleaseWrite(&scp->rw);
2561                 } else {
2562                     lock_ReleaseRead(&scp->rw);
2563                 }
2564                 cm_ReleaseSCache(scp);
2565             }
2566         } /* all files in the response */
2567         /* now tell it to drop the count,
2568          * after doing the vnode processing above */
2569         cm_EndCallbackGrantingCall(NULL, &cbReq, NULL, NULL, 0);
2570     }   /* while there are still more files to process */
2571
2572     return code;
2573 }
2574
2575 /* called with a write locked scp and a pointer to a buffer.  Make bulk stat
2576  * calls on all undeleted files in the page of the directory specified.
2577  */
2578 afs_int32
2579 cm_TryBulkStat(cm_scache_t *dscp, osi_hyper_t *offsetp, cm_user_t *userp,
2580                cm_req_t *reqp)
2581 {
2582     afs_int32 code;
2583     cm_bulkStat_t *bbp;
2584
2585     osi_Log1(afsd_logp, "cm_TryBulkStat dir 0x%p", dscp);
2586
2587     /* should be on a buffer boundary */
2588     osi_assertx((offsetp->LowPart & (cm_data.buf_blockSize - 1)) == 0, "invalid offset");
2589
2590     bbp = malloc(sizeof(cm_bulkStat_t));
2591     memset(bbp, 0, sizeof(cm_bulkStat_t));
2592     bbp->bufOffset = *offsetp;
2593
2594     lock_ReleaseWrite(&dscp->rw);
2595     /* first, assemble the file IDs we need to stat */
2596     code = cm_ApplyDir(dscp, cm_TryBulkProc, (void *) bbp, offsetp, userp, reqp, NULL);
2597
2598     /* if we failed, bail out early */
2599     if (code && code != CM_ERROR_STOPNOW) {
2600         free(bbp);
2601         lock_ObtainWrite(&dscp->rw);
2602         return code;
2603     }
2604
2605     code = cm_TryBulkStatRPC(dscp, bbp, userp, reqp);
2606     osi_Log1(afsd_logp, "END cm_TryBulkStat code 0x%x", code);
2607
2608     lock_ObtainWrite(&dscp->rw);
2609     free(bbp);
2610     return 0;
2611 }
2612
2613 void cm_StatusFromAttr(AFSStoreStatus *statusp, cm_scache_t *scp, cm_attr_t *attrp)
2614 {
2615     long mask;
2616
2617     /* initialize store back mask as inexpensive local variable */
2618     mask = 0;
2619     memset(statusp, 0, sizeof(AFSStoreStatus));
2620
2621     /* copy out queued info from scache first, if scp passed in */
2622     if (scp) {
2623         if (scp->mask & CM_SCACHEMASK_CLIENTMODTIME) {
2624             statusp->ClientModTime = scp->clientModTime;
2625             mask |= AFS_SETMODTIME;
2626             scp->mask &= ~CM_SCACHEMASK_CLIENTMODTIME;
2627         }
2628     }
2629
2630     if (attrp) {
2631         /* now add in our locally generated request */
2632         if (attrp->mask & CM_ATTRMASK_CLIENTMODTIME) {
2633             statusp->ClientModTime = attrp->clientModTime;
2634             mask |= AFS_SETMODTIME;
2635         }
2636         if (attrp->mask & CM_ATTRMASK_UNIXMODEBITS) {
2637             statusp->UnixModeBits = attrp->unixModeBits;
2638             mask |= AFS_SETMODE;
2639         }
2640         if (attrp->mask & CM_ATTRMASK_OWNER) {
2641             statusp->Owner = attrp->owner;
2642             mask |= AFS_SETOWNER;
2643         }
2644         if (attrp->mask & CM_ATTRMASK_GROUP) {
2645             statusp->Group = attrp->group;
2646             mask |= AFS_SETGROUP;
2647         }
2648     }
2649     statusp->Mask = mask;
2650 }
2651
2652 /* set the file size, and make sure that all relevant buffers have been
2653  * truncated.  Ensure that any partially truncated buffers have been zeroed
2654  * to the end of the buffer.
2655  */
2656 long cm_SetLength(cm_scache_t *scp, osi_hyper_t *sizep, cm_user_t *userp,
2657                    cm_req_t *reqp)
2658 {
2659     long code;
2660     int shrinking;
2661
2662     /* start by locking out buffer creation */
2663     lock_ObtainWrite(&scp->bufCreateLock);
2664
2665     /* verify that this is a file, not a dir or a symlink */
2666     lock_ObtainWrite(&scp->rw);
2667     code = cm_SyncOp(scp, NULL, userp, reqp, 0,
2668                       CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS);
2669     if (code)
2670         goto done;
2671     cm_SyncOpDone(scp, NULL, CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS);
2672
2673     if (scp->fileType != CM_SCACHETYPE_FILE) {
2674         code = CM_ERROR_ISDIR;
2675         goto done;
2676     }
2677
2678   startover:
2679     if (LargeIntegerLessThan(*sizep, scp->length))
2680         shrinking = 1;
2681     else
2682         shrinking = 0;
2683
2684     lock_ReleaseWrite(&scp->rw);
2685
2686     /* can't hold scp->rw lock here, since we may wait for a storeback to
2687      * finish if the buffer package is cleaning a buffer by storing it to
2688      * the server.
2689      */
2690     if (shrinking)
2691         buf_Truncate(scp, userp, reqp, sizep);
2692
2693     /* now ensure that file length is short enough, and update truncPos */
2694     lock_ObtainWrite(&scp->rw);
2695
2696     /* make sure we have a callback (so we have the right value for the
2697      * length), and wait for it to be safe to do a truncate.
2698      */
2699     code = cm_SyncOp(scp, NULL, userp, reqp, PRSFS_WRITE,
2700                       CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS
2701                       | CM_SCACHESYNC_SETSTATUS | CM_SCACHESYNC_SETSIZE);
2702
2703     /* If we only have 'i' bits, then we should still be able to set
2704        the size of a file we created. */
2705     if (code == CM_ERROR_NOACCESS && scp->creator == userp) {
2706         code = cm_SyncOp(scp, NULL, userp, reqp, PRSFS_INSERT,
2707                          CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS
2708                          | CM_SCACHESYNC_SETSTATUS | CM_SCACHESYNC_SETSIZE);
2709     }
2710
2711     if (code)
2712         goto done;
2713
2714     if (LargeIntegerLessThan(*sizep, scp->length)) {
2715         /* a real truncation.  If truncPos is not set yet, or is bigger
2716          * than where we're truncating the file, set truncPos to this
2717          * new value.
2718          */
2719         if (!shrinking)
2720             goto startover;
2721         if (!(scp->mask & CM_SCACHEMASK_TRUNCPOS)
2722              || LargeIntegerLessThan(*sizep, scp->length)) {
2723             /* set trunc pos */
2724             scp->truncPos = *sizep;
2725             scp->mask |= CM_SCACHEMASK_TRUNCPOS;
2726         }
2727         /* in either case, the new file size has been changed */
2728         scp->length = *sizep;
2729         scp->mask |= CM_SCACHEMASK_LENGTH;
2730     }
2731     else if (LargeIntegerGreaterThan(*sizep, scp->length)) {
2732         /* really extending the file */
2733         scp->length = *sizep;
2734         scp->mask |= CM_SCACHEMASK_LENGTH;
2735     }
2736
2737     /* done successfully */
2738     code = 0;
2739
2740     cm_SyncOpDone(scp, NULL,
2741                    CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS
2742                    | CM_SCACHESYNC_SETSTATUS | CM_SCACHESYNC_SETSIZE);
2743
2744   done:
2745     lock_ReleaseWrite(&scp->rw);
2746     lock_ReleaseWrite(&scp->bufCreateLock);
2747
2748     return code;
2749 }
2750
2751 /* set the file size or other attributes (but not both at once) */
2752 long cm_SetAttr(cm_scache_t *scp, cm_attr_t *attrp, cm_user_t *userp,
2753                 cm_req_t *reqp)
2754 {
2755     long code;
2756     AFSFetchStatus afsOutStatus;
2757     AFSVolSync volSync;
2758     cm_conn_t *connp;
2759     AFSFid tfid;
2760     AFSStoreStatus afsInStatus;
2761     struct rx_connection * rxconnp;
2762
2763     memset(&volSync, 0, sizeof(volSync));
2764
2765     /* handle file length setting */
2766     if (attrp->mask & CM_ATTRMASK_LENGTH)
2767         return cm_SetLength(scp, &attrp->length, userp, reqp);
2768
2769     lock_ObtainWrite(&scp->rw);
2770     /* Check for RO volume */
2771     if (scp->flags & CM_SCACHEFLAG_RO) {
2772         code = CM_ERROR_READONLY;
2773         lock_ReleaseWrite(&scp->rw);
2774         return code;
2775     }
2776
2777     /* otherwise, we have to make an RPC to get the status */
2778     code = cm_SyncOp(scp, NULL, userp, reqp, 0, CM_SCACHESYNC_STORESTATUS);
2779     if (code) {
2780         lock_ReleaseWrite(&scp->rw);
2781         return code;
2782     }
2783     lock_ConvertWToR(&scp->rw);
2784
2785     /* make the attr structure */
2786     cm_StatusFromAttr(&afsInStatus, scp, attrp);
2787
2788     tfid.Volume = scp->fid.volume;
2789     tfid.Vnode = scp->fid.vnode;
2790     tfid.Unique = scp->fid.unique;
2791     lock_ReleaseRead(&scp->rw);
2792
2793     /* now make the RPC */
2794     InterlockedIncrement(&scp->activeRPCs);
2795
2796     osi_Log1(afsd_logp, "CALL StoreStatus scp 0x%p", scp);
2797     do {
2798         code = cm_ConnFromFID(&scp->fid, userp, reqp, &connp);
2799         if (code)
2800             continue;
2801
2802         rxconnp = cm_GetRxConn(connp);
2803         code = RXAFS_StoreStatus(rxconnp, &tfid,
2804                                   &afsInStatus, &afsOutStatus, &volSync);
2805         rx_PutConnection(rxconnp);
2806
2807     } while (cm_Analyze(connp, userp, reqp,
2808                          &scp->fid, &volSync, NULL, NULL, code));
2809     code = cm_MapRPCError(code, reqp);
2810
2811     if (code)
2812         osi_Log1(afsd_logp, "CALL StoreStatus FAILURE, code 0x%x", code);
2813     else
2814         osi_Log0(afsd_logp, "CALL StoreStatus SUCCESS");
2815
2816     lock_ObtainWrite(&scp->rw);
2817     if (code == 0)
2818         cm_MergeStatus(NULL, scp, &afsOutStatus, &volSync, userp, reqp,
2819                         CM_MERGEFLAG_FORCE|CM_MERGEFLAG_STOREDATA);
2820     else
2821         InterlockedDecrement(&scp->activeRPCs);
2822     cm_SyncOpDone(scp, NULL, CM_SCACHESYNC_STORESTATUS);
2823
2824     /* if we're changing the mode bits, discard the ACL cache,
2825      * since we changed the mode bits.
2826      */
2827     if (afsInStatus.Mask & AFS_SETMODE)
2828         cm_FreeAllACLEnts(scp);
2829     lock_ReleaseWrite(&scp->rw);
2830     return code;
2831 }
2832
2833 long cm_Create(cm_scache_t *dscp, clientchar_t *cnamep, long flags, cm_attr_t *attrp,
2834                cm_scache_t **scpp, cm_user_t *userp, cm_req_t *reqp)
2835 {
2836     cm_conn_t *connp;
2837     long code;
2838     AFSFid dirAFSFid;
2839     cm_callbackRequest_t cbReq;
2840     AFSFid newAFSFid;
2841     cm_fid_t newFid;
2842     cm_scache_t *scp = NULL;
2843     int didEnd;
2844     int lostRace;
2845     AFSStoreStatus inStatus;
2846     AFSFetchStatus updatedDirStatus;
2847     AFSFetchStatus newFileStatus;
2848     AFSCallBack newFileCallback;
2849     AFSVolSync volSync;
2850     struct rx_connection * rxconnp;
2851     cm_dirOp_t dirop;
2852     fschar_t * fnamep = NULL;
2853
2854     memset(&volSync, 0, sizeof(volSync));
2855
2856     /* can't create names with @sys in them; must expand it manually first.
2857      * return "invalid request" if they try.
2858      */
2859     if (cm_ExpandSysName(NULL, cnamep, NULL, 0, 0)) {
2860         return CM_ERROR_ATSYS;
2861     }
2862
2863 #ifdef AFS_FREELANCE_CLIENT
2864     /* Freelance root volume does not hold files */
2865     if (cm_freelanceEnabled &&
2866         dscp->fid.cell==AFS_FAKE_ROOT_CELL_ID &&
2867         dscp->fid.volume==AFS_FAKE_ROOT_VOL_ID )
2868     {
2869         return CM_ERROR_NOACCESS;
2870     }
2871 #endif /* AFS_FREELANCE_CLIENT */
2872
2873     /* Check for RO volume */
2874     if (dscp->flags & CM_SCACHEFLAG_RO)
2875         return CM_ERROR_READONLY;
2876
2877     /* before starting the RPC, mark that we're changing the file data, so
2878      * that someone who does a chmod will know to wait until our call
2879      * completes.
2880      */
2881     cm_BeginDirOp(dscp, userp, reqp, CM_DIRLOCK_NONE, CM_DIROP_FLAG_NONE,
2882                   &dirop);
2883     lock_ObtainWrite(&dscp->rw);
2884     code = cm_SyncOp(dscp, NULL, userp, reqp, 0, CM_SCACHESYNC_STOREDATA);
2885     lock_ReleaseWrite(&dscp->rw);
2886     if (code == 0) {
2887         cm_StartCallbackGrantingCall(NULL, &cbReq);
2888     } else {
2889         cm_EndDirOp(&dirop);
2890     }
2891     if (code) {
2892         return code;
2893     }
2894     didEnd = 0;
2895
2896     fnamep = cm_ClientStringToFsStringAlloc(cnamep, -1, NULL);
2897
2898     cm_StatusFromAttr(&inStatus, NULL, attrp);
2899
2900     /* try the RPC now */
2901     InterlockedIncrement(&dscp->activeRPCs);
2902     osi_Log1(afsd_logp, "CALL CreateFile scp 0x%p", dscp);
2903     do {
2904         code = cm_ConnFromFID(&dscp->fid, userp, reqp, &connp);
2905         if (code)
2906             continue;
2907
2908         dirAFSFid.Volume = dscp->fid.volume;
2909         dirAFSFid.Vnode = dscp->fid.vnode;
2910         dirAFSFid.Unique = dscp->fid.unique;
2911
2912         rxconnp = cm_GetRxConn(connp);
2913         code = RXAFS_CreateFile(connp->rxconnp, &dirAFSFid, fnamep,
2914                                  &inStatus, &newAFSFid, &newFileStatus,
2915                                  &updatedDirStatus, &newFileCallback,
2916                                  &volSync);
2917         rx_PutConnection(rxconnp);
2918
2919     } while (cm_Analyze(connp, userp, reqp,
2920                          &dscp->fid, &volSync, NULL, &cbReq, code));
2921     code = cm_MapRPCError(code, reqp);
2922
2923     if (code)
2924         osi_Log1(afsd_logp, "CALL CreateFile FAILURE, code 0x%x", code);
2925     else
2926         osi_Log0(afsd_logp, "CALL CreateFile SUCCESS");
2927
2928     if (dirop.scp) {
2929         lock_ObtainWrite(&dirop.scp->dirlock);
2930         dirop.lockType = CM_DIRLOCK_WRITE;
2931     }
2932     lock_ObtainWrite(&dscp->rw);
2933     if (code == 0) {
2934         cm_MergeStatus(NULL, dscp, &updatedDirStatus, &volSync, userp, reqp, CM_MERGEFLAG_DIROP);
2935         cm_SetFid(&newFid, dscp->fid.cell, dscp->fid.volume, newAFSFid.Vnode, newAFSFid.Unique);
2936         if (cm_CheckDirOpForSingleChange(&dirop)) {
2937             lock_ReleaseWrite(&dscp->rw);
2938             cm_DirCreateEntry(&dirop, fnamep, &newFid);
2939 #ifdef USE_BPLUS
2940             cm_BPlusDirCreateEntry(&dirop, cnamep, &newFid);
2941 #endif
2942             lock_ObtainWrite(&dscp->rw);
2943         }
2944     } else {
2945         InterlockedDecrement(&dscp->activeRPCs);
2946     }
2947     cm_SyncOpDone(dscp, NULL, CM_SCACHESYNC_STOREDATA);
2948     lock_ReleaseWrite(&dscp->rw);
2949
2950     /* now try to create the file's entry, too, but be careful to
2951      * make sure that we don't merge in old info.  Since we weren't locking
2952      * out any requests during the file's creation, we may have pretty old
2953      * info.
2954      */
2955     if (code == 0) {
2956         code = cm_GetSCache(&newFid, &scp, userp, reqp);
2957         if (code == 0) {
2958             lock_ObtainWrite(&scp->rw);
2959             scp->creator = userp;               /* remember who created it */
2960             if (!cm_HaveCallback(scp)) {
2961                 lostRace = cm_EndCallbackGrantingCall(scp, &cbReq,
2962                                                       &newFileCallback, &volSync, 0);
2963                 InterlockedIncrement(&scp->activeRPCs);
2964                 if (!lostRace)
2965                     cm_MergeStatus(dscp, scp, &newFileStatus, &volSync,
2966                                    userp, reqp, 0);
2967                 didEnd = 1;
2968             }
2969             lock_ReleaseWrite(&scp->rw);
2970         }
2971     }
2972
2973     /* make sure we end things properly */
2974     if (!didEnd)
2975         cm_EndCallbackGrantingCall(NULL, &cbReq, NULL, NULL, 0);
2976
2977     cm_EndDirOp(&dirop);
2978
2979     if (fnamep)
2980         free(fnamep);
2981
2982     if (scp) {
2983         if (scpp)
2984             *scpp = scp;
2985         else
2986             cm_ReleaseSCache(scp);
2987     }
2988     return code;
2989 }
2990
2991 /*
2992  * locked if TRUE means write-locked
2993  * else the cm_scache_t rw must not be held
2994  */
2995 long cm_FSync(cm_scache_t *scp, cm_user_t *userp, cm_req_t *reqp, afs_uint32 locked)
2996 {
2997     long code;
2998
2999     if (locked)
3000         lock_ReleaseWrite(&scp->rw);
3001
3002     osi_Log2(afsd_logp, "cm_FSync scp 0x%p userp 0x%p", scp, userp);
3003
3004     code = buf_CleanVnode(scp, userp, reqp);
3005     if (code == 0) {
3006         lock_ObtainWrite(&scp->rw);
3007
3008         if (scp->mask & (CM_SCACHEMASK_TRUNCPOS
3009                           | CM_SCACHEMASK_CLIENTMODTIME
3010                           | CM_SCACHEMASK_LENGTH))
3011             code = cm_StoreMini(scp, userp, reqp);
3012
3013         if (scp->flags & (CM_SCACHEFLAG_OVERQUOTA | CM_SCACHEFLAG_OUTOFSPACE)) {
3014             code = (scp->flags & CM_SCACHEFLAG_OVERQUOTA) ? CM_ERROR_QUOTA : CM_ERROR_SPACE;
3015             scp->flags &= ~(CM_SCACHEFLAG_OVERQUOTA | CM_SCACHEFLAG_OUTOFSPACE);
3016         }
3017
3018         if (!locked)
3019             lock_ReleaseWrite(&scp->rw);
3020     } else if (locked) {
3021         lock_ObtainWrite(&scp->rw);
3022     }
3023     return code;
3024 }
3025
3026 long cm_MakeDir(cm_scache_t *dscp, clientchar_t *cnamep, long flags, cm_attr_t *attrp,
3027                 cm_user_t *userp, cm_req_t *reqp, cm_scache_t **scpp)
3028 {
3029     cm_conn_t *connp;
3030     long code;
3031     AFSFid dirAFSFid;
3032     cm_callbackRequest_t cbReq;
3033     AFSFid newAFSFid;
3034     cm_fid_t newFid;
3035     cm_scache_t *scp = NULL;
3036     int didEnd;
3037     int lostRace;
3038     AFSStoreStatus inStatus;
3039     AFSFetchStatus updatedDirStatus;
3040     AFSFetchStatus newDirStatus;
3041     AFSCallBack newDirCallback;
3042     AFSVolSync volSync;
3043     struct rx_connection * rxconnp;
3044     cm_dirOp_t dirop;
3045     fschar_t * fnamep = NULL;
3046
3047     memset(&volSync, 0, sizeof(volSync));
3048
3049     /* can't create names with @sys in them; must expand it manually first.
3050      * return "invalid request" if they try.
3051      */
3052     if (cm_ExpandSysName(NULL, cnamep, NULL, 0, 0)) {
3053         return CM_ERROR_ATSYS;
3054     }
3055
3056 #ifdef AFS_FREELANCE_CLIENT
3057     /* Freelance root volume does not hold subdirectories */
3058     if (cm_freelanceEnabled &&
3059         dscp->fid.cell==AFS_FAKE_ROOT_CELL_ID &&
3060         dscp->fid.volume==AFS_FAKE_ROOT_VOL_ID )
3061     {
3062         return CM_ERROR_NOACCESS;
3063     }
3064 #endif /* AFS_FREELANCE_CLIENT */
3065
3066     /* Check for RO volume */
3067     if (dscp->flags & CM_SCACHEFLAG_RO)
3068         return CM_ERROR_READONLY;
3069
3070     /* before starting the RPC, mark that we're changing the directory
3071      * data, so that someone who does a chmod on the dir will wait until
3072      * our call completes.
3073      */
3074     cm_BeginDirOp(dscp, userp, reqp, CM_DIRLOCK_NONE, CM_DIROP_FLAG_NONE,
3075                   &dirop);
3076     lock_ObtainWrite(&dscp->rw);
3077     code = cm_SyncOp(dscp, NULL, userp, reqp, 0, CM_SCACHESYNC_STOREDATA);
3078     lock_ReleaseWrite(&dscp->rw);
3079     if (code == 0) {
3080         cm_StartCallbackGrantingCall(NULL, &cbReq);
3081     } else {
3082         cm_EndDirOp(&dirop);
3083     }
3084     if (code) {
3085         return code;
3086     }
3087     didEnd = 0;
3088
3089     fnamep = cm_ClientStringToFsStringAlloc(cnamep, -1, NULL);
3090     cm_StatusFromAttr(&inStatus, NULL, attrp);
3091
3092     /* try the RPC now */
3093     InterlockedIncrement(&dscp->activeRPCs);
3094     osi_Log1(afsd_logp, "CALL MakeDir scp 0x%p", dscp);
3095     do {
3096         code = cm_ConnFromFID(&dscp->fid, userp, reqp, &connp);
3097         if (code)
3098             continue;
3099
3100         dirAFSFid.Volume = dscp->fid.volume;
3101         dirAFSFid.Vnode = dscp->fid.vnode;
3102         dirAFSFid.Unique = dscp->fid.unique;
3103
3104         rxconnp = cm_GetRxConn(connp);
3105         code = RXAFS_MakeDir(connp->rxconnp, &dirAFSFid, fnamep,
3106                               &inStatus, &newAFSFid, &newDirStatus,
3107                               &updatedDirStatus, &newDirCallback,
3108                               &volSync);
3109         rx_PutConnection(rxconnp);
3110
3111     } while (cm_Analyze(connp, userp, reqp,
3112                         &dscp->fid, &volSync, NULL, &cbReq, code));
3113     code = cm_MapRPCError(code, reqp);
3114
3115     if (code)
3116         osi_Log1(afsd_logp, "CALL MakeDir FAILURE, code 0x%x", code);
3117     else
3118         osi_Log0(afsd_logp, "CALL MakeDir SUCCESS");
3119
3120     if (dirop.scp) {
3121         lock_ObtainWrite(&dirop.scp->dirlock);
3122         dirop.lockType = CM_DIRLOCK_WRITE;
3123     }
3124     lock_ObtainWrite(&dscp->rw);
3125     if (code == 0) {
3126         cm_MergeStatus(NULL, dscp, &updatedDirStatus, &volSync, userp, reqp, CM_MERGEFLAG_DIROP);
3127         cm_SetFid(&newFid, dscp->fid.cell, dscp->fid.volume, newAFSFid.Vnode, newAFSFid.Unique);
3128         if (cm_CheckDirOpForSingleChange(&dirop)) {
3129             lock_ReleaseWrite(&dscp->rw);
3130             cm_DirCreateEntry(&dirop, fnamep, &newFid);
3131 #ifdef USE_BPLUS
3132             cm_BPlusDirCreateEntry(&dirop, cnamep, &newFid);
3133 #endif
3134             lock_ObtainWrite(&dscp->rw);
3135         }
3136     } else {
3137         InterlockedDecrement(&dscp->activeRPCs);
3138     }
3139     cm_SyncOpDone(dscp, NULL, CM_SCACHESYNC_STOREDATA);
3140     lock_ReleaseWrite(&dscp->rw);
3141
3142     /* now try to create the new dir's entry, too, but be careful to
3143      * make sure that we don't merge in old info.  Since we weren't locking
3144      * out any requests during the file's creation, we may have pretty old
3145      * info.
3146      */
3147     if (code == 0) {
3148         code = cm_GetSCache(&newFid, &scp, userp, reqp);
3149         if (code == 0) {
3150             lock_ObtainWrite(&scp->rw);
3151             if (!cm_HaveCallback(scp)) {
3152                 lostRace = cm_EndCallbackGrantingCall(scp, &cbReq,
3153                                                       &newDirCallback, &volSync, 0);
3154                 InterlockedIncrement(&scp->activeRPCs);
3155                 if (!lostRace)
3156                     cm_MergeStatus(dscp, scp, &newDirStatus, &volSync,
3157                                    userp, reqp, 0);
3158                 didEnd = 1;
3159             }
3160             lock_ReleaseWrite(&scp->rw);
3161         }
3162     }
3163
3164     /* make sure we end things properly */
3165     if (!didEnd)
3166         cm_EndCallbackGrantingCall(NULL, &cbReq, NULL, NULL, 0);
3167
3168     cm_EndDirOp(&dirop);
3169
3170     free(fnamep);
3171
3172     if (scp) {
3173         if (scpp)
3174             *scpp = scp;
3175         else
3176             cm_ReleaseSCache(scp);
3177     }
3178
3179     /* and return error code */
3180     return code;
3181 }
3182
3183 long cm_Link(cm_scache_t *dscp, clientchar_t *cnamep, cm_scache_t *sscp, long flags,
3184              cm_user_t *userp, cm_req_t *reqp)
3185 {
3186     cm_conn_t *connp;
3187     long code = 0;
3188     AFSFid dirAFSFid;
3189     AFSFid existingAFSFid;
3190     AFSFetchStatus updatedDirStatus;
3191     AFSFetchStatus newLinkStatus;
3192     AFSVolSync volSync;
3193     struct rx_connection * rxconnp;
3194     cm_dirOp_t dirop;
3195     fschar_t * fnamep = NULL;
3196     int invalidate = 0;
3197
3198     memset(&volSync, 0, sizeof(volSync));
3199
3200     if (dscp->fid.cell != sscp->fid.cell ||
3201         dscp->fid.volume != sscp->fid.volume) {
3202         return CM_ERROR_CROSSDEVLINK;
3203     }
3204
3205     /* Check for RO volume */
3206     if (dscp->flags & CM_SCACHEFLAG_RO)
3207         return CM_ERROR_READONLY;
3208
3209     cm_BeginDirOp(dscp, userp, reqp, CM_DIRLOCK_NONE, CM_DIROP_FLAG_NONE,
3210                   &dirop);
3211     lock_ObtainWrite(&dscp->rw);
3212     code = cm_SyncOp(dscp, NULL, userp, reqp, 0, CM_SCACHESYNC_STOREDATA);
3213     lock_ReleaseWrite(&dscp->rw);
3214     if (code != 0)
3215         cm_EndDirOp(&dirop);
3216
3217     if (code)
3218         return code;
3219
3220     fnamep = cm_ClientStringToFsStringAlloc(cnamep, -1, NULL);
3221
3222     /* try the RPC now */
3223     InterlockedIncrement(&dscp->activeRPCs);
3224     osi_Log1(afsd_logp, "CALL Link scp 0x%p", dscp);
3225     do {
3226         code = cm_ConnFromFID(&dscp->fid, userp, reqp, &connp);
3227         if (code) continue;
3228
3229         dirAFSFid.Volume = dscp->fid.volume;
3230         dirAFSFid.Vnode = dscp->fid.vnode;
3231         dirAFSFid.Unique = dscp->fid.unique;
3232
3233         existingAFSFid.Volume = sscp->fid.volume;
3234         existingAFSFid.Vnode = sscp->fid.vnode;
3235         existingAFSFid.Unique = sscp->fid.unique;
3236
3237         rxconnp = cm_GetRxConn(connp);
3238         code = RXAFS_Link(rxconnp, &dirAFSFid, fnamep, &existingAFSFid,
3239             &newLinkStatus, &updatedDirStatus, &volSync);
3240         rx_PutConnection(rxconnp);
3241         osi_Log1(afsd_logp,"  RXAFS_Link returns 0x%x", code);
3242
3243     } while (cm_Analyze(connp, userp, reqp,
3244         &dscp->fid, &volSync, NULL, NULL, code));
3245
3246     code = cm_MapRPCError(code, reqp);
3247
3248     if (code)
3249         osi_Log1(afsd_logp, "CALL Link FAILURE, code 0x%x", code);
3250     else
3251         osi_Log0(afsd_logp, "CALL Link SUCCESS");
3252
3253     if (dirop.scp) {
3254         lock_ObtainWrite(&dirop.scp->dirlock);
3255         dirop.lockType = CM_DIRLOCK_WRITE;
3256     }
3257     lock_ObtainWrite(&dscp->rw);
3258     if (code == 0) {
3259         cm_MergeStatus(NULL, dscp, &updatedDirStatus, &volSync, userp, reqp, CM_MERGEFLAG_DIROP);
3260         invalidate = 1;
3261
3262         if (cm_CheckDirOpForSingleChange(&dirop)) {
3263             lock_ReleaseWrite(&dscp->rw);
3264             cm_DirCreateEntry(&dirop, fnamep, &sscp->fid);
3265 #ifdef USE_BPLUS
3266             cm_BPlusDirCreateEntry(&dirop, cnamep, &sscp->fid);
3267 #endif
3268             lock_ObtainWrite(&dscp->rw);
3269         }
3270     } else {
3271         InterlockedDecrement(&dscp->activeRPCs);
3272     }
3273     cm_SyncOpDone(dscp, NULL, CM_SCACHESYNC_STOREDATA);
3274     lock_ReleaseWrite(&dscp->rw);
3275
3276     cm_EndDirOp(&dirop);
3277
3278     if (invalidate && RDR_Initialized)
3279         RDR_InvalidateObject(dscp->fid.cell, dscp->fid.volume, dscp->fid.vnode,
3280                              dscp->fid.unique, dscp->fid.hash,
3281                              dscp->fileType, AFS_INVALIDATE_DATA_VERSION);
3282
3283     /* Update the linked object status */
3284     if (code == 0) {
3285         lock_ObtainWrite(&sscp->rw);
3286         InterlockedIncrement(&sscp->activeRPCs);
3287         cm_MergeStatus(NULL, sscp, &newLinkStatus, &volSync, userp, reqp, 0);
3288         lock_ReleaseWrite(&sscp->rw);
3289     }
3290
3291     free(fnamep);
3292
3293     return code;
3294 }
3295
3296 long cm_SymLink(cm_scache_t *dscp, clientchar_t *cnamep, fschar_t *contentsp, long flags,
3297                 cm_attr_t *attrp, cm_user_t *userp, cm_req_t *reqp, cm_scache_t **scpp)
3298 {
3299     cm_conn_t *connp;
3300     long code;
3301     AFSFid dirAFSFid;
3302     AFSFid newAFSFid;
3303     cm_fid_t newFid;
3304     cm_scache_t *scp;
3305     AFSStoreStatus inStatus;
3306     AFSFetchStatus updatedDirStatus;
3307     AFSFetchStatus newLinkStatus;
3308     AFSVolSync volSync;
3309     struct rx_connection * rxconnp;
3310     cm_dirOp_t dirop;
3311     fschar_t *fnamep = NULL;
3312
3313     if (scpp)
3314         *scpp = NULL;
3315
3316     /* Check for RO volume */
3317     if (dscp->flags & CM_SCACHEFLAG_RO)
3318         return CM_ERROR_READONLY;
3319
3320     memset(&volSync, 0, sizeof(volSync));
3321
3322     /* before starting the RPC, mark that we're changing the directory data,
3323      * so that someone who does a chmod on the dir will wait until our
3324      * call completes.
3325      */
3326     cm_BeginDirOp(dscp, userp, reqp, CM_DIRLOCK_NONE, CM_DIROP_FLAG_NONE,
3327                   &dirop);
3328     lock_ObtainWrite(&dscp->rw);
3329     code = cm_SyncOp(dscp, NULL, userp, reqp, 0, CM_SCACHESYNC_STOREDATA);
3330     lock_ReleaseWrite(&dscp->rw);
3331     if (code != 0)
3332         cm_EndDirOp(&dirop);
3333     if (code) {
3334         return code;
3335     }
3336
3337     fnamep = cm_ClientStringToFsStringAlloc(cnamep, -1, NULL);
3338
3339     cm_StatusFromAttr(&inStatus, NULL, attrp);
3340
3341     /* try the RPC now */
3342     InterlockedIncrement(&dscp->activeRPCs);
3343     osi_Log1(afsd_logp, "CALL Symlink scp 0x%p", dscp);
3344     do {
3345         code = cm_ConnFromFID(&dscp->fid, userp, reqp, &connp);
3346         if (code)
3347             continue;
3348
3349         dirAFSFid.Volume = dscp->fid.volume;
3350         dirAFSFid.Vnode = dscp->fid.vnode;
3351         dirAFSFid.Unique = dscp->fid.unique;
3352
3353         rxconnp = cm_GetRxConn(connp);
3354         code = RXAFS_Symlink(rxconnp, &dirAFSFid, fnamep, contentsp,
3355                               &inStatus, &newAFSFid, &newLinkStatus,
3356                               &updatedDirStatus, &volSync);
3357         rx_PutConnection(rxconnp);
3358
3359     } while (cm_Analyze(connp, userp, reqp,
3360                          &dscp->fid, &volSync, NULL, NULL, code));
3361     code = cm_MapRPCError(code, reqp);
3362
3363     if (code)
3364         osi_Log1(afsd_logp, "CALL Symlink FAILURE, code 0x%x", code);
3365     else
3366         osi_Log0(afsd_logp, "CALL Symlink SUCCESS");
3367
3368     if (dirop.scp) {
3369         lock_ObtainWrite(&dirop.scp->dirlock);
3370         dirop.lockType = CM_DIRLOCK_WRITE;
3371     }
3372     lock_ObtainWrite(&dscp->rw);
3373     if (code == 0) {
3374         cm_MergeStatus(NULL, dscp, &updatedDirStatus, &volSync, userp, reqp, CM_MERGEFLAG_DIROP);
3375         cm_SetFid(&newFid, dscp->fid.cell, dscp->fid.volume, newAFSFid.Vnode, newAFSFid.Unique);
3376         if (cm_CheckDirOpForSingleChange(&dirop)) {
3377             lock_ReleaseWrite(&dscp->rw);
3378             cm_SetFid(&newFid, dscp->fid.cell, dscp->fid.volume, newAFSFid.Vnode, newAFSFid.Unique);
3379
3380             cm_DirCreateEntry(&dirop, fnamep, &newFid);
3381 #ifdef USE_BPLUS
3382             cm_BPlusDirCreateEntry(&dirop, cnamep, &newFid);
3383 #endif
3384             lock_ObtainWrite(&dscp->rw);
3385         }
3386     } else {
3387         InterlockedDecrement(&dscp->activeRPCs);
3388     }
3389     cm_SyncOpDone(dscp, NULL, CM_SCACHESYNC_STOREDATA);
3390     lock_ReleaseWrite(&dscp->rw);
3391
3392     cm_EndDirOp(&dirop);
3393
3394     /* now try to create the new dir's entry, too, but be careful to
3395      * make sure that we don't merge in old info.  Since we weren't locking
3396      * out any requests during the file's creation, we may have pretty old
3397      * info.
3398      */
3399     if (code == 0) {
3400         code = cm_GetSCache(&newFid, &scp, userp, reqp);
3401         if (code == 0) {
3402             lock_ObtainWrite(&scp->rw);
3403             if (!cm_HaveCallback(scp)) {
3404                 InterlockedIncrement(&scp->activeRPCs);
3405                 cm_MergeStatus(dscp, scp, &newLinkStatus, &volSync,
3406                                 userp, reqp, 0);
3407             }
3408             lock_ReleaseWrite(&scp->rw);
3409
3410             if (scpp) {
3411                 *scpp = scp;
3412             } else {
3413                 cm_ReleaseSCache(scp);
3414             }
3415         }
3416     }
3417
3418     free(fnamep);
3419
3420     /* and return error code */
3421     return code;
3422 }
3423
3424 /*! \brief Remove a directory
3425
3426   Encapsulates a call to RXAFS_RemoveDir().
3427
3428   \param[in] dscp cm_scache_t for the directory containing the
3429       directory to be removed.
3430
3431   \param[in] fnamep This will be the original name of the directory
3432       as known to the file server.   It will be passed in to RXAFS_RemoveDir().
3433       This parameter is optional.  If it is not provided the value
3434       will be looked up.
3435
3436   \param[in] cnamep Normalized name used to update the local
3437       directory caches.
3438
3439   \param[in] userp cm_user_t for the request.
3440
3441   \param[in] reqp Request tracker.
3442 */
3443 long cm_RemoveDir(cm_scache_t *dscp, fschar_t *fnamep, clientchar_t *cnamep, cm_user_t *userp, cm_req_t *reqp)
3444 {
3445     cm_conn_t *connp;
3446     long code;
3447     AFSFid dirAFSFid;
3448     int didEnd;
3449     AFSFetchStatus updatedDirStatus;
3450     AFSVolSync volSync;
3451     struct rx_connection * rxconnp;
3452     cm_dirOp_t dirop;
3453     cm_scache_t *scp = NULL;
3454     int free_fnamep = FALSE;
3455
3456     memset(&volSync, 0, sizeof(volSync));
3457
3458     if (fnamep == NULL) {
3459         code = -1;
3460 #ifdef USE_BPLUS
3461         code = cm_BeginDirOp(dscp, userp, reqp, CM_DIRLOCK_READ,
3462                              CM_DIROP_FLAG_NONE, &dirop);
3463         if (code == 0) {
3464             code = cm_BPlusDirLookupOriginalName(&dirop, cnamep, &fnamep);
3465             if (code == 0)
3466                 free_fnamep = TRUE;
3467             cm_EndDirOp(&dirop);
3468         }
3469 #endif
3470         if (code)
3471             goto done;
3472     }
3473
3474     code = cm_Lookup(dscp, cnamep, CM_FLAG_NOMOUNTCHASE, userp, reqp, &scp);
3475     if (code)
3476         goto done;
3477
3478     /* Check for RO volume */
3479     if (dscp->flags & CM_SCACHEFLAG_RO) {
3480         code = CM_ERROR_READONLY;
3481         goto done;
3482     }
3483
3484     /* before starting the RPC, mark that we're changing the directory data,
3485      * so that someone who does a chmod on the dir will wait until our
3486      * call completes.
3487      */
3488     cm_BeginDirOp(dscp, userp, reqp, CM_DIRLOCK_NONE, CM_DIROP_FLAG_NONE,
3489                   &dirop);
3490     lock_ObtainWrite(&dscp->rw);
3491     code = cm_SyncOp(dscp, NULL, userp, reqp, 0, CM_SCACHESYNC_STOREDATA);
3492     lock_ReleaseWrite(&dscp->rw);
3493     if (code) {
3494         cm_EndDirOp(&dirop);
3495         goto done;
3496     }
3497     didEnd = 0;
3498
3499     /* try the RPC now */
3500     InterlockedIncrement(&dscp->activeRPCs);
3501     osi_Log1(afsd_logp, "CALL RemoveDir scp 0x%p", dscp);
3502     do {
3503         code = cm_ConnFromFID(&dscp->fid, userp, reqp, &connp);
3504         if (code)
3505             continue;
3506
3507         dirAFSFid.Volume = dscp->fid.volume;
3508         dirAFSFid.Vnode = dscp->fid.vnode;
3509         dirAFSFid.Unique = dscp->fid.unique;
3510
3511         rxconnp = cm_GetRxConn(connp);
3512         code = RXAFS_RemoveDir(rxconnp, &dirAFSFid, fnamep,
3513                                &updatedDirStatus, &volSync);
3514         rx_PutConnection(rxconnp);
3515
3516     } while (cm_Analyze(connp, userp, reqp,
3517                         &dscp->fid, &volSync, NULL, NULL, code));
3518     code = cm_MapRPCErrorRmdir(code, reqp);
3519
3520     if (code)
3521         osi_Log1(afsd_logp, "CALL RemoveDir FAILURE, code 0x%x", code);
3522     else
3523         osi_Log0(afsd_logp, "CALL RemoveDir SUCCESS");
3524
3525     if (dirop.scp) {
3526         lock_ObtainWrite(&dirop.scp->dirlock);
3527         dirop.lockType = CM_DIRLOCK_WRITE;
3528     }
3529     lock_ObtainWrite(&dscp->rw);
3530     if (code == 0) {
3531         cm_dnlcRemove(dscp, cnamep);
3532         cm_MergeStatus(NULL, dscp, &updatedDirStatus, &volSync, userp, reqp, CM_MERGEFLAG_DIROP);
3533         if (cm_CheckDirOpForSingleChange(&dirop) && cnamep != NULL) {
3534             lock_ReleaseWrite(&dscp->rw);
3535             cm_DirDeleteEntry(&dirop, fnamep);
3536 #ifdef USE_BPLUS
3537             cm_BPlusDirDeleteEntry(&dirop, cnamep);
3538 #endif
3539             lock_ObtainWrite(&dscp->rw);
3540         }
3541     } else {
3542         InterlockedDecrement(&dscp->activeRPCs);
3543     }
3544     cm_SyncOpDone(dscp, NULL, CM_SCACHESYNC_STOREDATA);
3545     lock_ReleaseWrite(&dscp->rw);
3546
3547     cm_EndDirOp(&dirop);
3548
3549     if (scp) {
3550         cm_ReleaseSCache(scp);
3551         if (code == 0) {
3552             lock_ObtainWrite(&scp->rw);
3553             scp->flags |= CM_SCACHEFLAG_DELETED;
3554             lock_ObtainWrite(&cm_scacheLock);
3555             cm_AdjustScacheLRU(scp);
3556             cm_RemoveSCacheFromHashTable(scp);
3557             lock_ReleaseWrite(&cm_scacheLock);
3558             lock_ReleaseWrite(&scp->rw);
3559             if (RDR_Initialized && !(reqp->flags & CM_REQ_SOURCE_REDIR) &&
3560                 !RDR_InvalidateObject(scp->fid.cell, scp->fid.volume, scp->fid.vnode,
3561                                       scp->fid.unique, scp->fid.hash,
3562                                       scp->fileType, AFS_INVALIDATE_DELETED))
3563                 buf_ClearRDRFlag(scp, "rmdir");
3564         }
3565     }
3566
3567   done:
3568     if (free_fnamep)
3569         free(fnamep);
3570
3571     /* and return error code */
3572     return code;
3573 }
3574
3575 long cm_Open(cm_scache_t *scp, int type, cm_user_t *userp)
3576 {
3577     /* grab mutex on contents */
3578     lock_ObtainWrite(&scp->rw);
3579
3580     /* reset the prefetch info */
3581     scp->prefetch.base.LowPart = 0;             /* base */
3582     scp->prefetch.base.HighPart = 0;
3583     scp->prefetch.end.LowPart = 0;              /* and end */
3584     scp->prefetch.end.HighPart = 0;
3585
3586     /* release mutex on contents */
3587     lock_ReleaseWrite(&scp->rw);
3588
3589     /* we're done */
3590     return 0;
3591 }
3592
3593 /*! \brief Rename a file or directory
3594
3595   Encapsulates a RXAFS_Rename() call.
3596
3597   \param[in] oldDscp cm_scache_t for the directory containing the old
3598       name.
3599
3600   \param[in] oldNamep The original old name known to the file server.
3601       This is the name that will be passed into the RXAFS_Rename().
3602       If it is not provided, it will be looked up.
3603
3604   \param[in] normalizedOldNamep Normalized old name.  This is used for
3605   updating local directory caches.
3606
3607   \param[in] newDscp cm_scache_t for the directory containing the new
3608   name.
3609
3610   \param[in] newNamep New name. Normalized.
3611
3612   \param[in] userp cm_user_t for the request.
3613
3614   \param[in,out] reqp Request tracker.
3615
3616 */
3617 long cm_Rename(cm_scache_t *oldDscp, fschar_t *oldNamep, clientchar_t *cOldNamep,
3618                cm_scache_t *newDscp, clientchar_t *cNewNamep, cm_user_t *userp,
3619                cm_req_t *reqp)
3620 {
3621     cm_conn_t *connp;
3622     long code = 0;
3623     AFSFid oldDirAFSFid;
3624     AFSFid newDirAFSFid;
3625     AFSFetchStatus updatedOldDirStatus;
3626     AFSFetchStatus updatedNewDirStatus;
3627     AFSVolSync volSync;
3628     int oneDir = 0;
3629     int bTargetExists = 0;
3630     struct rx_connection * rxconnp;
3631     cm_dirOp_t oldDirOp;
3632     cm_fid_t   fileFid;
3633     int        diropCode = -1;
3634     cm_dirOp_t newDirOp;
3635     fschar_t * newNamep = NULL;
3636     int free_oldNamep = FALSE;
3637     cm_scache_t *oldScp = NULL, *oldTargetScp = NULL;
3638     int rpc_skipped = 0;
3639
3640     memset(&volSync, 0, sizeof(volSync));
3641
3642     if (cOldNamep == NULL || cNewNamep == NULL ||
3643         cm_ClientStrLen(cOldNamep) == 0 ||
3644         cm_ClientStrLen(cNewNamep) == 0)
3645         return CM_ERROR_INVAL;
3646
3647     /* check for identical names */
3648     if (oldDscp == newDscp &&
3649         cm_ClientStrCmp(cOldNamep, cNewNamep) == 0) {
3650         osi_Log2(afsd_logp, "cm_Rename oldDscp 0x%p newDscp 0x%p CM_ERROR_RENAME_IDENTICAL",
3651                   oldDscp, newDscp);
3652         return CM_ERROR_RENAME_IDENTICAL;
3653     }
3654
3655     /* Check for RO volume */
3656     if ((oldDscp->flags & CM_SCACHEFLAG_RO) || (newDscp->flags & CM_SCACHEFLAG_RO)) {
3657         return CM_ERROR_READONLY;
3658     }
3659
3660     if (oldNamep == NULL) {
3661         code = -1;
3662 #ifdef USE_BPLUS
3663         code = cm_BeginDirOp(oldDscp, userp, reqp, CM_DIRLOCK_READ,
3664                              CM_DIROP_FLAG_NONE, &oldDirOp);
3665         if (code == 0) {
3666             code = cm_BPlusDirLookupOriginalName(&oldDirOp, cOldNamep, &oldNamep);
3667             if (code == 0)
3668                 free_oldNamep = TRUE;
3669             cm_EndDirOp(&oldDirOp);
3670         }
3671 #endif
3672         if (code) {
3673             osi_Log2(afsd_logp, "cm_Rename oldDscp 0x%p cOldName %S Original Name lookup failed",
3674                       oldDscp, osi_LogSaveStringW(afsd_logp, cOldNamep));
3675             goto done;
3676         }
3677     }
3678
3679     /* before starting the RPC, mark that we're changing the directory data,
3680      * so that someone who does a chmod on the dir will wait until our call
3681      * completes.  We do this in vnode order so that we don't deadlock,
3682      * which makes the code a little verbose.
3683      */
3684     if (oldDscp == newDscp) {
3685         oneDir = 1;
3686         cm_BeginDirOp(oldDscp, userp, reqp, CM_DIRLOCK_NONE,
3687                       CM_DIROP_FLAG_NONE, &oldDirOp);
3688         lock_ObtainWrite(&oldDscp->rw);
3689         cm_dnlcRemove(oldDscp, cOldNamep);
3690         cm_dnlcRemove(oldDscp, cNewNamep);
3691         code = cm_SyncOp(oldDscp, NULL, userp, reqp, 0,
3692                           CM_SCACHESYNC_STOREDATA);
3693         lock_ReleaseWrite(&oldDscp->rw);
3694         if (code != 0) {
3695             cm_EndDirOp(&oldDirOp);
3696         }
3697     }
3698     else {
3699         /* two distinct dir vnodes */
3700         oneDir = 0;
3701         if (oldDscp->fid.cell != newDscp->fid.cell ||
3702              oldDscp->fid.volume != newDscp->fid.volume) {
3703             osi_Log2(afsd_logp, "cm_Rename oldDscp 0x%p newDscp 0x%p CM_ERROR_CROSSDEVLINK",
3704                       oldDscp, newDscp);
3705             code = CM_ERROR_CROSSDEVLINK;
3706             goto done;
3707         }
3708
3709         /* shouldn't happen that we have distinct vnodes for two
3710          * different files, but could due to deliberate attack, or
3711          * stale info.  Avoid deadlocks and quit now.
3712          */
3713         if (oldDscp->fid.vnode == newDscp->fid.vnode) {
3714             osi_Log2(afsd_logp, "cm_Rename oldDscp 0x%p newDscp 0x%p vnode collision",
3715                       oldDscp, newDscp);
3716             code = CM_ERROR_CROSSDEVLINK;
3717             goto done;
3718         }
3719
3720         if (oldDscp->fid.vnode < newDscp->fid.vnode) {
3721             cm_BeginDirOp(oldDscp, userp, reqp, CM_DIRLOCK_NONE,
3722                           CM_DIROP_FLAG_NONE, &oldDirOp);
3723             lock_ObtainWrite(&oldDscp->rw);
3724             cm_dnlcRemove(oldDscp, cOldNamep);
3725             code = cm_SyncOp(oldDscp, NULL, userp, reqp, 0,
3726                              CM_SCACHESYNC_STOREDATA);
3727             lock_ReleaseWrite(&oldDscp->rw);
3728             if (code != 0)
3729                 cm_EndDirOp(&oldDirOp);
3730             if (code == 0) {
3731                 cm_BeginDirOp(newDscp, userp, reqp, CM_DIRLOCK_NONE,
3732                               CM_DIROP_FLAG_NONE, &newDirOp);
3733                 lock_ObtainWrite(&newDscp->rw);
3734                 cm_dnlcRemove(newDscp, cNewNamep);
3735                 code = cm_SyncOp(newDscp, NULL, userp, reqp, 0,
3736                                  CM_SCACHESYNC_STOREDATA);
3737                 lock_ReleaseWrite(&newDscp->rw);
3738                 if (code) {
3739                     cm_EndDirOp(&newDirOp);
3740
3741                     /* cleanup first one */
3742                     lock_ObtainWrite(&oldDscp->rw);
3743                     cm_SyncOpDone(oldDscp, NULL,
3744                                    CM_SCACHESYNC_STOREDATA);
3745                     lock_ReleaseWrite(&oldDscp->rw);
3746                     cm_EndDirOp(&oldDirOp);
3747                 }
3748             }
3749         }
3750         else {
3751             /* lock the new vnode entry first */
3752             cm_BeginDirOp(newDscp, userp, reqp, CM_DIRLOCK_NONE,
3753                           CM_DIROP_FLAG_NONE, &newDirOp);
3754             lock_ObtainWrite(&newDscp->rw);
3755             cm_dnlcRemove(newDscp, cNewNamep);
3756             code = cm_SyncOp(newDscp, NULL, userp, reqp, 0,
3757                               CM_SCACHESYNC_STOREDATA);
3758             lock_ReleaseWrite(&newDscp->rw);
3759             if (code != 0)
3760                 cm_EndDirOp(&newDirOp);
3761             if (code == 0) {
3762                 cm_BeginDirOp(oldDscp, userp, reqp, CM_DIRLOCK_NONE,
3763                               CM_DIROP_FLAG_NONE, &oldDirOp);
3764                 lock_ObtainWrite(&oldDscp->rw);
3765                 cm_dnlcRemove(oldDscp, cOldNamep);
3766                 code = cm_SyncOp(oldDscp, NULL, userp, reqp, 0,
3767                                   CM_SCACHESYNC_STOREDATA);
3768                 lock_ReleaseWrite(&oldDscp->rw);
3769                 if (code != 0)
3770                     cm_EndDirOp(&oldDirOp);
3771                 if (code) {
3772                     /* cleanup first one */
3773                     lock_ObtainWrite(&newDscp->rw);
3774                     cm_SyncOpDone(newDscp, NULL,
3775                                    CM_SCACHESYNC_STOREDATA);
3776                     lock_ReleaseWrite(&newDscp->rw);
3777                     cm_EndDirOp(&newDirOp);
3778                 }
3779             }
3780         }
3781     }   /* two distinct vnodes */
3782
3783     if (code)
3784         goto done;
3785
3786     /*
3787      * The source and destination directories are now locked and no other local
3788      * changes can occur.
3789      *
3790      * Before we permit the operation, make sure that we do not already have
3791      * an object in the destination directory that has a case-insensitive match
3792      * for this name UNLESS the matching object is the object we are renaming.
3793      */
3794     code = cm_Lookup(oldDscp, cOldNamep, 0, userp, reqp, &oldScp);
3795     if (code) {
3796         osi_Log2(afsd_logp, "cm_Rename oldDscp 0x%p cOldName %S old name lookup failed",
3797                  oldDscp, osi_LogSaveStringW(afsd_logp, cOldNamep));
3798         rpc_skipped = 1;
3799         goto post_rpc;
3800     }
3801
3802     /* Case sensitive lookup.  If this succeeds we are done. */
3803     code = cm_Lookup(newDscp, cNewNamep, 0, userp, reqp, &oldTargetScp);
3804     if (code) {
3805         /*
3806          * Case insensitive lookup.  If this succeeds, it could have found the
3807          * same file with a name that differs only by case or it could be a
3808          * different file entirely.
3809          */
3810         code = cm_Lookup(newDscp, cNewNamep, CM_FLAG_CASEFOLD, userp, reqp, &oldTargetScp);
3811         if (code == 0) {
3812             /* found a matching object with the new name */
3813             if (cm_FidCmp(&oldScp->fid, &oldTargetScp->fid)) {
3814                 /* and they don't match so return an error */
3815                 osi_Log2(afsd_logp, "cm_Rename newDscp 0x%p cNewName %S new name already exists",
3816                           newDscp, osi_LogSaveStringW(afsd_logp, cNewNamep));
3817                 code = CM_ERROR_EXISTS;
3818             }
3819             cm_ReleaseSCache(oldTargetScp);
3820             oldTargetScp = NULL;
3821         } else if (code == CM_ERROR_AMBIGUOUS_FILENAME) {
3822             code = CM_ERROR_EXISTS;
3823         } else {
3824             /* The target does not exist.  Clear the error and perform the rename. */
3825             code = 0;
3826         }
3827     } else {
3828         bTargetExists = 1;
3829     }
3830
3831     if (code) {
3832         rpc_skipped = 1;
3833         goto post_rpc;
3834     }
3835
3836     newNamep = cm_ClientStringToFsStringAlloc(cNewNamep, -1, NULL);
3837
3838     /* try the RPC now */
3839     InterlockedIncrement(&oldDscp->activeRPCs);
3840     if (!oneDir)
3841         InterlockedIncrement(&newDscp->activeRPCs);
3842     osi_Log2(afsd_logp, "CALL Rename old scp 0x%p new scp 0x%p",
3843               oldDscp, newDscp);
3844     do {
3845         code = cm_ConnFromFID(&oldDscp->fid, userp, reqp, &connp);
3846         if (code)
3847             continue;
3848
3849         oldDirAFSFid.Volume = oldDscp->fid.volume;
3850         oldDirAFSFid.Vnode = oldDscp->fid.vnode;
3851         oldDirAFSFid.Unique = oldDscp->fid.unique;
3852         newDirAFSFid.Volume = newDscp->fid.volume;
3853         newDirAFSFid.Vnode = newDscp->fid.vnode;
3854         newDirAFSFid.Unique = newDscp->fid.unique;
3855
3856         rxconnp = cm_GetRxConn(connp);
3857         code = RXAFS_Rename(rxconnp, &oldDirAFSFid, oldNamep,
3858                             &newDirAFSFid, newNamep,
3859                             &updatedOldDirStatus, &updatedNewDirStatus,
3860                             &volSync);
3861         rx_PutConnection(rxconnp);
3862
3863     } while (cm_Analyze(connp, userp, reqp, &oldDscp->fid,
3864                          &volSync, NULL, NULL, code));
3865     code = cm_MapRPCError(code, reqp);
3866
3867     if (code)
3868         osi_Log1(afsd_logp, "CALL Rename FAILURE, code 0x%x", code);
3869     else
3870         osi_Log0(afsd_logp, "CALL Rename SUCCESS");
3871
3872   post_rpc:
3873     /* update the individual stat cache entries for the directories */
3874     if (oldDirOp.scp) {
3875         lock_ObtainWrite(&oldDirOp.scp->dirlock);
3876         oldDirOp.lockType = CM_DIRLOCK_WRITE;
3877     }
3878
3879     lock_ObtainWrite(&oldDscp->rw);
3880     if (code == 0) {
3881         cm_MergeStatus(NULL, oldDscp, &updatedOldDirStatus, &volSync,
3882                        userp, reqp, CM_MERGEFLAG_DIROP);
3883         if (cm_CheckDirOpForSingleChange(&oldDirOp)) {
3884             lock_ReleaseWrite(&oldDscp->rw);
3885             if (bTargetExists && oneDir) {
3886                 diropCode = cm_DirDeleteEntry(&oldDirOp, newNamep);
3887 #ifdef USE_BPLUS
3888                 cm_BPlusDirDeleteEntry(&oldDirOp, cNewNamep);
3889 #endif
3890             }
3891
3892 #ifdef USE_BPLUS
3893             diropCode = cm_BPlusDirLookup(&oldDirOp, cOldNamep, &fileFid);
3894             if (diropCode == CM_ERROR_INEXACT_MATCH)
3895                 diropCode = 0;
3896             else if (diropCode == EINVAL)
3897 #endif
3898                 diropCode = cm_DirLookup(&oldDirOp, oldNamep, &fileFid);
3899
3900             if (diropCode == 0) {
3901                 if (oneDir) {
3902                     diropCode = cm_DirCreateEntry(&oldDirOp, newNamep, &fileFid);
3903 #ifdef USE_BPLUS
3904                     cm_BPlusDirCreateEntry(&oldDirOp, cNewNamep, &fileFid);
3905 #endif
3906                 }
3907
3908                 if (diropCode == 0) {
3909                     diropCode = cm_DirDeleteEntry(&oldDirOp, oldNamep);
3910 #ifdef USE_BPLUS
3911                     cm_BPlusDirDeleteEntry(&oldDirOp, cOldNamep);
3912 #endif
3913                 }
3914             }
3915             lock_ObtainWrite(&oldDscp->rw);
3916         }
3917     } else {
3918         if (!rpc_skipped)
3919             InterlockedDecrement(&oldDscp->activeRPCs);
3920     }
3921     cm_SyncOpDone(oldDscp, NULL, CM_SCACHESYNC_STOREDATA);
3922     lock_ReleaseWrite(&oldDscp->rw);
3923
3924     cm_EndDirOp(&oldDirOp);
3925
3926     /* and update it for the new one, too, if necessary */
3927     if (!oneDir) {
3928         if (newDirOp.scp) {
3929             lock_ObtainWrite(&newDirOp.scp->dirlock);
3930             newDirOp.lockType = CM_DIRLOCK_WRITE;
3931         }
3932         lock_ObtainWrite(&newDscp->rw);
3933         if (code == 0) {
3934             cm_MergeStatus(NULL, newDscp, &updatedNewDirStatus, &volSync,
3935                             userp, reqp, CM_MERGEFLAG_DIROP);
3936
3937             /*
3938              * we only make the local change if we successfully made
3939              * the change in the old directory AND there was only one
3940              * change in the new directory
3941              */
3942             if (diropCode == 0 && cm_CheckDirOpForSingleChange(&newDirOp)) {
3943                 lock_ReleaseWrite(&newDscp->rw);
3944
3945                 if (bTargetExists && !oneDir) {
3946                     diropCode = cm_DirDeleteEntry(&newDirOp, newNamep);
3947 #ifdef USE_BPLUS
3948                     cm_BPlusDirDeleteEntry(&newDirOp, cNewNamep);
3949 #endif
3950                 }
3951
3952                 cm_DirCreateEntry(&newDirOp, newNamep, &fileFid);
3953 #ifdef USE_BPLUS
3954                 cm_BPlusDirCreateEntry(&newDirOp, cNewNamep, &fileFid);
3955 #endif
3956                 lock_ObtainWrite(&newDscp->rw);
3957             }
3958         } else {
3959             if (!rpc_skipped)
3960                 InterlockedIncrement(&newDscp->activeRPCs);
3961         }
3962         cm_SyncOpDone(newDscp, NULL, CM_SCACHESYNC_STOREDATA);
3963         lock_ReleaseWrite(&newDscp->rw);
3964
3965         cm_EndDirOp(&newDirOp);
3966     }
3967
3968     if (code == 0) {
3969         /*
3970          * After the rename the file server has invalidated the callbacks
3971          * on the file that was moved and destroyed any target file.
3972          */
3973         lock_ObtainWrite(&oldScp->rw);
3974         cm_DiscardSCache(oldScp);
3975         lock_ReleaseWrite(&oldScp->rw);
3976
3977         if (RDR_Initialized)
3978             RDR_InvalidateObject(oldScp->fid.cell, oldScp->fid.volume, oldScp->fid.vnode, oldScp->fid.unique,
3979                                   oldScp->fid.hash, oldScp->fileType, AFS_INVALIDATE_CALLBACK);
3980
3981         if (oldTargetScp) {
3982             lock_ObtainWrite(&oldTargetScp->rw);
3983             cm_DiscardSCache(oldTargetScp);
3984             lock_ReleaseWrite(&oldTargetScp->rw);
3985
3986             if (RDR_Initialized)
3987                 RDR_InvalidateObject(oldTargetScp->fid.cell, oldTargetScp->fid.volume, oldTargetScp->fid.vnode, oldTargetScp->fid.unique,
3988                                      oldTargetScp->fid.hash, oldTargetScp->fileType, AFS_INVALIDATE_CALLBACK);
3989         }
3990     }
3991
3992   done:
3993     if (oldScp)
3994         cm_ReleaseSCache(oldScp);
3995
3996     if (oldTargetScp)
3997         cm_ReleaseSCache(oldTargetScp);
3998
3999     if (free_oldNamep)
4000         free(oldNamep);
4001
4002     free(newNamep);
4003
4004     /* and return error code */
4005     return code;
4006 }
4007
4008 /* Byte range locks:
4009
4010    The OpenAFS Windows client has to fake byte range locks given no
4011    server side support for such locks.  This is implemented as keyed
4012    byte range locks on the cache manager.
4013
4014    Keyed byte range locks:
4015
4016    Each cm_scache_t structure keeps track of a list of keyed locks.
4017    The key for a lock identifies an owner of a set of locks (referred
4018    to as a client).  Each key is represented by a value.  The set of
4019    key values used within a specific cm_scache_t structure form a
4020    namespace that has a scope of just that cm_scache_t structure.  The
4021    same key value can be used with another cm_scache_t structure and
4022    correspond to a completely different client.  However it is
4023    advantageous for the SMB or IFS layer to make sure that there is a
4024    1-1 mapping between client and keys over all cm_scache_t objects.
4025
4026    Assume a client C has key Key(C) (although, since the scope of the
4027    key is a cm_scache_t, the key can be Key(C,S), where S is the
4028    cm_scache_t.  But assume a 1-1 relation between keys and clients).
4029    A byte range (O,+L) denotes byte addresses (O) through (O+L-1)
4030    inclusive (a.k.a. [O,O+L-1]).  The function Key(x) is implemented
4031    through cm_generateKey() function for both SMB and IFS.
4032
4033    The list of locks for a cm_scache_t object S is maintained in
4034    S->fileLocks.  The cache manager will set a lock on the AFS file
4035    server in order to assert the locks in S->fileLocks.  If only
4036    shared locks are in place for S, then the cache manager will obtain
4037    a LockRead lock, while if there are any exclusive locks, it will
4038    obtain a LockWrite lock.  If the exclusive locks are all released
4039    while the shared locks remain, then the cache manager will
4040    downgrade the lock from LockWrite to LockRead.  Similarly, if an
4041    exclusive lock is obtained when only shared locks exist, then the
4042    cache manager will try to upgrade the lock from LockRead to
4043    LockWrite.
4044
4045    Each lock L owned by client C maintains a key L->key such that
4046    L->key == Key(C), the effective range defined by L->LOffset and
4047    L->LLength such that the range of bytes affected by the lock is
4048    (L->LOffset, +L->LLength), a type maintained in L->LockType which
4049    is either exclusive or shared.
4050
4051    Lock states:
4052
4053    A lock exists iff it is in S->fileLocks for some cm_scache_t
4054    S. Existing locks are in one of the following states: ACTIVE,
4055    WAITLOCK, WAITUNLOCK, LOST, DELETED.
4056
4057    The following sections describe each lock and the associated
4058    transitions.
4059
4060    1. ACTIVE: A lock L is ACTIVE iff the cache manager has asserted
4061       the lock with the AFS file server.  This type of lock can be
4062       exercised by a client to read or write to the locked region (as
4063       the lock allows).
4064
4065       1.1 ACTIVE->LOST: When the AFS file server fails to extend a
4066         server lock that was required to assert the lock.  Before
4067         marking the lock as lost, the cache manager checks if the file
4068         has changed on the server.  If the file has not changed, then
4069         the cache manager will attempt to obtain a new server lock
4070         that is sufficient to assert the client side locks for the
4071         file.  If any of these fail, the lock is marked as LOST.
4072         Otherwise, it is left as ACTIVE.
4073
4074       1.2 ACTIVE->DELETED: Lock is released.
4075
4076    2. WAITLOCK: A lock is in a WAITLOCK state if the cache manager
4077       grants the lock but the lock is yet to be asserted with the AFS
4078       file server.  Once the file server grants the lock, the state
4079       will transition to an ACTIVE lock.
4080
4081       2.1 WAITLOCK->ACTIVE: The server granted the lock.
4082
4083       2.2 WAITLOCK->DELETED: Lock is abandoned, or timed out during
4084         waiting.
4085
4086       2.3 WAITLOCK->LOST: One or more locks from this client were
4087         marked as LOST.  No further locks will be granted to this
4088         client until all lost locks are removed.
4089
4090    3. WAITUNLOCK: A lock is in a WAITUNLOCK state if the cache manager
4091       receives a request for a lock that conflicts with an existing
4092       ACTIVE or WAITLOCK lock.  The lock will be placed in the queue
4093       and will be granted at such time the conflicting locks are
4094       removed, at which point the state will transition to either
4095       WAITLOCK or ACTIVE.
4096
4097       3.1 WAITUNLOCK->ACTIVE: The conflicting lock was removed.  The
4098         current serverLock is sufficient to assert this lock, or a
4099         sufficient serverLock is obtained.
4100
4101       3.2 WAITUNLOCK->WAITLOCK: The conflicting lock was removed,
4102         however the required serverLock is yet to be asserted with the
4103         server.
4104
4105       3.3 WAITUNLOCK->DELETED: The lock is abandoned, timed out or
4106         released.
4107
4108       3.5 WAITUNLOCK->LOST: One or more locks from this client were
4109         marked as LOST.  No further locks will be granted to this
4110         client until all lost locks are removed.
4111
4112    4. LOST: A lock L is LOST if the server lock that was required to
4113       assert the lock could not be obtained or if it could not be
4114       extended, or if other locks by the same client were LOST.
4115       Essentially, once a lock is LOST, the contract between the cache
4116       manager and that specific client is no longer valid.
4117
4118       The cache manager rechecks the server lock once every minute and
4119       extends it as appropriate.  If this is not done for 5 minutes,
4120       the AFS file server will release the lock (the 5 minute timeout
4121       is based on current file server code and is fairly arbitrary).
4122       Once released, the lock cannot be re-obtained without verifying
4123       that the contents of the file hasn't been modified since the
4124       time the lock was released.  Re-obtaining the lock without
4125       verifying this may lead to data corruption.  If the lock can not
4126       be obtained safely, then all active locks for the cm_scache_t
4127       are marked as LOST.
4128
4129       4.1 LOST->DELETED: The lock is released.
4130
4131    5. DELETED: The lock is no longer relevant.  Eventually, it will
4132       get removed from the cm_scache_t. In the meantime, it will be
4133       treated as if it does not exist.
4134
4135       5.1 DELETED->not exist: The lock is removed from the
4136         cm_scache_t.
4137
4138    The following are classifications of locks based on their state.
4139
4140    6* A lock L is ACCEPTED if it is ACTIVE or WAITLOCK.  These locks
4141       have been accepted by the cache manager, but may or may not have
4142       been granted back to the client.
4143
4144    7* A lock L is QUEUED if it is ACTIVE, WAITLOCK or WAITUNLOCK.
4145
4146    8* A lock L is WAITING if it is WAITLOCK or WAITUNLOCK.
4147
4148    Lock operation:
4149
4150    A client C can READ range (Offset,+Length) of a file represented by
4151    cm_scache_t S iff (1):
4152
4153    1. for all _a_ in (Offset,+Length), all of the following is true:
4154
4155        1.1 For each ACTIVE lock L in S->fileLocks such that _a_ in
4156          (L->LOffset,+L->LLength); L->key == Key(C) OR L->LockType is
4157          shared.
4158
4159        1.2 For each LOST lock L in S->fileLocks such that _a_ in
4160          (L->LOffset,+L->LLength); L->LockType is shared AND L->key !=
4161          Key(C)
4162
4163        (When locks are lost on an cm_scache_t, all locks are lost.  By
4164        4.2 (below), if there is an exclusive LOST lock, then there
4165        can't be any overlapping ACTIVE locks.)
4166
4167    A client C can WRITE range (Offset,+Length) of cm_scache_t S iff (2):
4168
4169    2. for all _a_ in (Offset,+Length), one of the following is true:
4170
4171        2.1 Byte _a_ of S is unowned (as specified in 1.1) AND there
4172          does not exist a LOST lock L such that _a_ in
4173          (L->LOffset,+L->LLength).
4174
4175        2.2 Byte _a_ of S is owned by C under lock L (as specified in
4176          1.2) AND L->LockType is exclusive.
4177
4178    A client C can OBTAIN a lock L on cm_scache_t S iff (both 3 and 4):
4179
4180    3. for all _a_ in (L->LOffset,+L->LLength), ALL of the following is
4181       true:
4182
4183        3.1 If L->LockType is exclusive then there does NOT exist a
4184          ACCEPTED lock M in S->fileLocks such that _a_ in
4185          (M->LOffset,+M->LLength).
4186
4187          (If we count all QUEUED locks then we hit cases such as
4188          cascading waiting locks where the locks later on in the queue
4189          can be granted without compromising file integrity.  On the
4190          other hand if only ACCEPTED locks are considered, then locks
4191          that were received earlier may end up waiting for locks that
4192          were received later to be unlocked. The choice of ACCEPTED
4193          locks was made to mimic the Windows byte range lock
4194          semantics.)
4195
4196        3.2 If L->LockType is shared then for each ACCEPTED lock M in
4197          S->fileLocks, if _a_ in (M->LOffset,+M->LLength) then
4198          M->LockType is shared.
4199
4200    4. For all LOST locks M in S->fileLocks, ALL of the following are true:
4201
4202        4.1 M->key != Key(C)
4203
4204        4.2 If M->LockType is exclusive, then (L->LOffset,+L->LLength)
4205          and (M->LOffset,+M->LLength) do not intersect.
4206
4207          (Note: If a client loses a lock, it loses all locks.
4208          Subsequently, it will not be allowed to obtain any more locks
4209          until all existing LOST locks that belong to the client are
4210          released.  Once all locks are released by a single client,
4211          there exists no further contract between the client and AFS
4212          about the contents of the file, hence the client can then
4213          proceed to obtain new locks and establish a new contract.
4214
4215          This doesn't quite work as you think it should, because most
4216          applications aren't built to deal with losing locks they
4217          thought they once had.  For now, we don't have a good
4218          solution to lost locks.
4219
4220          Also, for consistency reasons, we have to hold off on
4221          granting locks that overlap exclusive LOST locks.)
4222
4223    A client C can only unlock locks L in S->fileLocks which have
4224    L->key == Key(C).
4225
4226    The representation and invariants are as follows:
4227
4228    - Each cm_scache_t structure keeps:
4229
4230        - A queue of byte-range locks (cm_scache_t::fileLocks) which
4231          are of type cm_file_lock_t.
4232
4233        - A record of the highest server-side lock that has been
4234          obtained for this object (cm_scache_t::serverLock), which is
4235          one of (-1), LockRead, LockWrite.
4236
4237        - A count of ACCEPTED exclusive and shared locks that are in the
4238          queue (cm_scache_t::sharedLocks and
4239          cm_scache_t::exclusiveLocks)
4240
4241    - Each cm_file_lock_t structure keeps:
4242
4243        - The type of lock (cm_file_lock_t::LockType)
4244
4245        - The key associated with the lock (cm_file_lock_t::key)
4246
4247        - The offset and length of the lock (cm_file_lock_t::LOffset
4248          and cm_file_lock_t::LLength)
4249
4250        - The state of the lock.
4251
4252        - Time of issuance or last successful extension
4253
4254    Semantic invariants:
4255
4256        I1. The number of ACCEPTED locks in S->fileLocks are
4257            (S->sharedLocks + S->exclusiveLocks)
4258
4259    External invariants:
4260
4261        I3. S->serverLock is the lock that we have asserted with the
4262            AFS file server for this cm_scache_t.
4263
4264        I4. S->serverLock == LockRead iff there is at least one ACTIVE
4265            shared lock, but no ACTIVE exclusive locks.
4266
4267        I5. S->serverLock == LockWrite iff there is at least one ACTIVE
4268            exclusive lock.
4269
4270        I6. If L is a LOST lock, then for each lock M in S->fileLocks,
4271            M->key == L->key IMPLIES M is LOST or DELETED.
4272
4273    --asanka
4274  */
4275
4276 #define IS_LOCK_ACTIVE(lockp)     (((lockp)->flags & (CM_FILELOCK_FLAG_DELETED|CM_FILELOCK_FLAG_WAITLOCK|CM_FILELOCK_FLAG_WAITUNLOCK|CM_FILELOCK_FLAG_LOST)) == 0)
4277
4278 #define IS_LOCK_WAITLOCK(lockp)   (((lockp)->flags & (CM_FILELOCK_FLAG_DELETED|CM_FILELOCK_FLAG_WAITLOCK|CM_FILELOCK_FLAG_WAITUNLOCK|CM_FILELOCK_FLAG_LOST)) == CM_FILELOCK_FLAG_WAITLOCK)
4279
4280 #define IS_LOCK_WAITUNLOCK(lockp) (((lockp)->flags & (CM_FILELOCK_FLAG_DELETED|CM_FILELOCK_FLAG_WAITLOCK|CM_FILELOCK_FLAG_WAITUNLOCK|CM_FILELOCK_FLAG_LOST)) == CM_FILELOCK_FLAG_WAITUNLOCK)
4281
4282 #define IS_LOCK_LOST(lockp)       (((lockp)->flags & (CM_FILELOCK_FLAG_DELETED|CM_FILELOCK_FLAG_LOST)) == CM_FILELOCK_FLAG_LOST)
4283
4284 #define IS_LOCK_DELETED(lockp)    (((lockp)->flags & CM_FILELOCK_FLAG_DELETED) == CM_FILELOCK_FLAG_DELETED)
4285
4286 /* unsafe */
4287 #define IS_LOCK_ACCEPTED(lockp)   (IS_LOCK_ACTIVE(lockp) || IS_LOCK_WAITLOCK(lockp))
4288
4289 /* unsafe */
4290 #define IS_LOCK_CLIENTONLY(lockp) ((((lockp)->scp->flags & CM_SCACHEFLAG_RO) == CM_SCACHEFLAG_RO) || (((lockp)->flags & CM_FILELOCK_FLAG_CLIENTONLY) == CM_FILELOCK_FLAG_CLIENTONLY))
4291
4292 /* unsafe */
4293 #define INTERSECT_RANGE(r1,r2) (((r2).offset+(r2).length) > (r1).offset && ((r1).offset +(r1).length) > (r2).offset)
4294
4295 /* unsafe */
4296 #define CONTAINS_RANGE(r1,r2) (((r2).offset+(r2).length) <= ((r1).offset+(r1).length) && (r1).offset <= (r2).offset)
4297
4298 #if defined(VICED_CAPABILITY_USE_BYTE_RANGE_LOCKS) && !defined(LOCK_TESTING)
4299 #define SCP_SUPPORTS_BRLOCKS(scp) ((scp)->cbServerp && ((scp)->cbServerp->capabilities & VICED_CAPABILITY_USE_BYTE_RANGE_LOCKS))
4300 #else
4301 #define SCP_SUPPORTS_BRLOCKS(scp) (1)
4302 #endif
4303
4304 #define SERVERLOCKS_ENABLED(scp) (!((scp)->flags & CM_SCACHEFLAG_RO) && cm_enableServerLocks && SCP_SUPPORTS_BRLOCKS(scp))
4305
4306 #if defined(VICED_CAPABILITY_WRITELOCKACL)
4307 #define SCP_SUPPORTS_WRITELOCKACL(scp) ((scp)->cbServerp && ((scp->cbServerp->capabilities & VICED_CAPABILITY_WRITELOCKACL)))
4308 #else
4309 #define SCP_SUPPORTS_WRITELOCKACL(scp) (0)
4310
4311 /* This should really be defined in any build that this code is being
4312    compiled. */
4313 #error  VICED_CAPABILITY_WRITELOCKACL not defined.
4314 #endif
4315
4316 static void cm_LockRangeSubtract(cm_range_t * pos, const cm_range_t * neg)
4317 {
4318     afs_int64 int_begin;
4319     afs_int64 int_end;
4320
4321     int_begin = max(pos->offset, neg->offset);
4322     int_end = min(pos->offset+pos->length, neg->offset+neg->length);
4323
4324     if (int_begin < int_end) {
4325         if (int_begin == pos->offset) {
4326             pos->length = pos->offset + pos->length - int_end;
4327             pos->offset = int_end;
4328         } else if (int_end == pos->offset + pos->length) {
4329             pos->length = int_begin - pos->offset;
4330         }
4331
4332         /* We only subtract ranges if the resulting range is
4333            contiguous.  If we try to support non-contigous ranges, we
4334            aren't actually improving performance. */
4335     }
4336 }
4337
4338 /* Called with scp->rw held.  Returns 0 if all is clear to read the
4339    specified range by the client identified by key.
4340  */
4341 long cm_LockCheckRead(cm_scache_t *scp,
4342                       LARGE_INTEGER LOffset,
4343                       LARGE_INTEGER LLength,
4344                       cm_key_t key)
4345 {
4346 #ifndef ADVISORY_LOCKS
4347
4348     cm_file_lock_t *fileLock;
4349     osi_queue_t *q;
4350     long code = 0;
4351     cm_range_t range;
4352     int substract_ranges = FALSE;
4353
4354     range.offset = LOffset.QuadPart;
4355     range.length = LLength.QuadPart;
4356
4357     /*
4358
4359      1. for all _a_ in (Offset,+Length), all of the following is true:
4360
4361        1.1 For each ACTIVE lock L in S->fileLocks such that _a_ in
4362          (L->LOffset,+L->LLength); L->key == Key(C) OR L->LockType is
4363          shared.
4364
4365        1.2 For each LOST lock L in S->fileLocks such that _a_ in
4366          (L->LOffset,+L->LLength); L->LockType is shared AND L->key !=
4367          Key(C)
4368
4369     */
4370
4371     lock_ObtainRead(&cm_scacheLock);
4372
4373     for (q = scp->fileLocksH; q && range.length > 0; q = osi_QNext(q)) {
4374         fileLock =
4375             (cm_file_lock_t *)((char *) q - offsetof(cm_file_lock_t, fileq));
4376
4377         if (INTERSECT_RANGE(range, fileLock->range)) {
4378             if (IS_LOCK_ACTIVE(fileLock)) {
4379                 if (cm_KeyEquals(&fileLock->key, &key, 0)) {
4380
4381                     /* If there is an active lock for this client, it
4382                        is safe to substract ranges.*/
4383                     cm_LockRangeSubtract(&range, &fileLock->range);
4384                     substract_ranges = TRUE;
4385                 } else {
4386                     if (fileLock->lockType != LockRead) {
4387                         code = CM_ERROR_LOCK_CONFLICT;
4388                         break;
4389                     }
4390
4391                     /* even if the entire range is locked for reading,
4392                        we still can't grant the lock at this point
4393                        because the client may have lost locks. That
4394                        is, unless we have already seen an active lock
4395                        belonging to the client, in which case there
4396                        can't be any lost locks for this client. */
4397                     if (substract_ranges)
4398                         cm_LockRangeSubtract(&range, &fileLock->range);
4399                 }
4400             } else if (IS_LOCK_LOST(fileLock) &&
4401                        (cm_KeyEquals(&fileLock->key, &key, 0) || fileLock->lockType == LockWrite)) {
4402                 code = CM_ERROR_BADFD;
4403                 break;
4404             }
4405         }
4406     }
4407
4408     lock_ReleaseRead(&cm_scacheLock);
4409
4410     osi_Log4(afsd_logp, "cm_LockCheckRead scp 0x%x offset %d length %d code 0x%x",
4411               scp, (unsigned long)LOffset.QuadPart, (unsigned long)LLength.QuadPart, code);
4412
4413     return code;
4414
4415 #else
4416
4417     return 0;
4418
4419 #endif
4420 }
4421
4422 /* Called with scp->rw held.  Returns 0 if all is clear to write the
4423    specified range by the client identified by key.
4424  */
4425 long cm_LockCheckWrite(cm_scache_t *scp,
4426                        LARGE_INTEGER LOffset,
4427                        LARGE_INTEGER LLength,
4428                        cm_key_t key)
4429 {
4430 #ifndef ADVISORY_LOCKS
4431
4432     cm_file_lock_t *fileLock;
4433     osi_queue_t *q;
4434     long code = 0;
4435     cm_range_t range;
4436
4437     range.offset = LOffset.QuadPart;
4438     range.length = LLength.QuadPart;
4439
4440     /*
4441    A client C can WRITE range (Offset,+Length) of cm_scache_t S iff (2):
4442
4443    2. for all _a_ in (Offset,+Length), one of the following is true:
4444
4445        2.1 Byte _a_ of S is unowned AND there does not exist a LOST
4446          lock L such that _a_ in (L->LOffset,+L->LLength).
4447
4448        2.2 Byte _a_ of S is owned by C under lock L AND L->LockType is
4449          exclusive.
4450     */
4451
4452     lock_ObtainRead(&cm_scacheLock);
4453
4454     for (q = scp->fileLocksH; q && range.length > 0; q = osi_QNext(q)) {
4455         fileLock =
4456             (cm_file_lock_t *)((char *) q - offsetof(cm_file_lock_t, fileq));
4457
4458         if (INTERSECT_RANGE(range, fileLock->range)) {
4459             if (IS_LOCK_ACTIVE(fileLock)) {
4460                 if (cm_KeyEquals(&fileLock->key, &key, 0)) {
4461                     if (fileLock->lockType == LockWrite) {
4462
4463                         /* if there is an active lock for this client, it
4464                            is safe to substract ranges */
4465                         cm_LockRangeSubtract(&range, &fileLock->range);
4466                     } else {
4467                         code = CM_ERROR_LOCK_CONFLICT;
4468                         break;
4469                     }
4470                 } else {
4471                     code = CM_ERROR_LOCK_CONFLICT;
4472                     break;
4473                 }
4474             } else if (IS_LOCK_LOST(fileLock)) {
4475                 code = CM_ERROR_BADFD;
4476                 break;
4477             }
4478         }
4479     }
4480
4481     lock_ReleaseRead(&cm_scacheLock);
4482
4483     osi_Log4(afsd_logp, "cm_LockCheckWrite scp 0x%x offset %d length %d code 0x%x",
4484               scp, (unsigned long)LOffset.QuadPart, (unsigned long)LLength.QuadPart, code);
4485
4486     return code;
4487
4488 #else
4489
4490     return 0;
4491
4492 #endif
4493 }
4494
4495 /* Called with cm_scacheLock write locked */
4496 static cm_file_lock_t * cm_GetFileLock(void) {
4497     cm_file_lock_t * l;
4498
4499     l = (cm_file_lock_t *) cm_freeFileLocks;
4500     if (l) {
4501         osi_QRemove(&cm_freeFileLocks, &l->q);
4502     } else {
4503         l = malloc(sizeof(cm_file_lock_t));
4504         osi_assertx(l, "null cm_file_lock_t");
4505     }
4506
4507     memset(l, 0, sizeof(cm_file_lock_t));
4508
4509     return l;
4510 }
4511
4512 /* Called with cm_scacheLock write locked */
4513 static void cm_PutFileLock(cm_file_lock_t *l) {
4514     osi_QAdd(&cm_freeFileLocks, &l->q);
4515 }
4516
4517 /* called with scp->rw held.  May release it during processing, but
4518    leaves it held on exit. */
4519 long cm_IntSetLock(cm_scache_t * scp, cm_user_t * userp, int lockType,
4520                    cm_req_t * reqp) {
4521     long code = 0;
4522     AFSFid tfid;
4523     cm_fid_t cfid;
4524     cm_conn_t * connp;
4525     struct rx_connection * rxconnp;
4526     AFSVolSync volSync;
4527     afs_uint32 reqflags = reqp->flags;
4528
4529     osi_Log2(afsd_logp, "CALL SetLock scp 0x%p for lock %d", scp, lockType);
4530
4531         if ((lockType != LOCKING_ANDX_SHARED_LOCK && scp->fsLockCount != 0) ||
4532                 (lockType == LOCKING_ANDX_SHARED_LOCK && scp->fsLockCount < 0))
4533         {
4534                 code = CM_ERROR_LOCK_NOT_GRANTED;
4535         osi_Log2(afsd_logp, "CALL SetLock FAILURE, fsLockCount %d code 0x%x", scp->fsLockCount, code);
4536                 return code;
4537         }
4538
4539     memset(&volSync, 0, sizeof(volSync));
4540
4541     tfid.Volume = scp->fid.volume;
4542     tfid.Vnode = scp->fid.vnode;
4543     tfid.Unique = scp->fid.unique;
4544     cfid = scp->fid;
4545
4546     reqp->flags |= CM_REQ_NORETRY;
4547     lock_ReleaseWrite(&scp->rw);
4548
4549     do {
4550         code = cm_ConnFromFID(&cfid, userp, reqp, &connp);
4551         if (code)
4552             break;
4553
4554         rxconnp = cm_GetRxConn(connp);
4555         code = RXAFS_SetLock(rxconnp, &tfid, lockType,
4556                              &volSync);
4557         rx_PutConnection(rxconnp);
4558
4559     } while (cm_Analyze(connp, userp, reqp, &cfid, &volSync,
4560                         NULL, NULL, code));
4561
4562     code = cm_MapRPCError(code, reqp);
4563     if (code) {
4564         osi_Log1(afsd_logp, "CALL SetLock FAILURE, code 0x%x", code);
4565     } else {
4566         osi_Log0(afsd_logp, "CALL SetLock SUCCESS");
4567     }
4568
4569     reqp->flags = reqflags;
4570
4571     lock_ObtainWrite(&scp->rw);
4572     if (code == 0) {
4573         /*
4574          * The file server does not return a status structure so we must
4575          * locally track the file server lock count to the best of our
4576          * ability.
4577          */
4578         if (lockType == LockWrite)
4579             scp->fsLockCount = -1;
4580         else
4581             scp->fsLockCount++;
4582     }
4583     return code;
4584 }
4585
4586 /* called with scp->rw held.  Releases it during processing */
4587 long cm_IntReleaseLock(cm_scache_t * scp, cm_user_t * userp,
4588                        cm_req_t * reqp) {
4589     long code = 0;
4590     AFSFid tfid;
4591     cm_fid_t cfid;
4592     cm_conn_t * connp;
4593     struct rx_connection * rxconnp;
4594     AFSVolSync volSync;
4595
4596     if (scp->flags & CM_SCACHEFLAG_DELETED) {
4597         osi_Log1(afsd_logp, "CALL ReleaseLock on Deleted Vnode scp 0x%p", scp);
4598         return 0;
4599     }
4600
4601     memset(&volSync, 0, sizeof(volSync));
4602
4603     tfid.Volume = scp->fid.volume;
4604     tfid.Vnode = scp->fid.vnode;
4605     tfid.Unique = scp->fid.unique;
4606     cfid = scp->fid;
4607
4608     lock_ReleaseWrite(&scp->rw);
4609
4610     osi_Log1(afsd_logp, "CALL ReleaseLock scp 0x%p", scp);
4611
4612     do {
4613         code = cm_ConnFromFID(&cfid, userp, reqp, &connp);
4614         if (code)
4615             break;
4616
4617         rxconnp = cm_GetRxConn(connp);
4618         code = RXAFS_ReleaseLock(rxconnp, &tfid, &volSync);
4619         rx_PutConnection(rxconnp);
4620
4621     } while (cm_Analyze(connp, userp, reqp, &cfid, &volSync,
4622                         NULL, NULL, code));
4623     code = cm_MapRPCError(code, reqp);
4624     if (code)
4625         osi_Log1(afsd_logp,
4626                  "CALL ReleaseLock FAILURE, code 0x%x", code);
4627     else
4628         osi_Log0(afsd_logp,
4629                  "CALL ReleaseLock SUCCESS");
4630
4631     lock_ObtainWrite(&scp->rw);
4632     if (code == 0) {
4633         /*
4634          * The file server does not return a status structure so we must
4635          * locally track the file server lock count to the best of our
4636          * ability.
4637          */
4638         scp->fsLockCount--;
4639         if (scp->fsLockCount < 0)
4640             scp->fsLockCount = 0;
4641     }
4642
4643     return (code != CM_ERROR_BADFD ? code : 0);
4644 }
4645
4646 /* called with scp->rw held.  May release it during processing, but
4647    will exit with lock held.
4648
4649    This will return:
4650
4651    - 0 if the user has permission to get the specified lock for the scp
4652
4653    - CM_ERROR_NOACCESS if not
4654
4655    Any other error from cm_SyncOp will be sent down untranslated.
4656
4657    If CM_ERROR_NOACCESS is returned and lock_type is LockRead, then
4658    phas_insert (if non-NULL) will receive a boolean value indicating
4659    whether the user has INSERT permission or not.
4660 */
4661 long cm_LockCheckPerms(cm_scache_t * scp,
4662                        int lock_type,
4663                        cm_user_t * userp,
4664                        cm_req_t * reqp,
4665                        int * phas_insert)
4666 {
4667     long rights = 0;
4668     long code = 0, code2 = 0;
4669
4670     /* lock permissions are slightly tricky because of the 'i' bit.
4671        If the user has PRSFS_LOCK, she can read-lock the file.  If the
4672        user has PRSFS_WRITE, she can write-lock the file.  However, if
4673        the user has PRSFS_INSERT, then she can write-lock new files,
4674        but not old ones.  Since we don't have information about
4675        whether a file is new or not, we assume that if the user owns
4676        the scp, then she has the permissions that are granted by
4677        PRSFS_INSERT. */
4678
4679     osi_Log3(afsd_logp, "cm_LockCheckPerms for scp[0x%p] type[%d] user[0x%p]",
4680              scp, lock_type, userp);
4681
4682     if (lock_type == LockRead)
4683         rights |= PRSFS_LOCK;
4684     else if (lock_type == LockWrite)
4685         rights |= PRSFS_WRITE | PRSFS_LOCK;
4686     else {
4687         /* hmmkay */
4688         osi_assertx(FALSE, "invalid lock type");
4689         return 0;
4690     }
4691
4692     if (phas_insert)
4693         *phas_insert = FALSE;
4694
4695     code = cm_SyncOp(scp, NULL, userp, reqp, rights,
4696                      CM_SCACHESYNC_GETSTATUS |
4697                      CM_SCACHESYNC_NEEDCALLBACK);
4698
4699     if (phas_insert && scp->creator == userp) {
4700
4701         /* If this file was created by the user, then we check for
4702            PRSFS_INSERT.  If the file server is recent enough, then
4703            this should be sufficient for her to get a write-lock (but
4704            not necessarily a read-lock). VICED_CAPABILITY_WRITELOCKACL
4705            indicates whether a file server supports getting write
4706            locks when the user only has PRSFS_INSERT.
4707
4708            If the file was not created by the user we skip the check
4709            because the INSERT bit will not apply to this user even
4710            if it is set.
4711          */
4712
4713         code2 = cm_SyncOp(scp, NULL, userp, reqp, PRSFS_INSERT,
4714                          CM_SCACHESYNC_GETSTATUS |
4715                          CM_SCACHESYNC_NEEDCALLBACK);
4716
4717         if (code2 == CM_ERROR_NOACCESS) {
4718             osi_Log0(afsd_logp, "cm_LockCheckPerms user has no INSERT bits");
4719         } else {
4720             *phas_insert = TRUE;
4721             osi_Log0(afsd_logp, "cm_LockCheckPerms user has INSERT bits");
4722         }
4723     }
4724
4725     cm_SyncOpDone(scp, NULL, CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS);
4726
4727     osi_Log1(afsd_logp, "cm_LockCheckPerms returning code %d", code);
4728
4729     return code;
4730 }
4731
4732 /* called with scp->rw held */
4733 long cm_Lock(cm_scache_t *scp, unsigned char sLockType,
4734              LARGE_INTEGER LOffset, LARGE_INTEGER LLength,
4735              cm_key_t key,
4736              int allowWait, cm_user_t *userp, cm_req_t *reqp,
4737              cm_file_lock_t **lockpp)
4738 {
4739     long code = 0;
4740     int Which = ((sLockType & LOCKING_ANDX_SHARED_LOCK) ? LockRead : LockWrite);
4741     cm_file_lock_t *fileLock;
4742     osi_queue_t *q;
4743     cm_range_t range;
4744     int wait_unlock = FALSE;
4745     int force_client_lock = FALSE;
4746
4747     osi_Log4(afsd_logp, "cm_Lock scp 0x%x type 0x%x offset %d length %d",
4748              scp, sLockType, (unsigned long)LOffset.QuadPart, (unsigned long)LLength.QuadPart);
4749     osi_Log4(afsd_logp, "... allowWait %d key <0x%x, 0x%x, 0x%x>", allowWait,
4750              key.process_id, key.session_id, key.file_id);
4751
4752     /*
4753    A client C can OBTAIN a lock L on cm_scache_t S iff (both 3 and 4):
4754
4755    3. for all _a_ in (L->LOffset,+L->LLength), ALL of the following is
4756       true:
4757
4758        3.1 If L->LockType is exclusive then there does NOT exist a
4759          ACCEPTED lock M in S->fileLocks such that _a_ in
4760          (M->LOffset,+M->LLength).
4761
4762        3.2 If L->LockType is shared then for each ACCEPTED lock M in
4763          S->fileLocks, if _a_ in (M->LOffset,+M->LLength) then
4764          M->LockType is shared.
4765
4766    4. For all LOST locks M in S->fileLocks, ALL of the following are true:
4767
4768        4.1 M->key != Key(C)
4769
4770        4.2 If M->LockType is exclusive, then (L->LOffset,+L->LLength)
4771          and (M->LOffset,+M->LLength) do not intersect.
4772     */
4773
4774     range.offset = LOffset.QuadPart;
4775     range.length = LLength.QuadPart;
4776
4777     lock_ObtainRead(&cm_scacheLock);
4778
4779     for (q = scp->fileLocksH; q; q = osi_QNext(q)) {
4780         fileLock =
4781             (cm_file_lock_t *)((char *) q - offsetof(cm_file_lock_t, fileq));
4782
4783         if (IS_LOCK_LOST(fileLock)) {
4784             if (cm_KeyEquals(&fileLock->key, &key, 0)) {
4785                 code = CM_ERROR_BADFD;
4786                 break;
4787             } else if (fileLock->lockType == LockWrite && INTERSECT_RANGE(range, fileLock->range)) {
4788                 code = CM_ERROR_WOULDBLOCK;
4789                 wait_unlock = TRUE;
4790                 break;
4791             }
4792         }
4793
4794         /* we don't need to check for deleted locks here since deleted
4795            locks are dequeued from scp->fileLocks */
4796         if (IS_LOCK_ACCEPTED(fileLock) &&
4797            INTERSECT_RANGE(range, fileLock->range)) {
4798
4799             if ((sLockType & LOCKING_ANDX_SHARED_LOCK) == 0 ||
4800                 fileLock->lockType != LockRead) {
4801                 wait_unlock = TRUE;
4802                 code = CM_ERROR_WOULDBLOCK;
4803                 break;
4804             }
4805         }
4806     }
4807
4808     lock_ReleaseRead(&cm_scacheLock);
4809
4810     if (code == 0 && SERVERLOCKS_ENABLED(scp)) {
4811         if (Which == scp->serverLock ||
4812            (Which == LockRead && scp->serverLock == LockWrite)) {
4813
4814             int has_insert = 0;
4815
4816             /* we already have the lock we need */
4817             osi_Log3(afsd_logp, "   we already have the correct lock. exclusives[%d], shared[%d], serverLock[%d]",
4818                      scp->exclusiveLocks, scp->sharedLocks, (int)(signed char) scp->serverLock);
4819
4820             code = cm_LockCheckPerms(scp, Which, userp, reqp, &has_insert);
4821
4822             /* special case: if we don't have permission to read-lock
4823                the file, then we force a clientside lock.  This is to
4824                compensate for applications that obtain a read-lock for
4825                reading files off of directories that don't grant
4826                read-locks to the user. */
4827             if (code == CM_ERROR_NOACCESS && Which == LockRead) {
4828
4829                 if (has_insert && SCP_SUPPORTS_WRITELOCKACL(scp)) {
4830                     osi_Log0(afsd_logp, "   User has no read-lock perms, but has INSERT perms.");
4831                     code = 0;
4832                 } else {
4833                     osi_Log0(afsd_logp, "   User has no read-lock perms. Forcing client-side lock");
4834                     force_client_lock = TRUE;
4835                 }
4836             }
4837
4838         } else if ((scp->exclusiveLocks > 0) ||
4839                    (scp->sharedLocks > 0 && scp->serverLock != LockRead)) {
4840             int has_insert = 0;
4841
4842             /* We are already waiting for some other lock.  We should
4843                wait for the daemon to catch up instead of generating a
4844                flood of SetLock calls. */
4845             osi_Log3(afsd_logp, "   already waiting for other lock. exclusives[%d], shared[%d], serverLock[%d]",
4846                      scp->exclusiveLocks, scp->sharedLocks, (int)(signed char) scp->serverLock);
4847
4848             /* see if we have permission to create the lock in the
4849                first place. */
4850             code = cm_LockCheckPerms(scp, Which, userp, reqp, &has_insert);
4851             if (code == 0)
4852                 code = CM_ERROR_WOULDBLOCK;
4853             else if (code == CM_ERROR_NOACCESS && Which == LockRead) {
4854
4855                 if (has_insert && SCP_SUPPORTS_WRITELOCKACL(scp)) {
4856                     osi_Log0(afsd_logp,
4857                              "   User has no read-lock perms, but has INSERT perms.");
4858                     code = CM_ERROR_WOULDBLOCK;
4859                 } else {
4860                     osi_Log0(afsd_logp,
4861                              "   User has no read-lock perms. Forcing client-side lock");
4862                     force_client_lock = TRUE;
4863                 }
4864             }
4865
4866             /* leave any other codes as-is */
4867
4868         } else {
4869             int newLock;
4870             int check_data_version = FALSE;
4871             int has_insert = 0;
4872
4873             /* first check if we have permission to elevate or obtain
4874                the lock. */
4875             code = cm_LockCheckPerms(scp, Which, userp, reqp, &has_insert);
4876             if (code) {
4877                 if (code == CM_ERROR_NOACCESS && Which == LockRead &&
4878                     (!has_insert || !SCP_SUPPORTS_WRITELOCKACL(scp))) {
4879                     osi_Log0(afsd_logp, "   User has no read-lock perms.  Forcing client-side lock");
4880                     force_client_lock = TRUE;
4881                 }
4882                 goto check_code;
4883             }
4884
4885             /* has_insert => (Which == LockRead, code == CM_ERROR_NOACCESS) */
4886
4887             if (scp->serverLock == LockRead && Which == LockWrite) {
4888
4889                 /* We want to escalate the lock to a LockWrite.
4890                  * Unfortunately that's not really possible without
4891                  * letting go of the current lock.  But for now we do
4892                  * it anyway. */
4893
4894                 osi_Log0(afsd_logp,
4895                          "   attempting to UPGRADE from LockRead to LockWrite.");
4896                 osi_Log1(afsd_logp,
4897                          "   dataVersion on scp: %I64d", scp->dataVersion);
4898
4899                 /* we assume at this point (because scp->serverLock
4900                    was valid) that we had a valid server lock. */
4901                 scp->lockDataVersion = scp->dataVersion;
4902                 check_data_version = TRUE;
4903
4904                 code = cm_IntReleaseLock(scp, userp, reqp);
4905
4906                 if (code) {
4907                     /* We couldn't release the lock */
4908                     goto check_code;
4909                 } else {
4910                     scp->serverLock = -1;
4911                 }
4912             }
4913
4914             /* We need to obtain a server lock of type Which in order
4915              * to assert this file lock */
4916 #ifndef AGGRESSIVE_LOCKS
4917             newLock = Which;
4918 #else
4919             newLock = LockWrite;
4920 #endif
4921
4922             code = cm_IntSetLock(scp, userp, newLock, reqp);
4923
4924 #ifdef AGGRESSIVE_LOCKS
4925             if ((code == CM_ERROR_WOULDBLOCK ||
4926                  code == CM_ERROR_NOACCESS) && newLock != Which) {
4927                 /* we wanted LockRead.  We tried LockWrite. Now try
4928                  * LockRead again */
4929                 newLock = Which;
4930
4931                 /* am I sane? */
4932                 osi_assertx(newLock == LockRead, "lock type not read");
4933
4934                 code = cm_IntSetLock(scp, userp, newLock, reqp);
4935             }
4936 #endif
4937
4938             if (code == CM_ERROR_NOACCESS) {
4939                 if (Which == LockRead) {
4940                     if (has_insert && SCP_SUPPORTS_WRITELOCKACL(scp)) {
4941                         long tcode;
4942                         /* We requested a read-lock, but we have permission to
4943                          * get a write-lock. Try that */
4944
4945                         tcode = cm_LockCheckPerms(scp, LockWrite, userp, reqp, NULL);
4946
4947                         if (tcode == 0) {
4948                             newLock = LockWrite;
4949
4950                             osi_Log0(afsd_logp, "   User has 'i' perms and the request was for a LockRead.  Trying to get a LockWrite instead");
4951
4952                             code = cm_IntSetLock(scp, userp, newLock, reqp);
4953                         }
4954                     } else {
4955                         osi_Log0(afsd_logp, "   User has no read-lock perms.  Forcing client-side lock");
4956                         force_client_lock = TRUE;
4957                     }
4958                 } else if (Which == LockWrite &&
4959                            scp->creator == userp && !SCP_SUPPORTS_WRITELOCKACL(scp)) {
4960                     long tcode;
4961
4962                     /* Special case: if the lock request was for a
4963                      * LockWrite and the user owns the file and we weren't
4964                      * allowed to obtain the serverlock, we either lost a
4965                      * race (the permissions changed from under us), or we
4966                      * have 'i' bits, but we aren't allowed to lock the
4967                      * file. */
4968
4969                     /* check if we lost a race... */
4970                     tcode = cm_LockCheckPerms(scp, Which, userp, reqp, NULL);
4971
4972                     if (tcode == 0) {
4973                         osi_Log0(afsd_logp, "   User has 'i' perms but can't obtain write locks. Using client-side locks.");
4974                         force_client_lock = TRUE;
4975                     }
4976                 }
4977             }
4978
4979             if (code == 0 && check_data_version &&
4980                scp->dataVersion != scp->lockDataVersion) {
4981                 /* We lost a race.  Although we successfully obtained
4982                  * a lock, someone modified the file in between.  The
4983                  * locks have all been technically lost. */
4984
4985                 osi_Log0(afsd_logp,
4986                          "  Data version mismatch while upgrading lock.");
4987                 osi_Log2(afsd_logp,
4988                          "  Data versions before=%I64d, after=%I64d",
4989                          scp->lockDataVersion,
4990                          scp->dataVersion);
4991                 osi_Log1(afsd_logp,
4992                          "  Releasing stale lock for scp 0x%x", scp);
4993
4994                 code = cm_IntReleaseLock(scp, userp, reqp);
4995
4996                 scp->serverLock = -1;
4997
4998                 code = CM_ERROR_INVAL;
4999             } else if (code == 0) {
5000                 scp->serverLock = newLock;
5001                 scp->lockDataVersion = scp->dataVersion;
5002             }
5003
5004             if (code != 0 &&
5005                 (scp->sharedLocks > 0 || scp->exclusiveLocks > 0) &&
5006                 scp->serverLock == -1) {
5007                 /* Oops. We lost the lock. */
5008                 cm_LockMarkSCacheLost(scp);
5009             }
5010         }
5011     } else if (code == 0) {     /* server locks not enabled */
5012         osi_Log0(afsd_logp,
5013                  "  Skipping server lock for scp");
5014     }
5015
5016  check_code:
5017
5018     if (code != 0 && !force_client_lock) {
5019         /* Special case error translations
5020
5021            Applications don't expect certain errors from a
5022            LockFile/UnlockFile call.  We need to translate some error
5023            code to codes that apps expect and handle. */
5024
5025         /* We shouldn't actually need to handle this case since we
5026            simulate locks for RO scps anyway. */
5027         if (code == CM_ERROR_READONLY) {
5028             osi_Log0(afsd_logp, "   Reinterpreting CM_ERROR_READONLY as CM_ERROR_NOACCESS");
5029             code = CM_ERROR_NOACCESS;
5030         }
5031     }
5032
5033     if (code == 0 || (code == CM_ERROR_WOULDBLOCK && allowWait) ||
5034         force_client_lock) {
5035
5036         /* clear the error if we are forcing a client lock, so we
5037            don't get confused later. */
5038         if (force_client_lock && code != CM_ERROR_WOULDBLOCK)
5039             code = 0;
5040
5041         cm_HoldUser(userp);
5042
5043         lock_ObtainWrite(&cm_scacheLock);
5044         fileLock = cm_GetFileLock();
5045 #ifdef DEBUG
5046         fileLock->fid = scp->fid;
5047 #endif
5048         fileLock->key = key;
5049         fileLock->lockType = Which;
5050         fileLock->userp = userp;
5051         fileLock->range = range;
5052         fileLock->flags = (code == 0 ? 0 :
5053                            ((wait_unlock)?
5054                             CM_FILELOCK_FLAG_WAITUNLOCK :
5055                             CM_FILELOCK_FLAG_WAITLOCK));
5056
5057         if (force_client_lock || !SERVERLOCKS_ENABLED(scp))
5058             fileLock->flags |= CM_FILELOCK_FLAG_CLIENTONLY;
5059
5060         fileLock->lastUpdate = (code == 0 && !force_client_lock) ? time(NULL) : 0;
5061
5062         osi_QAddT(&scp->fileLocksH, &scp->fileLocksT, &fileLock->fileq);
5063         cm_HoldSCacheNoLock(scp);
5064         fileLock->scp = scp;
5065         osi_QAdd(&cm_allFileLocks, &fileLock->q);
5066         lock_ReleaseWrite(&cm_scacheLock);
5067
5068         if (code != 0) {
5069             *lockpp = fileLock;
5070         }
5071
5072         if (IS_LOCK_CLIENTONLY(fileLock)) {
5073             scp->clientLocks++;
5074         } else if (IS_LOCK_ACCEPTED(fileLock)) {
5075             if (Which == LockRead)
5076                 scp->sharedLocks++;
5077             else
5078                 scp->exclusiveLocks++;
5079         }
5080
5081         osi_Log3(afsd_logp,
5082                  "cm_Lock Lock added 0x%p flags 0x%x to scp [0x%p]",
5083                  fileLock, fileLock->flags, scp);
5084         osi_Log4(afsd_logp,
5085                  "   exclusives[%d] shared[%d] client[%d] serverLock[%d]",
5086                  scp->exclusiveLocks, scp->sharedLocks, scp->clientLocks,
5087                  (int)(signed char) scp->serverLock);
5088     } else {
5089         osi_Log1(afsd_logp,
5090                  "cm_Lock Rejecting lock (code = 0x%x)", code);
5091     }
5092
5093     /* Convert from would block to lock not granted */
5094     if (code == CM_ERROR_WOULDBLOCK)
5095         code = CM_ERROR_LOCK_NOT_GRANTED;
5096
5097     return code;
5098 }
5099
5100 static long
5101 cm_IntUnlock(cm_scache_t * scp,
5102              cm_user_t * userp,
5103              cm_req_t *  reqp)
5104 {
5105     long code = 0;
5106
5107     osi_assertx(scp->sharedLocks >= 0, "scp->sharedLocks < 0");
5108     osi_assertx(scp->exclusiveLocks >= 0, "scp->exclusiveLocks < 0");
5109     osi_assertx(scp->clientLocks >= 0, "scp->clientLocks < 0");
5110
5111     if (!SERVERLOCKS_ENABLED(scp)) {
5112         osi_Log0(afsd_logp, "  Skipping server lock for scp");
5113         goto done;
5114     }
5115
5116     /* Ideally we would go through the rest of the locks to determine
5117      * if one or more locks that were formerly in WAITUNLOCK can now
5118      * be put to ACTIVE or WAITLOCK and update scp->exclusiveLocks and
5119      * scp->sharedLocks accordingly.  However, the retrying of locks
5120      * in that manner is done cm_RetryLock() manually.
5121      */
5122
5123     if (scp->serverLock == LockWrite &&
5124         scp->exclusiveLocks == 0 &&
5125         scp->sharedLocks > 0) {
5126         /* The serverLock should be downgraded to LockRead */
5127         osi_Log0(afsd_logp, "  DOWNGRADE lock from LockWrite to LockRead");
5128
5129         /* Make sure there are no dirty buffers left. */
5130         code = cm_FSync(scp, userp, reqp, TRUE);
5131
5132         /* since scp->serverLock looked sane, we are going to assume
5133            that we have a valid server lock. */
5134         scp->lockDataVersion = scp->dataVersion;
5135         osi_Log1(afsd_logp, "  dataVersion on scp = %I64d", scp->dataVersion);
5136
5137         /* before we downgrade, make sure that we have enough
5138            permissions to get the read lock. */
5139         code = cm_LockCheckPerms(scp, LockRead, userp, reqp, NULL);
5140         if (code != 0) {
5141
5142             osi_Log0(afsd_logp, "  SKIPPING downgrade because user doesn't have perms to get downgraded lock");
5143
5144             code = 0;
5145             goto done;
5146         }
5147
5148         code = cm_IntReleaseLock(scp, userp, reqp);
5149
5150         if (code) {
5151             /* so we couldn't release it.  Just let the lock be for now */
5152             code = 0;
5153             goto done;
5154         } else {
5155             scp->serverLock = -1;
5156         }
5157
5158         code = cm_IntSetLock(scp, userp, LockRead, reqp);
5159
5160         if (code == 0 && scp->lockDataVersion == scp->dataVersion) {
5161             scp->serverLock = LockRead;
5162         } else if (code == 0 && scp->lockDataVersion != scp->dataVersion) {
5163             /* We lost a race condition.  Although we have a valid
5164                lock on the file, the data has changed and essentially
5165                we have lost the lock we had during the transition. */
5166
5167             osi_Log0(afsd_logp, "Data version mismatch during lock downgrade");
5168             osi_Log2(afsd_logp, "  Data versions before=%I64d, after=%I64d",
5169                      scp->lockDataVersion,
5170                      scp->dataVersion);
5171
5172             code = cm_IntReleaseLock(scp, userp, reqp);
5173
5174             code = CM_ERROR_INVAL;
5175             scp->serverLock = -1;
5176         }
5177
5178         if (code != 0 &&
5179             (scp->sharedLocks > 0 || scp->exclusiveLocks > 0) &&
5180                 (scp->serverLock == -1)) {
5181                 /* Oopsie */
5182                 cm_LockMarkSCacheLost(scp);
5183             }
5184
5185         /* failure here has no bearing on the return value of cm_Unlock() */
5186         code = 0;
5187
5188     } else if (scp->serverLock != (-1) &&
5189               scp->exclusiveLocks == 0 &&
5190               scp->sharedLocks == 0) {
5191         /* The serverLock should be released entirely */
5192
5193         if (scp->serverLock == LockWrite) {
5194             osi_Log0(afsd_logp, "  RELEASE LockWrite -> LockNone");
5195
5196             /* Make sure there are no dirty buffers left. */
5197             code = cm_FSync(scp, userp, reqp, TRUE);
5198         } else {
5199             osi_Log0(afsd_logp, "  RELEASE LockRead -> LockNone");
5200         }
5201
5202         code = cm_IntReleaseLock(scp, userp, reqp);
5203
5204         if (code == 0)
5205             scp->serverLock = (-1);
5206     }
5207
5208   done:
5209     return code;
5210 }
5211 /* Called with scp->rw held */
5212 long cm_UnlockByKey(cm_scache_t * scp,
5213                     cm_key_t key,
5214                     afs_uint32 flags,
5215                     cm_user_t * userp,
5216                     cm_req_t * reqp)
5217 {
5218     long code = 0;
5219     cm_file_lock_t *fileLock;
5220     osi_queue_t *q, *qn;
5221     int n_unlocks = 0;
5222
5223     osi_Log4(afsd_logp, "cm_UnlockByKey scp 0x%p key <0x%x,0x%x,0x%x",
5224              scp, key.process_id, key.session_id, key.file_id);
5225     osi_Log1(afsd_logp, "    flags=0x%x", flags);
5226
5227     lock_ObtainWrite(&cm_scacheLock);
5228
5229     for (q = scp->fileLocksH; q; q = qn) {
5230         qn = osi_QNext(q);
5231
5232         fileLock = (cm_file_lock_t *)
5233             ((char *) q - offsetof(cm_file_lock_t, fileq));
5234
5235 #ifdef DEBUG
5236         osi_Log4(afsd_logp, "   Checking lock[0x%x] range[%d,+%d] type[%d]",
5237                  fileLock,
5238                  (unsigned long) fileLock->range.offset,
5239                  (unsigned long) fileLock->range.length,
5240                 fileLock->lockType);
5241         osi_Log4(afsd_logp, "     key<0x%x, 0x%x, 0x%x> flags[0x%x]",
5242                  fileLock->key.process_id, fileLock->key.session_id, fileLock->key.file_id,
5243                  fileLock->flags);
5244
5245         if (cm_FidCmp(&fileLock->fid, &fileLock->scp->fid)) {
5246             osi_Log0(afsd_logp, "!!fileLock->fid != scp->fid");
5247             osi_Log4(afsd_logp, "  fileLock->fid(cell=[%d], volume=[%d], vnode=[%d], unique=[%d]",
5248                      fileLock->fid.cell,
5249                      fileLock->fid.volume,
5250                      fileLock->fid.vnode,
5251                      fileLock->fid.unique);
5252             osi_Log4(afsd_logp, "  scp->fid(cell=[%d], volume=[%d], vnode=[%d], unique=[%d]",
5253                      fileLock->scp->fid.cell,
5254                      fileLock->scp->fid.volume,
5255                      fileLock->scp->fid.vnode,
5256                      fileLock->scp->fid.unique);
5257             osi_assertx(FALSE, "invalid fid value");
5258         }
5259 #endif
5260
5261         if (!IS_LOCK_DELETED(fileLock) &&
5262             cm_KeyEquals(&fileLock->key, &key, flags)) {
5263             osi_Log3(afsd_logp, "...Unlock range [%d,+%d] type %d",
5264                     fileLock->range.offset,
5265                     fileLock->range.length,
5266                     fileLock->lockType);
5267
5268             osi_QRemoveHT(&scp->fileLocksH, &scp->fileLocksT, q);
5269
5270             if (IS_LOCK_CLIENTONLY(fileLock)) {
5271                 scp->clientLocks--;
5272             } else if (IS_LOCK_ACCEPTED(fileLock)) {
5273                 if (fileLock->lockType == LockRead)
5274                     scp->sharedLocks--;
5275                 else
5276                     scp->exclusiveLocks--;
5277             }
5278
5279             fileLock->flags |= CM_FILELOCK_FLAG_DELETED;
5280
5281             cm_ReleaseUser(fileLock->userp);
5282             cm_ReleaseSCacheNoLock(scp);
5283
5284             fileLock->userp = NULL;
5285             fileLock->scp = NULL;
5286
5287             n_unlocks++;
5288         }
5289     }
5290
5291     lock_ReleaseWrite(&cm_scacheLock);
5292
5293     if (n_unlocks == 0) {
5294         osi_Log0(afsd_logp, "cm_UnlockByKey no locks found");
5295         osi_Log3(afsd_logp, "   Leaving scp with exclusives[%d], shared[%d], serverLock[%d]",
5296                  scp->exclusiveLocks, scp->sharedLocks, (int)(signed char) scp->serverLock);
5297
5298         return 0;
5299     }
5300
5301     code = cm_IntUnlock(scp, userp, reqp);
5302     osi_Log1(afsd_logp, "cm_UnlockByKey code 0x%x", code);
5303
5304     osi_Log4(afsd_logp, "   Leaving scp with excl[%d], shared[%d], client[%d], serverLock[%d]",
5305              scp->exclusiveLocks, scp->sharedLocks, scp->clientLocks,
5306              (int)(signed char) scp->serverLock);
5307
5308     return code;
5309 }
5310
5311 /* Called with scp->rw held */
5312 long cm_Unlock(cm_scache_t *scp,
5313                unsigned char sLockType,
5314                LARGE_INTEGER LOffset, LARGE_INTEGER LLength,
5315                cm_key_t key,
5316                afs_uint32 flags,
5317                cm_user_t *userp,
5318                cm_req_t *reqp)
5319 {
5320     long code = 0;
5321     int Which = ((sLockType & LOCKING_ANDX_SHARED_LOCK) ? LockRead : LockWrite);
5322     cm_file_lock_t *fileLock;
5323     osi_queue_t *q;
5324     int release_userp = FALSE;
5325     int exact_match = !(flags & CM_UNLOCK_FLAG_MATCH_RANGE);
5326     int lock_found  = 0;
5327     LARGE_INTEGER RangeEnd;
5328
5329     osi_Log4(afsd_logp, "cm_Unlock scp 0x%p type 0x%x offset 0x%x length 0x%x",
5330              scp, sLockType, (unsigned long)LOffset.QuadPart, (unsigned long)LLength.QuadPart);
5331     osi_Log4(afsd_logp, "... key <0x%x,0x%x,0x%x> flags 0x%x",
5332              key.process_id, key.session_id, key.file_id, flags);
5333
5334     if (!exact_match)
5335         RangeEnd.QuadPart = LOffset.QuadPart + LLength.QuadPart;
5336
5337   try_again:
5338     lock_ObtainRead(&cm_scacheLock);
5339
5340     for (q = scp->fileLocksH; q; q = osi_QNext(q)) {
5341         fileLock = (cm_file_lock_t *)
5342             ((char *) q - offsetof(cm_file_lock_t, fileq));
5343
5344 #ifdef DEBUG
5345         if (cm_FidCmp(&fileLock->fid, &fileLock->scp->fid)) {
5346             osi_Log0(afsd_logp, "!!fileLock->fid != scp->fid");
5347             osi_Log4(afsd_logp, "  fileLock->fid(cell=[%d], volume=[%d], vnode=[%d], unique=[%d]",
5348                      fileLock->fid.cell,
5349                      fileLock->fid.volume,
5350                      fileLock->fid.vnode,
5351                      fileLock->fid.unique);
5352             osi_Log4(afsd_logp, "  scp->fid(cell=[%d], volume=[%d], vnode=[%d], unique=[%d]",
5353                      fileLock->scp->fid.cell,
5354                      fileLock->scp->fid.volume,
5355                      fileLock->scp->fid.vnode,
5356                      fileLock->scp->fid.unique);
5357             osi_assertx(FALSE, "invalid fid value");
5358         }
5359 #endif
5360         if (exact_match) {
5361             if (!IS_LOCK_DELETED(fileLock) &&
5362                  cm_KeyEquals(&fileLock->key, &key, 0) &&
5363                  fileLock->range.offset == LOffset.QuadPart &&
5364                  fileLock->range.length == LLength.QuadPart) {
5365                 lock_found = 1;
5366                 break;
5367             }
5368         } else {
5369
5370             if (!IS_LOCK_DELETED(fileLock) &&
5371                  cm_KeyEquals(&fileLock->key, &key, 0) &&
5372                  fileLock->range.offset >= LOffset.QuadPart &&
5373                  fileLock->range.offset < RangeEnd.QuadPart &&
5374                  (fileLock->range.offset + fileLock->range.length) <= RangeEnd.QuadPart) {
5375                 lock_found = 1;
5376                 break;
5377             }
5378         }
5379     }
5380
5381     if (!q) {
5382         lock_ReleaseRead(&cm_scacheLock);
5383
5384         if (lock_found && !exact_match) {
5385             code = 0;
5386             goto done;
5387         } else {
5388             osi_Log0(afsd_logp, "cm_Unlock lock not found; failure");
5389
5390             /* The lock didn't exist anyway. *shrug* */
5391             return CM_ERROR_RANGE_NOT_LOCKED;
5392         }
5393     }
5394
5395     /* discard lock record */
5396     lock_ConvertRToW(&cm_scacheLock);
5397     osi_QRemoveHT(&scp->fileLocksH, &scp->fileLocksT, q);
5398
5399     /*
5400      * Don't delete it here; let the daemon delete it, to simplify
5401      * the daemon's traversal of the list.
5402      */
5403
5404     if (IS_LOCK_CLIENTONLY(fileLock)) {
5405         scp->clientLocks--;
5406     } else if (IS_LOCK_ACCEPTED(fileLock)) {
5407         if (fileLock->lockType == LockRead)
5408             scp->sharedLocks--;
5409         else
5410             scp->exclusiveLocks--;
5411     }
5412
5413     fileLock->flags |= CM_FILELOCK_FLAG_DELETED;
5414
5415     if (userp != NULL) {
5416         cm_ReleaseUser(fileLock->userp);
5417     } else {
5418         userp = fileLock->userp;
5419         release_userp = TRUE;
5420     }
5421     cm_ReleaseSCacheNoLock(scp);
5422     fileLock->userp = NULL;
5423     fileLock->scp = NULL;
5424     lock_ReleaseWrite(&cm_scacheLock);
5425
5426     code = cm_IntUnlock(scp, userp, reqp);
5427
5428     if (release_userp) {
5429         cm_ReleaseUser(userp);
5430         release_userp = FALSE;
5431     }
5432
5433     if (!exact_match) {
5434         osi_Log1(afsd_logp, "cm_Unlock not exact match, searching for next lock, code 0x%x", code);
5435         goto try_again;         /* might be more than one lock in the range */
5436     }
5437
5438  done:
5439
5440     osi_Log1(afsd_logp, "cm_Unlock code 0x%x", code);
5441     osi_Log4(afsd_logp, "  leaving scp with excl[%d], shared[%d], client[%d], serverLock[%d]",
5442              scp->exclusiveLocks, scp->sharedLocks, scp->clientLocks,
5443              (int)(signed char) scp->serverLock);
5444
5445     return code;
5446 }
5447
5448 /* called with scp->rw held */
5449 void cm_LockMarkSCacheLost(cm_scache_t * scp)
5450 {
5451     cm_file_lock_t *fileLock;
5452     osi_queue_t *q;
5453
5454     osi_Log1(afsd_logp, "cm_LockMarkSCacheLost scp 0x%x", scp);
5455
5456     /* cm_scacheLock needed because we are modifying fileLock->flags */
5457     lock_ObtainWrite(&cm_scacheLock);
5458
5459     for (q = scp->fileLocksH; q; q = osi_QNext(q)) {
5460         fileLock =
5461             (cm_file_lock_t *)((char *) q - offsetof(cm_file_lock_t, fileq));
5462
5463         if (IS_LOCK_ACTIVE(fileLock) &&
5464             !IS_LOCK_CLIENTONLY(fileLock)) {
5465             if (fileLock->lockType == LockRead)
5466                 scp->sharedLocks--;
5467             else
5468                 scp->exclusiveLocks--;
5469
5470             fileLock->flags |= CM_FILELOCK_FLAG_LOST;
5471         }
5472     }
5473
5474     scp->serverLock = -1;
5475     scp->lockDataVersion = CM_SCACHE_VERSION_BAD;
5476     lock_ReleaseWrite(&cm_scacheLock);
5477 }
5478
5479 /* Called with no relevant locks held */
5480 void cm_CheckLocks()
5481 {
5482     osi_queue_t *q, *nq;
5483     cm_file_lock_t *fileLock;
5484     cm_req_t req;
5485     AFSFid tfid;
5486     AFSVolSync volSync;
5487     cm_conn_t *connp;
5488     long code;
5489     struct rx_connection * rxconnp;
5490     cm_scache_t * scp;
5491
5492     memset(&volSync, 0, sizeof(volSync));
5493
5494     cm_InitReq(&req);
5495
5496     lock_ObtainWrite(&cm_scacheLock);
5497
5498     cm_lockRefreshCycle++;
5499
5500     osi_Log1(afsd_logp, "cm_CheckLocks starting lock check cycle %d", cm_lockRefreshCycle);
5501
5502     for (q = cm_allFileLocks; q; q = nq) {
5503         fileLock = (cm_file_lock_t *) q;
5504         nq = osi_QNext(q);
5505         code = -1;
5506
5507         if (IS_LOCK_DELETED(fileLock)) {
5508             cm_user_t *userp = fileLock->userp;
5509             cm_scache_t *scp = fileLock->scp;
5510             fileLock->userp = NULL;
5511             fileLock->scp = NULL;
5512
5513             if (scp && userp) {
5514                 lock_ReleaseWrite(&cm_scacheLock);
5515                 lock_ObtainWrite(&scp->rw);
5516                 code = cm_IntUnlock(scp, userp, &req);
5517                 lock_ReleaseWrite(&scp->rw);
5518
5519                 cm_ReleaseUser(userp);
5520                 lock_ObtainWrite(&cm_scacheLock);
5521                 cm_ReleaseSCacheNoLock(scp);
5522             }
5523             osi_QRemove(&cm_allFileLocks, q);
5524             cm_PutFileLock(fileLock);
5525
5526         } else if (IS_LOCK_ACTIVE(fileLock) && !IS_LOCK_CLIENTONLY(fileLock)) {
5527
5528             /* Server locks must have been enabled for us to have
5529                received an active non-client-only lock. */
5530             osi_assertx(cm_enableServerLocks, "!cm_enableServerLocks");
5531
5532             scp = fileLock->scp;
5533             osi_assertx(scp != NULL, "null cm_scache_t");
5534
5535             cm_HoldSCacheNoLock(scp);
5536
5537 #ifdef DEBUG
5538             if (cm_FidCmp(&fileLock->fid, &fileLock->scp->fid)) {
5539                 osi_Log0(afsd_logp, "!!fileLock->fid != scp->fid");
5540                 osi_Log4(afsd_logp, "  fileLock->fid(cell=[%d], volume=[%d], vnode=[%d], unique=[%d]",
5541                          fileLock->fid.cell,
5542                          fileLock->fid.volume,
5543                          fileLock->fid.vnode,
5544                          fileLock->fid.unique);
5545                 osi_Log4(afsd_logp, "  scp->fid(cell=[%d], volume=[%d], vnode=[%d], unique=[%d]",
5546                          fileLock->scp->fid.cell,
5547                          fileLock->scp->fid.volume,
5548                          fileLock->scp->fid.vnode,
5549                          fileLock->scp->fid.unique);
5550                 osi_assertx(FALSE, "invalid fid");
5551             }
5552 #endif
5553             /* Server locks are extended once per scp per refresh
5554                cycle. */
5555             if (scp->lastRefreshCycle != cm_lockRefreshCycle) {
5556
5557                 int scp_done = FALSE;
5558
5559                 osi_Log1(afsd_logp, "cm_CheckLocks Updating scp 0x%x", scp);
5560
5561                 lock_ReleaseWrite(&cm_scacheLock);
5562                 lock_ObtainWrite(&scp->rw);
5563
5564                 /* did the lock change while we weren't holding the lock? */
5565                 if (!IS_LOCK_ACTIVE(fileLock))
5566                     goto post_syncopdone;
5567
5568                 code = cm_SyncOp(scp, NULL, fileLock->userp, &req, 0,
5569                                  CM_SCACHESYNC_NEEDCALLBACK
5570                                  | CM_SCACHESYNC_GETSTATUS
5571                                  | CM_SCACHESYNC_LOCK);
5572
5573                 if (code) {
5574                     osi_Log1(afsd_logp,
5575                              "cm_CheckLocks SyncOp failure code 0x%x", code);
5576                     goto post_syncopdone;
5577                 }
5578
5579                 /* cm_SyncOp releases scp->rw during which the lock
5580                    may get released. */
5581                 if (!IS_LOCK_ACTIVE(fileLock))
5582                     goto pre_syncopdone;
5583
5584                 if (scp->serverLock != -1 && !(scp->flags & CM_SCACHEFLAG_DELETED)) {
5585                     cm_fid_t cfid;
5586                     cm_user_t * userp;
5587
5588                     tfid.Volume = scp->fid.volume;
5589                     tfid.Vnode = scp->fid.vnode;
5590                     tfid.Unique = scp->fid.unique;
5591                     cfid = scp->fid;
5592                     userp = fileLock->userp;
5593
5594                     osi_Log3(afsd_logp, "CALL ExtendLock lock 0x%p for scp=0x%p with lock %d",
5595                              fileLock,
5596                              scp,
5597                              (int) scp->serverLock);
5598
5599                     lock_ReleaseWrite(&scp->rw);
5600
5601                     do {
5602                         code = cm_ConnFromFID(&cfid, userp,
5603                                        &req, &connp);
5604                         if (code)
5605                             break;
5606
5607                         rxconnp = cm_GetRxConn(connp);
5608                         code = RXAFS_ExtendLock(rxconnp, &tfid,
5609                                                 &volSync);
5610                         rx_PutConnection(rxconnp);
5611
5612                         osi_Log1(afsd_logp, "   ExtendLock returns %d", code);
5613
5614                     } while (cm_Analyze(connp, userp, &req,
5615                                         &cfid, &volSync, NULL, NULL,
5616                                         code));
5617
5618                     code = cm_MapRPCError(code, &req);
5619
5620                     lock_ObtainWrite(&scp->rw);
5621
5622                     if (code) {
5623                         osi_Log1(afsd_logp, "CALL ExtendLock FAILURE, code 0x%x", code);
5624                         scp->fsLockCount = 0;
5625                     } else {
5626                         osi_Log0(afsd_logp, "CALL ExtendLock SUCCESS");
5627                         scp->lockDataVersion = scp->dataVersion;
5628                     }
5629
5630                     if ((code == EINVAL || code == CM_ERROR_INVAL) &&
5631                         scp->lockDataVersion == scp->dataVersion) {
5632                         int lockType;
5633
5634                         lockType =
5635                             (scp->exclusiveLocks > 0) ? LockWrite: LockRead;
5636
5637                         /* we might still have a chance to obtain a
5638                            new lock */
5639
5640                         code = cm_IntSetLock(scp, userp, lockType, &req);
5641
5642                         if (code) {
5643                             code = CM_ERROR_INVAL;
5644                         } else if (scp->lockDataVersion != scp->dataVersion) {
5645
5646                             /* now check if we still have the file at
5647                                the right data version. */
5648                             osi_Log1(afsd_logp,
5649                                      "Data version mismatch on scp 0x%p",
5650                                      scp);
5651                             osi_Log2(afsd_logp,
5652                                      "   Data versions: before=%I64d, after=%I64d",
5653                                      scp->lockDataVersion,
5654                                      scp->dataVersion);
5655
5656                             code = cm_IntReleaseLock(scp, userp, &req);
5657
5658                             code = CM_ERROR_INVAL;
5659                         }
5660                     }
5661
5662                     if (code == EINVAL || code == CM_ERROR_INVAL ||
5663                         code == CM_ERROR_BADFD) {
5664                         cm_LockMarkSCacheLost(scp);
5665                     }
5666
5667                 } else {
5668                     /* interestingly, we have found an active lock
5669                        belonging to an scache that has no
5670                        serverLock */
5671                     cm_LockMarkSCacheLost(scp);
5672                 }
5673
5674                 scp_done = TRUE;
5675
5676             pre_syncopdone:
5677
5678                 cm_SyncOpDone(scp, NULL, CM_SCACHESYNC_LOCK);
5679
5680             post_syncopdone:
5681                 lock_ReleaseWrite(&scp->rw);
5682
5683                 lock_ObtainWrite(&cm_scacheLock);
5684
5685                 if (code == 0) {
5686                     fileLock->lastUpdate = time(NULL);
5687                 }
5688
5689                 if (scp_done)
5690                     scp->lastRefreshCycle = cm_lockRefreshCycle;
5691
5692             } else {
5693                 /* we have already refreshed the locks on this scp */
5694                 fileLock->lastUpdate = time(NULL);
5695             }
5696
5697             cm_ReleaseSCacheNoLock(scp);
5698
5699         } else if (IS_LOCK_ACTIVE(fileLock) && IS_LOCK_CLIENTONLY(fileLock)) {
5700             /* TODO: Check callbacks */
5701         }
5702     }
5703
5704     lock_ReleaseWrite(&cm_scacheLock);
5705     osi_Log1(afsd_logp, "cm_CheckLocks completes lock check cycle %d", cm_lockRefreshCycle);
5706 }
5707
5708 /* NOT called with scp->rw held. */
5709 long cm_RetryLock(cm_file_lock_t *oldFileLock, int client_is_dead)
5710 {
5711     long code = 0;
5712     cm_scache_t *scp = NULL;
5713     cm_file_lock_t *fileLock;
5714     osi_queue_t *q;
5715     cm_req_t req;
5716     int newLock = -1;
5717     int force_client_lock = FALSE;
5718     int has_insert = FALSE;
5719     int check_data_version = FALSE;
5720
5721     cm_InitReq(&req);
5722
5723     if (client_is_dead) {
5724         code = CM_ERROR_TIMEDOUT;
5725         goto updateLock;
5726     }
5727
5728     lock_ObtainRead(&cm_scacheLock);
5729
5730     osi_Log2(afsd_logp, "cm_RetryLock checking lock %p (scp=%p)", oldFileLock, oldFileLock->scp);
5731     osi_Log4(afsd_logp, "    offset(%x:%x) length(%x:%x)",
5732              (unsigned)(oldFileLock->range.offset >> 32),
5733              (unsigned)(oldFileLock->range.offset & 0xffffffff),
5734              (unsigned)(oldFileLock->range.length >> 32),
5735              (unsigned)(oldFileLock->range.length & 0xffffffff));
5736     osi_Log4(afsd_logp, "    key<0x%x,0x%x,0x%x> flags=%x",
5737              oldFileLock->key.process_id, oldFileLock->key.session_id, oldFileLock->key.file_id,
5738              (unsigned)(oldFileLock->flags));
5739
5740     /* if the lock has already been granted, then we have nothing to do */
5741     if (IS_LOCK_ACTIVE(oldFileLock)) {
5742         lock_ReleaseRead(&cm_scacheLock);
5743         osi_Log0(afsd_logp, "cm_RetryLock lock already granted");
5744         return 0;
5745     }
5746
5747     /* we can't do anything with lost or deleted locks at the moment. */
5748     if (IS_LOCK_LOST(oldFileLock) || IS_LOCK_DELETED(oldFileLock)) {
5749         code = CM_ERROR_BADFD;
5750         osi_Log0(afsd_logp, "cm_RetryLock lock is lost or deleted");
5751         lock_ReleaseRead(&cm_scacheLock);
5752         goto updateLock;
5753     }
5754
5755     scp = oldFileLock->scp;
5756
5757     osi_assertx(scp != NULL, "null cm_scache_t");
5758
5759     lock_ReleaseRead(&cm_scacheLock);
5760     lock_ObtainWrite(&scp->rw);
5761
5762     code = cm_LockCheckPerms(scp, oldFileLock->lockType,
5763                              oldFileLock->userp,
5764                              &req, &has_insert);
5765
5766     if (code == CM_ERROR_NOACCESS && oldFileLock->lockType == LockRead) {
5767         if (!has_insert || !SCP_SUPPORTS_WRITELOCKACL(scp)) {
5768         force_client_lock = TRUE;
5769         }
5770         code = 0;
5771     } else if (code) {
5772         lock_ReleaseWrite(&scp->rw);
5773         return code;
5774     }
5775
5776     lock_ObtainWrite(&cm_scacheLock);
5777
5778     /* Check if we already have a sufficient server lock to allow this
5779        lock to go through. */
5780     if (IS_LOCK_WAITLOCK(oldFileLock) &&
5781         (!SERVERLOCKS_ENABLED(scp) ||
5782          scp->serverLock == oldFileLock->lockType ||
5783          scp->serverLock == LockWrite)) {
5784
5785         oldFileLock->flags &= ~CM_FILELOCK_FLAG_WAITLOCK;
5786
5787         if (SERVERLOCKS_ENABLED(scp)) {
5788             osi_Log1(afsd_logp, "cm_RetryLock Server lock (%d) is sufficient for lock.  Granting",
5789                      (int) scp->serverLock);
5790         } else {
5791             osi_Log0(afsd_logp, "cm_RetryLock skipping server lock for scp");
5792         }
5793
5794         lock_ReleaseWrite(&cm_scacheLock);
5795         lock_ReleaseWrite(&scp->rw);
5796
5797         return 0;
5798     }
5799
5800     if (IS_LOCK_WAITUNLOCK(oldFileLock)) {
5801
5802         /* check if the conflicting locks have dissappeared already */
5803         for (q = scp->fileLocksH; q; q = osi_QNext(q)) {
5804
5805             fileLock = (cm_file_lock_t *)
5806                 ((char *) q - offsetof(cm_file_lock_t, fileq));
5807
5808             if (IS_LOCK_LOST(fileLock)) {
5809                 if (cm_KeyEquals(&fileLock->key, &oldFileLock->key, 0)) {
5810                     code = CM_ERROR_BADFD;
5811                     oldFileLock->flags |= CM_FILELOCK_FLAG_LOST;
5812                     osi_Log1(afsd_logp, "    found lost lock %p for same key.  Marking lock as lost",
5813                              fileLock);
5814                     break;
5815                 } else if (fileLock->lockType == LockWrite &&
5816                            INTERSECT_RANGE(oldFileLock->range, fileLock->range)) {
5817                     osi_Log1(afsd_logp, "    found conflicting LOST lock %p", fileLock);
5818                     code = CM_ERROR_WOULDBLOCK;
5819                     break;
5820                 }
5821             }
5822
5823             if (IS_LOCK_ACCEPTED(fileLock) &&
5824                 INTERSECT_RANGE(oldFileLock->range, fileLock->range)) {
5825
5826                 if (oldFileLock->lockType != LockRead ||
5827                    fileLock->lockType != LockRead) {
5828
5829                     osi_Log1(afsd_logp, "    found conflicting lock %p", fileLock);
5830                     code = CM_ERROR_WOULDBLOCK;
5831                     break;
5832                 }
5833             }
5834         }
5835     }
5836
5837     if (code != 0) {
5838         lock_ReleaseWrite(&cm_scacheLock);
5839         lock_ReleaseWrite(&scp->rw);
5840
5841         goto handleCode;
5842     }
5843
5844     /* when we get here, the lock is either a WAITUNLOCK or WAITLOCK.
5845        If it is WAITUNLOCK, then we didn't find any conflicting lock
5846        but we haven't verfied whether the serverLock is sufficient to
5847        assert it.  If it is WAITLOCK, then the serverLock is
5848        insufficient to assert it. Eitherway, we are ready to accept
5849        the lock as either ACTIVE or WAITLOCK depending on the
5850        serverLock. */
5851
5852     /* First, promote the WAITUNLOCK to a WAITLOCK */
5853     if (IS_LOCK_WAITUNLOCK(oldFileLock)) {
5854         if (oldFileLock->lockType == LockRead)
5855             scp->sharedLocks++;
5856         else
5857             scp->exclusiveLocks++;
5858
5859         oldFileLock->flags &= ~CM_FILELOCK_FLAG_WAITUNLOCK;
5860         oldFileLock->flags |= CM_FILELOCK_FLAG_WAITLOCK;
5861     }
5862
5863     osi_assertx(IS_LOCK_WAITLOCK(oldFileLock), "!IS_LOCK_WAITLOCK");
5864
5865     if (force_client_lock ||
5866         !SERVERLOCKS_ENABLED(scp) ||
5867         scp->serverLock == oldFileLock->lockType ||
5868         (oldFileLock->lockType == LockRead &&
5869          scp->serverLock == LockWrite)) {
5870
5871         oldFileLock->flags &= ~CM_FILELOCK_FLAG_WAITLOCK;
5872
5873         if ((force_client_lock ||
5874              !SERVERLOCKS_ENABLED(scp)) &&
5875             !IS_LOCK_CLIENTONLY(oldFileLock)) {
5876
5877             oldFileLock->flags |= CM_FILELOCK_FLAG_CLIENTONLY;
5878
5879             if (oldFileLock->lockType == LockRead)
5880                 scp->sharedLocks--;
5881             else
5882                 scp->exclusiveLocks--;
5883
5884             scp->clientLocks++;
5885         }
5886
5887         lock_ReleaseWrite(&cm_scacheLock);
5888         lock_ReleaseWrite(&scp->rw);
5889
5890         return 0;
5891
5892     } else {
5893         cm_user_t * userp;
5894
5895         code = cm_SyncOp(scp, NULL, oldFileLock->userp, &req, 0,
5896                          CM_SCACHESYNC_NEEDCALLBACK
5897                          | CM_SCACHESYNC_GETSTATUS
5898                          | CM_SCACHESYNC_LOCK);
5899         if (code) {
5900             osi_Log1(afsd_logp, "cm_RetryLock SyncOp failure code 0x%x", code);
5901             lock_ReleaseWrite(&cm_scacheLock);
5902             goto post_syncopdone;
5903         }
5904
5905         if (!IS_LOCK_WAITLOCK(oldFileLock))
5906             goto pre_syncopdone;
5907
5908         userp = oldFileLock->userp;
5909
5910 #ifndef AGGRESSIVE_LOCKS
5911         newLock = oldFileLock->lockType;
5912 #else
5913         newLock = LockWrite;
5914 #endif
5915
5916         if (has_insert) {
5917             /* if has_insert is non-zero, then:
5918                - the lock a LockRead
5919                - we don't have permission to get a LockRead
5920                - we do have permission to get a LockWrite
5921                - the server supports VICED_CAPABILITY_WRITELOCKACL
5922             */
5923
5924             newLock = LockWrite;
5925         }
5926
5927         lock_ReleaseWrite(&cm_scacheLock);
5928
5929         /* when we get here, either we have a read-lock and want a
5930            write-lock or we don't have any locks and we want some
5931            lock. */
5932
5933         if (scp->serverLock == LockRead) {
5934
5935             osi_assertx(newLock == LockWrite, "!LockWrite");
5936
5937             osi_Log0(afsd_logp, "  Attempting to UPGRADE from LockRead to LockWrite");
5938
5939             scp->lockDataVersion = scp->dataVersion;
5940             check_data_version = TRUE;
5941
5942             code = cm_IntReleaseLock(scp, userp, &req);
5943
5944             if (code)
5945                 goto pre_syncopdone;
5946             else
5947                 scp->serverLock = -1;
5948         }
5949
5950         code = cm_IntSetLock(scp, userp, newLock, &req);
5951
5952         if (code == 0) {
5953             if (scp->dataVersion != scp->lockDataVersion) {
5954                 /* we lost a race.  too bad */
5955
5956                 osi_Log0(afsd_logp,
5957                          "  Data version mismatch while upgrading lock.");
5958                 osi_Log2(afsd_logp,
5959                          "  Data versions before=%I64d, after=%I64d",
5960                          scp->lockDataVersion,
5961                          scp->dataVersion);
5962                 osi_Log1(afsd_logp,
5963                          "  Releasing stale lock for scp 0x%x", scp);
5964
5965                 code = cm_IntReleaseLock(scp, userp, &req);
5966
5967                 scp->serverLock = -1;
5968
5969                 code = CM_ERROR_INVAL;
5970
5971                 cm_LockMarkSCacheLost(scp);
5972             } else {
5973                 scp->serverLock = newLock;
5974             }
5975         }
5976
5977     pre_syncopdone:
5978         cm_SyncOpDone(scp, NULL, CM_SCACHESYNC_LOCK);
5979     post_syncopdone:
5980         ;
5981     }
5982
5983   handleCode:
5984     if (code != 0 && code != CM_ERROR_WOULDBLOCK) {
5985         lock_ObtainWrite(&cm_scacheLock);
5986         osi_QRemoveHT(&scp->fileLocksH, &scp->fileLocksT, &oldFileLock->fileq);
5987         lock_ReleaseWrite(&cm_scacheLock);
5988     }
5989     lock_ReleaseWrite(&scp->rw);
5990
5991   updateLock:
5992     lock_ObtainWrite(&cm_scacheLock);
5993     if (code == 0) {
5994         oldFileLock->flags &= ~CM_FILELOCK_FLAG_WAITLOCK;
5995     } else if (code != CM_ERROR_WOULDBLOCK) {
5996         oldFileLock->flags |= CM_FILELOCK_FLAG_DELETED;
5997         cm_ReleaseUser(oldFileLock->userp);
5998         oldFileLock->userp = NULL;
5999         if (oldFileLock->scp) {
6000             cm_ReleaseSCacheNoLock(oldFileLock->scp);
6001             oldFileLock->scp = NULL;
6002         }
6003     }
6004     lock_ReleaseWrite(&cm_scacheLock);
6005
6006     return code;
6007 }
6008
6009 cm_key_t cm_GenerateKey(afs_uint16 session_id, afs_offs_t process_id, afs_uint64 file_id)
6010 {
6011     cm_key_t key;
6012
6013     key.process_id = process_id;
6014     key.session_id = session_id;
6015     key.file_id = file_id;
6016
6017     return key;
6018 }
6019
6020 int cm_KeyEquals(cm_key_t *k1, cm_key_t *k2, int flags)
6021 {
6022     return (k1->session_id == k2->session_id) && (k1->file_id == k2->file_id) &&
6023         ((flags & CM_UNLOCK_FLAG_BY_FID) || (k1->process_id == k2->process_id));
6024 }
6025
6026 void cm_ReleaseAllLocks(void)
6027 {
6028     cm_scache_t *scp;
6029     cm_req_t req;
6030     cm_user_t *userp;
6031     cm_key_t   key;
6032     cm_file_lock_t *fileLock;
6033     unsigned int i;
6034
6035     for (i = 0; i < cm_data.scacheHashTableSize; i++)
6036     {
6037         for ( scp = cm_data.scacheHashTablep[i]; scp; scp = scp->nextp ) {
6038             while (scp->fileLocksH != NULL) {
6039                 lock_ObtainWrite(&scp->rw);
6040                 lock_ObtainWrite(&cm_scacheLock);
6041                 if (!scp->fileLocksH) {
6042                     lock_ReleaseWrite(&cm_scacheLock);
6043                     lock_ReleaseWrite(&scp->rw);
6044                     break;
6045                 }
6046                 fileLock = (cm_file_lock_t *)((char *) scp->fileLocksH - offsetof(cm_file_lock_t, fileq));
6047                 userp = fileLock->userp;
6048                 cm_HoldUser(userp);
6049                 key = fileLock->key;
6050                 cm_HoldSCacheNoLock(scp);
6051                 lock_ReleaseWrite(&cm_scacheLock);
6052                 cm_UnlockByKey(scp, key, 0, userp, &req);
6053                 cm_ReleaseSCache(scp);
6054                 cm_ReleaseUser(userp);
6055                 lock_ReleaseWrite(&scp->rw);
6056             }
6057         }
6058     }
6059 }