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