man: Add fi_hmem_attr to fi_info

Signed-off-by: Jessie Yang <[email protected]>
jiaxiyan · Sep 11, 2024 · 64bdd1f · 64bdd1f
1 parent d4d82f4
commit 64bdd1f
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 0 deletions.
diff --git a/man/fabric.7.md b/man/fabric.7.md
@@ -447,6 +447,14 @@ attributes:
 *fi_domain_attr*
 : Added max_ep_auth_key
 
+## ABI 1.8
+ABI version starting with libfabric 2.0. Expanded the following structure.
+
+*fi_info*
+: The fi_info structure was expanded to reference a new fabric object,
+  fi_hmem_attr.  When available, the fi_hmem_attr references a new set of 
+  attributes related to heterogeneous memory.
+
 # SEE ALSO
 
 [`fi_info`(1)](fi_info.1.html),

diff --git a/man/fi_fabric.3.md b/man/fi_fabric.3.md
@@ -177,6 +177,9 @@ datatype or field value.
 *FI_TYPE_LOG_SUBSYS*
 : enum fi_log_subsys
 
+*FI_TYPE_HMEM_ATTR*
+: struct fi_hmem_attr
+
 fi_tostr() will return a pointer to an internal libfabric buffer that
 should not be modified, and will be overwritten the next time
 fi_tostr() is invoked.  fi_tostr() is not thread safe.

diff --git a/man/fi_getinfo.3.md b/man/fi_getinfo.3.md
@@ -142,6 +142,7 @@ struct fi_info {
 	struct fi_ep_attr     *ep_attr;
 	struct fi_domain_attr *domain_attr;
 	struct fi_fabric_attr *fabric_attr;
+	struct fi_hmem_attr   *hmem_attr;
 	struct fid_nic        *nic;
 };
 ```
@@ -242,6 +243,13 @@ struct fi_info {
   output, the actual fabric attributes that can be provided will be
   returned.  See [`fi_fabric`(3)](fi_fabric.3.html) for details.
 
+*hmem_attr - heterogeneous memory attributes*
+: Optionally supplied HMEM attributes.  HMEM attributes may be
+  specified and returned as part of fi_getinfo.  When provided as
+  hints, requested values of struct fi_hmem_attr should be set.  On
+  output, the actual HMEM attributes that can be provided will be
+  returned.
+
 *nic - network interface details*
 : Optional attributes related to the hardware NIC associated with
   the specified fabric, domain, and endpoint data.  This field is

diff --git a/man/fi_info.1.md b/man/fi_info.1.md
@@ -200,6 +200,11 @@ fi_info:
         prov_name: verbs;ofi_rxd
         prov_version: 116.0
         api_version: 1.16
+    fi_hmem_attr:
+        iface: FI_HMEM_SYSTEM
+        api_permitted: FI_HMEM_ATTR_ENABLED
+        use_p2p: FI_HMEM_ATTR_ENABLED
+        use_dev_reg_copy: FI_HMEM_ATTR_ENABLED
     nic:
         fi_device_attr:
             name: mlx5_0