lstopo/draw: make memory:above layout configurable and use rectangular by default

Useful for fake numa cases where we have 8 local nodes per socket.
They'll be stacked as 2 rows of 4 instead of 1 single row of 8.

Signed-off-by: Brice Goglin <[email protected]>

Author: bgoglin

utils/lstopo/lstopo-draw.c

@@ -626,7 +626,7 @@ place_children(struct lstopo_output *loutput, hwloc_obj_t parent,
 	       unsigned xrel, unsigned yrel /* position of children within parent */)
 {
   struct lstopo_obj_userdata *plud = parent->userdata;
-  enum lstopo_orient_e main_orient, right_orient, below_orient;
+  enum lstopo_orient_e main_orient, right_orient, below_orient, above_orient;
   unsigned border = loutput->gridsize;
   unsigned separator = loutput->gridsize;
   unsigned separator_below_cache = loutput->gridsize;
@@ -674,6 +674,10 @@ place_children(struct lstopo_output *loutput, hwloc_obj_t parent,
   below_orient = loutput->below_force_orient;
   if (below_orient == LSTOPO_ORIENT_NONE)
     below_orient = loutput->force_orient[parent->type];
+  /* place above children in rectangle by default */
+  above_orient = loutput->above_force_orient;
+  if (above_orient == LSTOPO_ORIENT_NONE)
+    above_orient = LSTOPO_ORIENT_RECT;
 
   /* defaults */
   plud->children.box = 0;
@@ -790,7 +794,6 @@ place_children(struct lstopo_output *loutput, hwloc_obj_t parent,
 
   /* compute the size of the above children section (Memory), if any */
   if (plud->above_children.kinds) {
-    enum lstopo_orient_e morient = LSTOPO_ORIENT_HORIZ;
     int need_box;
 
     assert(plud->above_children.kinds == LSTOPO_CHILD_KIND_MEMORY);
@@ -801,7 +804,7 @@ place_children(struct lstopo_output *loutput, hwloc_obj_t parent,
     need_box = !hwloc_obj_type_is_memory(parent->type)
       && (parent->memory_arity + parent->memory_first_child->memory_arity > 1);
 
-    place__children(loutput, parent, plud->above_children.kinds, &morient, need_box ? border : 0, separator, &above_children_width, &above_children_height);
+    place__children(loutput, parent, plud->above_children.kinds, &above_orient, need_box ? border : 0, separator, &above_children_width, &above_children_height);
     if (parent->type == HWLOC_OBJ_MEMCACHE)
       above_children_height -= separator;
 

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

@@ -349,7 +349,7 @@ on the right.
 
 Up to hwloc 2.5, the default was rather to \fImemory:above,plain\fR.
 
-Additionally, \fIio:right\fR, \fIio:below\fR, \fImisc:right\fR
+Additionally, \fImemory:above\fR, \fIio:right\fR, \fIio:below\fR, \fImisc:right\fR
 and \fImisc:below\fR may be suffixed with
 \fI:horiz\fR, \fI:vert\fR or \fI:rect\fR to force the horizontal,
 vertical or rectangular layout of children inside these sections.

utils/lstopo/lstopo.c

@@ -303,11 +303,13 @@ lstopo_check_pci_domains(hwloc_topology_t topology)
 
 static void
 lstopo_parse_children_order(char *s, unsigned *children_order_p,
+                            enum lstopo_orient_e *above_force_orient_p,
                             enum lstopo_orient_e *right_force_orient_p,
                             enum lstopo_orient_e *below_force_orient_p)
 {
   char *tmp, *next;
   unsigned children_order;
+  enum lstopo_orient_e above_force_orient = LSTOPO_ORIENT_NONE;
   enum lstopo_orient_e right_force_orient = LSTOPO_ORIENT_NONE;
   enum lstopo_orient_e below_force_orient= LSTOPO_ORIENT_NONE;
 
@@ -327,6 +329,15 @@ lstopo_parse_children_order(char *s, unsigned *children_order_p,
 
     if (!strcmp(tmp, "memory:above") || !strcmp(tmp, "memoryabove") /* backward compat with 2.5 */) {
       children_order |= LSTOPO_ORDER_MEMORY_ABOVE;
+    } else if (!strcmp(tmp, "memory:above:horiz")) {
+      children_order |= LSTOPO_ORDER_MEMORY_ABOVE;
+      above_force_orient = LSTOPO_ORIENT_HORIZ;
+    } else if (!strcmp(tmp, "memory:above:vert")) {
+      children_order |= LSTOPO_ORDER_MEMORY_ABOVE;
+      above_force_orient = LSTOPO_ORIENT_VERT;
+    } else if (!strcmp(tmp, "memory:above:rect")) {
+      children_order |= LSTOPO_ORDER_MEMORY_ABOVE;
+      above_force_orient = LSTOPO_ORIENT_RECT;
 
     } else if (!strcmp(tmp, "io:right")) {
       children_order |= LSTOPO_ORDER_IO_RIGHT;
@@ -384,6 +395,7 @@ lstopo_parse_children_order(char *s, unsigned *children_order_p,
   }
 
   *children_order_p = children_order;
+  *above_force_orient_p = above_force_orient;
   *right_force_orient_p = right_force_orient;
   *below_force_orient_p = below_force_orient;
 }
@@ -896,6 +908,7 @@ main (int argc, char *argv[])
     loutput.force_orient[i] = LSTOPO_ORIENT_HORIZ;
   loutput.force_orient[HWLOC_OBJ_NUMANODE] = LSTOPO_ORIENT_HORIZ;
   loutput.force_orient[HWLOC_OBJ_MEMCACHE] = LSTOPO_ORIENT_HORIZ;
+  loutput.above_force_orient = LSTOPO_ORIENT_NONE;
   loutput.right_force_orient = LSTOPO_ORIENT_NONE;
   loutput.below_force_orient = LSTOPO_ORIENT_NONE;
   for(i=HWLOC_OBJ_TYPE_MIN; i<HWLOC_OBJ_TYPE_MAX; i++) {
@@ -1383,7 +1396,7 @@ main (int argc, char *argv[])
 	if (argc < 2)
 	  goto out_usagefailure;
         lstopo_parse_children_order(argv[1], &loutput.children_order,
-                                    &loutput.right_force_orient, &loutput.below_force_orient);
+                                    &loutput.above_force_orient, &loutput.right_force_orient, &loutput.below_force_orient);
 	opt = 1;
       }
       else if (!strcmp (argv[0], "--no-cpukinds")) {

utils/lstopo/lstopo.h

@@ -1,6 +1,6 @@
 /*
  * Copyright © 2009 CNRS
- * Copyright © 2009-2022 Inria.  All rights reserved.
+ * Copyright © 2009-2023 Inria.  All rights reserved.
  * Copyright © 2009-2010, 2012, 2015 Université Bordeaux
  * Copyright © 2011 Cisco Systems, Inc.  All rights reserved.
  * Copyright © 2020 Hewlett Packard Enterprise.  All rights reserved.
@@ -112,6 +112,7 @@ struct lstopo_output {
   unsigned int gridsize, fontsize, linespacing, thickness;
   float text_xscale;
   enum lstopo_orient_e force_orient[HWLOC_OBJ_TYPE_MAX]; /* orientation of children within an object of the given type */
+  enum lstopo_orient_e above_force_orient;
   enum lstopo_orient_e right_force_orient;
   enum lstopo_orient_e below_force_orient;
   int show_indexes[HWLOC_OBJ_TYPE_MAX]; /* enabled by global toggle index_type */