graph: add shape files with patterns

Signed-off-by: vsoch <[email protected]>

Author: vsoch

README.md

@@ -75,6 +75,7 @@ fluxbind predict core:0-7
 fluxbind predict --xml ./examples/topology/corona.xml numa:0,1 x core:0-2
 ```
 
+
 ## License
 
 DevTools is distributed under the terms of the MIT license.

examples/shape-graph/affinity/cores-near-gpu/shape.yaml

@@ -0,0 +1,10 @@
+# Find the 8 cores that are physically closest to the first available GPU
+resources:
+  - type: machine
+    count: 1
+    with:
+      - type: core
+        count: 8
+        affinity:
+          type: gpu
+        pattern: packed

examples/shape-graph/affinity/cores-near-nic/shape.yaml

@@ -0,0 +1,12 @@
+# Find the 4 cores that are physically closest to the NIC
+resources:
+  - type: machine
+    count: 1
+    with:
+      - type: core
+        count: 4
+        # Sort all available cores by distance to the NIC...
+        affinity:
+          type: nic
+        # ...then take the first 4 (the closest ones).
+        pattern: packed

examples/shape-graph/affinity/gpu-and-nic-in-same-numa/shape.yaml

@@ -0,0 +1,12 @@
+# Find a NUMA node that contains a NIC, and then find a GPU
+# that is also under that *same* NUMA node. 
+resources:
+  - type: numanode
+    count: 1
+    with:
+      # This NUMA node MUST contain at least one NIC
+      - type: nic
+        count: 1
+      # It also MUST contain at least one GPU
+      - type: gpu
+        count: 1

examples/shape-graph/basic/4-cores-anywhere/shape.yaml

@@ -0,0 +1,8 @@
+# Simplest possible test: Allocate 4 cores anywhere on the node.
+# The allocator should succeed on almost any machine.
+resources:
+  - type: machine
+    count: 1
+    with:
+      - type: core
+        count: 4

examples/shape-graph/basic/8-cores-in-one-socket/shape.yaml

@@ -0,0 +1,9 @@
+# Basic containment: Allocate 8 cores, but ensure they all
+# come from the same single socket (Package).
+# This will fail on a machine where no single socket has 8 cores.
+resources:
+  - type: socket
+    count: 1
+    with:
+      - type: core
+        count: 8

examples/shape-graph/complex/gpu-compute-and-nic-comm/shape.yaml

@@ -0,0 +1,28 @@
+# Single-rank application with complex needs.
+# The rank needs:
+#   1. A GPU
+#   2. Four cores that are as close as possible to THAT GPU
+#   3. One separate core that is as close as possible to the NIC
+resources:
+  # First, find one NUMA node that contains at least one GPU.
+  - type: numanode
+    count: 1
+    with:
+      - type: gpu
+        count: 1
+        # Within this NUMA node, find 4 cores close to the GPU we just found.
+        with:
+          - type: core
+            count: 4
+            affinity:
+              type: gpu
+            pattern: packed
+  
+  # Separately, find one core anywhere on the machine that is close to the NIC.
+  - type: machine
+    count: 1
+    with:
+      - type: core
+        count: 1
+        affinity:
+          type: nic

examples/shape-graph/multi-rank/4-ranks-16-cores/shape.yaml

@@ -0,0 +1,11 @@
+#
+# A job to be partitioned across 4 ranks.
+# This requests a total of 16 cores. When run with --local-size=4,
+# each of the 4 ranks should be assigned a unique slice of 4 cores.
+#
+resources:
+  - type: machine
+    count: 1
+    with:
+      - type: core
+        count: 16

examples/shape-graph/multi-rank/4-ranks-4-gpus-near-nic/shape.yaml

@@ -0,0 +1,16 @@
+# A complex multi-rank job for 4 ranks.
+# The total allocation asks for 4 GPUs and 16 cores.
+# The affinity key sorts the GPUs by closeness to the NIC before partitioning.
+# When run with --local-size=4, each rank will get 1 GPU and 4 cores.
+resources:
+  - type: machine
+    count: 1
+    with:
+      - type: gpu
+        count: 4
+        affinity:
+          type: nic
+      - type: core
+        count: 16
+        affinity:
+          type: nic

examples/shape-graph/patterns/local-cores/shape.yaml

@@ -0,0 +1,10 @@
+# Test local pattern (smart packing).
+# Requests 4 cores within a single socket, packed into the fewest
+# number of L3 caches possible.
+resources:
+  - type: socket
+    count: 1
+    with:
+      - type: core
+        count: 4
+        pattern: local