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 = 0;
147 cm_serverRef_t **serverspp = 0;
148 cm_serverRef_t *tsrp;
151 int free_svr_list = 0;
153 long timeUsed, timeLeft;
155 osi_Log2(afsd_logp, "cm_Analyze connp 0x%x, code %d",
156 (long) connp, errorCode);
158 /* no locking required, since connp->serverp never changes after
160 dead_session = (userp->cellInfop == NULL);
162 serverp = connp->serverp;
164 /* Update callback pointer */
165 if (cbrp && serverp && errorCode == 0) {
167 if ( cbrp->serverp != serverp ) {
168 lock_ObtainWrite(&cm_serverLock);
169 cm_PutServerNoLock(cbrp->serverp);
170 cm_GetServerNoLock(serverp);
171 lock_ReleaseWrite(&cm_serverLock);
174 cm_GetServer(serverp);
176 lock_ObtainWrite(&cm_callbackLock);
177 cbrp->serverp = serverp;
178 lock_ReleaseWrite(&cm_callbackLock);
181 /* If not allowed to retry, don't */
182 if (reqp->flags & CM_REQ_NORETRY)
185 /* if timeout - check that it did not exceed the SMB timeout
188 /* timeleft - get if from reqp the same way as cmXonnByMServers does */
190 timeUsed = (GetCurrentTime() - reqp->startTime) / 1000;
192 gettimeofday(&now, NULL);
193 timeUsed = sub_time(now, reqp->startTime) / 1000;
196 /* leave 5 seconds margin for sleep */
197 timeLeft = RDRtimeout - timeUsed;
199 if (errorCode == CM_ERROR_TIMEDOUT && timeLeft > 5 ) {
201 cm_CheckServers(CM_FLAG_CHECKDOWNSERVERS, NULL);
205 /* if all servers are offline, mark them non-busy and start over */
206 if (errorCode == CM_ERROR_ALLOFFLINE && timeLeft > 7) {
207 osi_Log0(afsd_logp, "cm_Analyze passed CM_ERROR_ALLOFFLINE.");
209 /* cm_ForceUpdateVolume marks all servers as non_busy */
210 /* No it doesn't and it won't do anything if all of the
211 * the servers are marked as DOWN. So clear the DOWN
212 * flag and reset the busy state as well.
215 cm_GetServerList(fidp, userp, reqp, &serverspp);
216 serversp = *serverspp;
220 lock_ObtainWrite(&cm_serverLock);
221 for (tsrp = serversp; tsrp; tsrp=tsrp->next) {
222 tsrp->server->flags &= ~CM_SERVERFLAG_DOWN;
223 if (tsrp->status == busy)
224 tsrp->status = not_busy;
226 lock_ReleaseWrite(&cm_serverLock);
228 cm_FreeServerList(&serversp);
229 *serverspp = serversp;
234 if (fidp != NULL) /* Not a VLDB call */
235 cm_ForceUpdateVolume(fidp, userp, reqp);
238 /* if all servers are busy, mark them non-busy and start over */
239 if (errorCode == CM_ERROR_ALLBUSY && timeLeft > 7) {
242 cm_GetServerList(fidp, userp, reqp, &serverspp);
243 serversp = *serverspp;
246 lock_ObtainWrite(&cm_serverLock);
247 for (tsrp = serversp; tsrp; tsrp=tsrp->next) {
248 if (tsrp->status == busy)
249 tsrp->status = not_busy;
251 lock_ReleaseWrite(&cm_serverLock);
253 cm_FreeServerList(&serversp);
254 *serverspp = serversp;
259 /* special codes: VBUSY and VRESTARTING */
260 if (errorCode == VBUSY || errorCode == VRESTARTING) {
262 cm_GetServerList(fidp, userp, reqp, &serverspp);
263 serversp = *serverspp;
266 lock_ObtainWrite(&cm_serverLock);
267 for (tsrp = serversp; tsrp; tsrp=tsrp->next) {
268 if (tsrp->server == serverp
269 && tsrp->status == not_busy) {
274 lock_ReleaseWrite(&cm_serverLock);
276 cm_FreeServerList(&serversp);
277 *serverspp = serversp;
282 /* special codes: missing volumes */
283 if (errorCode == VNOVOL || errorCode == VMOVED || errorCode == VOFFLINE
284 || errorCode == VSALVAGE || errorCode == VNOSERVICE) {
285 /* Log server being offline for this volume */
286 osi_Log4(afsd_logp, "cm_Analyze found server %d.%d.%d.%d marked offline for a volume",
287 ((serverp->addr.sin_addr.s_addr & 0xff)),
288 ((serverp->addr.sin_addr.s_addr & 0xff00)>> 8),
289 ((serverp->addr.sin_addr.s_addr & 0xff0000)>> 16),
290 ((serverp->addr.sin_addr.s_addr & 0xff000000)>> 24));
291 /* Create Event Log message */
296 h = RegisterEventSource(NULL, AFS_DAEMON_EVENT_NAME);
297 sprintf(s, "cm_Analyze: Server %d.%d.%d.%d reported volume %d as missing.",
298 ((serverp->addr.sin_addr.s_addr & 0xff)),
299 ((serverp->addr.sin_addr.s_addr & 0xff00)>> 8),
300 ((serverp->addr.sin_addr.s_addr & 0xff0000)>> 16),
301 ((serverp->addr.sin_addr.s_addr & 0xff000000)>> 24),
304 ReportEvent(h, EVENTLOG_WARNING_TYPE, 0, 1009, NULL,
306 DeregisterEventSource(h);
309 /* Mark server offline for this volume */
311 cm_GetServerList(fidp, userp, reqp, &serverspp);
312 serversp = *serverspp;
315 for (tsrp = serversp; tsrp; tsrp=tsrp->next) {
316 if (tsrp->server == serverp)
317 tsrp->status = offline;
320 cm_FreeServerList(&serversp);
321 *serverspp = serversp;
328 if (errorCode == RX_CALL_TIMEOUT) {
329 /* server took longer than hardDeadTime
330 * don't mark server as down but don't retry
331 * this is to prevent the SMB session from timing out
332 * In addition, we log an event to the event log
338 h = RegisterEventSource(NULL, AFS_DAEMON_EVENT_NAME);
339 sprintf(s, "cm_Analyze: HardDeadTime exceeded.");
341 ReportEvent(h, EVENTLOG_WARNING_TYPE, 0, 1009, NULL,
343 DeregisterEventSource(h);
347 osi_Log0(afsd_logp, "cm_Analyze: hardDeadTime exceeded");
349 else if (errorCode >= -64 && errorCode < 0) {
350 /* mark server as down */
351 lock_ObtainMutex(&serverp->mx);
352 serverp->flags |= CM_SERVERFLAG_DOWN;
353 lock_ReleaseMutex(&serverp->mx);
358 if (errorCode == RXKADEXPIRED && !dead_session) {
359 lock_ObtainMutex(&userp->mx);
360 ucellp = cm_GetUCell(userp, serverp->cellp);
361 if (ucellp->ticketp) {
362 free(ucellp->ticketp);
363 ucellp->ticketp = NULL;
365 ucellp->flags &= ~CM_UCELLFLAG_RXKAD;
367 lock_ReleaseMutex(&userp->mx);
372 if (retry && dead_session)
376 /* drop this on the way out */
380 /* retry until we fail to find a connection */
384 long cm_ConnByMServers(cm_serverRef_t *serversp, cm_user_t *usersp,
385 cm_req_t *reqp, cm_conn_t **connpp)
388 cm_serverRef_t *tsrp;
391 int someBusy = 0, someOffline = 0, allBusy = 1, allDown = 1;
392 long timeUsed, timeLeft, hardTimeLeft;
400 timeUsed = (GetCurrentTime() - reqp->startTime) / 1000;
402 gettimeofday(&now, NULL);
403 timeUsed = sub_time(now, reqp->startTime) / 1000;
406 /* leave 5 seconds margin of safety */
407 timeLeft = ConnDeadtimeout - timeUsed - 5;
408 hardTimeLeft = HardDeadtimeout - timeUsed - 5;
410 lock_ObtainWrite(&cm_serverLock);
411 for (tsrp = serversp; tsrp; tsrp=tsrp->next) {
413 cm_GetServerNoLock(tsp);
414 lock_ReleaseWrite(&cm_serverLock);
415 if (!(tsp->flags & CM_SERVERFLAG_DOWN)) {
417 if (tsrp->status == busy)
419 else if (tsrp->status == offline)
423 code = cm_ConnByServer(tsp, usersp, connpp);
426 /* Set RPC timeout */
427 if (timeLeft > ConnDeadtimeout)
428 timeLeft = ConnDeadtimeout;
430 if (hardTimeLeft > HardDeadtimeout)
431 hardTimeLeft = HardDeadtimeout;
433 lock_ObtainMutex(&(*connpp)->mx);
434 rx_SetConnDeadTime((*connpp)->callp, timeLeft);
435 rx_SetConnHardDeadTime((*connpp)->callp, (u_short) hardTimeLeft);
436 lock_ReleaseMutex(&(*connpp)->mx);
443 lock_ObtainWrite(&cm_serverLock);
444 cm_PutServerNoLock(tsp);
447 lock_ReleaseWrite(&cm_serverLock);
448 if (firstError == 0) {
449 if (serversp == NULL)
450 firstError = CM_ERROR_NOSUCHVOLUME;
452 firstError = CM_ERROR_ALLOFFLINE;
454 firstError = CM_ERROR_ALLBUSY;
456 firstError = CM_ERROR_TIMEDOUT;
459 osi_Log1(afsd_logp, "cm_ConnByMServers returning %x", firstError);
463 /* called with a held server to GC all bad connections hanging off of the server */
464 void cm_GCConnections(cm_server_t *serverp)
470 lock_ObtainWrite(&cm_connLock);
471 lcpp = &serverp->connsp;
472 for(tcp = *lcpp; tcp; tcp = *lcpp) {
474 if (userp && tcp->refCount == 0 && (userp->vcRefs == 0)) {
475 /* do the deletion of this guy */
476 cm_PutServer(tcp->serverp);
477 cm_ReleaseUser(userp);
479 rx_DestroyConnection(tcp->callp);
480 lock_FinalizeMutex(&tcp->mx);
484 /* just advance to the next */
488 lock_ReleaseWrite(&cm_connLock);
491 static void cm_NewRXConnection(cm_conn_t *tcp, cm_ucell_t *ucellp,
492 cm_server_t *serverp)
497 struct rx_securityClass *secObjp;
500 if (serverp->type == CM_SERVER_VLDB) {
505 osi_assert(serverp->type == CM_SERVER_FILE);
509 if (ucellp->flags & CM_UCELLFLAG_RXKAD) {
513 tcp->cryptlevel = rxkad_crypt;
517 secObjp = rxkad_NewClientSecurityObject(level,
518 &ucellp->sessionKey, ucellp->kvno,
519 ucellp->ticketLen, ucellp->ticketp);
524 secObjp = rxnull_NewClientSecurityObject();
526 osi_assert(secObjp != NULL);
527 tcp->callp = rx_NewConnection(serverp->addr.sin_addr.s_addr,
532 rx_SetConnDeadTime(tcp->callp, ConnDeadtimeout);
533 rx_SetConnHardDeadTime(tcp->callp, HardDeadtimeout);
534 tcp->ucgen = ucellp->gen;
536 rxs_Release(secObjp); /* Decrement the initial refCount */
539 long cm_ConnByServer(cm_server_t *serverp, cm_user_t *userp, cm_conn_t **connpp)
544 lock_ObtainMutex(&userp->mx);
545 lock_ObtainWrite(&cm_connLock);
546 for(tcp = serverp->connsp; tcp; tcp=tcp->nextp) {
547 if (tcp->userp == userp)
551 /* find ucell structure */
552 ucellp = cm_GetUCell(userp, serverp->cellp);
554 cm_GetServer(serverp);
555 tcp = malloc(sizeof(*tcp));
556 memset(tcp, 0, sizeof(*tcp));
557 tcp->nextp = serverp->connsp;
558 serverp->connsp = tcp;
561 lock_InitializeMutex(&tcp->mx, "cm_conn_t mutex");
562 tcp->serverp = serverp;
563 tcp->cryptlevel = rxkad_clear;
564 cm_NewRXConnection(tcp, ucellp, serverp);
568 if ((tcp->ucgen < ucellp->gen) || (tcp->cryptlevel != cryptall))
570 rx_DestroyConnection(tcp->callp);
571 cm_NewRXConnection(tcp, ucellp, serverp);
575 lock_ReleaseWrite(&cm_connLock);
576 lock_ReleaseMutex(&userp->mx);
578 /* return this pointer to our caller */
579 osi_Log1(afsd_logp, "cm_ConnByServer returning conn 0x%x", (long) tcp);
585 long cm_Conn(struct cm_fid *fidp, struct cm_user *userp, cm_req_t *reqp,
590 cm_serverRef_t **serverspp;
592 code = cm_GetServerList(fidp, userp, reqp, &serverspp);
598 code = cm_ConnByMServers(*serverspp, userp, reqp, connpp);
599 cm_FreeServerList(serverspp);