2 * Copyright 2000, International Business Machines Corporation and others.
5 * This software has been released under the terms of the IBM Public
6 * License. For details, see the LICENSE file in the top-level source
7 * directory or online at http://www.openafs.org/dl/license10.html
10 #include <afs/param.h>
27 /* Used by cm_FollowMountPoint */
33 extern void afsi_log(char *pattern, ...);
36 int cm_enableServerLocks = 1;
39 * Case-folding array. This was constructed by inspecting of SMBtrace output.
40 * I do not know anything more about it.
42 unsigned char cm_foldUpper[256] = {
43 0x0, 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7,
44 0x8, 0x9, 0xa, 0xb, 0xc, 0xd, 0xe, 0xf,
45 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17,
46 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f,
47 0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27,
48 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d, 0x2e, 0x2f,
49 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37,
50 0x38, 0x39, 0x3a, 0x3b, 0x3c, 0x3d, 0x3e, 0x3f,
51 0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47,
52 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f,
53 0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57,
54 0x58, 0x59, 0x5a, 0x5b, 0x5c, 0x5d, 0x5e, 0x5f,
55 0x60, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47,
56 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f,
57 0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57,
58 0x58, 0x59, 0x5a, 0x7b, 0x7c, 0x7d, 0x7e, 0x7f,
59 0x80, 0x9a, 0x90, 0x41, 0x8e, 0x41, 0x8f, 0x80,
60 0x45, 0x45, 0x45, 0x49, 0x49, 0x49, 0x8e, 0x8f,
61 0x90, 0x92, 0x92, 0x4f, 0x99, 0x4f, 0x55, 0x55,
62 0x59, 0x99, 0x9a, 0x9b, 0x9c, 0x9d, 0x9e, 0x9f,
63 0x41, 0x49, 0x4f, 0x55, 0xa5, 0xa5, 0x56, 0xa7,
64 0xa8, 0xa9, 0xaa, 0xab, 0xac, 0xad, 0xae, 0xaf,
65 0xb0, 0xb1, 0xb2, 0xb3, 0xb4, 0xb5, 0xb6, 0xb7,
66 0xb8, 0xb9, 0xba, 0xbb, 0xbc, 0xbd, 0xbe, 0xbf,
67 0xc0, 0xc1, 0xc2, 0xc3, 0xc4, 0xc5, 0xc6, 0xc7,
68 0xc8, 0xc9, 0xca, 0xcb, 0xcc, 0xcd, 0xce, 0xcf,
69 0xd0, 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7,
70 0xd8, 0xd9, 0xda, 0xdb, 0xdc, 0xdd, 0xde, 0xdf,
71 0xe0, 0xe1, 0xe2, 0xe3, 0xe4, 0xe5, 0xe6, 0xe7,
72 0xe8, 0xe9, 0xea, 0xeb, 0xec, 0xed, 0xee, 0xef,
73 0xf0, 0xf1, 0xf2, 0xf3, 0xf4, 0xf5, 0xf6, 0xf7,
74 0xf8, 0xf9, 0xfa, 0xfb, 0xfc, 0xfd, 0xfe, 0xff
78 * Case-insensitive string comparison. We used to use stricmp, but it doesn't
79 * know about 8-bit characters (e.g. 129 is lowercase u-umlaut, 154 is
80 * upper-case u-umlaut).
82 int cm_stricmp(const char *str1, const char *str2)
94 c1 = (char) cm_foldUpper[(unsigned char)(*str1++)];
95 c2 = (char) cm_foldUpper[(unsigned char)(*str2++)];
103 /* characters that are legal in an 8.3 name */
105 * We used to have 1's for all characters from 128 to 254. But
106 * the NT client behaves better if we create an 8.3 name for any
107 * name that has a character with the high bit on, and if we
108 * delete those characters from 8.3 names. In particular, see
109 * Sybase defect 10859.
111 char cm_LegalChars[256] = {
112 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
113 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
114 0, 1, 0, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 1, 0, 0,
115 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0,
116 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
117 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 1, 1,
118 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
119 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1, 1,
120 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
121 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
122 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
123 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
124 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
125 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
126 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
127 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
130 /* return true iff component is a valid 8.3 name */
131 int cm_Is8Dot3(char *namep)
138 * can't have a leading dot;
139 * special case for . and ..
141 if (namep[0] == '.') {
144 if (namep[1] == '.' && namep[2] == 0)
148 while (tc = *namep++) {
150 /* saw another dot */
151 if (sawDot) return 0; /* second dot */
156 if (cm_LegalChars[tc] == 0)
159 if (!sawDot && charCount > 8)
160 /* more than 8 chars in name */
162 if (sawDot && charCount > 3)
163 /* more than 3 chars in extension */
170 * Number unparsing map for generating 8.3 names;
171 * The version taken from DFS was on drugs.
172 * You can't include '&' and '@' in a file name.
174 char cm_8Dot3Mapping[42] =
175 {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
176 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'J', 'K',
177 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U',
178 'V', 'W', 'X', 'Y', 'Z', '_', '-', '$', '#', '!', '+', '='
180 int cm_8Dot3MapSize = sizeof(cm_8Dot3Mapping);
182 void cm_Gen8Dot3Name(cm_dirEntry_t *dep, char *shortName, char **shortNameEndp)
186 int vnode = ntohl(dep->fid.vnode);
188 int validExtension = 0;
189 char tc, *temp, *name;
191 /* Unparse the file's vnode number to get a "uniquifier" */
193 number[nsize] = cm_8Dot3Mapping[vnode % cm_8Dot3MapSize];
195 vnode /= cm_8Dot3MapSize;
199 * Look for valid extension. There has to be a dot, and
200 * at least one of the characters following has to be legal.
202 lastDot = strrchr(dep->name, '.');
204 temp = lastDot; temp++;
206 if (cm_LegalChars[tc])
212 /* Copy name characters */
214 for (i = 0, name = dep->name;
215 i < (7 - nsize) && name != lastDot; ) {
220 if (!cm_LegalChars[tc])
223 *shortName++ = toupper(tc);
229 /* Copy uniquifier characters */
230 memcpy(shortName, number, nsize);
233 if (validExtension) {
234 /* Copy extension characters */
235 *shortName++ = *lastDot++; /* copy dot */
236 for (i = 0, tc = *lastDot++;
239 if (cm_LegalChars[tc]) {
241 *shortName++ = toupper(tc);
250 *shortNameEndp = shortName;
253 /* return success if we can open this file in this mode */
254 long cm_CheckOpen(cm_scache_t *scp, int openMode, int trunc, cm_user_t *userp,
261 if (openMode != 1) rights |= PRSFS_READ;
262 if (openMode == 1 || openMode == 2 || trunc) rights |= PRSFS_WRITE;
264 lock_ObtainMutex(&scp->mx);
266 code = cm_SyncOp(scp, NULL, userp, reqp, rights,
267 CM_SCACHESYNC_GETSTATUS
268 | CM_SCACHESYNC_NEEDCALLBACK
269 | CM_SCACHESYNC_LOCK);
272 ((rights & PRSFS_WRITE) || (rights & PRSFS_READ)) &&
273 scp->fileType == CM_SCACHETYPE_FILE) {
276 unsigned int sLockType;
277 LARGE_INTEGER LOffset, LLength;
279 /* Check if there's some sort of lock on the file at the
282 key = cm_GenerateKey(CM_SESSION_CMINT,0,0);
284 if (rights & PRSFS_WRITE)
287 sLockType = LOCKING_ANDX_SHARED_LOCK;
289 LOffset.HighPart = CM_FLSHARE_OFFSET_HIGH;
290 LOffset.LowPart = CM_FLSHARE_OFFSET_LOW;
291 LLength.HighPart = CM_FLSHARE_LENGTH_HIGH;
292 LLength.LowPart = CM_FLSHARE_LENGTH_LOW;
294 code = cm_Lock(scp, sLockType, LOffset, LLength, key, 0, userp, reqp, NULL);
297 cm_Unlock(scp, sLockType, LOffset, LLength, key, userp, reqp);
299 /* In this case, we allow the file open to go through even
300 though we can't enforce mandatory locking on the
302 if (code == CM_ERROR_NOACCESS &&
303 !(rights & PRSFS_WRITE))
307 case CM_ERROR_ALLOFFLINE:
308 case CM_ERROR_ALLDOWN:
309 case CM_ERROR_ALLBUSY:
310 case CM_ERROR_TIMEDOUT:
312 case CM_ERROR_WOULDBLOCK:
315 code = CM_ERROR_SHARING_VIOLATION;
320 } else if (code != 0) {
324 cm_SyncOpDone(scp, NULL, CM_SCACHESYNC_LOCK);
328 lock_ReleaseMutex(&scp->mx);
333 /* return success if we can open this file in this mode */
334 long cm_CheckNTOpen(cm_scache_t *scp, unsigned int desiredAccess,
335 unsigned int createDisp, cm_user_t *userp, cm_req_t *reqp)
340 /* Always allow delete; the RPC will tell us if it's OK */
341 if (desiredAccess == DELETE)
346 if (desiredAccess & AFS_ACCESS_READ)
347 rights |= PRSFS_READ;
349 if ((desiredAccess & AFS_ACCESS_WRITE)
351 rights |= PRSFS_WRITE;
353 lock_ObtainMutex(&scp->mx);
355 code = cm_SyncOp(scp, NULL, userp, reqp, rights,
356 CM_SCACHESYNC_GETSTATUS
357 | CM_SCACHESYNC_NEEDCALLBACK
358 | CM_SCACHESYNC_LOCK);
361 * If the open will fail because the volume is readonly, then we will
362 * return an access denied error instead. This is to help brain-dead
363 * apps run correctly on replicated volumes.
364 * See defect 10007 for more information.
366 if (code == CM_ERROR_READONLY)
367 code = CM_ERROR_NOACCESS;
370 ((rights & PRSFS_WRITE) || (rights & PRSFS_READ)) &&
371 scp->fileType == CM_SCACHETYPE_FILE) {
373 unsigned int sLockType;
374 LARGE_INTEGER LOffset, LLength;
376 /* Check if there's some sort of lock on the file at the
379 key = cm_GenerateKey(CM_SESSION_CMINT,0,0);
380 if (rights & PRSFS_WRITE)
383 sLockType = LOCKING_ANDX_SHARED_LOCK;
385 /* single byte lock at offset 0x0100 0000 0000 0000 */
386 LOffset.HighPart = CM_FLSHARE_OFFSET_HIGH;
387 LOffset.LowPart = CM_FLSHARE_OFFSET_LOW;
388 LLength.HighPart = CM_FLSHARE_LENGTH_HIGH;
389 LLength.LowPart = CM_FLSHARE_LENGTH_LOW;
391 code = cm_Lock(scp, sLockType, LOffset, LLength, key, 0, userp, reqp, NULL);
394 cm_Unlock(scp, sLockType, LOffset, LLength, key, userp, reqp);
396 /* In this case, we allow the file open to go through even
397 though we can't enforce mandatory locking on the
399 if (code == CM_ERROR_NOACCESS &&
400 !(rights & PRSFS_WRITE))
404 case CM_ERROR_ALLOFFLINE:
405 case CM_ERROR_ALLDOWN:
406 case CM_ERROR_ALLBUSY:
407 case CM_ERROR_TIMEDOUT:
409 case CM_ERROR_WOULDBLOCK:
412 code = CM_ERROR_SHARING_VIOLATION;
416 } else if (code != 0) {
420 cm_SyncOpDone(scp, NULL, CM_SCACHESYNC_LOCK);
423 lock_ReleaseMutex(&scp->mx);
429 * When CAP_NT_SMBS has been negotiated, deletion (of files or directories) is
430 * done in three steps:
431 * (1) open for deletion (NT_CREATE_AND_X)
432 * (2) set for deletion on close (NT_TRANSACTION2, SET_FILE_INFO)
434 * We must not do the RPC until step 3. But if we are going to return an error
435 * code (e.g. directory not empty), we must return it by step 2, otherwise most
436 * clients will not notice it. So we do a preliminary check. For deleting
437 * files, this is almost free, since we have already done the RPC to get the
438 * parent directory's status bits. But for deleting directories, we must do an
439 * additional RPC to get the directory's data to check if it is empty. Sigh.
441 long cm_CheckNTDelete(cm_scache_t *dscp, cm_scache_t *scp, cm_user_t *userp,
448 unsigned short *hashTable;
450 int BeyondPage = 0, HaveDot = 0, HaveDotDot = 0;
452 /* First check permissions */
453 lock_ObtainMutex(&dscp->mx);
454 code = cm_SyncOp(dscp, NULL, userp, reqp, PRSFS_DELETE,
455 CM_SCACHESYNC_GETSTATUS
456 | CM_SCACHESYNC_NEEDCALLBACK);
457 lock_ReleaseMutex(&dscp->mx);
461 /* If deleting directory, must be empty */
463 if (scp->fileType != CM_SCACHETYPE_DIRECTORY)
466 thyper.HighPart = 0; thyper.LowPart = 0;
467 lock_ObtainRead(&scp->bufCreateLock);
468 code = buf_Get(scp, &thyper, &bufferp);
469 lock_ReleaseRead(&scp->bufCreateLock);
473 lock_ObtainMutex(&bufferp->mx);
474 lock_ObtainMutex(&scp->mx);
476 code = cm_SyncOp(scp, bufferp, userp, reqp, 0,
477 CM_SCACHESYNC_NEEDCALLBACK
479 | CM_SCACHESYNC_BUFLOCKED);
483 if (cm_HaveBuffer(scp, bufferp, 1))
486 /* otherwise, load the buffer and try again */
487 lock_ReleaseMutex(&bufferp->mx);
488 code = cm_GetBuffer(scp, bufferp, NULL, userp, reqp);
489 lock_ReleaseMutex(&scp->mx);
490 lock_ObtainMutex(&bufferp->mx);
491 lock_ObtainMutex(&scp->mx);
496 /* We try to determine emptiness without looking beyond the first page,
497 * and without assuming "." and ".." are present and are on the first
498 * page (though these assumptions might, after all, be reasonable).
500 hashTable = (unsigned short *)(bufferp->datap + (32 * 5));
501 for (i=0; i<128; i++) {
502 idx = ntohs(hashTable[i]);
508 dep = (cm_dirEntry_t *)(bufferp->datap + (32 * idx));
509 if (strcmp(dep->name, ".") == 0)
511 else if (strcmp(dep->name, "..") == 0)
514 code = CM_ERROR_NOTEMPTY;
517 idx = ntohs(dep->next);
520 if (BeyondPage && HaveDot && HaveDotDot)
521 code = CM_ERROR_NOTEMPTY;
525 lock_ReleaseMutex(&bufferp->mx);
526 buf_Release(bufferp);
527 lock_ReleaseMutex(&scp->mx);
532 * Iterate through all entries in a directory.
533 * When the function funcp is called, the buffer is locked but the
534 * directory vnode is not.
536 * If the retscp parameter is not NULL, the parmp must be a
537 * cm_lookupSearch_t object.
539 long cm_ApplyDir(cm_scache_t *scp, cm_DirFuncp_t funcp, void *parmp,
540 osi_hyper_t *startOffsetp, cm_user_t *userp, cm_req_t *reqp,
541 cm_scache_t **retscp)
548 osi_hyper_t dirLength;
549 osi_hyper_t bufferOffset;
550 osi_hyper_t curOffset;
554 cm_pageHeader_t *pageHeaderp;
556 long nextEntryCookie;
557 int numDirChunks; /* # of 32 byte dir chunks in this entry */
559 /* get the directory size */
560 lock_ObtainMutex(&scp->mx);
561 code = cm_SyncOp(scp, NULL, userp, reqp, PRSFS_LOOKUP,
562 CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS);
564 lock_ReleaseMutex(&scp->mx);
568 if (scp->fileType != CM_SCACHETYPE_DIRECTORY) {
569 lock_ReleaseMutex(&scp->mx);
570 return CM_ERROR_NOTDIR;
573 if (retscp) /* if this is a lookup call */
575 cm_lookupSearch_t* sp = parmp;
577 #ifdef AFS_FREELANCE_CLIENT
578 /* Freelance entries never end up in the DNLC because they
579 * do not have an associated cm_server_t
581 if ( !(cm_freelanceEnabled &&
582 sp->fid.cell==AFS_FAKE_ROOT_CELL_ID &&
583 sp->fid.volume==AFS_FAKE_ROOT_VOL_ID ) )
584 #endif /* AFS_FREELANCE_CLIENT */
586 int casefold = sp->caseFold;
587 sp->caseFold = 0; /* we have a strong preference for exact matches */
588 if ( *retscp = cm_dnlcLookup(scp, sp)) /* dnlc hit */
590 sp->caseFold = casefold;
591 lock_ReleaseMutex(&scp->mx);
594 sp->caseFold = casefold;
599 * XXX We only get the length once. It might change when we drop the
602 dirLength = scp->length;
604 lock_ReleaseMutex(&scp->mx);
607 bufferOffset.LowPart = bufferOffset.HighPart = 0;
609 curOffset = *startOffsetp;
611 curOffset.HighPart = 0;
612 curOffset.LowPart = 0;
616 /* make sure that curOffset.LowPart doesn't point to the first
617 * 32 bytes in the 2nd through last dir page, and that it
618 * doesn't point at the first 13 32-byte chunks in the first
619 * dir page, since those are dir and page headers, and don't
620 * contain useful information.
622 temp = curOffset.LowPart & (2048-1);
623 if (curOffset.HighPart == 0 && curOffset.LowPart < 2048) {
624 /* we're in the first page */
625 if (temp < 13*32) temp = 13*32;
628 /* we're in a later dir page */
629 if (temp < 32) temp = 32;
632 /* make sure the low order 5 bits are zero */
635 /* now put temp bits back ito curOffset.LowPart */
636 curOffset.LowPart &= ~(2048-1);
637 curOffset.LowPart |= temp;
639 /* check if we've passed the dir's EOF */
640 if (LargeIntegerGreaterThanOrEqualTo(curOffset, dirLength))
643 /* see if we can use the bufferp we have now; compute in which
644 * page the current offset would be, and check whether that's
645 * the offset of the buffer we have. If not, get the buffer.
647 thyper.HighPart = curOffset.HighPart;
648 thyper.LowPart = curOffset.LowPart & ~(cm_data.buf_blockSize-1);
649 if (!bufferp || !LargeIntegerEqualTo(thyper, bufferOffset)) {
652 lock_ReleaseMutex(&bufferp->mx);
653 buf_Release(bufferp);
657 lock_ObtainRead(&scp->bufCreateLock);
658 code = buf_Get(scp, &thyper, &bufferp);
659 lock_ReleaseRead(&scp->bufCreateLock);
661 /* if buf_Get() fails we do not have a buffer object to lock */
667 /* for the IFS version, we bulkstat the dirents because this
668 routine is used in place of smb_ReceiveCoreSearchDir. our
669 other option is to modify smb_ReceiveCoreSearchDir itself,
670 but this seems to be the proper use for cm_ApplyDir. */
671 lock_ObtainMutex(&scp->mx);
672 if ((scp->flags & CM_SCACHEFLAG_BULKSTATTING) == 0
673 && (scp->bulkStatProgress.QuadPart <= thyper.QuadPart))
675 scp->flags |= CM_SCACHEFLAG_BULKSTATTING;
676 code = cm_TryBulkStat(scp, &thyper, userp, reqp);
677 scp->flags &= ~CM_SCACHEFLAG_BULKSTATTING;
678 scp->bulkStatProgress = thyper;
680 lock_ReleaseMutex(&scp->mx);
683 lock_ObtainMutex(&bufferp->mx);
684 bufferOffset = thyper;
686 /* now get the data in the cache */
688 lock_ObtainMutex(&scp->mx);
689 code = cm_SyncOp(scp, bufferp, userp, reqp,
691 CM_SCACHESYNC_NEEDCALLBACK
693 | CM_SCACHESYNC_BUFLOCKED);
695 lock_ReleaseMutex(&scp->mx);
699 if (cm_HaveBuffer(scp, bufferp, 1)) {
700 lock_ReleaseMutex(&scp->mx);
704 /* otherwise, load the buffer and try again */
705 lock_ReleaseMutex(&bufferp->mx);
706 code = cm_GetBuffer(scp, bufferp, NULL, userp,
708 lock_ReleaseMutex(&scp->mx);
709 lock_ObtainMutex(&bufferp->mx);
714 lock_ReleaseMutex(&bufferp->mx);
715 buf_Release(bufferp);
719 } /* if (wrong buffer) ... */
721 /* now we have the buffer containing the entry we're interested
722 * in; copy it out if it represents a non-deleted entry.
724 entryInDir = curOffset.LowPart & (2048-1);
725 entryInBuffer = curOffset.LowPart & (cm_data.buf_blockSize - 1);
727 /* page header will help tell us which entries are free. Page
728 * header can change more often than once per buffer, since
729 * AFS 3 dir page size may be less than (but not more than) a
730 * buffer package buffer.
732 /* only look intra-buffer */
733 temp = curOffset.LowPart & (cm_data.buf_blockSize - 1);
734 temp &= ~(2048 - 1); /* turn off intra-page bits */
735 pageHeaderp = (cm_pageHeader_t *) (bufferp->datap + temp);
737 /* now determine which entry we're looking at in the page. If
738 * it is free (there's a free bitmap at the start of the dir),
739 * we should skip these 32 bytes.
741 slotInPage = (entryInDir & 0x7e0) >> 5;
742 if (!(pageHeaderp->freeBitmap[slotInPage>>3]
743 & (1 << (slotInPage & 0x7)))) {
744 /* this entry is free */
745 numDirChunks = 1; /* only skip this guy */
749 tp = bufferp->datap + entryInBuffer;
750 dep = (cm_dirEntry_t *) tp; /* now points to AFS3 dir entry */
752 /* while we're here, compute the next entry's location, too,
753 * since we'll need it when writing out the cookie into the
754 * dir listing stream.
756 numDirChunks = cm_NameEntries(dep->name, NULL);
758 /* compute the offset of the cookie representing the next entry */
759 nextEntryCookie = curOffset.LowPart
760 + (CM_DIR_CHUNKSIZE * numDirChunks);
762 if (dep->fid.vnode != 0) {
763 /* this is one of the entries to use: it is not deleted */
764 code = (*funcp)(scp, dep, parmp, &curOffset);
767 } /* if we're including this name */
770 /* and adjust curOffset to be where the new cookie is */
772 thyper.LowPart = CM_DIR_CHUNKSIZE * numDirChunks;
773 curOffset = LargeIntegerAdd(thyper, curOffset);
774 } /* while copying data for dir listing */
776 /* release the mutex */
778 lock_ReleaseMutex(&bufferp->mx);
779 buf_Release(bufferp);
784 int cm_NoneUpper(char *s)
788 if (c >= 'A' && c <= 'Z')
793 int cm_NoneLower(char *s)
797 if (c >= 'a' && c <= 'z')
802 long cm_LookupSearchProc(cm_scache_t *scp, cm_dirEntry_t *dep, void *rockp,
805 cm_lookupSearch_t *sp;
810 sp = (cm_lookupSearch_t *) rockp;
812 matchName = dep->name;
814 match = cm_stricmp(matchName, sp->searchNamep);
816 match = strcmp(matchName, sp->searchNamep);
820 && !cm_Is8Dot3(dep->name)) {
821 matchName = shortName;
822 cm_Gen8Dot3Name(dep, shortName, NULL);
824 match = cm_stricmp(matchName, sp->searchNamep);
826 match = strcmp(matchName, sp->searchNamep);
836 if (!sp->caseFold || matchName == shortName) {
837 sp->fid.vnode = ntohl(dep->fid.vnode);
838 sp->fid.unique = ntohl(dep->fid.unique);
839 return CM_ERROR_STOPNOW;
843 * If we get here, we are doing a case-insensitive search, and we
844 * have found a match. Now we determine what kind of match it is:
845 * exact, lower-case, upper-case, or none of the above. This is done
846 * in order to choose among matches, if there are more than one.
849 /* Exact matches are the best. */
850 match = strcmp(matchName, sp->searchNamep);
853 sp->fid.vnode = ntohl(dep->fid.vnode);
854 sp->fid.unique = ntohl(dep->fid.unique);
855 return CM_ERROR_STOPNOW;
858 /* Lower-case matches are next. */
861 if (cm_NoneUpper(matchName)) {
866 /* Upper-case matches are next. */
869 if (cm_NoneLower(matchName)) {
874 /* General matches are last. */
880 sp->fid.vnode = ntohl(dep->fid.vnode);
881 sp->fid.unique = ntohl(dep->fid.unique);
885 /* read the contents of a mount point into the appropriate string.
886 * called with locked scp, and returns with locked scp.
888 long cm_ReadMountPoint(cm_scache_t *scp, cm_user_t *userp, cm_req_t *reqp)
895 if (scp->mountPointStringp[0])
898 /* otherwise, we have to read it in */
899 lock_ReleaseMutex(&scp->mx);
901 lock_ObtainRead(&scp->bufCreateLock);
902 thyper.LowPart = thyper.HighPart = 0;
903 code = buf_Get(scp, &thyper, &bufp);
904 lock_ReleaseRead(&scp->bufCreateLock);
906 lock_ObtainMutex(&scp->mx);
911 code = cm_SyncOp(scp, bufp, userp, reqp, 0,
912 CM_SCACHESYNC_READ | CM_SCACHESYNC_NEEDCALLBACK);
917 if (cm_HaveBuffer(scp, bufp, 0))
920 /* otherwise load buffer */
921 code = cm_GetBuffer(scp, bufp, NULL, userp, reqp);
926 /* locked, has callback, has valid data in buffer */
927 if ((tlen = scp->length.LowPart) > 1000)
928 return CM_ERROR_TOOBIG;
930 code = CM_ERROR_INVAL;
934 /* someone else did the work while we were out */
935 if (scp->mountPointStringp[0]) {
940 /* otherwise, copy out the link */
941 memcpy(scp->mountPointStringp, bufp->datap, tlen);
943 /* now make it null-terminated. Note that the original contents of a
944 * link that is a mount point is "#volname." where "." is there just to
945 * be turned into a null. That is, we can trash the last char of the
946 * link without damaging the vol name. This is a stupid convention,
947 * but that's the protocol.
949 scp->mountPointStringp[tlen-1] = 0;
958 /* called with a locked scp and chases the mount point, yielding outScpp.
959 * scp remains locked, just for simplicity of describing the interface.
961 long cm_FollowMountPoint(cm_scache_t *scp, cm_scache_t *dscp, cm_user_t *userp,
962 cm_req_t *reqp, cm_scache_t **outScpp)
977 if (scp->mountRootFid.cell != 0 && scp->mountRootGen >= cm_data.mountRootGen) {
978 tfid = scp->mountRootFid;
979 lock_ReleaseMutex(&scp->mx);
980 code = cm_GetSCache(&tfid, outScpp, userp, reqp);
981 lock_ObtainMutex(&scp->mx);
985 /* parse the volume name */
986 mpNamep = scp->mountPointStringp;
988 return CM_ERROR_NOSUCHPATH;
989 tlen = (int)strlen(scp->mountPointStringp);
990 mtType = *scp->mountPointStringp;
991 cellNamep = malloc(tlen);
992 volNamep = malloc(tlen);
994 cp = strrchr(mpNamep, ':');
996 /* cellular mount point */
997 memset(cellNamep, 0, tlen);
998 strncpy(cellNamep, mpNamep+1, cp - mpNamep - 1);
999 strcpy(volNamep, cp+1);
1000 /* now look up the cell */
1001 cellp = cm_GetCell(cellNamep, CM_FLAG_CREATE);
1005 strcpy(volNamep, mpNamep+1);
1007 cellp = cm_FindCellByID(scp->fid.cell);
1011 code = CM_ERROR_NOSUCHCELL;
1015 vnLength = strlen(volNamep);
1016 if (vnLength >= 8 && strcmp(volNamep + vnLength - 7, ".backup") == 0)
1018 else if (vnLength >= 10
1019 && strcmp(volNamep + vnLength - 9, ".readonly") == 0)
1024 /* check for backups within backups */
1026 && (scp->flags & (CM_SCACHEFLAG_RO | CM_SCACHEFLAG_PURERO))
1027 == CM_SCACHEFLAG_RO) {
1028 code = CM_ERROR_NOSUCHVOLUME;
1032 /* now we need to get the volume */
1033 lock_ReleaseMutex(&scp->mx);
1034 code = cm_GetVolumeByName(cellp, volNamep, userp, reqp, 0, &volp);
1035 lock_ObtainMutex(&scp->mx);
1038 /* save the parent of the volume root for this is the
1039 * place where the volume is mounted and we must remember
1040 * this in the volume structure rather than just in the
1041 * scache entry lest the scache entry gets recycled
1044 lock_ObtainMutex(&volp->mx);
1045 volp->dotdotFid = dscp->fid;
1046 lock_ReleaseMutex(&volp->mx);
1048 scp->mountRootFid.cell = cellp->cellID;
1049 /* if the mt pt is in a read-only volume (not just a
1050 * backup), and if there is a read-only volume for the
1051 * target, and if this is a type '#' mount point, use
1052 * the read-only, otherwise use the one specified.
1054 if (mtType == '#' && (scp->flags & CM_SCACHEFLAG_PURERO)
1055 && volp->roID != 0 && type == RWVOL)
1058 scp->mountRootFid.volume = volp->roID;
1059 else if (type == BACKVOL)
1060 scp->mountRootFid.volume = volp->bkID;
1062 scp->mountRootFid.volume = volp->rwID;
1064 /* the rest of the fid is a magic number */
1065 scp->mountRootFid.vnode = 1;
1066 scp->mountRootFid.unique = 1;
1067 scp->mountRootGen = cm_data.mountRootGen;
1069 tfid = scp->mountRootFid;
1070 lock_ReleaseMutex(&scp->mx);
1071 code = cm_GetSCache(&tfid, outScpp, userp, reqp);
1072 lock_ObtainMutex(&scp->mx);
1081 long cm_LookupInternal(cm_scache_t *dscp, char *namep, long flags, cm_user_t *userp,
1082 cm_req_t *reqp, cm_scache_t **outpScpp)
1085 int dnlcHit = 1; /* did we hit in the dnlc? yes, we did */
1086 cm_scache_t *tscp = NULL;
1087 cm_scache_t *mountedScp;
1088 cm_lookupSearch_t rock;
1091 if (dscp->fid.vnode == 1 && dscp->fid.unique == 1
1092 && strcmp(namep, "..") == 0) {
1093 if (dscp->dotdotFid.volume == 0)
1094 return CM_ERROR_NOSUCHVOLUME;
1095 rock.fid = dscp->dotdotFid;
1099 memset(&rock, 0, sizeof(rock));
1100 rock.fid.cell = dscp->fid.cell;
1101 rock.fid.volume = dscp->fid.volume;
1102 rock.searchNamep = namep;
1103 rock.caseFold = (flags & CM_FLAG_CASEFOLD);
1104 rock.hasTilde = ((strchr(namep, '~') != NULL) ? 1 : 0);
1106 /* If NOMOUNTCHASE, bypass DNLC by passing NULL scp pointer */
1107 code = cm_ApplyDir(dscp, cm_LookupSearchProc, &rock, NULL, userp, reqp,
1108 (flags & CM_FLAG_NOMOUNTCHASE) ? NULL : &tscp);
1110 /* code == 0 means we fell off the end of the dir, while stopnow means
1111 * that we stopped early, probably because we found the entry we're
1112 * looking for. Any other non-zero code is an error.
1114 if (code && code != CM_ERROR_STOPNOW) {
1115 /* if the cm_scache_t we are searching in is not a directory
1116 * we must return path not found because the error
1117 * is to describe the final component not an intermediary
1119 if (code == CM_ERROR_NOTDIR) {
1120 if (flags & CM_FLAG_CHECKPATH)
1121 return CM_ERROR_NOSUCHPATH;
1123 return CM_ERROR_NOSUCHFILE;
1128 getroot = (dscp==cm_data.rootSCachep) ;
1130 if (!cm_freelanceEnabled || !getroot) {
1131 if (flags & CM_FLAG_CHECKPATH)
1132 return CM_ERROR_NOSUCHPATH;
1134 return CM_ERROR_NOSUCHFILE;
1136 else { /* nonexistent dir on freelance root, so add it */
1137 char fullname[200] = ".";
1140 osi_Log1(afsd_logp,"cm_Lookup adding mount for non-existent directory: %s",
1141 osi_LogSaveString(afsd_logp,namep));
1142 if (namep[0] == '.') {
1143 if (cm_GetCell_Gen(&namep[1], &fullname[1], CM_FLAG_CREATE)) {
1145 if ( stricmp(&namep[1], &fullname[1]) )
1146 code = cm_FreelanceAddSymlink(namep, fullname, &rock.fid);
1148 code = cm_FreelanceAddMount(namep, &fullname[1], "root.cell.", 1, &rock.fid);
1151 if (cm_GetCell_Gen(namep, fullname, CM_FLAG_CREATE)) {
1153 if ( stricmp(namep, fullname) )
1154 code = cm_FreelanceAddSymlink(namep, fullname, &rock.fid);
1156 code = cm_FreelanceAddMount(namep, fullname, "root.cell.", 0, &rock.fid);
1159 if (!found || code < 0) { /* add mount point failed, so give up */
1160 if (flags & CM_FLAG_CHECKPATH)
1161 return CM_ERROR_NOSUCHPATH;
1163 return CM_ERROR_NOSUCHFILE;
1165 tscp = NULL; /* to force call of cm_GetSCache */
1170 if ( !tscp ) /* we did not find it in the dnlc */
1173 code = cm_GetSCache(&rock.fid, &tscp, userp, reqp);
1177 /* tscp is now held */
1179 lock_ObtainMutex(&tscp->mx);
1180 code = cm_SyncOp(tscp, NULL, userp, reqp, 0,
1181 CM_SCACHESYNC_GETSTATUS | CM_SCACHESYNC_NEEDCALLBACK);
1183 lock_ReleaseMutex(&tscp->mx);
1184 cm_ReleaseSCache(tscp);
1187 /* tscp is now locked */
1189 if (!(flags & CM_FLAG_NOMOUNTCHASE)
1190 && tscp->fileType == CM_SCACHETYPE_MOUNTPOINT) {
1191 /* mount points are funny: they have a volume name to mount
1194 code = cm_ReadMountPoint(tscp, userp, reqp);
1196 code = cm_FollowMountPoint(tscp, dscp, userp, reqp,
1198 lock_ReleaseMutex(&tscp->mx);
1199 cm_ReleaseSCache(tscp);
1206 lock_ReleaseMutex(&tscp->mx);
1209 /* copy back pointer */
1212 /* insert scache in dnlc */
1213 if ( !dnlcHit && !(flags & CM_FLAG_NOMOUNTCHASE) && rock.ExactFound ) {
1214 /* lock the directory entry to prevent racing callback revokes */
1215 lock_ObtainMutex(&dscp->mx);
1216 if ( dscp->cbServerp != NULL && dscp->cbExpires > 0 )
1217 cm_dnlcEnter(dscp, namep, tscp);
1218 lock_ReleaseMutex(&dscp->mx);
1225 int cm_ExpandSysName(char *inp, char *outp, long outSize, unsigned int index)
1230 tp = strrchr(inp, '@');
1232 return 0; /* no @sys */
1234 if (strcmp(tp, "@sys") != 0)
1235 return 0; /* no @sys */
1237 /* caller just wants to know if this is a valid @sys type of name */
1241 if (index >= MAXNUMSYSNAMES)
1244 /* otherwise generate the properly expanded @sys name */
1245 prefixCount = (int)(tp - inp);
1247 strncpy(outp, inp, prefixCount); /* copy out "a." from "a.@sys" */
1248 outp[prefixCount] = 0; /* null terminate the "a." */
1249 strcat(outp, cm_sysNameList[index]);/* append i386_nt40 */
1253 long cm_Lookup(cm_scache_t *dscp, char *namep, long flags, cm_user_t *userp,
1254 cm_req_t *reqp, cm_scache_t **outpScpp)
1258 int sysNameIndex = 0;
1259 cm_scache_t *scp = 0;
1261 if ( stricmp(namep,SMB_IOCTL_FILENAME_NOSLASH) == 0 ) {
1262 if (flags & CM_FLAG_CHECKPATH)
1263 return CM_ERROR_NOSUCHPATH;
1265 return CM_ERROR_NOSUCHFILE;
1268 for ( sysNameIndex = 0; sysNameIndex < MAXNUMSYSNAMES; sysNameIndex++) {
1269 code = cm_ExpandSysName(namep, tname, sizeof(tname), sysNameIndex);
1271 code = cm_LookupInternal(dscp, tname, flags, userp, reqp, &scp);
1277 cm_ReleaseSCache(scp);
1281 return cm_LookupInternal(dscp, namep, flags, userp, reqp, outpScpp);
1285 /* None of the possible sysName expansions could be found */
1286 if (flags & CM_FLAG_CHECKPATH)
1287 return CM_ERROR_NOSUCHPATH;
1289 return CM_ERROR_NOSUCHFILE;
1292 long cm_Unlink(cm_scache_t *dscp, char *namep, cm_user_t *userp, cm_req_t *reqp)
1298 AFSFetchStatus newDirStatus;
1300 struct rx_connection * callp;
1302 #ifdef AFS_FREELANCE_CLIENT
1303 if (cm_freelanceEnabled && dscp == cm_data.rootSCachep) {
1304 /* deleting a mount point from the root dir. */
1305 code = cm_FreelanceRemoveMount(namep);
1310 /* make sure we don't screw up the dir status during the merge */
1311 lock_ObtainMutex(&dscp->mx);
1312 sflags = CM_SCACHESYNC_STOREDATA;
1313 code = cm_SyncOp(dscp, NULL, userp, reqp, 0, sflags);
1314 lock_ReleaseMutex(&dscp->mx);
1319 afsFid.Volume = dscp->fid.volume;
1320 afsFid.Vnode = dscp->fid.vnode;
1321 afsFid.Unique = dscp->fid.unique;
1323 osi_Log1(afsd_logp, "CALL RemoveFile scp 0x%p", dscp);
1325 code = cm_Conn(&dscp->fid, userp, reqp, &connp);
1329 callp = cm_GetRxConn(connp);
1330 code = RXAFS_RemoveFile(callp, &afsFid, namep,
1331 &newDirStatus, &volSync);
1332 rx_PutConnection(callp);
1334 } while (cm_Analyze(connp, userp, reqp, &dscp->fid, &volSync, NULL, NULL, code));
1335 code = cm_MapRPCError(code, reqp);
1338 osi_Log1(afsd_logp, "CALL RemoveFile FAILURE, code 0x%x", code);
1340 osi_Log0(afsd_logp, "CALL RemoveFile SUCCESS");
1342 lock_ObtainMutex(&dscp->mx);
1343 cm_dnlcRemove(dscp, namep);
1344 cm_SyncOpDone(dscp, NULL, sflags);
1346 cm_MergeStatus(dscp, &newDirStatus, &volSync, userp, 0);
1347 else if (code == CM_ERROR_NOSUCHFILE) {
1348 /* windows would not have allowed the request to delete the file
1349 * if it did not believe the file existed. therefore, we must
1350 * have an inconsistent view of the world.
1352 dscp->cbServerp = NULL;
1354 lock_ReleaseMutex(&dscp->mx);
1359 /* called with a locked vnode, and fills in the link info.
1360 * returns this the vnode still locked.
1362 long cm_HandleLink(cm_scache_t *linkScp, cm_user_t *userp, cm_req_t *reqp)
1369 lock_AssertMutex(&linkScp->mx);
1370 if (!linkScp->mountPointStringp[0]) {
1371 /* read the link data */
1372 lock_ReleaseMutex(&linkScp->mx);
1373 thyper.LowPart = thyper.HighPart = 0;
1374 code = buf_Get(linkScp, &thyper, &bufp);
1375 lock_ObtainMutex(&linkScp->mx);
1379 code = cm_SyncOp(linkScp, bufp, userp, reqp, 0,
1380 CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_READ);
1385 if (cm_HaveBuffer(linkScp, bufp, 0))
1388 code = cm_GetBuffer(linkScp, bufp, NULL, userp, reqp);
1393 } /* while loop to get the data */
1395 /* now if we still have no link read in,
1396 * copy the data from the buffer */
1397 if ((temp = linkScp->length.LowPart) >= MOUNTPOINTLEN) {
1399 return CM_ERROR_TOOBIG;
1402 /* otherwise, it fits; make sure it is still null (could have
1403 * lost race with someone else referencing this link above),
1404 * and if so, copy in the data.
1406 if (!linkScp->mountPointStringp[0]) {
1407 strncpy(linkScp->mountPointStringp, bufp->datap, temp);
1408 linkScp->mountPointStringp[temp] = 0; /* null terminate */
1411 } /* don't have sym link contents cached */
1416 /* called with a held vnode and a path suffix, with the held vnode being a
1417 * symbolic link. Our goal is to generate a new path to interpret, and return
1418 * this new path in newSpaceBufferp. If the new vnode is relative to a dir
1419 * other than the directory containing the symbolic link, then the new root is
1420 * returned in *newRootScpp, otherwise a null is returned there.
1422 long cm_AssembleLink(cm_scache_t *linkScp, char *pathSuffixp,
1423 cm_scache_t **newRootScpp, cm_space_t **newSpaceBufferp,
1424 cm_user_t *userp, cm_req_t *reqp)
1431 lock_ObtainMutex(&linkScp->mx);
1432 code = cm_HandleLink(linkScp, userp, reqp);
1436 /* if we may overflow the buffer, bail out; buffer is signficantly
1437 * bigger than max path length, so we don't really have to worry about
1438 * being a little conservative here.
1440 if (strlen(linkScp->mountPointStringp) + strlen(pathSuffixp) + 2
1441 >= CM_UTILS_SPACESIZE)
1442 return CM_ERROR_TOOBIG;
1444 tsp = cm_GetSpace();
1445 linkp = linkScp->mountPointStringp;
1446 if (strncmp(linkp, cm_mountRoot, cm_mountRootLen) == 0) {
1447 if (strlen(linkp) > cm_mountRootLen)
1448 strcpy(tsp->data, linkp+cm_mountRootLen+1);
1451 *newRootScpp = cm_data.rootSCachep;
1452 cm_HoldSCache(cm_data.rootSCachep);
1453 } else if (linkp[0] == '\\' && linkp[1] == '\\') {
1454 if (!strnicmp(&linkp[2], cm_NetbiosName, (len = (long)strlen(cm_NetbiosName))))
1456 char * p = &linkp[len + 3];
1457 if (strnicmp(p, "all", 3) == 0)
1460 strcpy(tsp->data, p);
1461 for (p = tsp->data; *p; p++) {
1465 *newRootScpp = cm_data.rootSCachep;
1466 cm_HoldSCache(cm_data.rootSCachep);
1468 linkScp->fileType = CM_SCACHETYPE_DFSLINK;
1469 strcpy(tsp->data, linkp);
1470 *newRootScpp = NULL;
1471 code = CM_ERROR_PATH_NOT_COVERED;
1473 } else if ( !strnicmp(linkp, "msdfs:", (len = (long)strlen("msdfs:"))) ) {
1474 linkScp->fileType = CM_SCACHETYPE_DFSLINK;
1475 strcpy(tsp->data, linkp);
1476 *newRootScpp = NULL;
1477 code = CM_ERROR_PATH_NOT_COVERED;
1478 } else if (*linkp == '\\' || *linkp == '/') {
1480 /* formerly, this was considered to be from the AFS root,
1481 * but this seems to create problems. instead, we will just
1482 * reject the link */
1483 strcpy(tsp->data, linkp+1);
1484 *newRootScpp = cm_data.rootSCachep;
1485 cm_HoldSCache(cm_data.rootSCachep);
1487 /* we still copy the link data into the response so that
1488 * the user can see what the link points to
1490 linkScp->fileType = CM_SCACHETYPE_INVALID;
1491 strcpy(tsp->data, linkp);
1492 *newRootScpp = NULL;
1493 code = CM_ERROR_NOSUCHPATH;
1496 /* a relative link */
1497 strcpy(tsp->data, linkp);
1498 *newRootScpp = NULL;
1500 if (pathSuffixp[0] != 0) { /* if suffix string is non-null */
1501 strcat(tsp->data, "\\");
1502 strcat(tsp->data, pathSuffixp);
1504 *newSpaceBufferp = tsp;
1507 lock_ReleaseMutex(&linkScp->mx);
1511 long cm_NameI(cm_scache_t *rootSCachep, char *pathp, long flags,
1512 cm_user_t *userp, char *tidPathp, cm_req_t *reqp, cm_scache_t **outScpp)
1515 char *tp; /* ptr moving through input buffer */
1516 char tc; /* temp char */
1517 int haveComponent; /* has new component started? */
1518 char component[256]; /* this is the new component */
1519 char *cp; /* component name being assembled */
1520 cm_scache_t *tscp; /* current location in the hierarchy */
1521 cm_scache_t *nscp; /* next dude down */
1522 cm_scache_t *dirScp; /* last dir we searched */
1523 cm_scache_t *linkScp; /* new root for the symlink we just
1525 cm_space_t *psp; /* space for current path, if we've hit
1527 cm_space_t *tempsp; /* temp vbl */
1528 char *restp; /* rest of the pathname to interpret */
1529 int symlinkCount; /* count of # of symlinks traversed */
1530 int extraFlag; /* avoid chasing mt pts for dir cmd */
1531 int phase = 1; /* 1 = tidPathp, 2 = pathp */
1544 cm_HoldSCache(tscp);
1551 /* map Unix slashes into DOS ones so we can interpret Unix
1557 if (!haveComponent) {
1560 } else if (tc == 0) {
1574 /* we have a component here */
1575 if (tc == 0 || tc == '\\') {
1576 /* end of the component; we're at the last
1577 * component if tc == 0. However, if the last
1578 * is a symlink, we have more to do.
1580 *cp++ = 0; /* add null termination */
1582 if ((flags & CM_FLAG_DIRSEARCH) && tc == 0)
1583 extraFlag = CM_FLAG_NOMOUNTCHASE;
1584 code = cm_Lookup(tscp, component,
1586 userp, reqp, &nscp);
1588 cm_ReleaseSCache(tscp);
1590 cm_ReleaseSCache(dirScp);
1593 if (code == CM_ERROR_NOSUCHFILE && tscp->fileType == CM_SCACHETYPE_SYMLINK)
1594 return CM_ERROR_NOSUCHPATH;
1598 haveComponent = 0; /* component done */
1600 cm_ReleaseSCache(dirScp);
1601 dirScp = tscp; /* for some symlinks */
1602 tscp = nscp; /* already held */
1604 if (tc == 0 && !(flags & CM_FLAG_FOLLOW) && phase == 2) {
1607 cm_ReleaseSCache(dirScp);
1613 /* now, if tscp is a symlink, we should follow
1614 * it and assemble the path again.
1616 lock_ObtainMutex(&tscp->mx);
1617 code = cm_SyncOp(tscp, NULL, userp, reqp, 0,
1618 CM_SCACHESYNC_GETSTATUS
1619 | CM_SCACHESYNC_NEEDCALLBACK);
1621 lock_ReleaseMutex(&tscp->mx);
1622 cm_ReleaseSCache(tscp);
1625 cm_ReleaseSCache(dirScp);
1630 if (tscp->fileType == CM_SCACHETYPE_SYMLINK) {
1631 /* this is a symlink; assemble a new buffer */
1632 lock_ReleaseMutex(&tscp->mx);
1633 if (symlinkCount++ >= MAX_SYMLINK_COUNT) {
1634 cm_ReleaseSCache(tscp);
1637 cm_ReleaseSCache(dirScp);
1642 return CM_ERROR_TOO_MANY_SYMLINKS;
1648 code = cm_AssembleLink(tscp, restp, &linkScp, &tempsp, userp, reqp);
1650 /* something went wrong */
1651 cm_ReleaseSCache(tscp);
1654 cm_ReleaseSCache(dirScp);
1660 /* otherwise, tempsp has the new path,
1661 * and linkScp is the new root from
1662 * which to interpret that path.
1663 * Continue with the namei processing,
1664 * also doing the bookkeeping for the
1665 * space allocation and tracking the
1666 * vnode reference counts.
1672 cm_ReleaseSCache(tscp);
1677 * now, if linkScp is null, that's
1678 * AssembleLink's way of telling us that
1679 * the sym link is relative to the dir
1680 * containing the link. We have a ref
1681 * to it in dirScp, and we hold it now
1682 * and reuse it as the new spot in the
1690 /* not a symlink, we may be done */
1691 lock_ReleaseMutex(&tscp->mx);
1699 cm_ReleaseSCache(dirScp);
1707 cm_ReleaseSCache(dirScp);
1710 } /* end of a component */
1713 } /* we have a component */
1714 } /* big while loop over all components */
1718 cm_ReleaseSCache(dirScp);
1724 cm_ReleaseSCache(tscp);
1728 /* called with a dir, and a vnode within the dir that happens to be a symlink.
1729 * We chase the link, and return a held pointer to the target, if it exists,
1730 * in *outScpp. If we succeed, we return 0, otherwise we return an error code
1731 * and do not hold or return a target vnode.
1733 * This is very similar to calling cm_NameI with the last component of a name,
1734 * which happens to be a symlink, except that we've already passed by the name.
1736 * This function is typically called by the directory listing functions, which
1737 * encounter symlinks but need to return the proper file length so programs
1738 * like "more" work properly when they make use of the attributes retrieved from
1741 * The input vnode should not be locked when this function is called.
1743 long cm_EvaluateSymLink(cm_scache_t *dscp, cm_scache_t *linkScp,
1744 cm_scache_t **outScpp, cm_user_t *userp, cm_req_t *reqp)
1748 cm_scache_t *newRootScp;
1750 osi_Log1(afsd_logp, "Evaluating symlink scp 0x%p", linkScp);
1752 code = cm_AssembleLink(linkScp, "", &newRootScp, &spacep, userp, reqp);
1756 /* now, if newRootScp is NULL, we're really being told that the symlink
1757 * is relative to the current directory (dscp).
1759 if (newRootScp == NULL) {
1761 cm_HoldSCache(dscp);
1764 code = cm_NameI(newRootScp, spacep->data,
1765 CM_FLAG_CASEFOLD | CM_FLAG_FOLLOW | CM_FLAG_DIRSEARCH,
1766 userp, NULL, reqp, outScpp);
1768 if (code == CM_ERROR_NOSUCHFILE)
1769 code = CM_ERROR_NOSUCHPATH;
1771 /* this stuff is allocated no matter what happened on the namei call,
1773 cm_FreeSpace(spacep);
1774 cm_ReleaseSCache(newRootScp);
1779 /* make this big enough so that one buffer of dir pages won't overflow. We'll
1780 * check anyway, but we want to minimize the chance that we have to leave stuff
1783 #define CM_BULKMAX (3 * AFSCBMAX)
1785 /* rock for bulk stat calls */
1786 typedef struct cm_bulkStat {
1787 osi_hyper_t bufOffset; /* only do it for things in this buffer page */
1789 /* info for the actual call */
1790 int counter; /* next free slot */
1791 AFSFid fids[CM_BULKMAX];
1792 AFSFetchStatus stats[CM_BULKMAX];
1793 AFSCallBack callbacks[CM_BULKMAX];
1796 /* for a given entry, make sure that it isn't in the stat cache, and then
1797 * add it to the list of file IDs to be obtained.
1799 * Don't bother adding it if we already have a vnode. Note that the dir
1800 * is locked, so we have to be careful checking the vnode we're thinking of
1801 * processing, to avoid deadlocks.
1803 long cm_TryBulkProc(cm_scache_t *scp, cm_dirEntry_t *dep, void *rockp,
1814 /* Don't overflow bsp. */
1815 if (bsp->counter >= CM_BULKMAX)
1816 return CM_ERROR_STOPNOW;
1818 thyper.LowPart = cm_data.buf_blockSize;
1819 thyper.HighPart = 0;
1820 thyper = LargeIntegerAdd(thyper, bsp->bufOffset);
1822 /* thyper is now the first byte past the end of the record we're
1823 * interested in, and bsp->bufOffset is the first byte of the record
1824 * we're interested in.
1825 * Skip data in the others.
1828 if (LargeIntegerLessThan(*offp, bsp->bufOffset))
1830 if (LargeIntegerGreaterThanOrEqualTo(*offp, thyper))
1831 return CM_ERROR_STOPNOW;
1832 if (strcmp(dep->name, ".") == 0 || strcmp(dep->name, "..") == 0)
1835 tfid.cell = scp->fid.cell;
1836 tfid.volume = scp->fid.volume;
1837 tfid.vnode = ntohl(dep->fid.vnode);
1838 tfid.unique = ntohl(dep->fid.unique);
1839 tscp = cm_FindSCache(&tfid);
1841 if (lock_TryMutex(&tscp->mx)) {
1842 /* we have an entry that we can look at */
1843 if (!(tscp->flags & CM_SCACHEFLAG_EACCESS) && cm_HaveCallback(tscp)) {
1844 /* we have a callback on it. Don't bother
1845 * fetching this stat entry, since we're happy
1846 * with the info we have.
1848 lock_ReleaseMutex(&tscp->mx);
1849 cm_ReleaseSCache(tscp);
1852 lock_ReleaseMutex(&tscp->mx);
1854 cm_ReleaseSCache(tscp);
1857 #ifdef AFS_FREELANCE_CLIENT
1858 // yj: if this is a mountpoint under root.afs then we don't want it
1859 // to be bulkstat-ed, instead, we call getSCache directly and under
1860 // getSCache, it is handled specially.
1861 if ( cm_freelanceEnabled &&
1862 tfid.cell==AFS_FAKE_ROOT_CELL_ID &&
1863 tfid.volume==AFS_FAKE_ROOT_VOL_ID &&
1864 !(tfid.vnode==0x1 && tfid.unique==0x1) )
1866 osi_Log0(afsd_logp, "cm_TryBulkProc Freelance calls cm_SCache on root.afs mountpoint");
1867 return cm_GetSCache(&tfid, &tscp, NULL, NULL);
1869 #endif /* AFS_FREELANCE_CLIENT */
1872 bsp->fids[i].Volume = scp->fid.volume;
1873 bsp->fids[i].Vnode = tfid.vnode;
1874 bsp->fids[i].Unique = tfid.unique;
1878 /* called with a locked scp and a pointer to a buffer. Make bulk stat
1879 * calls on all undeleted files in the page of the directory specified.
1882 cm_TryBulkStat(cm_scache_t *dscp, osi_hyper_t *offsetp, cm_user_t *userp,
1886 cm_bulkStat_t bb; /* this is *BIG*, probably 16K or so;
1887 * watch for stack problems */
1888 AFSCBFids fidStruct;
1889 AFSBulkStats statStruct;
1891 AFSCBs callbackStruct;
1894 cm_callbackRequest_t cbReq;
1900 struct rx_connection * callp;
1901 int inlinebulk = 0; /* Did we use InlineBulkStatus RPC or not? */
1903 osi_Log1(afsd_logp, "cm_TryBulkStat dir 0x%p", dscp);
1905 /* should be on a buffer boundary */
1906 osi_assert((offsetp->LowPart & (cm_data.buf_blockSize - 1)) == 0);
1908 memset(&bb, 0, sizeof(bb));
1909 bb.bufOffset = *offsetp;
1911 lock_ReleaseMutex(&dscp->mx);
1912 /* first, assemble the file IDs we need to stat */
1913 code = cm_ApplyDir(dscp, cm_TryBulkProc, (void *) &bb, offsetp, userp, reqp, NULL);
1915 /* if we failed, bail out early */
1916 if (code && code != CM_ERROR_STOPNOW) {
1917 lock_ObtainMutex(&dscp->mx);
1921 /* otherwise, we may have one or more bulk stat's worth of stuff in bb;
1922 * make the calls to create the entries. Handle AFSCBMAX files at a
1926 while (filex < bb.counter) {
1927 filesThisCall = bb.counter - filex;
1928 if (filesThisCall > AFSCBMAX)
1929 filesThisCall = AFSCBMAX;
1931 fidStruct.AFSCBFids_len = filesThisCall;
1932 fidStruct.AFSCBFids_val = &bb.fids[filex];
1933 statStruct.AFSBulkStats_len = filesThisCall;
1934 statStruct.AFSBulkStats_val = &bb.stats[filex];
1935 callbackStruct.AFSCBs_len = filesThisCall;
1936 callbackStruct.AFSCBs_val = &bb.callbacks[filex];
1937 cm_StartCallbackGrantingCall(NULL, &cbReq);
1938 osi_Log1(afsd_logp, "CALL BulkStatus, %d entries", filesThisCall);
1940 code = cm_Conn(&dscp->fid, userp, reqp, &connp);
1944 callp = cm_GetRxConn(connp);
1945 if (!(connp->serverp->flags & CM_SERVERFLAG_NOINLINEBULK)) {
1946 code = RXAFS_InlineBulkStatus(callp, &fidStruct,
1947 &statStruct, &callbackStruct, &volSync);
1948 if (code == RXGEN_OPCODE) {
1949 cm_SetServerNoInlineBulk(connp->serverp, 0);
1955 code = RXAFS_BulkStatus(callp, &fidStruct,
1956 &statStruct, &callbackStruct, &volSync);
1958 rx_PutConnection(callp);
1960 } while (cm_Analyze(connp, userp, reqp, &dscp->fid,
1961 &volSync, NULL, &cbReq, code));
1962 code = cm_MapRPCError(code, reqp);
1964 osi_Log2(afsd_logp, "CALL %sBulkStatus FAILURE code 0x%x",
1965 inlinebulk ? "Inline" : "", code);
1967 osi_Log1(afsd_logp, "CALL %sBulkStatus SUCCESS", inlinebulk ? "Inline" : "");
1969 /* may as well quit on an error, since we're not going to do
1970 * much better on the next immediate call, either.
1973 cm_EndCallbackGrantingCall(NULL, &cbReq, NULL, 0);
1977 /* otherwise, we should do the merges */
1978 for (i = 0; i<filesThisCall; i++) {
1980 tfid.cell = dscp->fid.cell;
1981 tfid.volume = bb.fids[j].Volume;
1982 tfid.vnode = bb.fids[j].Vnode;
1983 tfid.unique = bb.fids[j].Unique;
1984 code = cm_GetSCache(&tfid, &scp, userp, reqp);
1988 /* otherwise, if this entry has no callback info,
1991 lock_ObtainMutex(&scp->mx);
1992 /* now, we have to be extra paranoid on merging in this
1993 * information, since we didn't use cm_SyncOp before
1994 * starting the fetch to make sure that no bad races
1995 * were occurring. Specifically, we need to make sure
1996 * we don't obliterate any newer information in the
1997 * vnode than have here.
1999 * Right now, be pretty conservative: if there's a
2000 * callback or a pending call, skip it.
2002 if ((scp->cbServerp == NULL || (scp->flags & CM_SCACHEFLAG_EACCESS))
2004 (CM_SCACHEFLAG_FETCHING
2005 | CM_SCACHEFLAG_STORING
2006 | CM_SCACHEFLAG_SIZESTORING))) {
2007 cm_EndCallbackGrantingCall(scp, &cbReq,
2009 CM_CALLBACK_MAINTAINCOUNT);
2010 cm_MergeStatus(scp, &bb.stats[j], &volSync, userp, 0);
2012 lock_ReleaseMutex(&scp->mx);
2013 cm_ReleaseSCache(scp);
2014 } /* all files in the response */
2015 /* now tell it to drop the count,
2016 * after doing the vnode processing above */
2017 cm_EndCallbackGrantingCall(NULL, &cbReq, NULL, 0);
2019 filex += filesThisCall;
2020 } /* while there are still more files to process */
2021 lock_ObtainMutex(&dscp->mx);
2024 /* If we did the InlineBulk RPC pull out the return code */
2026 if ((&bb.stats[0])->errorCode) {
2027 cm_Analyze(NULL /*connp was released by the previous cm_Analyze */,
2028 userp, reqp, &dscp->fid, &volSync, NULL, NULL, (&bb.stats[0])->errorCode);
2029 code = cm_MapRPCError((&bb.stats[0])->errorCode, reqp);
2037 osi_Log1(afsd_logp, "END cm_TryBulkStat code = 0x%x", code);
2041 void cm_StatusFromAttr(AFSStoreStatus *statusp, cm_scache_t *scp, cm_attr_t *attrp)
2045 /* initialize store back mask as inexpensive local variable */
2047 memset(statusp, 0, sizeof(AFSStoreStatus));
2049 /* copy out queued info from scache first, if scp passed in */
2051 if (scp->mask & CM_SCACHEMASK_CLIENTMODTIME) {
2052 statusp->ClientModTime = scp->clientModTime;
2053 mask |= AFS_SETMODTIME;
2054 scp->mask &= ~CM_SCACHEMASK_CLIENTMODTIME;
2059 /* now add in our locally generated request */
2060 if (attrp->mask & CM_ATTRMASK_CLIENTMODTIME) {
2061 statusp->ClientModTime = attrp->clientModTime;
2062 mask |= AFS_SETMODTIME;
2064 if (attrp->mask & CM_ATTRMASK_UNIXMODEBITS) {
2065 statusp->UnixModeBits = attrp->unixModeBits;
2066 mask |= AFS_SETMODE;
2068 if (attrp->mask & CM_ATTRMASK_OWNER) {
2069 statusp->Owner = attrp->owner;
2070 mask |= AFS_SETOWNER;
2072 if (attrp->mask & CM_ATTRMASK_GROUP) {
2073 statusp->Group = attrp->group;
2074 mask |= AFS_SETGROUP;
2077 statusp->Mask = mask;
2080 /* set the file size, and make sure that all relevant buffers have been
2081 * truncated. Ensure that any partially truncated buffers have been zeroed
2082 * to the end of the buffer.
2084 long cm_SetLength(cm_scache_t *scp, osi_hyper_t *sizep, cm_user_t *userp,
2090 /* start by locking out buffer creation */
2091 lock_ObtainWrite(&scp->bufCreateLock);
2093 /* verify that this is a file, not a dir or a symlink */
2094 lock_ObtainMutex(&scp->mx);
2095 code = cm_SyncOp(scp, NULL, userp, reqp, 0,
2096 CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS);
2100 if (scp->fileType != CM_SCACHETYPE_FILE) {
2101 code = CM_ERROR_ISDIR;
2106 if (LargeIntegerLessThan(*sizep, scp->length))
2111 lock_ReleaseMutex(&scp->mx);
2113 /* can't hold scp->mx lock here, since we may wait for a storeback to
2114 * finish if the buffer package is cleaning a buffer by storing it to
2118 buf_Truncate(scp, userp, reqp, sizep);
2120 /* now ensure that file length is short enough, and update truncPos */
2121 lock_ObtainMutex(&scp->mx);
2123 /* make sure we have a callback (so we have the right value for the
2124 * length), and wait for it to be safe to do a truncate.
2126 code = cm_SyncOp(scp, NULL, userp, reqp, PRSFS_WRITE,
2127 CM_SCACHESYNC_NEEDCALLBACK | CM_SCACHESYNC_GETSTATUS
2128 | CM_SCACHESYNC_SETSTATUS | CM_SCACHESYNC_SETSIZE);
2132 if (LargeIntegerLessThan(*sizep, scp->length)) {
2133 /* a real truncation. If truncPos is not set yet, or is bigger
2134 * than where we're truncating the file, set truncPos to this
2139 if (!(scp->mask & CM_SCACHEMASK_TRUNCPOS)
2140 || LargeIntegerLessThan(*sizep, scp->length)) {
2142 scp->truncPos = *sizep;
2143 scp->mask |= CM_SCACHEMASK_TRUNCPOS;
2145 /* in either case, the new file size has been changed */
2146 scp->length = *sizep;
2147 scp->mask |= CM_SCACHEMASK_LENGTH;
2149 else if (LargeIntegerGreaterThan(*sizep, scp->length)) {
2150 /* really extending the file */
2151 scp->length = *sizep;
2152 scp->mask |= CM_SCACHEMASK_LENGTH;
2155 /* done successfully */
2159 lock_ReleaseMutex(&scp->mx);
2160 lock_ReleaseWrite(&scp->bufCreateLock);
2165 /* set the file size or other attributes (but not both at once) */
2166 long cm_SetAttr(cm_scache_t *scp, cm_attr_t *attrp, cm_user_t *userp,
2171 AFSFetchStatus afsOutStatus;
2175 AFSStoreStatus afsInStatus;
2176 struct rx_connection * callp;
2178 /* handle file length setting */
2179 if (attrp->mask & CM_ATTRMASK_LENGTH)
2180 return cm_SetLength(scp, &attrp->length, userp, reqp);
2182 flags = CM_SCACHESYNC_STORESTATUS;
2184 lock_ObtainMutex(&scp->mx);
2185 /* otherwise, we have to make an RPC to get the status */
2186 code = cm_SyncOp(scp, NULL, userp, reqp, 0, CM_SCACHESYNC_STORESTATUS);
2188 /* make the attr structure */
2189 cm_StatusFromAttr(&afsInStatus, scp, attrp);
2191 tfid.Volume = scp->fid.volume;
2192 tfid.Vnode = scp->fid.vnode;
2193 tfid.Unique = scp->fid.unique;
2195 lock_ReleaseMutex(&scp->mx);
2199 /* now make the RPC */
2200 osi_Log1(afsd_logp, "CALL StoreStatus scp 0x%p", scp);
2202 code = cm_Conn(&scp->fid, userp, reqp, &connp);
2206 callp = cm_GetRxConn(connp);
2207 code = RXAFS_StoreStatus(callp, &tfid,
2208 &afsInStatus, &afsOutStatus, &volSync);
2209 rx_PutConnection(callp);
2211 } while (cm_Analyze(connp, userp, reqp,
2212 &scp->fid, &volSync, NULL, NULL, code));
2213 code = cm_MapRPCError(code, reqp);
2216 osi_Log1(afsd_logp, "CALL StoreStatus FAILURE, code 0x%x", code);
2218 osi_Log0(afsd_logp, "CALL StoreStatus SUCCESS");
2220 lock_ObtainMutex(&scp->mx);
2221 cm_SyncOpDone(scp, NULL, CM_SCACHESYNC_STORESTATUS);
2223 cm_MergeStatus(scp, &afsOutStatus, &volSync, userp,
2224 CM_MERGEFLAG_FORCE);
2226 /* if we're changing the mode bits, discard the ACL cache,
2227 * since we changed the mode bits.
2229 if (afsInStatus.Mask & AFS_SETMODE) cm_FreeAllACLEnts(scp);
2230 lock_ReleaseMutex(&scp->mx);
2234 long cm_Create(cm_scache_t *dscp, char *namep, long flags, cm_attr_t *attrp,
2235 cm_scache_t **scpp, cm_user_t *userp, cm_req_t *reqp)
2240 cm_callbackRequest_t cbReq;
2245 AFSStoreStatus inStatus;
2246 AFSFetchStatus updatedDirStatus;
2247 AFSFetchStatus newFileStatus;
2248 AFSCallBack newFileCallback;
2250 struct rx_connection * callp;
2252 /* can't create names with @sys in them; must expand it manually first.
2253 * return "invalid request" if they try.
2255 if (cm_ExpandSysName(namep, NULL, 0, 0)) {
2256 return CM_ERROR_ATSYS;
2259 /* before starting the RPC, mark that we're changing the file data, so
2260 * that someone who does a chmod will know to wait until our call
2263 lock_ObtainMutex(&dscp->mx);
2264 code = cm_SyncOp(dscp, NULL, userp, reqp, 0, CM_SCACHESYNC_STOREDATA);
2266 cm_StartCallbackGrantingCall(NULL, &cbReq);
2268 lock_ReleaseMutex(&dscp->mx);
2274 cm_StatusFromAttr(&inStatus, NULL, attrp);
2276 /* try the RPC now */
2277 osi_Log1(afsd_logp, "CALL CreateFile scp 0x%p", dscp);
2279 code = cm_Conn(&dscp->fid, userp, reqp, &connp);
2283 dirAFSFid.Volume = dscp->fid.volume;
2284 dirAFSFid.Vnode = dscp->fid.vnode;
2285 dirAFSFid.Unique = dscp->fid.unique;
2287 callp = cm_GetRxConn(connp);
2288 code = RXAFS_CreateFile(connp->callp, &dirAFSFid, namep,
2289 &inStatus, &newAFSFid, &newFileStatus,
2290 &updatedDirStatus, &newFileCallback,
2292 rx_PutConnection(callp);
2294 } while (cm_Analyze(connp, userp, reqp,
2295 &dscp->fid, &volSync, NULL, &cbReq, code));
2296 code = cm_MapRPCError(code, reqp);
2299 osi_Log1(afsd_logp, "CALL CreateFile FAILURE, code 0x%x", code);
2301 osi_Log0(afsd_logp, "CALL CreateFile SUCCESS");
2303 lock_ObtainMutex(&dscp->mx);
2304 cm_SyncOpDone(dscp, NULL, CM_SCACHESYNC_STOREDATA);
2306 cm_MergeStatus(dscp, &updatedDirStatus, &volSync, userp, 0);
2308 lock_ReleaseMutex(&dscp->mx);
2310 /* now try to create the file's entry, too, but be careful to
2311 * make sure that we don't merge in old info. Since we weren't locking
2312 * out any requests during the file's creation, we may have pretty old
2316 newFid.cell = dscp->fid.cell;
2317 newFid.volume = dscp->fid.volume;
2318 newFid.vnode = newAFSFid.Vnode;
2319 newFid.unique = newAFSFid.Unique;
2320 code = cm_GetSCache(&newFid, &scp, userp, reqp);
2322 lock_ObtainMutex(&scp->mx);
2323 scp->creator = userp; /* remember who created it */
2324 if (!cm_HaveCallback(scp)) {
2325 cm_MergeStatus(scp, &newFileStatus, &volSync,
2327 cm_EndCallbackGrantingCall(scp, &cbReq,
2328 &newFileCallback, 0);
2331 lock_ReleaseMutex(&scp->mx);
2336 /* make sure we end things properly */
2338 cm_EndCallbackGrantingCall(NULL, &cbReq, NULL, 0);
2343 long cm_FSync(cm_scache_t *scp, cm_user_t *userp, cm_req_t *reqp)
2347 lock_ObtainWrite(&scp->bufCreateLock);
2348 code = buf_CleanVnode(scp, userp, reqp);
2349 lock_ReleaseWrite(&scp->bufCreateLock);
2351 lock_ObtainMutex(&scp->mx);
2353 if (scp->mask & (CM_SCACHEMASK_TRUNCPOS
2354 | CM_SCACHEMASK_CLIENTMODTIME
2355 | CM_SCACHEMASK_LENGTH))
2356 code = cm_StoreMini(scp, userp, reqp);
2358 if (scp->flags & (CM_SCACHEFLAG_OVERQUOTA | CM_SCACHEFLAG_OUTOFSPACE)) {
2359 code = (scp->flags & CM_SCACHEFLAG_OVERQUOTA) ? CM_ERROR_QUOTA : CM_ERROR_SPACE;
2360 scp->flags &= ~(CM_SCACHEFLAG_OVERQUOTA | CM_SCACHEFLAG_OUTOFSPACE);
2363 lock_ReleaseMutex(&scp->mx);
2368 long cm_MakeDir(cm_scache_t *dscp, char *namep, long flags, cm_attr_t *attrp,
2369 cm_user_t *userp, cm_req_t *reqp)
2374 cm_callbackRequest_t cbReq;
2379 AFSStoreStatus inStatus;
2380 AFSFetchStatus updatedDirStatus;
2381 AFSFetchStatus newDirStatus;
2382 AFSCallBack newDirCallback;
2384 struct rx_connection * callp;
2386 /* can't create names with @sys in them; must expand it manually first.
2387 * return "invalid request" if they try.
2389 if (cm_ExpandSysName(namep, NULL, 0, 0)) {
2390 return CM_ERROR_ATSYS;
2393 /* before starting the RPC, mark that we're changing the directory
2394 * data, so that someone who does a chmod on the dir will wait until
2395 * our call completes.
2397 lock_ObtainMutex(&dscp->mx);
2398 code = cm_SyncOp(dscp, NULL, userp, reqp, 0, CM_SCACHESYNC_STOREDATA);
2400 cm_StartCallbackGrantingCall(NULL, &cbReq);
2402 lock_ReleaseMutex(&dscp->mx);
2408 cm_StatusFromAttr(&inStatus, NULL, attrp);
2410 /* try the RPC now */
2411 osi_Log1(afsd_logp, "CALL MakeDir scp 0x%p", dscp);
2413 code = cm_Conn(&dscp->fid, userp, reqp, &connp);
2417 dirAFSFid.Volume = dscp->fid.volume;
2418 dirAFSFid.Vnode = dscp->fid.vnode;
2419 dirAFSFid.Unique = dscp->fid.unique;
2421 callp = cm_GetRxConn(connp);
2422 code = RXAFS_MakeDir(connp->callp, &dirAFSFid, namep,
2423 &inStatus, &newAFSFid, &newDirStatus,
2424 &updatedDirStatus, &newDirCallback,
2426 rx_PutConnection(callp);
2428 } while (cm_Analyze(connp, userp, reqp,
2429 &dscp->fid, &volSync, NULL, &cbReq, code));
2430 code = cm_MapRPCError(code, reqp);
2433 osi_Log1(afsd_logp, "CALL MakeDir FAILURE, code 0x%x", code);
2435 osi_Log0(afsd_logp, "CALL MakeDir SUCCESS");
2437 lock_ObtainMutex(&dscp->mx);
2438 cm_SyncOpDone(dscp, NULL, CM_SCACHESYNC_STOREDATA);
2440 cm_MergeStatus(dscp, &updatedDirStatus, &volSync, userp, 0);
2442 lock_ReleaseMutex(&dscp->mx);
2444 /* now try to create the new dir's entry, too, but be careful to
2445 * make sure that we don't merge in old info. Since we weren't locking
2446 * out any requests during the file's creation, we may have pretty old
2450 newFid.cell = dscp->fid.cell;
2451 newFid.volume = dscp->fid.volume;
2452 newFid.vnode = newAFSFid.Vnode;
2453 newFid.unique = newAFSFid.Unique;
2454 code = cm_GetSCache(&newFid, &scp, userp, reqp);
2456 lock_ObtainMutex(&scp->mx);
2457 if (!cm_HaveCallback(scp)) {
2458 cm_MergeStatus(scp, &newDirStatus, &volSync,
2460 cm_EndCallbackGrantingCall(scp, &cbReq,
2461 &newDirCallback, 0);
2464 lock_ReleaseMutex(&scp->mx);
2465 cm_ReleaseSCache(scp);
2469 /* make sure we end things properly */
2471 cm_EndCallbackGrantingCall(NULL, &cbReq, NULL, 0);
2473 /* and return error code */
2477 long cm_Link(cm_scache_t *dscp, char *namep, cm_scache_t *sscp, long flags,
2478 cm_user_t *userp, cm_req_t *reqp)
2483 AFSFid existingAFSFid;
2484 AFSFetchStatus updatedDirStatus;
2485 AFSFetchStatus newLinkStatus;
2487 struct rx_connection * callp;
2489 if (dscp->fid.cell != sscp->fid.cell ||
2490 dscp->fid.volume != sscp->fid.volume) {
2491 return CM_ERROR_CROSSDEVLINK;
2494 lock_ObtainMutex(&dscp->mx);
2495 code = cm_SyncOp(dscp, NULL, userp, reqp, 0, CM_SCACHESYNC_STOREDATA);
2496 lock_ReleaseMutex(&dscp->mx);
2501 /* try the RPC now */
2502 osi_Log1(afsd_logp, "CALL Link scp 0x%p", dscp);
2504 code = cm_Conn(&dscp->fid, userp, reqp, &connp);
2507 dirAFSFid.Volume = dscp->fid.volume;
2508 dirAFSFid.Vnode = dscp->fid.vnode;
2509 dirAFSFid.Unique = dscp->fid.unique;
2511 existingAFSFid.Volume = sscp->fid.volume;
2512 existingAFSFid.Vnode = sscp->fid.vnode;
2513 existingAFSFid.Unique = sscp->fid.unique;
2515 callp = cm_GetRxConn(connp);
2516 code = RXAFS_Link(callp, &dirAFSFid, namep, &existingAFSFid,
2517 &newLinkStatus, &updatedDirStatus, &volSync);
2518 rx_PutConnection(callp);
2519 osi_Log1(smb_logp," RXAFS_Link returns 0x%x", code);
2521 } while (cm_Analyze(connp, userp, reqp,
2522 &dscp->fid, &volSync, NULL, NULL, code));
2524 code = cm_MapRPCError(code, reqp);
2527 osi_Log1(afsd_logp, "CALL Link FAILURE, code 0x%x", code);
2529 osi_Log0(afsd_logp, "CALL Link SUCCESS");
2531 lock_ObtainMutex(&dscp->mx);
2532 cm_SyncOpDone(dscp, NULL, CM_SCACHESYNC_STOREDATA);
2534 cm_MergeStatus(dscp, &updatedDirStatus, &volSync, userp, 0);
2536 lock_ReleaseMutex(&dscp->mx);
2541 long cm_SymLink(cm_scache_t *dscp, char *namep, char *contentsp, long flags,
2542 cm_attr_t *attrp, cm_user_t *userp, cm_req_t *reqp)
2550 AFSStoreStatus inStatus;
2551 AFSFetchStatus updatedDirStatus;
2552 AFSFetchStatus newLinkStatus;
2554 struct rx_connection * callp;
2556 /* before starting the RPC, mark that we're changing the directory data,
2557 * so that someone who does a chmod on the dir will wait until our
2560 lock_ObtainMutex(&dscp->mx);
2561 code = cm_SyncOp(dscp, NULL, userp, reqp, 0, CM_SCACHESYNC_STOREDATA);
2562 lock_ReleaseMutex(&dscp->mx);
2567 cm_StatusFromAttr(&inStatus, NULL, attrp);
2569 /* try the RPC now */
2570 osi_Log1(afsd_logp, "CALL Symlink scp 0x%p", dscp);
2572 code = cm_Conn(&dscp->fid, userp, reqp, &connp);
2576 dirAFSFid.Volume = dscp->fid.volume;
2577 dirAFSFid.Vnode = dscp->fid.vnode;
2578 dirAFSFid.Unique = dscp->fid.unique;
2580 callp = cm_GetRxConn(connp);
2581 code = RXAFS_Symlink(callp, &dirAFSFid, namep, contentsp,
2582 &inStatus, &newAFSFid, &newLinkStatus,
2583 &updatedDirStatus, &volSync);
2584 rx_PutConnection(callp);
2586 } while (cm_Analyze(connp, userp, reqp,
2587 &dscp->fid, &volSync, NULL, NULL, code));
2588 code = cm_MapRPCError(code, reqp);
2591 osi_Log1(afsd_logp, "CALL Symlink FAILURE, code 0x%x", code);
2593 osi_Log0(afsd_logp, "CALL Symlink SUCCESS");
2595 lock_ObtainMutex(&dscp->mx);
2596 cm_SyncOpDone(dscp, NULL, CM_SCACHESYNC_STOREDATA);
2598 cm_MergeStatus(dscp, &updatedDirStatus, &volSync, userp, 0);
2600 lock_ReleaseMutex(&dscp->mx);
2602 /* now try to create the new dir's entry, too, but be careful to
2603 * make sure that we don't merge in old info. Since we weren't locking
2604 * out any requests during the file's creation, we may have pretty old
2608 newFid.cell = dscp->fid.cell;
2609 newFid.volume = dscp->fid.volume;
2610 newFid.vnode = newAFSFid.Vnode;
2611 newFid.unique = newAFSFid.Unique;
2612 code = cm_GetSCache(&newFid, &scp, userp, reqp);
2614 lock_ObtainMutex(&scp->mx);
2615 if (!cm_HaveCallback(scp)) {
2616 cm_MergeStatus(scp, &newLinkStatus, &volSync,
2619 lock_ReleaseMutex(&scp->mx);
2620 cm_ReleaseSCache(scp);
2624 /* and return error code */
2628 long cm_RemoveDir(cm_scache_t *dscp, char *namep, cm_user_t *userp,
2635 AFSFetchStatus updatedDirStatus;
2637 struct rx_connection * callp;
2639 /* before starting the RPC, mark that we're changing the directory data,
2640 * so that someone who does a chmod on the dir will wait until our
2643 lock_ObtainMutex(&dscp->mx);
2644 code = cm_SyncOp(dscp, NULL, userp, reqp, 0, CM_SCACHESYNC_STOREDATA);
2645 lock_ReleaseMutex(&dscp->mx);
2651 /* try the RPC now */
2652 osi_Log1(afsd_logp, "CALL RemoveDir scp 0x%p", dscp);
2654 code = cm_Conn(&dscp->fid, userp, reqp, &connp);
2658 dirAFSFid.Volume = dscp->fid.volume;
2659 dirAFSFid.Vnode = dscp->fid.vnode;
2660 dirAFSFid.Unique = dscp->fid.unique;
2662 callp = cm_GetRxConn(connp);
2663 code = RXAFS_RemoveDir(callp, &dirAFSFid, namep,
2664 &updatedDirStatus, &volSync);
2665 rx_PutConnection(callp);
2667 } while (cm_Analyze(connp, userp, reqp,
2668 &dscp->fid, &volSync, NULL, NULL, code));
2669 code = cm_MapRPCErrorRmdir(code, reqp);
2672 osi_Log1(afsd_logp, "CALL RemoveDir FAILURE, code 0x%x", code);
2674 osi_Log0(afsd_logp, "CALL RemoveDir SUCCESS");
2676 lock_ObtainMutex(&dscp->mx);
2677 cm_SyncOpDone(dscp, NULL, CM_SCACHESYNC_STOREDATA);
2679 cm_dnlcRemove(dscp, namep);
2680 cm_MergeStatus(dscp, &updatedDirStatus, &volSync, userp, 0);
2682 lock_ReleaseMutex(&dscp->mx);
2684 /* and return error code */
2688 long cm_Open(cm_scache_t *scp, int type, cm_user_t *userp)
2690 /* grab mutex on contents */
2691 lock_ObtainMutex(&scp->mx);
2693 /* reset the prefetch info */
2694 scp->prefetch.base.LowPart = 0; /* base */
2695 scp->prefetch.base.HighPart = 0;
2696 scp->prefetch.end.LowPart = 0; /* and end */
2697 scp->prefetch.end.HighPart = 0;
2699 /* release mutex on contents */
2700 lock_ReleaseMutex(&scp->mx);
2706 long cm_Rename(cm_scache_t *oldDscp, char *oldNamep, cm_scache_t *newDscp,
2707 char *newNamep, cm_user_t *userp, cm_req_t *reqp)
2711 AFSFid oldDirAFSFid;
2712 AFSFid newDirAFSFid;
2714 AFSFetchStatus updatedOldDirStatus;
2715 AFSFetchStatus updatedNewDirStatus;
2718 struct rx_connection * callp;
2720 /* before starting the RPC, mark that we're changing the directory data,
2721 * so that someone who does a chmod on the dir will wait until our call
2722 * completes. We do this in vnode order so that we don't deadlock,
2723 * which makes the code a little verbose.
2725 if (oldDscp == newDscp) {
2726 /* check for identical names */
2727 if (strcmp(oldNamep, newNamep) == 0)
2728 return CM_ERROR_RENAME_IDENTICAL;
2731 lock_ObtainMutex(&oldDscp->mx);
2732 cm_dnlcRemove(oldDscp, oldNamep);
2733 cm_dnlcRemove(oldDscp, newNamep);
2734 code = cm_SyncOp(oldDscp, NULL, userp, reqp, 0,
2735 CM_SCACHESYNC_STOREDATA);
2736 lock_ReleaseMutex(&oldDscp->mx);
2739 /* two distinct dir vnodes */
2741 if (oldDscp->fid.cell != newDscp->fid.cell ||
2742 oldDscp->fid.volume != newDscp->fid.volume)
2743 return CM_ERROR_CROSSDEVLINK;
2745 /* shouldn't happen that we have distinct vnodes for two
2746 * different files, but could due to deliberate attack, or
2747 * stale info. Avoid deadlocks and quit now.
2749 if (oldDscp->fid.vnode == newDscp->fid.vnode)
2750 return CM_ERROR_CROSSDEVLINK;
2752 if (oldDscp->fid.vnode < newDscp->fid.vnode) {
2753 lock_ObtainMutex(&oldDscp->mx);
2754 cm_dnlcRemove(oldDscp, oldNamep);
2755 code = cm_SyncOp(oldDscp, NULL, userp, reqp, 0,
2756 CM_SCACHESYNC_STOREDATA);
2757 lock_ReleaseMutex(&oldDscp->mx);
2759 lock_ObtainMutex(&newDscp->mx);
2760 cm_dnlcRemove(newDscp, newNamep);
2761 code = cm_SyncOp(newDscp, NULL, userp, reqp, 0,
2762 CM_SCACHESYNC_STOREDATA);
2763 lock_ReleaseMutex(&newDscp->mx);
2765 /* cleanup first one */
2766 lock_ObtainMutex(&newDscp->mx);
2767 cm_SyncOpDone(oldDscp, NULL,
2768 CM_SCACHESYNC_STOREDATA);
2769 lock_ReleaseMutex(&oldDscp->mx);
2774 /* lock the new vnode entry first */
2775 lock_ObtainMutex(&newDscp->mx);
2776 cm_dnlcRemove(newDscp, newNamep);
2777 code = cm_SyncOp(newDscp, NULL, userp, reqp, 0,
2778 CM_SCACHESYNC_STOREDATA);
2779 lock_ReleaseMutex(&newDscp->mx);
2781 lock_ObtainMutex(&oldDscp->mx);
2782 cm_dnlcRemove(oldDscp, oldNamep);
2783 code = cm_SyncOp(oldDscp, NULL, userp, reqp, 0,
2784 CM_SCACHESYNC_STOREDATA);
2785 lock_ReleaseMutex(&oldDscp->mx);
2787 /* cleanup first one */
2788 lock_ObtainMutex(&newDscp->mx);
2789 cm_SyncOpDone(newDscp, NULL,
2790 CM_SCACHESYNC_STOREDATA);
2791 lock_ReleaseMutex(&newDscp->mx);
2795 } /* two distinct vnodes */
2802 /* try the RPC now */
2803 osi_Log2(afsd_logp, "CALL Rename old scp 0x%p new scp 0x%p",
2806 code = cm_Conn(&oldDscp->fid, userp, reqp, &connp);
2810 oldDirAFSFid.Volume = oldDscp->fid.volume;
2811 oldDirAFSFid.Vnode = oldDscp->fid.vnode;
2812 oldDirAFSFid.Unique = oldDscp->fid.unique;
2813 newDirAFSFid.Volume = newDscp->fid.volume;
2814 newDirAFSFid.Vnode = newDscp->fid.vnode;
2815 newDirAFSFid.Unique = newDscp->fid.unique;
2817 callp = cm_GetRxConn(connp);
2818 code = RXAFS_Rename(callp, &oldDirAFSFid, oldNamep,
2819 &newDirAFSFid, newNamep,
2820 &updatedOldDirStatus, &updatedNewDirStatus,
2822 rx_PutConnection(callp);
2824 } while (cm_Analyze(connp, userp, reqp, &oldDscp->fid,
2825 &volSync, NULL, NULL, code));
2826 code = cm_MapRPCError(code, reqp);
2829 osi_Log1(afsd_logp, "CALL Rename FAILURE, code 0x%x", code);
2831 osi_Log0(afsd_logp, "CALL Rename SUCCESS");
2833 /* update the individual stat cache entries for the directories */
2834 lock_ObtainMutex(&oldDscp->mx);
2835 cm_SyncOpDone(oldDscp, NULL, CM_SCACHESYNC_STOREDATA);
2837 cm_MergeStatus(oldDscp, &updatedOldDirStatus, &volSync,
2840 lock_ReleaseMutex(&oldDscp->mx);
2842 /* and update it for the new one, too, if necessary */
2844 lock_ObtainMutex(&newDscp->mx);
2845 cm_SyncOpDone(newDscp, NULL, CM_SCACHESYNC_STOREDATA);
2847 cm_MergeStatus(newDscp, &updatedNewDirStatus, &volSync,
2850 lock_ReleaseMutex(&newDscp->mx);
2853 /* and return error code */
2857 /* Byte range locks:
2859 The OpenAFS Windows client has to fake byte range locks given no
2860 server side support for such locks. This is implemented as keyed
2861 byte range locks on the cache manager.
2863 Keyed byte range locks:
2865 Each cm_scache_t structure keeps track of a list of keyed locks.
2866 The key for a lock identifies an owner of a set of locks (referred
2867 to as a client). Each key is represented by a value. The set of
2868 key values used within a specific cm_scache_t structure form a
2869 namespace that has a scope of just that cm_scache_t structure. The
2870 same key value can be used with another cm_scache_t structure and
2871 correspond to a completely different client. However it is
2872 advantageous for the SMB or IFS layer to make sure that there is a
2873 1-1 mapping between client and keys over all cm_scache_t objects.
2875 Assume a client C has key Key(C) (although, since the scope of the
2876 key is a cm_scache_t, the key can be Key(C,S), where S is the
2877 cm_scache_t. But assume a 1-1 relation between keys and clients).
2878 A byte range (O,+L) denotes byte addresses (O) through (O+L-1)
2879 inclusive (a.k.a. [O,O+L-1]). The function Key(x) is implemented
2880 through cm_generateKey() function for both SMB and IFS.
2882 The list of locks for a cm_scache_t object S is maintained in
2883 S->fileLocks. The cache manager will set a lock on the AFS file
2884 server in order to assert the locks in S->fileLocks. If only
2885 shared locks are in place for S, then the cache manager will obtain
2886 a LockRead lock, while if there are any exclusive locks, it will
2887 obtain a LockWrite lock. If the exclusive locks are all released
2888 while the shared locks remain, then the cache manager will
2889 downgrade the lock from LockWrite to LockRead. Similarly, if an
2890 exclusive lock is obtained when only shared locks exist, then the
2891 cache manager will try to upgrade the lock from LockRead to
2894 Each lock L owned by client C maintains a key L->key such that
2895 L->key == Key(C), the effective range defined by L->LOffset and
2896 L->LLength such that the range of bytes affected by the lock is
2897 (L->LOffset, +L->LLength), a type maintained in L->LockType which
2898 is either exclusive or shared.
2902 A lock exists iff it is in S->fileLocks for some cm_scache_t
2903 S. Existing locks are in one of the following states: ACTIVE,
2904 WAITLOCK, WAITUNLOCK, LOST, DELETED.
2906 The following sections describe each lock and the associated
2909 1. ACTIVE: A lock L is ACTIVE iff the cache manager has asserted
2910 the lock with the AFS file server. This type of lock can be
2911 exercised by a client to read or write to the locked region (as
2914 1.1 ACTIVE->LOST: When the AFS file server fails to extend a
2915 server lock that was required to assert the lock. Before
2916 marking the lock as lost, the cache manager checks if the file
2917 has changed on the server. If the file has not changed, then
2918 the cache manager will attempt to obtain a new server lock
2919 that is sufficient to assert the client side locks for the
2920 file. If any of these fail, the lock is marked as LOST.
2921 Otherwise, it is left as ACTIVE.
2923 1.2 ACTIVE->DELETED: Lock is released.
2925 2. WAITLOCK: A lock is in a WAITLOCK state if the cache manager
2926 grants the lock but the lock is yet to be asserted with the AFS
2927 file server. Once the file server grants the lock, the state
2928 will transition to an ACTIVE lock.
2930 2.1 WAITLOCK->ACTIVE: The server granted the lock.
2932 2.2 WAITLOCK->DELETED: Lock is abandoned, or timed out during
2935 2.3 WAITLOCK->LOST: One or more locks from this client were
2936 marked as LOST. No further locks will be granted to this
2937 client until all lost locks are removed.
2939 3. WAITUNLOCK: A lock is in a WAITUNLOCK state if the cache manager
2940 receives a request for a lock that conflicts with an existing
2941 ACTIVE or WAITLOCK lock. The lock will be placed in the queue
2942 and will be granted at such time the conflicting locks are
2943 removed, at which point the state will transition to either
2946 3.1 WAITUNLOCK->ACTIVE: The conflicting lock was removed. The
2947 current serverLock is sufficient to assert this lock, or a
2948 sufficient serverLock is obtained.
2950 3.2 WAITUNLOCK->WAITLOCK: The conflicting lock was removed,
2951 however the required serverLock is yet to be asserted with the
2954 3.3 WAITUNLOCK->DELETED: The lock is abandoned, timed out or
2957 3.5 WAITUNLOCK->LOST: One or more locks from this client were
2958 marked as LOST. No further locks will be granted to this
2959 client until all lost locks are removed.
2961 4. LOST: A lock L is LOST if the server lock that was required to
2962 assert the lock could not be obtained or if it could not be
2963 extended, or if other locks by the same client were LOST.
2964 Essentially, once a lock is LOST, the contract between the cache
2965 manager and that specific client is no longer valid.
2967 The cache manager rechecks the server lock once every minute and
2968 extends it as appropriate. If this is not done for 5 minutes,
2969 the AFS file server will release the lock (the 5 minute timeout
2970 is based on current file server code and is fairly arbitrary).
2971 Once released, the lock cannot be re-obtained without verifying
2972 that the contents of the file hasn't been modified since the
2973 time the lock was released. Re-obtaining the lock without
2974 verifying this may lead to data corruption. If the lock can not
2975 be obtained safely, then all active locks for the cm_scache_t
2978 4.1 LOST->DELETED: The lock is released.
2980 5. DELETED: The lock is no longer relevant. Eventually, it will
2981 get removed from the cm_scache_t. In the meantime, it will be
2982 treated as if it does not exist.
2984 5.1 DELETED->not exist: The lock is removed from the
2987 The following are classifications of locks based on their state.
2989 6* A lock L is ACCEPTED if it is ACTIVE or WAITLOCK. These locks
2990 have been accepted by the cache manager, but may or may not have
2991 been granted back to the client.
2993 7* A lock L is QUEUED if it is ACTIVE, WAITLOCK or WAITUNLOCK.
2995 8* A lock L is WAITING if it is WAITLOCK or WAITUNLOCK.
2999 A client C can READ range (Offset,+Length) of a file represented by
3000 cm_scache_t S iff (1):
3002 1. for all _a_ in (Offset,+Length), all of the following is true:
3004 1.1 For each ACTIVE lock L in S->fileLocks such that _a_ in
3005 (L->LOffset,+L->LLength); L->key == Key(C) OR L->LockType is
3008 1.2 For each LOST lock L in S->fileLocks such that _a_ in
3009 (L->LOffset,+L->LLength); L->LockType is shared AND L->key !=
3012 (When locks are lost on an cm_scache_t, all locks are lost. By
3013 4.2 (below), if there is an exclusive LOST lock, then there
3014 can't be any overlapping ACTIVE locks.)
3016 A client C can WRITE range (Offset,+Length) of cm_scache_t S iff (2):
3018 2. for all _a_ in (Offset,+Length), one of the following is true:
3020 2.1 Byte _a_ of S is unowned (as specified in 1.1) AND there
3021 does not exist a LOST lock L such that _a_ in
3022 (L->LOffset,+L->LLength).
3024 2.2 Byte _a_ of S is owned by C under lock L (as specified in
3025 1.2) AND L->LockType is exclusive.
3027 A client C can OBTAIN a lock L on cm_scache_t S iff (both 3 and 4):
3029 3. for all _a_ in (L->LOffset,+L->LLength), ALL of the following is
3032 3.1 If L->LockType is exclusive then there does NOT exist a
3033 ACCEPTED lock M in S->fileLocks such that _a_ in
3034 (M->LOffset,+M->LLength).
3036 (If we count all QUEUED locks then we hit cases such as
3037 cascading waiting locks where the locks later on in the queue
3038 can be granted without compromising file integrity. On the
3039 other hand if only ACCEPTED locks are considered, then locks
3040 that were received earlier may end up waiting for locks that
3041 were received later to be unlocked. The choice of ACCEPTED
3042 locks was made to mimic the Windows byte range lock
3045 3.2 If L->LockType is shared then for each ACCEPTED lock M in
3046 S->fileLocks, if _a_ in (M->LOffset,+M->LLength) then
3047 M->LockType is shared.
3049 4. For all LOST locks M in S->fileLocks, ALL of the following are true:
3051 4.1 M->key != Key(C)
3053 4.2 If M->LockType is exclusive, then (L->LOffset,+L->LLength)
3054 and (M->LOffset,+M->LLength) do not intersect.
3056 (Note: If a client loses a lock, it loses all locks.
3057 Subsequently, it will not be allowed to obtain any more locks
3058 until all existing LOST locks that belong to the client are
3059 released. Once all locks are released by a single client,
3060 there exists no further contract between the client and AFS
3061 about the contents of the file, hence the client can then
3062 proceed to obtain new locks and establish a new contract.
3064 This doesn't quite work as you think it should, because most
3065 applications aren't built to deal with losing locks they
3066 thought they once had. For now, we don't have a good
3067 solution to lost locks.
3069 Also, for consistency reasons, we have to hold off on
3070 granting locks that overlap exclusive LOST locks.)
3072 A client C can only unlock locks L in S->fileLocks which have
3075 The representation and invariants are as follows:
3077 - Each cm_scache_t structure keeps:
3079 - A queue of byte-range locks (cm_scache_t::fileLocks) which
3080 are of type cm_file_lock_t.
3082 - A record of the highest server-side lock that has been
3083 obtained for this object (cm_scache_t::serverLock), which is
3084 one of (-1), LockRead, LockWrite.
3086 - A count of ACCEPTED exclusive and shared locks that are in the
3087 queue (cm_scache_t::sharedLocks and
3088 cm_scache_t::exclusiveLocks)
3090 - Each cm_file_lock_t structure keeps:
3092 - The type of lock (cm_file_lock_t::LockType)
3094 - The key associated with the lock (cm_file_lock_t::key)
3096 - The offset and length of the lock (cm_file_lock_t::LOffset
3097 and cm_file_lock_t::LLength)
3099 - The state of the lock.
3101 - Time of issuance or last successful extension
3103 Semantic invariants:
3105 I1. The number of ACCEPTED locks in S->fileLocks are
3106 (S->sharedLocks + S->exclusiveLocks)
3108 External invariants:
3110 I3. S->serverLock is the lock that we have asserted with the
3111 AFS file server for this cm_scache_t.
3113 I4. S->serverLock == LockRead iff there is at least one ACTIVE
3114 shared lock, but no ACTIVE exclusive locks.
3116 I5. S->serverLock == LockWrite iff there is at least one ACTIVE
3119 I6. If L is a LOST lock, then for each lock M in S->fileLocks,
3120 M->key == L->key IMPLIES M is LOST or DELETED.
3125 #define IS_LOCK_ACTIVE(lockp) (((lockp)->flags & (CM_FILELOCK_FLAG_DELETED|CM_FILELOCK_FLAG_WAITLOCK|CM_FILELOCK_FLAG_WAITUNLOCK|CM_FILELOCK_FLAG_LOST)) == 0)
3127 #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)
3129 #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)
3131 #define IS_LOCK_LOST(lockp) (((lockp)->flags & (CM_FILELOCK_FLAG_DELETED|CM_FILELOCK_FLAG_LOST)) == CM_FILELOCK_FLAG_LOST)
3133 #define IS_LOCK_DELETED(lockp) (((lockp)->flags & CM_FILELOCK_FLAG_DELETED) == CM_FILELOCK_FLAG_DELETED)
3136 #define IS_LOCK_ACCEPTED(lockp) (IS_LOCK_ACTIVE(lockp) || IS_LOCK_WAITLOCK(lockp))
3139 #define IS_LOCK_CLIENTONLY(lockp) ((((lockp)->scp->flags & CM_SCACHEFLAG_RO) == CM_SCACHEFLAG_RO) || (((lockp)->flags & CM_FILELOCK_FLAG_CLIENTONLY) == CM_FILELOCK_FLAG_CLIENTONLY))
3142 #define INTERSECT_RANGE(r1,r2) (((r2).offset+(r2).length) > (r1).offset && ((r1).offset +(r1).length) > (r2).offset)
3145 #define CONTAINS_RANGE(r1,r2) (((r2).offset+(r2).length) <= ((r1).offset+(r1).length) && (r1).offset <= (r2).offset)
3147 #if defined(VICED_CAPABILITY_USE_BYTE_RANGE_LOCKS) && !defined(LOCK_TESTING)
3148 #define SCP_SUPPORTS_BRLOCKS(scp) ((scp)->cbServerp && ((scp)->cbServerp->capabilities & VICED_CAPABILITY_USE_BYTE_RANGE_LOCKS))
3150 #define SCP_SUPPORTS_BRLOCKS(scp) (1)
3153 #define SERVERLOCKS_ENABLED(scp) (!((scp)->flags & CM_SCACHEFLAG_RO) && cm_enableServerLocks && SCP_SUPPORTS_BRLOCKS(scp))
3155 static void cm_LockRangeSubtract(cm_range_t * pos, const cm_range_t * neg)
3157 afs_int64 int_begin;
3160 int_begin = MAX(pos->offset, neg->offset);
3161 int_end = MIN(pos->offset+pos->length, neg->offset+neg->length);
3163 if (int_begin < int_end) {
3164 if (int_begin == pos->offset) {
3165 pos->length = pos->offset + pos->length - int_end;
3166 pos->offset = int_end;
3167 } else if (int_end == pos->offset + pos->length) {
3168 pos->length = int_begin - pos->offset;
3171 /* We only subtract ranges if the resulting range is
3172 contiguous. If we try to support non-contigous ranges, we
3173 aren't actually improving performance. */
3177 /* Called with scp->mx held. Returns 0 if all is clear to read the
3178 specified range by the client identified by key.
3180 long cm_LockCheckRead(cm_scache_t *scp,
3181 LARGE_INTEGER LOffset,
3182 LARGE_INTEGER LLength,
3185 #ifndef ADVISORY_LOCKS
3187 cm_file_lock_t *fileLock;
3191 int substract_ranges = FALSE;
3193 range.offset = LOffset.QuadPart;
3194 range.length = LLength.QuadPart;
3198 1. for all _a_ in (Offset,+Length), all of the following is true:
3200 1.1 For each ACTIVE lock L in S->fileLocks such that _a_ in
3201 (L->LOffset,+L->LLength); L->key == Key(C) OR L->LockType is
3204 1.2 For each LOST lock L in S->fileLocks such that _a_ in
3205 (L->LOffset,+L->LLength); L->LockType is shared AND L->key !=
3210 lock_ObtainRead(&cm_scacheLock);
3212 for (q = scp->fileLocksH; q && range.length > 0; q = osi_QNext(q)) {
3214 (cm_file_lock_t *)((char *) q - offsetof(cm_file_lock_t, fileq));
3216 if (INTERSECT_RANGE(range, fileLock->range)) {
3217 if (IS_LOCK_ACTIVE(fileLock)) {
3218 if (fileLock->key == key) {
3220 /* If there is an active lock for this client, it
3221 is safe to substract ranges.*/
3222 cm_LockRangeSubtract(&range, &fileLock->range);
3223 substract_ranges = TRUE;
3225 if (fileLock->lockType != LockRead) {
3226 code = CM_ERROR_LOCK_CONFLICT;
3230 /* even if the entire range is locked for reading,
3231 we still can't grant the lock at this point
3232 because the client may have lost locks. That
3233 is, unless we have already seen an active lock
3234 belonging to the client, in which case there
3235 can't be any lost locks for this client. */
3236 if (substract_ranges)
3237 cm_LockRangeSubtract(&range, &fileLock->range);
3239 } else if (IS_LOCK_LOST(fileLock) &&
3240 (fileLock->key == key || fileLock->lockType == LockWrite)) {
3241 code = CM_ERROR_BADFD;
3247 lock_ReleaseRead(&cm_scacheLock);
3249 osi_Log4(afsd_logp, "cm_LockCheckRead scp 0x%x offset %d length %d code 0x%x",
3250 scp, (unsigned long)LOffset.QuadPart, (unsigned long)LLength.QuadPart, code);
3261 /* Called with scp->mx held. Returns 0 if all is clear to write the
3262 specified range by the client identified by key.
3264 long cm_LockCheckWrite(cm_scache_t *scp,
3265 LARGE_INTEGER LOffset,
3266 LARGE_INTEGER LLength,
3269 #ifndef ADVISORY_LOCKS
3271 cm_file_lock_t *fileLock;
3276 range.offset = LOffset.QuadPart;
3277 range.length = LLength.QuadPart;
3280 A client C can WRITE range (Offset,+Length) of cm_scache_t S iff (2):
3282 2. for all _a_ in (Offset,+Length), one of the following is true:
3284 2.1 Byte _a_ of S is unowned AND there does not exist a LOST
3285 lock L such that _a_ in (L->LOffset,+L->LLength).
3287 2.2 Byte _a_ of S is owned by C under lock L AND L->LockType is
3291 lock_ObtainRead(&cm_scacheLock);
3293 for (q = scp->fileLocksH; q && range.length > 0; q = osi_QNext(q)) {
3295 (cm_file_lock_t *)((char *) q - offsetof(cm_file_lock_t, fileq));
3297 if (INTERSECT_RANGE(range, fileLock->range)) {
3298 if (IS_LOCK_ACTIVE(fileLock)) {
3299 if (fileLock->key == key) {
3300 if (fileLock->lockType == LockWrite) {
3302 /* if there is an active lock for this client, it
3303 is safe to substract ranges */
3304 cm_LockRangeSubtract(&range, &fileLock->range);
3306 code = CM_ERROR_LOCK_CONFLICT;
3310 code = CM_ERROR_LOCK_CONFLICT;
3313 } else if (IS_LOCK_LOST(fileLock)) {
3314 code = CM_ERROR_BADFD;
3320 lock_ReleaseRead(&cm_scacheLock);
3322 osi_Log4(afsd_logp, "cm_LockCheckWrite scp 0x%x offset %d length %d code 0x%x",
3323 scp, (unsigned long)LOffset.QuadPart, (unsigned long)LLength.QuadPart, code);
3335 static void cm_LockMarkSCacheLost(cm_scache_t * scp);
3337 /* Called with cm_scacheLock write locked */
3338 static cm_file_lock_t * cm_GetFileLock(void) {
3341 l = (cm_file_lock_t *) cm_freeFileLocks;
3343 osi_QRemove(&cm_freeFileLocks, &l->q);
3345 l = malloc(sizeof(cm_file_lock_t));
3349 memset(l, 0, sizeof(cm_file_lock_t));
3354 /* Called with cm_scacheLock write locked */
3355 static void cm_PutFileLock(cm_file_lock_t *l) {
3356 osi_QAdd(&cm_freeFileLocks, &l->q);
3359 /* called with scp->mx held. May release it during processing, but
3360 leaves it held on exit. */
3361 long cm_IntSetLock(cm_scache_t * scp, cm_user_t * userp, int lockType,
3367 struct rx_connection * callp;
3370 tfid.Volume = scp->fid.volume;
3371 tfid.Vnode = scp->fid.vnode;
3372 tfid.Unique = scp->fid.unique;
3375 osi_Log2(afsd_logp, "CALL SetLock scp 0x%p for lock %d", scp, lockType);
3377 lock_ReleaseMutex(&scp->mx);
3380 code = cm_Conn(&cfid, userp, reqp, &connp);
3384 callp = cm_GetRxConn(connp);
3385 code = RXAFS_SetLock(callp, &tfid, lockType,
3387 rx_PutConnection(callp);
3389 } while (cm_Analyze(connp, userp, reqp, &cfid, &volSync,
3392 code = cm_MapRPCError(code, reqp);
3394 osi_Log1(afsd_logp, "CALL SetLock FAILURE, code 0x%x", code);
3396 osi_Log0(afsd_logp, "CALL SetLock SUCCESS");
3399 lock_ObtainMutex(&scp->mx);
3404 /* called with scp->mx held. Releases it during processing */
3405 long cm_IntReleaseLock(cm_scache_t * scp, cm_user_t * userp,
3411 struct rx_connection * callp;
3414 tfid.Volume = scp->fid.volume;
3415 tfid.Vnode = scp->fid.vnode;
3416 tfid.Unique = scp->fid.unique;
3419 lock_ReleaseMutex(&scp->mx);
3421 osi_Log1(afsd_logp, "CALL ReleaseLock scp 0x%p", scp);
3424 code = cm_Conn(&cfid, userp, reqp, &connp);
3428 callp = cm_GetRxConn(connp);
3429 code = RXAFS_ReleaseLock(callp, &tfid, &volSync);
3430 rx_PutConnection(callp);
3432 } while (cm_Analyze(connp, userp, reqp, &cfid, &volSync,
3434 code = cm_MapRPCError(code, reqp);
3437 "CALL ReleaseLock FAILURE, code 0x%x", code);
3440 "CALL ReleaseLock SUCCESS");
3442 lock_ObtainMutex(&scp->mx);
3447 /* called with scp->mx held. May release it during processing, but
3448 will exit with lock held.
3452 - 0 if the user has permission to get the specified lock for the scp
3454 - CM_ERROR_NOACCESS if not
3456 Any other error from cm_SyncOp will be sent down untranslated.
3458 long cm_LockCheckPerms(cm_scache_t * scp,
3466 /* lock permissions are slightly tricky because of the 'i' bit.
3467 If the user has PRSFS_LOCK, she can read-lock the file. If the
3468 user has PRSFS_WRITE, she can write-lock the file. However, if
3469 the user has PRSFS_INSERT, then she can write-lock new files,
3470 but not old ones. Since we don't have information about
3471 whether a file is new or not, we assume that if the user owns
3472 the scp, then she has the permissions that are granted by
3475 osi_Log3(afsd_logp, "cm_LockCheckPerms for scp[0x%p] type[%d] user[0x%p]",
3476 scp, lock_type, userp);
3478 if (lock_type == LockRead)
3479 rights |= PRSFS_LOCK;
3480 else if (lock_type == LockWrite)
3481 rights |= PRSFS_WRITE;
3488 code = cm_SyncOp(scp, NULL, userp, reqp, rights,
3489 CM_SCACHESYNC_GETSTATUS |
3490 CM_SCACHESYNC_NEEDCALLBACK);
3492 if (code == CM_ERROR_NOACCESS &&
3493 lock_type == LockWrite &&
3494 scp->creator == userp) {
3495 /* check for PRSFS_INSERT. */
3497 code = cm_SyncOp(scp, NULL, userp, reqp, PRSFS_INSERT,
3498 CM_SCACHESYNC_GETSTATUS |
3499 CM_SCACHESYNC_NEEDCALLBACK);
3501 if (code == CM_ERROR_NOACCESS)
3502 osi_Log0(afsd_logp, "cm_LockCheckPerms user is creator but has no INSERT bits for scp");
3505 osi_Log1(afsd_logp, "cm_LockCheckPerms returning code %d", code);
3510 /* called with scp->mx held */
3511 long cm_Lock(cm_scache_t *scp, unsigned char sLockType,
3512 LARGE_INTEGER LOffset, LARGE_INTEGER LLength,
3514 int allowWait, cm_user_t *userp, cm_req_t *reqp,
3515 cm_file_lock_t **lockpp)
3518 int Which = ((sLockType & LOCKING_ANDX_SHARED_LOCK) ? LockRead : LockWrite);
3519 cm_file_lock_t *fileLock;
3522 int wait_unlock = FALSE;
3523 int force_client_lock = FALSE;
3525 osi_Log4(afsd_logp, "cm_Lock scp 0x%x type 0x%x offset %d length %d",
3526 scp, sLockType, (unsigned long)LOffset.QuadPart, (unsigned long)LLength.QuadPart);
3527 osi_Log3(afsd_logp, "... allowWait %d key 0x%x:%x", allowWait,
3528 (unsigned long)(key >> 32), (unsigned long)(key & 0xffffffff));
3531 A client C can OBTAIN a lock L on cm_scache_t S iff (both 3 and 4):
3533 3. for all _a_ in (L->LOffset,+L->LLength), ALL of the following is
3536 3.1 If L->LockType is exclusive then there does NOT exist a
3537 ACCEPTED lock M in S->fileLocks such that _a_ in
3538 (M->LOffset,+M->LLength).
3540 3.2 If L->LockType is shared then for each ACCEPTED lock M in
3541 S->fileLocks, if _a_ in (M->LOffset,+M->LLength) then
3542 M->LockType is shared.
3544 4. For all LOST locks M in S->fileLocks, ALL of the following are true:
3546 4.1 M->key != Key(C)
3548 4.2 If M->LockType is exclusive, then (L->LOffset,+L->LLength)
3549 and (M->LOffset,+M->LLength) do not intersect.
3552 range.offset = LOffset.QuadPart;
3553 range.length = LLength.QuadPart;
3555 lock_ObtainRead(&cm_scacheLock);
3557 for (q = scp->fileLocksH; q; q = osi_QNext(q)) {
3559 (cm_file_lock_t *)((char *) q - offsetof(cm_file_lock_t, fileq));
3561 if (IS_LOCK_LOST(fileLock)) {
3562 if (fileLock->key == key) {
3563 code = CM_ERROR_BADFD;
3565 } else if (fileLock->lockType == LockWrite && INTERSECT_RANGE(range, fileLock->range)) {
3566 code = CM_ERROR_WOULDBLOCK;
3572 /* we don't need to check for deleted locks here since deleted
3573 locks are dequeued from scp->fileLocks */
3574 if (IS_LOCK_ACCEPTED(fileLock) &&
3575 INTERSECT_RANGE(range, fileLock->range)) {
3577 if ((sLockType & LOCKING_ANDX_SHARED_LOCK) == 0 ||
3578 fileLock->lockType != LockRead) {
3580 code = CM_ERROR_WOULDBLOCK;
3586 lock_ReleaseRead(&cm_scacheLock);
3588 if (code == 0 && SERVERLOCKS_ENABLED(scp)) {
3589 if (Which == scp->serverLock ||
3590 (Which == LockRead && scp->serverLock == LockWrite)) {
3592 /* we already have the lock we need */
3593 osi_Log3(afsd_logp, " we already have the correct lock. exclusives[%d], shared[%d], serverLock[%d]",
3594 scp->exclusiveLocks, scp->sharedLocks, (int)(signed char) scp->serverLock);
3596 code = cm_LockCheckPerms(scp, Which, userp, reqp);
3598 /* special case: if we don't have permission to read-lock
3599 the file, then we force a clientside lock. This is to
3600 compensate for applications that obtain a read-lock for
3601 reading files off of directories that don't grant
3602 read-locks to the user. */
3603 if (code == CM_ERROR_NOACCESS && Which == LockRead) {
3604 osi_Log0(afsd_logp, " User has no read-lock perms. Forcing client-side lock");
3605 force_client_lock = TRUE;
3608 } else if ((scp->exclusiveLocks > 0) ||
3609 (scp->sharedLocks > 0 && scp->serverLock != LockRead)) {
3611 /* We are already waiting for some other lock. We should
3612 wait for the daemon to catch up instead of generating a
3613 flood of SetLock calls. */
3614 osi_Log3(afsd_logp, " already waiting for other lock. exclusives[%d], shared[%d], serverLock[%d]",
3615 scp->exclusiveLocks, scp->sharedLocks, (int)(signed char) scp->serverLock);
3617 /* see if we have permission to create the lock in the
3619 code = cm_LockCheckPerms(scp, Which, userp, reqp);
3621 code = CM_ERROR_WOULDBLOCK;
3622 else if (code == CM_ERROR_NOACCESS && Which == LockRead) {
3623 osi_Log0(afsd_logp, " User has no read-lock perms. Forcing client-side lock");
3624 force_client_lock = TRUE;
3627 /* leave any other codes as-is */
3631 int check_data_version = FALSE;
3633 /* first check if we have permission to elevate or obtain
3635 code = cm_LockCheckPerms(scp, Which, userp, reqp);
3637 if (code == CM_ERROR_NOACCESS && Which == LockRead) {
3638 osi_Log0(afsd_logp, " User has no read-lock perms. Forcing client-side lock");
3639 force_client_lock = TRUE;
3644 if (scp->serverLock == LockRead && Which == LockWrite) {
3646 /* We want to escalate the lock to a LockWrite.
3647 Unfortunately that's not really possible without
3648 letting go of the current lock. But for now we do
3652 " attempting to UPGRADE from LockRead to LockWrite.");
3654 " dataVersion on scp: %d", scp->dataVersion);
3656 /* we assume at this point (because scp->serverLock
3657 was valid) that we had a valid server lock. */
3658 scp->lockDataVersion = scp->dataVersion;
3659 check_data_version = TRUE;
3661 code = cm_IntReleaseLock(scp, userp, reqp);
3664 /* We couldn't release the lock */
3667 scp->serverLock = -1;
3671 /* We need to obtain a server lock of type Which in order
3672 to assert this file lock */
3673 #ifndef AGGRESSIVE_LOCKS
3676 newLock = LockWrite;
3678 code = cm_IntSetLock(scp, userp, newLock, reqp);
3680 if (code == CM_ERROR_WOULDBLOCK && newLock != Which) {
3681 /* we wanted LockRead. We tried LockWrite. Now try
3686 osi_assert(newLock == LockRead);
3688 code = cm_IntSetLock(scp, userp, newLock, reqp);
3691 if (code == 0 && check_data_version &&
3692 scp->dataVersion != scp->lockDataVersion) {
3693 /* We lost a race. Although we successfully obtained
3694 a lock, someone modified the file in between. The
3695 locks have all been technically lost. */
3698 " Data version mismatch while upgrading lock.");
3700 " Data versions before=%d, after=%d",
3701 scp->lockDataVersion,
3704 " Releasing stale lock for scp 0x%x", scp);
3706 code = cm_IntReleaseLock(scp, userp, reqp);
3708 scp->serverLock = -1;
3710 code = CM_ERROR_INVAL;
3711 } else if (code == 0) {
3712 scp->serverLock = newLock;
3713 scp->lockDataVersion = scp->dataVersion;
3717 (scp->sharedLocks > 0 || scp->exclusiveLocks > 0) &&
3718 scp->serverLock == -1) {
3719 /* Oops. We lost the lock. */
3720 cm_LockMarkSCacheLost(scp);
3723 } else if (code == 0) { /* server locks not enabled */
3725 " Skipping server lock for scp");
3730 if (code != 0 && !force_client_lock) {
3731 /* Special case error translations
3733 Applications don't expect certain errors from a
3734 LockFile/UnlockFile call. We need to translate some error
3735 code to codes that apps expect and handle. */
3737 /* We shouldn't actually need to handle this case since we
3738 simulate locks for RO scps anyway. */
3739 if (code == CM_ERROR_READONLY) {
3740 osi_Log0(afsd_logp, " Reinterpreting CM_ERROR_READONLY as CM_ERROR_NOACCESS");
3741 code = CM_ERROR_NOACCESS;
3745 if (code == 0 || (code == CM_ERROR_WOULDBLOCK && allowWait) ||
3746 force_client_lock) {
3748 /* clear the error if we are forcing a client lock, so we
3749 don't get confused later. */
3750 if (force_client_lock && code != CM_ERROR_WOULDBLOCK)
3753 lock_ObtainWrite(&cm_scacheLock);
3754 fileLock = cm_GetFileLock();
3755 lock_ReleaseWrite(&cm_scacheLock);
3757 fileLock->fid = scp->fid;
3759 fileLock->key = key;
3760 fileLock->lockType = Which;
3762 fileLock->userp = userp;
3763 fileLock->range = range;
3764 fileLock->flags = (code == 0 ? 0 :
3766 CM_FILELOCK_FLAG_WAITUNLOCK :
3767 CM_FILELOCK_FLAG_WAITLOCK));
3769 if (force_client_lock || !SERVERLOCKS_ENABLED(scp))
3770 fileLock->flags |= CM_FILELOCK_FLAG_CLIENTONLY;
3772 fileLock->lastUpdate = (code == 0 && !force_client_lock) ? time(NULL) : 0;
3774 lock_ObtainWrite(&cm_scacheLock);
3775 osi_QAddT(&scp->fileLocksH, &scp->fileLocksT, &fileLock->fileq);
3776 cm_HoldSCacheNoLock(scp);
3777 fileLock->scp = scp;
3778 osi_QAdd(&cm_allFileLocks, &fileLock->q);
3779 lock_ReleaseWrite(&cm_scacheLock);
3785 if (IS_LOCK_CLIENTONLY(fileLock)) {
3787 } else if (IS_LOCK_ACCEPTED(fileLock)) {
3788 if (Which == LockRead)
3791 scp->exclusiveLocks++;
3795 "cm_Lock Lock added 0x%p flags 0x%x to scp [0x%p]",
3796 fileLock, fileLock->flags, scp);
3798 " exclusives[%d] shared[%d] client[%d] serverLock[%d]",
3799 scp->exclusiveLocks, scp->sharedLocks, scp->clientLocks,
3800 (int)(signed char) scp->serverLock);
3803 "cm_Lock Rejecting lock (code = 0x%x)", code);
3809 static int cm_KeyEquals(cm_key_t k1, cm_key_t k2, int flags);
3811 /* Called with scp->mx held */
3812 long cm_UnlockByKey(cm_scache_t * scp,
3819 cm_file_lock_t *fileLock;
3820 osi_queue_t *q, *qn;
3823 osi_Log4(afsd_logp, "cm_UnlockByKey scp 0x%p key 0x%x:%x flags=0x%x",
3825 (unsigned long)(key >> 32),
3826 (unsigned long)(key & 0xffffffff),
3829 lock_ObtainWrite(&cm_scacheLock);
3831 for (q = scp->fileLocksH; q; q = qn) {
3834 fileLock = (cm_file_lock_t *)
3835 ((char *) q - offsetof(cm_file_lock_t, fileq));
3838 osi_Log4(afsd_logp, " Checking lock[0x%x] range[%d,+%d] type[%d]",
3840 (unsigned long) fileLock->range.offset,
3841 (unsigned long) fileLock->range.length,
3842 fileLock->lockType);
3843 osi_Log3(afsd_logp, " key[0x%x:%x] flags[0x%x]",
3844 (unsigned long)(fileLock->key >> 32),
3845 (unsigned long)(fileLock->key & 0xffffffff),
3848 if (cm_FidCmp(&fileLock->fid, &fileLock->scp->fid)) {
3849 osi_Log0(afsd_logp, "!!fileLock->fid != scp->fid");
3850 osi_Log4(afsd_logp, " fileLock->fid(cell=[%d], volume=[%d], vnode=[%d], unique=[%d]",
3852 fileLock->fid.volume,
3853 fileLock->fid.vnode,
3854 fileLock->fid.unique);
3855 osi_Log4(afsd_logp, " scp->fid(cell=[%d], volume=[%d], vnode=[%d], unique=[%d]",
3856 fileLock->scp->fid.cell,
3857 fileLock->scp->fid.volume,
3858 fileLock->scp->fid.vnode,
3859 fileLock->scp->fid.unique);
3864 if (!IS_LOCK_DELETED(fileLock) &&
3865 cm_KeyEquals(fileLock->key, key, flags)) {
3866 osi_Log3(afsd_logp, "...Unlock range [%d,+%d] type %d",
3867 fileLock->range.offset,
3868 fileLock->range.length,
3869 fileLock->lockType);
3871 if (scp->fileLocksT == q)
3872 scp->fileLocksT = osi_QPrev(q);
3873 osi_QRemoveHT(&scp->fileLocksH, &scp->fileLocksT, q);
3875 if (IS_LOCK_CLIENTONLY(fileLock)) {
3877 } else if (IS_LOCK_ACCEPTED(fileLock)) {
3878 if (fileLock->lockType == LockRead)
3881 scp->exclusiveLocks--;
3884 fileLock->flags |= CM_FILELOCK_FLAG_DELETED;
3886 cm_ReleaseUser(fileLock->userp);
3887 cm_ReleaseSCacheNoLock(scp);
3889 fileLock->userp = NULL;
3890 fileLock->scp = NULL;
3896 lock_ReleaseWrite(&cm_scacheLock);
3898 if (n_unlocks == 0) {
3899 osi_Log0(afsd_logp, "cm_UnlockByKey no locks found");
3900 osi_Log3(afsd_logp, " Leaving scp with exclusives[%d], shared[%d], serverLock[%d]",
3901 scp->exclusiveLocks, scp->sharedLocks, (int)(signed char) scp->serverLock);
3906 osi_Log1(afsd_logp, "cm_UnlockByKey done with %d locks", n_unlocks);
3908 osi_assertx(scp->sharedLocks >= 0, "scp->sharedLocks < 0");
3909 osi_assertx(scp->exclusiveLocks >= 0, "scp->exclusiveLocks < 0");
3910 osi_assertx(scp->clientLocks >= 0, "scp->clientLocks < 0");
3912 if (!SERVERLOCKS_ENABLED(scp)) {
3913 osi_Log0(afsd_logp, " Skipping server lock for scp");
3917 /* Ideally we would go through the rest of the locks to determine
3918 * if one or more locks that were formerly in WAITUNLOCK can now
3919 * be put to ACTIVE or WAITLOCK and update scp->exclusiveLocks and
3920 * scp->sharedLocks accordingly. However, the retrying of locks
3921 * in that manner is done cm_RetryLock() manually.
3924 if (scp->serverLock == LockWrite &&
3925 scp->exclusiveLocks == 0 &&
3926 scp->sharedLocks > 0) {
3928 /* The serverLock should be downgraded to LockRead */
3929 osi_Log0(afsd_logp, " DOWNGRADE lock from LockWrite to LockRead");
3931 /* since scp->serverLock looked sane, we are going to assume
3932 that we have a valid server lock. */
3933 scp->lockDataVersion = scp->dataVersion;
3934 osi_Log1(afsd_logp, " dataVersion on scp = %d", scp->dataVersion);
3936 code = cm_IntReleaseLock(scp, userp, reqp);
3939 /* so we couldn't release it. Just let the lock be for now */
3943 scp->serverLock = -1;
3946 code = cm_IntSetLock(scp, userp, LockRead, reqp);
3948 if (code == 0 && scp->lockDataVersion == scp->dataVersion) {
3949 scp->serverLock = LockRead;
3950 } else if (code == 0 && scp->lockDataVersion != scp->dataVersion) {
3951 /* We lost a race condition. Although we have a valid
3952 lock on the file, the data has changed and essentially
3953 we have lost the lock we had during the transition. */
3955 osi_Log0(afsd_logp, "Data version mismatch during lock downgrade");
3956 osi_Log2(afsd_logp, " Data versions before=%d, after=%d",
3957 scp->lockDataVersion,
3960 code = cm_IntReleaseLock(scp, userp, reqp);
3962 code = CM_ERROR_INVAL;
3963 scp->serverLock = -1;
3967 (scp->sharedLocks > 0 || scp->exclusiveLocks > 0) &&
3968 (scp->serverLock == -1)) {
3970 cm_LockMarkSCacheLost(scp);
3973 /* failure here has no bearing on the return value of
3977 } else if (scp->serverLock != (-1) &&
3978 scp->exclusiveLocks == 0 &&
3979 scp->sharedLocks == 0) {
3980 /* The serverLock should be released entirely */
3982 code = cm_IntReleaseLock(scp, userp, reqp);
3985 scp->serverLock = (-1);
3990 osi_Log1(afsd_logp, "cm_UnlockByKey code 0x%x", code);
3991 osi_Log4(afsd_logp, " Leaving scp with excl[%d], shared[%d], client[%d], serverLock[%d]",
3992 scp->exclusiveLocks, scp->sharedLocks, scp->clientLocks,
3993 (int)(signed char) scp->serverLock);
3998 long cm_Unlock(cm_scache_t *scp,
3999 unsigned char sLockType,
4000 LARGE_INTEGER LOffset, LARGE_INTEGER LLength,
4006 int Which = ((sLockType & LOCKING_ANDX_SHARED_LOCK) ? LockRead : LockWrite);
4007 cm_file_lock_t *fileLock;
4009 int release_userp = FALSE;
4011 osi_Log4(afsd_logp, "cm_Unlock scp 0x%p type 0x%x offset %d length %d",
4012 scp, sLockType, (unsigned long)LOffset.QuadPart, (unsigned long)LLength.QuadPart);
4013 osi_Log2(afsd_logp, "... key 0x%x:%x",
4014 (unsigned long) (key >> 32), (unsigned long) (key & 0xffffffff));
4016 lock_ObtainRead(&cm_scacheLock);
4018 for (q = scp->fileLocksH; q; q = osi_QNext(q)) {
4019 fileLock = (cm_file_lock_t *)
4020 ((char *) q - offsetof(cm_file_lock_t, fileq));
4023 if (cm_FidCmp(&fileLock->fid, &fileLock->scp->fid)) {
4024 osi_Log0(afsd_logp, "!!fileLock->fid != scp->fid");
4025 osi_Log4(afsd_logp, " fileLock->fid(cell=[%d], volume=[%d], vnode=[%d], unique=[%d]",
4027 fileLock->fid.volume,
4028 fileLock->fid.vnode,
4029 fileLock->fid.unique);
4030 osi_Log4(afsd_logp, " scp->fid(cell=[%d], volume=[%d], vnode=[%d], unique=[%d]",
4031 fileLock->scp->fid.cell,
4032 fileLock->scp->fid.volume,
4033 fileLock->scp->fid.vnode,
4034 fileLock->scp->fid.unique);
4038 if (!IS_LOCK_DELETED(fileLock) &&
4039 fileLock->key == key &&
4040 fileLock->range.offset == LOffset.QuadPart &&
4041 fileLock->range.length == LLength.QuadPart) {
4047 osi_Log0(afsd_logp, "cm_Unlock lock not found; failure");
4049 lock_ReleaseRead(&cm_scacheLock);
4051 /* The lock didn't exist anyway. *shrug* */
4055 lock_ReleaseRead(&cm_scacheLock);
4057 /* discard lock record */
4058 lock_ObtainWrite(&cm_scacheLock);
4059 if (scp->fileLocksT == q)
4060 scp->fileLocksT = osi_QPrev(q);
4061 osi_QRemoveHT(&scp->fileLocksH, &scp->fileLocksT, q);
4064 * Don't delete it here; let the daemon delete it, to simplify
4065 * the daemon's traversal of the list.
4068 if (IS_LOCK_CLIENTONLY(fileLock)) {
4070 } else if (IS_LOCK_ACCEPTED(fileLock)) {
4071 if (fileLock->lockType == LockRead)
4074 scp->exclusiveLocks--;
4077 fileLock->flags |= CM_FILELOCK_FLAG_DELETED;
4078 if (userp != NULL) {
4079 cm_ReleaseUser(fileLock->userp);
4081 userp = fileLock->userp;
4082 release_userp = TRUE;
4084 fileLock->userp = NULL;
4085 cm_ReleaseSCacheNoLock(scp);
4086 fileLock->scp = NULL;
4087 lock_ReleaseWrite(&cm_scacheLock);
4089 if (!SERVERLOCKS_ENABLED(scp)) {
4090 osi_Log0(afsd_logp, " Skipping server locks for scp");
4094 /* Ideally we would go through the rest of the locks to determine
4095 * if one or more locks that were formerly in WAITUNLOCK can now
4096 * be put to ACTIVE or WAITLOCK and update scp->exclusiveLocks and
4097 * scp->sharedLocks accordingly. However, the retrying of locks
4098 * in that manner is done cm_RetryLock() manually.
4101 if (scp->serverLock == LockWrite &&
4102 scp->exclusiveLocks == 0 &&
4103 scp->sharedLocks > 0) {
4105 /* The serverLock should be downgraded to LockRead */
4106 osi_Log0(afsd_logp, " DOWNGRADE lock from LockWrite to LockRead");
4108 /* Since we already had a lock, we assume that there is a
4109 valid server lock. */
4110 scp->lockDataVersion = scp->dataVersion;
4111 osi_Log1(afsd_logp, " dataVersion on scp is %d", scp->dataVersion);
4113 code = cm_IntReleaseLock(scp, userp, reqp);
4116 /* so we couldn't release it. Just let the lock be for now */
4120 scp->serverLock = -1;
4123 code = cm_IntSetLock(scp, userp, LockRead, reqp);
4125 if (code == 0 && scp->lockDataVersion == scp->dataVersion) {
4126 scp->serverLock = LockRead;
4127 } else if (code == 0 && scp->lockDataVersion != scp->dataVersion) {
4128 /* Lost a race. We obtained a new lock, but that is
4129 meaningless since someone modified the file
4133 "Data version mismatch while downgrading lock");
4135 " Data versions before=%d, after=%d",
4136 scp->lockDataVersion,
4139 code = cm_IntReleaseLock(scp, userp, reqp);
4141 scp->serverLock = -1;
4142 code = CM_ERROR_INVAL;
4146 (scp->sharedLocks > 0 || scp->exclusiveLocks > 0) &&
4147 (scp->serverLock == -1)) {
4149 cm_LockMarkSCacheLost(scp);
4152 /* failure here has no bearing on the return value of
4156 } else if (scp->serverLock != (-1) &&
4157 scp->exclusiveLocks == 0 &&
4158 scp->sharedLocks == 0) {
4159 /* The serverLock should be released entirely */
4161 code = cm_IntReleaseLock(scp, userp, reqp);
4164 scp->serverLock = (-1);
4169 cm_ReleaseUser(userp);
4173 osi_Log1(afsd_logp, "cm_Unlock code 0x%x", code);
4174 osi_Log4(afsd_logp, " leaving scp with excl[%d], shared[%d], client[%d], serverLock[%d]",
4175 scp->exclusiveLocks, scp->sharedLocks, scp->clientLocks,
4176 (int)(signed char) scp->serverLock);
4181 /* called with scp->mx held */
4182 static void cm_LockMarkSCacheLost(cm_scache_t * scp)
4184 cm_file_lock_t *fileLock;
4187 osi_Log1(afsd_logp, "cm_LockMarkSCacheLost scp 0x%x", scp);
4190 /* With the current code, we can't lose a lock on a RO scp */
4191 osi_assert(!(scp->flags & CM_SCACHEFLAG_RO));
4194 /* cm_scacheLock needed because we are modifying fileLock->flags */
4195 lock_ObtainWrite(&cm_scacheLock);
4197 for (q = scp->fileLocksH; q; q = osi_QNext(q)) {
4199 (cm_file_lock_t *)((char *) q - offsetof(cm_file_lock_t, fileq));
4201 if (IS_LOCK_ACTIVE(fileLock) &&
4202 !IS_LOCK_CLIENTONLY(fileLock)) {
4203 if (fileLock->lockType == LockRead)
4206 scp->exclusiveLocks--;
4208 fileLock->flags |= CM_FILELOCK_FLAG_LOST;
4212 scp->serverLock = -1;
4213 scp->lockDataVersion = -1;
4214 lock_ReleaseWrite(&cm_scacheLock);
4217 /* Called with no relevant locks held */
4218 void cm_CheckLocks()
4220 osi_queue_t *q, *nq;
4221 cm_file_lock_t *fileLock;
4227 struct rx_connection * callp;
4232 lock_ObtainWrite(&cm_scacheLock);
4234 cm_lockRefreshCycle++;
4236 osi_Log1(afsd_logp, "cm_CheckLocks starting lock check cycle %d", cm_lockRefreshCycle);
4238 for (q = cm_allFileLocks; q; q = nq) {
4239 fileLock = (cm_file_lock_t *) q;
4243 if (IS_LOCK_DELETED(fileLock)) {
4245 osi_QRemove(&cm_allFileLocks, q);
4246 cm_PutFileLock(fileLock);
4248 } else if (IS_LOCK_ACTIVE(fileLock) && !IS_LOCK_CLIENTONLY(fileLock)) {
4250 /* Server locks must have been enabled for us to have
4251 received an active non-client-only lock. */
4252 osi_assert(cm_enableServerLocks);
4254 scp = fileLock->scp;
4255 osi_assert(scp != NULL);
4257 cm_HoldSCacheNoLock(scp);
4260 if (cm_FidCmp(&fileLock->fid, &fileLock->scp->fid)) {
4261 osi_Log0(afsd_logp, "!!fileLock->fid != scp->fid");
4262 osi_Log4(afsd_logp, " fileLock->fid(cell=[%d], volume=[%d], vnode=[%d], unique=[%d]",
4264 fileLock->fid.volume,
4265 fileLock->fid.vnode,
4266 fileLock->fid.unique);
4267 osi_Log4(afsd_logp, " scp->fid(cell=[%d], volume=[%d], vnode=[%d], unique=[%d]",
4268 fileLock->scp->fid.cell,
4269 fileLock->scp->fid.volume,
4270 fileLock->scp->fid.vnode,
4271 fileLock->scp->fid.unique);
4275 /* Server locks are extended once per scp per refresh
4277 if (scp->lastRefreshCycle != cm_lockRefreshCycle) {
4279 int scp_done = FALSE;
4281 osi_Log1(afsd_logp, "cm_CheckLocks Updating scp 0x%x", scp);
4283 lock_ReleaseWrite(&cm_scacheLock);
4284 lock_ObtainMutex(&scp->mx);
4286 /* did the lock change while we weren't holding the lock? */
4287 if (!IS_LOCK_ACTIVE(fileLock))
4288 goto post_syncopdone;
4290 code = cm_SyncOp(scp, NULL, fileLock->userp, &req, 0,
4291 CM_SCACHESYNC_NEEDCALLBACK
4292 | CM_SCACHESYNC_GETSTATUS
4293 | CM_SCACHESYNC_LOCK);
4297 "cm_CheckLocks SyncOp failure code 0x%x", code);
4298 goto post_syncopdone;
4301 /* cm_SyncOp releases scp->mx during which the lock
4302 may get released. */
4303 if (!IS_LOCK_ACTIVE(fileLock))
4304 goto pre_syncopdone;
4306 if (scp->serverLock != -1) {
4310 tfid.Volume = scp->fid.volume;
4311 tfid.Vnode = scp->fid.vnode;
4312 tfid.Unique = scp->fid.unique;
4314 userp = fileLock->userp;
4316 osi_Log3(afsd_logp, "CALL ExtendLock lock 0x%p for scp=0x%p with lock %d",
4319 (int) scp->serverLock);
4321 lock_ReleaseMutex(&scp->mx);
4324 code = cm_Conn(&cfid, userp,
4329 callp = cm_GetRxConn(connp);
4330 code = RXAFS_ExtendLock(callp, &tfid,
4332 rx_PutConnection(callp);
4334 osi_Log1(afsd_logp, " ExtendLock returns %d", code);
4336 } while (cm_Analyze(connp, userp, &req,
4337 &cfid, &volSync, NULL, NULL,
4340 code = cm_MapRPCError(code, &req);
4342 lock_ObtainMutex(&scp->mx);
4345 osi_Log1(afsd_logp, "CALL ExtendLock FAILURE, code 0x%x", code);
4347 osi_Log0(afsd_logp, "CALL ExtendLock SUCCESS");
4348 scp->lockDataVersion = scp->dataVersion;
4351 if ((code == EINVAL || code == CM_ERROR_INVAL) &&
4352 scp->lockDataVersion == scp->dataVersion) {
4356 (scp->exclusiveLocks > 0) ? LockWrite: LockRead;
4358 /* we might still have a chance to obtain a
4361 code = cm_IntSetLock(scp, userp, lockType, &req);
4364 code = CM_ERROR_INVAL;
4365 } else if (scp->lockDataVersion != scp->dataVersion) {
4367 /* now check if we still have the file at
4368 the right data version. */
4370 "Data version mismatch on scp 0x%p",
4373 " Data versions: before=%d, after=%d",
4374 scp->lockDataVersion,
4377 code = cm_IntReleaseLock(scp, userp, &req);
4379 code = CM_ERROR_INVAL;
4383 if (code == EINVAL || code == CM_ERROR_INVAL) {
4384 cm_LockMarkSCacheLost(scp);
4388 /* interestingly, we have found an active lock
4389 belonging to an scache that has no
4391 cm_LockMarkSCacheLost(scp);
4398 cm_SyncOpDone(scp, NULL, CM_SCACHESYNC_LOCK);
4401 lock_ReleaseMutex(&scp->mx);
4403 lock_ObtainWrite(&cm_scacheLock);
4406 fileLock->lastUpdate = time(NULL);
4410 scp->lastRefreshCycle = cm_lockRefreshCycle;
4413 /* we have already refreshed the locks on this scp */
4414 fileLock->lastUpdate = time(NULL);
4417 cm_ReleaseSCacheNoLock(scp);
4419 } else if (IS_LOCK_ACTIVE(fileLock) && IS_LOCK_CLIENTONLY(fileLock)) {
4420 /* TODO: Check callbacks */
4424 lock_ReleaseWrite(&cm_scacheLock);
4425 osi_Log1(afsd_logp, "cm_CheckLocks completes lock check cycle %d", cm_lockRefreshCycle);
4428 /* NOT called with scp->mx held. */
4429 long cm_RetryLock(cm_file_lock_t *oldFileLock, int client_is_dead)
4432 cm_scache_t *scp = NULL;
4433 cm_file_lock_t *fileLock;
4437 int force_client_lock = FALSE;
4441 if (client_is_dead) {
4442 code = CM_ERROR_TIMEDOUT;
4446 lock_ObtainRead(&cm_scacheLock);
4448 osi_Log2(afsd_logp, "cm_RetryLock checking lock %p (scp=%p)", oldFileLock, oldFileLock->scp);
4449 osi_Log4(afsd_logp, " offset(%x:%x) length(%x:%x)",
4450 (unsigned)(oldFileLock->range.offset >> 32),
4451 (unsigned)(oldFileLock->range.offset & 0xffffffff),
4452 (unsigned)(oldFileLock->range.length >> 32),
4453 (unsigned)(oldFileLock->range.length & 0xffffffff));
4454 osi_Log3(afsd_logp, " key(%x:%x) flags=%x",
4455 (unsigned)(oldFileLock->key >> 32),
4456 (unsigned)(oldFileLock->key & 0xffffffff),
4457 (unsigned)(oldFileLock->flags));
4459 /* if the lock has already been granted, then we have nothing to do */
4460 if (IS_LOCK_ACTIVE(oldFileLock)) {
4461 lock_ReleaseRead(&cm_scacheLock);
4462 osi_Log0(afsd_logp, "cm_RetryLock lock already granted");
4466 /* we can't do anything with lost or deleted locks at the moment. */
4467 if (IS_LOCK_LOST(oldFileLock) || IS_LOCK_DELETED(oldFileLock)) {
4468 code = CM_ERROR_BADFD;
4469 osi_Log0(afsd_logp, "cm_RetryLock lock is lost or deleted");
4470 lock_ReleaseRead(&cm_scacheLock);
4474 scp = oldFileLock->scp;
4476 osi_assert(scp != NULL);
4478 lock_ReleaseRead(&cm_scacheLock);
4479 lock_ObtainMutex(&scp->mx);
4481 code = cm_LockCheckPerms(scp, oldFileLock->lockType,
4485 if (code == CM_ERROR_NOACCESS && oldFileLock->lockType == LockRead) {
4486 force_client_lock = TRUE;
4489 lock_ReleaseMutex(&scp->mx);
4493 lock_ObtainWrite(&cm_scacheLock);
4495 /* Check if we already have a sufficient server lock to allow this
4496 lock to go through. */
4497 if (IS_LOCK_WAITLOCK(oldFileLock) &&
4498 (!SERVERLOCKS_ENABLED(scp) ||
4499 scp->serverLock == oldFileLock->lockType ||
4500 scp->serverLock == LockWrite)) {
4502 oldFileLock->flags &= ~CM_FILELOCK_FLAG_WAITLOCK;
4504 if (SERVERLOCKS_ENABLED(scp)) {
4505 osi_Log1(afsd_logp, "cm_RetryLock Server lock (%d) is sufficient for lock. Granting",
4506 (int) scp->serverLock);
4508 osi_Log0(afsd_logp, "cm_RetryLock skipping server lock for scp");
4511 lock_ReleaseWrite(&cm_scacheLock);
4512 lock_ReleaseMutex(&scp->mx);
4517 if (IS_LOCK_WAITUNLOCK(oldFileLock)) {
4519 /* check if the conflicting locks have dissappeared already */
4520 for (q = scp->fileLocksH; q; q = osi_QNext(q)) {
4522 fileLock = (cm_file_lock_t *)
4523 ((char *) q - offsetof(cm_file_lock_t, fileq));
4525 if (IS_LOCK_LOST(fileLock)) {
4526 if (fileLock->key == oldFileLock->key) {
4527 code = CM_ERROR_BADFD;
4528 oldFileLock->flags |= CM_FILELOCK_FLAG_LOST;
4529 osi_Log1(afsd_logp, " found lost lock %p for same key. Marking lock as lost",
4532 } else if (fileLock->lockType == LockWrite &&
4533 INTERSECT_RANGE(oldFileLock->range, fileLock->range)) {
4534 osi_Log1(afsd_logp, " found conflicting LOST lock %p", fileLock);
4535 code = CM_ERROR_WOULDBLOCK;
4540 if (IS_LOCK_ACCEPTED(fileLock) &&
4541 INTERSECT_RANGE(oldFileLock->range, fileLock->range)) {
4543 if (oldFileLock->lockType != LockRead ||
4544 fileLock->lockType != LockRead) {
4546 osi_Log1(afsd_logp, " found conflicting lock %p", fileLock);
4547 code = CM_ERROR_WOULDBLOCK;
4555 lock_ReleaseWrite(&cm_scacheLock);
4556 lock_ReleaseMutex(&scp->mx);
4561 /* when we get here, the lock is either a WAITUNLOCK or WAITLOCK.
4562 If it is WAITUNLOCK, then we didn't find any conflicting lock
4563 but we haven't verfied whether the serverLock is sufficient to
4564 assert it. If it is WAITLOCK, then the serverLock is
4565 insufficient to assert it. Eitherway, we are ready to accept
4566 the lock as either ACTIVE or WAITLOCK depending on the
4569 /* First, promote the WAITUNLOCK to a WAITLOCK */
4570 if (IS_LOCK_WAITUNLOCK(oldFileLock)) {
4571 if (oldFileLock->lockType == LockRead)
4574 scp->exclusiveLocks++;
4576 oldFileLock->flags &= ~CM_FILELOCK_FLAG_WAITUNLOCK;
4577 oldFileLock->flags |= CM_FILELOCK_FLAG_WAITLOCK;
4580 if (force_client_lock ||
4581 !SERVERLOCKS_ENABLED(scp) ||
4582 scp->serverLock == oldFileLock->lockType ||
4583 (oldFileLock->lockType == LockRead &&
4584 scp->serverLock == LockWrite)) {
4586 oldFileLock->flags &= ~CM_FILELOCK_FLAG_WAITLOCK;
4588 if ((force_client_lock ||
4589 !SERVERLOCKS_ENABLED(scp)) &&
4590 !IS_LOCK_CLIENTONLY(oldFileLock)) {
4592 oldFileLock->flags |= CM_FILELOCK_FLAG_CLIENTONLY;
4594 if (oldFileLock->lockType == LockRead)
4597 scp->exclusiveLocks--;
4602 lock_ReleaseWrite(&cm_scacheLock);
4603 lock_ReleaseMutex(&scp->mx);
4610 code = cm_SyncOp(scp, NULL, oldFileLock->userp, &req, 0,
4611 CM_SCACHESYNC_NEEDCALLBACK
4612 | CM_SCACHESYNC_GETSTATUS
4613 | CM_SCACHESYNC_LOCK);
4615 osi_Log1(smb_logp, "cm_RetryLock SyncOp failure code 0x%x", code);
4616 lock_ReleaseWrite(&cm_scacheLock);
4617 goto post_syncopdone;
4620 if (!IS_LOCK_WAITLOCK(oldFileLock))
4621 goto pre_syncopdone;
4623 userp = oldFileLock->userp;
4625 #ifndef AGGRESSIVE_LOCKS
4626 newLock = oldFileLock->lockType;
4628 newLock = LockWrite;
4631 lock_ReleaseWrite(&cm_scacheLock);
4633 code = cm_IntSetLock(scp, userp, newLock, &req);
4636 cm_SyncOpDone(scp, NULL, CM_SCACHESYNC_LOCK);
4642 if (code != 0 && code != CM_ERROR_WOULDBLOCK) {
4643 lock_ObtainWrite(&cm_scacheLock);
4644 if (scp->fileLocksT == &oldFileLock->fileq)
4645 scp->fileLocksT = osi_QPrev(&oldFileLock->fileq);
4646 osi_QRemoveHT(&scp->fileLocksH, &scp->fileLocksT, &oldFileLock->fileq);
4647 lock_ReleaseWrite(&cm_scacheLock);
4648 } else if (code == 0 && IS_LOCK_WAITLOCK(oldFileLock)) {
4649 scp->serverLock = newLock;
4651 lock_ReleaseMutex(&scp->mx);
4654 lock_ObtainWrite(&cm_scacheLock);
4656 oldFileLock->flags &= ~CM_FILELOCK_FLAG_WAITLOCK;
4657 } else if (code != CM_ERROR_WOULDBLOCK) {
4658 oldFileLock->flags |= CM_FILELOCK_FLAG_DELETED;
4659 cm_ReleaseUser(oldFileLock->userp);
4660 oldFileLock->userp = NULL;
4661 if (oldFileLock->scp) {
4662 cm_ReleaseSCacheNoLock(oldFileLock->scp);
4663 oldFileLock->scp = NULL;
4666 lock_ReleaseWrite(&cm_scacheLock);
4671 cm_key_t cm_GenerateKey(unsigned int session_id, unsigned long process_id, unsigned int file_id)
4674 osi_assert((process_id & 0xffffffff) == process_id);
4675 osi_assert((session_id & 0xffff) == session_id);
4676 osi_assert((file_id & 0xffff) == file_id);
4680 (((cm_key_t) (process_id & 0xffffffff)) << 32) |
4681 (((cm_key_t) (session_id & 0xffff)) << 16) |
4682 (((cm_key_t) (file_id & 0xffff)));
4685 static int cm_KeyEquals(cm_key_t k1, cm_key_t k2, int flags)
4687 if (flags & CM_UNLOCK_BY_FID) {
4688 return ((k1 & 0xffffffff) == (k2 & 0xffffffff));
4694 void cm_ReleaseAllLocks(void)
4700 cm_file_lock_t *fileLock;
4703 for (i = 0; i < cm_data.hashTableSize; i++)
4705 for ( scp = cm_data.hashTablep[i]; scp; scp = scp->nextp ) {
4706 while (scp->fileLocksH != NULL) {
4707 lock_ObtainMutex(&scp->mx);
4708 lock_ObtainWrite(&cm_scacheLock);
4709 if (!scp->fileLocksH) {
4710 lock_ReleaseWrite(&cm_scacheLock);
4711 lock_ReleaseMutex(&scp->mx);
4714 fileLock = (cm_file_lock_t *)((char *) scp->fileLocksH - offsetof(cm_file_lock_t, fileq));
4715 userp = fileLock->userp;
4717 key = fileLock->key;
4718 cm_HoldSCacheNoLock(scp);
4719 lock_ReleaseWrite(&cm_scacheLock);
4720 cm_UnlockByKey(scp, key, 0, userp, &req);
4721 cm_ReleaseSCache(scp);
4722 cm_ReleaseUser(userp);
4723 lock_ReleaseMutex(&scp->mx);