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>
28 osi_rwlock_t cm_connLock;
30 long RDRtimeout = CM_CONN_DEFAULTRDRTIMEOUT;
31 long ConnDeadtimeout = CM_CONN_CONNDEADTIME;
32 long HardDeadtimeout = CM_CONN_HARDDEADTIME;
34 #define LANMAN_WKS_PARAM_KEY "SYSTEM\\CurrentControlSet\\Services\\lanmanworkstation\\parameters"
35 #define LANMAN_WKS_SESSION_TIMEOUT "SessTimeout"
37 afs_int32 cryptall = 0;
39 void cm_PutConn(cm_conn_t *connp)
41 lock_ObtainWrite(&cm_connLock);
42 osi_assert(connp->refCount-- > 0);
43 lock_ReleaseWrite(&cm_connLock);
46 void cm_InitConn(void)
48 static osi_once_t once;
53 if (osi_Once(&once)) {
54 lock_InitializeRWLock(&cm_connLock, "connection global lock");
56 /* keisa - read timeout value for lanmanworkstation service.
58 * http://support.microsoft.com:80/support/kb/articles/Q102/0/67.asp&NoWebContent=1
59 * the SessTimeout is a minimum timeout not a maximum timeout. Therefore,
60 * I believe that the default should not be short. Instead, we should wait until
61 * RX times out before reporting a timeout to the SMB client.
63 code = RegOpenKeyEx(HKEY_LOCAL_MACHINE, LANMAN_WKS_PARAM_KEY,
64 0, KEY_QUERY_VALUE, &parmKey);
65 if (code == ERROR_SUCCESS)
67 DWORD dummyLen = sizeof(sessTimeout);
68 code = RegQueryValueEx(parmKey, LANMAN_WKS_SESSION_TIMEOUT, NULL, NULL,
69 (BYTE *) &sessTimeout, &dummyLen);
70 if (code == ERROR_SUCCESS)
72 afsi_log("lanmanworkstation : SessTimeout %d", sessTimeout);
73 RDRtimeout = sessTimeout;
74 if ( ConnDeadtimeout < RDRtimeout + 15 ) {
75 ConnDeadtimeout = RDRtimeout + 15;
76 afsi_log("ConnDeadTimeout increased to %d", ConnDeadtimeout);
78 if ( HardDeadtimeout < 2 * ConnDeadtimeout ) {
79 HardDeadtimeout = 2 * ConnDeadtimeout;
80 afsi_log("HardDeadTimeout increased to %d", HardDeadtimeout);
89 void cm_InitReq(cm_req_t *reqp)
91 memset((char *)reqp, 0, sizeof(cm_req_t));
93 reqp->startTime = GetCurrentTime();
95 gettimeofday(&reqp->startTime, NULL);
99 static long cm_GetServerList(struct cm_fid *fidp, struct cm_user *userp,
100 struct cm_req *reqp, cm_serverRef_t ***serversppp)
103 cm_volume_t *volp = NULL;
104 cm_cell_t *cellp = NULL;
111 cellp = cm_FindCellByID(fidp->cell);
112 if (!cellp) return CM_ERROR_NOSUCHCELL;
114 code = cm_GetVolumeByID(cellp, fidp->volume, userp, reqp, &volp);
115 if (code) return code;
117 *serversppp = cm_GetVolServers(volp, fidp->volume);
124 * Analyze the error return from an RPC. Determine whether or not to retry,
125 * and if we're going to retry, determine whether failover is appropriate,
126 * and whether timed backoff is appropriate.
128 * If the error code is from cm_Conn() or friends, it will be a CM_ERROR code.
129 * Otherwise it will be an RPC code. This may be a UNIX code (e.g. EDQUOT), or
130 * it may be an RX code, or it may be a special code (e.g. VNOVOL), or it may
131 * be a security code (e.g. RXKADEXPIRED).
133 * If the error code is from cm_Conn() or friends, connp will be NULL.
135 * For VLDB calls, fidp will be NULL.
137 * volSyncp and/or cbrp may also be NULL.
140 cm_Analyze(cm_conn_t *connp, cm_user_t *userp, cm_req_t *reqp,
142 AFSVolSync *volSyncp,
143 cm_serverRef_t * serversp,
144 cm_callbackRequest_t *cbrp, long errorCode)
146 cm_server_t *serverp = NULL;
147 cm_serverRef_t **serverspp = NULL;
148 cm_serverRef_t *tsrp;
149 cm_cell_t *cellp = NULL;
152 int free_svr_list = 0;
154 long timeUsed, timeLeft;
157 osi_Log2(afsd_logp, "cm_Analyze connp 0x%x, code 0x%x",
158 (long) connp, errorCode);
160 /* no locking required, since connp->serverp never changes after
162 dead_session = (userp->cellInfop == NULL);
164 serverp = connp->serverp;
166 /* Update callback pointer */
167 if (cbrp && serverp && errorCode == 0) {
169 if ( cbrp->serverp != serverp ) {
170 lock_ObtainWrite(&cm_serverLock);
171 cm_PutServerNoLock(cbrp->serverp);
172 cm_GetServerNoLock(serverp);
173 lock_ReleaseWrite(&cm_serverLock);
176 cm_GetServer(serverp);
178 lock_ObtainWrite(&cm_callbackLock);
179 cbrp->serverp = serverp;
180 lock_ReleaseWrite(&cm_callbackLock);
183 /* If not allowed to retry, don't */
184 if (reqp->flags & CM_REQ_NORETRY)
187 /* if timeout - check that it did not exceed the SMB timeout
190 /* timeleft - get if from reqp the same way as cmXonnByMServers does */
192 timeUsed = (GetCurrentTime() - reqp->startTime) / 1000;
194 gettimeofday(&now, NULL);
195 timeUsed = sub_time(now, reqp->startTime) / 1000;
198 /* leave 5 seconds margin for sleep */
199 timeLeft = RDRtimeout - timeUsed;
201 if (errorCode == CM_ERROR_TIMEDOUT) {
204 if (cellp == NULL && serverp)
205 cellp = serverp->cellp;
206 if (cellp == NULL && serversp) {
207 struct cm_serverRef * refp;
208 for ( refp=serversp ; cellp == NULL && refp != NULL; refp=refp->next) {
210 cellp = refp->server->cellp;
213 cm_CheckServers(CM_FLAG_CHECKDOWNSERVERS, cellp);
218 /* if there is nosuchvolume, then we have a situation in which a
219 * previously known volume no longer has a set of servers
220 * associated with it. Either the volume has moved or
221 * the volume has been deleted. Try to find a new server list
222 * until the timeout period expires.
224 else if (errorCode == CM_ERROR_NOSUCHVOLUME) {
226 osi_Log0(afsd_logp, "cm_Analyze passed CM_ERROR_NOSUCHVOLUME.");
231 if (fidp != NULL) /* Not a VLDB call */
232 cm_ForceUpdateVolume(fidp, userp, reqp);
236 else if (errorCode == CM_ERROR_ALLOFFLINE) {
238 osi_Log0(afsd_logp, "cm_Analyze passed CM_ERROR_ALLOFFLINE.");
241 /* cm_ForceUpdateVolume marks all servers as non_busy */
242 /* No it doesn't and it won't do anything if all of the
243 * the servers are marked as DOWN. So clear the DOWN
244 * flag and reset the busy state as well.
247 code = cm_GetServerList(fidp, userp, reqp, &serverspp);
249 serversp = *serverspp;
254 lock_ObtainWrite(&cm_serverLock);
255 for (tsrp = serversp; tsrp; tsrp=tsrp->next) {
256 tsrp->server->flags &= ~CM_SERVERFLAG_DOWN;
257 if (tsrp->status == busy)
258 tsrp->status = not_busy;
260 lock_ReleaseWrite(&cm_serverLock);
262 cm_FreeServerList(&serversp);
263 *serverspp = serversp;
268 if (fidp != NULL) /* Not a VLDB call */
269 cm_ForceUpdateVolume(fidp, userp, reqp);
275 /* if all servers are busy, mark them non-busy and start over */
276 else if (errorCode == CM_ERROR_ALLBUSY) {
280 code = cm_GetServerList(fidp, userp, reqp, &serverspp);
282 serversp = *serverspp;
286 lock_ObtainWrite(&cm_serverLock);
287 for (tsrp = serversp; tsrp; tsrp=tsrp->next) {
288 if (tsrp->status == busy)
289 tsrp->status = not_busy;
291 lock_ReleaseWrite(&cm_serverLock);
293 cm_FreeServerList(&serversp);
294 *serverspp = serversp;
300 /* special codes: VBUSY and VRESTARTING */
301 else if (errorCode == VBUSY || errorCode == VRESTARTING) {
303 code = cm_GetServerList(fidp, userp, reqp, &serverspp);
305 serversp = *serverspp;
309 lock_ObtainWrite(&cm_serverLock);
310 for (tsrp = serversp; tsrp; tsrp=tsrp->next) {
311 if (tsrp->server == serverp
312 && tsrp->status == not_busy) {
317 lock_ReleaseWrite(&cm_serverLock);
319 cm_FreeServerList(&serversp);
320 *serverspp = serversp;
325 /* special codes: missing volumes */
326 else if (errorCode == VNOVOL || errorCode == VMOVED || errorCode == VOFFLINE ||
327 errorCode == VSALVAGE || errorCode == VNOSERVICE || errorCode == VIO)
337 switch ( errorCode ) {
339 format = "Server %s reported volume %d as not attached.";
342 format = "Server %s reported volume %d as moved.";
345 format = "Server %s reported volume %d as offline.";
348 format = "Server %s reported volume %d as needs salvage.";
351 format = "Server %s reported volume %d as not in service.";
354 format = "Server %s reported volume %d as temporarily unaccessible.";
358 /* Log server being offline for this volume */
359 sprintf(addr, "%d.%d.%d.%d",
360 ((serverp->addr.sin_addr.s_addr & 0xff)),
361 ((serverp->addr.sin_addr.s_addr & 0xff00)>> 8),
362 ((serverp->addr.sin_addr.s_addr & 0xff0000)>> 16),
363 ((serverp->addr.sin_addr.s_addr & 0xff000000)>> 24));
364 osi_Log2(afsd_logp, format, osi_LogSaveString(afsd_logp,addr), fidp->volume);
367 /* Create Event Log message */
368 h = RegisterEventSource(NULL, AFS_DAEMON_EVENT_NAME);
369 sprintf(s, format, addr, fidp->volume);
371 ReportEvent(h, EVENTLOG_WARNING_TYPE, 0, 1009, NULL,
373 DeregisterEventSource(h);
376 /* Mark server offline for this volume */
378 code = cm_GetServerList(fidp, userp, reqp, &serverspp);
380 serversp = *serverspp;
384 for (tsrp = serversp; tsrp; tsrp=tsrp->next) {
385 if (tsrp->server == serverp)
386 tsrp->status = offline;
389 cm_FreeServerList(&serversp);
390 *serverspp = serversp;
397 else if (errorCode == RX_CALL_TIMEOUT) {
398 /* server took longer than hardDeadTime
399 * don't mark server as down but don't retry
400 * this is to prevent the SMB session from timing out
401 * In addition, we log an event to the event log
407 h = RegisterEventSource(NULL, AFS_DAEMON_EVENT_NAME);
408 sprintf(s, "cm_Analyze: HardDeadTime exceeded.");
410 ReportEvent(h, EVENTLOG_WARNING_TYPE, 0, 1009, NULL,
412 DeregisterEventSource(h);
416 osi_Log0(afsd_logp, "cm_Analyze: hardDeadTime exceeded");
418 else if (errorCode >= -64 && errorCode < 0) {
419 /* mark server as down */
420 lock_ObtainMutex(&serverp->mx);
421 serverp->flags |= CM_SERVERFLAG_DOWN;
422 lock_ReleaseMutex(&serverp->mx);
426 else if (errorCode == RXKADEXPIRED ||
427 errorCode == RXKADBADTICKET) {
429 lock_ObtainMutex(&userp->mx);
430 ucellp = cm_GetUCell(userp, serverp->cellp);
431 if (ucellp->ticketp) {
432 free(ucellp->ticketp);
433 ucellp->ticketp = NULL;
435 ucellp->flags &= ~CM_UCELLFLAG_RXKAD;
437 lock_ReleaseMutex(&userp->mx);
443 char * s = "unknown error";
444 switch ( errorCode ) {
445 case RXKADINCONSISTENCY: s = "RXKADINCONSISTENCY"; break;
446 case RXKADPACKETSHORT : s = "RXKADPACKETSHORT"; break;
447 case RXKADLEVELFAIL : s = "RXKADLEVELFAIL"; break;
448 case RXKADTICKETLEN : s = "RXKADTICKETLEN"; break;
449 case RXKADOUTOFSEQUENCE: s = "RXKADOUTOFSEQUENCE"; break;
450 case RXKADNOAUTH : s = "RXKADNOAUTH"; break;
451 case RXKADBADKEY : s = "RXKADBADKEY"; break;
452 case RXKADBADTICKET : s = "RXKADBADTICKET"; break;
453 case RXKADUNKNOWNKEY : s = "RXKADUNKNOWNKEY"; break;
454 case RXKADEXPIRED : s = "RXKADEXPIRED"; break;
455 case RXKADSEALEDINCON : s = "RXKADSEALEDINCON"; break;
456 case RXKADDATALEN : s = "RXKADDATALEN"; break;
457 case RXKADILLEGALLEVEL : s = "RXKADILLEGALLEVEL"; break;
458 case VSALVAGE : s = "VSALVAGE"; break;
459 case VNOVNODE : s = "VNOVNODE"; break;
460 case VNOVOL : s = "VNOVOL"; break;
461 case VVOLEXISTS : s = "VVOLEXISTS"; break;
462 case VNOSERVICE : s = "VNOSERVICE"; break;
463 case VOFFLINE : s = "VOFFLINE"; break;
464 case VONLINE : s = "VONLINE"; break;
465 case VDISKFULL : s = "VDISKFULL"; break;
466 case VOVERQUOTA : s = "VOVERQUOTA"; break;
467 case VBUSY : s = "VBUSY"; break;
468 case VMOVED : s = "VMOVED"; break;
469 case VIO : s = "VIO"; break;
470 case VRESTRICTED : s = "VRESTRICTED"; break;
471 case VRESTARTING : s = "VRESTARTING"; break;
472 case VREADONLY : s = "VREADONLY"; break;
473 case EAGAIN : s = "EAGAIN"; break;
474 case EACCES : s = "EACCES"; break;
476 osi_Log2(afsd_logp, "cm_Analyze: ignoring error code 0x%x (%s)",
482 if (retry && dead_session)
486 /* drop this on the way out */
490 /* retry until we fail to find a connection */
494 long cm_ConnByMServers(cm_serverRef_t *serversp, cm_user_t *usersp,
495 cm_req_t *reqp, cm_conn_t **connpp)
498 cm_serverRef_t *tsrp;
501 int someBusy = 0, someOffline = 0, allBusy = 1, allDown = 1;
502 long timeUsed, timeLeft, hardTimeLeft;
510 timeUsed = (GetCurrentTime() - reqp->startTime) / 1000;
512 gettimeofday(&now, NULL);
513 timeUsed = sub_time(now, reqp->startTime) / 1000;
516 /* leave 5 seconds margin of safety */
517 timeLeft = ConnDeadtimeout - timeUsed - 5;
518 hardTimeLeft = HardDeadtimeout - timeUsed - 5;
520 lock_ObtainWrite(&cm_serverLock);
521 for (tsrp = serversp; tsrp; tsrp=tsrp->next) {
523 cm_GetServerNoLock(tsp);
524 lock_ReleaseWrite(&cm_serverLock);
525 if (!(tsp->flags & CM_SERVERFLAG_DOWN)) {
526 if (tsrp->status == busy) {
529 } else if (tsrp->status == offline) {
534 code = cm_ConnByServer(tsp, usersp, connpp);
535 if (code == 0) { /* cm_CBS only returns 0 */
537 /* Set RPC timeout */
538 if (timeLeft > ConnDeadtimeout)
539 timeLeft = ConnDeadtimeout;
541 if (hardTimeLeft > HardDeadtimeout)
542 hardTimeLeft = HardDeadtimeout;
544 lock_ObtainMutex(&(*connpp)->mx);
545 rx_SetConnDeadTime((*connpp)->callp, timeLeft);
546 rx_SetConnHardDeadTime((*connpp)->callp, (u_short) hardTimeLeft);
547 lock_ReleaseMutex(&(*connpp)->mx);
551 /* therefore, this code is never executed */
556 lock_ObtainWrite(&cm_serverLock);
557 cm_PutServerNoLock(tsp);
560 lock_ReleaseWrite(&cm_serverLock);
561 if (firstError == 0) {
562 if (serversp == NULL)
563 firstError = CM_ERROR_NOSUCHVOLUME;
565 firstError = CM_ERROR_ALLOFFLINE;
567 firstError = CM_ERROR_ALLBUSY;
569 osi_Log0(afsd_logp, "cm_ConnByMServers returning impossible error TIMEDOUT");
570 firstError = CM_ERROR_TIMEDOUT;
574 osi_Log1(afsd_logp, "cm_ConnByMServers returning 0x%x", firstError);
578 /* called with a held server to GC all bad connections hanging off of the server */
579 void cm_GCConnections(cm_server_t *serverp)
585 lock_ObtainWrite(&cm_connLock);
586 lcpp = &serverp->connsp;
587 for (tcp = *lcpp; tcp; tcp = *lcpp) {
589 if (userp && tcp->refCount == 0 && (userp->vcRefs == 0)) {
590 /* do the deletion of this guy */
591 cm_PutServer(tcp->serverp);
592 cm_ReleaseUser(userp);
594 rx_DestroyConnection(tcp->callp);
595 lock_FinalizeMutex(&tcp->mx);
599 /* just advance to the next */
603 lock_ReleaseWrite(&cm_connLock);
606 static void cm_NewRXConnection(cm_conn_t *tcp, cm_ucell_t *ucellp,
607 cm_server_t *serverp)
612 struct rx_securityClass *secObjp;
614 if (serverp->type == CM_SERVER_VLDB) {
619 osi_assert(serverp->type == CM_SERVER_FILE);
623 if (ucellp->flags & CM_UCELLFLAG_RXKAD) {
626 tcp->cryptlevel = rxkad_crypt;
628 tcp->cryptlevel = rxkad_clear;
630 secObjp = rxkad_NewClientSecurityObject(tcp->cryptlevel,
631 &ucellp->sessionKey, ucellp->kvno,
632 ucellp->ticketLen, ucellp->ticketp);
636 tcp->cryptlevel = rxkad_clear;
637 secObjp = rxnull_NewClientSecurityObject();
639 osi_assert(secObjp != NULL);
640 tcp->callp = rx_NewConnection(serverp->addr.sin_addr.s_addr,
645 rx_SetConnDeadTime(tcp->callp, ConnDeadtimeout);
646 rx_SetConnHardDeadTime(tcp->callp, HardDeadtimeout);
647 tcp->ucgen = ucellp->gen;
649 rxs_Release(secObjp); /* Decrement the initial refCount */
652 long cm_ConnByServer(cm_server_t *serverp, cm_user_t *userp, cm_conn_t **connpp)
657 lock_ObtainMutex(&userp->mx);
658 lock_ObtainWrite(&cm_connLock);
659 for (tcp = serverp->connsp; tcp; tcp=tcp->nextp) {
660 if (tcp->userp == userp)
664 /* find ucell structure */
665 ucellp = cm_GetUCell(userp, serverp->cellp);
667 cm_GetServer(serverp);
668 tcp = malloc(sizeof(*tcp));
669 memset(tcp, 0, sizeof(*tcp));
670 tcp->nextp = serverp->connsp;
671 serverp->connsp = tcp;
674 lock_InitializeMutex(&tcp->mx, "cm_conn_t mutex");
675 lock_ObtainMutex(&tcp->mx);
676 tcp->serverp = serverp;
677 tcp->cryptlevel = rxkad_clear;
678 cm_NewRXConnection(tcp, ucellp, serverp);
680 lock_ReleaseMutex(&tcp->mx);
682 if ((tcp->ucgen < ucellp->gen) ||
683 (tcp->cryptlevel != (cryptall ? (ucellp->flags & CM_UCELLFLAG_RXKAD ? rxkad_crypt : rxkad_clear) : rxkad_clear)))
685 if (tcp->ucgen < ucellp->gen)
686 osi_Log0(afsd_logp, "cm_ConnByServer replace connection due to token update");
688 osi_Log0(afsd_logp, "cm_ConnByServer replace connection due to crypt change");
689 lock_ObtainMutex(&tcp->mx);
690 rx_DestroyConnection(tcp->callp);
691 cm_NewRXConnection(tcp, ucellp, serverp);
692 lock_ReleaseMutex(&tcp->mx);
696 lock_ReleaseWrite(&cm_connLock);
697 lock_ReleaseMutex(&userp->mx);
699 /* return this pointer to our caller */
700 osi_Log1(afsd_logp, "cm_ConnByServer returning conn 0x%x", (long) tcp);
706 long cm_Conn(struct cm_fid *fidp, struct cm_user *userp, cm_req_t *reqp,
711 cm_serverRef_t **serverspp;
713 code = cm_GetServerList(fidp, userp, reqp, &serverspp);
719 code = cm_ConnByMServers(*serverspp, userp, reqp, connpp);
720 cm_FreeServerList(serverspp);
724 extern struct rx_connection *
725 cm_GetRxConn(cm_conn_t *connp)
727 struct rx_connection * rxconn;
728 lock_ObtainMutex(&connp->mx);
729 rxconn = connp->callp;
730 rx_GetConnection(rxconn);
731 lock_ReleaseMutex(&connp->mx);