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     long filesThisCall;
2400     long i;
2401     long j;
2402     cm_scache_t *scp;
2403     cm_fid_t tfid;
2404     struct rx_connection * rxconnp;
2405     int inlinebulk;             /* Did we use InlineBulkStatus RPC or not? */
2406
2407     memset(&volSync, 0, sizeof(volSync));
2408
2409     /* otherwise, we may have one or more bulk stat's worth of stuff in bb;
2410      * make the calls to create the entries.  Handle AFSCBMAX files at a
2411      * time.
2412      */
2413     for (filex = 0; filex < bbp->counter; filex += filesThisCall) {
2414         filesThisCall = bbp->counter - filex;
2415         if (filesThisCall > AFSCBMAX)
2416             filesThisCall = AFSCBMAX;
2417
2418         fidStruct.AFSCBFids_len = filesThisCall;
2419         fidStruct.AFSCBFids_val = &bbp->fids[filex];
2420         statStruct.AFSBulkStats_len = filesThisCall;
2421         statStruct.AFSBulkStats_val = &bbp->stats[filex];
2422         callbackStruct.AFSCBs_len = filesThisCall;
2423         callbackStruct.AFSCBs_val = &bbp->callbacks[filex];
2424         cm_StartCallbackGrantingCall(NULL, &cbReq);
2425         osi_Log1(afsd_logp, "CALL BulkStatus, %d entries", filesThisCall);
2426
2427         /*
2428          * Whenever cm_Analyze is called for a RXAFS_ RPC there must
2429          * be a FID provided.  However, the error code from RXAFS_BulkStatus
2430          * or RXAFS_InlinkBulkStatus does not apply to any FID.  Therefore,
2431          * we generate an invalid FID to match with the RPC error.
2432          */
2433         cm_SetFid(&tfid, dscp->fid.cell, dscp->fid.volume, 0, 0);
2434
2435         do {
2436             inlinebulk = 0;
2437
2438             code = cm_ConnFromFID(&tfid, userp, reqp, &connp);
2439             if (code)
2440                 continue;
2441
2442             rxconnp = cm_GetRxConn(connp);
2443             if (!(connp->serverp->flags & CM_SERVERFLAG_NOINLINEBULK)) {
2444                 code = RXAFS_InlineBulkStatus(rxconnp, &fidStruct,
2445                                               &statStruct, &callbackStruct, &volSync);
2446                 if (code == RXGEN_OPCODE) {
2447                     cm_SetServerNoInlineBulk(connp->serverp, 0);
2448                 } else {
2449                     inlinebulk = 1;
2450                 }
2451             }
2452             if (!inlinebulk) {
2453                 code = RXAFS_BulkStatus(rxconnp, &fidStruct,
2454                                         &statStruct, &callbackStruct, &volSync);
2455             }
2456             rx_PutConnection(rxconnp);
2457
2458             /*
2459              * If InlineBulk RPC was called and it succeeded,
2460              * then pull out the return code from the status info
2461              * and use it for cm_Analyze so that we can failover to other
2462              * .readonly volume instances.  But only do it for errors that
2463              * are volume global.
2464              */
2465             if (inlinebulk && code == 0 && (&bbp->stats[0])->errorCode) {
2466                 osi_Log1(afsd_logp, "cm_TryBulkStat inline-bulk stat error: %d",
2467                           (&bbp->stats[0])->errorCode);
2468                 switch ((&bbp->stats[0])->errorCode) {
2469                 case VBUSY:
2470                 case VRESTARTING:
2471                 case VNOVOL:
2472                 case VMOVED:
2473                 case VOFFLINE:
2474                 case VSALVAGE:
2475                 case VNOSERVICE:
2476                 case VIO:
2477                     code = (&bbp->stats[0])->errorCode;
2478                     break;
2479                 default:
2480                     /* Rx and Rxkad errors are volume global */
2481                     if ( (&bbp->stats[0])->errorCode >= -64 && (&bbp->stats[0])->errorCode < 0 ||
2482                          (&bbp->stats[0])->errorCode >= ERROR_TABLE_BASE_RXK && (&bbp->stats[0])->errorCode < ERROR_TABLE_BASE_RXK + 256)
2483                         code = (&bbp->stats[0])->errorCode;
2484                 }
2485             }
2486         } while (cm_Analyze(connp, userp, reqp, &tfid, &volSync, NULL, &cbReq, code));
2487         code = cm_MapRPCError(code, reqp);
2488
2489         /*
2490          * might as well quit on an error, since we're not going to do
2491          * much better on the next immediate call, either.
2492          */
2493         if (code) {
2494             osi_Log2(afsd_logp, "CALL %sBulkStatus FAILURE code 0x%x",
2495                       inlinebulk ? "Inline" : "", code);
2496             cm_EndCallbackGrantingCall(NULL, &cbReq, NULL, NULL, 0);
2497             break;
2498         }
2499
2500         /*
2501          * The bulk RPC has succeeded or at least not failed with a
2502          * volume global error result.  For items that have inlineBulk
2503          * errors we must call cm_Analyze in order to perform required
2504          * logging of errors.
2505          *
2506          * If the RPC was not inline bulk or the entry either has no error
2507          * the status must be merged.
2508          */
2509         osi_Log1(afsd_logp, "CALL %sBulkStatus SUCCESS", inlinebulk ? "Inline" : "");
2510
2511         for (i = 0; i<filesThisCall; i++) {
2512             j = filex + i;
2513             cm_SetFid(&tfid, dscp->fid.cell, bbp->fids[j].Volume, bbp->fids[j].Vnode, bbp->fids[j].Unique);
2514
2515             if (inlinebulk && (&bbp->stats[j])->errorCode) {
2516                 cm_req_t treq = *reqp;
2517                 cm_Analyze(NULL, userp, &treq, &tfid, &volSync, NULL, &cbReq, (&bbp->stats[j])->errorCode);
2518             } else {
2519                 code = cm_GetSCache(&tfid, &scp, userp, reqp);
2520                 if (code != 0)
2521                     continue;
2522
2523                 /*
2524                  * otherwise, if this entry has no callback info,
2525                  * merge in this.  If there is existing callback info
2526                  * we skip the merge because the existing data must be
2527                  * current (we have a callback) and the response from
2528                  * a non-inline bulk rpc might actually be wrong.
2529                  *
2530                  * now, we have to be extra paranoid on merging in this
2531                  * information, since we didn't use cm_SyncOp before
2532                  * starting the fetch to make sure that no bad races
2533                  * were occurring.  Specifically, we need to make sure
2534                  * we don't obliterate any newer information in the
2535                  * vnode than have here.
2536                  *
2537                  * Right now, be pretty conservative: if there's a
2538                  * callback or a pending call, skip it.
2539                  * However, if the prior attempt to obtain status
2540                  * was refused access or the volume is .readonly,
2541                  * take the data in any case since we have nothing
2542                  * better for the in flight directory enumeration that
2543                  * resulted in this function being called.
2544                  */
2545                 lock_ObtainRead(&scp->rw);
2546                 if ((scp->cbServerp == NULL &&
2547                      !(scp->flags & (CM_SCACHEFLAG_FETCHING | CM_SCACHEFLAG_STORING | CM_SCACHEFLAG_SIZESTORING))) ||
2548                      (scp->flags & CM_SCACHEFLAG_PURERO) ||
2549                      (scp->flags & CM_SCACHEFLAG_EACCESS))
2550                 {
2551                     lock_ConvertRToW(&scp->rw);
2552                     cm_EndCallbackGrantingCall(scp, &cbReq,
2553                                                &bbp->callbacks[j],
2554                                                &volSync,
2555                                                CM_CALLBACK_MAINTAINCOUNT);
2556                     InterlockedIncrement(&scp->activeRPCs);
2557                     cm_MergeStatus(dscp, scp, &bbp->stats[j], &volSync, userp, reqp, 0);
2558                     lock_ReleaseWrite(&scp->rw);
2559                 } else {
2560                     lock_ReleaseRead(&scp->rw);
2561                 }
2562                 cm_ReleaseSCache(scp);
2563             }
2564         } /* all files in the response */
2565         /* now tell it to drop the count,
2566          * after doing the vnode processing above */
2567         cm_EndCallbackGrantingCall(NULL, &cbReq, NULL, NULL, 0);
2568     }   /* while there are still more files to process */
2569
2570     return code;
2571 }
2572
2573 /* called with a write locked scp and a pointer to a buffer.  Make bulk stat
2574  * calls on all undeleted files in the page of the directory specified.
2575  */
2576 afs_int32
2577 cm_TryBulkStat(cm_scache_t *dscp, osi_hyper_t *offsetp, cm_user_t *userp,
2578                cm_req_t *reqp)
2579 {
2580     afs_int32 code;
2581     cm_bulkStat_t *bbp;
2582
2583     osi_Log1(afsd_logp, "cm_TryBulkStat dir 0x%p", dscp);
2584
2585     /* should be on a buffer boundary */
2586     osi_assertx((offsetp->LowPart & (cm_data.buf_blockSize - 1)) == 0, "invalid offset");
2587
2588     bbp = malloc(sizeof(cm_bulkStat_t));
2589     memset(bbp, 0, sizeof(cm_bulkStat_t));
2590     bbp->bufOffset = *offsetp;
2591
2592     lock_ReleaseWrite(&dscp->rw);
2593     /* first, assemble the file IDs we need to stat */
2594     code = cm_ApplyDir(dscp, cm_TryBulkProc, (void *) bbp, offsetp, userp, reqp, NULL);
2595
2596     /* if we failed, bail out early */
2597     if (code && code != CM_ERROR_STOPNOW) {
2598         free(bbp);
2599         lock_ObtainWrite(&dscp->rw);
2600         return code;
2601     }
2602
2603     code = cm_TryBulkStatRPC(dscp, bbp, userp, reqp);
2604     osi_Log1(afsd_logp, "END cm_TryBulkStat code 0x%x", code);
2605
2606     lock_ObtainWrite(&dscp->rw);
2607     free(bbp);
2608     return 0;
2609 }
2610
2611 void cm_StatusFromAttr(AFSStoreStatus *statusp, cm_scache_t *scp, cm_attr_t *attrp)
2612 {
2613     long mask;
2614
2615     /* initialize store back mask as inexpensive local variable */
2616     mask = 0;
2617     memset(statusp, 0, sizeof(AFSStoreStatus));
2618
2619     /* copy out queued info from scache first, if scp passed in */
2620     if (scp) {
2621         if (scp->mask & CM_SCACHEMASK_CLIENTMODTIME) {
2622             statusp->ClientModTime = scp->clientModTime;
2623             mask |= AFS_SETMODTIME;
2624             scp->mask &= ~CM_SCACHEMASK_CLIENTMODTIME;
2625         }
2626     }
2627
2628     if (attrp) {
2629         /* now add in our locally generated request */
2630         if (attrp->mask & CM_ATTRMASK_CLIENTMODTIME) {
2631             statusp->ClientModTime = attrp->clientModTime;
2632             mask |= AFS_SETMODTIME;
2633         }
2634         if (attrp->mask & CM_ATTRMASK_UNIXMODEBITS) {
2635             statusp->UnixModeBits = attrp->unixModeBits;
2636             mask |= AFS_SETMODE;
2637         }
2638         if (attrp->mask & CM_ATTRMASK_OWNER) {
2639             statusp->Owner = attrp->owner;
2640             mask |= AFS_SETOWNER;
2641         }
2642         if (attrp->mask & CM_ATTRMASK_GROUP) {
2643             statusp->Group = attrp->group;
2644             mask |= AFS_SETGROUP;
2645         }
2646     }
2647     statusp->Mask = mask;
2648 }
2649
2650 /* set the file size, and make sure that all relevant buffers have been
2651  * truncated.  Ensure that any partially truncated buffers have been zeroed
2652  * to the end of the buffer.
2653  */
2654 long cm_SetLength(cm_scache_t *scp, osi_hyper_t *sizep, cm_user_t *userp,
2655                    cm_req_t *reqp)
2656 {
2657     long code;
2658     int shrinking;
2659
2660     /* start by locking out buffer creation */
2661     lock_ObtainWrite(&scp->bufCreateLock);
2662
2663     /* verify that this is a file, not a dir or a symlink */
2664     lock_ObtainWrite(&scp->rw);
2665     code = cm_SyncOp(scp, NULL, userp, reqp, 0,
2666                       CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS);
2667     if (code)
2668         goto done;
2669     cm_SyncOpDone(scp, NULL, CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS);
2670
2671     if (scp->fileType != CM_SCACHETYPE_FILE) {
2672         code = CM_ERROR_ISDIR;
2673         goto done;
2674     }
2675
2676   startover:
2677     if (LargeIntegerLessThan(*sizep, scp->length))
2678         shrinking = 1;
2679     else
2680         shrinking = 0;
2681
2682     lock_ReleaseWrite(&scp->rw);
2683
2684     /* can't hold scp->rw lock here, since we may wait for a storeback to
2685      * finish if the buffer package is cleaning a buffer by storing it to
2686      * the server.
2687      */
2688     if (shrinking)
2689         buf_Truncate(scp, userp, reqp, sizep);
2690
2691     /* now ensure that file length is short enough, and update truncPos */
2692     lock_ObtainWrite(&scp->rw);
2693
2694     /* make sure we have a callback (so we have the right value for the
2695      * length), and wait for it to be safe to do a truncate.
2696      */
2697     code = cm_SyncOp(scp, NULL, userp, reqp, PRSFS_WRITE,
2698                       CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS
2699                       | CM_SCACHESYNC_SETSTATUS | CM_SCACHESYNC_SETSIZE);
2700
2701     /* If we only have 'i' bits, then we should still be able to set
2702        the size of a file we created. */
2703     if (code == CM_ERROR_NOACCESS && scp->creator == userp) {
2704         code = cm_SyncOp(scp, NULL, userp, reqp, PRSFS_INSERT,
2705                          CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS
2706                          | CM_SCACHESYNC_SETSTATUS | CM_SCACHESYNC_SETSIZE);
2707     }
2708
2709     if (code)
2710         goto done;
2711
2712     if (LargeIntegerLessThan(*sizep, scp->length)) {
2713         /* a real truncation.  If truncPos is not set yet, or is bigger
2714          * than where we're truncating the file, set truncPos to this
2715          * new value.
2716          */
2717         if (!shrinking)
2718             goto startover;
2719         if (!(scp->mask & CM_SCACHEMASK_TRUNCPOS)
2720              || LargeIntegerLessThan(*sizep, scp->length)) {
2721             /* set trunc pos */
2722             scp->truncPos = *sizep;
2723             scp->mask |= CM_SCACHEMASK_TRUNCPOS;
2724         }
2725         /* in either case, the new file size has been changed */
2726         scp->length = *sizep;
2727         scp->mask |= CM_SCACHEMASK_LENGTH;
2728     }
2729     else if (LargeIntegerGreaterThan(*sizep, scp->length)) {
2730         /* really extending the file */
2731         scp->length = *sizep;
2732         scp->mask |= CM_SCACHEMASK_LENGTH;
2733     }
2734
2735     /* done successfully */
2736     code = 0;
2737
2738     cm_SyncOpDone(scp, NULL,
2739                    CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS
2740                    | CM_SCACHESYNC_SETSTATUS | CM_SCACHESYNC_SETSIZE);
2741
2742   done:
2743     lock_ReleaseWrite(&scp->rw);
2744     lock_ReleaseWrite(&scp->bufCreateLock);
2745
2746     return code;
2747 }
2748
2749 /* set the file size or other attributes (but not both at once) */
2750 long cm_SetAttr(cm_scache_t *scp, cm_attr_t *attrp, cm_user_t *userp,
2751                 cm_req_t *reqp)
2752 {
2753     long code;
2754     AFSFetchStatus afsOutStatus;
2755     AFSVolSync volSync;
2756     cm_conn_t *connp;
2757     AFSFid tfid;
2758     AFSStoreStatus afsInStatus;
2759     struct rx_connection * rxconnp;
2760
2761     memset(&volSync, 0, sizeof(volSync));
2762
2763     /* handle file length setting */
2764     if (attrp->mask & CM_ATTRMASK_LENGTH)
2765         return cm_SetLength(scp, &attrp->length, userp, reqp);
2766
2767     lock_ObtainWrite(&scp->rw);
2768     /* Check for RO volume */
2769     if (scp->flags & CM_SCACHEFLAG_RO) {
2770         code = CM_ERROR_READONLY;
2771         lock_ReleaseWrite(&scp->rw);
2772         return code;
2773     }
2774
2775     /* otherwise, we have to make an RPC to get the status */
2776     code = cm_SyncOp(scp, NULL, userp, reqp, 0, CM_SCACHESYNC_STORESTATUS);
2777     if (code) {
2778         lock_ReleaseWrite(&scp->rw);
2779         return code;
2780     }
2781     lock_ConvertWToR(&scp->rw);
2782
2783     /* make the attr structure */
2784     cm_StatusFromAttr(&afsInStatus, scp, attrp);
2785
2786     tfid.Volume = scp->fid.volume;
2787     tfid.Vnode = scp->fid.vnode;
2788     tfid.Unique = scp->fid.unique;
2789     lock_ReleaseRead(&scp->rw);
2790
2791     /* now make the RPC */
2792     InterlockedIncrement(&scp->activeRPCs);
2793
2794     osi_Log1(afsd_logp, "CALL StoreStatus scp 0x%p", scp);
2795     do {
2796         code = cm_ConnFromFID(&scp->fid, userp, reqp, &connp);
2797         if (code)
2798             continue;
2799
2800         rxconnp = cm_GetRxConn(connp);
2801         code = RXAFS_StoreStatus(rxconnp, &tfid,
2802                                   &afsInStatus, &afsOutStatus, &volSync);
2803         rx_PutConnection(rxconnp);
2804
2805     } while (cm_Analyze(connp, userp, reqp,
2806                          &scp->fid, &volSync, NULL, NULL, code));
2807     code = cm_MapRPCError(code, reqp);
2808
2809     if (code)
2810         osi_Log1(afsd_logp, "CALL StoreStatus FAILURE, code 0x%x", code);
2811     else
2812         osi_Log0(afsd_logp, "CALL StoreStatus SUCCESS");
2813
2814     lock_ObtainWrite(&scp->rw);
2815     if (code == 0)
2816         cm_MergeStatus(NULL, scp, &afsOutStatus, &volSync, userp, reqp,
2817                         CM_MERGEFLAG_FORCE|CM_MERGEFLAG_STOREDATA);
2818     else
2819         InterlockedDecrement(&scp->activeRPCs);
2820     cm_SyncOpDone(scp, NULL, CM_SCACHESYNC_STORESTATUS);
2821
2822     /* if we're changing the mode bits, discard the ACL cache,
2823      * since we changed the mode bits.
2824      */
2825     if (afsInStatus.Mask & AFS_SETMODE)
2826         cm_FreeAllACLEnts(scp);
2827     lock_ReleaseWrite(&scp->rw);
2828     return code;
2829 }
2830
2831 long cm_Create(cm_scache_t *dscp, clientchar_t *cnamep, long flags, cm_attr_t *attrp,
2832                cm_scache_t **scpp, cm_user_t *userp, cm_req_t *reqp)
2833 {
2834     cm_conn_t *connp;
2835     long code;
2836     AFSFid dirAFSFid;
2837     cm_callbackRequest_t cbReq;
2838     AFSFid newAFSFid;
2839     cm_fid_t newFid;
2840     cm_scache_t *scp = NULL;
2841     int didEnd;
2842     AFSStoreStatus inStatus;
2843     AFSFetchStatus updatedDirStatus;
2844     AFSFetchStatus newFileStatus;
2845     AFSCallBack newFileCallback;
2846     AFSVolSync volSync;
2847     struct rx_connection * rxconnp;
2848     cm_dirOp_t dirop;
2849     fschar_t * fnamep = NULL;
2850
2851     memset(&volSync, 0, sizeof(volSync));
2852
2853     /* can't create names with @sys in them; must expand it manually first.
2854      * return "invalid request" if they try.
2855      */
2856     if (cm_ExpandSysName(NULL, cnamep, NULL, 0, 0)) {
2857         return CM_ERROR_ATSYS;
2858     }
2859
2860 #ifdef AFS_FREELANCE_CLIENT
2861     /* Freelance root volume does not hold files */
2862     if (cm_freelanceEnabled &&
2863         dscp->fid.cell==AFS_FAKE_ROOT_CELL_ID &&
2864         dscp->fid.volume==AFS_FAKE_ROOT_VOL_ID )
2865     {
2866         return CM_ERROR_NOACCESS;
2867     }
2868 #endif /* AFS_FREELANCE_CLIENT */
2869
2870     /* Check for RO volume */
2871     if (dscp->flags & CM_SCACHEFLAG_RO)
2872         return CM_ERROR_READONLY;
2873
2874     /* before starting the RPC, mark that we're changing the file data, so
2875      * that someone who does a chmod will know to wait until our call
2876      * completes.
2877      */
2878     cm_BeginDirOp(dscp, userp, reqp, CM_DIRLOCK_NONE, CM_DIROP_FLAG_NONE,
2879                   &dirop);
2880     lock_ObtainWrite(&dscp->rw);
2881     code = cm_SyncOp(dscp, NULL, userp, reqp, 0, CM_SCACHESYNC_STOREDATA);
2882     lock_ReleaseWrite(&dscp->rw);
2883     if (code == 0) {
2884         cm_StartCallbackGrantingCall(NULL, &cbReq);
2885     } else {
2886         cm_EndDirOp(&dirop);
2887     }
2888     if (code) {
2889         return code;
2890     }
2891     didEnd = 0;
2892
2893     fnamep = cm_ClientStringToFsStringAlloc(cnamep, -1, NULL);
2894
2895     cm_StatusFromAttr(&inStatus, NULL, attrp);
2896
2897     /* try the RPC now */
2898     InterlockedIncrement(&dscp->activeRPCs);
2899     osi_Log1(afsd_logp, "CALL CreateFile scp 0x%p", dscp);
2900     do {
2901         code = cm_ConnFromFID(&dscp->fid, userp, reqp, &connp);
2902         if (code)
2903             continue;
2904
2905         dirAFSFid.Volume = dscp->fid.volume;
2906         dirAFSFid.Vnode = dscp->fid.vnode;
2907         dirAFSFid.Unique = dscp->fid.unique;
2908
2909         rxconnp = cm_GetRxConn(connp);
2910         code = RXAFS_CreateFile(connp->rxconnp, &dirAFSFid, fnamep,
2911                                  &inStatus, &newAFSFid, &newFileStatus,
2912                                  &updatedDirStatus, &newFileCallback,
2913                                  &volSync);
2914         rx_PutConnection(rxconnp);
2915
2916     } while (cm_Analyze(connp, userp, reqp,
2917                          &dscp->fid, &volSync, NULL, &cbReq, code));
2918     code = cm_MapRPCError(code, reqp);
2919
2920     if (code)
2921         osi_Log1(afsd_logp, "CALL CreateFile FAILURE, code 0x%x", code);
2922     else
2923         osi_Log0(afsd_logp, "CALL CreateFile SUCCESS");
2924
2925     if (dirop.scp) {
2926         lock_ObtainWrite(&dirop.scp->dirlock);
2927         dirop.lockType = CM_DIRLOCK_WRITE;
2928     }
2929     lock_ObtainWrite(&dscp->rw);
2930     if (code == 0) {
2931         cm_MergeStatus(NULL, dscp, &updatedDirStatus, &volSync, userp, reqp, CM_MERGEFLAG_DIROP);
2932         cm_SetFid(&newFid, dscp->fid.cell, dscp->fid.volume, newAFSFid.Vnode, newAFSFid.Unique);
2933         if (cm_CheckDirOpForSingleChange(&dirop)) {
2934             lock_ReleaseWrite(&dscp->rw);
2935             cm_DirCreateEntry(&dirop, fnamep, &newFid);
2936 #ifdef USE_BPLUS
2937             cm_BPlusDirCreateEntry(&dirop, cnamep, &newFid);
2938 #endif
2939             lock_ObtainWrite(&dscp->rw);
2940         }
2941     } else {
2942         InterlockedDecrement(&dscp->activeRPCs);
2943     }
2944     cm_SyncOpDone(dscp, NULL, CM_SCACHESYNC_STOREDATA);
2945     lock_ReleaseWrite(&dscp->rw);
2946
2947     /* now try to create the file's entry, too, but be careful to
2948      * make sure that we don't merge in old info.  Since we weren't locking
2949      * out any requests during the file's creation, we may have pretty old
2950      * info.
2951      */
2952     if (code == 0) {
2953         code = cm_GetSCache(&newFid, &scp, userp, reqp);
2954         if (code == 0) {
2955             lock_ObtainWrite(&scp->rw);
2956             scp->creator = userp;               /* remember who created it */
2957             if (!cm_HaveCallback(scp)) {
2958                 cm_EndCallbackGrantingCall(scp, &cbReq,
2959                                            &newFileCallback, &volSync, 0);
2960                 InterlockedIncrement(&scp->activeRPCs);
2961                 cm_MergeStatus(dscp, scp, &newFileStatus, &volSync,
2962                                userp, reqp, 0);
2963                 didEnd = 1;
2964             }
2965             lock_ReleaseWrite(&scp->rw);
2966         }
2967     }
2968
2969     /* make sure we end things properly */
2970     if (!didEnd)
2971         cm_EndCallbackGrantingCall(NULL, &cbReq, NULL, NULL, 0);
2972
2973     cm_EndDirOp(&dirop);
2974
2975     if (fnamep)
2976         free(fnamep);
2977
2978     if (scp) {
2979         if (scpp)
2980             *scpp = scp;
2981         else
2982             cm_ReleaseSCache(scp);
2983     }
2984     return code;
2985 }
2986
2987 /*
2988  * locked if TRUE means write-locked
2989  * else the cm_scache_t rw must not be held
2990  */
2991 long cm_FSync(cm_scache_t *scp, cm_user_t *userp, cm_req_t *reqp, afs_uint32 locked)
2992 {
2993     long code;
2994
2995     if (locked)
2996         lock_ReleaseWrite(&scp->rw);
2997
2998     osi_Log2(afsd_logp, "cm_FSync scp 0x%p userp 0x%p", scp, userp);
2999
3000     code = buf_CleanVnode(scp, userp, reqp);
3001     if (code == 0) {
3002         lock_ObtainWrite(&scp->rw);
3003
3004         if (scp->mask & (CM_SCACHEMASK_TRUNCPOS
3005                           | CM_SCACHEMASK_CLIENTMODTIME
3006                           | CM_SCACHEMASK_LENGTH))
3007             code = cm_StoreMini(scp, userp, reqp);
3008
3009         if (scp->flags & (CM_SCACHEFLAG_OVERQUOTA | CM_SCACHEFLAG_OUTOFSPACE)) {
3010             code = (scp->flags & CM_SCACHEFLAG_OVERQUOTA) ? CM_ERROR_QUOTA : CM_ERROR_SPACE;
3011             scp->flags &= ~(CM_SCACHEFLAG_OVERQUOTA | CM_SCACHEFLAG_OUTOFSPACE);
3012         }
3013
3014         if (!locked)
3015             lock_ReleaseWrite(&scp->rw);
3016     } else if (locked) {
3017         lock_ObtainWrite(&scp->rw);
3018     }
3019     return code;
3020 }
3021
3022 long cm_MakeDir(cm_scache_t *dscp, clientchar_t *cnamep, long flags, cm_attr_t *attrp,
3023                 cm_user_t *userp, cm_req_t *reqp, cm_scache_t **scpp)
3024 {
3025     cm_conn_t *connp;
3026     long code;
3027     AFSFid dirAFSFid;
3028     cm_callbackRequest_t cbReq;
3029     AFSFid newAFSFid;
3030     cm_fid_t newFid;
3031     cm_scache_t *scp = NULL;
3032     int didEnd;
3033     AFSStoreStatus inStatus;
3034     AFSFetchStatus updatedDirStatus;
3035     AFSFetchStatus newDirStatus;
3036     AFSCallBack newDirCallback;
3037     AFSVolSync volSync;
3038     struct rx_connection * rxconnp;
3039     cm_dirOp_t dirop;
3040     fschar_t * fnamep = NULL;
3041
3042     memset(&volSync, 0, sizeof(volSync));
3043
3044     /* can't create names with @sys in them; must expand it manually first.
3045      * return "invalid request" if they try.
3046      */
3047     if (cm_ExpandSysName(NULL, cnamep, NULL, 0, 0)) {
3048         return CM_ERROR_ATSYS;
3049     }
3050
3051 #ifdef AFS_FREELANCE_CLIENT
3052     /* Freelance root volume does not hold subdirectories */
3053     if (cm_freelanceEnabled &&
3054         dscp->fid.cell==AFS_FAKE_ROOT_CELL_ID &&
3055         dscp->fid.volume==AFS_FAKE_ROOT_VOL_ID )
3056     {
3057         return CM_ERROR_NOACCESS;
3058     }
3059 #endif /* AFS_FREELANCE_CLIENT */
3060
3061     /* Check for RO volume */
3062     if (dscp->flags & CM_SCACHEFLAG_RO)
3063         return CM_ERROR_READONLY;
3064
3065     /* before starting the RPC, mark that we're changing the directory
3066      * data, so that someone who does a chmod on the dir will wait until
3067      * our call completes.
3068      */
3069     cm_BeginDirOp(dscp, userp, reqp, CM_DIRLOCK_NONE, CM_DIROP_FLAG_NONE,
3070                   &dirop);
3071     lock_ObtainWrite(&dscp->rw);
3072     code = cm_SyncOp(dscp, NULL, userp, reqp, 0, CM_SCACHESYNC_STOREDATA);
3073     lock_ReleaseWrite(&dscp->rw);
3074     if (code == 0) {
3075         cm_StartCallbackGrantingCall(NULL, &cbReq);
3076     } else {
3077         cm_EndDirOp(&dirop);
3078     }
3079     if (code) {
3080         return code;
3081     }
3082     didEnd = 0;
3083
3084     fnamep = cm_ClientStringToFsStringAlloc(cnamep, -1, NULL);
3085     cm_StatusFromAttr(&inStatus, NULL, attrp);
3086
3087     /* try the RPC now */
3088     InterlockedIncrement(&dscp->activeRPCs);
3089     osi_Log1(afsd_logp, "CALL MakeDir scp 0x%p", dscp);
3090     do {
3091         code = cm_ConnFromFID(&dscp->fid, userp, reqp, &connp);
3092         if (code)
3093             continue;
3094
3095         dirAFSFid.Volume = dscp->fid.volume;
3096         dirAFSFid.Vnode = dscp->fid.vnode;
3097         dirAFSFid.Unique = dscp->fid.unique;
3098
3099         rxconnp = cm_GetRxConn(connp);
3100         code = RXAFS_MakeDir(connp->rxconnp, &dirAFSFid, fnamep,
3101                               &inStatus, &newAFSFid, &newDirStatus,
3102                               &updatedDirStatus, &newDirCallback,
3103                               &volSync);
3104         rx_PutConnection(rxconnp);
3105
3106     } while (cm_Analyze(connp, userp, reqp,
3107                         &dscp->fid, &volSync, NULL, &cbReq, code));
3108     code = cm_MapRPCError(code, reqp);
3109
3110     if (code)
3111         osi_Log1(afsd_logp, "CALL MakeDir FAILURE, code 0x%x", code);
3112     else
3113         osi_Log0(afsd_logp, "CALL MakeDir SUCCESS");
3114
3115     if (dirop.scp) {
3116         lock_ObtainWrite(&dirop.scp->dirlock);
3117         dirop.lockType = CM_DIRLOCK_WRITE;
3118     }
3119     lock_ObtainWrite(&dscp->rw);
3120     if (code == 0) {
3121         cm_MergeStatus(NULL, dscp, &updatedDirStatus, &volSync, userp, reqp, CM_MERGEFLAG_DIROP);
3122         cm_SetFid(&newFid, dscp->fid.cell, dscp->fid.volume, newAFSFid.Vnode, newAFSFid.Unique);
3123         if (cm_CheckDirOpForSingleChange(&dirop)) {
3124             lock_ReleaseWrite(&dscp->rw);
3125             cm_DirCreateEntry(&dirop, fnamep, &newFid);
3126 #ifdef USE_BPLUS
3127             cm_BPlusDirCreateEntry(&dirop, cnamep, &newFid);
3128 #endif
3129             lock_ObtainWrite(&dscp->rw);
3130         }
3131     } else {
3132         InterlockedDecrement(&dscp->activeRPCs);
3133     }
3134     cm_SyncOpDone(dscp, NULL, CM_SCACHESYNC_STOREDATA);
3135     lock_ReleaseWrite(&dscp->rw);
3136
3137     /* now try to create the new dir's entry, too, but be careful to
3138      * make sure that we don't merge in old info.  Since we weren't locking
3139      * out any requests during the file's creation, we may have pretty old
3140      * info.
3141      */
3142     if (code == 0) {
3143         code = cm_GetSCache(&newFid, &scp, userp, reqp);
3144         if (code == 0) {
3145             lock_ObtainWrite(&scp->rw);
3146             if (!cm_HaveCallback(scp)) {
3147                 cm_EndCallbackGrantingCall(scp, &cbReq,
3148                                             &newDirCallback, &volSync, 0);
3149                 InterlockedIncrement(&scp->activeRPCs);
3150                 cm_MergeStatus(dscp, scp, &newDirStatus, &volSync,
3151                                 userp, reqp, 0);
3152                 didEnd = 1;
3153             }
3154             lock_ReleaseWrite(&scp->rw);
3155         }
3156     }
3157
3158     /* make sure we end things properly */
3159     if (!didEnd)
3160         cm_EndCallbackGrantingCall(NULL, &cbReq, NULL, NULL, 0);
3161
3162     cm_EndDirOp(&dirop);
3163
3164     free(fnamep);
3165
3166     if (scp) {
3167         if (scpp)
3168             *scpp = scp;
3169         else
3170             cm_ReleaseSCache(scp);
3171     }
3172
3173     /* and return error code */
3174     return code;
3175 }
3176
3177 long cm_Link(cm_scache_t *dscp, clientchar_t *cnamep, cm_scache_t *sscp, long flags,
3178              cm_user_t *userp, cm_req_t *reqp)
3179 {
3180     cm_conn_t *connp;
3181     long code = 0;
3182     AFSFid dirAFSFid;
3183     AFSFid existingAFSFid;
3184     AFSFetchStatus updatedDirStatus;
3185     AFSFetchStatus newLinkStatus;
3186     AFSVolSync volSync;
3187     struct rx_connection * rxconnp;
3188     cm_dirOp_t dirop;
3189     fschar_t * fnamep = NULL;
3190     int invalidate = 0;
3191
3192     memset(&volSync, 0, sizeof(volSync));
3193
3194     if (dscp->fid.cell != sscp->fid.cell ||
3195         dscp->fid.volume != sscp->fid.volume) {
3196         return CM_ERROR_CROSSDEVLINK;
3197     }
3198
3199     /* Check for RO volume */
3200     if (dscp->flags & CM_SCACHEFLAG_RO)
3201         return CM_ERROR_READONLY;
3202
3203     cm_BeginDirOp(dscp, userp, reqp, CM_DIRLOCK_NONE, CM_DIROP_FLAG_NONE,
3204                   &dirop);
3205     lock_ObtainWrite(&dscp->rw);
3206     code = cm_SyncOp(dscp, NULL, userp, reqp, 0, CM_SCACHESYNC_STOREDATA);
3207     lock_ReleaseWrite(&dscp->rw);
3208     if (code != 0)
3209         cm_EndDirOp(&dirop);
3210
3211     if (code)
3212         return code;
3213
3214     fnamep = cm_ClientStringToFsStringAlloc(cnamep, -1, NULL);
3215
3216     /* try the RPC now */
3217     InterlockedIncrement(&dscp->activeRPCs);
3218     osi_Log1(afsd_logp, "CALL Link scp 0x%p", dscp);
3219     do {
3220         code = cm_ConnFromFID(&dscp->fid, userp, reqp, &connp);
3221         if (code) continue;
3222
3223         dirAFSFid.Volume = dscp->fid.volume;
3224         dirAFSFid.Vnode = dscp->fid.vnode;
3225         dirAFSFid.Unique = dscp->fid.unique;
3226
3227         existingAFSFid.Volume = sscp->fid.volume;
3228         existingAFSFid.Vnode = sscp->fid.vnode;
3229         existingAFSFid.Unique = sscp->fid.unique;
3230
3231         rxconnp = cm_GetRxConn(connp);
3232         code = RXAFS_Link(rxconnp, &dirAFSFid, fnamep, &existingAFSFid,
3233             &newLinkStatus, &updatedDirStatus, &volSync);
3234         rx_PutConnection(rxconnp);
3235         osi_Log1(afsd_logp,"  RXAFS_Link returns 0x%x", code);
3236
3237     } while (cm_Analyze(connp, userp, reqp,
3238         &dscp->fid, &volSync, NULL, NULL, code));
3239
3240     code = cm_MapRPCError(code, reqp);
3241
3242     if (code)
3243         osi_Log1(afsd_logp, "CALL Link FAILURE, code 0x%x", code);
3244     else
3245         osi_Log0(afsd_logp, "CALL Link SUCCESS");
3246
3247     if (dirop.scp) {
3248         lock_ObtainWrite(&dirop.scp->dirlock);
3249         dirop.lockType = CM_DIRLOCK_WRITE;
3250     }
3251     lock_ObtainWrite(&dscp->rw);
3252     if (code == 0) {
3253         cm_MergeStatus(NULL, dscp, &updatedDirStatus, &volSync, userp, reqp, CM_MERGEFLAG_DIROP);
3254         invalidate = 1;
3255
3256         if (cm_CheckDirOpForSingleChange(&dirop)) {
3257             lock_ReleaseWrite(&dscp->rw);
3258             cm_DirCreateEntry(&dirop, fnamep, &sscp->fid);
3259 #ifdef USE_BPLUS
3260             cm_BPlusDirCreateEntry(&dirop, cnamep, &sscp->fid);
3261 #endif
3262             lock_ObtainWrite(&dscp->rw);
3263         }
3264     } else {
3265         InterlockedDecrement(&dscp->activeRPCs);
3266     }
3267     cm_SyncOpDone(dscp, NULL, CM_SCACHESYNC_STOREDATA);
3268     lock_ReleaseWrite(&dscp->rw);
3269
3270     cm_EndDirOp(&dirop);
3271
3272     if (invalidate && RDR_Initialized)
3273         RDR_InvalidateObject(dscp->fid.cell, dscp->fid.volume, dscp->fid.vnode,
3274                              dscp->fid.unique, dscp->fid.hash,
3275                              dscp->fileType, AFS_INVALIDATE_DATA_VERSION);
3276
3277     /* Update the linked object status */
3278     if (code == 0) {
3279         lock_ObtainWrite(&sscp->rw);
3280         InterlockedIncrement(&sscp->activeRPCs);
3281         cm_MergeStatus(NULL, sscp, &newLinkStatus, &volSync, userp, reqp, 0);
3282         lock_ReleaseWrite(&sscp->rw);
3283     }
3284
3285     free(fnamep);
3286
3287     return code;
3288 }
3289
3290 long cm_SymLink(cm_scache_t *dscp, clientchar_t *cnamep, fschar_t *contentsp, long flags,
3291                 cm_attr_t *attrp, cm_user_t *userp, cm_req_t *reqp, cm_scache_t **scpp)
3292 {
3293     cm_conn_t *connp;
3294     long code;
3295     AFSFid dirAFSFid;
3296     AFSFid newAFSFid;
3297     cm_fid_t newFid;
3298     cm_scache_t *scp;
3299     AFSStoreStatus inStatus;
3300     AFSFetchStatus updatedDirStatus;
3301     AFSFetchStatus newLinkStatus;
3302     AFSVolSync volSync;
3303     struct rx_connection * rxconnp;
3304     cm_dirOp_t dirop;
3305     fschar_t *fnamep = NULL;
3306
3307     if (scpp)
3308         *scpp = NULL;
3309
3310     /* Check for RO volume */
3311     if (dscp->flags & CM_SCACHEFLAG_RO)
3312         return CM_ERROR_READONLY;
3313
3314     memset(&volSync, 0, sizeof(volSync));
3315
3316     /* before starting the RPC, mark that we're changing the directory data,
3317      * so that someone who does a chmod on the dir will wait until our
3318      * call completes.
3319      */
3320     cm_BeginDirOp(dscp, userp, reqp, CM_DIRLOCK_NONE, CM_DIROP_FLAG_NONE,
3321                   &dirop);
3322     lock_ObtainWrite(&dscp->rw);
3323     code = cm_SyncOp(dscp, NULL, userp, reqp, 0, CM_SCACHESYNC_STOREDATA);
3324     lock_ReleaseWrite(&dscp->rw);
3325     if (code != 0)
3326         cm_EndDirOp(&dirop);
3327     if (code) {
3328         return code;
3329     }
3330
3331     fnamep = cm_ClientStringToFsStringAlloc(cnamep, -1, NULL);
3332
3333     cm_StatusFromAttr(&inStatus, NULL, attrp);
3334
3335     /* try the RPC now */
3336     InterlockedIncrement(&dscp->activeRPCs);
3337     osi_Log1(afsd_logp, "CALL Symlink scp 0x%p", dscp);
3338     do {
3339         code = cm_ConnFromFID(&dscp->fid, userp, reqp, &connp);
3340         if (code)
3341             continue;
3342
3343         dirAFSFid.Volume = dscp->fid.volume;
3344         dirAFSFid.Vnode = dscp->fid.vnode;
3345         dirAFSFid.Unique = dscp->fid.unique;
3346
3347         rxconnp = cm_GetRxConn(connp);
3348         code = RXAFS_Symlink(rxconnp, &dirAFSFid, fnamep, contentsp,
3349                               &inStatus, &newAFSFid, &newLinkStatus,
3350                               &updatedDirStatus, &volSync);
3351         rx_PutConnection(rxconnp);
3352
3353     } while (cm_Analyze(connp, userp, reqp,
3354                          &dscp->fid, &volSync, NULL, NULL, code));
3355     code = cm_MapRPCError(code, reqp);
3356
3357     if (code)
3358         osi_Log1(afsd_logp, "CALL Symlink FAILURE, code 0x%x", code);
3359     else
3360         osi_Log0(afsd_logp, "CALL Symlink SUCCESS");
3361
3362     if (dirop.scp) {
3363         lock_ObtainWrite(&dirop.scp->dirlock);
3364         dirop.lockType = CM_DIRLOCK_WRITE;
3365     }
3366     lock_ObtainWrite(&dscp->rw);
3367     if (code == 0) {
3368         cm_MergeStatus(NULL, dscp, &updatedDirStatus, &volSync, userp, reqp, CM_MERGEFLAG_DIROP);
3369         cm_SetFid(&newFid, dscp->fid.cell, dscp->fid.volume, newAFSFid.Vnode, newAFSFid.Unique);
3370         if (cm_CheckDirOpForSingleChange(&dirop)) {
3371             lock_ReleaseWrite(&dscp->rw);
3372             cm_SetFid(&newFid, dscp->fid.cell, dscp->fid.volume, newAFSFid.Vnode, newAFSFid.Unique);
3373
3374             cm_DirCreateEntry(&dirop, fnamep, &newFid);
3375 #ifdef USE_BPLUS
3376             cm_BPlusDirCreateEntry(&dirop, cnamep, &newFid);
3377 #endif
3378             lock_ObtainWrite(&dscp->rw);
3379         }
3380     } else {
3381         InterlockedDecrement(&dscp->activeRPCs);
3382     }
3383     cm_SyncOpDone(dscp, NULL, CM_SCACHESYNC_STOREDATA);
3384     lock_ReleaseWrite(&dscp->rw);
3385
3386     cm_EndDirOp(&dirop);
3387
3388     /* now try to create the new dir's entry, too, but be careful to
3389      * make sure that we don't merge in old info.  Since we weren't locking
3390      * out any requests during the file's creation, we may have pretty old
3391      * info.
3392      */
3393     if (code == 0) {
3394         code = cm_GetSCache(&newFid, &scp, userp, reqp);
3395         if (code == 0) {
3396             lock_ObtainWrite(&scp->rw);
3397             if (!cm_HaveCallback(scp)) {
3398                 InterlockedIncrement(&scp->activeRPCs);
3399                 cm_MergeStatus(dscp, scp, &newLinkStatus, &volSync,
3400                                 userp, reqp, 0);
3401             }
3402             lock_ReleaseWrite(&scp->rw);
3403
3404             if (scpp) {
3405                 *scpp = scp;
3406             } else {
3407                 cm_ReleaseSCache(scp);
3408             }
3409         }
3410     }
3411
3412     free(fnamep);
3413
3414     /* and return error code */
3415     return code;
3416 }
3417
3418 /*! \brief Remove a directory
3419
3420   Encapsulates a call to RXAFS_RemoveDir().
3421
3422   \param[in] dscp cm_scache_t for the directory containing the
3423       directory to be removed.
3424
3425   \param[in] fnamep This will be the original name of the directory
3426       as known to the file server.   It will be passed in to RXAFS_RemoveDir().
3427       This parameter is optional.  If it is not provided the value
3428       will be looked up.
3429
3430   \param[in] cnamep Normalized name used to update the local
3431       directory caches.
3432
3433   \param[in] userp cm_user_t for the request.
3434
3435   \param[in] reqp Request tracker.
3436 */
3437 long cm_RemoveDir(cm_scache_t *dscp, fschar_t *fnamep, clientchar_t *cnamep, cm_user_t *userp, cm_req_t *reqp)
3438 {
3439     cm_conn_t *connp;
3440     long code;
3441     AFSFid dirAFSFid;
3442     int didEnd;
3443     AFSFetchStatus updatedDirStatus;
3444     AFSVolSync volSync;
3445     struct rx_connection * rxconnp;
3446     cm_dirOp_t dirop;
3447     cm_scache_t *scp = NULL;
3448     int free_fnamep = FALSE;
3449
3450     memset(&volSync, 0, sizeof(volSync));
3451
3452     if (fnamep == NULL) {
3453         code = -1;
3454 #ifdef USE_BPLUS
3455         code = cm_BeginDirOp(dscp, userp, reqp, CM_DIRLOCK_READ,
3456                              CM_DIROP_FLAG_NONE, &dirop);
3457         if (code == 0) {
3458             code = cm_BPlusDirLookupOriginalName(&dirop, cnamep, &fnamep);
3459             if (code == 0)
3460                 free_fnamep = TRUE;
3461             cm_EndDirOp(&dirop);
3462         }
3463 #endif
3464         if (code)
3465             goto done;
3466     }
3467
3468     code = cm_Lookup(dscp, cnamep, CM_FLAG_NOMOUNTCHASE, userp, reqp, &scp);
3469     if (code)
3470         goto done;
3471
3472     /* Check for RO volume */
3473     if (dscp->flags & CM_SCACHEFLAG_RO) {
3474         code = CM_ERROR_READONLY;
3475         goto done;
3476     }
3477
3478     /* before starting the RPC, mark that we're changing the directory data,
3479      * so that someone who does a chmod on the dir will wait until our
3480      * call completes.
3481      */
3482     cm_BeginDirOp(dscp, userp, reqp, CM_DIRLOCK_NONE, CM_DIROP_FLAG_NONE,
3483                   &dirop);
3484     lock_ObtainWrite(&dscp->rw);
3485     code = cm_SyncOp(dscp, NULL, userp, reqp, 0, CM_SCACHESYNC_STOREDATA);
3486     lock_ReleaseWrite(&dscp->rw);
3487     if (code) {
3488         cm_EndDirOp(&dirop);
3489         goto done;
3490     }
3491     didEnd = 0;
3492
3493     /* try the RPC now */
3494     InterlockedIncrement(&dscp->activeRPCs);
3495     osi_Log1(afsd_logp, "CALL RemoveDir scp 0x%p", dscp);
3496     do {
3497         code = cm_ConnFromFID(&dscp->fid, userp, reqp, &connp);
3498         if (code)
3499             continue;
3500
3501         dirAFSFid.Volume = dscp->fid.volume;
3502         dirAFSFid.Vnode = dscp->fid.vnode;
3503         dirAFSFid.Unique = dscp->fid.unique;
3504
3505         rxconnp = cm_GetRxConn(connp);
3506         code = RXAFS_RemoveDir(rxconnp, &dirAFSFid, fnamep,
3507                                &updatedDirStatus, &volSync);
3508         rx_PutConnection(rxconnp);
3509
3510     } while (cm_Analyze(connp, userp, reqp,
3511                         &dscp->fid, &volSync, NULL, NULL, code));
3512     code = cm_MapRPCErrorRmdir(code, reqp);
3513
3514     if (code)
3515         osi_Log1(afsd_logp, "CALL RemoveDir FAILURE, code 0x%x", code);
3516     else
3517         osi_Log0(afsd_logp, "CALL RemoveDir SUCCESS");
3518
3519     if (dirop.scp) {
3520         lock_ObtainWrite(&dirop.scp->dirlock);
3521         dirop.lockType = CM_DIRLOCK_WRITE;
3522     }
3523     lock_ObtainWrite(&dscp->rw);
3524     if (code == 0) {
3525         cm_dnlcRemove(dscp, cnamep);
3526         cm_MergeStatus(NULL, dscp, &updatedDirStatus, &volSync, userp, reqp, CM_MERGEFLAG_DIROP);
3527         if (cm_CheckDirOpForSingleChange(&dirop) && cnamep != NULL) {
3528             lock_ReleaseWrite(&dscp->rw);
3529             cm_DirDeleteEntry(&dirop, fnamep);
3530 #ifdef USE_BPLUS
3531             cm_BPlusDirDeleteEntry(&dirop, cnamep);
3532 #endif
3533             lock_ObtainWrite(&dscp->rw);
3534         }
3535     } else {
3536         InterlockedDecrement(&dscp->activeRPCs);
3537     }
3538     cm_SyncOpDone(dscp, NULL, CM_SCACHESYNC_STOREDATA);
3539     lock_ReleaseWrite(&dscp->rw);
3540
3541     cm_EndDirOp(&dirop);
3542
3543     if (scp) {
3544         cm_ReleaseSCache(scp);
3545         if (code == 0) {
3546             lock_ObtainWrite(&scp->rw);
3547             scp->flags |= CM_SCACHEFLAG_DELETED;
3548             lock_ObtainWrite(&cm_scacheLock);
3549             cm_AdjustScacheLRU(scp);
3550             cm_RemoveSCacheFromHashTable(scp);
3551             lock_ReleaseWrite(&cm_scacheLock);
3552             lock_ReleaseWrite(&scp->rw);
3553             if (RDR_Initialized && !(reqp->flags & CM_REQ_SOURCE_REDIR) &&
3554                 !RDR_InvalidateObject(scp->fid.cell, scp->fid.volume, scp->fid.vnode,
3555                                       scp->fid.unique, scp->fid.hash,
3556                                       scp->fileType, AFS_INVALIDATE_DELETED))
3557                 buf_ClearRDRFlag(scp, "rmdir");
3558         }
3559     }
3560
3561   done:
3562     if (free_fnamep)
3563         free(fnamep);
3564
3565     /* and return error code */
3566     return code;
3567 }
3568
3569 long cm_Open(cm_scache_t *scp, int type, cm_user_t *userp)
3570 {
3571     /* grab mutex on contents */
3572     lock_ObtainWrite(&scp->rw);
3573
3574     /* reset the prefetch info */
3575     scp->prefetch.base.LowPart = 0;             /* base */
3576     scp->prefetch.base.HighPart = 0;
3577     scp->prefetch.end.LowPart = 0;              /* and end */
3578     scp->prefetch.end.HighPart = 0;
3579
3580     /* release mutex on contents */
3581     lock_ReleaseWrite(&scp->rw);
3582
3583     /* we're done */
3584     return 0;
3585 }
3586
3587 /*! \brief Rename a file or directory
3588
3589   Encapsulates a RXAFS_Rename() call.
3590
3591   \param[in] oldDscp cm_scache_t for the directory containing the old
3592       name.
3593
3594   \param[in] oldNamep The original old name known to the file server.
3595       This is the name that will be passed into the RXAFS_Rename().
3596       If it is not provided, it will be looked up.
3597
3598   \param[in] normalizedOldNamep Normalized old name.  This is used for
3599   updating local directory caches.
3600
3601   \param[in] newDscp cm_scache_t for the directory containing the new
3602   name.
3603
3604   \param[in] newNamep New name. Normalized.
3605
3606   \param[in] userp cm_user_t for the request.
3607
3608   \param[in,out] reqp Request tracker.
3609
3610 */
3611 long cm_Rename(cm_scache_t *oldDscp, fschar_t *oldNamep, clientchar_t *cOldNamep,
3612                cm_scache_t *newDscp, clientchar_t *cNewNamep, cm_user_t *userp,
3613                cm_req_t *reqp)
3614 {
3615     cm_conn_t *connp;
3616     long code;
3617     AFSFid oldDirAFSFid;
3618     AFSFid newDirAFSFid;
3619     int didEnd;
3620     AFSFetchStatus updatedOldDirStatus;
3621     AFSFetchStatus updatedNewDirStatus;
3622     AFSVolSync volSync;
3623     int oneDir;
3624     struct rx_connection * rxconnp;
3625     cm_dirOp_t oldDirOp;
3626     cm_fid_t   fileFid;
3627     int        diropCode = -1;
3628     cm_dirOp_t newDirOp;
3629     fschar_t * newNamep = NULL;
3630     int free_oldNamep = FALSE;
3631     cm_scache_t *oldScp = NULL, *newScp = NULL;
3632
3633     memset(&volSync, 0, sizeof(volSync));
3634
3635     if (cOldNamep == NULL || cNewNamep == NULL ||
3636         cm_ClientStrLen(cOldNamep) == 0 ||
3637         cm_ClientStrLen(cNewNamep) == 0)
3638         return CM_ERROR_INVAL;
3639
3640     /*
3641      * Before we permit the operation, make sure that we do not already have
3642      * an object in the destination directory that has a case-insensitive match
3643      * for this name UNLESS the matching object is the object we are renaming.
3644      */
3645     code = cm_Lookup(oldDscp, cOldNamep, 0, userp, reqp, &oldScp);
3646     if (code) {
3647         osi_Log2(afsd_logp, "cm_Rename oldDscp 0x%p cOldName %S old name lookup failed",
3648                  oldDscp, osi_LogSaveStringW(afsd_logp, cOldNamep));
3649         goto done;
3650     }
3651
3652     /* Case sensitive lookup.  If this succeeds we are done. */
3653     code = cm_Lookup(newDscp, cNewNamep, 0, userp, reqp, &newScp);
3654     if (code) {
3655         /*
3656          * Case insensitive lookup.  If this succeeds, it could have found the
3657          * same file with a name that differs only by case or it could be a
3658          * different file entirely.
3659          */
3660         code = cm_Lookup(newDscp, cNewNamep, CM_FLAG_CASEFOLD, userp, reqp, &newScp);
3661         if (code == 0) {
3662             /* found a matching object with the new name */
3663             if (cm_FidCmp(&oldScp->fid, &newScp->fid)) {
3664                 /* and they don't match so return an error */
3665                 osi_Log2(afsd_logp, "cm_Rename newDscp 0x%p cNewName %S new name already exists",
3666                           newDscp, osi_LogSaveStringW(afsd_logp, cNewNamep));
3667                 code = CM_ERROR_EXISTS;
3668             }
3669             cm_ReleaseSCache(newScp);
3670             newScp = NULL;
3671         } else if (code == CM_ERROR_AMBIGUOUS_FILENAME) {
3672             code = CM_ERROR_EXISTS;
3673         } else {
3674             /* The target does not exist.  Clear the error and perform the rename. */
3675             code = 0;
3676         }
3677     }
3678
3679     /* Check for RO volume */
3680     if (code == 0 &&
3681         (oldDscp->flags & CM_SCACHEFLAG_RO) || (newDscp->flags & CM_SCACHEFLAG_RO)) {
3682         code = CM_ERROR_READONLY;
3683     }
3684
3685     if (code)
3686         goto done;
3687
3688     if (oldNamep == NULL) {
3689         code = -1;
3690 #ifdef USE_BPLUS
3691         code = cm_BeginDirOp(oldDscp, userp, reqp, CM_DIRLOCK_READ,
3692                              CM_DIROP_FLAG_NONE, &oldDirOp);
3693         if (code == 0) {
3694             code = cm_BPlusDirLookupOriginalName(&oldDirOp, cOldNamep, &oldNamep);
3695             if (code == 0)
3696                 free_oldNamep = TRUE;
3697             cm_EndDirOp(&oldDirOp);
3698         }
3699 #endif
3700         if (code) {
3701             osi_Log2(afsd_logp, "cm_Rename oldDscp 0x%p cOldName %S Original Name lookup failed",
3702                       oldDscp, osi_LogSaveStringW(afsd_logp, cOldNamep));
3703             goto done;
3704         }
3705     }
3706
3707
3708     /* before starting the RPC, mark that we're changing the directory data,
3709      * so that someone who does a chmod on the dir will wait until our call
3710      * completes.  We do this in vnode order so that we don't deadlock,
3711      * which makes the code a little verbose.
3712      */
3713     if (oldDscp == newDscp) {
3714         /* check for identical names */
3715         if (cm_ClientStrCmp(cOldNamep, cNewNamep) == 0) {
3716             osi_Log2(afsd_logp, "cm_Rename oldDscp 0x%p newDscp 0x%p CM_ERROR_RENAME_IDENTICAL",
3717                       oldDscp, newDscp);
3718             code = CM_ERROR_RENAME_IDENTICAL;
3719             goto done;
3720         }
3721
3722         oneDir = 1;
3723         cm_BeginDirOp(oldDscp, userp, reqp, CM_DIRLOCK_NONE,
3724                       CM_DIROP_FLAG_NONE, &oldDirOp);
3725         lock_ObtainWrite(&oldDscp->rw);
3726         cm_dnlcRemove(oldDscp, cOldNamep);
3727         cm_dnlcRemove(oldDscp, cNewNamep);
3728         code = cm_SyncOp(oldDscp, NULL, userp, reqp, 0,
3729                           CM_SCACHESYNC_STOREDATA);
3730         lock_ReleaseWrite(&oldDscp->rw);
3731         if (code != 0) {
3732             cm_EndDirOp(&oldDirOp);
3733         }
3734     }
3735     else {
3736         /* two distinct dir vnodes */
3737         oneDir = 0;
3738         if (oldDscp->fid.cell != newDscp->fid.cell ||
3739              oldDscp->fid.volume != newDscp->fid.volume) {
3740             osi_Log2(afsd_logp, "cm_Rename oldDscp 0x%p newDscp 0x%p CM_ERROR_CROSSDEVLINK",
3741                       oldDscp, newDscp);
3742             code = CM_ERROR_CROSSDEVLINK;
3743             goto done;
3744         }
3745
3746         /* shouldn't happen that we have distinct vnodes for two
3747          * different files, but could due to deliberate attack, or
3748          * stale info.  Avoid deadlocks and quit now.
3749          */
3750         if (oldDscp->fid.vnode == newDscp->fid.vnode) {
3751             osi_Log2(afsd_logp, "cm_Rename oldDscp 0x%p newDscp 0x%p vnode collision",
3752                       oldDscp, newDscp);
3753             code = CM_ERROR_CROSSDEVLINK;
3754             goto done;
3755         }
3756
3757         if (oldDscp->fid.vnode < newDscp->fid.vnode) {
3758             cm_BeginDirOp(oldDscp, userp, reqp, CM_DIRLOCK_NONE,
3759                           CM_DIROP_FLAG_NONE, &oldDirOp);
3760             lock_ObtainWrite(&oldDscp->rw);
3761             cm_dnlcRemove(oldDscp, cOldNamep);
3762             code = cm_SyncOp(oldDscp, NULL, userp, reqp, 0,
3763                              CM_SCACHESYNC_STOREDATA);
3764             lock_ReleaseWrite(&oldDscp->rw);
3765             if (code != 0)
3766                 cm_EndDirOp(&oldDirOp);
3767             if (code == 0) {
3768                 cm_BeginDirOp(newDscp, userp, reqp, CM_DIRLOCK_NONE,
3769                               CM_DIROP_FLAG_NONE, &newDirOp);
3770                 lock_ObtainWrite(&newDscp->rw);
3771                 cm_dnlcRemove(newDscp, cNewNamep);
3772                 code = cm_SyncOp(newDscp, NULL, userp, reqp, 0,
3773                                  CM_SCACHESYNC_STOREDATA);
3774                 lock_ReleaseWrite(&newDscp->rw);
3775                 if (code) {
3776                     cm_EndDirOp(&newDirOp);
3777
3778                     /* cleanup first one */
3779                     lock_ObtainWrite(&oldDscp->rw);
3780                     cm_SyncOpDone(oldDscp, NULL,
3781                                    CM_SCACHESYNC_STOREDATA);
3782                     lock_ReleaseWrite(&oldDscp->rw);
3783                     cm_EndDirOp(&oldDirOp);
3784                 }
3785             }
3786         }
3787         else {
3788             /* lock the new vnode entry first */
3789             cm_BeginDirOp(newDscp, userp, reqp, CM_DIRLOCK_NONE,
3790                           CM_DIROP_FLAG_NONE, &newDirOp);
3791             lock_ObtainWrite(&newDscp->rw);
3792             cm_dnlcRemove(newDscp, cNewNamep);
3793             code = cm_SyncOp(newDscp, NULL, userp, reqp, 0,
3794                               CM_SCACHESYNC_STOREDATA);
3795             lock_ReleaseWrite(&newDscp->rw);
3796             if (code != 0)
3797                 cm_EndDirOp(&newDirOp);
3798             if (code == 0) {
3799                 cm_BeginDirOp(oldDscp, userp, reqp, CM_DIRLOCK_NONE,
3800                               CM_DIROP_FLAG_NONE, &oldDirOp);
3801                 lock_ObtainWrite(&oldDscp->rw);
3802                 cm_dnlcRemove(oldDscp, cOldNamep);
3803                 code = cm_SyncOp(oldDscp, NULL, userp, reqp, 0,
3804                                   CM_SCACHESYNC_STOREDATA);
3805                 lock_ReleaseWrite(&oldDscp->rw);
3806                 if (code != 0)
3807                     cm_EndDirOp(&oldDirOp);
3808                 if (code) {
3809                     /* cleanup first one */
3810                     lock_ObtainWrite(&newDscp->rw);
3811                     cm_SyncOpDone(newDscp, NULL,
3812                                    CM_SCACHESYNC_STOREDATA);
3813                     lock_ReleaseWrite(&newDscp->rw);
3814                     cm_EndDirOp(&newDirOp);
3815                 }
3816             }
3817         }
3818     }   /* two distinct vnodes */
3819
3820     if (code)
3821         goto done;
3822
3823     didEnd = 0;
3824
3825     newNamep = cm_ClientStringToFsStringAlloc(cNewNamep, -1, NULL);
3826
3827     /* try the RPC now */
3828     InterlockedIncrement(&oldDscp->activeRPCs);
3829     if (!oneDir)
3830         InterlockedIncrement(&newDscp->activeRPCs);
3831     osi_Log2(afsd_logp, "CALL Rename old scp 0x%p new scp 0x%p",
3832               oldDscp, newDscp);
3833     do {
3834         code = cm_ConnFromFID(&oldDscp->fid, userp, reqp, &connp);
3835         if (code)
3836             continue;
3837
3838         oldDirAFSFid.Volume = oldDscp->fid.volume;
3839         oldDirAFSFid.Vnode = oldDscp->fid.vnode;
3840         oldDirAFSFid.Unique = oldDscp->fid.unique;
3841         newDirAFSFid.Volume = newDscp->fid.volume;
3842         newDirAFSFid.Vnode = newDscp->fid.vnode;
3843         newDirAFSFid.Unique = newDscp->fid.unique;
3844
3845         rxconnp = cm_GetRxConn(connp);
3846         code = RXAFS_Rename(rxconnp, &oldDirAFSFid, oldNamep,
3847                             &newDirAFSFid, newNamep,
3848                             &updatedOldDirStatus, &updatedNewDirStatus,
3849                             &volSync);
3850         rx_PutConnection(rxconnp);
3851
3852     } while (cm_Analyze(connp, userp, reqp, &oldDscp->fid,
3853                          &volSync, NULL, NULL, code));
3854     code = cm_MapRPCError(code, reqp);
3855
3856     if (code)
3857         osi_Log1(afsd_logp, "CALL Rename FAILURE, code 0x%x", code);
3858     else
3859         osi_Log0(afsd_logp, "CALL Rename SUCCESS");
3860
3861     /* update the individual stat cache entries for the directories */
3862     if (oldDirOp.scp) {
3863         lock_ObtainWrite(&oldDirOp.scp->dirlock);
3864         oldDirOp.lockType = CM_DIRLOCK_WRITE;
3865     }
3866
3867     lock_ObtainWrite(&oldDscp->rw);
3868     if (code == 0) {
3869         cm_MergeStatus(NULL, oldDscp, &updatedOldDirStatus, &volSync,
3870                        userp, reqp, CM_MERGEFLAG_DIROP);
3871         if (cm_CheckDirOpForSingleChange(&oldDirOp)) {
3872             lock_ReleaseWrite(&oldDscp->rw);
3873 #ifdef USE_BPLUS
3874             diropCode = cm_BPlusDirLookup(&oldDirOp, cOldNamep, &fileFid);
3875             if (diropCode == CM_ERROR_INEXACT_MATCH)
3876                 diropCode = 0;
3877             else if (diropCode == EINVAL)
3878 #endif
3879                 diropCode = cm_DirLookup(&oldDirOp, oldNamep, &fileFid);
3880
3881             if (diropCode == 0) {
3882                 if (oneDir) {
3883                     diropCode = cm_DirCreateEntry(&oldDirOp, newNamep, &fileFid);
3884 #ifdef USE_BPLUS
3885                     cm_BPlusDirCreateEntry(&oldDirOp, cNewNamep, &fileFid);
3886 #endif
3887                 }
3888
3889                 if (diropCode == 0) {
3890                     diropCode = cm_DirDeleteEntry(&oldDirOp, oldNamep);
3891 #ifdef USE_BPLUS
3892                     cm_BPlusDirDeleteEntry(&oldDirOp, cOldNamep);
3893 #endif
3894                 }
3895             }
3896             lock_ObtainWrite(&oldDscp->rw);
3897         }
3898     } else {
3899         InterlockedDecrement(&oldDscp->activeRPCs);
3900     }
3901     cm_SyncOpDone(oldDscp, NULL, CM_SCACHESYNC_STOREDATA);
3902     lock_ReleaseWrite(&oldDscp->rw);
3903
3904     cm_EndDirOp(&oldDirOp);
3905
3906     /* and update it for the new one, too, if necessary */
3907     if (!oneDir) {
3908         if (newDirOp.scp) {
3909             lock_ObtainWrite(&newDirOp.scp->dirlock);
3910             newDirOp.lockType = CM_DIRLOCK_WRITE;
3911         }
3912         lock_ObtainWrite(&newDscp->rw);
3913         if (code == 0) {
3914             cm_MergeStatus(NULL, newDscp, &updatedNewDirStatus, &volSync,
3915                             userp, reqp, CM_MERGEFLAG_DIROP);
3916 #if 0
3917             /*
3918              * The following optimization does not work.
3919              * When the file server processed a RXAFS_Rename() request the
3920              * FID of the object being moved between directories is not
3921              * preserved.  The client does not know the new FID nor the
3922              * version number of the target.  Not only can we not create
3923              * the directory entry in the new directory, but we can't
3924              * preserve the cached data for the file.  It must be re-read
3925              * from the file server.  - jaltman, 2009/02/20
3926              */
3927             /* we only make the local change if we successfully made
3928              * the change in the old directory AND there was only one
3929              * change in the new directory
3930              */
3931             if (diropCode == 0 && cm_CheckDirOpForSingleChange(&newDirOp)) {
3932                 lock_ReleaseWrite(&newDscp->rw);
3933                 cm_DirCreateEntry(&newDirOp, newNamep, &fileFid);
3934 #ifdef USE_BPLUS
3935                 cm_BPlusDirCreateEntry(&newDirOp, cNewNamep, &fileFid);
3936 #endif
3937                 lock_ObtainWrite(&newDscp->rw);
3938             }
3939 #endif /* 0 */
3940         } else {
3941             InterlockedIncrement(&newDscp->activeRPCs);
3942         }
3943         cm_SyncOpDone(newDscp, NULL, CM_SCACHESYNC_STOREDATA);
3944         lock_ReleaseWrite(&newDscp->rw);
3945
3946         cm_EndDirOp(&newDirOp);
3947     }
3948
3949     /*
3950      * After the rename the file server has invalidated the callbacks
3951      * on the file that was moved nor do we have a directory reference
3952      * to it anymore.
3953      */
3954     lock_ObtainWrite(&oldScp->rw);
3955     cm_DiscardSCache(oldScp);
3956     lock_ReleaseWrite(&oldScp->rw);
3957
3958     if (RDR_Initialized)
3959         RDR_InvalidateObject(oldScp->fid.cell, oldScp->fid.volume, oldScp->fid.vnode, oldScp->fid.unique,
3960                               oldScp->fid.hash, oldScp->fileType, AFS_INVALIDATE_CALLBACK);
3961   done:
3962     if (oldScp)
3963         cm_ReleaseSCache(oldScp);
3964
3965     if (free_oldNamep)
3966         free(oldNamep);
3967
3968     free(newNamep);
3969
3970     /* and return error code */
3971     return code;
3972 }
3973
3974 /* Byte range locks:
3975
3976    The OpenAFS Windows client has to fake byte range locks given no
3977    server side support for such locks.  This is implemented as keyed
3978    byte range locks on the cache manager.
3979
3980    Keyed byte range locks:
3981
3982    Each cm_scache_t structure keeps track of a list of keyed locks.
3983    The key for a lock identifies an owner of a set of locks (referred
3984    to as a client).  Each key is represented by a value.  The set of
3985    key values used within a specific cm_scache_t structure form a
3986    namespace that has a scope of just that cm_scache_t structure.  The
3987    same key value can be used with another cm_scache_t structure and
3988    correspond to a completely different client.  However it is
3989    advantageous for the SMB or IFS layer to make sure that there is a
3990    1-1 mapping between client and keys over all cm_scache_t objects.
3991
3992    Assume a client C has key Key(C) (although, since the scope of the
3993    key is a cm_scache_t, the key can be Key(C,S), where S is the
3994    cm_scache_t.  But assume a 1-1 relation between keys and clients).
3995    A byte range (O,+L) denotes byte addresses (O) through (O+L-1)
3996    inclusive (a.k.a. [O,O+L-1]).  The function Key(x) is implemented
3997    through cm_generateKey() function for both SMB and IFS.
3998
3999    The list of locks for a cm_scache_t object S is maintained in
4000    S->fileLocks.  The cache manager will set a lock on the AFS file
4001    server in order to assert the locks in S->fileLocks.  If only
4002    shared locks are in place for S, then the cache manager will obtain
4003    a LockRead lock, while if there are any exclusive locks, it will
4004    obtain a LockWrite lock.  If the exclusive locks are all released
4005    while the shared locks remain, then the cache manager will
4006    downgrade the lock from LockWrite to LockRead.  Similarly, if an
4007    exclusive lock is obtained when only shared locks exist, then the
4008    cache manager will try to upgrade the lock from LockRead to
4009    LockWrite.
4010
4011    Each lock L owned by client C maintains a key L->key such that
4012    L->key == Key(C), the effective range defined by L->LOffset and
4013    L->LLength such that the range of bytes affected by the lock is
4014    (L->LOffset, +L->LLength), a type maintained in L->LockType which
4015    is either exclusive or shared.
4016
4017    Lock states:
4018
4019    A lock exists iff it is in S->fileLocks for some cm_scache_t
4020    S. Existing locks are in one of the following states: ACTIVE,
4021    WAITLOCK, WAITUNLOCK, LOST, DELETED.
4022
4023    The following sections describe each lock and the associated
4024    transitions.
4025
4026    1. ACTIVE: A lock L is ACTIVE iff the cache manager has asserted
4027       the lock with the AFS file server.  This type of lock can be
4028       exercised by a client to read or write to the locked region (as
4029       the lock allows).
4030
4031       1.1 ACTIVE->LOST: When the AFS file server fails to extend a
4032         server lock that was required to assert the lock.  Before
4033         marking the lock as lost, the cache manager checks if the file
4034         has changed on the server.  If the file has not changed, then
4035         the cache manager will attempt to obtain a new server lock
4036         that is sufficient to assert the client side locks for the
4037         file.  If any of these fail, the lock is marked as LOST.
4038         Otherwise, it is left as ACTIVE.
4039
4040       1.2 ACTIVE->DELETED: Lock is released.
4041
4042    2. WAITLOCK: A lock is in a WAITLOCK state if the cache manager
4043       grants the lock but the lock is yet to be asserted with the AFS
4044       file server.  Once the file server grants the lock, the state
4045       will transition to an ACTIVE lock.
4046
4047       2.1 WAITLOCK->ACTIVE: The server granted the lock.
4048
4049       2.2 WAITLOCK->DELETED: Lock is abandoned, or timed out during
4050         waiting.
4051
4052       2.3 WAITLOCK->LOST: One or more locks from this client were
4053         marked as LOST.  No further locks will be granted to this
4054         client until all lost locks are removed.
4055
4056    3. WAITUNLOCK: A lock is in a WAITUNLOCK state if the cache manager
4057       receives a request for a lock that conflicts with an existing
4058       ACTIVE or WAITLOCK lock.  The lock will be placed in the queue
4059       and will be granted at such time the conflicting locks are
4060       removed, at which point the state will transition to either
4061       WAITLOCK or ACTIVE.
4062
4063       3.1 WAITUNLOCK->ACTIVE: The conflicting lock was removed.  The
4064         current serverLock is sufficient to assert this lock, or a
4065         sufficient serverLock is obtained.
4066
4067       3.2 WAITUNLOCK->WAITLOCK: The conflicting lock was removed,
4068         however the required serverLock is yet to be asserted with the
4069         server.
4070
4071       3.3 WAITUNLOCK->DELETED: The lock is abandoned, timed out or
4072         released.
4073
4074       3.5 WAITUNLOCK->LOST: One or more locks from this client were
4075         marked as LOST.  No further locks will be granted to this
4076         client until all lost locks are removed.
4077
4078    4. LOST: A lock L is LOST if the server lock that was required to
4079       assert the lock could not be obtained or if it could not be
4080       extended, or if other locks by the same client were LOST.
4081       Essentially, once a lock is LOST, the contract between the cache
4082       manager and that specific client is no longer valid.
4083
4084       The cache manager rechecks the server lock once every minute and
4085       extends it as appropriate.  If this is not done for 5 minutes,
4086       the AFS file server will release the lock (the 5 minute timeout
4087       is based on current file server code and is fairly arbitrary).
4088       Once released, the lock cannot be re-obtained without verifying
4089       that the contents of the file hasn't been modified since the
4090       time the lock was released.  Re-obtaining the lock without
4091       verifying this may lead to data corruption.  If the lock can not
4092       be obtained safely, then all active locks for the cm_scache_t
4093       are marked as LOST.
4094
4095       4.1 LOST->DELETED: The lock is released.
4096
4097    5. DELETED: The lock is no longer relevant.  Eventually, it will
4098       get removed from the cm_scache_t. In the meantime, it will be
4099       treated as if it does not exist.
4100
4101       5.1 DELETED->not exist: The lock is removed from the
4102         cm_scache_t.
4103
4104    The following are classifications of locks based on their state.
4105
4106    6* A lock L is ACCEPTED if it is ACTIVE or WAITLOCK.  These locks
4107       have been accepted by the cache manager, but may or may not have
4108       been granted back to the client.
4109
4110    7* A lock L is QUEUED if it is ACTIVE, WAITLOCK or WAITUNLOCK.
4111
4112    8* A lock L is WAITING if it is WAITLOCK or WAITUNLOCK.
4113
4114    Lock operation:
4115
4116    A client C can READ range (Offset,+Length) of a file represented by
4117    cm_scache_t S iff (1):
4118
4119    1. for all _a_ in (Offset,+Length), all of the following is true:
4120
4121        1.1 For each ACTIVE lock L in S->fileLocks such that _a_ in
4122          (L->LOffset,+L->LLength); L->key == Key(C) OR L->LockType is
4123          shared.
4124
4125        1.2 For each LOST lock L in S->fileLocks such that _a_ in
4126          (L->LOffset,+L->LLength); L->LockType is shared AND L->key !=
4127          Key(C)
4128
4129        (When locks are lost on an cm_scache_t, all locks are lost.  By
4130        4.2 (below), if there is an exclusive LOST lock, then there
4131        can't be any overlapping ACTIVE locks.)
4132
4133    A client C can WRITE range (Offset,+Length) of cm_scache_t S iff (2):
4134
4135    2. for all _a_ in (Offset,+Length), one of the following is true:
4136
4137        2.1 Byte _a_ of S is unowned (as specified in 1.1) AND there
4138          does not exist a LOST lock L such that _a_ in
4139          (L->LOffset,+L->LLength).
4140
4141        2.2 Byte _a_ of S is owned by C under lock L (as specified in
4142          1.2) AND L->LockType is exclusive.
4143
4144    A client C can OBTAIN a lock L on cm_scache_t S iff (both 3 and 4):
4145
4146    3. for all _a_ in (L->LOffset,+L->LLength), ALL of the following is
4147       true:
4148
4149        3.1 If L->LockType is exclusive then there does NOT exist a
4150          ACCEPTED lock M in S->fileLocks such that _a_ in
4151          (M->LOffset,+M->LLength).
4152
4153          (If we count all QUEUED locks then we hit cases such as
4154          cascading waiting locks where the locks later on in the queue
4155          can be granted without compromising file integrity.  On the
4156          other hand if only ACCEPTED locks are considered, then locks
4157          that were received earlier may end up waiting for locks that
4158          were received later to be unlocked. The choice of ACCEPTED
4159          locks was made to mimic the Windows byte range lock
4160          semantics.)
4161
4162        3.2 If L->LockType is shared then for each ACCEPTED lock M in
4163          S->fileLocks, if _a_ in (M->LOffset,+M->LLength) then
4164          M->LockType is shared.
4165
4166    4. For all LOST locks M in S->fileLocks, ALL of the following are true:
4167
4168        4.1 M->key != Key(C)
4169
4170        4.2 If M->LockType is exclusive, then (L->LOffset,+L->LLength)
4171          and (M->LOffset,+M->LLength) do not intersect.
4172
4173          (Note: If a client loses a lock, it loses all locks.
4174          Subsequently, it will not be allowed to obtain any more locks
4175          until all existing LOST locks that belong to the client are
4176          released.  Once all locks are released by a single client,
4177          there exists no further contract between the client and AFS
4178          about the contents of the file, hence the client can then
4179          proceed to obtain new locks and establish a new contract.
4180
4181          This doesn't quite work as you think it should, because most
4182          applications aren't built to deal with losing locks they
4183          thought they once had.  For now, we don't have a good
4184          solution to lost locks.
4185
4186          Also, for consistency reasons, we have to hold off on
4187          granting locks that overlap exclusive LOST locks.)
4188
4189    A client C can only unlock locks L in S->fileLocks which have
4190    L->key == Key(C).
4191
4192    The representation and invariants are as follows:
4193
4194    - Each cm_scache_t structure keeps:
4195
4196        - A queue of byte-range locks (cm_scache_t::fileLocks) which
4197          are of type cm_file_lock_t.
4198
4199        - A record of the highest server-side lock that has been
4200          obtained for this object (cm_scache_t::serverLock), which is
4201          one of (-1), LockRead, LockWrite.
4202
4203        - A count of ACCEPTED exclusive and shared locks that are in the
4204          queue (cm_scache_t::sharedLocks and
4205          cm_scache_t::exclusiveLocks)
4206
4207    - Each cm_file_lock_t structure keeps:
4208
4209        - The type of lock (cm_file_lock_t::LockType)
4210
4211        - The key associated with the lock (cm_file_lock_t::key)
4212
4213        - The offset and length of the lock (cm_file_lock_t::LOffset
4214          and cm_file_lock_t::LLength)
4215
4216        - The state of the lock.
4217
4218        - Time of issuance or last successful extension
4219
4220    Semantic invariants:
4221
4222        I1. The number of ACCEPTED locks in S->fileLocks are
4223            (S->sharedLocks + S->exclusiveLocks)
4224
4225    External invariants:
4226
4227        I3. S->serverLock is the lock that we have asserted with the
4228            AFS file server for this cm_scache_t.
4229
4230        I4. S->serverLock == LockRead iff there is at least one ACTIVE
4231            shared lock, but no ACTIVE exclusive locks.
4232
4233        I5. S->serverLock == LockWrite iff there is at least one ACTIVE
4234            exclusive lock.
4235
4236        I6. If L is a LOST lock, then for each lock M in S->fileLocks,
4237            M->key == L->key IMPLIES M is LOST or DELETED.
4238
4239    --asanka
4240  */
4241
4242 #define IS_LOCK_ACTIVE(lockp)     (((lockp)->flags & (CM_FILELOCK_FLAG_DELETED|CM_FILELOCK_FLAG_WAITLOCK|CM_FILELOCK_FLAG_WAITUNLOCK|CM_FILELOCK_FLAG_LOST)) == 0)
4243
4244 #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)
4245
4246 #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)
4247
4248 #define IS_LOCK_LOST(lockp)       (((lockp)->flags & (CM_FILELOCK_FLAG_DELETED|CM_FILELOCK_FLAG_LOST)) == CM_FILELOCK_FLAG_LOST)
4249
4250 #define IS_LOCK_DELETED(lockp)    (((lockp)->flags & CM_FILELOCK_FLAG_DELETED) == CM_FILELOCK_FLAG_DELETED)
4251
4252 /* unsafe */
4253 #define IS_LOCK_ACCEPTED(lockp)   (IS_LOCK_ACTIVE(lockp) || IS_LOCK_WAITLOCK(lockp))
4254
4255 /* unsafe */
4256 #define IS_LOCK_CLIENTONLY(lockp) ((((lockp)->scp->flags & CM_SCACHEFLAG_RO) == CM_SCACHEFLAG_RO) || (((lockp)->flags & CM_FILELOCK_FLAG_CLIENTONLY) == CM_FILELOCK_FLAG_CLIENTONLY))
4257
4258 /* unsafe */
4259 #define INTERSECT_RANGE(r1,r2) (((r2).offset+(r2).length) > (r1).offset && ((r1).offset +(r1).length) > (r2).offset)
4260
4261 /* unsafe */
4262 #define CONTAINS_RANGE(r1,r2) (((r2).offset+(r2).length) <= ((r1).offset+(r1).length) && (r1).offset <= (r2).offset)
4263
4264 #if defined(VICED_CAPABILITY_USE_BYTE_RANGE_LOCKS) && !defined(LOCK_TESTING)
4265 #define SCP_SUPPORTS_BRLOCKS(scp) ((scp)->cbServerp && ((scp)->cbServerp->capabilities & VICED_CAPABILITY_USE_BYTE_RANGE_LOCKS))
4266 #else
4267 #define SCP_SUPPORTS_BRLOCKS(scp) (1)
4268 #endif
4269
4270 #define SERVERLOCKS_ENABLED(scp) (!((scp)->flags & CM_SCACHEFLAG_RO) && cm_enableServerLocks && SCP_SUPPORTS_BRLOCKS(scp))
4271
4272 #if defined(VICED_CAPABILITY_WRITELOCKACL)
4273 #define SCP_SUPPORTS_WRITELOCKACL(scp) ((scp)->cbServerp && ((scp->cbServerp->capabilities & VICED_CAPABILITY_WRITELOCKACL)))
4274 #else
4275 #define SCP_SUPPORTS_WRITELOCKACL(scp) (0)
4276
4277 /* This should really be defined in any build that this code is being
4278    compiled. */
4279 #error  VICED_CAPABILITY_WRITELOCKACL not defined.
4280 #endif
4281
4282 static void cm_LockRangeSubtract(cm_range_t * pos, const cm_range_t * neg)
4283 {
4284     afs_int64 int_begin;
4285     afs_int64 int_end;
4286
4287     int_begin = max(pos->offset, neg->offset);
4288     int_end = min(pos->offset+pos->length, neg->offset+neg->length);
4289
4290     if (int_begin < int_end) {
4291         if (int_begin == pos->offset) {
4292             pos->length = pos->offset + pos->length - int_end;
4293             pos->offset = int_end;
4294         } else if (int_end == pos->offset + pos->length) {
4295             pos->length = int_begin - pos->offset;
4296         }
4297
4298         /* We only subtract ranges if the resulting range is
4299            contiguous.  If we try to support non-contigous ranges, we
4300            aren't actually improving performance. */
4301     }
4302 }
4303
4304 /* Called with scp->rw held.  Returns 0 if all is clear to read the
4305    specified range by the client identified by key.
4306  */
4307 long cm_LockCheckRead(cm_scache_t *scp,
4308                       LARGE_INTEGER LOffset,
4309                       LARGE_INTEGER LLength,
4310                       cm_key_t key)
4311 {
4312 #ifndef ADVISORY_LOCKS
4313
4314     cm_file_lock_t *fileLock;
4315     osi_queue_t *q;
4316     long code = 0;
4317     cm_range_t range;
4318     int substract_ranges = FALSE;
4319
4320     range.offset = LOffset.QuadPart;
4321     range.length = LLength.QuadPart;
4322
4323     /*
4324
4325      1. for all _a_ in (Offset,+Length), all of the following is true:
4326
4327        1.1 For each ACTIVE lock L in S->fileLocks such that _a_ in
4328          (L->LOffset,+L->LLength); L->key == Key(C) OR L->LockType is
4329          shared.
4330
4331        1.2 For each LOST lock L in S->fileLocks such that _a_ in
4332          (L->LOffset,+L->LLength); L->LockType is shared AND L->key !=
4333          Key(C)
4334
4335     */
4336
4337     lock_ObtainRead(&cm_scacheLock);
4338
4339     for (q = scp->fileLocksH; q && range.length > 0; q = osi_QNext(q)) {
4340         fileLock =
4341             (cm_file_lock_t *)((char *) q - offsetof(cm_file_lock_t, fileq));
4342
4343         if (INTERSECT_RANGE(range, fileLock->range)) {
4344             if (IS_LOCK_ACTIVE(fileLock)) {
4345                 if (cm_KeyEquals(&fileLock->key, &key, 0)) {
4346
4347                     /* If there is an active lock for this client, it
4348                        is safe to substract ranges.*/
4349                     cm_LockRangeSubtract(&range, &fileLock->range);
4350                     substract_ranges = TRUE;
4351                 } else {
4352                     if (fileLock->lockType != LockRead) {
4353                         code = CM_ERROR_LOCK_CONFLICT;
4354                         break;
4355                     }
4356
4357                     /* even if the entire range is locked for reading,
4358                        we still can't grant the lock at this point
4359                        because the client may have lost locks. That
4360                        is, unless we have already seen an active lock
4361                        belonging to the client, in which case there
4362                        can't be any lost locks for this client. */
4363                     if (substract_ranges)
4364                         cm_LockRangeSubtract(&range, &fileLock->range);
4365                 }
4366             } else if (IS_LOCK_LOST(fileLock) &&
4367                        (cm_KeyEquals(&fileLock->key, &key, 0) || fileLock->lockType == LockWrite)) {
4368                 code = CM_ERROR_BADFD;
4369                 break;
4370             }
4371         }
4372     }
4373
4374     lock_ReleaseRead(&cm_scacheLock);
4375
4376     osi_Log4(afsd_logp, "cm_LockCheckRead scp 0x%x offset %d length %d code 0x%x",
4377               scp, (unsigned long)LOffset.QuadPart, (unsigned long)LLength.QuadPart, code);
4378
4379     return code;
4380
4381 #else
4382
4383     return 0;
4384
4385 #endif
4386 }
4387
4388 /* Called with scp->rw held.  Returns 0 if all is clear to write the
4389    specified range by the client identified by key.
4390  */
4391 long cm_LockCheckWrite(cm_scache_t *scp,
4392                        LARGE_INTEGER LOffset,
4393                        LARGE_INTEGER LLength,
4394                        cm_key_t key)
4395 {
4396 #ifndef ADVISORY_LOCKS
4397
4398     cm_file_lock_t *fileLock;
4399     osi_queue_t *q;
4400     long code = 0;
4401     cm_range_t range;
4402
4403     range.offset = LOffset.QuadPart;
4404     range.length = LLength.QuadPart;
4405
4406     /*
4407    A client C can WRITE range (Offset,+Length) of cm_scache_t S iff (2):
4408
4409    2. for all _a_ in (Offset,+Length), one of the following is true:
4410
4411        2.1 Byte _a_ of S is unowned AND there does not exist a LOST
4412          lock L such that _a_ in (L->LOffset,+L->LLength).
4413
4414        2.2 Byte _a_ of S is owned by C under lock L AND L->LockType is
4415          exclusive.
4416     */
4417
4418     lock_ObtainRead(&cm_scacheLock);
4419
4420     for (q = scp->fileLocksH; q && range.length > 0; q = osi_QNext(q)) {
4421         fileLock =
4422             (cm_file_lock_t *)((char *) q - offsetof(cm_file_lock_t, fileq));
4423
4424         if (INTERSECT_RANGE(range, fileLock->range)) {
4425             if (IS_LOCK_ACTIVE(fileLock)) {
4426                 if (cm_KeyEquals(&fileLock->key, &key, 0)) {
4427                     if (fileLock->lockType == LockWrite) {
4428
4429                         /* if there is an active lock for this client, it
4430                            is safe to substract ranges */
4431                         cm_LockRangeSubtract(&range, &fileLock->range);
4432                     } else {
4433                         code = CM_ERROR_LOCK_CONFLICT;
4434                         break;
4435                     }
4436                 } else {
4437                     code = CM_ERROR_LOCK_CONFLICT;
4438                     break;
4439                 }
4440             } else if (IS_LOCK_LOST(fileLock)) {
4441                 code = CM_ERROR_BADFD;
4442                 break;
4443             }
4444         }
4445     }
4446
4447     lock_ReleaseRead(&cm_scacheLock);
4448
4449     osi_Log4(afsd_logp, "cm_LockCheckWrite scp 0x%x offset %d length %d code 0x%x",
4450               scp, (unsigned long)LOffset.QuadPart, (unsigned long)LLength.QuadPart, code);
4451
4452     return code;
4453
4454 #else
4455
4456     return 0;
4457
4458 #endif
4459 }
4460
4461 /* Called with cm_scacheLock write locked */
4462 static cm_file_lock_t * cm_GetFileLock(void) {
4463     cm_file_lock_t * l;
4464
4465     l = (cm_file_lock_t *) cm_freeFileLocks;
4466     if (l) {
4467         osi_QRemove(&cm_freeFileLocks, &l->q);
4468     } else {
4469         l = malloc(sizeof(cm_file_lock_t));
4470         osi_assertx(l, "null cm_file_lock_t");
4471     }
4472
4473     memset(l, 0, sizeof(cm_file_lock_t));
4474
4475     return l;
4476 }
4477
4478 /* Called with cm_scacheLock write locked */
4479 static void cm_PutFileLock(cm_file_lock_t *l) {
4480     osi_QAdd(&cm_freeFileLocks, &l->q);
4481 }
4482
4483 /* called with scp->rw held.  May release it during processing, but
4484    leaves it held on exit. */
4485 long cm_IntSetLock(cm_scache_t * scp, cm_user_t * userp, int lockType,
4486                    cm_req_t * reqp) {
4487     long code = 0;
4488     AFSFid tfid;
4489     cm_fid_t cfid;
4490     cm_conn_t * connp;
4491     struct rx_connection * rxconnp;
4492     AFSVolSync volSync;
4493     afs_uint32 reqflags = reqp->flags;
4494
4495     osi_Log2(afsd_logp, "CALL SetLock scp 0x%p for lock %d", scp, lockType);
4496
4497         if ((lockType != LOCKING_ANDX_SHARED_LOCK && scp->fsLockCount != 0) ||
4498                 (lockType == LOCKING_ANDX_SHARED_LOCK && scp->fsLockCount < 0))
4499         {
4500                 code = CM_ERROR_LOCK_NOT_GRANTED;
4501         osi_Log2(afsd_logp, "CALL SetLock FAILURE, fsLockCount %d code 0x%x", scp->fsLockCount, code);
4502                 return code;
4503         }
4504
4505     memset(&volSync, 0, sizeof(volSync));
4506
4507     tfid.Volume = scp->fid.volume;
4508     tfid.Vnode = scp->fid.vnode;
4509     tfid.Unique = scp->fid.unique;
4510     cfid = scp->fid;
4511
4512     reqp->flags |= CM_REQ_NORETRY;
4513     lock_ReleaseWrite(&scp->rw);
4514
4515     do {
4516         code = cm_ConnFromFID(&cfid, userp, reqp, &connp);
4517         if (code)
4518             break;
4519
4520         rxconnp = cm_GetRxConn(connp);
4521         code = RXAFS_SetLock(rxconnp, &tfid, lockType,
4522                              &volSync);
4523         rx_PutConnection(rxconnp);
4524
4525     } while (cm_Analyze(connp, userp, reqp, &cfid, &volSync,
4526                         NULL, NULL, code));
4527
4528     code = cm_MapRPCError(code, reqp);
4529     if (code) {
4530         osi_Log1(afsd_logp, "CALL SetLock FAILURE, code 0x%x", code);
4531     } else {
4532         osi_Log0(afsd_logp, "CALL SetLock SUCCESS");
4533     }
4534
4535     reqp->flags = reqflags;
4536
4537     lock_ObtainWrite(&scp->rw);
4538     if (code == 0) {
4539         /*
4540          * The file server does not return a status structure so we must
4541          * locally track the file server lock count to the best of our
4542          * ability.
4543          */
4544         if (lockType == LockWrite)
4545             scp->fsLockCount = -1;
4546         else
4547             scp->fsLockCount++;
4548     }
4549     return code;
4550 }
4551
4552 /* called with scp->rw held.  Releases it during processing */
4553 long cm_IntReleaseLock(cm_scache_t * scp, cm_user_t * userp,
4554                        cm_req_t * reqp) {
4555     long code = 0;
4556     AFSFid tfid;
4557     cm_fid_t cfid;
4558     cm_conn_t * connp;
4559     struct rx_connection * rxconnp;
4560     AFSVolSync volSync;
4561
4562     if (scp->flags & CM_SCACHEFLAG_DELETED) {
4563         osi_Log1(afsd_logp, "CALL ReleaseLock on Deleted Vnode scp 0x%p", scp);
4564         return 0;
4565     }
4566
4567     memset(&volSync, 0, sizeof(volSync));
4568
4569     tfid.Volume = scp->fid.volume;
4570     tfid.Vnode = scp->fid.vnode;
4571     tfid.Unique = scp->fid.unique;
4572     cfid = scp->fid;
4573
4574     lock_ReleaseWrite(&scp->rw);
4575
4576     osi_Log1(afsd_logp, "CALL ReleaseLock scp 0x%p", scp);
4577
4578     do {
4579         code = cm_ConnFromFID(&cfid, userp, reqp, &connp);
4580         if (code)
4581             break;
4582
4583         rxconnp = cm_GetRxConn(connp);
4584         code = RXAFS_ReleaseLock(rxconnp, &tfid, &volSync);
4585         rx_PutConnection(rxconnp);
4586
4587     } while (cm_Analyze(connp, userp, reqp, &cfid, &volSync,
4588                         NULL, NULL, code));
4589     code = cm_MapRPCError(code, reqp);
4590     if (code)
4591         osi_Log1(afsd_logp,
4592                  "CALL ReleaseLock FAILURE, code 0x%x", code);
4593     else
4594         osi_Log0(afsd_logp,
4595                  "CALL ReleaseLock SUCCESS");
4596
4597     lock_ObtainWrite(&scp->rw);
4598     if (code == 0) {
4599         /*
4600          * The file server does not return a status structure so we must
4601          * locally track the file server lock count to the best of our
4602          * ability.
4603          */
4604         scp->fsLockCount--;
4605         if (scp->fsLockCount < 0)
4606             scp->fsLockCount = 0;
4607     }
4608
4609     return (code != CM_ERROR_BADFD ? code : 0);
4610 }
4611
4612 /* called with scp->rw held.  May release it during processing, but
4613    will exit with lock held.
4614
4615    This will return:
4616
4617    - 0 if the user has permission to get the specified lock for the scp
4618
4619    - CM_ERROR_NOACCESS if not
4620
4621    Any other error from cm_SyncOp will be sent down untranslated.
4622
4623    If CM_ERROR_NOACCESS is returned and lock_type is LockRead, then
4624    phas_insert (if non-NULL) will receive a boolean value indicating
4625    whether the user has INSERT permission or not.
4626 */
4627 long cm_LockCheckPerms(cm_scache_t * scp,
4628                        int lock_type,
4629                        cm_user_t * userp,
4630                        cm_req_t * reqp,
4631                        int * phas_insert)
4632 {
4633     long rights = 0;
4634     long code = 0, code2 = 0;
4635
4636     /* lock permissions are slightly tricky because of the 'i' bit.
4637        If the user has PRSFS_LOCK, she can read-lock the file.  If the
4638        user has PRSFS_WRITE, she can write-lock the file.  However, if
4639        the user has PRSFS_INSERT, then she can write-lock new files,
4640        but not old ones.  Since we don't have information about
4641        whether a file is new or not, we assume that if the user owns
4642        the scp, then she has the permissions that are granted by
4643        PRSFS_INSERT. */
4644
4645     osi_Log3(afsd_logp, "cm_LockCheckPerms for scp[0x%p] type[%d] user[0x%p]",
4646              scp, lock_type, userp);
4647
4648     if (lock_type == LockRead)
4649         rights |= PRSFS_LOCK;
4650     else if (lock_type == LockWrite)
4651         rights |= PRSFS_WRITE | PRSFS_LOCK;
4652     else {
4653         /* hmmkay */
4654         osi_assertx(FALSE, "invalid lock type");
4655         return 0;
4656     }
4657
4658     if (phas_insert)
4659         *phas_insert = FALSE;
4660
4661     code = cm_SyncOp(scp, NULL, userp, reqp, rights,
4662                      CM_SCACHESYNC_GETSTATUS |
4663                      CM_SCACHESYNC_NEEDCALLBACK);
4664
4665     if (phas_insert && scp->creator == userp) {
4666
4667         /* If this file was created by the user, then we check for
4668            PRSFS_INSERT.  If the file server is recent enough, then
4669            this should be sufficient for her to get a write-lock (but
4670            not necessarily a read-lock). VICED_CAPABILITY_WRITELOCKACL
4671            indicates whether a file server supports getting write
4672            locks when the user only has PRSFS_INSERT.
4673
4674            If the file was not created by the user we skip the check
4675            because the INSERT bit will not apply to this user even
4676            if it is set.
4677          */
4678
4679         code2 = cm_SyncOp(scp, NULL, userp, reqp, PRSFS_INSERT,
4680                          CM_SCACHESYNC_GETSTATUS |
4681                          CM_SCACHESYNC_NEEDCALLBACK);
4682
4683         if (code2 == CM_ERROR_NOACCESS) {
4684             osi_Log0(afsd_logp, "cm_LockCheckPerms user has no INSERT bits");
4685         } else {
4686             *phas_insert = TRUE;
4687             osi_Log0(afsd_logp, "cm_LockCheckPerms user has INSERT bits");
4688         }
4689     }
4690
4691     cm_SyncOpDone(scp, NULL, CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS);
4692
4693     osi_Log1(afsd_logp, "cm_LockCheckPerms returning code %d", code);
4694
4695     return code;
4696 }
4697
4698 /* called with scp->rw held */
4699 long cm_Lock(cm_scache_t *scp, unsigned char sLockType,
4700              LARGE_INTEGER LOffset, LARGE_INTEGER LLength,
4701              cm_key_t key,
4702              int allowWait, cm_user_t *userp, cm_req_t *reqp,
4703              cm_file_lock_t **lockpp)
4704 {
4705     long code = 0;
4706     int Which = ((sLockType & LOCKING_ANDX_SHARED_LOCK) ? LockRead : LockWrite);
4707     cm_file_lock_t *fileLock;
4708     osi_queue_t *q;
4709     cm_range_t range;
4710     int wait_unlock = FALSE;
4711     int force_client_lock = FALSE;
4712
4713     osi_Log4(afsd_logp, "cm_Lock scp 0x%x type 0x%x offset %d length %d",
4714              scp, sLockType, (unsigned long)LOffset.QuadPart, (unsigned long)LLength.QuadPart);
4715     osi_Log4(afsd_logp, "... allowWait %d key <0x%x, 0x%x, 0x%x>", allowWait,
4716              key.process_id, key.session_id, key.file_id);
4717
4718     /*
4719    A client C can OBTAIN a lock L on cm_scache_t S iff (both 3 and 4):
4720
4721    3. for all _a_ in (L->LOffset,+L->LLength), ALL of the following is
4722       true:
4723
4724        3.1 If L->LockType is exclusive then there does NOT exist a
4725          ACCEPTED lock M in S->fileLocks such that _a_ in
4726          (M->LOffset,+M->LLength).
4727
4728        3.2 If L->LockType is shared then for each ACCEPTED lock M in
4729          S->fileLocks, if _a_ in (M->LOffset,+M->LLength) then
4730          M->LockType is shared.
4731
4732    4. For all LOST locks M in S->fileLocks, ALL of the following are true:
4733
4734        4.1 M->key != Key(C)
4735
4736        4.2 If M->LockType is exclusive, then (L->LOffset,+L->LLength)
4737          and (M->LOffset,+M->LLength) do not intersect.
4738     */
4739
4740     range.offset = LOffset.QuadPart;
4741     range.length = LLength.QuadPart;
4742
4743     lock_ObtainRead(&cm_scacheLock);
4744
4745     for (q = scp->fileLocksH; q; q = osi_QNext(q)) {
4746         fileLock =
4747             (cm_file_lock_t *)((char *) q - offsetof(cm_file_lock_t, fileq));
4748
4749         if (IS_LOCK_LOST(fileLock)) {
4750             if (cm_KeyEquals(&fileLock->key, &key, 0)) {
4751                 code = CM_ERROR_BADFD;
4752                 break;
4753             } else if (fileLock->lockType == LockWrite && INTERSECT_RANGE(range, fileLock->range)) {
4754                 code = CM_ERROR_WOULDBLOCK;
4755                 wait_unlock = TRUE;
4756                 break;
4757             }
4758         }
4759
4760         /* we don't need to check for deleted locks here since deleted
4761            locks are dequeued from scp->fileLocks */
4762         if (IS_LOCK_ACCEPTED(fileLock) &&
4763            INTERSECT_RANGE(range, fileLock->range)) {
4764
4765             if ((sLockType & LOCKING_ANDX_SHARED_LOCK) == 0 ||
4766                 fileLock->lockType != LockRead) {
4767                 wait_unlock = TRUE;
4768                 code = CM_ERROR_WOULDBLOCK;
4769                 break;
4770             }
4771         }
4772     }
4773
4774     lock_ReleaseRead(&cm_scacheLock);
4775
4776     if (code == 0 && SERVERLOCKS_ENABLED(scp)) {
4777         if (Which == scp->serverLock ||
4778            (Which == LockRead && scp->serverLock == LockWrite)) {
4779
4780             int has_insert = 0;
4781
4782             /* we already have the lock we need */
4783             osi_Log3(afsd_logp, "   we already have the correct lock. exclusives[%d], shared[%d], serverLock[%d]",
4784                      scp->exclusiveLocks, scp->sharedLocks, (int)(signed char) scp->serverLock);
4785
4786             code = cm_LockCheckPerms(scp, Which, userp, reqp, &has_insert);
4787
4788             /* special case: if we don't have permission to read-lock
4789                the file, then we force a clientside lock.  This is to
4790                compensate for applications that obtain a read-lock for
4791                reading files off of directories that don't grant
4792                read-locks to the user. */
4793             if (code == CM_ERROR_NOACCESS && Which == LockRead) {
4794
4795                 if (has_insert && SCP_SUPPORTS_WRITELOCKACL(scp)) {
4796                     osi_Log0(afsd_logp, "   User has no read-lock perms, but has INSERT perms.");
4797                     code = 0;
4798                 } else {
4799                     osi_Log0(afsd_logp, "   User has no read-lock perms. Forcing client-side lock");
4800                     force_client_lock = TRUE;
4801                 }
4802             }
4803
4804         } else if ((scp->exclusiveLocks > 0) ||
4805                    (scp->sharedLocks > 0 && scp->serverLock != LockRead)) {
4806             int has_insert = 0;
4807
4808             /* We are already waiting for some other lock.  We should
4809                wait for the daemon to catch up instead of generating a
4810                flood of SetLock calls. */
4811             osi_Log3(afsd_logp, "   already waiting for other lock. exclusives[%d], shared[%d], serverLock[%d]",
4812                      scp->exclusiveLocks, scp->sharedLocks, (int)(signed char) scp->serverLock);
4813
4814             /* see if we have permission to create the lock in the
4815                first place. */
4816             code = cm_LockCheckPerms(scp, Which, userp, reqp, &has_insert);
4817             if (code == 0)
4818                 code = CM_ERROR_WOULDBLOCK;
4819             else if (code == CM_ERROR_NOACCESS && Which == LockRead) {
4820
4821                 if (has_insert && SCP_SUPPORTS_WRITELOCKACL(scp)) {
4822                     osi_Log0(afsd_logp,
4823                              "   User has no read-lock perms, but has INSERT perms.");
4824                     code = CM_ERROR_WOULDBLOCK;
4825                 } else {
4826                     osi_Log0(afsd_logp,
4827                              "   User has no read-lock perms. Forcing client-side lock");
4828                     force_client_lock = TRUE;
4829                 }
4830             }
4831
4832             /* leave any other codes as-is */
4833
4834         } else {
4835             int newLock;
4836             int check_data_version = FALSE;
4837             int has_insert = 0;
4838
4839             /* first check if we have permission to elevate or obtain
4840                the lock. */
4841             code = cm_LockCheckPerms(scp, Which, userp, reqp, &has_insert);
4842             if (code) {
4843                 if (code == CM_ERROR_NOACCESS && Which == LockRead &&
4844                     (!has_insert || !SCP_SUPPORTS_WRITELOCKACL(scp))) {
4845                     osi_Log0(afsd_logp, "   User has no read-lock perms.  Forcing client-side lock");
4846                     force_client_lock = TRUE;
4847                 }
4848                 goto check_code;
4849             }
4850
4851             /* has_insert => (Which == LockRead, code == CM_ERROR_NOACCESS) */
4852
4853             if (scp->serverLock == LockRead && Which == LockWrite) {
4854
4855                 /* We want to escalate the lock to a LockWrite.
4856                  * Unfortunately that's not really possible without
4857                  * letting go of the current lock.  But for now we do
4858                  * it anyway. */
4859
4860                 osi_Log0(afsd_logp,
4861                          "   attempting to UPGRADE from LockRead to LockWrite.");
4862                 osi_Log1(afsd_logp,
4863                          "   dataVersion on scp: %I64d", scp->dataVersion);
4864
4865                 /* we assume at this point (because scp->serverLock
4866                    was valid) that we had a valid server lock. */
4867                 scp->lockDataVersion = scp->dataVersion;
4868                 check_data_version = TRUE;
4869
4870                 code = cm_IntReleaseLock(scp, userp, reqp);
4871
4872                 if (code) {
4873                     /* We couldn't release the lock */
4874                     goto check_code;
4875                 } else {
4876                     scp->serverLock = -1;
4877                 }
4878             }
4879
4880             /* We need to obtain a server lock of type Which in order
4881              * to assert this file lock */
4882 #ifndef AGGRESSIVE_LOCKS
4883             newLock = Which;
4884 #else
4885             newLock = LockWrite;
4886 #endif
4887
4888             code = cm_IntSetLock(scp, userp, newLock, reqp);
4889
4890 #ifdef AGGRESSIVE_LOCKS
4891             if ((code == CM_ERROR_WOULDBLOCK ||
4892                  code == CM_ERROR_NOACCESS) && newLock != Which) {
4893                 /* we wanted LockRead.  We tried LockWrite. Now try
4894                  * LockRead again */
4895                 newLock = Which;
4896
4897                 /* am I sane? */
4898                 osi_assertx(newLock == LockRead, "lock type not read");
4899
4900                 code = cm_IntSetLock(scp, userp, newLock, reqp);
4901             }
4902 #endif
4903
4904             if (code == CM_ERROR_NOACCESS) {
4905                 if (Which == LockRead) {
4906                     if (has_insert && SCP_SUPPORTS_WRITELOCKACL(scp)) {
4907                         long tcode;
4908                         /* We requested a read-lock, but we have permission to
4909                          * get a write-lock. Try that */
4910
4911                         tcode = cm_LockCheckPerms(scp, LockWrite, userp, reqp, NULL);
4912
4913                         if (tcode == 0) {
4914                             newLock = LockWrite;
4915
4916                             osi_Log0(afsd_logp, "   User has 'i' perms and the request was for a LockRead.  Trying to get a LockWrite instead");
4917
4918                             code = cm_IntSetLock(scp, userp, newLock, reqp);
4919                         }
4920                     } else {
4921                         osi_Log0(afsd_logp, "   User has no read-lock perms.  Forcing client-side lock");
4922                         force_client_lock = TRUE;
4923                     }
4924                 } else if (Which == LockWrite &&
4925                            scp->creator == userp && !SCP_SUPPORTS_WRITELOCKACL(scp)) {
4926                     long tcode;
4927
4928                     /* Special case: if the lock request was for a
4929                      * LockWrite and the user owns the file and we weren't
4930                      * allowed to obtain the serverlock, we either lost a
4931                      * race (the permissions changed from under us), or we
4932                      * have 'i' bits, but we aren't allowed to lock the
4933                      * file. */
4934
4935                     /* check if we lost a race... */
4936                     tcode = cm_LockCheckPerms(scp, Which, userp, reqp, NULL);
4937
4938                     if (tcode == 0) {
4939                         osi_Log0(afsd_logp, "   User has 'i' perms but can't obtain write locks. Using client-side locks.");
4940                         force_client_lock = TRUE;
4941                     }
4942                 }
4943             }
4944
4945             if (code == 0 && check_data_version &&
4946                scp->dataVersion != scp->lockDataVersion) {
4947                 /* We lost a race.  Although we successfully obtained
4948                  * a lock, someone modified the file in between.  The
4949                  * locks have all been technically lost. */
4950
4951                 osi_Log0(afsd_logp,
4952                          "  Data version mismatch while upgrading lock.");
4953                 osi_Log2(afsd_logp,
4954                          "  Data versions before=%I64d, after=%I64d",
4955                          scp->lockDataVersion,
4956                          scp->dataVersion);
4957                 osi_Log1(afsd_logp,
4958                          "  Releasing stale lock for scp 0x%x", scp);
4959
4960                 code = cm_IntReleaseLock(scp, userp, reqp);
4961
4962                 scp->serverLock = -1;
4963
4964                 code = CM_ERROR_INVAL;
4965             } else if (code == 0) {
4966                 scp->serverLock = newLock;
4967                 scp->lockDataVersion = scp->dataVersion;
4968             }
4969
4970             if (code != 0 &&
4971                 (scp->sharedLocks > 0 || scp->exclusiveLocks > 0) &&
4972                 scp->serverLock == -1) {
4973                 /* Oops. We lost the lock. */
4974                 cm_LockMarkSCacheLost(scp);
4975             }
4976         }
4977     } else if (code == 0) {     /* server locks not enabled */
4978         osi_Log0(afsd_logp,
4979                  "  Skipping server lock for scp");
4980     }
4981
4982  check_code:
4983
4984     if (code != 0 && !force_client_lock) {
4985         /* Special case error translations
4986
4987            Applications don't expect certain errors from a
4988            LockFile/UnlockFile call.  We need to translate some error
4989            code to codes that apps expect and handle. */
4990
4991         /* We shouldn't actually need to handle this case since we
4992            simulate locks for RO scps anyway. */
4993         if (code == CM_ERROR_READONLY) {
4994             osi_Log0(afsd_logp, "   Reinterpreting CM_ERROR_READONLY as CM_ERROR_NOACCESS");
4995             code = CM_ERROR_NOACCESS;
4996         }
4997     }
4998
4999     if (code == 0 || (code == CM_ERROR_WOULDBLOCK && allowWait) ||
5000         force_client_lock) {
5001
5002         /* clear the error if we are forcing a client lock, so we
5003            don't get confused later. */
5004         if (force_client_lock && code != CM_ERROR_WOULDBLOCK)
5005             code = 0;
5006
5007         cm_HoldUser(userp);
5008
5009         lock_ObtainWrite(&cm_scacheLock);
5010         fileLock = cm_GetFileLock();
5011 #ifdef DEBUG
5012         fileLock->fid = scp->fid;
5013 #endif
5014         fileLock->key = key;
5015         fileLock->lockType = Which;
5016         fileLock->userp = userp;
5017         fileLock->range = range;
5018         fileLock->flags = (code == 0 ? 0 :
5019                            ((wait_unlock)?
5020                             CM_FILELOCK_FLAG_WAITUNLOCK :
5021                             CM_FILELOCK_FLAG_WAITLOCK));
5022
5023         if (force_client_lock || !SERVERLOCKS_ENABLED(scp))
5024             fileLock->flags |= CM_FILELOCK_FLAG_CLIENTONLY;
5025
5026         fileLock->lastUpdate = (code == 0 && !force_client_lock) ? time(NULL) : 0;
5027
5028         osi_QAddT(&scp->fileLocksH, &scp->fileLocksT, &fileLock->fileq);
5029         cm_HoldSCacheNoLock(scp);
5030         fileLock->scp = scp;
5031         osi_QAdd(&cm_allFileLocks, &fileLock->q);
5032         lock_ReleaseWrite(&cm_scacheLock);
5033
5034         if (code != 0) {
5035             *lockpp = fileLock;
5036         }
5037
5038         if (IS_LOCK_CLIENTONLY(fileLock)) {
5039             scp->clientLocks++;
5040         } else if (IS_LOCK_ACCEPTED(fileLock)) {
5041             if (Which == LockRead)
5042                 scp->sharedLocks++;
5043             else
5044                 scp->exclusiveLocks++;
5045         }
5046
5047         osi_Log3(afsd_logp,
5048                  "cm_Lock Lock added 0x%p flags 0x%x to scp [0x%p]",
5049                  fileLock, fileLock->flags, scp);
5050         osi_Log4(afsd_logp,
5051                  "   exclusives[%d] shared[%d] client[%d] serverLock[%d]",
5052                  scp->exclusiveLocks, scp->sharedLocks, scp->clientLocks,
5053                  (int)(signed char) scp->serverLock);
5054     } else {
5055         osi_Log1(afsd_logp,
5056                  "cm_Lock Rejecting lock (code = 0x%x)", code);
5057     }
5058
5059     /* Convert from would block to lock not granted */
5060     if (code == CM_ERROR_WOULDBLOCK)
5061         code = CM_ERROR_LOCK_NOT_GRANTED;
5062
5063     return code;
5064 }
5065
5066 static long
5067 cm_IntUnlock(cm_scache_t * scp,
5068              cm_user_t * userp,
5069              cm_req_t *  reqp)
5070 {
5071     long code = 0;
5072
5073     osi_assertx(scp->sharedLocks >= 0, "scp->sharedLocks < 0");
5074     osi_assertx(scp->exclusiveLocks >= 0, "scp->exclusiveLocks < 0");
5075     osi_assertx(scp->clientLocks >= 0, "scp->clientLocks < 0");
5076
5077     if (!SERVERLOCKS_ENABLED(scp)) {
5078         osi_Log0(afsd_logp, "  Skipping server lock for scp");
5079         goto done;
5080     }
5081
5082     /* Ideally we would go through the rest of the locks to determine
5083      * if one or more locks that were formerly in WAITUNLOCK can now
5084      * be put to ACTIVE or WAITLOCK and update scp->exclusiveLocks and
5085      * scp->sharedLocks accordingly.  However, the retrying of locks
5086      * in that manner is done cm_RetryLock() manually.
5087      */
5088
5089     if (scp->serverLock == LockWrite &&
5090         scp->exclusiveLocks == 0 &&
5091         scp->sharedLocks > 0) {
5092         /* The serverLock should be downgraded to LockRead */
5093         osi_Log0(afsd_logp, "  DOWNGRADE lock from LockWrite to LockRead");
5094
5095         /* Make sure there are no dirty buffers left. */
5096         code = cm_FSync(scp, userp, reqp, TRUE);
5097
5098         /* since scp->serverLock looked sane, we are going to assume
5099            that we have a valid server lock. */
5100         scp->lockDataVersion = scp->dataVersion;
5101         osi_Log1(afsd_logp, "  dataVersion on scp = %I64d", scp->dataVersion);
5102
5103         /* before we downgrade, make sure that we have enough
5104            permissions to get the read lock. */
5105         code = cm_LockCheckPerms(scp, LockRead, userp, reqp, NULL);
5106         if (code != 0) {
5107
5108             osi_Log0(afsd_logp, "  SKIPPING downgrade because user doesn't have perms to get downgraded lock");
5109
5110             code = 0;
5111             goto done;
5112         }
5113
5114         code = cm_IntReleaseLock(scp, userp, reqp);
5115
5116         if (code) {
5117             /* so we couldn't release it.  Just let the lock be for now */
5118             code = 0;
5119             goto done;
5120         } else {
5121             scp->serverLock = -1;
5122         }
5123
5124         code = cm_IntSetLock(scp, userp, LockRead, reqp);
5125
5126         if (code == 0 && scp->lockDataVersion == scp->dataVersion) {
5127             scp->serverLock = LockRead;
5128         } else if (code == 0 && scp->lockDataVersion != scp->dataVersion) {
5129             /* We lost a race condition.  Although we have a valid
5130                lock on the file, the data has changed and essentially
5131                we have lost the lock we had during the transition. */
5132
5133             osi_Log0(afsd_logp, "Data version mismatch during lock downgrade");
5134             osi_Log2(afsd_logp, "  Data versions before=%I64d, after=%I64d",
5135                      scp->lockDataVersion,
5136                      scp->dataVersion);
5137
5138             code = cm_IntReleaseLock(scp, userp, reqp);
5139
5140             code = CM_ERROR_INVAL;
5141             scp->serverLock = -1;
5142         }
5143
5144         if (code != 0 &&
5145             (scp->sharedLocks > 0 || scp->exclusiveLocks > 0) &&
5146                 (scp->serverLock == -1)) {
5147                 /* Oopsie */
5148                 cm_LockMarkSCacheLost(scp);
5149             }
5150
5151         /* failure here has no bearing on the return value of cm_Unlock() */
5152         code = 0;
5153
5154     } else if (scp->serverLock != (-1) &&
5155               scp->exclusiveLocks == 0 &&
5156               scp->sharedLocks == 0) {
5157         /* The serverLock should be released entirely */
5158
5159         if (scp->serverLock == LockWrite) {
5160             osi_Log0(afsd_logp, "  RELEASE LockWrite -> LockNone");
5161
5162             /* Make sure there are no dirty buffers left. */
5163             code = cm_FSync(scp, userp, reqp, TRUE);
5164         } else {
5165             osi_Log0(afsd_logp, "  RELEASE LockRead -> LockNone");
5166         }
5167
5168         code = cm_IntReleaseLock(scp, userp, reqp);
5169
5170         if (code == 0)
5171             scp->serverLock = (-1);
5172     }
5173
5174   done:
5175     return code;
5176 }
5177 /* Called with scp->rw held */
5178 long cm_UnlockByKey(cm_scache_t * scp,
5179                     cm_key_t key,
5180                     afs_uint32 flags,
5181                     cm_user_t * userp,
5182                     cm_req_t * reqp)
5183 {
5184     long code = 0;
5185     cm_file_lock_t *fileLock;
5186     osi_queue_t *q, *qn;
5187     int n_unlocks = 0;
5188
5189     osi_Log4(afsd_logp, "cm_UnlockByKey scp 0x%p key <0x%x,0x%x,0x%x",
5190              scp, key.process_id, key.session_id, key.file_id);
5191     osi_Log1(afsd_logp, "    flags=0x%x", flags);
5192
5193     lock_ObtainWrite(&cm_scacheLock);
5194
5195     for (q = scp->fileLocksH; q; q = qn) {
5196         qn = osi_QNext(q);
5197
5198         fileLock = (cm_file_lock_t *)
5199             ((char *) q - offsetof(cm_file_lock_t, fileq));
5200
5201 #ifdef DEBUG
5202         osi_Log4(afsd_logp, "   Checking lock[0x%x] range[%d,+%d] type[%d]",
5203                  fileLock,
5204                  (unsigned long) fileLock->range.offset,
5205                  (unsigned long) fileLock->range.length,
5206                 fileLock->lockType);
5207         osi_Log4(afsd_logp, "     key<0x%x, 0x%x, 0x%x> flags[0x%x]",
5208                  fileLock->key.process_id, fileLock->key.session_id, fileLock->key.file_id,
5209                  fileLock->flags);
5210
5211         if (cm_FidCmp(&fileLock->fid, &fileLock->scp->fid)) {
5212             osi_Log0(afsd_logp, "!!fileLock->fid != scp->fid");
5213             osi_Log4(afsd_logp, "  fileLock->fid(cell=[%d], volume=[%d], vnode=[%d], unique=[%d]",
5214                      fileLock->fid.cell,
5215                      fileLock->fid.volume,
5216                      fileLock->fid.vnode,
5217                      fileLock->fid.unique);
5218             osi_Log4(afsd_logp, "  scp->fid(cell=[%d], volume=[%d], vnode=[%d], unique=[%d]",
5219                      fileLock->scp->fid.cell,
5220                      fileLock->scp->fid.volume,
5221                      fileLock->scp->fid.vnode,
5222                      fileLock->scp->fid.unique);
5223             osi_assertx(FALSE, "invalid fid value");
5224         }
5225 #endif
5226
5227         if (!IS_LOCK_DELETED(fileLock) &&
5228             cm_KeyEquals(&fileLock->key, &key, flags)) {
5229             osi_Log3(afsd_logp, "...Unlock range [%d,+%d] type %d",
5230                     fileLock->range.offset,
5231                     fileLock->range.length,
5232                     fileLock->lockType);
5233
5234             osi_QRemoveHT(&scp->fileLocksH, &scp->fileLocksT, q);
5235
5236             if (IS_LOCK_CLIENTONLY(fileLock)) {
5237                 scp->clientLocks--;
5238             } else if (IS_LOCK_ACCEPTED(fileLock)) {
5239                 if (fileLock->lockType == LockRead)
5240                     scp->sharedLocks--;
5241                 else
5242                     scp->exclusiveLocks--;
5243             }
5244
5245             fileLock->flags |= CM_FILELOCK_FLAG_DELETED;
5246
5247             cm_ReleaseUser(fileLock->userp);
5248             cm_ReleaseSCacheNoLock(scp);
5249
5250             fileLock->userp = NULL;
5251             fileLock->scp = NULL;
5252
5253             n_unlocks++;
5254         }
5255     }
5256
5257     lock_ReleaseWrite(&cm_scacheLock);
5258
5259     if (n_unlocks == 0) {
5260         osi_Log0(afsd_logp, "cm_UnlockByKey no locks found");
5261         osi_Log3(afsd_logp, "   Leaving scp with exclusives[%d], shared[%d], serverLock[%d]",
5262                  scp->exclusiveLocks, scp->sharedLocks, (int)(signed char) scp->serverLock);
5263
5264         return 0;
5265     }
5266
5267     code = cm_IntUnlock(scp, userp, reqp);
5268     osi_Log1(afsd_logp, "cm_UnlockByKey code 0x%x", code);
5269
5270     osi_Log4(afsd_logp, "   Leaving scp with excl[%d], shared[%d], client[%d], serverLock[%d]",
5271              scp->exclusiveLocks, scp->sharedLocks, scp->clientLocks,
5272              (int)(signed char) scp->serverLock);
5273
5274     return code;
5275 }
5276
5277 /* Called with scp->rw held */
5278 long cm_Unlock(cm_scache_t *scp,
5279                unsigned char sLockType,
5280                LARGE_INTEGER LOffset, LARGE_INTEGER LLength,
5281                cm_key_t key,
5282                afs_uint32 flags,
5283                cm_user_t *userp,
5284                cm_req_t *reqp)
5285 {
5286     long code = 0;
5287     int Which = ((sLockType & LOCKING_ANDX_SHARED_LOCK) ? LockRead : LockWrite);
5288     cm_file_lock_t *fileLock;
5289     osi_queue_t *q;
5290     int release_userp = FALSE;
5291     int exact_match = !(flags & CM_UNLOCK_FLAG_MATCH_RANGE);
5292     int lock_found  = 0;
5293     LARGE_INTEGER RangeEnd;
5294
5295     osi_Log4(afsd_logp, "cm_Unlock scp 0x%p type 0x%x offset 0x%x length 0x%x",
5296              scp, sLockType, (unsigned long)LOffset.QuadPart, (unsigned long)LLength.QuadPart);
5297     osi_Log4(afsd_logp, "... key <0x%x,0x%x,0x%x> flags 0x%x",
5298              key.process_id, key.session_id, key.file_id, flags);
5299
5300     if (!exact_match)
5301         RangeEnd.QuadPart = LOffset.QuadPart + LLength.QuadPart;
5302
5303   try_again:
5304     lock_ObtainRead(&cm_scacheLock);
5305
5306     for (q = scp->fileLocksH; q; q = osi_QNext(q)) {
5307         fileLock = (cm_file_lock_t *)
5308             ((char *) q - offsetof(cm_file_lock_t, fileq));
5309
5310 #ifdef DEBUG
5311         if (cm_FidCmp(&fileLock->fid, &fileLock->scp->fid)) {
5312             osi_Log0(afsd_logp, "!!fileLock->fid != scp->fid");
5313             osi_Log4(afsd_logp, "  fileLock->fid(cell=[%d], volume=[%d], vnode=[%d], unique=[%d]",
5314                      fileLock->fid.cell,
5315                      fileLock->fid.volume,
5316                      fileLock->fid.vnode,
5317                      fileLock->fid.unique);
5318             osi_Log4(afsd_logp, "  scp->fid(cell=[%d], volume=[%d], vnode=[%d], unique=[%d]",
5319                      fileLock->scp->fid.cell,
5320                      fileLock->scp->fid.volume,
5321                      fileLock->scp->fid.vnode,
5322                      fileLock->scp->fid.unique);
5323             osi_assertx(FALSE, "invalid fid value");
5324         }
5325 #endif
5326         if (exact_match) {
5327             if (!IS_LOCK_DELETED(fileLock) &&
5328                  cm_KeyEquals(&fileLock->key, &key, 0) &&
5329                  fileLock->range.offset == LOffset.QuadPart &&
5330                  fileLock->range.length == LLength.QuadPart) {
5331                 lock_found = 1;
5332                 break;
5333             }
5334         } else {
5335
5336             if (!IS_LOCK_DELETED(fileLock) &&
5337                  cm_KeyEquals(&fileLock->key, &key, 0) &&
5338                  fileLock->range.offset >= LOffset.QuadPart &&
5339                  fileLock->range.offset < RangeEnd.QuadPart &&
5340                  (fileLock->range.offset + fileLock->range.length) <= RangeEnd.QuadPart) {
5341                 lock_found = 1;
5342                 break;
5343             }
5344         }
5345     }
5346
5347     if (!q) {
5348         lock_ReleaseRead(&cm_scacheLock);
5349
5350         if (lock_found && !exact_match) {
5351             code = 0;
5352             goto done;
5353         } else {
5354             osi_Log0(afsd_logp, "cm_Unlock lock not found; failure");
5355
5356             /* The lock didn't exist anyway. *shrug* */
5357             return CM_ERROR_RANGE_NOT_LOCKED;
5358         }
5359     }
5360
5361     /* discard lock record */
5362     lock_ConvertRToW(&cm_scacheLock);
5363     osi_QRemoveHT(&scp->fileLocksH, &scp->fileLocksT, q);
5364
5365     /*
5366      * Don't delete it here; let the daemon delete it, to simplify
5367      * the daemon's traversal of the list.
5368      */
5369
5370     if (IS_LOCK_CLIENTONLY(fileLock)) {
5371         scp->clientLocks--;
5372     } else if (IS_LOCK_ACCEPTED(fileLock)) {
5373         if (fileLock->lockType == LockRead)
5374             scp->sharedLocks--;
5375         else
5376             scp->exclusiveLocks--;
5377     }
5378
5379     fileLock->flags |= CM_FILELOCK_FLAG_DELETED;
5380
5381     if (userp != NULL) {
5382         cm_ReleaseUser(fileLock->userp);
5383     } else {
5384         userp = fileLock->userp;
5385         release_userp = TRUE;
5386     }
5387     cm_ReleaseSCacheNoLock(scp);
5388     fileLock->userp = NULL;
5389     fileLock->scp = NULL;
5390     lock_ReleaseWrite(&cm_scacheLock);
5391
5392     code = cm_IntUnlock(scp, userp, reqp);
5393
5394     if (release_userp) {
5395         cm_ReleaseUser(userp);
5396         release_userp = FALSE;
5397     }
5398
5399     if (!exact_match) {
5400         osi_Log1(afsd_logp, "cm_Unlock not exact match, searching for next lock, code 0x%x", code);
5401         goto try_again;         /* might be more than one lock in the range */
5402     }
5403
5404  done:
5405
5406     osi_Log1(afsd_logp, "cm_Unlock code 0x%x", code);
5407     osi_Log4(afsd_logp, "  leaving scp with excl[%d], shared[%d], client[%d], serverLock[%d]",
5408              scp->exclusiveLocks, scp->sharedLocks, scp->clientLocks,
5409              (int)(signed char) scp->serverLock);
5410
5411     return code;
5412 }
5413
5414 /* called with scp->rw held */
5415 void cm_LockMarkSCacheLost(cm_scache_t * scp)
5416 {
5417     cm_file_lock_t *fileLock;
5418     osi_queue_t *q;
5419
5420     osi_Log1(afsd_logp, "cm_LockMarkSCacheLost scp 0x%x", scp);
5421
5422     /* cm_scacheLock needed because we are modifying fileLock->flags */
5423     lock_ObtainWrite(&cm_scacheLock);
5424
5425     for (q = scp->fileLocksH; q; q = osi_QNext(q)) {
5426         fileLock =
5427             (cm_file_lock_t *)((char *) q - offsetof(cm_file_lock_t, fileq));
5428
5429         if (IS_LOCK_ACTIVE(fileLock) &&
5430             !IS_LOCK_CLIENTONLY(fileLock)) {
5431             if (fileLock->lockType == LockRead)
5432                 scp->sharedLocks--;
5433             else
5434                 scp->exclusiveLocks--;
5435
5436             fileLock->flags |= CM_FILELOCK_FLAG_LOST;
5437         }
5438     }
5439
5440     scp->serverLock = -1;
5441     scp->lockDataVersion = CM_SCACHE_VERSION_BAD;
5442     lock_ReleaseWrite(&cm_scacheLock);
5443 }
5444
5445 /* Called with no relevant locks held */
5446 void cm_CheckLocks()
5447 {
5448     osi_queue_t *q, *nq;
5449     cm_file_lock_t *fileLock;
5450     cm_req_t req;
5451     AFSFid tfid;
5452     AFSVolSync volSync;
5453     cm_conn_t *connp;
5454     long code;
5455     struct rx_connection * rxconnp;
5456     cm_scache_t * scp;
5457
5458     memset(&volSync, 0, sizeof(volSync));
5459
5460     cm_InitReq(&req);
5461
5462     lock_ObtainWrite(&cm_scacheLock);
5463
5464     cm_lockRefreshCycle++;
5465
5466     osi_Log1(afsd_logp, "cm_CheckLocks starting lock check cycle %d", cm_lockRefreshCycle);
5467
5468     for (q = cm_allFileLocks; q; q = nq) {
5469         fileLock = (cm_file_lock_t *) q;
5470         nq = osi_QNext(q);
5471         code = -1;
5472
5473         if (IS_LOCK_DELETED(fileLock)) {
5474             cm_user_t *userp = fileLock->userp;
5475             cm_scache_t *scp = fileLock->scp;
5476             fileLock->userp = NULL;
5477             fileLock->scp = NULL;
5478
5479             if (scp && userp) {
5480                 lock_ReleaseWrite(&cm_scacheLock);
5481                 lock_ObtainWrite(&scp->rw);
5482                 code = cm_IntUnlock(scp, userp, &req);
5483                 lock_ReleaseWrite(&scp->rw);
5484
5485                 cm_ReleaseUser(userp);
5486                 lock_ObtainWrite(&cm_scacheLock);
5487                 cm_ReleaseSCacheNoLock(scp);
5488             }
5489             osi_QRemove(&cm_allFileLocks, q);
5490             cm_PutFileLock(fileLock);
5491
5492         } else if (IS_LOCK_ACTIVE(fileLock) && !IS_LOCK_CLIENTONLY(fileLock)) {
5493
5494             /* Server locks must have been enabled for us to have
5495                received an active non-client-only lock. */
5496             osi_assertx(cm_enableServerLocks, "!cm_enableServerLocks");
5497
5498             scp = fileLock->scp;
5499             osi_assertx(scp != NULL, "null cm_scache_t");
5500
5501             cm_HoldSCacheNoLock(scp);
5502
5503 #ifdef DEBUG
5504             if (cm_FidCmp(&fileLock->fid, &fileLock->scp->fid)) {
5505                 osi_Log0(afsd_logp, "!!fileLock->fid != scp->fid");
5506                 osi_Log4(afsd_logp, "  fileLock->fid(cell=[%d], volume=[%d], vnode=[%d], unique=[%d]",
5507                          fileLock->fid.cell,
5508                          fileLock->fid.volume,
5509                          fileLock->fid.vnode,
5510                          fileLock->fid.unique);
5511                 osi_Log4(afsd_logp, "  scp->fid(cell=[%d], volume=[%d], vnode=[%d], unique=[%d]",
5512                          fileLock->scp->fid.cell,
5513                          fileLock->scp->fid.volume,
5514                          fileLock->scp->fid.vnode,
5515                          fileLock->scp->fid.unique);
5516                 osi_assertx(FALSE, "invalid fid");
5517             }
5518 #endif
5519             /* Server locks are extended once per scp per refresh
5520                cycle. */
5521             if (scp->lastRefreshCycle != cm_lockRefreshCycle) {
5522
5523                 int scp_done = FALSE;
5524
5525                 osi_Log1(afsd_logp, "cm_CheckLocks Updating scp 0x%x", scp);
5526
5527                 lock_ReleaseWrite(&cm_scacheLock);
5528                 lock_ObtainWrite(&scp->rw);
5529
5530                 /* did the lock change while we weren't holding the lock? */
5531                 if (!IS_LOCK_ACTIVE(fileLock))
5532                     goto post_syncopdone;
5533
5534                 code = cm_SyncOp(scp, NULL, fileLock->userp, &req, 0,
5535                                  CM_SCACHESYNC_NEEDCALLBACK
5536                                  | CM_SCACHESYNC_GETSTATUS
5537                                  | CM_SCACHESYNC_LOCK);
5538
5539                 if (code) {
5540                     osi_Log1(afsd_logp,
5541                              "cm_CheckLocks SyncOp failure code 0x%x", code);
5542                     goto post_syncopdone;
5543                 }
5544
5545                 /* cm_SyncOp releases scp->rw during which the lock
5546                    may get released. */
5547                 if (!IS_LOCK_ACTIVE(fileLock))
5548                     goto pre_syncopdone;
5549
5550                 if (scp->serverLock != -1 && !(scp->flags & CM_SCACHEFLAG_DELETED)) {
5551                     cm_fid_t cfid;
5552                     cm_user_t * userp;
5553
5554                     tfid.Volume = scp->fid.volume;
5555                     tfid.Vnode = scp->fid.vnode;
5556                     tfid.Unique = scp->fid.unique;
5557                     cfid = scp->fid;
5558                     userp = fileLock->userp;
5559
5560                     osi_Log3(afsd_logp, "CALL ExtendLock lock 0x%p for scp=0x%p with lock %d",
5561                              fileLock,
5562                              scp,
5563                              (int) scp->serverLock);
5564
5565                     lock_ReleaseWrite(&scp->rw);
5566
5567                     do {
5568                         code = cm_ConnFromFID(&cfid, userp,
5569                                        &req, &connp);
5570                         if (code)
5571                             break;
5572
5573                         rxconnp = cm_GetRxConn(connp);
5574                         code = RXAFS_ExtendLock(rxconnp, &tfid,
5575                                                 &volSync);
5576                         rx_PutConnection(rxconnp);
5577
5578                         osi_Log1(afsd_logp, "   ExtendLock returns %d", code);
5579
5580                     } while (cm_Analyze(connp, userp, &req,
5581                                         &cfid, &volSync, NULL, NULL,
5582                                         code));
5583
5584                     code = cm_MapRPCError(code, &req);
5585
5586                     lock_ObtainWrite(&scp->rw);
5587
5588                     if (code) {
5589                         osi_Log1(afsd_logp, "CALL ExtendLock FAILURE, code 0x%x", code);
5590                         scp->fsLockCount = 0;
5591                     } else {
5592                         osi_Log0(afsd_logp, "CALL ExtendLock SUCCESS");
5593                         scp->lockDataVersion = scp->dataVersion;
5594                     }
5595
5596                     if ((code == EINVAL || code == CM_ERROR_INVAL) &&
5597                         scp->lockDataVersion == scp->dataVersion) {
5598                         int lockType;
5599
5600                         lockType =
5601                             (scp->exclusiveLocks > 0) ? LockWrite: LockRead;
5602
5603                         /* we might still have a chance to obtain a
5604                            new lock */
5605
5606                         code = cm_IntSetLock(scp, userp, lockType, &req);
5607
5608                         if (code) {
5609                             code = CM_ERROR_INVAL;
5610                         } else if (scp->lockDataVersion != scp->dataVersion) {
5611
5612                             /* now check if we still have the file at
5613                                the right data version. */
5614                             osi_Log1(afsd_logp,
5615                                      "Data version mismatch on scp 0x%p",
5616                                      scp);
5617                             osi_Log2(afsd_logp,
5618                                      "   Data versions: before=%I64d, after=%I64d",
5619                                      scp->lockDataVersion,
5620                                      scp->dataVersion);
5621
5622                             code = cm_IntReleaseLock(scp, userp, &req);
5623
5624                             code = CM_ERROR_INVAL;
5625                         }
5626                     }
5627
5628                     if (code == EINVAL || code == CM_ERROR_INVAL ||
5629                         code == CM_ERROR_BADFD) {
5630                         cm_LockMarkSCacheLost(scp);
5631                     }
5632
5633                 } else {
5634                     /* interestingly, we have found an active lock
5635                        belonging to an scache that has no
5636                        serverLock */
5637                     cm_LockMarkSCacheLost(scp);
5638                 }
5639
5640                 scp_done = TRUE;
5641
5642             pre_syncopdone:
5643
5644                 cm_SyncOpDone(scp, NULL, CM_SCACHESYNC_LOCK);
5645
5646             post_syncopdone:
5647                 lock_ReleaseWrite(&scp->rw);
5648
5649                 lock_ObtainWrite(&cm_scacheLock);
5650
5651                 if (code == 0) {
5652                     fileLock->lastUpdate = time(NULL);
5653                 }
5654
5655                 if (scp_done)
5656                     scp->lastRefreshCycle = cm_lockRefreshCycle;
5657
5658             } else {
5659                 /* we have already refreshed the locks on this scp */
5660                 fileLock->lastUpdate = time(NULL);
5661             }
5662
5663             cm_ReleaseSCacheNoLock(scp);
5664
5665         } else if (IS_LOCK_ACTIVE(fileLock) && IS_LOCK_CLIENTONLY(fileLock)) {
5666             /* TODO: Check callbacks */
5667         }
5668     }
5669
5670     lock_ReleaseWrite(&cm_scacheLock);
5671     osi_Log1(afsd_logp, "cm_CheckLocks completes lock check cycle %d", cm_lockRefreshCycle);
5672 }
5673
5674 /* NOT called with scp->rw held. */
5675 long cm_RetryLock(cm_file_lock_t *oldFileLock, int client_is_dead)
5676 {
5677     long code = 0;
5678     cm_scache_t *scp = NULL;
5679     cm_file_lock_t *fileLock;
5680     osi_queue_t *q;
5681     cm_req_t req;
5682     int newLock = -1;
5683     int force_client_lock = FALSE;
5684     int has_insert = FALSE;
5685     int check_data_version = FALSE;
5686
5687     cm_InitReq(&req);
5688
5689     if (client_is_dead) {
5690         code = CM_ERROR_TIMEDOUT;
5691         goto updateLock;
5692     }
5693
5694     lock_ObtainRead(&cm_scacheLock);
5695
5696     osi_Log2(afsd_logp, "cm_RetryLock checking lock %p (scp=%p)", oldFileLock, oldFileLock->scp);
5697     osi_Log4(afsd_logp, "    offset(%x:%x) length(%x:%x)",
5698              (unsigned)(oldFileLock->range.offset >> 32),
5699              (unsigned)(oldFileLock->range.offset & 0xffffffff),
5700              (unsigned)(oldFileLock->range.length >> 32),
5701              (unsigned)(oldFileLock->range.length & 0xffffffff));
5702     osi_Log4(afsd_logp, "    key<0x%x,0x%x,0x%x> flags=%x",
5703              oldFileLock->key.process_id, oldFileLock->key.session_id, oldFileLock->key.file_id,
5704              (unsigned)(oldFileLock->flags));
5705
5706     /* if the lock has already been granted, then we have nothing to do */
5707     if (IS_LOCK_ACTIVE(oldFileLock)) {
5708         lock_ReleaseRead(&cm_scacheLock);
5709         osi_Log0(afsd_logp, "cm_RetryLock lock already granted");
5710         return 0;
5711     }
5712
5713     /* we can't do anything with lost or deleted locks at the moment. */
5714     if (IS_LOCK_LOST(oldFileLock) || IS_LOCK_DELETED(oldFileLock)) {
5715         code = CM_ERROR_BADFD;
5716         osi_Log0(afsd_logp, "cm_RetryLock lock is lost or deleted");
5717         lock_ReleaseRead(&cm_scacheLock);
5718         goto updateLock;
5719     }
5720
5721     scp = oldFileLock->scp;
5722
5723     osi_assertx(scp != NULL, "null cm_scache_t");
5724
5725     lock_ReleaseRead(&cm_scacheLock);
5726     lock_ObtainWrite(&scp->rw);
5727
5728     code = cm_LockCheckPerms(scp, oldFileLock->lockType,
5729                              oldFileLock->userp,
5730                              &req, &has_insert);
5731
5732     if (code == CM_ERROR_NOACCESS && oldFileLock->lockType == LockRead) {
5733         if (!has_insert || !SCP_SUPPORTS_WRITELOCKACL(scp)) {
5734         force_client_lock = TRUE;
5735         }
5736         code = 0;
5737     } else if (code) {
5738         lock_ReleaseWrite(&scp->rw);
5739         return code;
5740     }
5741
5742     lock_ObtainWrite(&cm_scacheLock);
5743
5744     /* Check if we already have a sufficient server lock to allow this
5745        lock to go through. */
5746     if (IS_LOCK_WAITLOCK(oldFileLock) &&
5747         (!SERVERLOCKS_ENABLED(scp) ||
5748          scp->serverLock == oldFileLock->lockType ||
5749          scp->serverLock == LockWrite)) {
5750
5751         oldFileLock->flags &= ~CM_FILELOCK_FLAG_WAITLOCK;
5752
5753         if (SERVERLOCKS_ENABLED(scp)) {
5754             osi_Log1(afsd_logp, "cm_RetryLock Server lock (%d) is sufficient for lock.  Granting",
5755                      (int) scp->serverLock);
5756         } else {
5757             osi_Log0(afsd_logp, "cm_RetryLock skipping server lock for scp");
5758         }
5759
5760         lock_ReleaseWrite(&cm_scacheLock);
5761         lock_ReleaseWrite(&scp->rw);
5762
5763         return 0;
5764     }
5765
5766     if (IS_LOCK_WAITUNLOCK(oldFileLock)) {
5767
5768         /* check if the conflicting locks have dissappeared already */
5769         for (q = scp->fileLocksH; q; q = osi_QNext(q)) {
5770
5771             fileLock = (cm_file_lock_t *)
5772                 ((char *) q - offsetof(cm_file_lock_t, fileq));
5773
5774             if (IS_LOCK_LOST(fileLock)) {
5775                 if (cm_KeyEquals(&fileLock->key, &oldFileLock->key, 0)) {
5776                     code = CM_ERROR_BADFD;
5777                     oldFileLock->flags |= CM_FILELOCK_FLAG_LOST;
5778                     osi_Log1(afsd_logp, "    found lost lock %p for same key.  Marking lock as lost",
5779                              fileLock);
5780                     break;
5781                 } else if (fileLock->lockType == LockWrite &&
5782                            INTERSECT_RANGE(oldFileLock->range, fileLock->range)) {
5783                     osi_Log1(afsd_logp, "    found conflicting LOST lock %p", fileLock);
5784                     code = CM_ERROR_WOULDBLOCK;
5785                     break;
5786                 }
5787             }
5788
5789             if (IS_LOCK_ACCEPTED(fileLock) &&
5790                 INTERSECT_RANGE(oldFileLock->range, fileLock->range)) {
5791
5792                 if (oldFileLock->lockType != LockRead ||
5793                    fileLock->lockType != LockRead) {
5794
5795                     osi_Log1(afsd_logp, "    found conflicting lock %p", fileLock);
5796                     code = CM_ERROR_WOULDBLOCK;
5797                     break;
5798                 }
5799             }
5800         }
5801     }
5802
5803     if (code != 0) {
5804         lock_ReleaseWrite(&cm_scacheLock);
5805         lock_ReleaseWrite(&scp->rw);
5806
5807         goto handleCode;
5808     }
5809
5810     /* when we get here, the lock is either a WAITUNLOCK or WAITLOCK.
5811        If it is WAITUNLOCK, then we didn't find any conflicting lock
5812        but we haven't verfied whether the serverLock is sufficient to
5813        assert it.  If it is WAITLOCK, then the serverLock is
5814        insufficient to assert it. Eitherway, we are ready to accept
5815        the lock as either ACTIVE or WAITLOCK depending on the
5816        serverLock. */
5817
5818     /* First, promote the WAITUNLOCK to a WAITLOCK */
5819     if (IS_LOCK_WAITUNLOCK(oldFileLock)) {
5820         if (oldFileLock->lockType == LockRead)
5821             scp->sharedLocks++;
5822         else
5823             scp->exclusiveLocks++;
5824
5825         oldFileLock->flags &= ~CM_FILELOCK_FLAG_WAITUNLOCK;
5826         oldFileLock->flags |= CM_FILELOCK_FLAG_WAITLOCK;
5827     }
5828
5829     osi_assertx(IS_LOCK_WAITLOCK(oldFileLock), "!IS_LOCK_WAITLOCK");
5830
5831     if (force_client_lock ||
5832         !SERVERLOCKS_ENABLED(scp) ||
5833         scp->serverLock == oldFileLock->lockType ||
5834         (oldFileLock->lockType == LockRead &&
5835          scp->serverLock == LockWrite)) {
5836
5837         oldFileLock->flags &= ~CM_FILELOCK_FLAG_WAITLOCK;
5838
5839         if ((force_client_lock ||
5840              !SERVERLOCKS_ENABLED(scp)) &&
5841             !IS_LOCK_CLIENTONLY(oldFileLock)) {
5842
5843             oldFileLock->flags |= CM_FILELOCK_FLAG_CLIENTONLY;
5844
5845             if (oldFileLock->lockType == LockRead)
5846                 scp->sharedLocks--;
5847             else
5848                 scp->exclusiveLocks--;
5849
5850             scp->clientLocks++;
5851         }
5852
5853         lock_ReleaseWrite(&cm_scacheLock);
5854         lock_ReleaseWrite(&scp->rw);
5855
5856         return 0;
5857
5858     } else {
5859         cm_user_t * userp;
5860
5861         code = cm_SyncOp(scp, NULL, oldFileLock->userp, &req, 0,
5862                          CM_SCACHESYNC_NEEDCALLBACK
5863                          | CM_SCACHESYNC_GETSTATUS
5864                          | CM_SCACHESYNC_LOCK);
5865         if (code) {
5866             osi_Log1(afsd_logp, "cm_RetryLock SyncOp failure code 0x%x", code);
5867             lock_ReleaseWrite(&cm_scacheLock);
5868             goto post_syncopdone;
5869         }
5870
5871         if (!IS_LOCK_WAITLOCK(oldFileLock))
5872             goto pre_syncopdone;
5873
5874         userp = oldFileLock->userp;
5875
5876 #ifndef AGGRESSIVE_LOCKS
5877         newLock = oldFileLock->lockType;
5878 #else
5879         newLock = LockWrite;
5880 #endif
5881
5882         if (has_insert) {
5883             /* if has_insert is non-zero, then:
5884                - the lock a LockRead
5885                - we don't have permission to get a LockRead
5886                - we do have permission to get a LockWrite
5887                - the server supports VICED_CAPABILITY_WRITELOCKACL
5888             */
5889
5890             newLock = LockWrite;
5891         }
5892
5893         lock_ReleaseWrite(&cm_scacheLock);
5894
5895         /* when we get here, either we have a read-lock and want a
5896            write-lock or we don't have any locks and we want some
5897            lock. */
5898
5899         if (scp->serverLock == LockRead) {
5900
5901             osi_assertx(newLock == LockWrite, "!LockWrite");
5902
5903             osi_Log0(afsd_logp, "  Attempting to UPGRADE from LockRead to LockWrite");
5904
5905             scp->lockDataVersion = scp->dataVersion;
5906             check_data_version = TRUE;
5907
5908             code = cm_IntReleaseLock(scp, userp, &req);
5909
5910             if (code)
5911                 goto pre_syncopdone;
5912             else
5913                 scp->serverLock = -1;
5914         }
5915
5916         code = cm_IntSetLock(scp, userp, newLock, &req);
5917
5918         if (code == 0) {
5919             if (scp->dataVersion != scp->lockDataVersion) {
5920                 /* we lost a race.  too bad */
5921
5922                 osi_Log0(afsd_logp,
5923                          "  Data version mismatch while upgrading lock.");
5924                 osi_Log2(afsd_logp,
5925                          "  Data versions before=%I64d, after=%I64d",
5926                          scp->lockDataVersion,
5927                          scp->dataVersion);
5928                 osi_Log1(afsd_logp,
5929                          "  Releasing stale lock for scp 0x%x", scp);
5930
5931                 code = cm_IntReleaseLock(scp, userp, &req);
5932
5933                 scp->serverLock = -1;
5934
5935                 code = CM_ERROR_INVAL;
5936
5937                 cm_LockMarkSCacheLost(scp);
5938             } else {
5939                 scp->serverLock = newLock;
5940             }
5941         }
5942
5943     pre_syncopdone:
5944         cm_SyncOpDone(scp, NULL, CM_SCACHESYNC_LOCK);
5945     post_syncopdone:
5946         ;
5947     }
5948
5949   handleCode:
5950     if (code != 0 && code != CM_ERROR_WOULDBLOCK) {
5951         lock_ObtainWrite(&cm_scacheLock);
5952         osi_QRemoveHT(&scp->fileLocksH, &scp->fileLocksT, &oldFileLock->fileq);
5953         lock_ReleaseWrite(&cm_scacheLock);
5954     }
5955     lock_ReleaseWrite(&scp->rw);
5956
5957   updateLock:
5958     lock_ObtainWrite(&cm_scacheLock);
5959     if (code == 0) {
5960         oldFileLock->flags &= ~CM_FILELOCK_FLAG_WAITLOCK;
5961     } else if (code != CM_ERROR_WOULDBLOCK) {
5962         oldFileLock->flags |= CM_FILELOCK_FLAG_DELETED;
5963         cm_ReleaseUser(oldFileLock->userp);
5964         oldFileLock->userp = NULL;
5965         if (oldFileLock->scp) {
5966             cm_ReleaseSCacheNoLock(oldFileLock->scp);
5967             oldFileLock->scp = NULL;
5968         }
5969     }
5970     lock_ReleaseWrite(&cm_scacheLock);
5971
5972     return code;
5973 }
5974
5975 cm_key_t cm_GenerateKey(afs_uint16 session_id, afs_offs_t process_id, afs_uint64 file_id)
5976 {
5977     cm_key_t key;
5978
5979     key.process_id = process_id;
5980     key.session_id = session_id;
5981     key.file_id = file_id;
5982
5983     return key;
5984 }
5985
5986 int cm_KeyEquals(cm_key_t *k1, cm_key_t *k2, int flags)
5987 {
5988     return (k1->session_id == k2->session_id) && (k1->file_id == k2->file_id) &&
5989         ((flags & CM_UNLOCK_FLAG_BY_FID) || (k1->process_id == k2->process_id));
5990 }
5991
5992 void cm_ReleaseAllLocks(void)
5993 {
5994     cm_scache_t *scp;
5995     cm_req_t req;
5996     cm_user_t *userp;
5997     cm_key_t   key;
5998     cm_file_lock_t *fileLock;
5999     unsigned int i;
6000
6001     for (i = 0; i < cm_data.scacheHashTableSize; i++)
6002     {
6003         for ( scp = cm_data.scacheHashTablep[i]; scp; scp = scp->nextp ) {
6004             while (scp->fileLocksH != NULL) {
6005                 lock_ObtainWrite(&scp->rw);
6006                 lock_ObtainWrite(&cm_scacheLock);
6007                 if (!scp->fileLocksH) {
6008                     lock_ReleaseWrite(&cm_scacheLock);
6009                     lock_ReleaseWrite(&scp->rw);
6010                     break;
6011                 }
6012                 fileLock = (cm_file_lock_t *)((char *) scp->fileLocksH - offsetof(cm_file_lock_t, fileq));
6013                 userp = fileLock->userp;
6014                 cm_HoldUser(userp);
6015                 key = fileLock->key;
6016                 cm_HoldSCacheNoLock(scp);
6017                 lock_ReleaseWrite(&cm_scacheLock);
6018                 cm_UnlockByKey(scp, key, 0, userp, &req);
6019                 cm_ReleaseSCache(scp);
6020                 cm_ReleaseUser(userp);
6021                 lock_ReleaseWrite(&scp->rw);
6022             }
6023         }
6024     }
6025 }