Add AbstractTrees Interface

Project.toml

@@ -1,17 +1,19 @@
 name = "Hwloc"
 uuid = "0e44f5e4-bd66-52a0-8798-143a42290a1d"
 authors = ["Erik Schnetter <[email protected]>"]
-version = "3.0.0"
+version = "3.1.1"
 
 [deps]
+AbstractTrees = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"
 CEnum = "fa961155-64e5-5f13-b03f-caf6b980ea82"
 Hwloc_jll = "e33a78d0-f292-5ffc-b300-72abe9b543c8"
+Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
 Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
 
 [compat]
+CEnum = "0.4"
 Hwloc_jll = "2.8"
 julia = "1.6"
-CEnum = "0.4"
 
 [extras]
 CpuId = "adafc99b-e345-5852-983c-f28acb93d879"

src/Hwloc.jl

@@ -5,13 +5,16 @@ using Statistics
 import Base: show, IteratorSize, IteratorEltype, isempty, eltype, iterate
 
 include("libhwloc.jl")
+include("libhwloc_extensions.jl")
 include("lowlevel_api.jl")
 include("highlevel_api.jl")
+include("tree.jl")
 
 export topology, gettopology, topology_info, getinfo, print_topology, topology_graphical
 export num_physical_cores, num_virtual_cores, num_packages, num_numa_nodes
 export cachesize, cachelinesize
 export hwloc_typeof, hwloc_isa, collectobjects
+export HwlocTreeNode
 
 const machine_topology = Ref{Object}()
 

src/highlevel_api.jl

@@ -1,5 +1,8 @@
-using ..LibHwloc: hwloc_get_api_version
+using ..LibHwloc: hwloc_get_api_version, HWLOC_OBJ_BRIDGE_HOST,
+    HWLOC_OBJ_OSDEV_BLOCK, HWLOC_OBJ_OSDEV_GPU, HWLOC_OBJ_OSDEV_NETWORK,
+    HWLOC_OBJ_OSDEV_OPENFABRICS, HWLOC_OBJ_OSDEV_DMA, HWLOC_OBJ_OSDEV_COPROC
 
+using Printf
 
 """
 Returns the API version of libhwloc.
@@ -14,27 +17,102 @@ function get_api_version()
     VersionNumber(major, minor, patch)
 end
 
+const minimal_classes = [
+    "VGA", "NVMExp", "SATA", "Network", "Ethernet", "InfiniBand", "3D", "Other"
+]
+subtype_str(obj) = obj.subtype == "" ? "" : "($(obj.subtype))"
+
+function is_visible(obj::Object; minimal=true)
+    t = hwloc_typeof(obj)
+
+    if t == :Bridge
+        for child in obj.io_children
+            if is_visible(child)
+                return true
+            end
+        end
+        return false
+    end
+
+    if t == :PCI_Device
+        if minimal
+            class_string = hwloc_pci_class_string(obj.attr.class_id)
+            return class_string in minimal_classes
+        else
+            return true
+        end
+    end
+
+    return true
+end
+
 """
     print_topology([io::IO = stdout, obj::Object = gettopology()])
 
 Prints the topology of the given `obj` as a tree to `io`.
 """
-function print_topology(io::IO = stdout, obj::Object = gettopology(); indent = "", newline = false, prefix = "")
+function print_topology(
+        io::IO = stdout, obj::Object = gettopology();
+        indent = "", newline = false, prefix = "", minimal=true
+    )
     t = hwloc_typeof(obj)
+
     idxstr = t in (:Package, :Core, :PU) ? "L#$(obj.logical_index) P#$(obj.os_index) " : ""
     attrstr = string(obj.attr)
 
+    # this is set to false whenever minimal == true and the PCI class_id strings
+    # don't match the minimal_classes list
+    print_device = is_visible(obj; minimal=minimal)
+
     if t in (:L1Cache, :L2Cache, :L3Cache, :L1ICache)
         tstr = first(string(t), 2)
         attrstr = "("*_bytes2string(obj.attr.size)*")"
+    elseif t == :Bridge
+        if obj.attr.upstream_type == HWLOC_OBJ_BRIDGE_HOST
+            tstr    = "HostBridge"
+            attrstr = ""
+        else
+            tstr = "PCIBridge"
+            attrstr = ""
+        end
+    elseif t == :PCI_Device
+        class_string = hwloc_pci_class_string(obj.attr.class_id)
+        tstr    = "PCI"
+        attrstr = @sprintf(
+            "%s%02x:%02x.%01x",
+            Char(obj.attr.domain), obj.attr.bus, obj.attr.dev, obj.attr.func
+        ) * " ($(class_string))"
+    elseif t == :OS_Device
+        attrstr = "\"$(obj.name)\""
+        tstr = if obj.attr.type == HWLOC_OBJ_OSDEV_BLOCK
+            "Block$(subtype_str(obj))"
+        elseif obj.attr.type == HWLOC_OBJ_OSDEV_GPU
+            "GPU"
+        elseif obj.attr.type == HWLOC_OBJ_OSDEV_NETWORK
+            "Net"
+        elseif obj.attr.type == HWLOC_OBJ_OSDEV_OPENFABRICS
+            "OpenFabrics"
+        elseif obj.attr.type == HWLOC_OBJ_OSDEV_DMA
+            "DMA"
+        elseif obj.attr.type == HWLOC_OBJ_OSDEV_COPROC
+            "CoProc$(subtype_str(obj))"
+        else
+            string(obj.attr)
+        end
     else
         tstr = string(t)
+        attrstr = obj.name
     end
 
-    newline && print(io, "\n", indent)
-    print(io, prefix, tstr, " ",
-        idxstr,
-        attrstr, obj.mem > 0 ? "("*_bytes2string(obj.mem)*")" : "")
+    if print_device
+        newline && print(io, "\n", indent)
+        print(
+            io, prefix, tstr, " ", idxstr, attrstr,
+            obj.mem > 0 ? "("*_bytes2string(obj.mem)*")" : ""
+        )
+    else
+        return nothing
+    end
 
     for memchild in obj.memory_children
         memstr = "("*_bytes2string(memchild.mem)*")"
@@ -50,19 +128,27 @@ function print_topology(io::IO = stdout, obj::Object = gettopology(); indent = "
             print_topology(io, child; indent = indent*repeat(" ", 4), newline=true)
         end
     end
+
+    for child in obj.io_children
+        print_topology(io, child; indent=indent*repeat(" ", 4), newline=true)
+    end
+
     return nothing
 end
 print_topology(obj::Object) = print_topology(stdout, obj)
 
 """
 Returns the top-level system topology `Object`.
 
-On first call, it loads the topology by querying
-libhwloc and caches the result.
+On first call, it loads the topology by querying libhwloc and caches the result.
+Pass `reload=true` in order to force reload.
 """
-function gettopology()
-    if !isassigned(machine_topology)
-        machine_topology[] = topology_load()
+function gettopology(htopo=nothing; reload=false)
+    if reload || (!isassigned(machine_topology))
+        if isnothing(htopo)
+            htopo=topology_init()
+        end
+        machine_topology[] = topology_load(htopo)
     end
 
     return machine_topology[]
@@ -71,7 +157,7 @@ end
 """
 Prints the system topology as a tree.
 """
-topology() = print_topology(gettopology())
+topology(htopo=nothing) = print_topology(gettopology(htopo))
 
 """
 Prints a summary of the system topology (loosely similar to `hwloc-info`).
@@ -306,6 +392,6 @@ The quality of the result might depend on the used terminal and might vary betwe
 **Note:** The specific visualization may change between minor versions.
 """
 function topology_graphical()
-    run(`$(lstopo_no_graphics()) --no-io --no-legend --of txt`)
+    run(`$(lstopo_no_graphics()) --no-legend --of txt`)
     return nothing
 end

src/libhwloc.jl

@@ -235,6 +235,12 @@ const hwloc_nodeset_t = hwloc_bitmap_t
 
 const hwloc_const_nodeset_t = hwloc_const_bitmap_t
 
+# TODO: do we need this?
+# struct hwloc_obj_memory_page_type_s
+#     size::Culonglong
+#     count::Culonglong
+# end
+
 @cenum hwloc_obj_type_t::UInt32 begin
     HWLOC_OBJ_MACHINE = 0
     HWLOC_OBJ_PACKAGE = 1

src/libhwloc_extensions.jl

@@ -0,0 +1,17 @@
+module LibHwlocExtensions
+
+using ..LibHwloc: libhwloc, Hwloc_jll
+
+using CEnum
+
+function hwloc_pci_class_string(class_id)
+    val = ccall(
+        (:hwloc_pci_class_string, libhwloc),
+        Ptr{Cchar},
+        (Cushort,),
+        class_id
+    )
+    return unsafe_string(val)
+end
+
+end