API: add hwloc_infos_s structure in objects

It contains the existing hwloc_info_s array and its length.

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

Author: bgoglin

NEWS

@@ -34,6 +34,8 @@ Version 3.0.0
     or "Memory" (for Linux DAX and CXL devices, etc).
   + The "Backend" info attribute of OS devices is now in the topology
     root object together with other backends.
+  + The array and count of info attributes are now embedded in the new
+    struct hwloc_infos_s.
 * Tools
   + lstopo has a new --osf option to tune the displaying of object
     attributes and units.

hwloc/diff.c

@@ -212,10 +212,10 @@ hwloc_diff_trees(hwloc_topology_t topo1, hwloc_obj_t obj1,
 	}
 
 	/* infos */
-	if (obj1->infos_count != obj2->infos_count)
+	if (obj1->infos.count != obj2->infos.count)
 		goto out_too_complex;
-	for(i=0; i<obj1->infos_count; i++) {
-		struct hwloc_info_s *info1 = &obj1->infos[i], *info2 = &obj2->infos[i];
+	for(i=0; i<obj1->infos.count; i++) {
+		struct hwloc_info_s *info1 = &obj1->infos.array[i], *info2 = &obj2->infos.array[i];
 		if (strcmp(info1->name, info2->name))
 			goto out_too_complex;
 		if (strcmp(info1->value, info2->value)) {
@@ -494,8 +494,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[i];
+			for(i=0; i<obj->infos.count; i++) {
+				struct hwloc_info_s *info = &obj->infos.array[i];
 				if (!strcmp(info->name, name)
 				    && !strcmp(info->value, oldvalue)) {
 					free(info->value);

hwloc/topology-linux.c

@@ -2163,7 +2163,7 @@ static int hwloc_linux_get_allowed_resources_hook(hwloc_topology_t topology)
 
   hwloc_linux__get_allowed_resources(topology, fsroot_path, root_fd, &cpuset_name);
   if (cpuset_name) {
-    hwloc__add_info_nodup(&topology->levels[0][0]->infos, &topology->levels[0][0]->infos_count,
+    hwloc__add_info_nodup(&topology->levels[0][0]->infos.array, &topology->levels[0][0]->infos.count,
 			  "LinuxCgroup", cpuset_name, 1 /* replace */);
     free(cpuset_name);
   }
@@ -4884,7 +4884,7 @@ look_sysfscpu(struct hwloc_topology *topology,
 	  if (cpuinfo_Lprocs) {
 	    for(j=0; j<(int) cpuinfo_numprocs; j++)
 	      if ((int) cpuinfo_Lprocs[j].Pproc == i) {
-		hwloc__move_infos(&package->infos, &package->infos_count,
+		hwloc__move_infos(&package->infos.array, &package->infos.count,
 				  &cpuinfo_Lprocs[j].infos, &cpuinfo_Lprocs[j].infos_count);
 	      }
 	  }
@@ -5825,7 +5825,7 @@ hwloc_linuxfs_look_cpu(struct hwloc_backend *backend, struct hwloc_disc_status *
     goto cpudone;
 
   /* setup root info */
-  hwloc__move_infos(&hwloc_get_root_obj(topology)->infos, &hwloc_get_root_obj(topology)->infos_count,
+  hwloc__move_infos(&hwloc_get_root_obj(topology)->infos.array, &hwloc_get_root_obj(topology)->infos.count,
 		    &global_infos, &global_infos_count);
 
   /* sysfs */
@@ -6986,7 +6986,7 @@ hwloc__get_firmware_dmi_memory_info_one(struct hwloc_topology *topology,
 
   misc->subtype = strdup("MemoryModule");
 
-  hwloc__move_infos(&misc->infos, &misc->infos_count, &infos, &infos_count);
+  hwloc__move_infos(&misc->infos.array, &misc->infos.count, &infos, &infos_count);
   /* FIXME: find a way to identify the corresponding NUMA node and attach these objects there.
    * but it means we need to parse DeviceLocation=DIMM_B4 but these vary significantly
    * with the vendor, and it's hard to be 100% sure 'B' is second socket.

hwloc/topology-x86.c

@@ -915,19 +915,19 @@ hwloc_x86_add_cpuinfos(hwloc_obj_t obj, struct procinfo *info, int replace)
 {
   char number[12];
   if (info->cpuvendor[0])
-    hwloc__add_info_nodup(&obj->infos, &obj->infos_count, "CPUVendor", info->cpuvendor, replace);
+    hwloc__add_info_nodup(&obj->infos.array, &obj->infos.count, "CPUVendor", info->cpuvendor, replace);
   snprintf(number, sizeof(number), "%u", info->cpufamilynumber);
-  hwloc__add_info_nodup(&obj->infos, &obj->infos_count, "CPUFamilyNumber", number, replace);
+  hwloc__add_info_nodup(&obj->infos.array, &obj->infos.count, "CPUFamilyNumber", number, replace);
   snprintf(number, sizeof(number), "%u", info->cpumodelnumber);
-  hwloc__add_info_nodup(&obj->infos, &obj->infos_count, "CPUModelNumber", number, replace);
+  hwloc__add_info_nodup(&obj->infos.array, &obj->infos.count, "CPUModelNumber", number, replace);
   if (info->cpumodel[0]) {
     const char *c = info->cpumodel;
     while (*c == ' ')
       c++;
-    hwloc__add_info_nodup(&obj->infos, &obj->infos_count, "CPUModel", c, replace);
+    hwloc__add_info_nodup(&obj->infos.array, &obj->infos.count, "CPUModel", c, replace);
   }
   snprintf(number, sizeof(number), "%u", info->cpustepping);
-  hwloc__add_info_nodup(&obj->infos, &obj->infos_count, "CPUStepping", number, replace);
+  hwloc__add_info_nodup(&obj->infos.array, &obj->infos.count, "CPUStepping", number, replace);
 }
 
 static void

hwloc/topology-xml.c

@@ -1832,19 +1832,19 @@ hwloc_look_xml(struct hwloc_backend *backend, struct hwloc_disc_status *dstatus)
   if (data->version_major <= 2) {
     unsigned i;
     /* check if root already has some backend info */
-    for(i=0; i<root->infos_count; i++)
-      if (!strcmp(root->infos[i].name, "Backend")) {
-        if (!strcmp(root->infos[i].value, "CUDA"))
+    for(i=0; i<root->infos.count; i++)
+      if (!strcmp(root->infos.array[i].name, "Backend")) {
+        if (!strcmp(root->infos.array[i].value, "CUDA"))
           data->need_cuda_backend_info = 0;
-        if (!strcmp(root->infos[i].value, "NVML"))
+        if (!strcmp(root->infos.array[i].value, "NVML"))
           data->need_nvml_backend_info = 0;
-        if (!strcmp(root->infos[i].value, "RSMI"))
+        if (!strcmp(root->infos.array[i].value, "RSMI"))
           data->need_rsmi_backend_info = 0;
-        if (!strcmp(root->infos[i].value, "LevelZero"))
+        if (!strcmp(root->infos.array[i].value, "LevelZero"))
           data->need_levelzero_backend_info = 0;
-        if (!strcmp(root->infos[i].value, "OpenCL"))
+        if (!strcmp(root->infos.array[i].value, "OpenCL"))
           data->need_opencl_backend_info = 0;
-        if (!strcmp(root->infos[i].value, "GL"))
+        if (!strcmp(root->infos.array[i].value, "GL"))
           data->need_gl_backend_info = 0;
       }
     /* add missing backend info */
@@ -2197,8 +2197,8 @@ hwloc__xml_export_object_contents (hwloc__xml_export_state_t state, hwloc_topolo
     break;
   }
 
-  for(i=0; i<obj->infos_count; i++)
-    hwloc__xml_export_info_attr(state, obj->infos[i].name, obj->infos[i].value);
+  for(i=0; i<obj->infos.count; i++)
+    hwloc__xml_export_info_attr(state, obj->infos.array[i].name, obj->infos.array[i].value);
 
   if (v2export && obj->type == HWLOC_OBJ_OS_DEVICE && obj->subtype && !hwloc_obj_get_info_by_name(obj, "Backend")) {
     /* v2 gpus had Backend inside the object itself */

hwloc/topology.c

@@ -566,7 +566,7 @@ int hwloc__move_infos(struct hwloc_info_s **dst_infosp, unsigned *dst_countp,
 
 int hwloc_obj_add_info(hwloc_obj_t obj, const char *name, const char *value)
 {
-  return hwloc__add_info(&obj->infos, &obj->infos_count, name, value);
+  return hwloc__add_info(&obj->infos.array, &obj->infos.count, name, value);
 }
 
 /* This function may be called with topology->tma set, it cannot free() or realloc() */
@@ -610,7 +610,7 @@ hwloc__free_object_contents(hwloc_obj_t obj)
   default:
     break;
   }
-  hwloc__free_infos(obj->infos, obj->infos_count);
+  hwloc__free_infos(obj->infos.array, obj->infos.count);
   free(obj->attr);
   free(obj->children);
   free(obj->subtype);
@@ -915,7 +915,7 @@ hwloc__duplicate_object(struct hwloc_topology *newtopology,
   newobj->nodeset = hwloc_bitmap_tma_dup(tma, src->nodeset);
   newobj->complete_nodeset = hwloc_bitmap_tma_dup(tma, src->complete_nodeset);
 
-  hwloc__tma_dup_infos(tma, &newobj->infos, &newobj->infos_count, src->infos, src->infos_count);
+  hwloc__tma_dup_infos(tma, &newobj->infos.array, &newobj->infos.count, src->infos.array, src->infos.count);
 
   /* find our level */
   if (src->depth < 0) {
@@ -1357,10 +1357,10 @@ merge_insert_equal(hwloc_obj_t new, hwloc_obj_t old)
   if (old->os_index == HWLOC_UNKNOWN_INDEX)
     old->os_index = new->os_index;
 
-  if (new->infos_count) {
+  if (new->infos.count) {
     /* FIXME: dedup */
-    hwloc__move_infos(&old->infos, &old->infos_count,
-		      &new->infos, &new->infos_count);
+    hwloc__move_infos(&old->infos.array, &old->infos.count,
+		      &new->infos.array, &new->infos.count);
   }
 
   if (new->name && !old->name) {

hwloc/traversal.c

@@ -705,8 +705,8 @@ hwloc_obj_attr_snprintf(char * __hwloc_restrict string, size_t size, hwloc_obj_t
   /* printf infos */
   if (verbose) {
     unsigned i;
-    for(i=0; i<obj->infos_count; i++) {
-      struct hwloc_info_s *info = &obj->infos[i];
+    for(i=0; i<obj->infos.count; i++) {
+      struct hwloc_info_s *info = &obj->infos.array[i];
       const char *quote;
       if (strchr(info->value, ' '))
         quote = "\"";

include/hwloc.h

@@ -416,6 +416,25 @@ HWLOC_DECLSPEC int hwloc_compare_types (hwloc_obj_type_t type1, hwloc_obj_type_t
 
 union hwloc_obj_attr_u;
 
+/** \brief Info attribute (name and value strings)
+ * \sa hwlocality_info_attr
+ */
+struct hwloc_info_s {
+  char *name;   /**< \brief Info name */
+  char *value;	/**< \brief Info value */
+};
+
+/** \brief Array of string info attributes (pairs of name and value).
+ *
+ * These structures may only be modified with hwloc_obj_add_info().
+ *
+ * \sa hwlocality_info_attr
+ */
+struct hwloc_infos_s {
+  struct hwloc_info_s *array;  /**< \brief Array of string pairs */
+  unsigned count;              /**< \brief Number of elements in the array. */
+};
+
 /** \brief Structure of a topology object
  *
  * Applications must not modify any field except \p hwloc_obj.userdata.
@@ -602,8 +621,7 @@ struct hwloc_obj {
                                           * \note Its value must not be changed, hwloc_bitmap_dup() must be used instead.
                                           */
 
-  struct hwloc_info_s *infos;		/**< \brief Array of info attributes (name and value strings). */
-  unsigned infos_count;			/**< \brief Size of infos array. */
+  struct hwloc_infos_s infos;           /**< \brief Array of info attributes (name and value strings). */
 
   /* misc */
   void *userdata;			/**< \brief Application-given private data pointer,
@@ -687,15 +705,6 @@ union hwloc_obj_attr_u {
   } osdev;
 };
 
-/** \brief Object info attribute (name and value strings)
- *
- * \sa hwlocality_info_attr
- */
-struct hwloc_info_s {
-  char *name;	/**< \brief Info name */
-  char *value;	/**< \brief Info value */
-};
-
 /** @} */
 
 

include/hwloc/inlines.h

@@ -1,6 +1,6 @@
 /*
  * Copyright © 2009 CNRS
- * Copyright © 2009-2018 Inria.  All rights reserved.
+ * Copyright © 2009-2022 Inria.  All rights reserved.
  * Copyright © 2009-2012 Université Bordeaux
  * Copyright © 2009-2010 Cisco Systems, Inc.  All rights reserved.
  * See COPYING in top-level directory.
@@ -111,8 +111,9 @@ static __hwloc_inline const char *
 hwloc_obj_get_info_by_name(hwloc_obj_t obj, const char *name)
 {
   unsigned i;
-  for(i=0; i<obj->infos_count; i++) {
-    struct hwloc_info_s *info = &obj->infos[i];
+  struct hwloc_infos_s *infos = &obj->infos;
+  for(i=0; i<obj->infos.count; i++) {
+    struct hwloc_info_s *info = &infos->array[i];
     if (!strcmp(info->name, name))
       return info->value;
   }

include/hwloc/rename.h

@@ -98,6 +98,7 @@ extern "C" {
 #define hwloc_obj_t HWLOC_NAME(obj_t)
 
 #define hwloc_info_s HWLOC_NAME(info_s)
+#define hwloc_infos_s HWLOC_NAME(infos_s)
 
 #define hwloc_obj_attr_u HWLOC_NAME(obj_attr_u)
 #define hwloc_numanode_attr_s HWLOC_NAME(numanode_attr_s)