Open MPI logo

Portable Hardware Locality (hwloc) Documentation: v1.9

  |   Home   |   Support   |   FAQ   |  
helper.h
1 /*
2  * Copyright © 2009 CNRS
3  * Copyright © 2009-2014 Inria. All rights reserved.
4  * Copyright © 2009-2012 Université Bordeaux 1
5  * Copyright © 2009-2010 Cisco Systems, Inc. All rights reserved.
6  * See COPYING in top-level directory.
7  */
8 
13 #ifndef HWLOC_HELPER_H
14 #define HWLOC_HELPER_H
15 
16 #ifndef HWLOC_H
17 #error Please include the main hwloc.h instead
18 #endif
19 
20 #include <stdlib.h>
21 #include <errno.h>
22 
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 
44 static __hwloc_inline hwloc_obj_t
46 {
47  hwloc_obj_t obj = hwloc_get_root_obj(topology);
48  if (!obj->cpuset || !hwloc_bitmap_intersects(obj->cpuset, set))
49  return NULL;
50  while (!hwloc_bitmap_isincluded(obj->cpuset, set)) {
51  /* while the object intersects without being included, look at its children */
52  hwloc_obj_t child = obj->first_child;
53  while (child) {
54  if (child->cpuset && hwloc_bitmap_intersects(child->cpuset, set))
55  break;
56  child = child->next_sibling;
57  }
58  if (!child)
59  /* no child intersects, return their father */
60  return obj;
61  /* found one intersecting child, look at its children */
62  obj = child;
63  }
64  /* obj is included, return it */
65  return obj;
66 }
67 
76  hwloc_obj_t * __hwloc_restrict objs, int max);
77 
87 static __hwloc_inline hwloc_obj_t
89  unsigned depth, hwloc_obj_t prev)
90 {
91  hwloc_obj_t next = hwloc_get_next_obj_by_depth(topology, depth, prev);
92  if (!next || !next->cpuset)
93  return NULL;
94  while (next && !hwloc_bitmap_isincluded(next->cpuset, set))
95  next = next->next_cousin;
96  return next;
97 }
98 
108 static __hwloc_inline hwloc_obj_t
110  hwloc_obj_type_t type, hwloc_obj_t prev)
111 {
112  int depth = hwloc_get_type_depth(topology, type);
113  if (depth == HWLOC_TYPE_DEPTH_UNKNOWN || depth == HWLOC_TYPE_DEPTH_MULTIPLE)
114  return NULL;
115  return hwloc_get_next_obj_inside_cpuset_by_depth(topology, set, depth, prev);
116 }
117 
123 static __hwloc_inline hwloc_obj_t
125  unsigned depth, unsigned idx) __hwloc_attribute_pure;
126 static __hwloc_inline hwloc_obj_t
128  unsigned depth, unsigned idx)
129 {
130  hwloc_obj_t obj = hwloc_get_obj_by_depth (topology, depth, 0);
131  unsigned count = 0;
132  if (!obj || !obj->cpuset)
133  return NULL;
134  while (obj) {
135  if (hwloc_bitmap_isincluded(obj->cpuset, set)) {
136  if (count == idx)
137  return obj;
138  count++;
139  }
140  obj = obj->next_cousin;
141  }
142  return NULL;
143 }
144 
154 static __hwloc_inline hwloc_obj_t
156  hwloc_obj_type_t type, unsigned idx) __hwloc_attribute_pure;
157 static __hwloc_inline hwloc_obj_t
159  hwloc_obj_type_t type, unsigned idx)
160 {
161  int depth = hwloc_get_type_depth(topology, type);
162  if (depth == HWLOC_TYPE_DEPTH_UNKNOWN || depth == HWLOC_TYPE_DEPTH_MULTIPLE)
163  return NULL;
164  return hwloc_get_obj_inside_cpuset_by_depth(topology, set, depth, idx);
165 }
166 
172 static __hwloc_inline unsigned
174  unsigned depth) __hwloc_attribute_pure;
175 static __hwloc_inline unsigned
177  unsigned depth)
178 {
179  hwloc_obj_t obj = hwloc_get_obj_by_depth (topology, depth, 0);
180  unsigned count = 0;
181  if (!obj || !obj->cpuset)
182  return 0;
183  while (obj) {
184  if (hwloc_bitmap_isincluded(obj->cpuset, set))
185  count++;
186  obj = obj->next_cousin;
187  }
188  return count;
189 }
190 
200 static __hwloc_inline int
202  hwloc_obj_type_t type) __hwloc_attribute_pure;
203 static __hwloc_inline int
205  hwloc_obj_type_t type)
206 {
207  int depth = hwloc_get_type_depth(topology, type);
208  if (depth == HWLOC_TYPE_DEPTH_UNKNOWN)
209  return 0;
210  if (depth == HWLOC_TYPE_DEPTH_MULTIPLE)
211  return -1; /* FIXME: agregate nbobjs from different levels? */
212  return hwloc_get_nbobjs_inside_cpuset_by_depth(topology, set, depth);
213 }
214 
223 static __hwloc_inline int
224 hwloc_get_obj_index_inside_cpuset (hwloc_topology_t topology __hwloc_attribute_unused, hwloc_const_cpuset_t set,
225  hwloc_obj_t obj) __hwloc_attribute_pure;
226 static __hwloc_inline int
228  hwloc_obj_t obj)
229 {
230  int idx = 0;
231  if (!hwloc_bitmap_isincluded(obj->cpuset, set))
232  return -1;
233  /* count how many objects are inside the cpuset on the way from us to the beginning of the level */
234  while ((obj = obj->prev_cousin) != NULL)
235  if (hwloc_bitmap_isincluded(obj->cpuset, set))
236  idx++;
237  return idx;
238 }
239 
254 static __hwloc_inline hwloc_obj_t
255 hwloc_get_child_covering_cpuset (hwloc_topology_t topology __hwloc_attribute_unused, hwloc_const_cpuset_t set,
256  hwloc_obj_t parent) __hwloc_attribute_pure;
257 static __hwloc_inline hwloc_obj_t
259  hwloc_obj_t parent)
260 {
261  hwloc_obj_t child;
262  if (!parent->cpuset || hwloc_bitmap_iszero(set))
263  return NULL;
264  child = parent->first_child;
265  while (child) {
266  if (child->cpuset && hwloc_bitmap_isincluded(set, child->cpuset))
267  return child;
268  child = child->next_sibling;
269  }
270  return NULL;
271 }
272 
280 static __hwloc_inline hwloc_obj_t
281 hwloc_get_obj_covering_cpuset (hwloc_topology_t topology, hwloc_const_cpuset_t set) __hwloc_attribute_pure;
282 static __hwloc_inline hwloc_obj_t
284 {
285  struct hwloc_obj *current = hwloc_get_root_obj(topology);
286  if (hwloc_bitmap_iszero(set) || !current->cpuset || !hwloc_bitmap_isincluded(set, current->cpuset))
287  return NULL;
288  while (1) {
289  hwloc_obj_t child = hwloc_get_child_covering_cpuset(topology, set, current);
290  if (!child)
291  return current;
292  current = child;
293  }
294 }
295 
306 static __hwloc_inline hwloc_obj_t
308  unsigned depth, hwloc_obj_t prev)
309 {
310  hwloc_obj_t next = hwloc_get_next_obj_by_depth(topology, depth, prev);
311  if (!next || !next->cpuset)
312  return NULL;
313  while (next && !hwloc_bitmap_intersects(set, next->cpuset))
314  next = next->next_cousin;
315  return next;
316 }
317 
333 static __hwloc_inline hwloc_obj_t
336 {
337  int depth = hwloc_get_type_depth(topology, type);
338  if (depth == HWLOC_TYPE_DEPTH_UNKNOWN || depth == HWLOC_TYPE_DEPTH_MULTIPLE)
339  return NULL;
340  return hwloc_get_next_obj_covering_cpuset_by_depth(topology, set, depth, prev);
341 }
342 
357 static __hwloc_inline hwloc_obj_t
358 hwloc_get_ancestor_obj_by_depth (hwloc_topology_t topology __hwloc_attribute_unused, unsigned depth, hwloc_obj_t obj) __hwloc_attribute_pure;
359 static __hwloc_inline hwloc_obj_t
360 hwloc_get_ancestor_obj_by_depth (hwloc_topology_t topology __hwloc_attribute_unused, unsigned depth, hwloc_obj_t obj)
361 {
362  hwloc_obj_t ancestor = obj;
363  if (obj->depth < depth)
364  return NULL;
365  while (ancestor && ancestor->depth > depth)
366  ancestor = ancestor->parent;
367  return ancestor;
368 }
369 
371 static __hwloc_inline hwloc_obj_t
372 hwloc_get_ancestor_obj_by_type (hwloc_topology_t topology __hwloc_attribute_unused, hwloc_obj_type_t type, hwloc_obj_t obj) __hwloc_attribute_pure;
373 static __hwloc_inline hwloc_obj_t
375 {
376  hwloc_obj_t ancestor = obj->parent;
377  while (ancestor && ancestor->type != type)
378  ancestor = ancestor->parent;
379  return ancestor;
380 }
381 
383 static __hwloc_inline hwloc_obj_t
384 hwloc_get_common_ancestor_obj (hwloc_topology_t topology __hwloc_attribute_unused, hwloc_obj_t obj1, hwloc_obj_t obj2) __hwloc_attribute_pure;
385 static __hwloc_inline hwloc_obj_t
386 hwloc_get_common_ancestor_obj (hwloc_topology_t topology __hwloc_attribute_unused, hwloc_obj_t obj1, hwloc_obj_t obj2)
387 {
388  /* the loop isn't so easy since intermediate ancestors may have
389  * different depth, causing us to alternate between using obj1->parent
390  * and obj2->parent. Also, even if at some point we find ancestors of
391  * of the same depth, their ancestors may have different depth again.
392  */
393  while (obj1 != obj2) {
394  while (obj1->depth > obj2->depth)
395  obj1 = obj1->parent;
396  while (obj2->depth > obj1->depth)
397  obj2 = obj2->parent;
398  if (obj1 != obj2 && obj1->depth == obj2->depth) {
399  obj1 = obj1->parent;
400  obj2 = obj2->parent;
401  }
402  }
403  return obj1;
404 }
405 
410 static __hwloc_inline int
411 hwloc_obj_is_in_subtree (hwloc_topology_t topology __hwloc_attribute_unused, hwloc_obj_t obj, hwloc_obj_t subtree_root) __hwloc_attribute_pure;
412 static __hwloc_inline int
413 hwloc_obj_is_in_subtree (hwloc_topology_t topology __hwloc_attribute_unused, hwloc_obj_t obj, hwloc_obj_t subtree_root)
414 {
415  return hwloc_bitmap_isincluded(obj->cpuset, subtree_root->cpuset);
416 }
417 
422 static __hwloc_inline hwloc_obj_t
423 hwloc_get_next_child (hwloc_topology_t topology __hwloc_attribute_unused, hwloc_obj_t parent, hwloc_obj_t prev)
424 {
425  if (!prev)
426  return parent->first_child;
427  if (prev->parent != parent)
428  return NULL;
429  return prev->next_sibling;
430 }
431 
459 static __hwloc_inline int
461  unsigned cachelevel, hwloc_obj_cache_type_t cachetype)
462 {
463  int depth;
464  int found = HWLOC_TYPE_DEPTH_UNKNOWN;
465  for (depth=0; ; depth++) {
466  hwloc_obj_t obj = hwloc_get_obj_by_depth(topology, depth, 0);
467  if (!obj)
468  break;
469  if (obj->type != HWLOC_OBJ_CACHE || obj->attr->cache.depth != cachelevel)
470  /* doesn't match, try next depth */
471  continue;
472  if (cachetype == (hwloc_obj_cache_type_t) -1) {
473  if (found != HWLOC_TYPE_DEPTH_UNKNOWN) {
474  /* second match, return MULTIPLE */
476  }
477  /* first match, mark it as found */
478  found = depth;
479  continue;
480  }
481  if (obj->attr->cache.type == cachetype || obj->attr->cache.type == HWLOC_OBJ_CACHE_UNIFIED)
482  /* exact match (either unified is alone, or we match instruction or data), return immediately */
483  return depth;
484  }
485  /* went to the bottom, return what we found */
486  return found;
487 }
488 
496 static __hwloc_inline hwloc_obj_t
497 hwloc_get_cache_covering_cpuset (hwloc_topology_t topology, hwloc_const_cpuset_t set) __hwloc_attribute_pure;
498 static __hwloc_inline hwloc_obj_t
500 {
501  hwloc_obj_t current = hwloc_get_obj_covering_cpuset(topology, set);
502  while (current) {
503  if (current->type == HWLOC_OBJ_CACHE)
504  return current;
505  current = current->parent;
506  }
507  return NULL;
508 }
509 
514 static __hwloc_inline hwloc_obj_t
515 hwloc_get_shared_cache_covering_obj (hwloc_topology_t topology __hwloc_attribute_unused, hwloc_obj_t obj) __hwloc_attribute_pure;
516 static __hwloc_inline hwloc_obj_t
517 hwloc_get_shared_cache_covering_obj (hwloc_topology_t topology __hwloc_attribute_unused, hwloc_obj_t obj)
518 {
519  hwloc_obj_t current = obj->parent;
520  if (!obj->cpuset)
521  return NULL;
522  while (current && current->cpuset) {
523  if (!hwloc_bitmap_isequal(current->cpuset, obj->cpuset)
524  && current->type == HWLOC_OBJ_CACHE)
525  return current;
526  current = current->parent;
527  }
528  return NULL;
529 }
530 
552 static __hwloc_inline hwloc_obj_t
553 hwloc_get_pu_obj_by_os_index(hwloc_topology_t topology, unsigned os_index) __hwloc_attribute_pure;
554 static __hwloc_inline hwloc_obj_t
556 {
557  hwloc_obj_t obj = NULL;
558  while ((obj = hwloc_get_next_obj_by_type(topology, HWLOC_OBJ_PU, obj)) != NULL)
559  if (obj->os_index == os_index)
560  return obj;
561  return NULL;
562 }
563 
575 /* TODO: rather provide an iterator? Provide a way to know how much should be allocated? By returning the total number of objects instead? */
576 HWLOC_DECLSPEC unsigned hwloc_get_closest_objs (hwloc_topology_t topology, hwloc_obj_t src, hwloc_obj_t * __hwloc_restrict objs, unsigned max);
577 
590 static __hwloc_inline hwloc_obj_t
592  hwloc_obj_type_t type1, unsigned idx1,
593  hwloc_obj_type_t type2, unsigned idx2) __hwloc_attribute_pure;
594 static __hwloc_inline hwloc_obj_t
596  hwloc_obj_type_t type1, unsigned idx1,
597  hwloc_obj_type_t type2, unsigned idx2)
598 {
599  hwloc_obj_t obj;
600  obj = hwloc_get_obj_by_type (topology, type1, idx1);
601  if (!obj || !obj->cpuset)
602  return NULL;
603  return hwloc_get_obj_inside_cpuset_by_type(topology, obj->cpuset, type2, idx2);
604 }
605 
624 static __hwloc_inline hwloc_obj_t
625 hwloc_get_obj_below_array_by_type (hwloc_topology_t topology, int nr, hwloc_obj_type_t *typev, unsigned *idxv) __hwloc_attribute_pure;
626 static __hwloc_inline hwloc_obj_t
627 hwloc_get_obj_below_array_by_type (hwloc_topology_t topology, int nr, hwloc_obj_type_t *typev, unsigned *idxv)
628 {
629  hwloc_obj_t obj = hwloc_get_root_obj(topology);
630  int i;
631  for(i=0; i<nr; i++) {
632  if (!obj || !obj->cpuset)
633  return NULL;
634  obj = hwloc_get_obj_inside_cpuset_by_type(topology, obj->cpuset, typev[i], idxv[i]);
635  }
636  return obj;
637 }
638 
654 };
655 
679 static __hwloc_inline int
681  hwloc_obj_t *roots, unsigned n_roots,
682  hwloc_cpuset_t *set,
683  unsigned n,
684  unsigned until, unsigned long flags)
685 {
686  unsigned i;
687  unsigned tot_weight;
688  hwloc_cpuset_t *cpusetp = set;
689 
690  if (flags & ~HWLOC_DISTRIB_FLAG_REVERSE) {
691  errno = EINVAL;
692  return -1;
693  }
694 
695  tot_weight = 0;
696  for (i = 0; i < n_roots; i++)
697  if (roots[i]->cpuset)
698  tot_weight += hwloc_bitmap_weight(roots[i]->cpuset);
699 
700  for (i = 0; i < n_roots && tot_weight; i++) {
701  /* Give to roots[] a portion proportional to its weight */
702  hwloc_obj_t root = roots[flags & HWLOC_DISTRIB_FLAG_REVERSE ? n_roots-1-i : i];
703  unsigned weight = root->cpuset ? hwloc_bitmap_weight(root->cpuset) : 0;
704  unsigned chunk = (n * weight + tot_weight-1) / tot_weight;
705  if (!root->arity || chunk == 1 || root->depth >= until) {
706  /* Got to the bottom, we can't split any more, put everything there. */
707  unsigned j;
708  for (j=0; j<n; j++)
709  cpusetp[j] = hwloc_bitmap_dup(root->cpuset);
710  } else {
711  /* Still more to distribute, recurse into children */
712  hwloc_distrib(topology, root->children, root->arity, cpusetp, chunk, until, flags);
713  }
714  cpusetp += chunk;
715  tot_weight -= weight;
716  n -= chunk;
717  }
718 
719  return 0;
720 }
721 
738 static __hwloc_inline hwloc_const_cpuset_t
739 hwloc_topology_get_complete_cpuset(hwloc_topology_t topology) __hwloc_attribute_pure;
740 static __hwloc_inline hwloc_const_cpuset_t
742 {
743  return hwloc_get_root_obj(topology)->complete_cpuset;
744 }
745 
756 static __hwloc_inline hwloc_const_cpuset_t
757 hwloc_topology_get_topology_cpuset(hwloc_topology_t topology) __hwloc_attribute_pure;
758 static __hwloc_inline hwloc_const_cpuset_t
760 {
761  return hwloc_get_root_obj(topology)->cpuset;
762 }
763 
773 static __hwloc_inline hwloc_const_cpuset_t
774 hwloc_topology_get_online_cpuset(hwloc_topology_t topology) __hwloc_attribute_pure;
775 static __hwloc_inline hwloc_const_cpuset_t
777 {
778  return hwloc_get_root_obj(topology)->online_cpuset;
779 }
780 
790 static __hwloc_inline hwloc_const_cpuset_t
791 hwloc_topology_get_allowed_cpuset(hwloc_topology_t topology) __hwloc_attribute_pure;
792 static __hwloc_inline hwloc_const_cpuset_t
794 {
795  return hwloc_get_root_obj(topology)->allowed_cpuset;
796 }
797 
807 static __hwloc_inline hwloc_const_nodeset_t
808 hwloc_topology_get_complete_nodeset(hwloc_topology_t topology) __hwloc_attribute_pure;
809 static __hwloc_inline hwloc_const_nodeset_t
811 {
812  return hwloc_get_root_obj(topology)->complete_nodeset;
813 }
814 
825 static __hwloc_inline hwloc_const_nodeset_t
826 hwloc_topology_get_topology_nodeset(hwloc_topology_t topology) __hwloc_attribute_pure;
827 static __hwloc_inline hwloc_const_nodeset_t
829 {
830  return hwloc_get_root_obj(topology)->nodeset;
831 }
832 
842 static __hwloc_inline hwloc_const_nodeset_t
843 hwloc_topology_get_allowed_nodeset(hwloc_topology_t topology) __hwloc_attribute_pure;
844 static __hwloc_inline hwloc_const_nodeset_t
846 {
847  return hwloc_get_root_obj(topology)->allowed_nodeset;
848 }
849 
880 static __hwloc_inline void
882 {
883  int depth = hwloc_get_type_depth(topology, HWLOC_OBJ_NODE);
884  hwloc_obj_t obj;
885 
886  if (depth == HWLOC_TYPE_DEPTH_UNKNOWN) {
887  if (hwloc_bitmap_iszero(_cpuset))
888  hwloc_bitmap_zero(nodeset);
889  else
890  /* Assume the whole system */
891  hwloc_bitmap_fill(nodeset);
892  return;
893  }
894 
895  hwloc_bitmap_zero(nodeset);
896  obj = NULL;
897  while ((obj = hwloc_get_next_obj_covering_cpuset_by_depth(topology, _cpuset, depth, obj)) != NULL)
898  hwloc_bitmap_set(nodeset, obj->os_index);
899 }
900 
908 static __hwloc_inline void
910 {
911  int depth = hwloc_get_type_depth(topology, HWLOC_OBJ_NODE);
912  hwloc_obj_t obj;
913  if (depth == HWLOC_TYPE_DEPTH_UNKNOWN )
914  return;
915  hwloc_bitmap_zero(nodeset);
916  obj = NULL;
917  while ((obj = hwloc_get_next_obj_covering_cpuset_by_depth(topology, _cpuset, depth, obj)) != NULL)
918  hwloc_bitmap_set(nodeset, obj->os_index);
919 }
920 
929 static __hwloc_inline void
931 {
932  int depth = hwloc_get_type_depth(topology, HWLOC_OBJ_NODE);
933  hwloc_obj_t obj;
934 
935  if (depth == HWLOC_TYPE_DEPTH_UNKNOWN ) {
936  if (hwloc_bitmap_iszero(nodeset))
937  hwloc_bitmap_zero(_cpuset);
938  else
939  /* Assume the whole system */
940  hwloc_bitmap_fill(_cpuset);
941  return;
942  }
943 
944  hwloc_bitmap_zero(_cpuset);
945  obj = NULL;
946  while ((obj = hwloc_get_next_obj_by_depth(topology, depth, obj)) != NULL) {
947  if (hwloc_bitmap_isset(nodeset, obj->os_index))
948  /* no need to check obj->cpuset because objects in levels always have a cpuset */
949  hwloc_bitmap_or(_cpuset, _cpuset, obj->cpuset);
950  }
951 }
952 
960 static __hwloc_inline void
962 {
963  int depth = hwloc_get_type_depth(topology, HWLOC_OBJ_NODE);
964  hwloc_obj_t obj;
965  if (depth == HWLOC_TYPE_DEPTH_UNKNOWN )
966  return;
967  hwloc_bitmap_zero(_cpuset);
968  obj = NULL;
969  while ((obj = hwloc_get_next_obj_by_depth(topology, depth, obj)) != NULL)
970  if (hwloc_bitmap_isset(nodeset, obj->os_index))
971  /* no need to check obj->cpuset because objects in levels always have a cpuset */
972  hwloc_bitmap_or(_cpuset, _cpuset, obj->cpuset);
973 }
974 
1002 static __hwloc_inline const struct hwloc_distances_s *
1004 {
1005  hwloc_obj_t root = hwloc_get_root_obj(topology);
1006  unsigned i;
1007  for(i=0; i<root->distances_count; i++)
1008  if (root->distances[i]->relative_depth == depth)
1009  return root->distances[i];
1010  return NULL;
1011 }
1012 
1032 static __hwloc_inline const struct hwloc_distances_s *
1034 {
1035  int depth = hwloc_get_type_depth(topology, type);
1036  if (depth < 0)
1037  return NULL;
1038  return hwloc_get_whole_distance_matrix_by_depth(topology, depth);
1039 }
1040 
1054 static __hwloc_inline const struct hwloc_distances_s *
1056  hwloc_obj_t obj, unsigned depth,
1057  unsigned *firstp)
1058 {
1059  while (obj && obj->cpuset) {
1060  unsigned i;
1061  for(i=0; i<obj->distances_count; i++)
1062  if (obj->distances[i]->relative_depth == depth - obj->depth) {
1063  if (!obj->distances[i]->nbobjs)
1064  continue;
1065  *firstp = hwloc_get_next_obj_inside_cpuset_by_depth(topology, obj->cpuset, depth, NULL)->logical_index;
1066  return obj->distances[i];
1067  }
1068  obj = obj->parent;
1069  }
1070  return NULL;
1071 }
1072 
1084 static __hwloc_inline int
1086  hwloc_obj_t obj1, hwloc_obj_t obj2,
1087  float *latency, float *reverse_latency)
1088 {
1089  hwloc_obj_t ancestor;
1090  const struct hwloc_distances_s * distances;
1091  unsigned first_logical ;
1092 
1093  if (obj1->depth != obj2->depth) {
1094  errno = EINVAL;
1095  return -1;
1096  }
1097 
1098  ancestor = hwloc_get_common_ancestor_obj(topology, obj1, obj2);
1099  distances = hwloc_get_distance_matrix_covering_obj_by_depth(topology, ancestor, obj1->depth, &first_logical);
1100  if (distances && distances->latency) {
1101  const float * latency_matrix = distances->latency;
1102  unsigned nbobjs = distances->nbobjs;
1103  unsigned l1 = obj1->logical_index - first_logical;
1104  unsigned l2 = obj2->logical_index - first_logical;
1105  *latency = latency_matrix[l1*nbobjs+l2];
1106  *reverse_latency = latency_matrix[l2*nbobjs+l1];
1107  return 0;
1108  }
1109 
1110  errno = ENOSYS;
1111  return -1;
1112 }
1113 
1128 static __hwloc_inline hwloc_obj_t
1129 hwloc_get_non_io_ancestor_obj(hwloc_topology_t topology __hwloc_attribute_unused,
1130  hwloc_obj_t ioobj)
1131 {
1132  hwloc_obj_t obj = ioobj;
1133  while (obj && !obj->cpuset) {
1134  obj = obj->parent;
1135  }
1136  return obj;
1137 }
1138 
1143 static __hwloc_inline hwloc_obj_t
1145 {
1146  return hwloc_get_next_obj_by_type(topology, HWLOC_OBJ_PCI_DEVICE, prev);
1147 }
1148 
1152 static __hwloc_inline hwloc_obj_t
1154  unsigned domain, unsigned bus, unsigned dev, unsigned func)
1155 {
1156  hwloc_obj_t obj = NULL;
1157  while ((obj = hwloc_get_next_pcidev(topology, obj)) != NULL) {
1158  if (obj->attr->pcidev.domain == domain
1159  && obj->attr->pcidev.bus == bus
1160  && obj->attr->pcidev.dev == dev
1161  && obj->attr->pcidev.func == func)
1162  return obj;
1163  }
1164  return NULL;
1165 }
1166 
1170 static __hwloc_inline hwloc_obj_t
1172 {
1173  unsigned domain = 0; /* default */
1174  unsigned bus, dev, func;
1175 
1176  if (sscanf(busid, "%x:%x.%x", &bus, &dev, &func) != 3
1177  && sscanf(busid, "%x:%x:%x.%x", &domain, &bus, &dev, &func) != 4) {
1178  errno = EINVAL;
1179  return NULL;
1180  }
1181 
1182  return hwloc_get_pcidev_by_busid(topology, domain, bus, dev, func);
1183 }
1184 
1189 static __hwloc_inline hwloc_obj_t
1191 {
1192  return hwloc_get_next_obj_by_type(topology, HWLOC_OBJ_OS_DEVICE, prev);
1193 }
1194 
1199 static __hwloc_inline hwloc_obj_t
1201 {
1202  return hwloc_get_next_obj_by_type(topology, HWLOC_OBJ_BRIDGE, prev);
1203 }
1204 
1205 /* \brief Checks whether a given bridge covers a given PCI bus.
1206  */
1207 static __hwloc_inline int
1209  unsigned domain, unsigned bus)
1210 {
1211  return bridge->type == HWLOC_OBJ_BRIDGE
1213  && bridge->attr->bridge.downstream.pci.domain == domain
1214  && bridge->attr->bridge.downstream.pci.secondary_bus <= bus
1215  && bridge->attr->bridge.downstream.pci.subordinate_bus >= bus;
1216 }
1217 
1223 static __hwloc_inline hwloc_obj_t
1225  unsigned domain, unsigned bus)
1226 {
1227  hwloc_obj_t obj = NULL;
1228  while ((obj = hwloc_get_next_bridge(topology, obj)) != NULL) {
1229  if (hwloc_bridge_covers_pcibus(obj, domain, bus)) {
1230  /* found bridge covering this pcibus, make sure it's a hostbridge */
1232  assert(obj->parent->type != HWLOC_OBJ_BRIDGE);
1233  assert(obj->parent->cpuset);
1234  return obj;
1235  }
1236  }
1237  return NULL;
1238 }
1239 
1244 #ifdef __cplusplus
1245 } /* extern "C" */
1246 #endif
1247 
1248 
1249 #endif /* HWLOC_HELPER_H */
Structure of a topology object.
Definition: hwloc.h:331
static hwloc_obj_t hwloc_get_next_osdev(hwloc_topology_t topology, hwloc_obj_t prev)
Get the next OS device in the system.
Definition: helper.h:1190
unsigned arity
Number of children.
Definition: hwloc.h:363
static void hwloc_cpuset_from_nodeset_strict(struct hwloc_topology *topology, hwloc_cpuset_t _cpuset, hwloc_const_nodeset_t nodeset)
Convert a NUMA node set into a CPU set without handling non-NUMA cases.
Definition: helper.h:961
unsigned short domain
Definition: hwloc.h:496
Processing Unit, or (Logical) Processor. An execution unit (may share a core with some other logical ...
Definition: hwloc.h:187
static void hwloc_cpuset_from_nodeset(hwloc_topology_t topology, hwloc_cpuset_t _cpuset, hwloc_const_nodeset_t nodeset)
Convert a NUMA node set into a CPU set and handle non-NUMA cases.
Definition: helper.h:930
void hwloc_bitmap_set(hwloc_bitmap_t bitmap, unsigned id)
Add index id in bitmap bitmap.
hwloc_const_bitmap_t hwloc_const_cpuset_t
A non-modifiable hwloc_cpuset_t.
Definition: hwloc.h:118
hwloc_obj_type_t
Type of topology object.
Definition: hwloc.h:152
static hwloc_obj_t hwloc_get_obj_inside_cpuset_by_depth(hwloc_topology_t topology, hwloc_const_cpuset_t set, unsigned depth, unsigned idx)
Return the (logically) idx -th object at depth depth included in CPU set set.
Definition: helper.h:127
unsigned char dev
Definition: hwloc.h:497
static hwloc_obj_t hwloc_get_obj_inside_cpuset_by_type(hwloc_topology_t topology, hwloc_const_cpuset_t set, hwloc_obj_type_t type, unsigned idx)
Return the idx -th object of type type included in CPU set set.
Definition: helper.h:158
struct hwloc_obj * prev_cousin
Previous object of same type and depth.
Definition: hwloc.h:354
unsigned distances_count
Definition: hwloc.h:463
static hwloc_obj_t hwloc_get_first_largest_obj_inside_cpuset(hwloc_topology_t topology, hwloc_const_cpuset_t set)
Get the first largest object included in the given cpuset set.
Definition: helper.h:45
Distances between objects.
Definition: hwloc.h:538
static hwloc_obj_t hwloc_get_ancestor_obj_by_depth(hwloc_topology_t topology, unsigned depth, hwloc_obj_t obj)
Returns the ancestor object of obj at depth depth.
Definition: helper.h:360
struct hwloc_obj_attr_u::hwloc_cache_attr_s cache
static hwloc_obj_t hwloc_get_pcidev_by_busid(hwloc_topology_t topology, unsigned domain, unsigned bus, unsigned dev, unsigned func)
Find the PCI device object matching the PCI bus id given domain, bus device and function PCI bus id...
Definition: helper.h:1153
Operating system device. These objects have neither CPU sets nor node sets. They are not added to the...
Definition: hwloc.h:225
static int hwloc_get_cache_type_depth(hwloc_topology_t topology, unsigned cachelevel, hwloc_obj_cache_type_t cachetype)
Find the depth of cache objects matching cache depth and type.
Definition: helper.h:460
int hwloc_bitmap_weight(hwloc_const_bitmap_t bitmap)
Compute the "weight" of bitmap bitmap (i.e., number of indexes that are in the bitmap).
static int hwloc_get_obj_index_inside_cpuset(hwloc_topology_t topology, hwloc_const_cpuset_t set, hwloc_obj_t obj)
Return the logical index among the objects included in CPU set set.
Definition: helper.h:227
static hwloc_const_cpuset_t hwloc_topology_get_online_cpuset(hwloc_topology_t topology)
Get online CPU set.
Definition: helper.h:776
int hwloc_bitmap_iszero(hwloc_const_bitmap_t bitmap)
Test whether bitmap bitmap is empty.
static hwloc_obj_t hwloc_get_non_io_ancestor_obj(hwloc_topology_t topology, hwloc_obj_t ioobj)
Get the first non-I/O ancestor object.
Definition: helper.h:1129
static void hwloc_cpuset_to_nodeset_strict(struct hwloc_topology *topology, hwloc_const_cpuset_t _cpuset, hwloc_nodeset_t nodeset)
Convert a CPU set into a NUMA node set without handling non-NUMA cases.
Definition: helper.h:909
static const struct hwloc_distances_s * hwloc_get_whole_distance_matrix_by_type(hwloc_topology_t topology, hwloc_obj_type_t type)
Get the distances between all objects of a given type.
Definition: helper.h:1033
unsigned char func
Definition: hwloc.h:497
struct hwloc_obj_attr_u::hwloc_bridge_attr_s bridge
int hwloc_bitmap_isequal(hwloc_const_bitmap_t bitmap1, hwloc_const_bitmap_t bitmap2)
Test whether bitmap bitmap1 is equal to bitmap bitmap2.
static int hwloc_get_latency(hwloc_topology_t topology, hwloc_obj_t obj1, hwloc_obj_t obj2, float *latency, float *reverse_latency)
Get the latency in both directions between two objects.
Definition: helper.h:1085
static hwloc_obj_t hwloc_get_next_obj_inside_cpuset_by_depth(hwloc_topology_t topology, hwloc_const_cpuset_t set, unsigned depth, hwloc_obj_t prev)
Return the next object at depth depth included in CPU set set.
Definition: helper.h:88
struct hwloc_obj * parent
Parent, NULL if root (system object)
Definition: hwloc.h:357
static hwloc_const_cpuset_t hwloc_topology_get_allowed_cpuset(hwloc_topology_t topology)
Get allowed CPU set.
Definition: helper.h:793
hwloc_nodeset_t allowed_nodeset
The set of allowed NUMA memory nodes.
Definition: hwloc.h:449
static hwloc_obj_t hwloc_get_root_obj(hwloc_topology_t topology)
Returns the top-object of the topology-tree.
hwloc_distrib_flags_e
Flags to be given to hwloc_distrib().
Definition: helper.h:649
PCI-side of a bridge.
Definition: hwloc.h:254
static hwloc_obj_t hwloc_get_next_bridge(hwloc_topology_t topology, hwloc_obj_t prev)
Get the next bridge in the system.
Definition: helper.h:1200
unsigned logical_index
Horizontal index in the whole list of similar objects, could be a "cousin_rank" since it's the rank...
Definition: hwloc.h:348
unsigned depth
Vertical index in the hierarchy. If the topology is symmetric, this is equal to the parent depth plus...
Definition: hwloc.h:343
static hwloc_obj_t hwloc_get_pu_obj_by_os_index(hwloc_topology_t topology, unsigned os_index)
Returns the object of type HWLOC_OBJ_PU with os_index.
Definition: helper.h:555
int hwloc_bitmap_isset(hwloc_const_bitmap_t bitmap, unsigned id)
Test whether index id is part of bitmap bitmap.
void hwloc_bitmap_or(hwloc_bitmap_t res, hwloc_const_bitmap_t bitmap1, hwloc_const_bitmap_t bitmap2)
Or bitmaps bitmap1 and bitmap2 and store the result in bitmap res.
unsigned os_index
OS-provided physical index number.
Definition: hwloc.h:334
struct hwloc_distances_s ** distances
Distances between all objects at same depth below this object.
Definition: hwloc.h:462
hwloc_cpuset_t complete_cpuset
The complete CPU set of logical processors of this object,.
Definition: hwloc.h:388
static hwloc_obj_t hwloc_get_next_obj_covering_cpuset_by_depth(hwloc_topology_t topology, hwloc_const_cpuset_t set, unsigned depth, hwloc_obj_t prev)
Iterate through same-depth objects covering at least CPU set set.
Definition: helper.h:307
static hwloc_obj_t hwloc_get_cache_covering_cpuset(hwloc_topology_t topology, hwloc_const_cpuset_t set)
Get the first cache covering a cpuset set.
Definition: helper.h:499
void hwloc_bitmap_fill(hwloc_bitmap_t bitmap)
Fill bitmap bitmap with all possible indexes (even if those objects don't exist or are otherwise unav...
hwloc_bitmap_t hwloc_nodeset_t
A node set is a bitmap whose bits are set according to NUMA memory node physical OS indexes...
Definition: hwloc.h:133
Distrib in reverse order, starting from the last objects.
Definition: helper.h:653
Objects of given type exist at different depth in the topology.
Definition: hwloc.h:1080
static hwloc_obj_t hwloc_get_obj_covering_cpuset(hwloc_topology_t topology, hwloc_const_cpuset_t set)
Get the lowest object covering at least CPU set set.
Definition: helper.h:283
static const struct hwloc_distances_s * hwloc_get_whole_distance_matrix_by_depth(hwloc_topology_t topology, unsigned depth)
Get the distances between all objects at the given depth.
Definition: helper.h:1003
int hwloc_get_largest_objs_inside_cpuset(hwloc_topology_t topology, hwloc_const_cpuset_t set, hwloc_obj_t *restrict objs, int max)
Get the set of largest objects covering exactly a given cpuset set.
static hwloc_obj_t hwloc_get_next_obj_inside_cpuset_by_type(hwloc_topology_t topology, hwloc_const_cpuset_t set, hwloc_obj_type_t type, hwloc_obj_t prev)
Return the next object of type type included in CPU set set.
Definition: helper.h:109
hwloc_obj_cache_type_t type
Cache type.
Definition: hwloc.h:488
static hwloc_obj_t hwloc_get_common_ancestor_obj(hwloc_topology_t topology, hwloc_obj_t obj1, hwloc_obj_t obj2)
Returns the common parent object to objects lvl1 and lvl2.
Definition: helper.h:386
hwloc_obj_type_t type
Type of object.
Definition: hwloc.h:333
hwloc_nodeset_t complete_nodeset
The complete NUMA node set of this object,.
Definition: hwloc.h:435
static int hwloc_bridge_covers_pcibus(hwloc_obj_t bridge, unsigned domain, unsigned bus)
Definition: helper.h:1208
static hwloc_obj_t hwloc_get_child_covering_cpuset(hwloc_topology_t topology, hwloc_const_cpuset_t set, hwloc_obj_t parent)
Get the child covering at least CPU set set.
Definition: helper.h:258
hwloc_bitmap_t hwloc_cpuset_t
A CPU set is a bitmap whose bits are set according to CPU physical OS indexes.
Definition: hwloc.h:116
NUMA node. A set of processors around memory which the processors can directly access.
Definition: hwloc.h:172
enum hwloc_obj_cache_type_e hwloc_obj_cache_type_t
Cache type.
static hwloc_obj_t hwloc_get_pcidev_by_busidstring(hwloc_topology_t topology, const char *busid)
Find the PCI device object matching the PCI bus id given as a string xxxx:yy:zz.t or yy:zz...
Definition: helper.h:1171
struct hwloc_obj * next_sibling
Next object below the same parent.
Definition: hwloc.h:359
static hwloc_obj_t hwloc_get_next_obj_covering_cpuset_by_type(hwloc_topology_t topology, hwloc_const_cpuset_t set, hwloc_obj_type_t type, hwloc_obj_t prev)
Iterate through same-type objects covering at least CPU set set.
Definition: helper.h:334
void hwloc_bitmap_zero(hwloc_bitmap_t bitmap)
Empty the bitmap bitmap.
static hwloc_const_nodeset_t hwloc_topology_get_allowed_nodeset(hwloc_topology_t topology)
Get allowed node set.
Definition: helper.h:845
hwloc_nodeset_t nodeset
NUMA nodes covered by this object or containing this object.
Definition: hwloc.h:418
Host-side of a bridge, only possible upstream.
Definition: hwloc.h:253
static int hwloc_get_nbobjs_inside_cpuset_by_type(hwloc_topology_t topology, hwloc_const_cpuset_t set, hwloc_obj_type_t type)
Return the number of objects of type type included in CPU set set.
Definition: helper.h:204
hwloc_obj_bridge_type_t downstream_type
Definition: hwloc.h:515
union hwloc_obj_attr_u * attr
Object type-specific Attributes, may be NULL if no attribute value was found.
Definition: hwloc.h:339
static hwloc_obj_t hwloc_get_next_obj_by_depth(hwloc_topology_t topology, unsigned depth, hwloc_obj_t prev)
Returns the next object at depth depth.
hwloc_cpuset_t online_cpuset
The CPU set of online logical processors.
Definition: hwloc.h:399
static unsigned hwloc_get_nbobjs_inside_cpuset_by_depth(hwloc_topology_t topology, hwloc_const_cpuset_t set, unsigned depth)
Return the number of objects at depth depth included in CPU set set.
Definition: helper.h:176
unsigned depth
Depth of cache (e.g., L1, L2, ...etc.)
Definition: hwloc.h:484
struct hwloc_obj * first_child
First child.
Definition: hwloc.h:365
hwloc_const_bitmap_t hwloc_const_nodeset_t
A non-modifiable hwloc_nodeset_t.
Definition: hwloc.h:136
unsigned hwloc_get_closest_objs(hwloc_topology_t topology, hwloc_obj_t src, hwloc_obj_t *restrict objs, unsigned max)
Do a depth-first traversal of the topology to find and sort.
static hwloc_obj_t hwloc_get_shared_cache_covering_obj(hwloc_topology_t topology, hwloc_obj_t obj)
Get the first cache shared between an object and somebody else.
Definition: helper.h:517
float * latency
Matrix of latencies between objects, stored as a one-dimension array. May be NULL if the distances co...
Definition: hwloc.h:546
static hwloc_obj_t hwloc_get_next_child(hwloc_topology_t topology, hwloc_obj_t parent, hwloc_obj_t prev)
Return the next child.
Definition: helper.h:423
struct hwloc_obj_attr_u::hwloc_pcidev_attr_s pcidev
static hwloc_const_nodeset_t hwloc_topology_get_complete_nodeset(hwloc_topology_t topology)
Get complete node set.
Definition: helper.h:810
struct hwloc_obj * next_cousin
Next object of same type and depth.
Definition: hwloc.h:353
static int hwloc_obj_is_in_subtree(hwloc_topology_t topology, hwloc_obj_t obj, hwloc_obj_t subtree_root)
Returns true if obj is inside the subtree beginning with ancestor object subtree_root.
Definition: helper.h:413
PCI device. These objects have neither CPU sets nor node sets. They are not added to the topology unl...
Definition: hwloc.h:220
Cache. Can be L1i, L1d, L2, L3, ...
Definition: hwloc.h:180
static hwloc_obj_t hwloc_get_next_obj_by_type(hwloc_topology_t topology, hwloc_obj_type_t type, hwloc_obj_t prev)
Returns the next object of type type.
struct hwloc_pcidev_attr_s pci
Definition: hwloc.h:506
No object of given type exists in the topology.
Definition: hwloc.h:1079
unsigned char bus
Definition: hwloc.h:497
struct hwloc_obj ** children
Children, children[0 .. arity -1].
Definition: hwloc.h:364
Unified cache.
Definition: hwloc.h:245
static hwloc_const_nodeset_t hwloc_topology_get_topology_nodeset(hwloc_topology_t topology)
Get topology node set.
Definition: helper.h:828
static hwloc_obj_t hwloc_get_hostbridge_by_pcibus(hwloc_topology_t topology, unsigned domain, unsigned bus)
Find the hostbridge that covers the given PCI bus.
Definition: helper.h:1224
static hwloc_obj_t hwloc_get_next_pcidev(hwloc_topology_t topology, hwloc_obj_t prev)
Get the next PCI device in the system.
Definition: helper.h:1144
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:577
hwloc_cpuset_t allowed_cpuset
The CPU set of allowed logical processors.
Definition: hwloc.h:407
int hwloc_get_type_depth(hwloc_topology_t topology, hwloc_obj_type_t type)
Returns the depth of objects of type type.
static int hwloc_distrib(hwloc_topology_t topology, hwloc_obj_t *roots, unsigned n_roots, hwloc_cpuset_t *set, unsigned n, unsigned until, unsigned long flags)
Distribute n items over the topology under roots.
Definition: helper.h:680
hwloc_obj_t hwloc_get_obj_by_depth(hwloc_topology_t topology, unsigned depth, unsigned idx)
Returns the topology object at logical index idx from depth depth.
int hwloc_bitmap_isincluded(hwloc_const_bitmap_t sub_bitmap, hwloc_const_bitmap_t super_bitmap)
Test whether bitmap sub_bitmap is part of bitmap super_bitmap.
static void hwloc_cpuset_to_nodeset(hwloc_topology_t topology, hwloc_const_cpuset_t _cpuset, hwloc_nodeset_t nodeset)
Convert a CPU set into a NUMA node set and handle non-NUMA cases.
Definition: helper.h:881
static hwloc_obj_t hwloc_get_ancestor_obj_by_type(hwloc_topology_t topology, hwloc_obj_type_t type, hwloc_obj_t obj)
Returns the ancestor object of obj with type type.
Definition: helper.h:374
Bridge. Any bridge that connects the host or an I/O bus, to another I/O bus. Bridge objects have neit...
Definition: hwloc.h:213
hwloc_cpuset_t cpuset
CPUs covered by this object.
Definition: hwloc.h:375
static hwloc_const_cpuset_t hwloc_topology_get_topology_cpuset(hwloc_topology_t topology)
Get topology CPU set.
Definition: helper.h:759
static const struct hwloc_distances_s * hwloc_get_distance_matrix_covering_obj_by_depth(hwloc_topology_t topology, hwloc_obj_t obj, unsigned depth, unsigned *firstp)
Get distances for the given depth and covering some objects.
Definition: helper.h:1055
hwloc_bitmap_t hwloc_bitmap_dup(hwloc_const_bitmap_t bitmap)
Duplicate bitmap bitmap by allocating a new bitmap and copying bitmap contents.
static hwloc_obj_t hwloc_get_obj_below_by_type(hwloc_topology_t topology, hwloc_obj_type_t type1, unsigned idx1, hwloc_obj_type_t type2, unsigned idx2)
Find an object below another object, both specified by types and indexes.
Definition: helper.h:595
static hwloc_const_cpuset_t hwloc_topology_get_complete_cpuset(hwloc_topology_t topology)
Get complete CPU set.
Definition: helper.h:741
unsigned relative_depth
Relative depth of the considered objects below the object containing this distance information...
Definition: hwloc.h:539
unsigned nbobjs
Number of objects considered in the matrix. It is the number of descendant objects at relative_depth ...
Definition: hwloc.h:541
union hwloc_obj_attr_u::hwloc_bridge_attr_s::@1 downstream
static hwloc_obj_t hwloc_get_obj_by_type(hwloc_topology_t topology, hwloc_obj_type_t type, unsigned idx)
Returns the topology object at logical index idx with type type.
int hwloc_bitmap_intersects(hwloc_const_bitmap_t bitmap1, hwloc_const_bitmap_t bitmap2)
Test whether bitmaps bitmap1 and bitmap2 intersects.
static hwloc_obj_t hwloc_get_obj_below_array_by_type(hwloc_topology_t topology, int nr, hwloc_obj_type_t *typev, unsigned *idxv)
Find an object below a chain of objects specified by types and indexes.
Definition: helper.h:627
hwloc_obj_bridge_type_t upstream_type
Definition: hwloc.h:508