hwloc-ps: add --lstopo-misc to output something for --lstopo --misc-from

Closes #606

Signed-off-by: Brice Goglin <Brice.Goglin@inria.fr>

Author: bgoglin

contrib/completion/bash/hwloc

@@ -493,6 +493,7 @@ _hwloc_ps(){
 		   --pid-cmd
 		   --short-name
 		   --disallowed --whole-system
+		   --lstopo-misc
 		   --json-server
 		   --json-port
 		   -v --verbose

utils/hwloc/hwloc-ps.1in

@@ -86,6 +86,10 @@ in each process and display it at the end of the line.
 On Linux, try to find the process MPI rank (by querying some widespread
 environment variables) and display it at the end of the line.
 
+.TP
+\fB\-\-lstopo\-misc\fR <file>
+Output a file that may be given to \fBlstopo \-\-misc\-from\fR for displaying
+processes/threads as Misc objects. See EXAMPLES below.
 .TP
 \fB\-\-json\-server\fR
 Run the tool as a JSON server that waits for other process' requests
@@ -175,6 +179,27 @@ it only appears in the thread-aware output (or if explicitly selected):
     $ hwloc-ps --pid 4759
     4759	Machine:0		myprogram
 
+The output may be a file that lstopo uses for adding Misc objects
+(more flexible version of lstopo --top):
+
+    $ hwloc-ps --misc-from foo
+    $ cat foo
+    name=12444 myprogram
+    cpuset=0x000000f0
+    subtype=Process
+
+    name=12444 mythread1
+    cpuset=0x00000050
+    subtype=Thread
+
+    name=12444 mythread2
+    cpuset=0x000000a0
+    subtype=Thread
+
+This may be directly given to lstopo:
+
+    $ hwloc-ps --misc-from - | lstopo --misc-from -
+
 On Linux, hwloc-ps may also display some process specific environment
 variable at the end of the line. This is for instance useful
 for identify MPI ranks among processes:

utils/hwloc/hwloc-ps.c

@@ -41,6 +41,7 @@ static int json_server = 0;
 static int json_port = JSON_PORT;
 static FILE *json_output = NULL;
 static int verbose = 0;
+static FILE *lstopo_misc_output = NULL;
 
 void usage(const char *name, FILE *where)
 {
@@ -66,6 +67,7 @@ void usage(const char *name, FILE *where)
   fprintf (where, "  --pid-cmd <cmd>    Append the output of <cmd> <pid> to each PID line\n");
   fprintf (where, "  --short-name       Show only the process short name instead of the path\n");
   fprintf (where, "  --disallowed       Include objects disallowed by administrative limitations\n");
+  fprintf (where, "  --lstopo-misc <file>  Output Misc object to be given to lstopo --misc-from <file>\n");
   fprintf (where, "  --json-server      Run as a JSON server\n");
   fprintf (where, "  --json-port <n>    Use port <n> for JSON server (default is %d)\n", JSON_PORT);
   fprintf (where, "  -v --verbose       Increase verbosity\n");
@@ -135,6 +137,45 @@ static void print_process(hwloc_topology_t topology,
 	print_task(topology, proc->threads[i].tid, proc->threads[i].name, proc->threads[i].cpuset, NULL, 1);
 }
 
+static void print_process_lstopo_misc(hwloc_topology_t topology __hwloc_attribute_unused,
+                                      struct hwloc_ps_process *proc)
+{
+  /* sort of similar to foreach_process_cb() in lstopo.c */
+  char name[100];
+  char *s;
+  unsigned i;
+
+  snprintf(name, sizeof(name), "%ld", proc->pid);
+  if (*proc->name)
+    snprintf(name, sizeof(name), "%ld %s", proc->pid, proc->name);
+  hwloc_bitmap_asprintf(&s, proc->cpuset);
+  fprintf(lstopo_misc_output,
+          "name=%s\n"
+          "cpuset=%s\n"
+          "subtype=Process\n"
+          "\n",
+          name, s);
+  free(s);
+
+  if (proc->nthreads)
+    for(i=0; i<proc->nthreads; i++)
+      if (proc->threads[i].cpuset) {
+	char task_name[150];
+	if (*proc->threads[i].name)
+	  snprintf(task_name, sizeof(task_name), "%s %li %s", name, proc->threads[i].tid, proc->threads[i].name);
+	else
+	  snprintf(task_name, sizeof(task_name), "%s %li", name, proc->threads[i].tid);
+        hwloc_bitmap_asprintf(&s, proc->threads[i].cpuset);
+        fprintf(lstopo_misc_output,
+                "name=%s\n"
+                "cpuset=%s\n"
+                "subtype=Thread\n"
+                "\n",
+                task_name, s);
+        free(s);
+      }
+}
+
 static void print_process_json(hwloc_topology_t topology,
 			       struct hwloc_ps_process *proc)
 {
@@ -207,6 +248,8 @@ static void foreach_process_cb(hwloc_topology_t topology,
 
   if (json_output)
     print_process_json(topology, proc);
+  else if (lstopo_misc_output)
+    print_process_lstopo_misc(topology, proc);
   else
     print_process(topology, proc);
 }
@@ -241,6 +284,8 @@ static int run(hwloc_topology_t topology, hwloc_const_bitmap_t topocpuset,
 
       if (json_output)
 	print_process_json(topology, &proc);
+      else if (lstopo_misc_output)
+        print_process_lstopo_misc(topology, &proc);
       else
 	print_process(topology, &proc);
     }
@@ -467,6 +512,21 @@ int main(int argc, char *argv[])
       pidcmd = argv[1];
       opt = 1;
 
+    } else if (!strcmp (argv[0], "--lstopo-misc")) {
+      if (argc < 2) {
+	usage(callname, stderr);
+	exit(EXIT_FAILURE);
+      }
+      if (!strcmp(argv[1], "-"))
+        lstopo_misc_output = stdout;
+      else
+        lstopo_misc_output = fopen(argv[1], "w");
+      if (!lstopo_misc_output) {
+        fprintf(stderr, "Failed to open --lstopo-misc output `%s' for writing (%s)\n", argv[1], strerror(errno));
+        exit(EXIT_FAILURE);
+      }
+      opt = 1;
+
     } else if (!strcmp (argv[0], "--json-server")) {
       json_server = 1;
     } else if (!strcmp (argv[0], "--json-port")) {
@@ -540,5 +600,7 @@ int main(int argc, char *argv[])
  out_with_topology:
   hwloc_topology_destroy(topology);
  out:
+  if (lstopo_misc_output && lstopo_misc_output != stdout)
+    fclose(lstopo_misc_output);
   return err;
 }

utils/lstopo/lstopo-no-graphics.1in

@@ -331,6 +331,7 @@ machine are shown.  On Linux, kernel threads are not shown.
 If many processes appear, the output may become hard to read anyway,
 making the hwloc-ps program more practical.
 
+See \fB\-\-misc\-from\fR for a customizable variant using \fBhwloc-ps\fR.
 .TP
 \fB\-\-misc\-from\fR <file>
 Add Misc objects as described in <file> containing entries such as:
@@ -342,6 +343,8 @@ Add Misc objects as described in <file> containing entries such as:
     cpuset=0x7
     subtype=myOptionalSubtype
 
+This is useful for combining with \fBhwloc-ps --lstopo-misc\fR (see EXAMPLES below)
+because hwloc-ps is far more customizable than lstopo's \fB\-\-top\fR option.
 .TP
 \fB\-\-children\-order\fR <order>
 Change the order of the different kinds of children with respect to
@@ -894,6 +897,11 @@ To count the number of logical processors in the system
 To append the kernel release and version to the graphical legend:
 
    lstopo --append-legend "Kernel release: $(uname -r)" --append-legend "Kernel version: $(uname -v)"
+
+To show where a process and its children are bound by combining with hwloc-ps:
+
+   hwloc-ps --pid-children 23 --lstopo-misc - | lstopo --misc-from -
+
 .
 .\" **************************
 .\"    Notes Section

utils/lstopo/lstopo.c

@@ -117,6 +117,7 @@ static void foreach_process_cb(hwloc_topology_t topology,
 			       struct hwloc_ps_process *proc,
 			       void *cbdata __hwloc_attribute_unused)
 {
+  /* sort of similar to print_process_lstopo_misc() in hwloc-ps.c */
   char name[100];
   unsigned i;