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.
141 cm_Analyze(cm_conn_t *connp, cm_user_t *userp, cm_req_t *reqp,
143 AFSVolSync *volSyncp, cm_callbackRequest_t *cbrp, long errorCode)
145 cm_server_t *serverp;
146 cm_serverRef_t *serversp, *tsrp;
151 osi_Log2(afsd_logp, "cm_Analyze connp 0x%x, code %d",
152 (long) connp, errorCode);
154 /* no locking required, since connp->serverp never changes after
156 dead_session = (userp->cellInfop == NULL);
158 serverp = connp->serverp;
160 /* Update callback pointer */
161 if (cbrp && errorCode == 0) cbrp->serverp = connp->serverp;
163 /* If not allowed to retry, don't */
164 if (reqp->flags & CM_REQ_NORETRY)
167 /* if timeout - check that is did not exceed the SMB timeout
169 if (errorCode == CM_ERROR_TIMEDOUT)
171 long timeUsed, timeLeft;
172 /* timeleft - get if from reqp the same way as cmXonnByMServers does */
174 timeUsed = (GetCurrentTime() - reqp->startTime) / 1000;
176 gettimeofday(&now, NULL);
177 timeUsed = sub_time(now, reqp->startTime) / 1000;
180 /* leave 5 seconds margin for sleep */
181 timeLeft = RDRtimeout - timeUsed;
185 cm_CheckServers(CM_FLAG_CHECKDOWNSERVERS, NULL);
190 /* if all servers are offline, mark them non-busy and start over */
191 if (errorCode == CM_ERROR_ALLOFFLINE) {
192 osi_Log0(afsd_logp, "cm_Analyze passed CM_ERROR_ALLOFFLINE.");
194 /* cm_ForceUpdateVolume marks all servers as non_busy */
195 cm_ForceUpdateVolume(fidp, userp, reqp);
199 /* if all servers are busy, mark them non-busy and start over */
200 if (errorCode == CM_ERROR_ALLBUSY) {
201 cm_GetServerList(fidp, userp, reqp, &serversp);
202 for (tsrp = serversp; tsrp; tsrp=tsrp->next) {
203 if (tsrp->status == busy)
204 tsrp->status = not_busy;
210 /* special codes: VBUSY and VRESTARTING */
211 if (errorCode == VBUSY || errorCode == VRESTARTING) {
212 cm_GetServerList(fidp, userp, reqp, &serversp);
213 for (tsrp = serversp; tsrp; tsrp=tsrp->next) {
214 if (tsrp->server == serverp
215 && tsrp->status == not_busy) {
223 /* special codes: missing volumes */
224 if (errorCode == VNOVOL || errorCode == VMOVED || errorCode == VOFFLINE
225 || errorCode == VSALVAGE || errorCode == VNOSERVICE) {
226 /* Log server being offline for this volume */
227 osi_Log4(afsd_logp, "cm_Analyze found server %d.%d.%d.%d marked offline for a volume",
228 ((serverp->addr.sin_addr.s_addr & 0xff)),
229 ((serverp->addr.sin_addr.s_addr & 0xff00)>> 8),
230 ((serverp->addr.sin_addr.s_addr & 0xff0000)>> 16),
231 ((serverp->addr.sin_addr.s_addr & 0xff000000)>> 24));
232 /* Create Event Log message */
237 h = RegisterEventSource(NULL, AFS_DAEMON_EVENT_NAME);
238 sprintf(s, "cm_Analyze: Server %d.%d.%d.%d reported volume %d as missing.",
239 ((serverp->addr.sin_addr.s_addr & 0xff)),
240 ((serverp->addr.sin_addr.s_addr & 0xff00)>> 8),
241 ((serverp->addr.sin_addr.s_addr & 0xff0000)>> 16),
242 ((serverp->addr.sin_addr.s_addr & 0xff000000)>> 24),
245 ReportEvent(h, EVENTLOG_WARNING_TYPE, 0, 1009, NULL,
247 DeregisterEventSource(h);
250 /* Mark server offline for this volume */
251 cm_GetServerList(fidp, userp, reqp, &serversp);
253 for (tsrp = serversp; tsrp; tsrp=tsrp->next) {
254 if (tsrp->server == serverp)
255 tsrp->status = offline;
261 if (errorCode == RX_CALL_TIMEOUT) {
262 /* server took longer than hardDeadTime
263 * don't mark server as down but don't retry
264 * this is to prevent the SMB session from timing out
265 * In addition, we log an event to the event log
271 h = RegisterEventSource(NULL, AFS_DAEMON_EVENT_NAME);
272 sprintf(s, "cm_Analyze: HardDeadTime exceeded.");
274 ReportEvent(h, EVENTLOG_WARNING_TYPE, 0, 1009, NULL,
276 DeregisterEventSource(h);
280 osi_Log0(afsd_logp, "cm_Analyze: hardDeadTime exceeded");
282 else if (errorCode >= -64 && errorCode < 0) {
283 /* mark server as down */
284 lock_ObtainMutex(&serverp->mx);
285 serverp->flags |= CM_SERVERFLAG_DOWN;
286 lock_ReleaseMutex(&serverp->mx);
290 if (errorCode == RXKADEXPIRED && !dead_session) {
291 lock_ObtainMutex(&userp->mx);
292 ucellp = cm_GetUCell(userp, serverp->cellp);
293 if (ucellp->ticketp) {
294 free(ucellp->ticketp);
295 ucellp->ticketp = NULL;
297 ucellp->flags &= ~CM_UCELLFLAG_RXKAD;
299 lock_ReleaseMutex(&userp->mx);
303 if (retry && dead_session)
307 /* drop this on the way out */
311 /* retry until we fail to find a connection */
315 long cm_ConnByMServers(cm_serverRef_t *serversp, cm_user_t *usersp,
316 cm_req_t *reqp, cm_conn_t **connpp)
319 cm_serverRef_t *tsrp;
322 int someBusy = 0, someOffline = 0, allDown = 1;
323 long timeUsed, timeLeft, hardTimeLeft;
331 timeUsed = (GetCurrentTime() - reqp->startTime) / 1000;
333 gettimeofday(&now, NULL);
334 timeUsed = sub_time(now, reqp->startTime) / 1000;
337 /* leave 5 seconds margin of safety */
338 timeLeft = RDRtimeout - timeUsed - 5;
339 hardTimeLeft = timeLeft;
341 /* Time enough to do an RPC? */
343 return CM_ERROR_TIMEDOUT;
346 lock_ObtainWrite(&cm_serverLock);
348 for(tsrp = serversp; tsrp; tsrp=tsrp->next) {
351 lock_ReleaseWrite(&cm_serverLock);
352 if (!(tsp->flags & CM_SERVERFLAG_DOWN)) {
354 if (tsrp->status == busy)
356 else if (tsrp->status == offline)
359 code = cm_ConnByServer(tsp, usersp, connpp);
362 /* Set RPC timeout */
363 if (timeLeft > CM_CONN_CONNDEADTIME)
364 timeLeft = CM_CONN_CONNDEADTIME;
366 if (hardTimeLeft > CM_CONN_HARDDEADTIME)
367 hardTimeLeft = CM_CONN_HARDDEADTIME;
369 lock_ObtainMutex(&(*connpp)->mx);
370 rx_SetConnDeadTime((*connpp)->callp,
372 rx_SetConnHardDeadTime((*connpp)->callp,
373 (u_short) hardTimeLeft);
374 lock_ReleaseMutex(&(*connpp)->mx);
382 lock_ObtainWrite(&cm_serverLock);
383 osi_assert(tsp->refCount-- > 0);
386 lock_ReleaseWrite(&cm_serverLock);
387 if (firstError == 0) {
389 firstError = CM_ERROR_ALLBUSY;
390 else if (someOffline)
391 firstError = CM_ERROR_ALLOFFLINE;
392 else if (!allDown && serversp)
393 firstError = CM_ERROR_TIMEDOUT;
394 /* Only return CM_ERROR_NOSUCHVOLUME if there are no
395 servers for this volume */
397 firstError = CM_ERROR_NOSUCHVOLUME;
399 osi_Log1(afsd_logp, "cm_ConnByMServers returning %x", firstError);
403 /* called with a held server to GC all bad connections hanging off of the server */
404 void cm_GCConnections(cm_server_t *serverp)
410 lock_ObtainWrite(&cm_connLock);
411 lcpp = &serverp->connsp;
412 for(tcp = *lcpp; tcp; tcp = *lcpp) {
414 if (userp && tcp->refCount == 0 && (userp->vcRefs == 0)) {
415 /* do the deletion of this guy */
416 cm_ReleaseUser(userp);
418 rx_DestroyConnection(tcp->callp);
419 lock_FinalizeMutex(&tcp->mx);
423 /* just advance to the next */
427 lock_ReleaseWrite(&cm_connLock);
430 static void cm_NewRXConnection(cm_conn_t *tcp, cm_ucell_t *ucellp,
431 cm_server_t *serverp)
436 struct rx_securityClass *secObjp;
439 if (serverp->type == CM_SERVER_VLDB) {
444 osi_assert(serverp->type == CM_SERVER_FILE);
448 if (ucellp->flags & CM_UCELLFLAG_RXKAD) {
452 tcp->cryptlevel = rxkad_crypt;
456 secObjp = rxkad_NewClientSecurityObject(level,
457 &ucellp->sessionKey, ucellp->kvno,
458 ucellp->ticketLen, ucellp->ticketp);
463 secObjp = rxnull_NewClientSecurityObject();
465 osi_assert(secObjp != NULL);
466 tcp->callp = rx_NewConnection(serverp->addr.sin_addr.s_addr,
471 rx_SetConnDeadTime(tcp->callp, CM_CONN_CONNDEADTIME);
472 rx_SetConnHardDeadTime(tcp->callp, CM_CONN_HARDDEADTIME);
473 tcp->ucgen = ucellp->gen;
476 long cm_ConnByServer(cm_server_t *serverp, cm_user_t *userp, cm_conn_t **connpp)
481 lock_ObtainMutex(&userp->mx);
482 lock_ObtainWrite(&cm_connLock);
483 for(tcp = serverp->connsp; tcp; tcp=tcp->nextp) {
484 if (tcp->userp == userp) break;
486 /* find ucell structure */
487 ucellp = cm_GetUCell(userp, serverp->cellp);
489 tcp = malloc(sizeof(*tcp));
490 memset(tcp, 0, sizeof(*tcp));
491 tcp->nextp = serverp->connsp;
492 serverp->connsp = tcp;
495 lock_InitializeMutex(&tcp->mx, "cm_conn_t mutex");
496 tcp->serverp = serverp;
497 tcp->cryptlevel = rxkad_clear;
498 cm_NewRXConnection(tcp, ucellp, serverp);
502 if ((tcp->ucgen < ucellp->gen) || (tcp->cryptlevel != cryptall))
504 rx_DestroyConnection(tcp->callp);
505 cm_NewRXConnection(tcp, ucellp, serverp);
509 lock_ReleaseWrite(&cm_connLock);
510 lock_ReleaseMutex(&userp->mx);
512 /* return this pointer to our caller */
513 osi_Log1(afsd_logp, "cm_ConnByServer returning conn 0x%x", (long) tcp);
519 long cm_Conn(struct cm_fid *fidp, struct cm_user *userp, cm_req_t *reqp,
524 cm_serverRef_t *serversp;
526 code = cm_GetServerList(fidp, userp, reqp, &serversp);
532 code = cm_ConnByMServers(serversp, userp, reqp, connpp);