From 69113f0235c66ddcdaef1e20e8678fded80aff44 Mon Sep 17 00:00:00 2001 From: "f.setrakov" Date: Fri, 19 Sep 2025 18:41:57 +0300 Subject: [PATCH] aghnet: fix docs, fix format --- internal/aghnet/dhcp_unix.go | 19 ++++++++++--------- internal/aghnet/interfaces.go | 9 ++++----- internal/aghnet/net.go | 4 ++-- 3 files changed, 16 insertions(+), 16 deletions(-) diff --git a/internal/aghnet/dhcp_unix.go b/internal/aghnet/dhcp_unix.go index df457969..7efb2a54 100644 --- a/internal/aghnet/dhcp_unix.go +++ b/internal/aghnet/dhcp_unix.go @@ -39,6 +39,7 @@ func checkOtherDHCP(ifaceName string) (ok4, ok6 bool, err4, err6 error) { } // ifaceIPv4Subnet returns the first suitable IPv4 subnetwork iface has. +// iface must not be nil func ifaceIPv4Subnet(iface *net.Interface) (subnet netip.Prefix, err error) { var addrs []net.Addr if addrs, err = iface.Addrs(); err != nil { @@ -91,7 +92,7 @@ func checkOtherDHCPv4(iface *net.Interface) (ok bool, err error) { } // discover4 sends a DHCPv4 discovery to the specified network interface and -// waits for response. iface and dstAddr must not be nil. +// waits for response. iface and dstAddr must not be nil. func discover4(iface *net.Interface, dstAddr *net.UDPAddr, hostname string) (ok bool, err error) { var req *dhcpv4.DHCPv4 if req, err = dhcpv4.NewDiscovery(iface.HardwareAddr); err != nil { @@ -138,13 +139,13 @@ func discover4(iface *net.Interface, dstAddr *net.UDPAddr, hostname string) (ok // getDHCP4Response reads and validates DHCP response from [net.PacketConn]. // req, c and iface must not be nil. -func getDHCP4Response(req *dhcpv4.DHCPv4, c net.PacketConn, iface *net.Interface) (ok, next bool, err error) { +func getDHCP4Response( + req *dhcpv4.DHCPv4, + c net.PacketConn, + iface *net.Interface, +) (ok, next bool, err error) { ok, next, err = tryConn4(req, c, iface) if next { - if err != nil { - log.Debug("dhcpv4: trying a connection: %s", err) - } - return false, next, err } @@ -156,7 +157,7 @@ func getDHCP4Response(req *dhcpv4.DHCPv4, c net.PacketConn, iface *net.Interface } // tryConn4 reads and validates DHCPv4 response packet if it matches -// the original request. req and c must not be nil. +// the original request. req and c must not be nil. // // TODO(a.garipov): Refactor further. Inspect error handling, remove parameter // next, address the TODO, merge with tryConn6, etc. @@ -241,7 +242,7 @@ func checkOtherDHCPv6(iface *net.Interface) (ok bool, err error) { } // discover6 sends a DHCPv6 discovery to the specified network interface and -// waits for response. iface, updAddr and dstAddr must not be nil. +// waits for response. iface, updAddr and dstAddr must not be nil. func discover6(iface *net.Interface, udpAddr, dstAddr *net.UDPAddr) (ok bool, err error) { req, err := dhcpv6.NewSolicit(iface.HardwareAddr) if err != nil { @@ -295,7 +296,7 @@ func getDHCP6Response(req *dhcpv6.Message, c net.PacketConn) (ok, next bool, err } // tryConn6 reads and validates DHCPv6 response packet if it matches -// the original request. req and c must not be nil. +// the original request. req and c must not be nil. // // TODO(a.garipov): See the comment on tryConn4. Sigh… func tryConn6(req *dhcpv6.Message, c net.PacketConn) (ok, next bool, err error) { diff --git a/internal/aghnet/interfaces.go b/internal/aghnet/interfaces.go index 7086d16b..e3112a03 100644 --- a/internal/aghnet/interfaces.go +++ b/internal/aghnet/interfaces.go @@ -23,7 +23,7 @@ type NetIface interface { Addrs() ([]net.Addr, error) } -// IfaceIPAddrs returns the interface's IP addresses. iface must noot be nil. +// IfaceIPAddrs returns the interface's IP addresses. iface must not be nil. func IfaceIPAddrs(iface NetIface, ipv IPVersion) (ips []net.IP, err error) { switch ipv { case IPVersion4, IPVersion6: @@ -46,7 +46,7 @@ func IfaceIPAddrs(iface NetIface, ipv IPVersion) (ips []net.IP, err error) { return ips, nil } -// ipFromAddr converts addr to IP. +// ipFromAddr converts addr to IP. addr must not be nil. func ipFromAddr(addr net.Addr, ipv IPVersion) (ip net.IP) { switch addr := addr.(type) { case *net.IPAddr: @@ -57,9 +57,8 @@ func ipFromAddr(addr net.Addr, ipv IPVersion) (ip net.IP) { return nil } - // Assume that net.(*Interface).Addrs can only return valid IPv4 and - // IPv6 addresses. Thus, if it isn't an IPv4 address, it must be an - // IPv6 one. + // Assume that net.Addr can only be valid IPv4 or IPv6. Thus, + // if it isn't an IPv4 address, it must be an IPv6 one. ip4 := ip.To4() if ipv == IPVersion4 { return ip4 diff --git a/internal/aghnet/net.go b/internal/aghnet/net.go index 8ef1fd8b..a97c6343 100644 --- a/internal/aghnet/net.go +++ b/internal/aghnet/net.go @@ -136,7 +136,7 @@ func (iface NetInterface) MarshalJSON() ([]byte, error) { } // NetInterfaceFrom converts a [net.Interface] to [NetInterface], populating -// name, MAC address, flags, MTU, IP addresses, and subnets. iface must not be +// name, MAC address, flags, MTU, IP addresses, and subnets. iface must not be // nil. func NetInterfaceFrom(iface *net.Interface) (niface *NetInterface, err error) { niface = &NetInterface{ @@ -153,7 +153,7 @@ func NetInterfaceFrom(iface *net.Interface) (niface *NetInterface, err error) { for i, addr := range addrs { if err = populateAddrs(addr, niface); err != nil { - return nil, fmt.Errorf("populating from addrs[%d]: %v", i, err) + return nil, fmt.Errorf("populating at index %d: %w", i, err) } }