Merge ~paelzer/ubuntu/+source/ipxe:fix-lp1805920-vlan0-tag-stripping-cosmic into ubuntu/+source/ipxe:ubuntu/cosmic-devel

[Christian Ehrhardt ]

[Christian Ehrhardt  (paelzer)]

PPA: https://launchpad.net/~ci-train-ppa-service/+archive/ubuntu/3560

[Andreas Hasenack (ahasenack)]

I see the bug is still marked as incomplete, and pending a test case, but that doesn't block review.

The DEP3 header is lacking Last-Update, and maybe a link to the upstream commit? The centos commit hints that upstream sent a patch (or a patch was sent upstream), but it's the same person (Ladi?). The ubuntu bug says that upstream didn't "follow the suggestion", is there a link to some discussion, upstream bug, or mailing list post? The mailing list link in the centos patch has just one post, no thread that followed.

For the actual upload, I think only a test case is missing in the SRU template, if that's even doable. This may require a somewhat complex setup to test.

I'll mark as needs info just because of the questions above.

[Andreas Hasenack (ahasenack)]

review: Needs Information

[Christian Ehrhardt  (paelzer)]

It was not Nacked, the only follow up was http://lists.ipxe.org/pipermail/ipxe-devel/2016-August/005144.html later on.

I added the links, the date and a short statement about it to the header.
Pushing in a few minutes.

cc3c947... by Christian Ehrhardt  on 2018-12-14

d/p/0005-strip-802.1Q-VLAN-0-priority-tags.patch: improve dep8 header

Signed-off-by: Christian Ehrhardt <email address hidden>

[Andreas Hasenack (ahasenack)]

+1, but it's a dep3 header, not dep8 ;)

review: Approve

[Christian Ehrhardt  (paelzer)]

In SRU proposed

diff --git a/debian/changelog b/debian/changelog
index beee4bb..bfb5e6b 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,10 @@
+ipxe (1.0.0+git-20180124.fbe8c52d-0ubuntu4.1) cosmic; urgency=medium
+
+  * d/p/0005-strip-802.1Q-VLAN-0-priority-tags.patch: Strip 802.1Q VLAN 0
+    priority tags; Fixes PXE when VLAN tag is 0. (LP: #1805920)
+
+ -- Andres Rodriguez <[e-mail]>  Mon, 10 Dec 2018 16:26:42 -0500
+
 ipxe (1.0.0+git-20180124.fbe8c52d-0ubuntu4) cosmic; urgency=medium
 
   * Build ROMs for QEMU with CONFIG=qemu (LP: #1789319)
diff --git a/debian/patches/0005-strip-802.1Q-VLAN-0-priority-tags.patch b/debian/patches/0005-strip-802.1Q-VLAN-0-priority-tags.patch
new file mode 100644
index 0000000..b39fdc1
--- /dev/null
+++ b/debian/patches/0005-strip-802.1Q-VLAN-0-priority-tags.patch
@@ -0,0 +1,127 @@
+From: Ladi Prosek <[e-mail]>
+Subject: Strip 802.1Q VLAN 0 priority tags
+ iPXE was unable to receive priority tagged packets specified in
+ the 802.1Q standard and supported by all major networking stacks.
+ .
+ This commit adds a new function net_pull_tags which is called by
+ all consumers of incoming packets after stripping their link-layer
+ headers.
+ .
+ This was tried to be upstreamed in
+ http://lists.ipxe.org/pipermail/ipxe-devel/2016-July/005099.html but not
+ accepted by upstream (no Nack, just ignored).
+ .
+Origin: vendor, https://git.centos.org/blob/rpms!ipxe.git/c7/SOURCES!0009-Strip-802.1Q-VLAN-0-priority-tags.patch
+Bug-Ubuntu: https://bugs.launchpad.net/bugs/1805920
+Last-Update: 2018-12-14
+
+Index: ipxe-1.0.0+git-20180124.fbe8c52d/src/arch/x86/interface/pxe/pxe_undi.c
+===================================================================
+--- ipxe-1.0.0+git-20180124.fbe8c52d.orig/src/arch/x86/interface/pxe/pxe_undi.c	2018-11-30 22:42:34.000000000 -0500
++++ ipxe-1.0.0+git-20180124.fbe8c52d/src/arch/x86/interface/pxe/pxe_undi.c	2018-11-30 22:54:25.000000000 -0500
+@@ -976,6 +976,12 @@
+ 		}
+ 		ll_hlen = ( len - iob_len ( iobuf ) );
+ 
++		/* Strip link-layer-independent headers */
++		if ( ( rc = net_pull_tags ( iobuf, pxe_netdev, &net_proto ) ) != 0 ) {
++			/* Assume unknown net_proto */
++			net_proto = 0;
++		}
++
+ 		/* Determine network-layer protocol */
+ 		switch ( net_proto ) {
+ 		case htons ( ETH_P_IP ):
+Index: ipxe-1.0.0+git-20180124.fbe8c52d/src/include/ipxe/netdevice.h
+===================================================================
+--- ipxe-1.0.0+git-20180124.fbe8c52d.orig/src/include/ipxe/netdevice.h	2018-11-30 22:42:34.000000000 -0500
++++ ipxe-1.0.0+git-20180124.fbe8c52d/src/include/ipxe/netdevice.h	2018-11-30 22:54:25.000000000 -0500
+@@ -726,6 +726,8 @@
+ extern int net_rx ( struct io_buffer *iobuf, struct net_device *netdev,
+ 		    uint16_t net_proto, const void *ll_dest,
+ 		    const void *ll_source, unsigned int flags );
++extern int net_pull_tags ( struct io_buffer *iobuf, struct net_device *netdev,
++			   uint16_t *net_proto );
+ extern void net_poll ( void );
+ extern struct net_device_configurator *
+ find_netdev_configurator ( const char *name );
+Index: ipxe-1.0.0+git-20180124.fbe8c52d/src/interface/efi/efi_snp.c
+===================================================================
+--- ipxe-1.0.0+git-20180124.fbe8c52d.orig/src/interface/efi/efi_snp.c	2018-11-30 22:42:34.000000000 -0500
++++ ipxe-1.0.0+git-20180124.fbe8c52d/src/interface/efi/efi_snp.c	2018-11-30 22:54:25.000000000 -0500
+@@ -751,6 +751,13 @@
+ 		goto out_bad_ll_header;
+ 	}
+ 
++	/* Strip link-layer-independent headers */
++	if ( ( rc = net_pull_tags ( iobuf, snpdev->netdev, &iob_net_proto ) ) ) {
++		DBGC ( snpdev, "SNPDEV %p could not parse tags: %s\n",
++			snpdev, strerror ( rc ) );
++		goto out_bad_ll_header;
++	}
++
+ 	/* Return link-layer header parameters to caller, if required */
+ 	if ( ll_header_len )
+ 		*ll_header_len = ll_protocol->ll_header_len;
+Index: ipxe-1.0.0+git-20180124.fbe8c52d/src/net/netdevice.c
+===================================================================
+--- ipxe-1.0.0+git-20180124.fbe8c52d.orig/src/net/netdevice.c	2018-11-30 22:42:34.000000000 -0500
++++ ipxe-1.0.0+git-20180124.fbe8c52d/src/net/netdevice.c	2018-11-30 22:54:25.000000000 -0500
+@@ -1044,6 +1044,44 @@
+ }
+ 
+ /**
++ * Strip extra link-layer-independent tags from a received packet
++ *
++ * @v iobuf        I/O buffer
++ * @v netdev        Network device
++ * @v net_proto        Network-layer protocol, in network-byte order
++ * @ret rc        Return status code
++ *
++ * This function should be called after stripping link-layer headers but
++ * before inspecting the network-layer protocol.
++ */
++int net_pull_tags ( struct io_buffer *iobuf, struct net_device *netdev,
++            uint16_t *net_proto ) {
++    struct vlan_header *vlanhdr;
++    uint16_t tag;
++
++    /* Strip 802.1Q VLAN 0 priority tags if present */
++    while ( *net_proto == htons ( ETH_P_8021Q ) ) {
++        if ( iob_len ( iobuf ) < sizeof ( *vlanhdr ) ) {
++            DBG ( "VLAN header too short at %zd bytes (min %zd bytes)\n",
++                  iob_len ( iobuf ), sizeof ( *vlanhdr ) );
++            return -EINVAL;
++        }
++        vlanhdr = ( struct vlan_header * ) iobuf->data;
++        tag = VLAN_TAG ( ntohs ( vlanhdr->tci ) );
++
++        if ( tag == 0 && ! vlan_find ( netdev, tag ) ) {
++            /* VLAN 0, strip and continue */
++            *net_proto = vlanhdr->net_proto;
++            iob_pull ( iobuf, sizeof ( *vlanhdr ) );
++        } else {
++            /* Real VLAN tag, leave it alone */
++            break;
++        }
++    }
++    return 0;
++}
++
++/**
+  * Poll the network stack
+  *
+  * This polls all interfaces for received packets, and processes
+@@ -1093,6 +1131,12 @@
+ 				free_iob ( iobuf );
+ 				continue;
+ 			}
++
++			/* Remove link-layer-independent headers */
++			if ( ( rc = net_pull_tags ( iobuf, netdev, &net_proto ) ) ) {
++				free_iob ( iobuf );
++				continue;
++			}
+ 
+ 			/* Hand packet to network layer */
+ 			if ( ( rc = net_rx ( iob_disown ( iobuf ), netdev,
diff --git a/debian/patches/series b/debian/patches/series
index 6d8351b..db818d1 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -3,3 +3,4 @@ util-elf2efi-GNU_SOURCE.patch
 enable-https.patch
 handle-dhcp-nack.patch
 fix-elf2efi-plt-relocation.diff
+0005-strip-802.1Q-VLAN-0-priority-tags.patch