ib-diags: add missing file
[mirror/winof/.git] / tools / infiniband-diags / src / iblinkinfo.c
1 /*
2  * Copyright (c) 2004-2007 Voltaire Inc.  All rights reserved.
3  * Copyright (c) 2007 Xsigo Systems Inc.  All rights reserved.
4  * Copyright (c) 2008 Lawrence Livermore National Lab.  All rights reserved.
5  *
6  * This software is available to you under a choice of one of two
7  * licenses.  You may choose to be licensed under the terms of the GNU
8  * General Public License (GPL) Version 2, available from the file
9  * COPYING in the main directory of this source tree, or the
10  * OpenIB.org BSD license below:
11  *
12  *     Redistribution and use in source and binary forms, with or
13  *     without modification, are permitted provided that the following
14  *     conditions are met:
15  *
16  *      - Redistributions of source code must retain the above
17  *        copyright notice, this list of conditions and the following
18  *        disclaimer.
19  *
20  *      - Redistributions in binary form must reproduce the above
21  *        copyright notice, this list of conditions and the following
22  *        disclaimer in the documentation and/or other materials
23  *        provided with the distribution.
24  *
25  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
26  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
27  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
28  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
29  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
30  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
31  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
32  * SOFTWARE.
33  *
34  */
35
36 #if HAVE_CONFIG_H
37 #  include <config.h>
38 #endif /* HAVE_CONFIG_H */
39
40 #define _GNU_SOURCE
41 #include <stdio.h>
42 #include <stdlib.h>
43 #include <unistd.h>
44 #include <stdarg.h>
45 #include <time.h>
46 #include <string.h>
47 #include <getopt.h>
48 #include <errno.h>
49 #include <inttypes.h>
50
51 #include <complib/cl_nodenamemap.h>
52 #include <infiniband/ibnetdisc.h>
53
54 char *argv0 = "iblinkinfotest";
55 static FILE *f;
56
57 static char *node_name_map_file = NULL;
58 static nn_map_t *node_name_map = NULL;
59
60 static int timeout_ms = 500;
61
62 static int down_links_only = 0;
63 static int line_mode = 0;
64 static int add_sw_settings = 0;
65 static int print_port_guids = 0;
66
67 static unsigned int
68 get_max(unsigned int num)
69 {
70         unsigned int v = num; // 32-bit word to find the log base 2 of
71         unsigned r = 0; // r will be lg(v)
72
73         while (v >>= 1) // unroll for more speed...
74         {
75                 r++;
76         }
77
78         return (1 << r);
79 }
80
81 void
82 get_msg(char *width_msg, char *speed_msg, int msg_size, ibnd_port_t *port)
83 {
84         char buf[64];
85         uint32_t max_speed = 0;
86
87         uint32_t max_width = get_max(mad_get_field(port->info, 0,
88                                         IB_PORT_LINK_WIDTH_SUPPORTED_F)
89                                 & mad_get_field(port->remoteport->info, 0,
90                                         IB_PORT_LINK_WIDTH_SUPPORTED_F));
91         if ((max_width & mad_get_field(port->info, 0,
92                                 IB_PORT_LINK_WIDTH_ACTIVE_F)) == 0) {
93                 // we are not at the max supported width
94                 // print what we could be at.
95                 snprintf(width_msg, msg_size, "Could be %s",
96                         mad_dump_val(IB_PORT_LINK_WIDTH_ACTIVE_F,
97                                 buf, 64, &max_width));
98         }
99
100         max_speed = get_max(mad_get_field(port->info, 0,
101                                         IB_PORT_LINK_SPEED_SUPPORTED_F)
102                                 & mad_get_field(port->remoteport->info, 0,
103                                         IB_PORT_LINK_SPEED_SUPPORTED_F));
104         if ((max_speed & mad_get_field(port->info, 0,
105                                 IB_PORT_LINK_SPEED_ACTIVE_F)) == 0) {
106                 // we are not at the max supported speed
107                 // print what we could be at.
108                 snprintf(speed_msg, msg_size, "Could be %s",
109                         mad_dump_val(IB_PORT_LINK_SPEED_ACTIVE_F,
110                                 buf, 64, &max_speed));
111         }
112 }
113
114 void
115 print_port(ibnd_node_t *node, ibnd_port_t *port)
116 {
117         char width[64], speed[64], state[64], physstate[64];
118         char remote_guid_str[256];
119         char remote_str[256];
120         char link_str[256];
121         char width_msg[256];
122         char speed_msg[256];
123         char ext_port_str[256];
124         int iwidth, ispeed, istate, iphystate;
125         int n = 0;
126
127         if (!port)
128                 return;
129
130         iwidth = mad_get_field(port->info, 0, IB_PORT_LINK_WIDTH_ACTIVE_F);
131         ispeed = mad_get_field(port->info, 0, IB_PORT_LINK_SPEED_ACTIVE_F);
132         istate = mad_get_field(port->info, 0, IB_PORT_STATE_F);
133         iphystate = mad_get_field(port->info, 0, IB_PORT_PHYS_STATE_F);
134
135         remote_guid_str[0] = '\0';
136         remote_str[0] = '\0';
137         link_str[0] = '\0';
138         width_msg[0] = '\0';
139         speed_msg[0] = '\0';
140
141         n = snprintf(link_str, 256, "(%3s %s %6s/%8s)",
142                 mad_dump_val(IB_PORT_LINK_WIDTH_ACTIVE_F, width, 64, &iwidth),
143                 mad_dump_val(IB_PORT_LINK_SPEED_ACTIVE_F, speed, 64, &ispeed),
144                 mad_dump_val(IB_PORT_STATE_F, state, 64, &istate),
145                 mad_dump_val(IB_PORT_PHYS_STATE_F, physstate, 64, &iphystate));
146
147         if (add_sw_settings)
148                 snprintf(link_str+n, 256-n,
149                         " (HOQ:%d VL_Stall:%d)",
150                         mad_get_field(port->info, 0, IB_PORT_HOQ_LIFE_F),
151                         mad_get_field(port->info, 0, IB_PORT_VL_STALL_COUNT_F));
152
153         if (port->remoteport) {
154                 char *remap = remap_node_name(node_name_map, port->remoteport->node->guid,
155                                 port->remoteport->node->nodedesc);
156
157                 if (port->remoteport->ext_portnum)
158                         snprintf(ext_port_str, 256, "%d", port->remoteport->ext_portnum);
159                 else
160                         ext_port_str[0] = '\0';
161
162                 get_msg(width_msg, speed_msg, 256, port);
163
164                 if (line_mode) {
165                         if (print_port_guids)
166                                 snprintf(remote_guid_str, 256, "0x%016"PRIx64" ",
167                                         port->remoteport->guid);
168                         else
169                                 snprintf(remote_guid_str, 256, "0x%016"PRIx64" ",
170                                         port->remoteport->node->guid);
171                 }
172
173                 snprintf(remote_str, 256,
174                         "%s%6d %4d[%2s] \"%s\" (%s %s)\n",
175                         remote_guid_str,
176                         port->remoteport->base_lid ?  port->remoteport->base_lid :
177                                 port->remoteport->node->smalid,
178                         port->remoteport->portnum,
179                         ext_port_str,
180                         remap,
181                         width_msg,
182                         speed_msg);
183                 free(remap);
184         } else
185                 snprintf(remote_str, 256, "           [  ] \"\" ( )\n");
186
187         if (port->ext_portnum)
188                 snprintf(ext_port_str, 256, "%d", port->ext_portnum);
189         else
190                 ext_port_str[0] = '\0';
191
192         if (line_mode) {
193                 char *remap = remap_node_name(node_name_map, node->guid,
194                                         node->nodedesc);
195                 printf("0x%016"PRIx64" \"%30s\" ", node->guid, remap);
196                 free(remap);
197         } else
198                 printf("      ");
199
200         printf("%6d %4d[%2s] ==%s==>  %s",
201                 node->smalid, port->portnum, ext_port_str, link_str, remote_str);
202 }
203
204 void
205 print_switch(ibnd_node_t *node, void *user_data)
206 {
207         int i = 0;
208
209         if (!line_mode) {
210                 char *remap = remap_node_name(node_name_map, node->guid,
211                                         node->nodedesc);
212                 printf("Switch 0x%016"PRIx64" %s:\n", node->guid, remap);
213                 free(remap);
214         }
215
216         for (i = 1; i <= node->numports; i++) {
217                 ibnd_port_t *port = node->ports[i];
218                 if (!port)
219                         continue;
220                 if (!down_links_only ||
221                                 mad_get_field(port->info, 0, IB_PORT_STATE_F) == IB_LINK_DOWN) {
222                         print_port(node, port);
223                 }
224         }
225 }
226
227 void
228 usage(void)
229 {
230         fprintf(stderr,
231                 "Usage: %s [-hclp -S <guid> -D <direct route> -C <ca_name> -P <ca_port>]\n"
232                 "   Report link speed and connection for each port of each switch which is active\n"
233                 "   -h This help message\n"
234                 "   -S <guid> output only the node specified by guid\n"
235                 "   -D <direct route> print only node specified by <direct route>\n"
236                 "   -f <dr_path> specify node to start \"from\"\n"
237                 "   -n <hops> Number of hops to include away from specified node\n"
238                 "   -d print only down links\n"
239                 "   -l (line mode) print all information for each link on each line\n"
240                 "   -p print additional switch settings (PktLifeTime,HoqLife,VLStallCount)\n"
241
242
243                 "   -t <timeout_ms> timeout for any single fabric query\n"
244                 "   -s show progress during scan\n"
245                 "   --node-name-map <map_file> use specified node name map\n"
246
247                 "   -C <ca_name> use selected Channel Adaptor name for queries\n"
248                 "   -P <ca_port> use selected channel adaptor port for queries\n"
249                 "   -g print port guids instead of node guids\n"
250                 "   --debug print debug messages\n"
251                 "   -R (this option is obsolete and does nothing)\n"
252                 ,
253                         argv0);
254         exit(-1);
255 }
256
257 int
258 main(int argc, char **argv)
259 {
260         int rc = 0;
261         char *ca = 0;
262         int ca_port = 0;
263         ibnd_fabric_t *fabric = NULL;
264         uint64_t guid = 0;
265         char *dr_path = NULL;
266         char *from = NULL;
267         int hops = 0;
268         ib_portid_t port_id;
269
270         struct ibmad_port *ibmad_port;
271         int mgmt_classes[2] = {IB_SMI_CLASS, IB_SMI_DIRECT_CLASS};
272
273         static char const str_opts[] = "S:D:n:C:P:t:sldgphuf:R";
274         static const struct option long_opts[] = {
275                 { "S", 1, 0, 'S'},
276                 { "D", 1, 0, 'D'},
277                 { "num-hops", 1, 0, 'n'},
278                 { "down-links-only", 0, 0, 'd'},
279                 { "line-mode", 0, 0, 'l'},
280                 { "ca-name", 1, 0, 'C'},
281                 { "ca-port", 1, 0, 'P'},
282                 { "timeout", 1, 0, 't'},
283                 { "show", 0, 0, 's'},
284                 { "print-port-guids", 0, 0, 'g'},
285                 { "print-additional", 0, 0, 'p'},
286                 { "help", 0, 0, 'h'},
287                 { "usage", 0, 0, 'u'},
288                 { "node-name-map", 1, 0, 1},
289                 { "debug", 0, 0, 2},
290                 { "compat", 0, 0, 3},
291                 { "from", 1, 0, 'f'},
292                 { "R", 0, 0, 'R'},
293                 { 0 }
294         };
295
296         f = stdout;
297
298         argv0 = argv[0];
299
300         while (1) {
301                 int ch = getopt_long(argc, argv, str_opts, long_opts, NULL);
302                 if ( ch == -1 )
303                         break;
304                 switch(ch) {
305                 case 1:
306                         node_name_map_file = strdup(optarg);
307                         break;
308                 case 2:
309                         ibnd_debug(1);
310                         break;
311                 case 'f':
312                         from = strdup(optarg);
313                         break;
314                 case 'C':
315                         ca = strdup(optarg);
316                         break;
317                 case 'P':
318                         ca_port = strtoul(optarg, 0, 0);
319                         break;
320                 case 'D':
321                         dr_path = strdup(optarg);
322                         break;
323                 case 'n':
324                         hops = (int)strtol(optarg, NULL, 0);
325                         break;
326                 case 'd':
327                         down_links_only = 1;
328                         break;
329                 case 'l':
330                         line_mode = 1;
331                         break;
332                 case 't':
333                         timeout_ms = strtoul(optarg, 0, 0);
334                         break;
335                 case 's':
336                         ibnd_show_progress(1);
337                         break;
338                 case 'g':
339                         print_port_guids = 1;
340                         break;
341                 case 'S':
342                         guid = (uint64_t)strtoull(optarg, 0, 0);
343                         break;
344                 case 'p':
345                         add_sw_settings = 1;
346                         break;
347                 case 'R':
348                         /* GNDN */
349                         break;
350                 default:
351                         usage();
352                         break;
353                 }
354         }
355         argc -= optind;
356         argv += optind;
357
358         if (argc && !(f = fopen(argv[0], "w")))
359                 fprintf(stderr, "can't open file %s for writing", argv[0]);
360
361         ibmad_port = mad_rpc_open_port(ca, ca_port, mgmt_classes, 2);
362         if (!ibmad_port) {
363                 fprintf(stderr, "Failed to open %s port %d", ca, ca_port);
364                 exit(1);
365         }
366
367         node_name_map = open_node_name_map(node_name_map_file);
368
369         if (from) {
370                 /* only scan part of the fabric */
371                 str2drpath(&(port_id.drpath), from, 0, 0);
372                 if ((fabric = ibnd_discover_fabric(ibmad_port, timeout_ms, &port_id, hops)) == NULL) {
373                         fprintf(stderr, "discover failed\n");
374                         rc = 1;
375                         goto close_port;
376                 }
377                 guid = 0;
378         } else {
379                 if ((fabric = ibnd_discover_fabric(ibmad_port, timeout_ms, NULL, -1)) == NULL) {
380                         fprintf(stderr, "discover failed\n");
381                         rc = 1;
382                         goto close_port;
383                 }
384         }
385
386         if (guid) {
387                 ibnd_node_t *sw = ibnd_find_node_guid(fabric, guid);
388                 print_switch(sw, NULL);
389         } else if (dr_path) {
390                 ibnd_node_t *sw = ibnd_find_node_dr(fabric, dr_path);
391                 print_switch(sw, NULL);
392         } else {
393                 ibnd_iter_nodes_type(fabric, print_switch, IB_NODE_SWITCH, NULL);
394         }
395
396         ibnd_destroy_fabric(fabric);
397
398 close_port:
399         close_node_name_map(node_name_map);
400         mad_rpc_close_port(ibmad_port);
401         exit(rc);
402 }