1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * Copyright (C) 2002 Cluster File Systems, Inc.
6 * This file is part of Portals
7 * http://sourceforge.net/projects/sandiaportals/
9 * Portals is free software; you can redistribute it and/or
10 * modify it under the terms of version 2 of the GNU General Public
11 * License as published by the Free Software Foundation.
13 * Portals is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with Portals; if not, write to the Free Software
20 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 LIST_HEAD(kpr_routes);
27 LIST_HEAD(kpr_gateways);
30 unsigned long long kpr_fwd_bytes;
31 unsigned long kpr_fwd_packets;
32 unsigned long kpr_fwd_errors;
33 atomic_t kpr_queue_depth;
35 /* Mostly the tables are read-only (thread and interrupt context)
37 * Once in a blue moon we register/deregister NALs and add/remove routing
38 * entries (thread context only)... */
39 rwlock_t kpr_rwlock = RW_LOCK_UNLOCKED;
41 kpr_router_interface_t kpr_router_interface = {
42 kprri_register: kpr_register_nal,
43 kprri_lookup: kpr_lookup_target,
44 kprri_fwd_start: kpr_forward_packet,
45 kprri_fwd_done: kpr_complete_packet,
46 kprri_notify: kpr_nal_notify,
47 kprri_shutdown: kpr_shutdown_nal,
48 kprri_deregister: kpr_deregister_nal,
51 kpr_control_interface_t kpr_control_interface = {
52 kprci_add_route: kpr_add_route,
53 kprci_del_route: kpr_del_route,
54 kprci_get_route: kpr_get_route,
55 kprci_notify: kpr_sys_notify,
59 kpr_register_nal (kpr_nal_interface_t *nalif, void **argp)
65 CDEBUG (D_NET, "Registering NAL %d\n", nalif->kprni_nalid);
67 PORTAL_ALLOC (ne, sizeof (*ne));
71 memset (ne, 0, sizeof (*ne));
72 memcpy ((void *)&ne->kpne_interface, (void *)nalif, sizeof (*nalif));
74 LASSERT (!in_interrupt());
75 write_lock_irqsave (&kpr_rwlock, flags);
77 for (e = kpr_nals.next; e != &kpr_nals; e = e->next)
79 kpr_nal_entry_t *ne2 = list_entry (e, kpr_nal_entry_t, kpne_list);
81 if (ne2->kpne_interface.kprni_nalid == ne->kpne_interface.kprni_nalid)
83 write_unlock_irqrestore (&kpr_rwlock, flags);
85 CERROR ("Attempt to register same NAL %d twice\n", ne->kpne_interface.kprni_nalid);
87 PORTAL_FREE (ne, sizeof (*ne));
92 list_add (&ne->kpne_list, &kpr_nals);
94 write_unlock_irqrestore (&kpr_rwlock, flags);
102 kpr_do_upcall (void *arg)
104 kpr_upcall_t *u = (kpr_upcall_t *)arg;
113 u->kpru_alive ? "up" : "down",
117 snprintf (nalstr, sizeof(nalstr), "%d", u->kpru_nal_id);
118 snprintf (nidstr, sizeof(nidstr), LPX64, u->kpru_nid);
119 snprintf (whenstr, sizeof(whenstr), "%ld", u->kpru_when);
121 portals_run_upcall (argv);
127 kpr_upcall (int gw_nalid, ptl_nid_t gw_nid, int alive, time_t when)
129 /* May be in arbitrary context */
130 kpr_upcall_t *u = kmalloc (sizeof (kpr_upcall_t), GFP_ATOMIC);
133 CERROR ("Upcall out of memory: nal %d nid "LPX64" %s\n",
134 gw_nalid, gw_nid, alive ? "up" : "down");
138 u->kpru_nal_id = gw_nalid;
139 u->kpru_nid = gw_nid;
140 u->kpru_alive = alive;
143 prepare_work (&u->kpru_tq, kpr_do_upcall, u);
144 schedule_work (&u->kpru_tq);
148 kpr_do_notify (int byNal, int gateway_nalid, ptl_nid_t gateway_nid,
149 int alive, time_t when)
153 kpr_nal_entry_t *ne = NULL;
154 kpr_gateway_entry_t *ge = NULL;
159 CDEBUG (D_NET, "%s notifying [%d] "LPX64": %s\n",
160 byNal ? "NAL" : "userspace",
161 gateway_nalid, gateway_nid, alive ? "up" : "down");
163 /* can't do predictions... */
164 do_gettimeofday (&now);
165 if (when > now.tv_sec) {
166 CWARN ("Ignoring prediction from %s of [%d] "LPX64" %s "
167 "%ld seconds in the future\n",
168 byNal ? "NAL" : "userspace",
169 gateway_nalid, gateway_nid,
170 alive ? "up" : "down",
175 LASSERT (when <= now.tv_sec);
177 /* Serialise with lookups (i.e. write lock) */
178 write_lock_irqsave(&kpr_rwlock, flags);
181 list_for_each_safe (e, n, &kpr_gateways) {
183 ge = list_entry(e, kpr_gateway_entry_t, kpge_list);
184 if ((gateway_nalid != 0 &&
185 ge->kpge_nalid != gateway_nalid) ||
186 ge->kpge_nid != gateway_nid)
194 /* gateway not found */
195 write_unlock_irqrestore(&kpr_rwlock, flags);
196 CDEBUG (D_NET, "Gateway not found\n");
200 if (when < ge->kpge_timestamp) {
201 /* out of date information */
202 write_unlock_irqrestore (&kpr_rwlock, flags);
203 CDEBUG (D_NET, "Out of date\n");
207 /* update timestamp */
208 ge->kpge_timestamp = when;
210 if ((!ge->kpge_alive) == (!alive)) {
211 /* new date for old news */
212 write_unlock_irqrestore (&kpr_rwlock, flags);
213 CDEBUG (D_NET, "Old news\n");
217 ge->kpge_alive = alive;
218 CDEBUG(D_NET, "set "LPX64" [%p] %d\n", gateway_nid, ge, alive);
221 /* Reset all gateway weights so the newly-enabled gateway
222 * doesn't have to play catch-up */
223 list_for_each_safe (e, n, &kpr_gateways) {
224 kpr_gateway_entry_t *ge = list_entry(e, kpr_gateway_entry_t,
226 atomic_set (&ge->kpge_weight, 0);
232 /* userland notified me: notify NAL? */
233 ne = kpr_find_nal_entry_locked (ge->kpge_nalid);
235 if (!ne->kpne_shutdown &&
236 ne->kpne_interface.kprni_notify != NULL) {
237 /* take a ref on this NAL until notifying
238 * it has completed... */
239 atomic_inc (&ne->kpne_refcount);
245 write_unlock_irqrestore(&kpr_rwlock, flags);
248 ne->kpne_interface.kprni_notify (ne->kpne_interface.kprni_arg,
250 /* 'ne' can disappear now... */
251 atomic_dec (&ne->kpne_refcount);
255 /* It wasn't userland that notified me... */
256 CWARN ("Upcall: NAL %d NID "LPX64" is %s\n",
257 gateway_nalid, gateway_nid,
258 alive ? "alive" : "dead");
259 kpr_upcall (gateway_nalid, gateway_nid, alive, when);
261 CDEBUG (D_NET, " NOT Doing upcall\n");
268 kpr_nal_notify (void *arg, ptl_nid_t peer, int alive, time_t when)
270 kpr_nal_entry_t *ne = (kpr_nal_entry_t *)arg;
272 kpr_do_notify (1, ne->kpne_interface.kprni_nalid, peer, alive, when);
276 kpr_shutdown_nal (void *arg)
279 kpr_nal_entry_t *ne = (kpr_nal_entry_t *)arg;
281 CDEBUG (D_NET, "Shutting down NAL %d\n", ne->kpne_interface.kprni_nalid);
283 LASSERT (!ne->kpne_shutdown);
284 LASSERT (!in_interrupt());
286 write_lock_irqsave (&kpr_rwlock, flags); /* locking a bit spurious... */
287 ne->kpne_shutdown = 1;
288 write_unlock_irqrestore (&kpr_rwlock, flags); /* except it's a memory barrier */
290 while (atomic_read (&ne->kpne_refcount) != 0)
292 CDEBUG (D_NET, "Waiting for refcount on NAL %d to reach zero (%d)\n",
293 ne->kpne_interface.kprni_nalid, atomic_read (&ne->kpne_refcount));
295 set_current_state (TASK_UNINTERRUPTIBLE);
296 schedule_timeout (HZ);
301 kpr_deregister_nal (void *arg)
304 kpr_nal_entry_t *ne = (kpr_nal_entry_t *)arg;
306 CDEBUG (D_NET, "Deregister NAL %d\n", ne->kpne_interface.kprni_nalid);
308 LASSERT (ne->kpne_shutdown); /* caller must have issued shutdown already */
309 LASSERT (atomic_read (&ne->kpne_refcount) == 0); /* can't be busy */
310 LASSERT (!in_interrupt());
312 write_lock_irqsave (&kpr_rwlock, flags);
314 list_del (&ne->kpne_list);
316 write_unlock_irqrestore (&kpr_rwlock, flags);
318 PORTAL_FREE (ne, sizeof (*ne));
323 kpr_ge_isbetter (kpr_gateway_entry_t *ge1, kpr_gateway_entry_t *ge2)
325 const int significant_bits = 0x00ffffff;
326 /* We use atomic_t to record/compare route weights for
327 * load-balancing. Here we limit ourselves to only using
328 * 'significant_bits' when we do an 'after' comparison */
330 int diff = (atomic_read (&ge1->kpge_weight) -
331 atomic_read (&ge2->kpge_weight)) & significant_bits;
332 int rc = (diff > (significant_bits >> 1));
334 CDEBUG(D_NET, "[%p]"LPX64"=%d %s [%p]"LPX64"=%d\n",
335 ge1, ge1->kpge_nid, atomic_read (&ge1->kpge_weight),
337 ge2, ge2->kpge_nid, atomic_read (&ge2->kpge_weight));
343 kpr_update_weight (kpr_gateway_entry_t *ge, int nob)
345 int weight = 1 + (nob + sizeof (ptl_hdr_t)/2)/sizeof (ptl_hdr_t);
347 /* We've chosen this route entry (i.e. gateway) to forward payload
348 * of length 'nob'; update the route's weight to make it less
349 * favoured. Note that the weight is 1 plus the payload size
350 * rounded and scaled to the portals header size, so we get better
351 * use of the significant bits in kpge_weight. */
353 CDEBUG(D_NET, "gateway [%p]"LPX64" += %d\n", ge,
354 ge->kpge_nid, weight);
356 atomic_add (weight, &ge->kpge_weight);
360 kpr_lookup_target (void *arg, ptl_nid_t target_nid, int nob,
361 ptl_nid_t *gateway_nidp)
363 kpr_nal_entry_t *ne = (kpr_nal_entry_t *)arg;
365 kpr_route_entry_t *re;
366 kpr_gateway_entry_t *ge = NULL;
369 /* Caller wants to know if 'target_nid' can be reached via a gateway
370 * ON HER OWN NETWORK */
372 CDEBUG (D_NET, "lookup "LPX64" from NAL %d\n", target_nid,
373 ne->kpne_interface.kprni_nalid);
375 if (ne->kpne_shutdown) /* caller is shutting down */
378 read_lock (&kpr_rwlock);
380 /* Search routes for one that has a gateway to target_nid on the callers network */
382 list_for_each (e, &kpr_routes) {
383 re = list_entry (e, kpr_route_entry_t, kpre_list);
385 if (re->kpre_lo_nid > target_nid ||
386 re->kpre_hi_nid < target_nid)
389 /* found table entry */
391 if (re->kpre_gateway->kpge_nalid != ne->kpne_interface.kprni_nalid ||
392 !re->kpre_gateway->kpge_alive) {
393 /* different NAL or gateway down */
399 kpr_ge_isbetter (re->kpre_gateway, ge))
400 ge = re->kpre_gateway;
404 kpr_update_weight (ge, nob);
405 *gateway_nidp = ge->kpge_nid;
409 read_unlock (&kpr_rwlock);
411 /* NB can't deref 're' now; it might have been removed! */
413 CDEBUG (D_NET, "lookup "LPX64" from NAL %d: %d ("LPX64")\n",
414 target_nid, ne->kpne_interface.kprni_nalid, rc,
415 (rc == 0) ? *gateway_nidp : (ptl_nid_t)0);
420 kpr_find_nal_entry_locked (int nal_id)
424 /* Called with kpr_rwlock held */
426 list_for_each (e, &kpr_nals) {
427 kpr_nal_entry_t *ne = list_entry (e, kpr_nal_entry_t, kpne_list);
429 if (nal_id != ne->kpne_interface.kprni_nalid) /* no match */
439 kpr_forward_packet (void *arg, kpr_fwd_desc_t *fwd)
441 kpr_nal_entry_t *src_ne = (kpr_nal_entry_t *)arg;
442 ptl_nid_t target_nid = fwd->kprfd_target_nid;
443 int nob = fwd->kprfd_nob;
444 kpr_gateway_entry_t *ge = NULL;
445 kpr_nal_entry_t *dst_ne = NULL;
447 kpr_route_entry_t *re;
448 kpr_nal_entry_t *tmp_ne;
450 CDEBUG (D_NET, "forward [%p] "LPX64" from NAL %d\n", fwd,
451 target_nid, src_ne->kpne_interface.kprni_nalid);
453 LASSERT (nob >= sizeof (ptl_hdr_t)); /* at least got a packet header */
454 LASSERT (nob == lib_iov_nob (fwd->kprfd_niov, fwd->kprfd_iov));
456 atomic_inc (&kpr_queue_depth);
457 atomic_inc (&src_ne->kpne_refcount); /* source nal is busy until fwd completes */
459 kpr_fwd_packets++; /* (loose) stats accounting */
460 kpr_fwd_bytes += nob;
462 if (src_ne->kpne_shutdown) /* caller is shutting down */
465 fwd->kprfd_router_arg = src_ne; /* stash caller's nal entry */
467 read_lock (&kpr_rwlock);
469 /* Search routes for one that has a gateway to target_nid NOT on the caller's network */
471 list_for_each (e, &kpr_routes) {
472 re = list_entry (e, kpr_route_entry_t, kpre_list);
474 if (re->kpre_lo_nid > target_nid || /* no match */
475 re->kpre_hi_nid < target_nid)
478 if (re->kpre_gateway->kpge_nalid == src_ne->kpne_interface.kprni_nalid)
479 continue; /* don't route to same NAL */
481 if (!re->kpre_gateway->kpge_alive)
482 continue; /* gateway is dead */
484 tmp_ne = kpr_find_nal_entry_locked (re->kpre_gateway->kpge_nalid);
486 if (tmp_ne == NULL ||
487 tmp_ne->kpne_shutdown) {
488 /* NAL must be registered and not shutting down */
493 kpr_ge_isbetter (re->kpre_gateway, ge)) {
494 ge = re->kpre_gateway;
500 LASSERT (dst_ne != NULL);
502 kpr_update_weight (ge, nob);
504 fwd->kprfd_gateway_nid = ge->kpge_nid;
505 atomic_inc (&dst_ne->kpne_refcount); /* dest nal is busy until fwd completes */
507 read_unlock (&kpr_rwlock);
509 CDEBUG (D_NET, "forward [%p] "LPX64" from NAL %d: "
510 "to "LPX64" on NAL %d\n",
511 fwd, target_nid, src_ne->kpne_interface.kprni_nalid,
512 fwd->kprfd_gateway_nid, dst_ne->kpne_interface.kprni_nalid);
514 dst_ne->kpne_interface.kprni_fwd (dst_ne->kpne_interface.kprni_arg, fwd);
518 read_unlock (&kpr_rwlock);
522 CDEBUG (D_NET, "Failed to forward [%p] "LPX64" from NAL %d\n", fwd,
523 target_nid, src_ne->kpne_interface.kprni_nalid);
525 /* Can't find anywhere to forward to */
526 (fwd->kprfd_callback)(fwd->kprfd_callback_arg, -EHOSTUNREACH);
528 atomic_dec (&kpr_queue_depth);
529 atomic_dec (&src_ne->kpne_refcount);
533 kpr_complete_packet (void *arg, kpr_fwd_desc_t *fwd, int error)
535 kpr_nal_entry_t *dst_ne = (kpr_nal_entry_t *)arg;
536 kpr_nal_entry_t *src_ne = (kpr_nal_entry_t *)fwd->kprfd_router_arg;
538 CDEBUG (D_NET, "complete(1) [%p] from NAL %d to NAL %d: %d\n", fwd,
539 src_ne->kpne_interface.kprni_nalid, dst_ne->kpne_interface.kprni_nalid, error);
541 atomic_dec (&dst_ne->kpne_refcount); /* CAVEAT EMPTOR dst_ne can disappear now!!! */
543 (fwd->kprfd_callback)(fwd->kprfd_callback_arg, error);
545 CDEBUG (D_NET, "complete(2) [%p] from NAL %d: %d\n", fwd,
546 src_ne->kpne_interface.kprni_nalid, error);
548 atomic_dec (&kpr_queue_depth);
549 atomic_dec (&src_ne->kpne_refcount); /* CAVEAT EMPTOR src_ne can disappear now!!! */
553 kpr_add_route (int gateway_nalid, ptl_nid_t gateway_nid,
554 ptl_nid_t lo_nid, ptl_nid_t hi_nid)
558 kpr_route_entry_t *re;
559 kpr_gateway_entry_t *ge;
562 CDEBUG(D_NET, "Add route: %d "LPX64" : "LPX64" - "LPX64"\n",
563 gateway_nalid, gateway_nid, lo_nid, hi_nid);
565 if (gateway_nalid == PTL_NID_ANY ||
566 lo_nid == PTL_NID_ANY ||
567 hi_nid == PTL_NID_ANY ||
571 PORTAL_ALLOC (ge, sizeof (*ge));
575 ge->kpge_nalid = gateway_nalid;
576 ge->kpge_nid = gateway_nid;
578 ge->kpge_timestamp = 0;
579 ge->kpge_refcount = 0;
580 atomic_set (&ge->kpge_weight, 0);
582 PORTAL_ALLOC (re, sizeof (*re));
586 re->kpre_lo_nid = lo_nid;
587 re->kpre_hi_nid = hi_nid;
589 LASSERT(!in_interrupt());
590 write_lock_irqsave (&kpr_rwlock, flags);
592 list_for_each (e, &kpr_gateways) {
593 kpr_gateway_entry_t *ge2 = list_entry(e, kpr_gateway_entry_t,
596 if (ge2->kpge_nalid == gateway_nalid &&
597 ge2->kpge_nid == gateway_nid) {
598 PORTAL_FREE (ge, sizeof (*ge));
606 /* Adding a new gateway... */
608 list_add (&ge->kpge_list, &kpr_gateways);
610 /* ...zero all gateway weights so this one doesn't have to
613 list_for_each (e, &kpr_gateways) {
614 kpr_gateway_entry_t *ge2 = list_entry(e, kpr_gateway_entry_t,
616 atomic_set (&ge2->kpge_weight, 0);
621 re->kpre_gateway = ge;
623 list_add (&re->kpre_list, &kpr_routes);
625 write_unlock_irqrestore (&kpr_rwlock, flags);
630 kpr_sys_notify (int gateway_nalid, ptl_nid_t gateway_nid,
631 int alive, time_t when)
633 return (kpr_do_notify (0, gateway_nalid, gateway_nid, alive, when));
637 kpr_del_route (int gw_nalid, ptl_nid_t gw_nid,
638 ptl_nid_t lo, ptl_nid_t hi)
640 int specific = (lo != PTL_NID_ANY);
646 CDEBUG(D_NET, "Del route [%d] "LPX64" : "LPX64" - "LPX64"\n",
647 gw_nalid, gw_nid, lo, hi);
649 LASSERT(!in_interrupt());
651 /* NB Caller may specify either all routes via the given gateway
652 * (lo/hi == PTL_NID_ANY) or a specific route entry (lo/hi are
655 if (specific ? (hi == PTL_NID_ANY || hi < lo) : (hi != PTL_NID_ANY))
658 write_lock_irqsave(&kpr_rwlock, flags);
660 list_for_each_safe (e, n, &kpr_routes) {
661 kpr_route_entry_t *re = list_entry(e, kpr_route_entry_t,
663 kpr_gateway_entry_t *ge = re->kpre_gateway;
665 if (ge->kpge_nalid != gw_nalid ||
666 ge->kpge_nid != gw_nid ||
668 (lo != re->kpre_lo_nid || hi != re->kpre_hi_nid)))
673 if (--ge->kpge_refcount == 0) {
674 list_del (&ge->kpge_list);
675 PORTAL_FREE (ge, sizeof (*ge));
678 list_del (&re->kpre_list);
679 PORTAL_FREE(re, sizeof (*re));
685 write_unlock_irqrestore(&kpr_rwlock, flags);
690 kpr_get_route (int idx, int *gateway_nalid, ptl_nid_t *gateway_nid,
691 ptl_nid_t *lo_nid, ptl_nid_t *hi_nid, int *alive)
695 read_lock(&kpr_rwlock);
697 for (e = kpr_routes.next; e != &kpr_routes; e = e->next) {
698 kpr_route_entry_t *re = list_entry(e, kpr_route_entry_t,
700 kpr_gateway_entry_t *ge = re->kpre_gateway;
703 *gateway_nalid = ge->kpge_nalid;
704 *gateway_nid = ge->kpge_nid;
705 *alive = ge->kpge_alive;
706 *lo_nid = re->kpre_lo_nid;
707 *hi_nid = re->kpre_hi_nid;
709 read_unlock(&kpr_rwlock);
714 read_unlock (&kpr_rwlock);
718 static void /*__exit*/
721 LASSERT (list_empty (&kpr_nals));
723 while (!list_empty (&kpr_routes)) {
724 kpr_route_entry_t *re = list_entry(kpr_routes.next,
728 list_del(&re->kpre_list);
729 PORTAL_FREE(re, sizeof (*re));
734 PORTAL_SYMBOL_UNREGISTER(kpr_router_interface);
735 PORTAL_SYMBOL_UNREGISTER(kpr_control_interface);
737 CDEBUG(D_MALLOC, "kpr_finalise: kmem back to %d\n",
738 atomic_read(&portal_kmemory));
742 kpr_initialise (void)
744 CDEBUG(D_MALLOC, "kpr_initialise: kmem %d\n",
745 atomic_read(&portal_kmemory));
749 PORTAL_SYMBOL_REGISTER(kpr_router_interface);
750 PORTAL_SYMBOL_REGISTER(kpr_control_interface);
754 MODULE_AUTHOR("Eric Barton");
755 MODULE_DESCRIPTION("Kernel Portals Router v0.01");
756 MODULE_LICENSE("GPL");
758 module_init (kpr_initialise);
759 module_exit (kpr_finalise);
761 EXPORT_SYMBOL (kpr_control_interface);
762 EXPORT_SYMBOL (kpr_router_interface);