09d7d8f04cf0affa08fdb715e1ca737eec759b10
[openafs.git] / src / afs / afs_conn.c
1 /*
2  * Copyright 2000, International Business Machines Corporation and others.
3  * All Rights Reserved.
4  *
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
8  */
9
10 /*
11  * Implements:
12  */
13 #include <afsconfig.h>
14 #include "afs/param.h"
15
16
17 #include "afs/stds.h"
18 #include "afs/sysincludes.h"    /* Standard vendor system headers */
19
20 #if !defined(UKERNEL)
21 #if !defined(AFS_LINUX20_ENV)
22 #include <net/if.h>
23 #endif
24 #include <netinet/in.h>
25
26 #ifdef AFS_SGI62_ENV
27 #include "h/hashing.h"
28 #endif
29 #if !defined(AFS_HPUX110_ENV) && !defined(AFS_LINUX20_ENV) && !defined(AFS_DARWIN_ENV)
30 #include <netinet/in_var.h>
31 #endif /* ! AFS_HPUX110_ENV */
32 #endif /* !defined(UKERNEL) */
33
34 #include "afsincludes.h"        /* Afs-based standard headers */
35 #include "afs/afs_stats.h"      /* afs statistics */
36
37 #if     defined(AFS_SUN5_ENV)
38 #include <inet/led.h>
39 #include <inet/common.h>
40 #include <netinet/ip6.h>
41 #include <inet/ip.h>
42 #endif
43
44 /* Exported variables */
45 afs_rwlock_t afs_xconn;         /* allocation lock for new things */
46 afs_rwlock_t afs_xinterface;    /* for multiple client address */
47 afs_int32 cryptall = 0;         /* encrypt all communications */
48
49 /* some connection macros */
50
51 /* a constructor */
52 #define new_conn_vector(xcv) \
53 do { \
54         xcv = (struct sa_conn_vector *) \
55         afs_osi_Alloc(sizeof(struct sa_conn_vector)); \
56         if (xcv) { \
57                 memset((char *)xcv, 0, sizeof(struct sa_conn_vector)); \
58         } \
59 } while (0);
60
61 /* select a connection to return (if no connection has lower utilization
62  * than any other) */
63 #define conn_vec_select_conn(xcv, bix, conn) \
64 do { \
65     (bix) = ((xcv)->select_index)++ % CVEC_LEN; \
66     (conn) = &((xcv)->cvec[bix]); \
67 } while (0);
68
69 #define struct_conn(s) ((struct afs_conn *)(s))
70
71 #define REPORT_CONNECTIONS_ISSUED 0 /* enable to see utilization */
72
73 /**
74  * Find a connection with call slots available, allocating one
75  * if nothing is available and we find an allocated slot
76  * @param xcv  A connection vector
77  * @param create  If set, a new connection may be created
78  */
79 static struct afs_conn *
80 find_preferred_connection(struct sa_conn_vector *xcv, int create)
81 {
82     afs_int32 cix, bix;
83     struct afs_conn *tc = NULL;
84
85     bix = -1;
86     for(cix = 0; cix < CVEC_LEN; ++cix) {
87         tc = &(xcv->cvec[cix]);
88         if (!tc->id) {
89             if (create) {
90                 tc->parent = xcv;
91                 tc->forceConnectFS = 1;
92                 tc->activated = 1;
93                 bix = cix;
94                 break;
95             } /* create */
96         } else {
97             if (tc->refCount < (RX_MAXCALLS-1)) {
98                 bix = cix;
99                 goto f_conn;
100             } else if (cix == (CVEC_LEN-1))
101                 conn_vec_select_conn(xcv, bix, tc);
102         } /* tc->id */
103     } /* for cix < CVEC_LEN */
104
105     if (bix < 0) {
106         afs_warn("find_preferred_connection: no connection and !create\n");
107         tc = NULL;
108         goto out;
109     }
110
111 f_conn:
112     tc->refCount++;
113     xcv->refCount++;
114
115 #if REPORT_CONNECTIONS_ISSUED
116     afs_warn("Issuing conn %d refCount=%d parent refCount=%d\n", bix,
117              tc->refCount, xcv->refCount);
118 #endif
119
120 out:
121     return (tc);
122
123 }        /* find_preferred_connection */
124
125
126 /**
127  * Release all connections for unix user xu at server xs
128  * @param xu
129  * @param xs
130  */
131 static void
132 release_conns_user_server(struct unixuser *xu, struct server *xs)
133 {
134     int cix, glocked;
135     struct srvAddr *sa;
136     struct afs_conn *tc;
137     struct sa_conn_vector *tcv, **lcv, *tcvn;
138     for (sa = (xs)->addr; sa; sa = sa->next_sa) {
139         lcv = &sa->conns;
140         for (tcv = *lcv; tcv; lcv = &tcv->next, tcv = *lcv) {
141             if (tcv->user == (xu) && tcv->refCount == 0) {
142                 *lcv = tcv->next;
143                 /* our old friend, the GLOCK */
144                 glocked = ISAFS_GLOCK();
145                 if (glocked)
146                     AFS_GUNLOCK();
147                 for(cix = 0; cix < CVEC_LEN; ++cix) {
148                     tc = &(tcv->cvec[cix]);
149                     if (tc->activated) {
150                         rx_SetConnSecondsUntilNatPing(tc->id, 0);
151                         rx_DestroyConnection(tc->id);
152                         /* find another eligible connection */
153                         if (sa->natping == tc) {
154                             int cin;
155                             struct afs_conn *tcn;
156                             for (tcvn = sa->conns; tcvn; tcvn = tcvn->next) {
157                                 if (tcvn == tcv)
158                                     continue;
159                                 for(cin = 0; cin < CVEC_LEN; ++cin) {
160                                     tcn = &(tcvn->cvec[cin]);
161                                     if (tcn->activated) {
162                                         rx_SetConnSecondsUntilNatPing(tcn->id, 20);
163                                         sa->natping = tcn;
164                                         break;
165                                     }
166                                 }
167                             }
168                         }
169                     }
170                 }
171                 if (glocked)
172                     AFS_GLOCK();
173                 afs_osi_Free(tcv, sizeof(struct sa_conn_vector));
174                 break;    /* at most one instance per server */
175             } /*Found unreferenced connection for user */
176         }
177     } /*For each connection on the server */
178
179 }        /* release_conns_user_server */
180
181
182 static void
183 release_conns_vector(struct sa_conn_vector *xcv)
184 {
185     int cix, glocked;
186     struct afs_conn *tc;
187     struct sa_conn_vector *tcv = NULL;
188     struct sa_conn_vector **lcv = NULL;
189     for (tcv = xcv; tcv; lcv = &tcv->next, tcv = *lcv) {
190         *lcv = tcv->next;
191         /* you know it, you love it, the GLOCK */
192         glocked = ISAFS_GLOCK();
193         if (glocked)
194             AFS_GUNLOCK(); \
195         for(cix = 0; cix < CVEC_LEN; ++cix) {
196             tc = &(tcv->cvec[cix]);
197             if (tc->activated) {
198                 rx_SetConnSecondsUntilNatPing(tc->id, 0);
199                 rx_DestroyConnection(tc->id);
200                 if (tcv->srvr->natping == tc)
201                     tcv->srvr->natping = NULL;
202             }
203         }
204         if (glocked)
205             AFS_GLOCK();
206         afs_osi_Free(tcv, sizeof(struct sa_conn_vector));
207     }
208
209 }        /* release_conns_vector */
210
211
212 unsigned int VNOSERVERS = 0;
213
214 /**
215  * Pick a security object to use for a connection to a given server,
216  * by a given user
217  *
218  * @param[in] conn
219  *      The AFS connection for which the security object is required
220  * @param[out] secLevel
221  *      The security level of the returned object
222  *
223  * @return
224  *      An rx security object. This function is guaranteed to return
225  *      an object, although that object may be rxnull (with a secLevel
226  *      of 0)
227  */
228 static struct rx_securityClass *
229 afs_pickSecurityObject(struct afs_conn *conn, int *secLevel)
230 {
231     struct rx_securityClass *secObj = NULL;
232     union tokenUnion *token;
233
234     /* Do we have tokens ? */
235     if (conn->parent->user->states & UHasTokens) {
236         token = afs_FindToken(conn->parent->user->tokens, RX_SECIDX_KAD);
237         if (token) {
238             *secLevel = RX_SECIDX_KAD;
239             /* kerberos tickets on channel 2 */
240             secObj = rxkad_NewClientSecurityObject(
241                          cryptall ? rxkad_crypt : rxkad_clear,
242                          (struct ktc_encryptionKey *)
243                                token->rxkad.clearToken.HandShakeKey,
244                          token->rxkad.clearToken.AuthHandle,
245                          token->rxkad.ticketLen, token->rxkad.ticket);
246             /* We're going to use this token, so populate the viced */
247             conn->parent->user->viceId = token->rxkad.clearToken.ViceId;
248         }
249      }
250      if (secObj == NULL) {
251         *secLevel = 0;
252         secObj = rxnull_NewClientSecurityObject();
253      }
254
255      return secObj;
256 }
257
258
259 /**
260  * Try setting up a connection to the server containing the specified fid.
261  * Gets the volume, checks if it's up and does the connection by server address.
262  *
263  * @param afid
264  * @param areq Request filled in by the caller.
265  * @param locktype Type of lock that will be used.
266  *
267  * @return The conn struct, or NULL.
268  */
269 struct afs_conn *
270 afs_Conn(struct VenusFid *afid, struct vrequest *areq,
271          afs_int32 locktype, struct rx_connection **rxconn)
272 {
273     u_short fsport = AFS_FSPORT;
274     struct volume *tv;
275     struct afs_conn *tconn = NULL;
276     struct srvAddr *lowp = NULL;
277     struct unixuser *tu;
278     int notbusy;
279     int i;
280     struct srvAddr *sa1p;
281     afs_int32 replicated = -1; /* a single RO will increment to 0 */
282
283     *rxconn = NULL;
284
285     AFS_STATCNT(afs_Conn);
286     /* Get fid's volume. */
287     tv = afs_GetVolume(afid, areq, READ_LOCK);
288     if (!tv) {
289         if (areq) {
290             afs_FinalizeReq(areq);
291             areq->volumeError = 1;
292         }
293         return NULL;
294     }
295
296     if (tv->serverHost[0] && tv->serverHost[0]->cell) {
297         fsport = tv->serverHost[0]->cell->fsport;
298     } else {
299         VNOSERVERS++;
300     }
301
302     /* First is always lowest rank, if it's up */
303     if ((tv->status[0] == not_busy) && tv->serverHost[0]
304         && !(tv->serverHost[0]->addr->sa_flags & SRVR_ISDOWN) &&
305         !(((areq->idleError > 0) || (areq->tokenError > 0))
306           && (areq->skipserver[0] == 1)))
307         lowp = tv->serverHost[0]->addr;
308
309     /* Otherwise we look at all of them. There are seven levels of
310      * not_busy. This means we will check a volume seven times before it
311      * is marked offline. Ideally, we only need two levels, but this
312      * serves a second purpose of waiting some number of seconds before
313      * the client decides the volume is offline (ie: a clone could finish
314      * in this time).
315      */
316     for (notbusy = not_busy; (!lowp && (notbusy <= end_not_busy)); notbusy++) {
317         for (i = 0; i < AFS_MAXHOSTS && tv->serverHost[i]; i++) {
318             if (tv->states & VRO)
319                 replicated++;
320             if (((areq->tokenError > 0)||(areq->idleError > 0))
321                 && (areq->skipserver[i] == 1))
322                 continue;
323             if (tv->status[i] != notbusy) {
324                 if (tv->status[i] == rd_busy || tv->status[i] == rdwr_busy) {
325                     if (!areq->busyCount)
326                         areq->busyCount++;
327                 } else if (tv->status[i] == offline) {
328                     if (!areq->volumeError)
329                         areq->volumeError = VOLMISSING;
330                 }
331                 continue;
332             }
333             for (sa1p = tv->serverHost[i]->addr; sa1p; sa1p = sa1p->next_sa) {
334                 if (sa1p->sa_flags & SRVR_ISDOWN)
335                     continue;
336                 if (!lowp || (lowp->sa_iprank > sa1p->sa_iprank))
337                     lowp = sa1p;
338             }
339         }
340     }
341     if ((replicated == -1) && (tv->states & VRO)) {
342         for (i = 0; i < AFS_MAXHOSTS && tv->serverHost[i]; i++) {
343             if (tv->states & VRO)
344                 replicated++;
345         }
346     } else
347         replicated = 0;
348
349     afs_PutVolume(tv, READ_LOCK);
350
351     if (lowp) {
352         tu = afs_GetUser(areq->uid, afid->Cell, SHARED_LOCK);
353         tconn = afs_ConnBySA(lowp, fsport, afid->Cell, tu, 0 /*!force */ ,
354                              1 /*create */ , locktype, replicated, rxconn);
355
356         afs_PutUser(tu, SHARED_LOCK);
357     }
358
359     return tconn;
360 }                               /*afs_Conn */
361
362
363 /**
364  * Connects to a server by it's server address.
365  *
366  * @param sap Server address.
367  * @param aport Server port.
368  * @param acell
369  * @param tu Connect as this user.
370  * @param force_if_down
371  * @param create
372  * @param replicated
373  * @param locktype Specifies type of lock to be used for this function.
374  *
375  * @return The new connection.
376  */
377 struct afs_conn *
378 afs_ConnBySA(struct srvAddr *sap, unsigned short aport, afs_int32 acell,
379              struct unixuser *tu, int force_if_down, afs_int32 create,
380              afs_int32 locktype, afs_int32 replicated,
381              struct rx_connection **rxconn)
382 {
383     int glocked, foundvec;
384     struct afs_conn *tc = NULL;
385     struct sa_conn_vector *tcv = NULL;
386     struct rx_securityClass *csec; /*Security class object */
387     int isec; /*Security index */
388     int service;
389     int isrep = (replicated > 0)?CONN_REPLICATED:0;
390
391     *rxconn = NULL;
392
393     /* find cached connection */
394     ObtainSharedLock(&afs_xconn, 15);
395     foundvec = 0;
396     for (tcv = sap->conns; tcv; tcv = tcv->next) {
397         if (tcv->user == tu && tcv->port == aport &&
398             (isrep == (tcv->flags & CONN_REPLICATED))) {
399             /* return most eligible conn */
400             if (!foundvec)
401                 foundvec = 1;
402             UpgradeSToWLock(&afs_xconn, 37);
403             tc = find_preferred_connection(tcv, create);
404             ConvertWToSLock(&afs_xconn);
405             break;
406         }
407     }
408
409     if (!tc && !create) {
410         /* Not found and can't create a new one. */
411         ReleaseSharedLock(&afs_xconn);
412         return NULL;
413     }
414
415     if (AFS_IS_DISCONNECTED && !AFS_IN_SYNC) {
416         afs_warnuser("afs_ConnBySA: disconnected\n");
417         ReleaseSharedLock(&afs_xconn);
418         return NULL;
419     }
420
421     if (!foundvec && create) {
422         /* No such connection vector exists.  Create one and splice it in.
423          * Make sure the server record has been marked as used (for the purposes
424          * of calculating up & down times, it's now considered to be an
425          * ``active'' server).  Also make sure the server's lastUpdateEvalTime
426          * gets set, marking the time of its ``birth''.
427          */
428         UpgradeSToWLock(&afs_xconn, 37);
429         new_conn_vector(tcv);
430
431         tcv->user = tu;
432         tcv->port = aport;
433         tcv->srvr = sap;
434         tcv->next = sap->conns;
435         if (isrep)
436             tcv->flags |= CONN_REPLICATED;
437         sap->conns = tcv;
438
439         /* all struct afs_conn ptrs come from here */
440         tc = find_preferred_connection(tcv, create);
441
442         afs_ActivateServer(sap);
443
444         ConvertWToSLock(&afs_xconn);
445     } /* end of if (!tcv) */
446
447     if (!tc) {
448         /* Not found and no alternatives. */
449         ReleaseSharedLock(&afs_xconn);
450         return NULL;
451     }
452
453     if (tu->states & UTokensBad) {
454         /* we may still have an authenticated RPC connection here,
455          * we'll have to create a new, unauthenticated, connection.
456          * Perhaps a better way to do this would be to set
457          * conn->forceConnectFS on all conns when the token first goes
458          * bad, but that's somewhat trickier, due to locking
459          * constraints (though not impossible).
460          */
461         if (tc->id && (rx_SecurityClassOf(tc->id) != 0)) {
462             tc->forceConnectFS = 1;     /* force recreation of connection */
463         }
464         tu->states &= ~UHasTokens;      /* remove the authentication info */
465     }
466
467     glocked = ISAFS_GLOCK();
468     if (tc->forceConnectFS) {
469         UpgradeSToWLock(&afs_xconn, 38);
470         csec = (struct rx_securityClass *)0;
471         if (tc->id) {
472             if (sap->natping == tc)
473                 sap->natping = NULL;
474             if (glocked)
475                 AFS_GUNLOCK();
476             rx_SetConnSecondsUntilNatPing(tc->id, 0);
477             rx_DestroyConnection(tc->id);
478             if (glocked)
479                 AFS_GLOCK();
480         }
481         /*
482          * Stupid hack to determine if using vldb service or file system
483          * service.
484          */
485         if (aport == sap->server->cell->vlport)
486             service = 52;
487         else
488             service = 1;
489         isec = 0;
490
491         csec = afs_pickSecurityObject(tc, &isec);
492
493         if (glocked)
494             AFS_GUNLOCK();
495         tc->id = rx_NewConnection(sap->sa_ip, aport, service, csec, isec);
496         if (glocked)
497             AFS_GLOCK();
498         if (service == 52) {
499             rx_SetConnHardDeadTime(tc->id, afs_rx_harddead);
500         }
501
502         /* Setting idle dead time to non-zero activates RX_CALL_IDLE errors. */
503         if (isrep)
504             rx_SetConnIdleDeadTime(tc->id, afs_rx_idledead_rep);
505         else
506             rx_SetConnIdleDeadTime(tc->id, afs_rx_idledead);
507
508         /*
509          * Only do this for one connection
510          */
511         if ((service != 52) && (sap->natping == NULL)) {
512             sap->natping = tc;
513             rx_SetConnSecondsUntilNatPing(tc->id, 20);
514         }
515
516         tc->forceConnectFS = 0; /* apparently we're appropriately connected now */
517         if (csec)
518             rxs_Release(csec);
519         ConvertWToSLock(&afs_xconn);
520     } /* end of if (tc->forceConnectFS)*/
521
522     *rxconn = tc->id;
523     rx_GetConnection(*rxconn);
524
525     ReleaseSharedLock(&afs_xconn);
526     return tc;
527 }
528
529 /**
530  * forceConnectFS is set whenever we must recompute the connection. UTokensBad
531  * is true only if we know that the tokens are bad.  We thus clear this flag
532  * when we get a new set of tokens..
533  * Having force... true and UTokensBad true simultaneously means that the tokens
534  * went bad and we're supposed to create a new, unauthenticated, connection.
535  *
536  * @param aserver Server to connect to.
537  * @param aport Connection port.
538  * @param acell The cell where all of this happens.
539  * @param areq The request.
540  * @param aforce Force connection?
541  * @param locktype Type of lock to be used.
542  * @param replicated
543  *
544  * @return The established connection.
545  */
546 struct afs_conn *
547 afs_ConnByHost(struct server *aserver, unsigned short aport, afs_int32 acell,
548                struct vrequest *areq, int aforce, afs_int32 locktype,
549                afs_int32 replicated, struct rx_connection **rxconn)
550 {
551     struct unixuser *tu;
552     struct afs_conn *tc = NULL;
553     struct srvAddr *sa = NULL;
554
555     *rxconn = NULL;
556
557     AFS_STATCNT(afs_ConnByHost);
558
559     if (AFS_IS_DISCONNECTED && !AFS_IN_SYNC) {
560         afs_warnuser("afs_ConnByHost: disconnected\n");
561         return NULL;
562     }
563
564 /*
565   1.  look for an existing connection
566   2.  create a connection at an address believed to be up
567       (if aforce is true, create a connection at the first address)
568 */
569
570     tu = afs_GetUser(areq->uid, acell, SHARED_LOCK);
571
572     for (sa = aserver->addr; sa; sa = sa->next_sa) {
573         tc = afs_ConnBySA(sa, aport, acell, tu, aforce,
574                           0 /*don't create one */ ,
575                           locktype, replicated, rxconn);
576         if (tc)
577             break;
578     }
579
580     if (!tc) {
581         for (sa = aserver->addr; sa; sa = sa->next_sa) {
582             tc = afs_ConnBySA(sa, aport, acell, tu, aforce,
583                               1 /*create one */ ,
584                               locktype, replicated, rxconn);
585             if (tc)
586                 break;
587         }
588     }
589
590     afs_PutUser(tu, SHARED_LOCK);
591     return tc;
592
593 }                               /*afs_ConnByHost */
594
595
596 /**
597  * Connect by multiple hosts.
598  * Try to connect to one of the hosts from the ahosts array.
599  *
600  * @param ahosts Multiple hosts to connect to.
601  * @param aport Connection port.
602  * @param acell The cell where all of this happens.
603  * @param areq The request.
604  * @param locktype Type of lock to be used.
605  * @param replicated
606  *
607  * @return The established connection or NULL.
608  */
609 struct afs_conn *
610 afs_ConnByMHosts(struct server *ahosts[], unsigned short aport,
611                  afs_int32 acell, struct vrequest *areq,
612                  afs_int32 locktype, afs_int32 replicated,
613                  struct rx_connection **rxconn)
614 {
615     afs_int32 i;
616     struct afs_conn *tconn;
617     struct server *ts;
618
619     *rxconn = NULL;
620
621     /* try to find any connection from the set */
622     AFS_STATCNT(afs_ConnByMHosts);
623     for (i = 0; i < AFS_MAXCELLHOSTS; i++) {
624         if ((ts = ahosts[i]) == NULL)
625             break;
626         tconn = afs_ConnByHost(ts, aport, acell, areq, 0, locktype,
627                                replicated, rxconn);
628         if (tconn) {
629             return tconn;
630         }
631     }
632     return NULL;
633
634 }                               /*afs_ConnByMHosts */
635
636
637 /**
638  * Decrement reference count to this connection.
639  * @param ac
640  * @param locktype
641  */
642 void
643 afs_PutConn(struct afs_conn *ac, struct rx_connection *rxconn,
644             afs_int32 locktype)
645 {
646     AFS_STATCNT(afs_PutConn);
647     ac->refCount--;
648     if (ac->refCount < 0) {
649         osi_Panic("afs_PutConn: refcount imbalance 0x%lx %d",
650                   (unsigned long)(uintptrsz)ac, (int)ac->refCount);
651     }
652     ac->parent->refCount--;
653     rx_PutConnection(rxconn);
654 }                               /*afs_PutConn */
655
656
657 /**
658  * Free up a connection vector, allowing, eg, code in afs_user.c
659  * to ignore how connections are stored/pooled
660  * @param tcv
661  */
662 void
663 afs_ReleaseConns(struct sa_conn_vector *tcv) {
664     release_conns_vector(tcv);
665 }
666
667
668 /**
669  * Free connection vector(s) for a user
670  * @param au
671  */
672 void
673 afs_ReleaseConnsUser(struct unixuser *au) {
674
675     int i;
676     struct server *ts;
677
678     for (i = 0; i < NSERVERS; i++) {
679         for (ts = afs_servers[i]; ts; ts = ts->next) {
680             release_conns_user_server(au, ts);
681         }       /*For each server on chain */
682     } /*For each chain */
683 }
684
685
686 /**
687  * For multi homed clients, a RPC may timeout because of a
688  * client network interface going down. We need to reopen new
689  * connections in this case.
690  *
691  * @param sap Server address.
692  */
693 void
694 ForceNewConnections(struct srvAddr *sap)
695 {
696     int cix;
697     struct afs_conn *tc = NULL;
698     struct sa_conn_vector *tcv = NULL;
699
700     if (!sap)
701         return; /* defensive check */
702
703     ObtainWriteLock(&afs_xconn, 413);
704     for (tcv = sap->conns; tcv; tcv = tcv->next) {
705         for(cix = 0; cix < CVEC_LEN; ++cix) {
706             tc = &(tcv->cvec[cix]);
707             if (tc->activated)
708                 tc->forceConnectFS = 1;
709         }
710     }
711     ReleaseWriteLock(&afs_xconn);
712 }
713
714