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>
23 osi_rwlock_t cm_connLock;
25 long RDRtimeout = CM_CONN_DEFAULTRDRTIMEOUT;
26 unsigned short ConnDeadtimeout = CM_CONN_CONNDEADTIME;
27 unsigned short HardDeadtimeout = CM_CONN_HARDDEADTIME;
29 #define LANMAN_WKS_PARAM_KEY "SYSTEM\\CurrentControlSet\\Services\\lanmanworkstation\\parameters"
30 #define LANMAN_WKS_SESSION_TIMEOUT "SessTimeout"
32 afs_int32 cryptall = 0;
34 void cm_PutConn(cm_conn_t *connp)
36 lock_ObtainWrite(&cm_connLock);
37 osi_assert(connp->refCount-- > 0);
38 lock_ReleaseWrite(&cm_connLock);
41 void cm_InitConn(void)
43 static osi_once_t once;
48 if (osi_Once(&once)) {
49 lock_InitializeRWLock(&cm_connLock, "connection global lock");
51 /* keisa - read timeout value for lanmanworkstation service.
53 * http://support.microsoft.com:80/support/kb/articles/Q102/0/67.asp&NoWebContent=1
54 * the SessTimeout is a minimum timeout not a maximum timeout. Therefore,
55 * I believe that the default should not be short. Instead, we should wait until
56 * RX times out before reporting a timeout to the SMB client.
58 code = RegOpenKeyEx(HKEY_LOCAL_MACHINE, LANMAN_WKS_PARAM_KEY,
59 0, KEY_QUERY_VALUE, &parmKey);
60 if (code == ERROR_SUCCESS)
62 DWORD dummyLen = sizeof(sessTimeout);
63 code = RegQueryValueEx(parmKey, LANMAN_WKS_SESSION_TIMEOUT, NULL, NULL,
64 (BYTE *) &sessTimeout, &dummyLen);
65 if (code == ERROR_SUCCESS)
67 afsi_log("lanmanworkstation : SessTimeout %d", sessTimeout);
68 RDRtimeout = sessTimeout;
69 if ( ConnDeadtimeout < RDRtimeout + 15 ) {
70 ConnDeadtimeout = RDRtimeout + 15;
71 afsi_log("ConnDeadTimeout increased to %d", ConnDeadtimeout);
73 if ( HardDeadtimeout < 2 * ConnDeadtimeout ) {
74 HardDeadtimeout = 2 * ConnDeadtimeout;
75 afsi_log("HardDeadTimeout increased to %d", HardDeadtimeout);
84 void cm_InitReq(cm_req_t *reqp)
86 memset((char *)reqp, 0, sizeof(cm_req_t));
88 reqp->startTime = GetTickCount();
90 gettimeofday(&reqp->startTime, NULL);
94 static long cm_GetServerList(struct cm_fid *fidp, struct cm_user *userp,
95 struct cm_req *reqp, cm_serverRef_t ***serversppp)
98 cm_volume_t *volp = NULL;
99 cm_cell_t *cellp = NULL;
106 cellp = cm_FindCellByID(fidp->cell);
107 if (!cellp) return CM_ERROR_NOSUCHCELL;
109 code = cm_GetVolumeByID(cellp, fidp->volume, userp, reqp, &volp);
110 if (code) return code;
112 *serversppp = cm_GetVolServers(volp, fidp->volume);
119 * Analyze the error return from an RPC. Determine whether or not to retry,
120 * and if we're going to retry, determine whether failover is appropriate,
121 * and whether timed backoff is appropriate.
123 * If the error code is from cm_Conn() or friends, it will be a CM_ERROR code.
124 * Otherwise it will be an RPC code. This may be a UNIX code (e.g. EDQUOT), or
125 * it may be an RX code, or it may be a special code (e.g. VNOVOL), or it may
126 * be a security code (e.g. RXKADEXPIRED).
128 * If the error code is from cm_Conn() or friends, connp will be NULL.
130 * For VLDB calls, fidp will be NULL.
132 * volSyncp and/or cbrp may also be NULL.
135 cm_Analyze(cm_conn_t *connp, cm_user_t *userp, cm_req_t *reqp,
137 AFSVolSync *volSyncp,
138 cm_serverRef_t * serversp,
139 cm_callbackRequest_t *cbrp, long errorCode)
141 cm_server_t *serverp = NULL;
142 cm_serverRef_t **serverspp = NULL;
143 cm_serverRef_t *tsrp;
144 cm_cell_t *cellp = NULL;
147 int free_svr_list = 0;
149 long timeUsed, timeLeft;
153 osi_Log2(afsd_logp, "cm_Analyze connp 0x%p, code 0x%x",
156 /* no locking required, since connp->serverp never changes after
158 dead_session = (userp->cellInfop == NULL);
160 serverp = connp->serverp;
162 /* Update callback pointer */
163 if (cbrp && serverp && errorCode == 0) {
165 if ( cbrp->serverp != serverp ) {
166 lock_ObtainWrite(&cm_serverLock);
167 cm_PutServerNoLock(cbrp->serverp);
168 cm_GetServerNoLock(serverp);
169 lock_ReleaseWrite(&cm_serverLock);
172 cm_GetServer(serverp);
174 lock_ObtainWrite(&cm_callbackLock);
175 cbrp->serverp = serverp;
176 lock_ReleaseWrite(&cm_callbackLock);
179 /* If not allowed to retry, don't */
180 if (reqp->flags & CM_REQ_NORETRY)
183 /* if timeout - check that it did not exceed the SMB timeout
186 /* timeleft - get if from reqp the same way as cmXonnByMServers does */
188 timeUsed = (GetTickCount() - reqp->startTime) / 1000;
190 gettimeofday(&now, NULL);
191 timeUsed = sub_time(now, reqp->startTime) / 1000;
194 /* leave 5 seconds margin for sleep */
195 timeLeft = RDRtimeout - timeUsed;
197 if (errorCode == CM_ERROR_TIMEDOUT) {
200 if (cellp == NULL && serverp)
201 cellp = serverp->cellp;
202 if (cellp == NULL && serversp) {
203 struct cm_serverRef * refp;
204 for ( refp=serversp ; cellp == NULL && refp != NULL; refp=refp->next) {
206 cellp = refp->server->cellp;
209 cm_CheckServers(CM_FLAG_CHECKDOWNSERVERS, cellp);
214 /* if there is nosuchvolume, then we have a situation in which a
215 * previously known volume no longer has a set of servers
216 * associated with it. Either the volume has moved or
217 * the volume has been deleted. Try to find a new server list
218 * until the timeout period expires.
220 else if (errorCode == CM_ERROR_NOSUCHVOLUME) {
221 osi_Log0(afsd_logp, "cm_Analyze passed CM_ERROR_NOSUCHVOLUME.");
227 if (fidp != NULL) /* Not a VLDB call */
228 cm_ForceUpdateVolume(fidp, userp, reqp);
232 else if (errorCode == CM_ERROR_ALLDOWN) {
233 osi_Log0(afsd_logp, "cm_Analyze passed CM_ERROR_ALLDOWN.");
234 /* Servers marked DOWN will be restored by the background daemon
235 * thread as they become available.
239 else if (errorCode == CM_ERROR_ALLOFFLINE) {
241 osi_Log0(afsd_logp, "cm_Analyze passed CM_ERROR_ALLOFFLINE.");
244 if (fidp) { /* Not a VLDB call */
246 code = cm_GetServerList(fidp, userp, reqp, &serverspp);
248 serversp = *serverspp;
253 lock_ObtainWrite(&cm_serverLock);
254 for (tsrp = serversp; tsrp; tsrp=tsrp->next)
255 tsrp->status = not_busy;
256 lock_ReleaseWrite(&cm_serverLock);
258 cm_FreeServerList(&serversp);
259 *serverspp = serversp;
264 cm_ForceUpdateVolume(fidp, userp, reqp);
265 } else { /* VLDB call */
267 lock_ObtainWrite(&cm_serverLock);
268 for (tsrp = serversp; tsrp; tsrp=tsrp->next)
269 tsrp->status = not_busy;
270 lock_ReleaseWrite(&cm_serverLock);
272 cm_FreeServerList(&serversp);
273 *serverspp = serversp;
280 /* if all servers are busy, mark them non-busy and start over */
281 else if (errorCode == CM_ERROR_ALLBUSY) {
282 osi_Log0(afsd_logp, "cm_Analyze passed CM_ERROR_ALLBUSY.");
286 code = cm_GetServerList(fidp, userp, reqp, &serverspp);
288 serversp = *serverspp;
292 lock_ObtainWrite(&cm_serverLock);
293 for (tsrp = serversp; tsrp; tsrp=tsrp->next) {
294 if (tsrp->status == busy)
295 tsrp->status = not_busy;
297 lock_ReleaseWrite(&cm_serverLock);
299 cm_FreeServerList(&serversp);
300 *serverspp = serversp;
306 /* special codes: VBUSY and VRESTARTING */
307 else if (errorCode == VBUSY || errorCode == VRESTARTING) {
309 code = cm_GetServerList(fidp, userp, reqp, &serverspp);
311 serversp = *serverspp;
315 lock_ObtainWrite(&cm_serverLock);
316 for (tsrp = serversp; tsrp; tsrp=tsrp->next) {
317 if (tsrp->server == serverp
318 && tsrp->status == not_busy) {
323 lock_ReleaseWrite(&cm_serverLock);
325 cm_FreeServerList(&serversp);
326 *serverspp = serversp;
331 /* special codes: missing volumes */
332 else if (errorCode == VNOVOL || errorCode == VMOVED || errorCode == VOFFLINE ||
333 errorCode == VSALVAGE || errorCode == VNOSERVICE || errorCode == VIO)
340 switch ( errorCode ) {
343 msgID = MSG_SERVER_REPORTS_VNOVOL;
345 format = "Server %s reported volume %d as not attached.";
349 msgID = MSG_SERVER_REPORTS_VMOVED;
351 format = "Server %s reported volume %d as moved.";
355 msgID = MSG_SERVER_REPORTS_VOFFLINE;
357 format = "Server %s reported volume %d as offline.";
361 msgID = MSG_SERVER_REPORTS_VSALVAGE;
363 format = "Server %s reported volume %d as needs salvage.";
367 msgID = MSG_SERVER_REPORTS_VNOSERVICE;
369 format = "Server %s reported volume %d as not in service.";
373 msgID = MSG_SERVER_REPORTS_VIO;
375 format = "Server %s reported volume %d as temporarily unaccessible.";
379 /* Log server being offline for this volume */
380 sprintf(addr, "%d.%d.%d.%d",
381 ((serverp->addr.sin_addr.s_addr & 0xff)),
382 ((serverp->addr.sin_addr.s_addr & 0xff00)>> 8),
383 ((serverp->addr.sin_addr.s_addr & 0xff0000)>> 16),
384 ((serverp->addr.sin_addr.s_addr & 0xff000000)>> 24));
386 osi_Log2(afsd_logp, format, osi_LogSaveString(afsd_logp,addr), fidp->volume);
388 LogEvent(EVENTLOG_WARNING_TYPE, msgID, addr, fidp->volume);
391 /* Mark server offline for this volume */
393 code = cm_GetServerList(fidp, userp, reqp, &serverspp);
395 serversp = *serverspp;
399 for (tsrp = serversp; tsrp; tsrp=tsrp->next) {
400 if (tsrp->server == serverp)
401 tsrp->status = offline;
404 cm_FreeServerList(&serversp);
405 *serverspp = serversp;
409 } else if ( errorCode == VNOVNODE ) {
412 osi_Log4(afsd_logp, "cm_Analyze passed VNOVNODE cell %u vol %u vn %u uniq %u.",
413 fidp->cell, fidp->volume, fidp->vnode, fidp->unique);
414 scp = cm_FindSCache(fidp);
416 cm_scache_t *pscp = cm_FindSCacheParent(scp);
417 cm_CleanFile(scp, userp, reqp);
418 cm_ReleaseSCache(scp);
420 if (pscp->cbExpires > 0 && pscp->cbServerp != NULL) {
421 lock_ObtainMutex(&pscp->mx);
422 cm_DiscardSCache(pscp);
423 lock_ReleaseMutex(&pscp->mx);
425 cm_ReleaseSCache(pscp);
429 osi_Log0(afsd_logp, "cm_Analyze passed VNOVNODE unknown fid.");
434 else if (errorCode == RX_CALL_TIMEOUT) {
435 /* server took longer than hardDeadTime
436 * don't mark server as down but don't retry
437 * this is to prevent the SMB session from timing out
438 * In addition, we log an event to the event log
441 /* Log server being offline for this volume */
442 sprintf(addr, "%d.%d.%d.%d",
443 ((serverp->addr.sin_addr.s_addr & 0xff)),
444 ((serverp->addr.sin_addr.s_addr & 0xff00)>> 8),
445 ((serverp->addr.sin_addr.s_addr & 0xff0000)>> 16),
446 ((serverp->addr.sin_addr.s_addr & 0xff000000)>> 24));
449 LogEvent(EVENTLOG_WARNING_TYPE, MSG_RX_HARD_DEAD_TIME_EXCEEDED, addr);
453 osi_Log1(afsd_logp, "cm_Analyze: hardDeadTime exceeded addr[%s]",
454 osi_LogSaveString(afsd_logp,addr));
456 else if (errorCode >= -64 && errorCode < 0) {
457 /* mark server as down */
458 lock_ObtainMutex(&serverp->mx);
459 serverp->flags |= CM_SERVERFLAG_DOWN;
460 lock_ReleaseMutex(&serverp->mx);
461 cm_ForceNewConnections(serverp);
465 else if (errorCode == RXKADEXPIRED ||
466 errorCode == RXKADBADTICKET) {
468 lock_ObtainMutex(&userp->mx);
469 ucellp = cm_GetUCell(userp, serverp->cellp);
470 if (ucellp->ticketp) {
471 free(ucellp->ticketp);
472 ucellp->ticketp = NULL;
474 ucellp->flags &= ~CM_UCELLFLAG_RXKAD;
476 lock_ReleaseMutex(&userp->mx);
482 char * s = "unknown error";
483 switch ( errorCode ) {
484 case RXKADINCONSISTENCY: s = "RXKADINCONSISTENCY"; break;
485 case RXKADPACKETSHORT : s = "RXKADPACKETSHORT"; break;
486 case RXKADLEVELFAIL : s = "RXKADLEVELFAIL"; break;
487 case RXKADTICKETLEN : s = "RXKADTICKETLEN"; break;
488 case RXKADOUTOFSEQUENCE: s = "RXKADOUTOFSEQUENCE"; break;
489 case RXKADNOAUTH : s = "RXKADNOAUTH"; break;
490 case RXKADBADKEY : s = "RXKADBADKEY"; break;
491 case RXKADBADTICKET : s = "RXKADBADTICKET"; break;
492 case RXKADUNKNOWNKEY : s = "RXKADUNKNOWNKEY"; break;
493 case RXKADEXPIRED : s = "RXKADEXPIRED"; break;
494 case RXKADSEALEDINCON : s = "RXKADSEALEDINCON"; break;
495 case RXKADDATALEN : s = "RXKADDATALEN"; break;
496 case RXKADILLEGALLEVEL : s = "RXKADILLEGALLEVEL"; break;
497 case VSALVAGE : s = "VSALVAGE"; break;
498 case VNOVNODE : s = "VNOVNODE"; break;
499 case VNOVOL : s = "VNOVOL"; break;
500 case VVOLEXISTS : s = "VVOLEXISTS"; break;
501 case VNOSERVICE : s = "VNOSERVICE"; break;
502 case VOFFLINE : s = "VOFFLINE"; break;
503 case VONLINE : s = "VONLINE"; break;
504 case VDISKFULL : s = "VDISKFULL"; break;
505 case VOVERQUOTA : s = "VOVERQUOTA"; break;
506 case VBUSY : s = "VBUSY"; break;
507 case VMOVED : s = "VMOVED"; break;
508 case VIO : s = "VIO"; break;
509 case VRESTRICTED : s = "VRESTRICTED"; break;
510 case VRESTARTING : s = "VRESTARTING"; break;
511 case VREADONLY : s = "VREADONLY"; break;
512 case EAGAIN : s = "EAGAIN"; break;
513 case EACCES : s = "EACCES"; break;
515 osi_Log2(afsd_logp, "cm_Analyze: ignoring error code 0x%x (%s)",
521 if (retry && dead_session)
525 /* drop this on the way out */
529 /* retry until we fail to find a connection */
533 long cm_ConnByMServers(cm_serverRef_t *serversp, cm_user_t *usersp,
534 cm_req_t *reqp, cm_conn_t **connpp)
537 cm_serverRef_t *tsrp;
540 int someBusy = 0, someOffline = 0, allOffline = 1, allBusy = 1, allDown = 1;
541 long timeUsed, timeLeft, hardTimeLeft;
546 if (serversp == NULL) {
547 osi_Log1(afsd_logp, "cm_ConnByMServers returning 0x%x", CM_ERROR_NOSUCHVOLUME);
548 return CM_ERROR_NOSUCHVOLUME;
554 timeUsed = (GetTickCount() - reqp->startTime) / 1000;
556 gettimeofday(&now, NULL);
557 timeUsed = sub_time(now, reqp->startTime) / 1000;
560 /* leave 5 seconds margin of safety */
561 timeLeft = ConnDeadtimeout - timeUsed - 5;
562 hardTimeLeft = HardDeadtimeout - timeUsed - 5;
564 lock_ObtainWrite(&cm_serverLock);
565 for (tsrp = serversp; tsrp; tsrp=tsrp->next) {
567 cm_GetServerNoLock(tsp);
568 lock_ReleaseWrite(&cm_serverLock);
569 if (!(tsp->flags & CM_SERVERFLAG_DOWN)) {
571 if (tsrp->status == busy) {
574 } else if (tsrp->status == offline) {
580 code = cm_ConnByServer(tsp, usersp, connpp);
581 if (code == 0) { /* cm_CBS only returns 0 */
583 /* Set RPC timeout */
584 if (timeLeft > ConnDeadtimeout)
585 timeLeft = ConnDeadtimeout;
587 if (hardTimeLeft > HardDeadtimeout)
588 hardTimeLeft = HardDeadtimeout;
590 lock_ObtainMutex(&(*connpp)->mx);
591 rx_SetConnDeadTime((*connpp)->callp, timeLeft);
592 rx_SetConnHardDeadTime((*connpp)->callp, (u_short) hardTimeLeft);
593 lock_ReleaseMutex(&(*connpp)->mx);
597 /* therefore, this code is never executed */
602 lock_ObtainWrite(&cm_serverLock);
603 cm_PutServerNoLock(tsp);
605 lock_ReleaseWrite(&cm_serverLock);
607 if (firstError == 0) {
609 firstError = CM_ERROR_ALLDOWN;
611 firstError = CM_ERROR_ALLBUSY;
612 else if (allOffline || (someBusy && someOffline))
613 firstError = CM_ERROR_ALLOFFLINE;
615 osi_Log0(afsd_logp, "cm_ConnByMServers returning impossible error TIMEDOUT");
616 firstError = CM_ERROR_TIMEDOUT;
620 osi_Log1(afsd_logp, "cm_ConnByMServers returning 0x%x", firstError);
624 /* called with a held server to GC all bad connections hanging off of the server */
625 void cm_GCConnections(cm_server_t *serverp)
631 lock_ObtainWrite(&cm_connLock);
632 lcpp = &serverp->connsp;
633 for (tcp = *lcpp; tcp; tcp = *lcpp) {
635 if (userp && tcp->refCount == 0 && (userp->vcRefs == 0)) {
636 /* do the deletion of this guy */
637 cm_PutServer(tcp->serverp);
638 cm_ReleaseUser(userp);
640 rx_DestroyConnection(tcp->callp);
641 lock_FinalizeMutex(&tcp->mx);
645 /* just advance to the next */
649 lock_ReleaseWrite(&cm_connLock);
652 static void cm_NewRXConnection(cm_conn_t *tcp, cm_ucell_t *ucellp,
653 cm_server_t *serverp)
658 struct rx_securityClass *secObjp;
660 if (serverp->type == CM_SERVER_VLDB) {
665 osi_assert(serverp->type == CM_SERVER_FILE);
669 if (ucellp->flags & CM_UCELLFLAG_RXKAD) {
672 tcp->cryptlevel = rxkad_crypt;
674 tcp->cryptlevel = rxkad_clear;
676 secObjp = rxkad_NewClientSecurityObject(tcp->cryptlevel,
677 &ucellp->sessionKey, ucellp->kvno,
678 ucellp->ticketLen, ucellp->ticketp);
682 tcp->cryptlevel = rxkad_clear;
683 secObjp = rxnull_NewClientSecurityObject();
685 osi_assert(secObjp != NULL);
686 tcp->callp = rx_NewConnection(serverp->addr.sin_addr.s_addr,
691 rx_SetConnDeadTime(tcp->callp, ConnDeadtimeout);
692 rx_SetConnHardDeadTime(tcp->callp, HardDeadtimeout);
693 tcp->ucgen = ucellp->gen;
695 rxs_Release(secObjp); /* Decrement the initial refCount */
698 long cm_ConnByServer(cm_server_t *serverp, cm_user_t *userp, cm_conn_t **connpp)
703 lock_ObtainMutex(&userp->mx);
704 lock_ObtainWrite(&cm_connLock);
705 for (tcp = serverp->connsp; tcp; tcp=tcp->nextp) {
706 if (tcp->userp == userp)
710 /* find ucell structure */
711 ucellp = cm_GetUCell(userp, serverp->cellp);
713 cm_GetServer(serverp);
714 tcp = malloc(sizeof(*tcp));
715 memset(tcp, 0, sizeof(*tcp));
716 tcp->nextp = serverp->connsp;
717 serverp->connsp = tcp;
720 lock_InitializeMutex(&tcp->mx, "cm_conn_t mutex");
721 lock_ObtainMutex(&tcp->mx);
722 tcp->serverp = serverp;
723 tcp->cryptlevel = rxkad_clear;
724 cm_NewRXConnection(tcp, ucellp, serverp);
726 lock_ReleaseMutex(&tcp->mx);
728 if ((tcp->flags & CM_CONN_FLAG_FORCE_NEW) ||
729 (tcp->ucgen < ucellp->gen) ||
730 (tcp->cryptlevel != (cryptall ? (ucellp->flags & CM_UCELLFLAG_RXKAD ? rxkad_crypt : rxkad_clear) : rxkad_clear)))
732 if (tcp->ucgen < ucellp->gen)
733 osi_Log0(afsd_logp, "cm_ConnByServer replace connection due to token update");
735 osi_Log0(afsd_logp, "cm_ConnByServer replace connection due to crypt change");
736 lock_ObtainMutex(&tcp->mx);
737 tcp->flags &= ~CM_CONN_FLAG_FORCE_NEW;
738 rx_DestroyConnection(tcp->callp);
739 cm_NewRXConnection(tcp, ucellp, serverp);
740 lock_ReleaseMutex(&tcp->mx);
744 lock_ReleaseWrite(&cm_connLock);
745 lock_ReleaseMutex(&userp->mx);
747 /* return this pointer to our caller */
748 osi_Log1(afsd_logp, "cm_ConnByServer returning conn 0x%p", tcp);
754 long cm_Conn(struct cm_fid *fidp, struct cm_user *userp, cm_req_t *reqp,
759 cm_serverRef_t **serverspp;
761 code = cm_GetServerList(fidp, userp, reqp, &serverspp);
767 code = cm_ConnByMServers(*serverspp, userp, reqp, connpp);
768 cm_FreeServerList(serverspp);
772 extern struct rx_connection *
773 cm_GetRxConn(cm_conn_t *connp)
775 struct rx_connection * rxconn;
776 lock_ObtainMutex(&connp->mx);
777 rxconn = connp->callp;
778 rx_GetConnection(rxconn);
779 lock_ReleaseMutex(&connp->mx);
783 void cm_ForceNewConnections(cm_server_t *serverp)
787 lock_ObtainWrite(&cm_connLock);
788 for (tcp = serverp->connsp; tcp; tcp=tcp->nextp) {
789 lock_ObtainMutex(&tcp->mx);
790 tcp->flags |= CM_CONN_FLAG_FORCE_NEW;
791 lock_ReleaseMutex(&tcp->mx);
793 lock_ReleaseWrite(&cm_connLock);