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;
32 #define LANMAN_WKS_PARAM_KEY "SYSTEM\\CurrentControlSet\\Services\\lanmanworkstation\\parameters"
33 #define LANMAN_WKS_SESSION_TIMEOUT "SessTimeout"
35 afs_int32 cryptall = 0;
37 void cm_PutConn(cm_conn_t *connp)
39 lock_ObtainWrite(&cm_connLock);
40 osi_assert(connp->refCount-- > 0);
41 lock_ReleaseWrite(&cm_connLock);
44 void cm_InitConn(void)
46 static osi_once_t once;
51 if (osi_Once(&once)) {
52 lock_InitializeRWLock(&cm_connLock, "connection global lock");
54 /* keisa - read timeout value for lanmanworkstation service.
55 * It is used as hardtimeout for connections.
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;
72 RDRtimeout = CM_CONN_DEFAULTRDRTIMEOUT;
80 void cm_InitReq(cm_req_t *reqp)
82 memset((char *)reqp, 0, sizeof(cm_req_t));
84 reqp->startTime = GetCurrentTime();
86 gettimeofday(&reqp->startTime, NULL);
91 long cm_GetServerList(struct cm_fid *fidp, struct cm_user *userp,
92 struct cm_req *reqp, cm_serverRef_t **serverspp)
95 cm_volume_t *volp = NULL;
96 cm_serverRef_t *serversp = NULL;
97 cm_cell_t *cellp = NULL;
104 cellp = cm_FindCellByID(fidp->cell);
105 if (!cellp) return CM_ERROR_NOSUCHCELL;
107 code = cm_GetVolumeByID(cellp, fidp->volume, userp, reqp, &volp);
108 if (code) return code;
110 if (fidp->volume == volp->rwID)
111 serversp = volp->rwServersp;
112 else if (fidp->volume == volp->roID)
113 serversp = volp->roServersp;
114 else if (fidp->volume == volp->bkID)
115 serversp = volp->bkServersp;
120 *serverspp = serversp;
125 * Analyze the error return from an RPC. Determine whether or not to retry,
126 * and if we're going to retry, determine whether failover is appropriate,
127 * and whether timed backoff is appropriate.
129 * If the error code is from cm_Conn() or friends, it will be a CM_ERROR code.
130 * Otherwise it will be an RPC code. This may be a UNIX code (e.g. EDQUOT), or
131 * it may be an RX code, or it may be a special code (e.g. VNOVOL), or it may
132 * be a security code (e.g. RXKADEXPIRED).
134 * If the error code is from cm_Conn() or friends, connp will be NULL.
136 * For VLDB calls, fidp will be NULL.
138 * 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, cm_callbackRequest_t *cbrp, long errorCode)
144 cm_server_t *serverp;
145 cm_serverRef_t *serversp, *tsrp;
150 osi_Log2(afsd_logp, "cm_Analyze connp 0x%x, code %d",
151 (long) connp, errorCode);
153 /* no locking required, since connp->serverp never changes after
155 dead_session = (userp->cellInfop == NULL);
157 serverp = connp->serverp;
159 /* Update callback pointer */
160 if (cbrp && errorCode == 0) cbrp->serverp = connp->serverp;
162 /* If not allowed to retry, don't */
163 if (reqp->flags & CM_REQ_NORETRY)
166 /* if timeout - check that is did not exceed the SMB timeout
168 if (errorCode == CM_ERROR_TIMEDOUT)
170 long timeUsed, timeLeft;
171 /* timeleft - get if from reqp the same way as cmXonnByMServers does */
173 timeUsed = (GetCurrentTime() - reqp->startTime) / 1000;
175 gettimeofday(&now, NULL);
176 timeUsed = sub_time(now, reqp->startTime) / 1000;
179 /* leave 5 seconds margin for sleep */
180 timeLeft = RDRtimeout - timeUsed;
184 cm_CheckServers(CM_FLAG_CHECKDOWNSERVERS, NULL);
189 /* if all servers are offline, mark them non-busy and start over */
190 if (errorCode == CM_ERROR_ALLOFFLINE) {
191 osi_Log0(afsd_logp, "cm_Analyze passed CM_ERROR_ALLOFFLINE.");
193 /* cm_ForceUpdateVolume marks all servers as non_busy */
194 cm_ForceUpdateVolume(fidp, userp, reqp);
198 /* if all servers are busy, mark them non-busy and start over */
199 if (errorCode == CM_ERROR_ALLBUSY) {
200 cm_GetServerList(fidp, userp, reqp, &serversp);
201 for (tsrp = serversp; tsrp; tsrp=tsrp->next) {
202 if (tsrp->status == busy)
203 tsrp->status = not_busy;
209 /* special codes: VBUSY and VRESTARTING */
210 if (errorCode == VBUSY || errorCode == VRESTARTING) {
211 cm_GetServerList(fidp, userp, reqp, &serversp);
212 for (tsrp = serversp; tsrp; tsrp=tsrp->next) {
213 if (tsrp->server == serverp
214 && tsrp->status == not_busy) {
222 /* special codes: missing volumes */
223 if (errorCode == VNOVOL || errorCode == VMOVED || errorCode == VOFFLINE
224 || errorCode == VSALVAGE || errorCode == VNOSERVICE) {
228 /* Log server being offline for this volume */
229 osi_Log4(afsd_logp, "cm_Analyze found server %d.%d.%d.%d marked offline for a volume",
230 ((serverp->addr.sin_addr.s_addr & 0xff)),
231 ((serverp->addr.sin_addr.s_addr & 0xff00)>> 8),
232 ((serverp->addr.sin_addr.s_addr & 0xff0000)>> 16),
233 ((serverp->addr.sin_addr.s_addr & 0xff000000)>> 24));
234 /* Create Event Log message */
239 h = RegisterEventSource(NULL, AFS_DAEMON_EVENT_NAME);
240 sprintf(s, "cm_Analyze: Server %d.%d.%d.%d reported volume %d as missing.",
241 ((serverp->addr.sin_addr.s_addr & 0xff)),
242 ((serverp->addr.sin_addr.s_addr & 0xff00)>> 8),
243 ((serverp->addr.sin_addr.s_addr & 0xff0000)>> 16),
244 ((serverp->addr.sin_addr.s_addr & 0xff000000)>> 24),
247 ReportEvent(h, EVENTLOG_WARNING_TYPE, 0, 1009, NULL,
249 DeregisterEventSource(h);
252 /* Mark server offline for this volume */
253 cm_GetServerList(fidp, userp, reqp, &serversp);
255 for (tsrp = serversp; tsrp; tsrp=tsrp->next) {
256 if (tsrp->server == serverp)
257 tsrp->status = offline;
263 if (errorCode == RX_CALL_TIMEOUT) {
264 /* server took longer than hardDeadTime
265 * don't mark server as down but don't retry
266 * this is to prevent the SMB session from timing out
267 * In addition, we log an event to the event log
273 h = RegisterEventSource(NULL, AFS_DAEMON_EVENT_NAME);
274 sprintf(s, "cm_Analyze: HardDeadTime exceeded.");
276 ReportEvent(h, EVENTLOG_WARNING_TYPE, 0, 1009, NULL,
278 DeregisterEventSource(h);
282 osi_Log0(afsd_logp, "cm_Analyze: hardDeadTime exceeded");
284 else if (errorCode >= -64 && errorCode < 0) {
285 /* mark server as down */
286 lock_ObtainMutex(&serverp->mx);
287 serverp->flags |= CM_SERVERFLAG_DOWN;
288 lock_ReleaseMutex(&serverp->mx);
292 if (errorCode == RXKADEXPIRED && !dead_session) {
293 lock_ObtainMutex(&userp->mx);
294 ucellp = cm_GetUCell(userp, serverp->cellp);
295 if (ucellp->ticketp) {
296 free(ucellp->ticketp);
297 ucellp->ticketp = NULL;
299 ucellp->flags &= ~CM_UCELLFLAG_RXKAD;
301 lock_ReleaseMutex(&userp->mx);
305 if (retry && dead_session)
309 /* drop this on the way out */
313 /* retry until we fail to find a connection */
317 long cm_ConnByMServers(cm_serverRef_t *serversp, cm_user_t *usersp,
318 cm_req_t *reqp, cm_conn_t **connpp)
321 cm_serverRef_t *tsrp;
324 int someBusy = 0, someOffline = 0;
325 long timeUsed, timeLeft, hardTimeLeft;
333 timeUsed = (GetCurrentTime() - reqp->startTime) / 1000;
335 gettimeofday(&now, NULL);
336 timeUsed = sub_time(now, reqp->startTime) / 1000;
339 /* leave 5 seconds margin of safety */
340 timeLeft = RDRtimeout - timeUsed - 5;
341 hardTimeLeft = timeLeft;
343 /* Time enough to do an RPC? */
345 return CM_ERROR_TIMEDOUT;
348 lock_ObtainWrite(&cm_serverLock);
350 for(tsrp = serversp; tsrp; tsrp=tsrp->next) {
353 lock_ReleaseWrite(&cm_serverLock);
354 if (!(tsp->flags & CM_SERVERFLAG_DOWN)) {
355 if (tsrp->status == busy)
357 else if (tsrp->status == offline)
360 code = cm_ConnByServer(tsp, usersp, connpp);
363 /* Set RPC timeout */
364 if (timeLeft > CM_CONN_CONNDEADTIME)
365 timeLeft = CM_CONN_CONNDEADTIME;
367 if (hardTimeLeft > CM_CONN_HARDDEADTIME)
368 hardTimeLeft = CM_CONN_HARDDEADTIME;
370 lock_ObtainMutex(&(*connpp)->mx);
371 rx_SetConnDeadTime((*connpp)->callp,
373 rx_SetConnHardDeadTime((*connpp)->callp,
374 (u_short) hardTimeLeft);
375 lock_ReleaseMutex(&(*connpp)->mx);
383 lock_ObtainWrite(&cm_serverLock);
384 osi_assert(tsp->refCount-- > 0);
387 lock_ReleaseWrite(&cm_serverLock);
388 if (firstError == 0) {
389 if (someBusy) firstError = CM_ERROR_ALLBUSY;
390 else if (someOffline) firstError = CM_ERROR_ALLOFFLINE;
391 else if (serversp) firstError = CM_ERROR_TIMEDOUT;
392 /* Only return CM_ERROR_NOSUCHVOLUME if there are no
393 servers for this volume */
394 else firstError = CM_ERROR_NOSUCHVOLUME;
396 osi_Log1(afsd_logp, "cm_ConnByMServers returning %x", firstError);
400 /* called with a held server to GC all bad connections hanging off of the server */
401 void cm_GCConnections(cm_server_t *serverp)
407 lock_ObtainWrite(&cm_connLock);
408 lcpp = &serverp->connsp;
409 for(tcp = *lcpp; tcp; tcp = *lcpp) {
411 if (userp && tcp->refCount == 0 && (userp->vcRefs == 0)) {
412 /* do the deletion of this guy */
413 cm_ReleaseUser(userp);
415 rx_DestroyConnection(tcp->callp);
416 lock_FinalizeMutex(&tcp->mx);
420 /* just advance to the next */
424 lock_ReleaseWrite(&cm_connLock);
427 static void cm_NewRXConnection(cm_conn_t *tcp, cm_ucell_t *ucellp,
428 cm_server_t *serverp)
433 struct rx_securityClass *secObjp;
436 if (serverp->type == CM_SERVER_VLDB) {
441 osi_assert(serverp->type == CM_SERVER_FILE);
445 if (ucellp->flags & CM_UCELLFLAG_RXKAD) {
449 tcp->cryptlevel = rxkad_crypt;
453 secObjp = rxkad_NewClientSecurityObject(level,
454 &ucellp->sessionKey, ucellp->kvno,
455 ucellp->ticketLen, ucellp->ticketp);
460 secObjp = rxnull_NewClientSecurityObject();
462 osi_assert(secObjp != NULL);
463 tcp->callp = rx_NewConnection(serverp->addr.sin_addr.s_addr,
468 rx_SetConnDeadTime(tcp->callp, CM_CONN_CONNDEADTIME);
469 rx_SetConnHardDeadTime(tcp->callp, CM_CONN_HARDDEADTIME);
470 tcp->ucgen = ucellp->gen;
473 long cm_ConnByServer(cm_server_t *serverp, cm_user_t *userp, cm_conn_t **connpp)
478 lock_ObtainMutex(&userp->mx);
479 lock_ObtainWrite(&cm_connLock);
480 for(tcp = serverp->connsp; tcp; tcp=tcp->nextp) {
481 if (tcp->userp == userp) break;
483 /* find ucell structure */
484 ucellp = cm_GetUCell(userp, serverp->cellp);
486 tcp = malloc(sizeof(*tcp));
487 memset(tcp, 0, sizeof(*tcp));
488 tcp->nextp = serverp->connsp;
489 serverp->connsp = tcp;
492 lock_InitializeMutex(&tcp->mx, "cm_conn_t mutex");
493 tcp->serverp = serverp;
494 tcp->cryptlevel = rxkad_clear;
495 cm_NewRXConnection(tcp, ucellp, serverp);
499 if ((tcp->ucgen < ucellp->gen) || (tcp->cryptlevel != cryptall))
501 rx_DestroyConnection(tcp->callp);
502 cm_NewRXConnection(tcp, ucellp, serverp);
506 lock_ReleaseWrite(&cm_connLock);
507 lock_ReleaseMutex(&userp->mx);
509 /* return this pointer to our caller */
510 osi_Log1(afsd_logp, "cm_ConnByServer returning conn 0x%x", (long) tcp);
516 long cm_Conn(struct cm_fid *fidp, struct cm_user *userp, cm_req_t *reqp,
521 cm_serverRef_t *serversp;
523 code = cm_GetServerList(fidp, userp, reqp, &serversp);
529 code = cm_ConnByMServers(serversp, userp, reqp, connpp);