libafs: add replicated connection pool
[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;
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                     }
153                 }
154                 if (glocked)
155                     AFS_GLOCK();
156                 afs_osi_Free(tcv, sizeof(struct sa_conn_vector));
157                 break;    /* at most one instance per server */
158             } /*Found unreferenced connection for user */
159         }
160     } /*For each connection on the server */
161
162 }        /* release_conns_user_server */
163
164
165 static void
166 release_conns_vector(struct sa_conn_vector *xcv)
167 {
168     int cix, glocked;
169     struct afs_conn *tc;
170     struct sa_conn_vector *tcv = NULL;
171     struct sa_conn_vector **lcv = NULL;
172     for (tcv = xcv; tcv; lcv = &tcv->next, tcv = *lcv) {
173         *lcv = tcv->next;
174         /* you know it, you love it, the GLOCK */
175         glocked = ISAFS_GLOCK();
176         if (glocked)
177             AFS_GUNLOCK(); \
178         for(cix = 0; cix < CVEC_LEN; ++cix) {
179             tc = &(tcv->cvec[cix]);
180             if (tc->activated) {
181                 rx_SetConnSecondsUntilNatPing(tc->id, 0);
182                 rx_DestroyConnection(tc->id);
183             }
184         }
185         if (glocked)
186             AFS_GLOCK();
187         afs_osi_Free(tcv, sizeof(struct sa_conn_vector));
188     }
189
190 }        /* release_conns_vector */
191
192
193 unsigned int VNOSERVERS = 0;
194
195 /**
196  * Pick a security object to use for a connection to a given server,
197  * by a given user
198  *
199  * @param[in] conn
200  *      The AFS connection for which the security object is required
201  * @param[out] secLevel
202  *      The security level of the returned object
203  *
204  * @return
205  *      An rx security object. This function is guaranteed to return
206  *      an object, although that object may be rxnull (with a secLevel
207  *      of 0)
208  */
209 static struct rx_securityClass *
210 afs_pickSecurityObject(struct afs_conn *conn, int *secLevel)
211 {
212     struct rx_securityClass *secObj = NULL;
213     union tokenUnion *token;
214
215     /* Do we have tokens ? */
216     if (conn->parent->user->states & UHasTokens) {
217         token = afs_FindToken(conn->parent->user->tokens, RX_SECIDX_KAD);
218         if (token) {
219             *secLevel = RX_SECIDX_KAD;
220             /* kerberos tickets on channel 2 */
221             secObj = rxkad_NewClientSecurityObject(
222                          cryptall ? rxkad_crypt : rxkad_clear,
223                          (struct ktc_encryptionKey *)
224                                token->rxkad.clearToken.HandShakeKey,
225                          token->rxkad.clearToken.AuthHandle,
226                          token->rxkad.ticketLen, token->rxkad.ticket);
227             /* We're going to use this token, so populate the viced */
228             conn->parent->user->viceId = token->rxkad.clearToken.ViceId;
229         }
230      }
231      if (secObj == NULL) {
232         *secLevel = 0;
233         secObj = rxnull_NewClientSecurityObject();
234      }
235
236      return secObj;
237 }
238
239
240 /**
241  * Try setting up a connection to the server containing the specified fid.
242  * Gets the volume, checks if it's up and does the connection by server address.
243  *
244  * @param afid
245  * @param areq Request filled in by the caller.
246  * @param locktype Type of lock that will be used.
247  *
248  * @return The conn struct, or NULL.
249  */
250 struct afs_conn *
251 afs_Conn(struct VenusFid *afid, struct vrequest *areq,
252          afs_int32 locktype, struct rx_connection **rxconn)
253 {
254     u_short fsport = AFS_FSPORT;
255     struct volume *tv;
256     struct afs_conn *tconn = NULL;
257     struct srvAddr *lowp = NULL;
258     struct unixuser *tu;
259     int notbusy;
260     int i;
261     struct srvAddr *sa1p;
262     afs_int32 replicated = -1; /* a single RO will increment to 0 */
263
264     *rxconn = NULL;
265
266     AFS_STATCNT(afs_Conn);
267     /* Get fid's volume. */
268     tv = afs_GetVolume(afid, areq, READ_LOCK);
269     if (!tv) {
270         if (areq) {
271             afs_FinalizeReq(areq);
272             areq->volumeError = 1;
273         }
274         return NULL;
275     }
276
277     if (tv->serverHost[0] && tv->serverHost[0]->cell) {
278         fsport = tv->serverHost[0]->cell->fsport;
279     } else {
280         VNOSERVERS++;
281     }
282
283     /* First is always lowest rank, if it's up */
284     if ((tv->status[0] == not_busy) && tv->serverHost[0]
285         && !(tv->serverHost[0]->addr->sa_flags & SRVR_ISDOWN) &&
286         !(((areq->idleError > 0) || (areq->tokenError > 0))
287           && (areq->skipserver[0] == 1)))
288         lowp = tv->serverHost[0]->addr;
289
290     /* Otherwise we look at all of them. There are seven levels of
291      * not_busy. This means we will check a volume seven times before it
292      * is marked offline. Ideally, we only need two levels, but this
293      * serves a second purpose of waiting some number of seconds before
294      * the client decides the volume is offline (ie: a clone could finish
295      * in this time).
296      */
297     for (notbusy = not_busy; (!lowp && (notbusy <= end_not_busy)); notbusy++) {
298         for (i = 0; i < AFS_MAXHOSTS && tv->serverHost[i]; i++) {
299             if (tv->states & VRO)
300                 replicated++;
301             if (((areq->tokenError > 0)||(areq->idleError > 0))
302                 && (areq->skipserver[i] == 1))
303                 continue;
304             if (tv->status[i] != notbusy) {
305                 if (tv->status[i] == rd_busy || tv->status[i] == rdwr_busy) {
306                     if (!areq->busyCount)
307                         areq->busyCount++;
308                 } else if (tv->status[i] == offline) {
309                     if (!areq->volumeError)
310                         areq->volumeError = VOLMISSING;
311                 }
312                 continue;
313             }
314             for (sa1p = tv->serverHost[i]->addr; sa1p; sa1p = sa1p->next_sa) {
315                 if (sa1p->sa_flags & SRVR_ISDOWN)
316                     continue;
317                 if (!lowp || (lowp->sa_iprank > sa1p->sa_iprank))
318                     lowp = sa1p;
319             }
320         }
321     }
322     if ((replicated == -1) && (tv->states & VRO)) {
323         for (i = 0; i < AFS_MAXHOSTS && tv->serverHost[i]; i++) {
324             if (tv->states & VRO)
325                 replicated++;
326         }
327     } else
328         replicated = 0;
329
330     afs_PutVolume(tv, READ_LOCK);
331
332     if (lowp) {
333         tu = afs_GetUser(areq->uid, afid->Cell, SHARED_LOCK);
334         tconn = afs_ConnBySA(lowp, fsport, afid->Cell, tu, 0 /*!force */ ,
335                              1 /*create */ , locktype, replicated, rxconn);
336
337         afs_PutUser(tu, SHARED_LOCK);
338     }
339
340     return tconn;
341 }                               /*afs_Conn */
342
343
344 /**
345  * Connects to a server by it's server address.
346  *
347  * @param sap Server address.
348  * @param aport Server port.
349  * @param acell
350  * @param tu Connect as this user.
351  * @param force_if_down
352  * @param create
353  * @param replicated
354  * @param locktype Specifies type of lock to be used for this function.
355  *
356  * @return The new connection.
357  */
358 struct afs_conn *
359 afs_ConnBySA(struct srvAddr *sap, unsigned short aport, afs_int32 acell,
360              struct unixuser *tu, int force_if_down, afs_int32 create,
361              afs_int32 locktype, afs_int32 replicated,
362              struct rx_connection **rxconn)
363 {
364     int glocked, foundvec;
365     struct afs_conn *tc = NULL;
366     struct sa_conn_vector *tcv = NULL;
367     struct rx_securityClass *csec; /*Security class object */
368     int isec; /*Security index */
369     int service;
370     int isrep = (replicated > 0)?CONN_REPLICATED:0;
371
372     *rxconn = NULL;
373
374     /* find cached connection */
375     ObtainSharedLock(&afs_xconn, 15);
376     foundvec = 0;
377     for (tcv = sap->conns; tcv; tcv = tcv->next) {
378         if (tcv->user == tu && tcv->port == aport &&
379             (isrep == (tcv->flags & CONN_REPLICATED))) {
380             /* return most eligible conn */
381             if (!foundvec)
382                 foundvec = 1;
383             UpgradeSToWLock(&afs_xconn, 37);
384             tc = find_preferred_connection(tcv, create);
385             ConvertWToSLock(&afs_xconn);
386             break;
387         }
388     }
389
390     if (!tc && !create) {
391         /* Not found and can't create a new one. */
392         ReleaseSharedLock(&afs_xconn);
393         return NULL;
394     }
395
396     if (AFS_IS_DISCONNECTED && !AFS_IN_SYNC) {
397         afs_warnuser("afs_ConnBySA: disconnected\n");
398         ReleaseSharedLock(&afs_xconn);
399         return NULL;
400     }
401
402     if (!foundvec && create) {
403         /* No such connection vector exists.  Create one and splice it in.
404          * Make sure the server record has been marked as used (for the purposes
405          * of calculating up & down times, it's now considered to be an
406          * ``active'' server).  Also make sure the server's lastUpdateEvalTime
407          * gets set, marking the time of its ``birth''.
408          */
409         UpgradeSToWLock(&afs_xconn, 37);
410         new_conn_vector(tcv);
411
412         tcv->user = tu;
413         tcv->port = aport;
414         tcv->srvr = sap;
415         tcv->next = sap->conns;
416         if (isrep)
417             tcv->flags |= CONN_REPLICATED;
418         sap->conns = tcv;
419
420         /* all struct afs_conn ptrs come from here */
421         tc = find_preferred_connection(tcv, create);
422
423         afs_ActivateServer(sap);
424
425         ConvertWToSLock(&afs_xconn);
426     } /* end of if (!tcv) */
427
428     if (!tc) {
429         /* Not found and no alternatives. */
430         ReleaseSharedLock(&afs_xconn);
431         return NULL;
432     }
433
434     if (tu->states & UTokensBad) {
435         /* we may still have an authenticated RPC connection here,
436          * we'll have to create a new, unauthenticated, connection.
437          * Perhaps a better way to do this would be to set
438          * conn->forceConnectFS on all conns when the token first goes
439          * bad, but that's somewhat trickier, due to locking
440          * constraints (though not impossible).
441          */
442         if (tc->id && (rx_SecurityClassOf(tc->id) != 0)) {
443             tc->forceConnectFS = 1;     /* force recreation of connection */
444         }
445         tu->states &= ~UHasTokens;      /* remove the authentication info */
446     }
447
448     glocked = ISAFS_GLOCK();
449     if (tc->forceConnectFS) {
450         UpgradeSToWLock(&afs_xconn, 38);
451         csec = (struct rx_securityClass *)0;
452         if (tc->id) {
453             if (glocked)
454                 AFS_GUNLOCK();
455             rx_SetConnSecondsUntilNatPing(tc->id, 0);
456             rx_DestroyConnection(tc->id);
457             if (glocked)
458                 AFS_GLOCK();
459         }
460         /*
461          * Stupid hack to determine if using vldb service or file system
462          * service.
463          */
464         if (aport == sap->server->cell->vlport)
465             service = 52;
466         else
467             service = 1;
468         isec = 0;
469
470         csec = afs_pickSecurityObject(tc, &isec);
471
472         if (glocked)
473             AFS_GUNLOCK();
474         tc->id = rx_NewConnection(sap->sa_ip, aport, service, csec, isec);
475         if (glocked)
476             AFS_GLOCK();
477         if (service == 52) {
478             rx_SetConnHardDeadTime(tc->id, afs_rx_harddead);
479         }
480
481         /* Setting idle dead time to non-zero activates RX_CALL_IDLE errors. */
482         if (isrep)
483             rx_SetConnIdleDeadTime(tc->id, afs_rx_idledead_rep);
484         else
485             rx_SetConnIdleDeadTime(tc->id, afs_rx_idledead);
486
487         /*
488          * Only do this for the base connection, not per-user.
489          * Will need to be revisited if/when CB gets security.
490          */
491         if ((isec == 0) && (service != 52) && !(tu->states & UTokensBad) &&
492             (tu->viceId == UNDEFVID) && (isrep == 0)
493 #ifndef UKERNEL /* ukernel runs as just one uid anyway */
494             && (tu->uid == 0)
495 #endif
496             )
497             rx_SetConnSecondsUntilNatPing(tc->id, 20);
498
499         tc->forceConnectFS = 0; /* apparently we're appropriately connected now */
500         if (csec)
501             rxs_Release(csec);
502         ConvertWToSLock(&afs_xconn);
503     } /* end of if (tc->forceConnectFS)*/
504
505     *rxconn = tc->id;
506     rx_GetConnection(*rxconn);
507
508     ReleaseSharedLock(&afs_xconn);
509     return tc;
510 }
511
512 /**
513  * forceConnectFS is set whenever we must recompute the connection. UTokensBad
514  * is true only if we know that the tokens are bad.  We thus clear this flag
515  * when we get a new set of tokens..
516  * Having force... true and UTokensBad true simultaneously means that the tokens
517  * went bad and we're supposed to create a new, unauthenticated, connection.
518  *
519  * @param aserver Server to connect to.
520  * @param aport Connection port.
521  * @param acell The cell where all of this happens.
522  * @param areq The request.
523  * @param aforce Force connection?
524  * @param locktype Type of lock to be used.
525  * @param replicated
526  *
527  * @return The established connection.
528  */
529 struct afs_conn *
530 afs_ConnByHost(struct server *aserver, unsigned short aport, afs_int32 acell,
531                struct vrequest *areq, int aforce, afs_int32 locktype,
532                afs_int32 replicated, struct rx_connection **rxconn)
533 {
534     struct unixuser *tu;
535     struct afs_conn *tc = NULL;
536     struct srvAddr *sa = NULL;
537
538     *rxconn = NULL;
539
540     AFS_STATCNT(afs_ConnByHost);
541
542     if (AFS_IS_DISCONNECTED && !AFS_IN_SYNC) {
543         afs_warnuser("afs_ConnByHost: disconnected\n");
544         return NULL;
545     }
546
547 /*
548   1.  look for an existing connection
549   2.  create a connection at an address believed to be up
550       (if aforce is true, create a connection at the first address)
551 */
552
553     tu = afs_GetUser(areq->uid, acell, SHARED_LOCK);
554
555     for (sa = aserver->addr; sa; sa = sa->next_sa) {
556         tc = afs_ConnBySA(sa, aport, acell, tu, aforce,
557                           0 /*don't create one */ ,
558                           locktype, replicated, rxconn);
559         if (tc)
560             break;
561     }
562
563     if (!tc) {
564         for (sa = aserver->addr; sa; sa = sa->next_sa) {
565             tc = afs_ConnBySA(sa, aport, acell, tu, aforce,
566                               1 /*create one */ ,
567                               locktype, replicated, rxconn);
568             if (tc)
569                 break;
570         }
571     }
572
573     afs_PutUser(tu, SHARED_LOCK);
574     return tc;
575
576 }                               /*afs_ConnByHost */
577
578
579 /**
580  * Connect by multiple hosts.
581  * Try to connect to one of the hosts from the ahosts array.
582  *
583  * @param ahosts Multiple hosts to connect to.
584  * @param aport Connection port.
585  * @param acell The cell where all of this happens.
586  * @param areq The request.
587  * @param locktype Type of lock to be used.
588  * @param replicated
589  *
590  * @return The established connection or NULL.
591  */
592 struct afs_conn *
593 afs_ConnByMHosts(struct server *ahosts[], unsigned short aport,
594                  afs_int32 acell, struct vrequest *areq,
595                  afs_int32 locktype, afs_int32 replicated,
596                  struct rx_connection **rxconn)
597 {
598     afs_int32 i;
599     struct afs_conn *tconn;
600     struct server *ts;
601
602     *rxconn = NULL;
603
604     /* try to find any connection from the set */
605     AFS_STATCNT(afs_ConnByMHosts);
606     for (i = 0; i < AFS_MAXCELLHOSTS; i++) {
607         if ((ts = ahosts[i]) == NULL)
608             break;
609         tconn = afs_ConnByHost(ts, aport, acell, areq, 0, locktype,
610                                replicated, rxconn);
611         if (tconn) {
612             return tconn;
613         }
614     }
615     return NULL;
616
617 }                               /*afs_ConnByMHosts */
618
619
620 /**
621  * Decrement reference count to this connection.
622  * @param ac
623  * @param locktype
624  */
625 void
626 afs_PutConn(struct afs_conn *ac, struct rx_connection *rxconn,
627             afs_int32 locktype)
628 {
629     AFS_STATCNT(afs_PutConn);
630     ac->refCount--;
631     if (ac->refCount < 0) {
632         osi_Panic("afs_PutConn: refcount imbalance 0x%lx %d",
633                   (unsigned long)(uintptrsz)ac, (int)ac->refCount);
634     }
635     ac->parent->refCount--;
636     rx_PutConnection(rxconn);
637 }                               /*afs_PutConn */
638
639
640 /**
641  * Free up a connection vector, allowing, eg, code in afs_user.c
642  * to ignore how connections are stored/pooled
643  * @param tcv
644  */
645 void
646 afs_ReleaseConns(struct sa_conn_vector *tcv) {
647     release_conns_vector(tcv);
648 }
649
650
651 /**
652  * Free connection vector(s) for a user
653  * @param au
654  */
655 void
656 afs_ReleaseConnsUser(struct unixuser *au) {
657
658     int i;
659     struct server *ts;
660
661     for (i = 0; i < NSERVERS; i++) {
662         for (ts = afs_servers[i]; ts; ts = ts->next) {
663             release_conns_user_server(au, ts);
664         }       /*For each server on chain */
665     } /*For each chain */
666 }
667
668
669 /**
670  * For multi homed clients, a RPC may timeout because of a
671  * client network interface going down. We need to reopen new
672  * connections in this case.
673  *
674  * @param sap Server address.
675  */
676 void
677 ForceNewConnections(struct srvAddr *sap)
678 {
679     int cix;
680     struct afs_conn *tc = NULL;
681     struct sa_conn_vector *tcv = NULL;
682
683     if (!sap)
684         return; /* defensive check */
685
686     ObtainWriteLock(&afs_xconn, 413);
687     for (tcv = sap->conns; tcv; tcv = tcv->next) {
688         for(cix = 0; cix < CVEC_LEN; ++cix) {
689             tc = &(tcv->cvec[cix]);
690             if (tc->activated)
691                 tc->forceConnectFS = 1;
692         }
693     }
694     ReleaseWriteLock(&afs_xconn);
695 }
696
697