API: add topology-specific info attributes

bgoglin · bgoglin · commit 88a6c1d54ed8 · 2023-07-26T14:05:38.000+02:00
Accessible through hwloc_topology_get_infos()

Nothing in this array yet.

Signed-off-by: Brice Goglin &lt;Brice.Goglin@inria.fr&gt;
diff --git a/NEWS b/NEWS
@@ -37,6 +37,8 @@ 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.
     - hwloc_cpukinds_get_info() and hwloc_cpukinds_register() now manipulate
       infos as such a structure.
 * Tools
diff --git a/doc/Makefile.am b/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 = \
diff --git a/doc/hwloc.doxy b/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
@@ -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
diff --git a/hwloc/diff.c b/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);
diff --git a/hwloc/hwloc2.dtd b/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*)>
diff --git a/hwloc/topology-xml.c b/hwloc/topology-xml.c
@@ -1782,7 +1782,8 @@ hwloc_look_xml(struct hwloc_backend *backend, struct hwloc_disc_status *dstatus)
         ret = hwloc___xml_import_info(&infoname, &infovalue, &childstate);
         if (ret < 0)
           goto failed;
-        /* ignored */
+        if (infoname && infovalue)
+          hwloc__add_info(&topology->infos, infoname, infovalue);
       } else {
 	if (hwloc__xml_verbose())
 	  fprintf(stderr, "%s: ignoring unknown tag `%s' after root object.\n",
@@ -2518,6 +2519,14 @@ hwloc__xml_export_cpukinds(hwloc__xml_export_state_t state, hwloc_topology_t top
   }
 }
 
+static void
+hwloc__xml_export_infos(hwloc__xml_export_state_t state, hwloc_topology_t topology)
+{
+  unsigned j;
+  for(j=0; j<topology->infos.count; j++)
+    hwloc__xml_export_info_attr(state, topology->infos.array[j].name, topology->infos.array[j].value);
+}
+
 void
 hwloc__xml_export_topology(hwloc__xml_export_state_t state, hwloc_topology_t topology, unsigned long flags)
 {
@@ -2531,6 +2540,7 @@ hwloc__xml_export_topology(hwloc__xml_export_state_t state, hwloc_topology_t top
       hwloc__xml_v2export_support(state, topology);
     hwloc__xml_export_memattrs(state, topology);
     hwloc__xml_export_cpukinds(state, topology);
+    hwloc__xml_export_infos(state, topology);
 }
 
 void
diff --git a/hwloc/topology.c b/hwloc/topology.c
@@ -461,6 +461,11 @@ hwloc_debug_print_objects(int indent __hwloc_attribute_unused, hwloc_obj_t obj)
 #define hwloc_debug_print_objects(indent, obj) do { /* nothing */ } while (0)
 #endif /* !HWLOC_DEBUG */
 
+struct hwloc_infos_s * hwloc_topology_get_infos(hwloc_topology_t topology)
+{
+  return &topology->infos;
+}
+
 void hwloc__free_infos(struct hwloc_infos_s *infos)
 {
   unsigned i;
@@ -1206,6 +1211,8 @@ hwloc__topology_dup(hwloc_topology_t *newp,
   if (err < 0)
     goto out_with_topology;
 
+  hwloc__tma_dup_infos(tma, &new->infos, &old->infos);
+
   err = hwloc_internal_distances_dup(new, old);
   if (err < 0)
     goto out_with_topology;
@@ -3830,6 +3837,10 @@ hwloc__topology_init (struct hwloc_topology **topologyp,
   topology->support.membind = hwloc_tma_malloc(tma, sizeof(*topology->support.membind));
   topology->support.misc = hwloc_tma_malloc(tma, sizeof(*topology->support.misc));
 
+  topology->infos.count = 0;
+  topology->infos.allocated = 0;
+  topology->infos.array = NULL;
+
   topology->nb_levels_allocated = nblevels; /* enough for default 10 levels = Mach+Pack+Die+NUMA+L3+L2+L1d+L1i+Co+PU */
   topology->levels = hwloc_tma_calloc(tma, topology->nb_levels_allocated * sizeof(*topology->levels));
   topology->level_nbobjects = hwloc_tma_calloc(tma, topology->nb_levels_allocated * sizeof(*topology->level_nbobjects));
@@ -4127,6 +4138,8 @@ hwloc_topology_destroy (struct hwloc_topology *topology)
 
   hwloc_topology_clear(topology);
 
+  hwloc__free_infos(&topology->infos);
+
   free(topology->levels);
   free(topology->level_nbobjects);
 
diff --git a/include/hwloc.h b/include/hwloc.h
@@ -1228,6 +1228,13 @@ enum hwloc_modify_infos_op_e {
 static __hwloc_inline int
 hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value);
 
+/** \brief Get the structure of info attributes attached to the topology.
+ *
+ * \note The function cannot return \c NULL.
+ * \note The returned pointer belongs to the hwloc library, it should not be freed or modified.
+ */
+HWLOC_DECLSPEC struct hwloc_infos_s * hwloc_topology_get_infos(hwloc_topology_t topology);
+
 /** @} */
 
 
diff --git a/include/hwloc/diff.h b/include/hwloc/diff.h
@@ -138,7 +138,7 @@ typedef union hwloc_topology_diff_u {
     hwloc_topology_diff_type_t type; /* must be ::HWLOC_TOPOLOGY_DIFF_OBJ_ATTR */
     union hwloc_topology_diff_u * next;
     /* List of attribute differences for a single object */
-    int obj_depth;
+    int obj_depth; /* topology depth if topology attribute instead of object attribute */
     unsigned obj_index;
     union hwloc_topology_diff_obj_attr_u diff;
   } obj_attr;
diff --git a/include/hwloc/rename.h b/include/hwloc/rename.h
@@ -224,6 +224,7 @@ extern "C" {
 #define HWLOC_MODIFY_INFOS_OP_ADD_UNIQUE HWLOC_NAME_CAPS(MODIFY_INFOS_OP_ADD_UNIQUE)
 #define HWLOC_MODIFY_INFOS_OP_REPLACE HWLOC_NAME_CAPS(MODIFY_INFOS_OP_REPLACE)
 #define HWLOC_MODIFY_INFOS_OP_REMOVE HWLOC_NAME_CAPS(MODIFY_INFOS_OP_REMOVE)
+#define hwloc_topology_get_infos HWLOC_NAME(topology_get_infos)
 
 #define HWLOC_CPUBIND_PROCESS HWLOC_NAME_CAPS(CPUBIND_PROCESS)
 #define HWLOC_CPUBIND_THREAD HWLOC_NAME_CAPS(CPUBIND_THREAD)
diff --git a/include/private/private.h b/include/private/private.h
@@ -145,6 +145,8 @@ struct hwloc_topology {
 
   struct hwloc_topology_support support;
 
+  struct hwloc_infos_s infos;
+
   void (*userdata_export_cb)(void *reserved, struct hwloc_topology *topology, struct hwloc_obj *obj);
   void (*userdata_import_cb)(struct hwloc_topology *topology, struct hwloc_obj *obj, const char *name, const void *buffer, size_t length);
   int userdata_not_decoded;
diff --git a/tests/hwloc/hwloc_topology_abi.c b/tests/hwloc/hwloc_topology_abi.c
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2017-2022 Inria.  All rights reserved.
+ * Copyright © 2017-2023 Inria.  All rights reserved.
  * See COPYING in top-level directory.
  */
 
@@ -60,13 +60,18 @@ int main(void)
     offset = offsetof(struct hwloc_topology, support);
     assert(offset == 656);
 
+    offset = offsetof(struct hwloc_topology, infos);
+    assert(offset == 688);
+    size = sizeof(struct hwloc_infos_s);
+    assert(size == 16);
+
     offset = offsetof(struct hwloc_topology, first_dist);
-    assert(offset == 712);
+    assert(offset == 728);
     size = sizeof(struct hwloc_internal_distances_s);
     assert(size == 88);
 
     offset = offsetof(struct hwloc_topology, memattrs);
-    assert(offset == 736);
+    assert(offset == 752);
     size = sizeof(struct hwloc_internal_memattr_s);
     assert(size == 32);
     size = sizeof(struct hwloc_internal_memattr_target_s);
@@ -77,12 +82,12 @@ int main(void)
     assert(size == 32);
 
     offset = offsetof(struct hwloc_topology, cpukinds);
-    assert(offset == 752);
+    assert(offset == 768);
     size = sizeof(struct hwloc_internal_cpukind_s);
     assert(size == 40);
 
     offset = offsetof(struct hwloc_topology, grouping_next_subkind);
-    assert(offset == 792);
+    assert(offset == 808);
 
     /* fields after this one aren't needed after discovery */
 
