Skip to content

Update INSTALL dependencies #199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
derobins wants to merge 1 commit into
base: develop
Choose a base branch
from
+7 −3
Open

Update INSTALL dependencies #199

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ If CMake can't find hipcc/nvcc, you can set `-DCMAKE_HIP_COMPILER=<path>`

Supported platforms: Linux (Windows may be supported in a future release)
Copy link
Collaborator

@gaoikawa gaoikawa Mar 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you add something to the effect that in the linux kernel we require 'CONFIG_PCI_P2PDMA' to be enabled? On by default in Ubuntu 24.04 (is this true?), but not in 22.x? Can be done in Ubuntu22 via the hardware enablement kernel (hwe)? (Need to confirm.) Would be good if we could give some guidance on what has it enabled by default and what doesn't, and either a link to existing instructions for a few distros.

cc @jordan-turbofish


Supported filesystems: Only ext4 is supported at this time
Supported filesystems: Only ext4 and xfs are supported at this time

Targeting NVIDIA requires cuFile to be installed

Expand All @@ -94,8 +94,12 @@ sudo systemctl reboot

### Prerequisites

> [!NOTE]
> hipFile relies on the unreleased [ROCm 7.2](https://github.com/ROCm/TheRock) libraries and associated [amdgpu](https://github.com/ROCm/amdgpu) drivers. We will update the install instructions when these are released.
* CMake >= 3.21
* C++ >= 17 (tested w/ clang++ & g++, we don't use GNU extensions)
* ROCm >= 7.2
* amdgpu >= 30.10.1
Copy link

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The prerequisite amdgpu >= 30.10.1 is ambiguous (kernel module vs. the amdgpu-dkms/driver package) and doesn’t match the earlier wording that refers to amdgpu-dkms. Consider renaming this to the actual installable package/driver requirement (and, if relevant, noting how to check the version) so readers know what to install/verify.

Suggested change
* amdgpu >= 30.10.1
* amdgpu-dkms >= 30.10.1

Copilot uses AI. Check for mistakes.
Copy link
Collaborator

@riley-dixon riley-dixon Feb 27, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

30.20.1 should be the minimum version. (Also agree with copilot about specifying dkms).

Copy link
Collaborator Author

@derobins derobins Feb 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will fix

* Boost
* libmount
Comment on lines +101 to +102
Copy link

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the prerequisites list, Boost and libmount read like runtime packages, but building this project (and tests) needs the development headers/libraries (e.g., libmount-dev/libmount-devel and Boost program_options dev packages). Suggest clarifying that these are -dev/-devel dependencies (and optionally which Boost component is required) to prevent install/build failures.

Suggested change
* Boost
* libmount
* Boost development packages (including `program_options`; e.g. `libboost-program-options-dev` / `boost-devel`)
* libmount development packages (e.g. `libmount-dev` / `libmount-devel`)

Copilot uses AI. Check for mistakes.

### Configure

Expand Down