2 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
4 * Copyright (c) 2011, 2017, Intel Corporation.
6 * This file is part of Lustre, https://wiki.whamcloud.com/
8 * Portals is free software; you can redistribute it and/or
9 * modify it under the terms of version 2 of the GNU General Public
10 * License as published by the Free Software Foundation.
12 * Portals is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Portals; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 #define DEBUG_SUBSYSTEM S_LNET
25 #include <linux/uaccess.h>
27 #include <libcfs/libcfs.h>
28 #include <lnet/lib-lnet.h>
30 /* This is really lnet_proc.c. You might need to update sanity test 215
31 * if any file format is changed. */
33 #define LNET_LOFFT_BITS (sizeof(loff_t) * 8)
35 * NB: max allowed LNET_CPT_BITS is 8 on 64-bit system and 2 on 32-bit system
37 #define LNET_PROC_CPT_BITS (LNET_CPT_BITS + 1)
38 /* change version, 16 bits or 8 bits */
39 #define LNET_PROC_VER_BITS MAX(((MIN(LNET_LOFFT_BITS, 64)) / 4), 8)
41 #define LNET_PROC_HASH_BITS LNET_PEER_HASH_BITS
43 * bits for peer hash offset
44 * NB: we don't use the highest bit of *ppos because it's signed
46 #define LNET_PROC_HOFF_BITS (LNET_LOFFT_BITS - \
47 LNET_PROC_CPT_BITS - \
48 LNET_PROC_VER_BITS - \
49 LNET_PROC_HASH_BITS - 1)
50 /* bits for hash index + position */
51 #define LNET_PROC_HPOS_BITS (LNET_PROC_HASH_BITS + LNET_PROC_HOFF_BITS)
52 /* bits for peer hash table + hash version */
53 #define LNET_PROC_VPOS_BITS (LNET_PROC_HPOS_BITS + LNET_PROC_VER_BITS)
55 #define LNET_PROC_CPT_MASK ((1ULL << LNET_PROC_CPT_BITS) - 1)
56 #define LNET_PROC_VER_MASK ((1ULL << LNET_PROC_VER_BITS) - 1)
57 #define LNET_PROC_HASH_MASK ((1ULL << LNET_PROC_HASH_BITS) - 1)
58 #define LNET_PROC_HOFF_MASK ((1ULL << LNET_PROC_HOFF_BITS) - 1)
60 #define LNET_PROC_CPT_GET(pos) \
61 (int)(((pos) >> LNET_PROC_VPOS_BITS) & LNET_PROC_CPT_MASK)
63 #define LNET_PROC_VER_GET(pos) \
64 (int)(((pos) >> LNET_PROC_HPOS_BITS) & LNET_PROC_VER_MASK)
66 #define LNET_PROC_HASH_GET(pos) \
67 (int)(((pos) >> LNET_PROC_HOFF_BITS) & LNET_PROC_HASH_MASK)
69 #define LNET_PROC_HOFF_GET(pos) \
70 (int)((pos) & LNET_PROC_HOFF_MASK)
72 #define LNET_PROC_POS_MAKE(cpt, ver, hash, off) \
73 (((((loff_t)(cpt)) & LNET_PROC_CPT_MASK) << LNET_PROC_VPOS_BITS) | \
74 ((((loff_t)(ver)) & LNET_PROC_VER_MASK) << LNET_PROC_HPOS_BITS) | \
75 ((((loff_t)(hash)) & LNET_PROC_HASH_MASK) << LNET_PROC_HOFF_BITS) | \
76 ((off) & LNET_PROC_HOFF_MASK))
78 #define LNET_PROC_VERSION(v) ((unsigned int)((v) & LNET_PROC_VER_MASK))
80 static int __proc_lnet_stats(void *data, int write,
81 loff_t pos, void __user *buffer, int nob)
84 struct lnet_counters *ctrs;
85 struct lnet_counters_common common;
88 const int tmpsiz = 256; /* 7 %u and 4 __u64 */
91 lnet_counters_reset();
97 LIBCFS_ALLOC(ctrs, sizeof(*ctrs));
101 LIBCFS_ALLOC(tmpstr, tmpsiz);
102 if (tmpstr == NULL) {
103 LIBCFS_FREE(ctrs, sizeof(*ctrs));
107 lnet_counters_get(ctrs);
108 common = ctrs->lct_common;
110 len = snprintf(tmpstr, tmpsiz,
111 "%u %u %u %u %u %u %u %llu %llu "
113 common.lcc_msgs_alloc, common.lcc_msgs_max,
115 common.lcc_send_count, common.lcc_recv_count,
116 common.lcc_route_count, common.lcc_drop_count,
117 common.lcc_send_length, common.lcc_recv_length,
118 common.lcc_route_length, common.lcc_drop_length);
120 if (pos >= min_t(int, len, strlen(tmpstr)))
123 rc = cfs_trace_copyout_string(buffer, nob,
126 LIBCFS_FREE(tmpstr, tmpsiz);
127 LIBCFS_FREE(ctrs, sizeof(*ctrs));
132 proc_lnet_stats(struct ctl_table *table, int write, void __user *buffer,
133 size_t *lenp, loff_t *ppos)
135 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
140 proc_lnet_routes(struct ctl_table *table, int write, void __user *buffer,
141 size_t *lenp, loff_t *ppos)
143 const int tmpsiz = 256;
151 CLASSERT(sizeof(loff_t) >= 4);
153 off = LNET_PROC_HOFF_GET(*ppos);
154 ver = LNET_PROC_VER_GET(*ppos);
161 LIBCFS_ALLOC(tmpstr, tmpsiz);
165 s = tmpstr; /* points to current position in tmpstr[] */
168 s += snprintf(s, tmpstr + tmpsiz - s, "Routing %s\n",
169 the_lnet.ln_routing ? "enabled" : "disabled");
170 LASSERT(tmpstr + tmpsiz - s > 0);
172 s += snprintf(s, tmpstr + tmpsiz - s, "%-8s %4s %8s %7s %s\n",
173 "net", "hops", "priority", "state", "router");
174 LASSERT(tmpstr + tmpsiz - s > 0);
177 ver = (unsigned int)the_lnet.ln_remote_nets_version;
179 *ppos = LNET_PROC_POS_MAKE(0, ver, 0, off);
183 struct lnet_route *route = NULL;
184 struct lnet_remotenet *rnet = NULL;
186 struct list_head *rn_list;
191 if (ver != LNET_PROC_VERSION(the_lnet.ln_remote_nets_version)) {
193 LIBCFS_FREE(tmpstr, tmpsiz);
197 for (i = 0; i < LNET_REMOTE_NETS_HASH_SIZE && route == NULL;
199 rn_list = &the_lnet.ln_remote_nets_hash[i];
203 while (n != rn_list && route == NULL) {
204 rnet = list_entry(n, struct lnet_remotenet,
207 r = rnet->lrn_routes.next;
209 while (r != &rnet->lrn_routes) {
210 struct lnet_route *re =
211 list_entry(r, struct lnet_route,
227 __u32 net = rnet->lrn_net;
228 __u32 hops = route->lr_hops;
229 unsigned int priority = route->lr_priority;
230 int alive = lnet_is_route_alive(route);
232 s += snprintf(s, tmpstr + tmpsiz - s,
233 "%-8s %4d %8u %7s %s\n",
234 libcfs_net2str(net), hops,
236 alive ? "up" : "down",
237 libcfs_nid2str(route->lr_nid));
238 LASSERT(tmpstr + tmpsiz - s > 0);
244 len = s - tmpstr; /* how many bytes was written */
246 if (len > *lenp) { /* linux-supplied buffer is too small */
248 } else if (len > 0) { /* wrote something */
249 if (copy_to_user(buffer, tmpstr, len))
253 *ppos = LNET_PROC_POS_MAKE(0, ver, 0, off);
257 LIBCFS_FREE(tmpstr, tmpsiz);
266 proc_lnet_routers(struct ctl_table *table, int write, void __user *buffer,
267 size_t *lenp, loff_t *ppos)
272 const int tmpsiz = 256;
277 off = LNET_PROC_HOFF_GET(*ppos);
278 ver = LNET_PROC_VER_GET(*ppos);
285 LIBCFS_ALLOC(tmpstr, tmpsiz);
289 s = tmpstr; /* points to current position in tmpstr[] */
292 s += snprintf(s, tmpstr + tmpsiz - s,
294 "ref", "rtr_ref", "alive", "router");
295 LASSERT(tmpstr + tmpsiz - s > 0);
298 ver = (unsigned int)the_lnet.ln_routers_version;
300 *ppos = LNET_PROC_POS_MAKE(0, ver, 0, off);
303 struct lnet_peer *peer = NULL;
308 if (ver != LNET_PROC_VERSION(the_lnet.ln_routers_version)) {
311 LIBCFS_FREE(tmpstr, tmpsiz);
315 r = the_lnet.ln_routers.next;
317 while (r != &the_lnet.ln_routers) {
318 struct lnet_peer *lp =
319 list_entry(r, struct lnet_peer,
332 lnet_nid_t nid = peer->lp_primary_nid;
333 int nrefs = atomic_read(&peer->lp_refcount);
334 int nrtrrefs = peer->lp_rtr_refcount;
335 int alive = lnet_is_gateway_alive(peer);
337 s += snprintf(s, tmpstr + tmpsiz - s,
340 alive ? "up" : "down",
341 libcfs_nid2str(nid));
347 len = s - tmpstr; /* how many bytes was written */
349 if (len > *lenp) { /* linux-supplied buffer is too small */
351 } else if (len > 0) { /* wrote something */
352 if (copy_to_user(buffer, tmpstr, len))
356 *ppos = LNET_PROC_POS_MAKE(0, ver, 0, off);
360 LIBCFS_FREE(tmpstr, tmpsiz);
368 /* TODO: there should be no direct access to ptable. We should add a set
369 * of APIs that give access to the ptable and its members */
371 proc_lnet_peers(struct ctl_table *table, int write, void __user *buffer,
372 size_t *lenp, loff_t *ppos)
374 const int tmpsiz = 256;
375 struct lnet_peer_table *ptable;
378 int cpt = LNET_PROC_CPT_GET(*ppos);
379 int ver = LNET_PROC_VER_GET(*ppos);
380 int hash = LNET_PROC_HASH_GET(*ppos);
381 int hoff = LNET_PROC_HOFF_GET(*ppos);
387 struct lnet_peer_ni *peer;
389 cfs_percpt_for_each(ptable, i, the_lnet.ln_peer_tables) {
391 for (hash = 0; hash < LNET_PEER_HASH_SIZE; hash++) {
392 list_for_each_entry(peer,
393 &ptable->pt_hash[hash],
395 peer->lpni_mintxcredits =
396 peer->lpni_txcredits;
397 peer->lpni_minrtrcredits =
398 peer->lpni_rtrcredits;
410 CLASSERT(LNET_PROC_HASH_BITS >= LNET_PEER_HASH_BITS);
412 if (cpt >= LNET_CPT_NUMBER) {
417 LIBCFS_ALLOC(tmpstr, tmpsiz);
421 s = tmpstr; /* points to current position in tmpstr[] */
424 s += snprintf(s, tmpstr + tmpsiz - s,
425 "%-24s %4s %5s %5s %5s %5s %5s %5s %5s %s\n",
426 "nid", "refs", "state", "last", "max",
427 "rtr", "min", "tx", "min", "queue");
428 LASSERT(tmpstr + tmpsiz - s > 0);
432 struct lnet_peer_ni *peer;
442 ptable = the_lnet.ln_peer_tables[cpt];
444 ver = LNET_PROC_VERSION(ptable->pt_version);
446 if (ver != LNET_PROC_VERSION(ptable->pt_version)) {
447 lnet_net_unlock(cpt);
448 LIBCFS_FREE(tmpstr, tmpsiz);
452 while (hash < LNET_PEER_HASH_SIZE) {
454 p = ptable->pt_hash[hash].next;
456 while (p != &ptable->pt_hash[hash]) {
457 struct lnet_peer_ni *lp =
458 list_entry(p, struct lnet_peer_ni,
463 /* minor optimization: start from idx+1
464 * on next iteration if we've just
465 * drained lpni_hashlist */
466 if (lp->lpni_hashlist.next ==
467 &ptable->pt_hash[hash]) {
478 p = lp->lpni_hashlist.next;
490 lnet_nid_t nid = peer->lpni_nid;
491 int nrefs = atomic_read(&peer->lpni_refcount);
492 time64_t lastalive = -1;
493 char *aliveness = "NA";
494 int maxcr = (peer->lpni_net) ?
495 peer->lpni_net->net_tunables.lct_peer_tx_credits : 0;
496 int txcr = peer->lpni_txcredits;
497 int mintxcr = peer->lpni_mintxcredits;
498 int rtrcr = peer->lpni_rtrcredits;
499 int minrtrcr = peer->lpni_minrtrcredits;
500 int txqnob = peer->lpni_txqnob;
502 if (lnet_isrouter(peer) ||
503 lnet_peer_aliveness_enabled(peer))
504 aliveness = lnet_is_peer_ni_alive(peer) ?
507 lnet_net_unlock(cpt);
509 s += snprintf(s, tmpstr + tmpsiz - s,
510 "%-24s %4d %5s %5lld %5d %5d %5d %5d %5d %d\n",
511 libcfs_nid2str(nid), nrefs, aliveness,
512 lastalive, maxcr, rtrcr, minrtrcr, txcr,
514 LASSERT(tmpstr + tmpsiz - s > 0);
516 } else { /* peer is NULL */
517 lnet_net_unlock(cpt);
520 if (hash == LNET_PEER_HASH_SIZE) {
524 if (peer == NULL && cpt < LNET_CPT_NUMBER)
529 len = s - tmpstr; /* how many bytes was written */
531 if (len > *lenp) { /* linux-supplied buffer is too small */
533 } else if (len > 0) { /* wrote something */
534 if (copy_to_user(buffer, tmpstr, len))
537 *ppos = LNET_PROC_POS_MAKE(cpt, ver, hash, hoff);
540 LIBCFS_FREE(tmpstr, tmpsiz);
548 static int __proc_lnet_buffers(void *data, int write,
549 loff_t pos, void __user *buffer, int nob)
561 /* (4 %d) * 4 * LNET_CPT_NUMBER */
562 tmpsiz = 64 * (LNET_NRBPOOLS + 1) * LNET_CPT_NUMBER;
563 LIBCFS_ALLOC(tmpstr, tmpsiz);
567 s = tmpstr; /* points to current position in tmpstr[] */
569 s += snprintf(s, tmpstr + tmpsiz - s,
571 "pages", "count", "credits", "min");
572 LASSERT(tmpstr + tmpsiz - s > 0);
574 if (the_lnet.ln_rtrpools == NULL)
575 goto out; /* I'm not a router */
577 for (idx = 0; idx < LNET_NRBPOOLS; idx++) {
578 struct lnet_rtrbufpool *rbp;
580 lnet_net_lock(LNET_LOCK_EX);
581 cfs_percpt_for_each(rbp, i, the_lnet.ln_rtrpools) {
582 s += snprintf(s, tmpstr + tmpsiz - s,
585 rbp[idx].rbp_nbuffers,
586 rbp[idx].rbp_credits,
587 rbp[idx].rbp_mincredits);
588 LASSERT(tmpstr + tmpsiz - s > 0);
590 lnet_net_unlock(LNET_LOCK_EX);
596 if (pos >= min_t(int, len, strlen(tmpstr)))
599 rc = cfs_trace_copyout_string(buffer, nob,
602 LIBCFS_FREE(tmpstr, tmpsiz);
607 proc_lnet_buffers(struct ctl_table *table, int write, void __user *buffer,
608 size_t *lenp, loff_t *ppos)
610 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
611 __proc_lnet_buffers);
615 proc_lnet_nis(struct ctl_table *table, int write, void __user *buffer,
616 size_t *lenp, loff_t *ppos)
618 int tmpsiz = 128 * LNET_CPT_NUMBER;
628 /* Just reset the min stat. */
630 struct lnet_net *net;
634 list_for_each_entry(net, &the_lnet.ln_nets, net_list) {
635 list_for_each_entry(ni, &net->net_ni_list, ni_netlist) {
636 struct lnet_tx_queue *tq;
640 cfs_percpt_for_each(tq, i, ni->ni_tx_queues) {
641 for (j = 0; ni->ni_cpts != NULL &&
642 j < ni->ni_ncpts; j++) {
643 if (i == ni->ni_cpts[j])
647 if (j == ni->ni_ncpts)
652 tq->tq_credits_min = tq->tq_credits;
663 LIBCFS_ALLOC(tmpstr, tmpsiz);
667 s = tmpstr; /* points to current position in tmpstr[] */
670 s += snprintf(s, tmpstr + tmpsiz - s,
671 "%-24s %6s %5s %4s %4s %4s %5s %5s %5s\n",
672 "nid", "status", "alive", "refs", "peer",
673 "rtr", "max", "tx", "min");
674 LASSERT (tmpstr + tmpsiz - s > 0);
676 struct lnet_ni *ni = NULL;
677 int skip = *ppos - 1;
681 ni = lnet_get_ni_idx_locked(skip);
684 struct lnet_tx_queue *tq;
686 time64_t now = ktime_get_real_seconds();
687 time64_t last_alive = -1;
691 if (the_lnet.ln_routing)
692 last_alive = now - ni->ni_net->net_last_alive;
694 /* @lo forever alive */
695 if (ni->ni_net->net_lnd->lnd_type == LOLND)
699 LASSERT(ni->ni_status != NULL);
700 stat = (ni->ni_status->ns_status ==
701 LNET_NI_STATUS_UP) ? "up" : "down";
704 /* we actually output credits information for
705 * TX queue of each partition */
706 cfs_percpt_for_each(tq, i, ni->ni_tx_queues) {
707 for (j = 0; ni->ni_cpts != NULL &&
708 j < ni->ni_ncpts; j++) {
709 if (i == ni->ni_cpts[j])
713 if (j == ni->ni_ncpts)
719 s += snprintf(s, tmpstr + tmpsiz - s,
720 "%-24s %6s %5lld %4d %4d %4d %5d %5d %5d\n",
721 libcfs_nid2str(ni->ni_nid), stat,
722 last_alive, *ni->ni_refs[i],
723 ni->ni_net->net_tunables.lct_peer_tx_credits,
724 ni->ni_net->net_tunables.lct_peer_rtr_credits,
726 tq->tq_credits, tq->tq_credits_min);
730 LASSERT(tmpstr + tmpsiz - s > 0);
736 len = s - tmpstr; /* how many bytes was written */
738 if (len > *lenp) { /* linux-supplied buffer is too small */
740 } else if (len > 0) { /* wrote something */
741 if (copy_to_user(buffer, tmpstr, len))
747 LIBCFS_FREE(tmpstr, tmpsiz);
755 struct lnet_portal_rotors {
761 static struct lnet_portal_rotors portal_rotors[] = {
763 .pr_value = LNET_PTL_ROTOR_OFF,
765 .pr_desc = "Turn off message rotor for wildcard portals"
768 .pr_value = LNET_PTL_ROTOR_ON,
770 .pr_desc = "round-robin dispatch all PUT messages for "
774 .pr_value = LNET_PTL_ROTOR_RR_RT,
776 .pr_desc = "round-robin dispatch routed PUT message for "
780 .pr_value = LNET_PTL_ROTOR_HASH_RT,
781 .pr_name = "HASH_RT",
782 .pr_desc = "dispatch routed PUT message by hashing source "
783 "NID for wildcard portals"
792 static int __proc_lnet_portal_rotor(void *data, int write,
793 loff_t pos, void __user *buffer, int nob)
795 const int buf_len = 128;
801 LIBCFS_ALLOC(buf, buf_len);
808 for (i = 0; portal_rotors[i].pr_value >= 0; i++) {
809 if (portal_rotors[i].pr_value == portal_rotor)
813 LASSERT(portal_rotors[i].pr_value == portal_rotor);
816 rc = snprintf(buf, buf_len,
817 "{\n\tportals: all\n"
818 "\trotor: %s\n\tdescription: %s\n}",
819 portal_rotors[i].pr_name,
820 portal_rotors[i].pr_desc);
822 if (pos >= min_t(int, rc, buf_len)) {
825 rc = cfs_trace_copyout_string(buffer, nob,
831 rc = cfs_trace_copyin_string(buf, buf_len, buffer, nob);
839 for (i = 0; portal_rotors[i].pr_name != NULL; i++) {
840 if (strncasecmp(portal_rotors[i].pr_name, tmp,
841 strlen(portal_rotors[i].pr_name)) == 0) {
842 portal_rotor = portal_rotors[i].pr_value;
849 LIBCFS_FREE(buf, buf_len);
854 proc_lnet_portal_rotor(struct ctl_table *table, int write, void __user *buffer,
855 size_t *lenp, loff_t *ppos)
857 return lprocfs_call_handler(table->data, write, ppos, buffer, lenp,
858 __proc_lnet_portal_rotor);
862 static struct ctl_table lnet_table[] = {
864 * NB No .strategy entries have been provided since sysctl(8) prefers
865 * to go via /proc for portability.
871 .proc_handler = &proc_lnet_stats,
875 .procname = "routes",
877 .proc_handler = &proc_lnet_routes,
881 .procname = "routers",
883 .proc_handler = &proc_lnet_routers,
889 .proc_handler = &proc_lnet_peers,
893 .procname = "buffers",
895 .proc_handler = &proc_lnet_buffers,
901 .proc_handler = &proc_lnet_nis,
905 .procname = "portal_rotor",
907 .proc_handler = &proc_lnet_portal_rotor,
912 void lnet_router_debugfs_init(void)
914 lnet_insert_debugfs(lnet_table);
917 void lnet_router_debugfs_fini(void)
919 lnet_remove_debugfs(lnet_table);