Add linting rules to spot use of un-wrapped netlink functions.

Spot netlink functions that may return EINTR because network configuration changed during a state dump, and point at the nlutil wrappers. Signed-off-by: Rob Murray <[email protected]>
aepifanov · Sep 15, 2024 · edaa0eb · edaa0eb
1 parent 00bf437
commit edaa0eb
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 11 deletions.
diff --git a/.golangci.yml b/.golangci.yml
@@ -37,6 +37,12 @@ linters-settings:
       - pkg: ^sync/atomic$
         p: ^atomic\.(Add|CompareAndSwap|Load|Store|Swap).
         msg: Go 1.19 atomic types should be used instead.
+      - pkg: github.com/vishvananda/netlink$
+        p: ^netlink\.(Handle\.)?(AddrList|BridgeVlanList|ChainList|ClassList|ConntrackTableList|ConntrackDeleteFilter$|ConntrackDeleteFilters|DevLinkGetDeviceList|DevLinkGetAllPortList|DevlinkGetDeviceParams|FilterList|FouList|GenlFamilyList|GTPPDPList|LinkByName|LinkByAlias|LinkList|LinkSubscribeWithOptions|NeighList$|NeighProxyList|NeighListExecute|NeighSubscribeWithOptions|LinkGetProtinfo|QdiscList|RdmaLinkList|RdmaLinkByName|RdmaLinkDel|RouteList|RouteListFilteredIter|RuleListFiltered$|RouteSubscribeWithOptions|RuleList$|RuleListFiltered|SocketGet|SocketDiagTCPInfo|SocketDiagTCP|SocketDiagUDPInfo|SocketDiagUDP|UnixSocketDiagInfo|UnixSocketDiag|VDPAGetDevConfigList|VDPAGetDevList|VDPAGetMGMTDevList|XfrmPolicyList|XfrmStateList)
+        msg: Use internal nlwrap package for EINTR handling.
+      - pkg: github.com/docker/docker/internal/nlwrap$
+        p: ^nlwrap.Handle.(BridgeVlanList|ChainList|ClassList|ConntrackDeleteFilter$|DevLinkGetDeviceList|DevLinkGetAllPortList|DevlinkGetDeviceParams|FilterList|FouList|GenlFamilyList|GTPPDPList|LinkByAlias|LinkSubscribeWithOptions|NeighList$|NeighProxyList|NeighListExecute|NeighSubscribeWithOptions|LinkGetProtinfo|QdiscList|RdmaLinkList|RdmaLinkByName|RdmaLinkDel|RouteListFilteredIter|RuleListFiltered$|RouteSubscribeWithOptions|RuleList$|RuleListFiltered|SocketGet|SocketDiagTCPInfo|SocketDiagTCP|SocketDiagUDPInfo|SocketDiagUDP|UnixSocketDiagInfo|UnixSocketDiag|VDPAGetDevConfigList|VDPAGetDevList|VDPAGetMGMTDevList)
+        msg: Add a wrapper to nlwrap.Handle for EINTR handling and update the list in .golangci.yml.
     analyze-types: true
   importas:
     # Do not allow unaliased imports of aliased packages.

diff --git a/internal/nlwrap/nlwrap_linux.go b/internal/nlwrap/nlwrap_linux.go
@@ -66,7 +66,7 @@ func retryOnIntr(f func() error) {
 // AddrList calls nlh.LinkList, retrying if necessary.
 func (nlh Handle) AddrList(link netlink.Link, family int) (addrs []netlink.Addr, err error) {
 	retryOnIntr(func() error {
-		addrs, err = nlh.Handle.AddrList(link, family)
+		addrs, err = nlh.Handle.AddrList(link, family) //nolint:forbidigo
 		return err
 	})
 	return addrs, err
@@ -75,7 +75,7 @@ func (nlh Handle) AddrList(link netlink.Link, family int) (addrs []netlink.Addr,
 // AddrList calls netlink.LinkList, retrying if necessary.
 func AddrList(link netlink.Link, family int) (addrs []netlink.Addr, err error) {
 	retryOnIntr(func() error {
-		addrs, err = netlink.AddrList(link, family)
+		addrs, err = netlink.AddrList(link, family) //nolint:forbidigo
 		return err
 	})
 	return addrs, err
@@ -88,7 +88,7 @@ func (nlh Handle) ConntrackDeleteFilters(
 	filters ...netlink.CustomConntrackFilter,
 ) (matched uint, err error) {
 	retryOnIntr(func() error {
-		matched, err = nlh.Handle.ConntrackDeleteFilters(table, family, filters...)
+		matched, err = nlh.Handle.ConntrackDeleteFilters(table, family, filters...) //nolint:forbidigo
 		return err
 	})
 	return matched, err
@@ -100,7 +100,7 @@ func ConntrackTableList(
 	family netlink.InetFamily,
 ) (flows []*netlink.ConntrackFlow, err error) {
 	retryOnIntr(func() error {
-		flows, err = netlink.ConntrackTableList(table, family)
+		flows, err = netlink.ConntrackTableList(table, family) //nolint:forbidigo
 		return err
 	})
 	return flows, err
@@ -111,7 +111,7 @@ func ConntrackTableList(
 // will do as a fallback and that dump may get inconsistent results.
 func (nlh Handle) LinkByName(name string) (link netlink.Link, err error) {
 	retryOnIntr(func() error {
-		link, err = nlh.Handle.LinkByName(name)
+		link, err = nlh.Handle.LinkByName(name) //nolint:forbidigo
 		return err
 	})
 	return link, err
@@ -122,7 +122,7 @@ func (nlh Handle) LinkByName(name string) (link netlink.Link, err error) {
 // kernel, it will do as a fallback and that dump may get inconsistent results.
 func LinkByName(name string) (link netlink.Link, err error) {
 	retryOnIntr(func() error {
-		link, err = netlink.LinkByName(name)
+		link, err = netlink.LinkByName(name) //nolint:forbidigo
 		return err
 	})
 	return link, err
@@ -131,7 +131,7 @@ func LinkByName(name string) (link netlink.Link, err error) {
 // LinkList calls nlh.LinkList, retrying if necessary.
 func (nlh Handle) LinkList() (links []netlink.Link, err error) {
 	retryOnIntr(func() error {
-		links, err = nlh.Handle.LinkList()
+		links, err = nlh.Handle.LinkList() //nolint:forbidigo
 		return err
 	})
 	return links, err
@@ -140,7 +140,7 @@ func (nlh Handle) LinkList() (links []netlink.Link, err error) {
 // LinkList calls netlink.LinkList, retrying if necessary.
 func LinkList() (links []netlink.Link, err error) {
 	retryOnIntr(func() error {
-		links, err = netlink.LinkList()
+		links, err = netlink.LinkList() //nolint:forbidigo
 		return err
 	})
 	return links, err
@@ -149,23 +149,23 @@ func LinkList() (links []netlink.Link, err error) {
 // RouteList calls nlh.RouteList, retrying if necessary.
 func (nlh Handle) RouteList(link netlink.Link, family int) (routes []netlink.Route, err error) {
 	retryOnIntr(func() error {
-		routes, err = nlh.Handle.RouteList(link, family)
+		routes, err = nlh.Handle.RouteList(link, family) //nolint:forbidigo
 		return err
 	})
 	return routes, err
 }
 
 func (nlh Handle) XfrmPolicyList(family int) (policies []netlink.XfrmPolicy, err error) {
 	retryOnIntr(func() error {
-		policies, err = nlh.Handle.XfrmPolicyList(family)
+		policies, err = nlh.Handle.XfrmPolicyList(family) //nolint:forbidigo
 		return err
 	})
 	return policies, err
 }
 
 func (nlh Handle) XfrmStateList(family int) (states []netlink.XfrmState, err error) {
 	retryOnIntr(func() error {
-		states, err = nlh.Handle.XfrmStateList(family)
+		states, err = nlh.Handle.XfrmStateList(family) //nolint:forbidigo
 		return err
 	})
 	return states, err