[SRU] Support to install nvidia driver by allowing list

build log

Feature Freeze Exceptions are for the development release of Ubuntu and only necessary after Feature Freeze which for the Lunar Lobster is February 23th. Is this feature change intended for Lunar?

@Brian, no, there was a misunderstanding, and this was not meant for Lunar. Please unsubscribe the Release team, as I can't seem to be able to do it.

The original schedule of this feature hopes could be in last year.
Unfortunately, I've no time to cook this in previous months.
This ticket should be converted to a SRU ticket now.

Sorry for the noise.

Add patch to support install nvidia driver by allowing list

The attachment "force_install_NVIDIA_driver-jammy.debdiff" seems to be a debdiff. The ubuntu-sponsors team has been subscribed to the bug report so that they can review and hopefully sponsor the debdiff. If the attachment isn't a patch, please remove the "patch" flag from the attachment, remove the "patch" tag, and if you are member of the ~ubuntu-sponsors, unsubscribe the team.

[This is an automated message performed by a Launchpad user owned by ~brian-murray, for any issue please contact him.]

@Dirk, are you sure you attached the right changeset? The patch is adding autopkgtest to the package. Also such changes should be submitted against the upstream project for review on https://github.com/tseliot/ubuntu-drivers-common/pulls

@seb128

the patches in the debdiff file picked from https://github.com/tseliot/ubuntu-drivers-common/commit/ec675fba22c68932da9fae95e0f4f2fd10732bf3, https://github.com/tseliot/ubuntu-drivers-common/commit/4776c6b9f78411ef3b269a28e9546e4ffd2b7115 and https://github.com/tseliot/ubuntu-drivers-common/commit/83528313da84b55c04daa62b5edcbf823e5c067b. The patches were merged in the Pull Request https://github.com/tseliot/ubuntu-drivers-common/pull/76 and related discussion was in https://github.com/tseliot/ubuntu-drivers-common/pull/71

Found that debdiff in #6 is buggy. Upload the modified debdiff

The issue is fixed in Lunar and newer so closing the main task. Technically we should SRU to kinetic before jammy but it's probably fine to skip that serie at this point

I've added the bug reference to the changelog which is required by the SRU process and uploaded now

Hi,

Thanks for your contribution. Since Kinetic is going to be skipped and the Jammy debdiff has been uploaded, I'm unsubscribing ubuntu-sponsors from this bug. Feel free to re-subscribe the team should the need arise.

Reading the description in the changelog did not tell me why this was appropriate for SRU.

+ - Add support for force installing the NVIDIA driver on unsupported
+ devices. (lp: #1990341)

You can obviously force install nvidia drivers on any device by using apt.

What this feature addition is actually about is allowing OEMs to locally extend the mapping of PCI IDs to drivers in a custom image. That's very different than what I understood from the changelog.

Changelog entries for SRUs are much more visible to users than changelog entries in devel, and while they will often be technical and not understood by all users, I think it's important that they at least be accurate.

I'm not rejecting this SRU, but I would like to see it reuploaded with a clearer changelog entry.

Based on the suggestion in #14, update the changelog to make the update more clearly for the use

  [ Jeremy Szu ]
  * README, README.md,
    UbuntuDrivers/detect.py,
    tests/test_ubuntu_drivers.py:
    - Let OEM image can locally extending the NVIDIA driver
      supported PCI IDs for cutting edge silicons by specifying
      related information in /etc/custom_supported_gpus.json file.
      (lp: #1990341)
    - Support autopkgtest for force install Nvidia and update
      related section in README.

Update debdiff based on the newly released ubuntu-drivers-common-0.9.6.2~0.22.04.4

There seem to be an unrelated change in the debdiff that are not mentioned in the changelog or in the bug, the _is_runtimepm_supported() rework to use apt_pkg.DepCache rather than the high-level apt API.

So I am unsubscribing ubuntu-sponsors as that needs more information.

Update changelog to document the apt_pkg.DepCache in _is_runtimepm_supported. Related discussion is at https://github.com/tseliot/ubuntu-drivers-common/pull/71/commits/025cce328b9909f3f421376be35cb34511b9ea2e#r884846872

  [ Jeremy Szu ]
  * README, README.md,
    UbuntuDrivers/detect.py,
    tests/test_ubuntu_drivers.py:
    - Let OEM image can locally extending the NVIDIA driver
      supported PCI IDs for cutting edge silicons by specifying
      related information in /etc/custom_supported_gpus.json file.
      (lp: #1990341)
    - Fix pkg.candidate.record retired from apt_pkg library
    - Support autopkgtest for force install Nvidia and update
      related section in README.

Hello Dirk,

I took the liberty to fix a nit in the changelog entry:

 18 [ Jeremy Szu ]
 19 * README, README.md,
 20 UbuntuDrivers/detect.py,
 21 tests/test_ubuntu_drivers.py:
 22 - Let OEM images locally extend the NVIDIA driver
 23 supported PCI IDs for cutting edge silicons by specifying
 24 related information in /etc/custom_supported_gpus.json file.
 25 (LP: #1990341)
 26 - Fix pkg.candidate.record retired from apt_pkg library
 27 - Support autopkgtest for force install Nvidia and update
 28 related section in README.

I changed the "- Let OEM..." sentence, and made sure that "LP" is uppercase.

Otherwise I believe everything has been properly addressed so I'm uploading this package:

$ dput ubuntu-drivers-common_0.9.6.2~0.22.04.5_source.changes
Trying to upload package to ubuntu
Checking signature on .changes
gpg: /home/sergio/work/ubuntu-drivers-common/ubuntu-drivers-common_0.9.6.2~0.22.04.5_source.changes: Valid signature from 106DA1C8C3CBBF14
Checking signature on .dsc
gpg: /home/sergio/work/ubuntu-drivers-common/ubuntu-drivers-common_0.9.6.2~0.22.04.5.dsc: Valid signature from 106DA1C8C3CBBF14
Uploading to ubuntu (via ftp to upload.ubuntu.com):
  Uploading ubuntu-drivers-common_0.9.6.2~0.22.04.5.dsc: done.
  Uploading ubuntu-drivers-common_0.9.6.2~0.22.04.5.tar.xz: done.
  Uploading ubuntu-drivers-common_0.9.6.2~0.22.04.5_source.buildinfo: done.
  Uploading ubuntu-drivers-common_0.9.6.2~0.22.04.5_source.changes: done.
Successfully uploaded packages.

I'm unsubscribing Ubuntu Sponsors.

Hello jeremyszu, or anyone else affected,

Accepted ubuntu-drivers-common into jammy-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/ubuntu-drivers-common/1:0.9.6.2~0.22.04.5 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed. Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested, what testing has been performed on the package and change the tag from verification-needed-jammy to verification-done-jammy. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-jammy. In either case, without details of your testing we will not be able to proceed.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance for helping!

N.B. The updated package will be released to -updates after the bug(s) fixed by this package have been verified and the package has been in -proposed for a minimum of 7 days.

Tested with Nvidia GPU 10de:2717. Disable restricted in jammy-updates and jammy-security, which make Nvidia 525 unavailable. Add /etc/customer_supported_gpus.json

{
  "chips": [
    {
      "devid": "0x2717",
      "name": "TEST 2717",
      "branch": "510.60",
      "feature": [
        "runtimepm"
      ]
    }
  ]
}

Type "ubuntu-driver list" in console did not show anything.

Upstream had fix the bug found in #22. Include the patch and generate debdiff again.

Hi Dirk,

Thanks for the revised patch. However, it needs to be based on top of the version currently in -proposed. The archive can't overwrite a version that's already published, which is basically whenever its sources hit the -proposed pocket (that happened when Steve accepted the SRU back in #21).

Unsubscribing ubuntu-sponsors, please resubscribe when you feel the patch is ready for review :)

Thank for the advice. Revised patch to generate 0.9.6.2~0.22.04.6

Upload the patch for lunar

The jammy debdiff in comment #25 was based on some local copy of ubuntu-drivers-common so contained a different changelog entry, than what is in -proposed, for version 1:0.9.6.2~0.22.04.5 with "Let OEM image can locally" vs "Let OEM image locally" and different date. Given that these two changes were trivial to fix up locally I've done just that.

I sponsored the changes for both Jammy and Lunar.

Hello jeremyszu, or anyone else affected,

Accepted ubuntu-drivers-common into lunar-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/ubuntu-drivers-common/1:0.9.7.1.2 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed. Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested, what testing has been performed on the package and change the tag from verification-needed-lunar to verification-done-lunar. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-lunar. In either case, without details of your testing we will not be able to proceed.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance for helping!

N.B. The updated package will be released to -updates after the bug(s) fixed by this package have been verified and the package has been in -proposed for a minimum of 7 days.

All autopkgtests for the newly accepted ubuntu-drivers-common (1:0.9.7.1.2) for lunar have finished running.
The following regressions have been reported in tests triggered by the package:

ubuntu-drivers-common/1:0.9.7.1.2 (ppc64el)

Please visit the excuses page listed below and investigate the failures, proceeding afterwards as per the StableReleaseUpdates policy regarding autopkgtest regressions [1].

https://people.canonical.com/~ubuntu-archive/proposed-migration/lunar/update_excuses.html#ubuntu-drivers-common

[1] https://wiki.ubuntu.com/StableReleaseUpdates#Autopkgtest_Regressions

Thank you!

Install lunar iso into Dell Precision 7680. Then install ubuntu-drivers-common 1:0.9.7.1.2 from proposed channel.

ubuntu@ubuntu-Precision-7680:~$ ubuntu-drivers list
ubuntu@ubuntu-Precision-7680:~$ sudo cp /tmp/custom_supported_gpus.json /etc
ubuntu@ubuntu-Precision-7680:~$ cat /etc/custom_supported_gpus.json
{
  "chips": [
    {
      "devid": "0x28B9",
      "name": "TEST 28B9",
      "branch": "535.113",
      "features": [
        "runtimepm"
      ]
    }
  ]
}
ubuntu@ubuntu-Precision-7680:~$ ubuntu-drivers list
nvidia-driver-535, (kernel modules provided by linux-modules-nvidia-535-generic-hwe-22.04)

System can use ubuntu-drivers to list package by adding customized JSON file. With command ubuntu-drivers install, Nvidia related packages can be added. After system reboot, Nvidia GPU work as expected.

Install jammy iso ubuntu-22.04.3-desktop-amd64.iso into Dell Precision 7680. Then install ubuntu-drivers-common 1:0.9.6.2~0.22.04.6 from proposed channel.

ubuntu@ubuntu-Precision-7680:~$ ubuntu-drivers list
ubuntu@ubuntu-Precision-7680:~$ sudo cp /tmp/custom_supported_gpus.json /etc
ubuntu@ubuntu-Precision-7680:~$ cat /etc/custom_supported_gpus.json
{
  "chips": [
    {
      "devid": "0x28B9",
      "name": "TEST 28B9",
      "branch": "535.113",
      "features": [
        "runtimepm"
      ]
    }
  ]
}
ubuntu@ubuntu-Precision-7680:~$ ubuntu-drivers list
nvidia-driver-535, (kernel modules provided by linux-modules-nvidia-535-generic-hwe-22.04)

System can use ubuntu-drivers to list package by adding customized JSON file. With command ubuntu-drivers install, Nvidia related packages can be added. After system reboot, Nvidia GPU work as expected.

https://launchpad.net/ubuntu/+source/ubuntu-drivers-common/1:0.9.6.2~0.22.04.6 in jammy-proposed has no closing bug, and the changes file should include version 22.04.5 too I believe. There is also a build failure for arm64 (due to a build-time test failing). I will retrigger it, but I'm thinking we need a new upload to fix the changes file at least, and perhaps the build failure if it persists.

The jammy build of 1:0.9.6.2~0.22.04.6 is still failing[1] in arm64 after a retry:

FAIL: test_system_driver_packages_force_install_nvidia (test_ubuntu_drivers.DetectTest)
system_driver_packages() force install config points to an older version.
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/usr/lib/python3.10/unittest/mock.py", line 1379, in patched
    return func(*newargs, **newkeywargs)
  File "/<<PKGBUILDDIR>>/tests/test_ubuntu_drivers.py", line 1495, in test_system_driver_packages_force_install_nvidia
    self.assertEqual(set(packages), set(['nvidia-driver-470']))
AssertionError: Items in the first set but not the second:
'nvidia-driver-510'
Items in the second set but not the first:
'nvidia-driver-470'

This bug was fixed in the package ubuntu-drivers-common - 1:0.9.7.1.2

---------------
ubuntu-drivers-common (1:0.9.7.1.2) lunar; urgency=medium

  * UbuntuDrivers/detect.py:
    - Skip modalias checking if id in force install list (LP: #1990341)

 -- Dirk Su <email address hidden> Thu, 31 Aug 2023 12:21:20 +0800

The verification of the Stable Release Update for ubuntu-drivers-common has completed successfully and the package is now being released to -updates. Subsequently, the Ubuntu Stable Release Updates Team is being unsubscribed and will not receive messages about this bug report. In the event that you encounter a regression using the package from -updates please report a new bug using ubuntu-bug and tag the bug report regression-update so we can easily find any regressions.

Reply to #34, I try to build 1:0.9.6.2~0.22.04.6 on my PPA (https://launchpad.net/~dirksu/+archive/ubuntu/ubuntu-drivers-common-build-test/+packages). And the package seems built successfully on arm64. Can you help to re-trigger the build for it?

It seems that it's already been retried once in the main archive. I note that your PPA builds *without* -proposed enabled, whereas the archive will build *with* -proposed enabled - possibly this is why it fails in the archive and succeeds in your PPA?

Thanks for the reply. I create another PPA (https://launchpad.net/~dirksu/+archive/ubuntu/ubuntu-drivers-common-build-with-proposed-test) which build with -proposed enabled. And ubuntu-drivers-common built successful on arm64.

OOoooh, right. This is releasable, and has a sensible changelog, it's just that LP isn't showing the full changes file.

This bug was fixed in the package ubuntu-drivers-common - 1:0.9.6.2~0.22.04.6

---------------
ubuntu-drivers-common (1:0.9.6.2~0.22.04.6) jammy; urgency=medium

  * UbuntuDrivers/detect.py:
    - Skip modalias checking if id in force install list

 -- Dirk Su <email address hidden> Fri, 15 Sep 2023 16:59:17 +0800