Merge pull request #607 from bgoglin/topo-infos

* add topology-global array of info attrs, available from hwloc_topology_get_infos()
* move topology/backend and OS information there instead of in the root object mess

Author: bgoglin

NEWS

@@ -37,6 +37,12 @@ Version 3.0.0
   + The array and count of info attributes are now embedded in the new
     struct hwloc_infos_s.
     - hwloc_infos_s structures may be modified with hwloc_modify_infos().
+    - hwloc_topology_get_infos() returns the new topology-global array
+      of info attributes.
+      . Several info attributes previously stored in the root object are
+        now topology attributes (e.g. information about hwloc, about the
+        discovery, operating system information returned by uname).
+        See "Custom string infos" in the documentation for details.
     - hwloc_cpukinds_get_info() and hwloc_cpukinds_register() now manipulate
       infos as such a structure.
 * Tools

doc/Makefile.am

@@ -356,7 +356,8 @@ man3_object_info_attrs_DATA = \
         $(DOX_MAN_DIR)/man3/HWLOC_MODIFY_INFOS_OP_ADD.3 \
         $(DOX_MAN_DIR)/man3/HWLOC_MODIFY_INFOS_OP_ADD_UNIQUE.3 \
         $(DOX_MAN_DIR)/man3/HWLOC_MODIFY_INFOS_OP_REPLACE.3 \
-        $(DOX_MAN_DIR)/man3/HWLOC_MODIFY_INFOS_OP_REMOVE.3
+        $(DOX_MAN_DIR)/man3/HWLOC_MODIFY_INFOS_OP_REMOVE.3 \
+        $(DOX_MAN_DIR)/man3/hwloc_topology_get_infos.3
 
 man3_cpubindingdir = $(man3dir)
 man3_cpubinding_DATA = \

doc/hwloc.doxy

@@ -1972,6 +1972,9 @@ or using the hwloc_obj_get_info_by_name().
 The user may additionally add new name-value pairs to any object using
 hwloc_obj_add_info(), hwloc_modify_infos() or the \ref cli_hwloc_annotate program.
 
+Some topology-global info attributes (not specific to some objects)
+are also accessible using hwloc_topology_get_infos().
+
 Here is a non-exhaustive list of attributes that may be automatically
 added by hwloc.
 Note that these attributes heavily depend on the ability of the
@@ -2020,7 +2023,7 @@ See doc/examples/get-knl-modes.c in the source directory for an example of retri
 \endhtmlonly
 \subsection attributes_info_os Operating System Information
 
-These info attributes are attached to the root object (Machine).
+These info attributes are attached to the topology itself.
 
 <dl>
 <dt>OSName, OSRelease, OSVersion, HostName, Architecture</dt>
@@ -2040,12 +2043,12 @@ placed.
 \htmlonly
 </div><div class="subsection" id="attributes_info_hwloc">
 \endhtmlonly
-\subsection attributes_info_hwloc hwloc Information
+\subsection attributes_info_hwloc hwloc Topology Information
 
-Unless specified, these info attributes are attached to the root object (Machine).
+These info attributes are attached to the topology itself.
 
 <dl>
-<dt>Backend (topology root object)</dt>
+<dt>Backend</dt>
 <dd>The name of a hwloc backend/component that added objects in the topology.
 If several components were combined, multiple Backend pairs may exist,
 with different values, for instance <tt>x86</tt>, <tt>Linux</tt> and
@@ -2316,9 +2319,9 @@ that have a special meaning:
 <div class="section">
 \endhtmlonly
 
-Besides the hierarchy of objects and individual object attributes
-(see \ref attributes), hwloc may also expose finer information about
-the hardware organization.
+Besides the hierarchy of objects, individual object attributes
+and topology info attributes (see \ref attributes),
+hwloc may also expose finer information about the hardware organization.
 
 
 \htmlonly

hwloc/diff.c

@@ -66,7 +66,8 @@ static int hwloc_append_diff_too_complex(hwloc_obj_t obj1,
 	return 0;
 }
 
-static int hwloc_append_diff_obj_attr_string(hwloc_obj_t obj,
+static int hwloc_append_diff_obj_attr_string(hwloc_topology_t topology,
+                                             hwloc_obj_t obj,
 					     hwloc_topology_diff_obj_attr_type_t type,
 					     const char *name,
 					     const char *oldvalue,
@@ -80,8 +81,8 @@ static int hwloc_append_diff_obj_attr_string(hwloc_obj_t obj,
 		return -1;
 
 	newdiff->obj_attr.type = HWLOC_TOPOLOGY_DIFF_OBJ_ATTR;
-	newdiff->obj_attr.obj_depth = obj->depth;
-	newdiff->obj_attr.obj_index = obj->logical_index;
+	newdiff->obj_attr.obj_depth = obj ? obj->depth : (int) topology->nb_levels;
+	newdiff->obj_attr.obj_index = obj ? obj->logical_index : 0;
 	newdiff->obj_attr.diff.string.type = type;
 	newdiff->obj_attr.diff.string.name = name ? strdup(name) : NULL;
 	newdiff->obj_attr.diff.string.oldvalue = oldvalue ? strdup(oldvalue) : NULL;
@@ -155,7 +156,7 @@ hwloc_diff_trees(hwloc_topology_t topo1, hwloc_obj_t obj1,
 
 	if ((!obj1->name) != (!obj2->name)
 	    || (obj1->name && strcmp(obj1->name, obj2->name))) {
-		err = hwloc_append_diff_obj_attr_string(obj1,
+                err = hwloc_append_diff_obj_attr_string(topo1, obj1,
 						       HWLOC_TOPOLOGY_DIFF_OBJ_ATTR_NAME,
 						       NULL,
 						       obj1->name,
@@ -219,7 +220,7 @@ hwloc_diff_trees(hwloc_topology_t topo1, hwloc_obj_t obj1,
 		if (strcmp(info1->name, info2->name))
 			goto out_too_complex;
 		if (strcmp(info1->value, info2->value)) {
-			err = hwloc_append_diff_obj_attr_string(obj1,
+                        err = hwloc_append_diff_obj_attr_string(topo1, obj1,
 								HWLOC_TOPOLOGY_DIFF_OBJ_ATTR_INFO,
 								info1->name,
 								info1->value,
@@ -338,6 +339,27 @@ int hwloc_topology_diff_build(hwloc_topology_t topo1,
                   goto roottoocomplex;
 	}
 
+        /* topology infos */
+        if (!err) {
+          if (topo1->infos.count != topo2->infos.count)
+            goto roottoocomplex;
+          for(i=0; i<topo1->infos.count; i++) {
+            struct hwloc_info_s *info1 = &topo1->infos.array[i], *info2 = &topo2->infos.array[i];
+            if (strcmp(info1->name, info2->name))
+              goto roottoocomplex;
+            if (strcmp(info1->value, info2->value)) {
+              err = hwloc_append_diff_obj_attr_string(topo1, NULL,
+                                                      HWLOC_TOPOLOGY_DIFF_OBJ_ATTR_INFO,
+                                                      info1->name,
+                                                      info1->value,
+                                                      info2->value,
+                                                      diffp, &lastdiff);
+              if (err < 0)
+                return err;
+            }
+          }
+	}
+
 	if (!err) {
 		/* distances */
 		hwloc_internal_distances_refresh(topo1);
@@ -458,15 +480,22 @@ hwloc_apply_diff_one(hwloc_topology_t topology,
 	case HWLOC_TOPOLOGY_DIFF_OBJ_ATTR: {
 		struct hwloc_topology_diff_obj_attr_s *obj_attr = &diff->obj_attr;
 		hwloc_obj_t obj = hwloc_get_obj_by_depth(topology, obj_attr->obj_depth, obj_attr->obj_index);
-		if (!obj)
-			return -1;
+                struct hwloc_infos_s *infos;
+                if (obj)
+                  infos = &obj->infos;
+                else if (obj_attr->obj_depth == (int) topology->nb_levels)
+                  infos = &topology->infos;
+                else
+                  return -1;
 
 		switch (obj_attr->diff.generic.type) {
 		case HWLOC_TOPOLOGY_DIFF_OBJ_ATTR_SIZE: {
 			hwloc_obj_t tmpobj;
 			hwloc_uint64_t oldvalue = reverse ? obj_attr->diff.uint64.newvalue : obj_attr->diff.uint64.oldvalue;
 			hwloc_uint64_t newvalue = reverse ? obj_attr->diff.uint64.oldvalue : obj_attr->diff.uint64.newvalue;
 			hwloc_uint64_t valuediff = newvalue - oldvalue;
+                        if (!obj)
+                          return -1;
 			if (obj->type != HWLOC_OBJ_NUMANODE)
 				return -1;
 			if (obj->attr->numanode.local_memory != oldvalue)
@@ -482,7 +511,9 @@ hwloc_apply_diff_one(hwloc_topology_t topology,
 		case HWLOC_TOPOLOGY_DIFF_OBJ_ATTR_NAME: {
 			const char *oldvalue = reverse ? obj_attr->diff.string.newvalue : obj_attr->diff.string.oldvalue;
 			const char *newvalue = reverse ? obj_attr->diff.string.oldvalue : obj_attr->diff.string.newvalue;
-			if (!obj->name || strcmp(obj->name, oldvalue))
+                        if (!obj)
+                          return -1;
+                        if (!obj->name || strcmp(obj->name, oldvalue))
 				return -1;
 			free(obj->name);
 			obj->name = strdup(newvalue);
@@ -494,8 +525,8 @@ hwloc_apply_diff_one(hwloc_topology_t topology,
 			const char *newvalue = reverse ? obj_attr->diff.string.oldvalue : obj_attr->diff.string.newvalue;
 			unsigned i;
 			int found = 0;
-			for(i=0; i<obj->infos.count; i++) {
-				struct hwloc_info_s *info = &obj->infos.array[i];
+			for(i=0; i<infos->count; i++) {
+				struct hwloc_info_s *info = &infos->array[i];
 				if (!strcmp(info->name, name)
 				    && !strcmp(info->value, oldvalue)) {
 					free(info->value);

hwloc/hwloc2.dtd

@@ -1,13 +1,13 @@
 <!--
   Copyright © 2009      CNRS
-  Copyright © 2009-2022 Inria.  All rights reserved.
+  Copyright © 2009-2023 Inria.  All rights reserved.
   Copyright © 2009-2011 Université Bordeaux.
   See COPYING in top-level directory.
 
   This is the DTD for hwloc v2.x XMLs.
  -->
 
-<!ELEMENT topology (object+,distances2*,distances2hetero*,support*,memattr*,cpukind*)>
+<!ELEMENT topology (object+,distances2*,distances2hetero*,support*,memattr*,cpukind*,info*)>
 <!ATTLIST topology version CDATA "">
 
 <!ELEMENT object (page_type*,info*,userdata*,object*)>

hwloc/misc.c

@@ -1,6 +1,6 @@
 /*
  * Copyright © 2009 CNRS
- * Copyright © 2009-2022 Inria.  All rights reserved.
+ * Copyright © 2009-2023 Inria.  All rights reserved.
  * Copyright © 2009-2010 Université Bordeaux
  * Copyright © 2009-2018 Cisco Systems, Inc.  All rights reserved.
  * See COPYING in top-level directory.
@@ -86,7 +86,7 @@ void hwloc_add_uname_info(struct hwloc_topology *topology __hwloc_attribute_unus
 #ifdef HAVE_UNAME
   struct utsname _utsname, *utsname;
 
-  if (hwloc_obj_get_info_by_name(topology->levels[0][0], "OSName"))
+  if (hwloc_get_info_by_name(&topology->infos, "OSName"))
     /* don't annotate twice */
     return;
 
@@ -99,15 +99,15 @@ void hwloc_add_uname_info(struct hwloc_topology *topology __hwloc_attribute_unus
   }
 
   if (*utsname->sysname)
-    hwloc_obj_add_info(topology->levels[0][0], "OSName", utsname->sysname);
+    hwloc__add_info(&topology->infos, "OSName", utsname->sysname);
   if (*utsname->release)
-    hwloc_obj_add_info(topology->levels[0][0], "OSRelease", utsname->release);
+    hwloc__add_info(&topology->infos, "OSRelease", utsname->release);
   if (*utsname->version)
-    hwloc_obj_add_info(topology->levels[0][0], "OSVersion", utsname->version);
+    hwloc__add_info(&topology->infos, "OSVersion", utsname->version);
   if (*utsname->nodename)
-    hwloc_obj_add_info(topology->levels[0][0], "HostName", utsname->nodename);
+    hwloc__add_info(&topology->infos, "HostName", utsname->nodename);
   if (*utsname->machine)
-    hwloc_obj_add_info(topology->levels[0][0], "Architecture", utsname->machine);
+    hwloc__add_info(&topology->infos, "Architecture", utsname->machine);
 #endif /* HAVE_UNAME */
 }
 

hwloc/topology-aix.c

@@ -817,7 +817,7 @@ hwloc_look_aix(struct hwloc_backend *backend, struct hwloc_disc_status *dstatus)
 	}
     }
 
-  hwloc_obj_add_info(topology->levels[0][0], "Backend", "AIX");
+  hwloc__add_info(&topology->infos, "Backend", "AIX");
   hwloc_add_uname_info(topology, NULL);
   return 0;
 }

hwloc/topology-cuda.c

@@ -142,7 +142,7 @@ hwloc_cuda_discover(struct hwloc_backend *backend, struct hwloc_disc_status *dst
   }
 
   if (added > 0)
-    hwloc_obj_add_info(hwloc_get_root_obj(topology), "Backend", "CUDA");
+    hwloc_modify_infos(hwloc_topology_get_infos(topology), HWLOC_MODIFY_INFOS_OP_ADD, "Backend", "CUDA");
   return 0;
 }
 

hwloc/topology-darwin.c

@@ -903,7 +903,7 @@ hwloc_look_darwin(struct hwloc_backend *backend, struct hwloc_disc_status *dstat
   else
     hwloc__darwin_cpukinds_register(topology, &kinds);
 
-  hwloc_obj_add_info(topology->levels[0][0], "Backend", "Darwin");
+  hwloc__add_info(&topology->infos, "Backend", "Darwin");
   hwloc_add_uname_info(topology, NULL);
   return 0;
 }

hwloc/topology-freebsd.c

@@ -553,7 +553,7 @@ hwloc_look_freebsd(struct hwloc_backend *backend, struct hwloc_disc_status *dsta
   }
 
   if (data->need_global_infos) {
-    hwloc_obj_add_info(topology->levels[0][0], "Backend", "FreeBSD");
+    hwloc__add_info(&topology->infos, "Backend", "FreeBSD");
     hwloc_add_uname_info(topology, NULL);
     data->need_global_infos = 0;
   }