UnboundLocalError: local variable 'version' referenced before assignment

[Seth Arnold]

[ Impact ]

 * The introduction of the -open NVIDIA drivers requires a change in the way we detect driver series and flavours. Failing to do so, causes the ubuntu-drivers tool to crash (LP: #1993019), or to prefer the -open drivers over the non-open ones (LP: #1988836).

 * Furthermore, calling the ubuntu-drivers tool where the alsa-utils package is not installed (mainly on servers), ubuntu-drivers (through the sl-modem plugin) complains, unnecessarily about the missing aplay binary.

[ Test Plan ]

 * Install the new ubuntu-drivers-common from -proposed on a system where the GPU is compatible with the 515 series (or higher).

 * Run the ubuntu-drivers list command, and make sure that the 515 driver series (or higher) is listed.

 * Try installing the driver using the following command:
   sudo ubuntu-drivers install

 * Check which driver series was installed (you can use the "sudo ubuntu-drivers debug" command), and make sure that the installation does not cause ubuntu-drivers to crash.

[ Where problems could occur ]

 * A problem in the ubuntu-drivers tool can cause it to install a driver which
   is not recommended for the detected hardware, or even cause the package
   installation to fail, and prevent users from logging in through the
   graphics interface.

[ Other Info ]

 * To prevent failures of the test-suite on architectures such as armhf (as seen
   in Lunar), we are skipping the tests for any architectures other than amd64
   and arm64 (which are the only ones actually using ubuntu-drivers).
   This was already the case with riscv, and we now have an easier way
   to do so in the debian/rules file.

== Changelogs ==

=== Kinetic and Jammy ===

  [ Alberto Milone ]
  * New upstream release:
  * UbuntuDrivers/detect.py:
    - Make sure all -open drivers have a lower priority, regardless
      of whether the --server parameter is passed in or not.
    - Update regex in nvidia_desktop_pre_installation_hook. This prevents
      ubuntu-drivers from crashing when dealing with the -open NVIDIA
      drivers (LP: #1993019).
  * tests/test_ubuntu_drivers.py:
    - Add tests so we make sure to keep preferring non-open NVIDIA
      modules over the -open ones, at least until the open modules catch up
      feature wise and performance wise.

  [ gongzhengyang ]
  * UbuntuDrivers/detect.py:
    - Fix local variable 'version' being referenced before assignment
      when catching ValueError (LP: #1993019).

  [ Jeff Lane ]
  * detect-plugins/sl-modem.py:
    - Add some error trapping when aplay is not installed (on servers).

=== Jammy only (left over from 1:0.9.6.2~0.22.04.1) ===

   * UbuntuDrivers/detect.py:
     - Make sure -open drivers have a lower priority (LP: #1988836).

== Changelogs ==

=== Kinetic and Jammy ===

  [ Alberto Milone ]
  * debian/rules:
    - Limit the tests to the selected architectures (amd64, arm64).
      This prevents armhf builds from failing.
  * UbuntuDrivers/detect.py:
    - Make sure all -open drivers have a lower priority, regardless
      of whether the --server parameter is passed in or not.
    - Update regex and unify package name parsing in the following
      functions by using the new NvidiaPkgNameInfo class:
      nvidia_desktop_pre_installation_hook,
      _get_headless_no_dkms_metapackage,
      nvidia_desktop_pre_installation_hook,
      get_linux_modules_metapackage,
      This prevents ubuntu-drivers from crashing when dealing with
      the -open NVIDIA drivers (LP: #1993019).
  * tests/test_ubuntu_drivers.py:
    - Add tests so we make sure to keep preferring non-open NVIDIA
      modules over the -open ones, at least until the open modules catch up
      feature wise and performance wise.

  [ gongzhengyang ]
  * UbuntuDrivers/detect.py:
    - Fix local variable 'version' being referenced before assignment
      when catching ValueError (LP: #1993019).

  [ Jeff Lane ]
  * detect-plugins/sl-modem.py:
    - Add some error trapping when aplay is not installed (on servers).

=== Jammy only (left over from 1:0.9.6.2~0.22.04.1) ===

   * UbuntuDrivers/detect.py:
     - Make sure -open drivers have a lower priority (LP: #1988836).

____
Hello, we received a drive-by complaint about the ubuntu-drivers autoinstall tool:

< Fhazal> hye i have problem with ubuntu 22.04 nvidia auto install command
< Fhazal> this error appear when i try to auto install recommended driver
< Fhazal> https://pastebin.com/ydZVFT24

The contents of the pastebin:

Traceback (most recent call last):
  File "/usr/bin/ubuntu-drivers", line 513, in <module>
    greet()
  File "/usr/lib/python3/dist-packages/click/core.py", line 1128, in __call__
    return self.main(*args, **kwargs)
  File "/usr/lib/python3/dist-packages/click/core.py", line 1053, in main
    rv = self.invoke(ctx)
  File "/usr/lib/python3/dist-packages/click/core.py", line 1659, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/usr/lib/python3/dist-packages/click/core.py", line 1395, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/usr/lib/python3/dist-packages/click/core.py", line 754, in invoke
    return __callback(*args, **kwargs)
  File "/usr/lib/python3/dist-packages/click/decorators.py", line 84, in new_func
    return ctx.invoke(f, obj, *args, **kwargs)
  File "/usr/lib/python3/dist-packages/click/core.py", line 754, in invoke
    return __callback(*args, **kwargs)
  File "/usr/bin/ubuntu-drivers", line 432, in autoinstall
    command_install(config)
  File "/usr/bin/ubuntu-drivers", line 187, in command_install
    UbuntuDrivers.detect.nvidia_desktop_pre_installation_hook(to_install)
  File "/usr/lib/python3/dist-packages/UbuntuDrivers/detect.py", line 839, in nvidia_desktop_pre_installation_hook
    with_nvidia_kms = version >= 470
UnboundLocalError: local variable 'version' referenced before assignment

Skimming the version on my system it sure feels plausible:

def nvidia_desktop_pre_installation_hook(to_install):
    '''Applies changes that need to happen before installing the NVIDIA drivers'''
    with_nvidia_kms = False

    # Enable KMS if nvidia >= 470
    for package_name in to_install:
        if package_name.startswith('nvidia-driver-'):
            try:
                version = int(package_name.split('-')[-1])
            except ValueError:
                pass
            finally:
                with_nvidia_kms = version >= 470

    if with_nvidia_kms:
        set_nvidia_kms(1)

If there was an exception splitting, indexing, or converting to an int, that 'version' variable may not have a value.

Thanks

[Onno (ostraaten)]

I saw the same issue. I performed fresh Ubuntu 22.04.1 install on Dell Precision 7540. First attempt I immediately installed proprietary drivers by enabling this third party option in install dialog. After this Software & Updates do not allow update. All options are greyed out and cannot be enabled. There is a message "This device is using a manually-installed driver"

Second attempt I installed without proprietary drivers / with third party disabled. After installation and reboot Software & Updates does allow me to select a proprietary driver. There is no longer a message "This device is using a manually-installed driver"

[Onno (ostraaten)]

See screenshot for message

[Weston Kelliher (westonkelliher)]

I also ran into this issue. In my case the package names were `nvidia-driver-515-open` and `nvidia-dkms-515-open` so I changed `version = int(package_name.split('-')[-1])` to `version = int(package_name.split('-')[2])` and that worked for me (`sudo ubuntu-drivers install` ran to completion). Not sure if that is a robust solution as I don't know how consistent the package names are. Also I'm new here.

[Launchpad Janitor (janitor)]

Status changed to 'Confirmed' because the bug affects multiple users.

[Vic Lim (limw0144)]

I confirmed @westonkelliher 's method and I have changed the python script with the file name '{usr-directory}/detect.py and it worked.

Thanks @westonkelliher !

# detect.py
def nvidia_desktop_pre_installation_hook(to_install):
    '''Applies changes that need to happen before installing the NVIDIA drivers'''
    with_nvidia_kms = False

    # Enable KMS if nvidia >= 470
    for package_name in to_install:
        if package_name.startswith('nvidia-driver-'):
            try:
                version = int(package_name.split('-')[-2]) #Line 839
            except ValueError:
                pass
            finally:
                with_nvidia_kms = version >= 470

    if with_nvidia_kms:
        set_nvidia_kms(1)

[Gustavo Canabrava (gustavocanabrava)]

Have the same problem using a Ideapad 3i. The solution provided by Weston Kelliher works, with a few start up problems, but all right now.

[SzySzySzy (elune90)]

What happened that it broken so many ppl things? wtf ubuntu
My gpu stopped detecting other two displays and one display has limited resolution. It was working!!! Stopped working few days ago
3080TI if that helps.. I think it's for nvidia only, but someone messed something pretty badly..

[D F (zanshin13)]

Also have this. Decided to update drivers after failure to run steam app. autoinstall fails

[Guilherme Alvarenga (guin0x)]

I have the same issue but I can't edit 'detect.py' as other people have suggested. It is a read-only file and I can't edit it. Any ideas how to do so? My issue is also that my second and third monitors are mostly black. Sometimes they work out of nowhere but then it goes out again.

[JK (m0d)]

I've just experienced the same issue, but with the ubuntu driver tool GUI (on Ubuntu 22.04).

I tried to change the NVIDIA drivers from 515 to 520-open. After asking for my password I got a pop-up with a big grey "X" and an "OK" button, but no text. Not helpful at all. Then I took a look at the installed "*nvidia*" packages with dpkg and noticed that all 515 packages had been removed but no 520 packages had been installed. When executing "ubuntu-drivers autoinstall" I got the same Python exception as above.

After that, I installed the 520 drivers with

"apt install nvidia-driver-520-open"

However, that didn't really work. After the reboot, I got a Kernel Oops:

[ 7.678638] NVRM: Open nvidia.ko is only ready for use on Data Center GPUs.
[ 7.678640] NVRM: To force use of Open nvidia.ko on other GPUs, see the
[ 7.678641] NVRM: 'OpenRmEnableUnsupportedGpus' kernel module parameter described
[ 7.678642] NVRM: in the README.
[ 7.680890] RTL8226B_RTL8221B 2.5Gbps PHY r8169-0-400:00: attached PHY driver (mii_bus:phy_addr=r8169-0-400:00, irq=MAC)
[ 8.243707] NVRM s_executeBooterUcode_TU102: Booter failed with non-zero error code: 0xa
[ 8.243709] NVRM kgspExecuteBooterUnloadIfNeeded_TU102: failed to execute Booter Unload: 0xffff
[ 8.243713] NVRM nvAssertFailedNoLog: Assertion failed: rmStatus == NV_OK @ osinit.c:1982
[ 8.244983] NVRM: GPU 0000:01:00.0: RmInitAdapter failed! (0x63:0x0:1900)
[ 8.245515] NVRM: GPU 0000:01:00.0: rm_init_adapter failed, device minor number 0
[ 8.245564] [drm:nv_drm_load [nvidia_drm]] *ERROR* [nvidia-drm] [GPU ID 0x00000100] Failed to allocate NvKmsKapiDevice
[ 8.245660] [drm:nv_drm_probe_devices [nvidia_drm]] *ERROR* [nvidia-drm] [GPU ID 0x00000100] Failed to register device
[ 8.245666] BUG: kernel NULL pointer dereference, address: 0000000000000040
[ 8.245709] #PF: supervisor read access in kernel mode
[ 8.245722] #PF: error_code(0x0000) - not-present page
[ 8.245733] PGD 0 P4D 0
[ 8.245739] Oops: 0000 [#1] SMP NOPTI

Now I'm not sure if this is a driver issue or due to the way it has been installed ("520-open" is the recommended driver, so I assume that it should work). Anyway, that bug in ubuntu-drivers is a serious issue and should be fixed as soon as possible...

Update: Fixed by "apt install nvidia-driver-520". It seems like the "520-open" driver does not really work with consumer GPUs (at least not with my RTX 3060 TI). But then why is it marked as "recommended" and "tested" in the ubuntu-drivers tool? That should probably also be fixed...

[Bill Gan (pblpbl)]

I have also encountered this issue

[Leonardo Veiga (leograba)]

I have nvidia-520 installed for a while. After noticing that the packages have been kept back (don't know why), I tried to upgrade the driver from the "Software and Updates" GUI. Not possible, all options grayed out and a message reads "This device is using a manually-installed driver".

Then I tried to "sudo ubuntu-drivers autoinstall", and got the error "UnboundLocalError: local variable 'version' referenced before assignment" and to this bug report.

[Gabriel Devenyi (ace-staticwave)]

The proposed change breaks extraction for drivers without -open.

A more appropriate fix is to regex extract the version number:
```
version = int(re.findall("[0-9]+", package_name)[0]
```

[Timo Aaltonen (tjaalton)]

Hello Seth, or anyone else affected,

Accepted ubuntu-drivers-common into kinetic-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/ubuntu-drivers-common/1:0.9.6.3.1 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-kinetic to verification-done-kinetic. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-kinetic. 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.

[Timo Aaltonen (tjaalton)]

Hello Seth, 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.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-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.

[Steve Langasek (vorlon)]

Hello Seth, or anyone else affected,

Accepted ubuntu-drivers-common into kinetic-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/ubuntu-drivers-common/1:0.9.6.3.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-kinetic to verification-done-kinetic. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-kinetic. 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.

[Steve Langasek (vorlon)]

Hello Seth, 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.3 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.

[Alberto Milone (albertomilone)]

The installation proceeded as expected in Kinetic.

:~$ apt-cache policy ubuntu-drivers-common
ubuntu-drivers-common:
  Installed: 1:0.9.6.3.2
  Candidate: 1:0.9.6.3.2
  Version table:
 *** 1:0.9.6.3.2 400
        400 http://archive.ubuntu.com/ubuntu kinetic-proposed/main amd64 Packages
        100 /var/lib/dpkg/status
     1:0.9.6.3 500
        500 http://it.archive.ubuntu.com/ubuntu kinetic/main amd64 Packages

You can see the attached output of "ubuntu-drivers debug"

[Alberto Milone (albertomilone)]

The installation proceeded as expected in Jammy.

:~$ apt-cache policy ubuntu-drivers-common
ubuntu-drivers-common:
  Installed: 1:0.9.6.2~0.22.04.3
  Candidate: 1:0.9.6.2~0.22.04.3
  Version table:
 *** 1:0.9.6.2~0.22.04.3 500
        500 http://archive.ubuntu.com/ubuntu jammy-proposed/main amd64 Packages
        100 /var/lib/dpkg/status
     1:0.9.6.1 500
        500 http://archive.ubuntu.com/ubuntu jammy/main amd64 Packages

You can see the attached output of "ubuntu-drivers debug"

[Alberto Milone (albertomilone)]

Note: neither in Jammy nor in Kinetic was the -open driver preferred over its non-open counterpart, which is one of the things that we want for this SRU.

[Launchpad Janitor (janitor)]

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

---------------
ubuntu-drivers-common (1:0.9.6.3.2) kinetic; urgency=medium

  * UbuntuDrivers/detect.py:
    - Fix "882:5 local variable 'with_nvidia_kms' is assigned to
      but never used" FTBFS (triggered by tests/test_static.py).

ubuntu-drivers-common (1:0.9.6.3.1) kinetic; urgency=medium

  [ Alberto Milone ]
  * debian/rules:
    - Limit the tests to the selected architectures (amd64, arm64).
      This prevents armhf builds from failing.
  * UbuntuDrivers/detect.py:
    - Make sure all -open drivers have a lower priority, regardless
      of whether the --server parameter is passed in or not.
    - Update regex and unify package name parsing in the following
      functions by using the new NvidiaPkgNameInfo class:
      nvidia_desktop_pre_installation_hook,
      _get_headless_no_dkms_metapackage,
      nvidia_desktop_pre_installation_hook,
      get_linux_modules_metapackage.
      This prevents ubuntu-drivers from crashing when dealing with
      the -open NVIDIA drivers (LP: #1993019).
  * tests/test_ubuntu_drivers.py:
    - Add tests so we make sure to keep preferring non-open NVIDIA
      modules over the -open ones, at least until the open modules catch up
      feature wise and performance wise.

  [ gongzhengyang ]
  * UbuntuDrivers/detect.py:
    - Fix local variable 'version' being referenced before assignment
      when catching ValueError (LP: #1993019).

  [ Jeff Lane ]
  * detect-plugins/sl-modem.py:
    - Add some error trapping when aplay is not installed (on servers)
      (LP: #1935070).

 -- Alberto Milone <email address hidden> Wed, 08 Mar 2023 15:57:25 +0000

[Brian Murray (brian-murray)]

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.