From 1bac654b2341d4bc8553efc1497089061ee305ff Mon Sep 17 00:00:00 2001 From: Rocco Meli Date: Thu, 21 Aug 2025 13:41:50 +0200 Subject: [PATCH 1/4] fi_info --- .../container-engine/resource-hook.md | 26 +++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/docs/software/container-engine/resource-hook.md b/docs/software/container-engine/resource-hook.md index 72707731..68bbe676 100644 --- a/docs/software/container-engine/resource-hook.md +++ b/docs/software/container-engine/resource-hook.md @@ -169,6 +169,32 @@ The hook is activated by setting the `com.hooks.cxi.enabled` annotation, which 4194304 23925.61 ``` +!!! tip "How to check if the CXI provider is working correctly" + + You can check if the CXI provider works correctly using the following command + (within the container): + + ```bash + fi_info -p cxi + ``` + + ??? example "CXI provider working" + ```console + $ fi_info -p cxi + provider: cxi + fabric: cxi + domain: cxi0 + version: 0.1 + type: FI_EP_RDM + protocol: FI_PROTO_CXI + ``` + + ??? example "CXI provider not working" + ```console + $ fi_info -p cxi + fi_getinfo: -61 (No data available) + ``` + [](){#ref-ce-aws-ofi-hook} ### AWS OFI NCCL hook  From b40340be5e78fe2330ceb988724501d175ca7ba5 Mon Sep 17 00:00:00 2001 From: Rocco Meli Date: Thu, 21 Aug 2025 13:57:19 +0200 Subject: [PATCH 2/4] update --- docs/software/container-engine/resource-hook.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/software/container-engine/resource-hook.md b/docs/software/container-engine/resource-hook.md index 68bbe676..ad006fcc 100644 --- a/docs/software/container-engine/resource-hook.md +++ b/docs/software/container-engine/resource-hook.md @@ -169,16 +169,16 @@ The hook is activated by setting the `com.hooks.cxi.enabled` annotation, which 4194304 23925.61 ``` -!!! tip "How to check if the CXI provider is working correctly" +!!! tip "How to check if the CXI provider is available" - You can check if the CXI provider works correctly using the following command + You can check if the CXI provider is available using the following command (within the container): ```bash fi_info -p cxi ``` - ??? example "CXI provider working" + ??? example "CXI provider available" ```console $ fi_info -p cxi provider: cxi @@ -189,7 +189,7 @@ The hook is activated by setting the `com.hooks.cxi.enabled` annotation, which protocol: FI_PROTO_CXI ``` - ??? example "CXI provider not working" + ??? example "CXI provider not available" ```console $ fi_info -p cxi fi_getinfo: -61 (No data available) From c7043846adcde6915b72babf85a90f3394b1496a Mon Sep 17 00:00:00 2001 From: Rocco Meli Date: Thu, 21 Aug 2025 13:57:57 +0200 Subject: [PATCH 3/4] update --- docs/software/container-engine/resource-hook.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/software/container-engine/resource-hook.md b/docs/software/container-engine/resource-hook.md index ad006fcc..0aee32f9 100644 --- a/docs/software/container-engine/resource-hook.md +++ b/docs/software/container-engine/resource-hook.md @@ -171,7 +171,7 @@ The hook is activated by setting the `com.hooks.cxi.enabled` annotation, which !!! tip "How to check if the CXI provider is available" - You can check if the CXI provider is available using the following command + You can check if the CXI provider is available using `fi_info` (within the container): ```bash From 5cc1bdce43076ac81ab2abf073abb11d70acd837 Mon Sep 17 00:00:00 2001 From: Rocco Meli Date: Thu, 21 Aug 2025 15:36:54 +0200 Subject: [PATCH 4/4] review --- docs/software/container-engine/resource-hook.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/software/container-engine/resource-hook.md b/docs/software/container-engine/resource-hook.md index 0aee32f9..bce9cc8d 100644 --- a/docs/software/container-engine/resource-hook.md +++ b/docs/software/container-engine/resource-hook.md @@ -169,16 +169,20 @@ The hook is activated by setting the `com.hooks.cxi.enabled` annotation, which 4194304 23925.61 ``` -!!! tip "How to check if the CXI provider is available" +!!! tip "How to check the CXI provider works inside a container" - You can check if the CXI provider is available using `fi_info` - (within the container): + You might want to check if the CXI provider works inside a container, + i.e. that the CXI hook has been correctly applied. + + You can check if the CXI provider is working using `fi_info`, + usually available alongside your `libfabric` installation, + within the container: ```bash fi_info -p cxi ``` - ??? example "CXI provider available" + ??? example "CXI provider is working" ```console $ fi_info -p cxi provider: cxi @@ -189,7 +193,7 @@ The hook is activated by setting the `com.hooks.cxi.enabled` annotation, which protocol: FI_PROTO_CXI ``` - ??? example "CXI provider not available" + ??? example "CXI provider not working" ```console $ fi_info -p cxi fi_getinfo: -61 (No data available)