[Bug 1956264] Re: Cannot set offload options to false

[Lukas Märdian]

** Description changed:

+ [Impact] 
+ In https://bugs.launchpad.net/netplan/+bug/1771740, the ability to set the offload options that are exposed by systemd.link was added. Unfortunately, the implementation only allows setting the offload options to true. Setting the options to false results in nothing being written to the generated .link file, because "false" is treated the same as "unset" by netplan.
+ 
+ [Test Plan]
+ In addition to runing & passing the full set of unit- and integration-tests
+ (that contains new tests to check for this new feature), as described in
+ https://wiki.ubuntu.com/NetplanUpdates we want to run the following commands
+ to make sure the link offload stanza is working properly:
+ 
+ $ cat /etc/netplan/test.yaml
+ network:
+   version: 2
+   ethernets:
+     eth1:
+       receive-checksum-offload: false
+       transmit-checksum-offload: false
+       tcp-segmentation-offload: false
+       tcp6-segmentation-offload: false
+       generic-segmentation-offload: false
+       generic-receive-offload: false
+       large-receive-offload: false
+ $ netplan apply
+ $ cat /run/systemd/network/10-netplan-eth1.link | grep Offload
+ => Make sure the *Offload settings are correctly set to "=false".
+ $ ethtool -k eth1
+ => Make sure the offloading options have been set to "off":
+ rx-checksumming: off
+ tx-checksumming: off
+ tcp-segmentation-offload: off
+ tx-tcp6-segmentation: off
+ generic-segmentation-offload: off
+ generic-receive-offload: off
+ large-receive-offload: off
+ 
+ autopkgtest logs:
+ * Jammy: TBD
+ * Impish: TBD
+ * Focal: TBD
+ 
+ [Where problems could occur]
+ 
+  * The settings exist since systemd-232 which means Bionic and up can use
+    this feature
+ 
+ This upload touches netplan's generator, if anything goes wrong it could impact
+ the rendering of network configuration and break a system's network connectivity
+ 
+ [Other Info]
+ The full set of autopkgtest logs will be attached after the upload is accepted
+ into -proposed and the tests have been run on the official autopkgtest.u.c
+ infrastructure.
+ 
+ === original description ===
+ 
  In https://bugs.launchpad.net/netplan/+bug/1771740, the ability to set
  the offload options that are exposed by systemd.link was added.
  Unfortunately, the implementation only allows setting the offload
  options to true. Setting the options to false results in nothing being
  written to the generated .link file, because "false" is treated the same
  as "unset" by netplan.
  
  See the current implementation
  https://git.launchpad.net/netplan/tree/src/networkd.c#n260.
  
  netplan needs to handle three different values for the offload options:
  "true", "false", and "unset"
  
  (I have a specific case in mind,
  https://bugzilla.kernel.org/show_bug.cgi?id=118721, where I need to set
  TSO to off when using the e1000e driver. The current netplan
  implementation does not support that; as a workaround I created a
  separate .link file in /etc/systemd/network to disable TSO.)

-- 
You received this bug notification because you are a member of Ubuntu
Sponsors Team, which is subscribed to the bug report.
https://bugs.launchpad.net/bugs/1956264

Title:
  Cannot set offload options to false

Status in netplan:
  Fix Committed
Status in netplan.io package in Ubuntu:
  Fix Released
Status in netplan.io source package in Focal:
  Confirmed
Status in netplan.io source package in Impish:
  Confirmed
Status in netplan.io source package in Jammy:
  In Progress
Status in netplan.io source package in Kinetic:
  Fix Released

Bug description:
  [Impact] 
  In https://bugs.launchpad.net/netplan/+bug/1771740, the ability to set the offload options that are exposed by systemd.link was added. Unfortunately, the implementation only allows setting the offload options to true. Setting the options to false results in nothing being written to the generated .link file, because "false" is treated the same as "unset" by netplan.

  [Test Plan]
  In addition to runing & passing the full set of unit- and integration-tests
  (that contains new tests to check for this new feature), as described in
  https://wiki.ubuntu.com/NetplanUpdates we want to run the following commands
  to make sure the link offload stanza is working properly:

  $ cat /etc/netplan/test.yaml
  network:
    version: 2
    ethernets:
      eth1:
        receive-checksum-offload: false
        transmit-checksum-offload: false
        tcp-segmentation-offload: false
        tcp6-segmentation-offload: false
        generic-segmentation-offload: false
        generic-receive-offload: false
        large-receive-offload: false
  $ netplan apply
  $ cat /run/systemd/network/10-netplan-eth1.link | grep Offload
  => Make sure the *Offload settings are correctly set to "=false".
  $ ethtool -k eth1
  => Make sure the offloading options have been set to "off":
  rx-checksumming: off
  tx-checksumming: off
  tcp-segmentation-offload: off
  tx-tcp6-segmentation: off
  generic-segmentation-offload: off
  generic-receive-offload: off
  large-receive-offload: off

  autopkgtest logs:
  * Jammy: TBD
  * Impish: TBD
  * Focal: TBD

  [Where problems could occur]

   * The settings exist since systemd-232 which means Bionic and up can use
     this feature

  This upload touches netplan's generator, if anything goes wrong it could impact
  the rendering of network configuration and break a system's network connectivity

  [Other Info]
  The full set of autopkgtest logs will be attached after the upload is accepted
  into -proposed and the tests have been run on the official autopkgtest.u.c
  infrastructure.

  === original description ===

  In https://bugs.launchpad.net/netplan/+bug/1771740, the ability to set
  the offload options that are exposed by systemd.link was added.
  Unfortunately, the implementation only allows setting the offload
  options to true. Setting the options to false results in nothing being
  written to the generated .link file, because "false" is treated the
  same as "unset" by netplan.

  See the current implementation
  https://git.launchpad.net/netplan/tree/src/networkd.c#n260.

  netplan needs to handle three different values for the offload
  options: "true", "false", and "unset"

  (I have a specific case in mind,
  https://bugzilla.kernel.org/show_bug.cgi?id=118721, where I need to
  set TSO to off when using the e1000e driver. The current netplan
  implementation does not support that; as a workaround I created a
  separate .link file in /etc/systemd/network to disable TSO.)

To manage notifications about this bug go to:
https://bugs.launchpad.net/netplan/+bug/1956264/+subscriptions