Skip to content

Add Rule.Equal method. #1095

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add Rule.Equal method. #1095

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions rule.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,47 @@ type Rule struct {
Type uint8
}

func (r Rule) Equal(x Rule) bool {
return r.Table == x.Table &&
((r.Src == nil && x.Src == nil) ||
(r.Src != nil && x.Src != nil && r.Src.String() == x.Src.String())) &&
((r.Dst == nil && x.Dst == nil) ||
(r.Dst != nil && x.Dst != nil && r.Dst.String() == x.Dst.String())) &&
r.OifName == x.OifName &&
r.Priority == x.Priority &&
r.Family == x.Family &&
r.IifName == x.IifName &&
r.Invert == x.Invert &&
r.Tos == x.Tos &&
r.Type == x.Type &&
r.IPProto == x.IPProto &&
r.Protocol == x.Protocol &&
r.Mark == x.Mark &&
// For non-zero marks, mask defaults to 0xFFFFFFFF if not set. So if either mask is nil
// while the other is 0xFFFFFFFF when mark is non-zero, treat the masks as identical.
// See kernel source: https://github.com/torvalds/linux/blob/v6.15/net/core/fib_rules.c#L624
(ptrEqual(r.Mask, x.Mask) || (r.Mark != 0 &&
(r.Mask == nil && *x.Mask == 0xFFFFFFFF || x.Mask == nil && *r.Mask == 0xFFFFFFFF))) &&
r.TunID == x.TunID &&
r.Goto == x.Goto &&
r.Flow == x.Flow &&
r.SuppressIfgroup == x.SuppressIfgroup &&
r.SuppressPrefixlen == x.SuppressPrefixlen &&
(r.Dport == x.Dport || (r.Dport != nil && x.Dport != nil && r.Dport.Equal(*x.Dport))) &&
(r.Sport == x.Sport || (r.Sport != nil && x.Sport != nil && r.Sport.Equal(*x.Sport))) &&
(r.UIDRange == x.UIDRange || (r.UIDRange != nil && x.UIDRange != nil && r.UIDRange.Equal(*x.UIDRange)))
}

func ptrEqual(a, b *uint32) bool {
if a == b {
return true
}
if (a == nil) || (b == nil) {
return false
}
return *a == *b
}

func (r Rule) String() string {
from := "all"
if r.Src != nil && r.Src.String() != "<nil>" {
Expand Down Expand Up @@ -70,6 +111,10 @@ type RulePortRange struct {
End uint16
}

func (r RulePortRange) Equal(x RulePortRange) bool {
return r.Start == x.Start && r.End == x.End
}

// NewRuleUIDRange creates rule uid range.
func NewRuleUIDRange(start, end uint32) *RuleUIDRange {
return &RuleUIDRange{Start: start, End: end}
Expand All @@ -80,3 +125,7 @@ type RuleUIDRange struct {
Start uint32
End uint32
}

func (r RuleUIDRange) Equal(x RuleUIDRange) bool {
return r.Start == x.Start && r.End == x.End
}
10 changes: 0 additions & 10 deletions rule_linux.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,16 +336,6 @@ func (pr *RuleUIDRange) toRtAttrData() []byte {
return bytes.Join(b, []byte{})
}

func ptrEqual(a, b *uint32) bool {
if a == b {
return true
}
if (a == nil) || (b == nil) {
return false
}
return *a == *b
}

func (r Rule) typeString() string {
switch r.Type {
case unix.RTN_UNSPEC: // zero
Expand Down
119 changes: 99 additions & 20 deletions rule_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ package netlink

import (
"net"
"strconv"
"testing"
"time"

Expand Down Expand Up @@ -600,7 +601,7 @@ func runRuleListFiltered(t *testing.T, family int, srcNet, dstNet *net.IPNet) {
t.Errorf("Expected len: %d, got: %d", len(wantRules), len(rules))
} else {
for i := range wantRules {
if !ruleEquals(wantRules[i], rules[i]) {
if !wantRules[i].Equal(rules[i]) {
t.Errorf("Rules mismatch, want %v, got %v", wantRules[i], rules[i])
}
}
Expand Down Expand Up @@ -666,30 +667,108 @@ func TestRuleString(t *testing.T) {

func ruleExists(rules []Rule, rule Rule) bool {
for i := range rules {
if ruleEquals(rules[i], rule) {
if rules[i].Equal(rule) {
return true
}
}

return false
}

func ruleEquals(a, b Rule) bool {
return a.Table == b.Table &&
((a.Src == nil && b.Src == nil) ||
(a.Src != nil && b.Src != nil && a.Src.String() == b.Src.String())) &&
((a.Dst == nil && b.Dst == nil) ||
(a.Dst != nil && b.Dst != nil && a.Dst.String() == b.Dst.String())) &&
a.OifName == b.OifName &&
a.Priority == b.Priority &&
a.Family == b.Family &&
a.IifName == b.IifName &&
a.Invert == b.Invert &&
a.Tos == b.Tos &&
a.Type == b.Type &&
a.IPProto == b.IPProto &&
a.Protocol == b.Protocol &&
a.Mark == b.Mark &&
(ptrEqual(a.Mask, b.Mask) || (a.Mark != 0 &&
(a.Mask == nil && *b.Mask == 0xFFFFFFFF || b.Mask == nil && *a.Mask == 0xFFFFFFFF)))
func TestRuleEqual(t *testing.T) {
cases := []Rule{
{Priority: 1000},
{Family: FAMILY_V6},
{Table: 10},
{Mark: 1},
{Mask: &[]uint32{0x1}[0]},
{Tos: 1},
{TunID: 3},
{Goto: 10},
{Src: &net.IPNet{IP: net.IPv4(172, 16, 0, 1), Mask: net.CIDRMask(16, 32)}},
{Dst: &net.IPNet{IP: net.IPv4(172, 16, 1, 1), Mask: net.CIDRMask(24, 32)}},
{Flow: 3},
{IifName: "IifName"},
{OifName: "OifName"},
{SuppressIfgroup: 7},
{SuppressPrefixlen: 16},
{Invert: true},
{Dport: &RulePortRange{Start: 10, End: 20}},
{Sport: &RulePortRange{Start: 1, End: 2}},
{IPProto: unix.IPPROTO_TCP},
{UIDRange: &RuleUIDRange{Start: 3, End: 5}},
{Protocol: FAMILY_V6},
{Type: unix.RTN_UNREACHABLE},
}
for i1 := range cases {
for i2 := range cases {
got := cases[i1].Equal(cases[i2])
expected := i1 == i2
if got != expected {
t.Errorf("Equal(%q,%q) == %s but expected %s",
cases[i1], cases[i2],
strconv.FormatBool(got),
strconv.FormatBool(expected))
}
}
}
}

func TestRuleEqualMaskMark(t *testing.T) {
a := Rule{Mark: 1, Mask: nil}
b := Rule{Mark: 1, Mask: &[]uint32{0xFFFFFFFF}[0]}
if !a.Equal(b) || !b.Equal(a) {
t.Errorf("Rules are expected to be equal")
}

b = Rule{Mark: 2, Mask: &[]uint32{0xFFFFFFFF}[0]}
if a.Equal(b) || b.Equal(a) {
t.Errorf("Rules are not expected to be equal")
}

a = Rule{Mark: 0, Mask: nil}
b = Rule{Mark: 0, Mask: &[]uint32{0xFFFFFFFF}[0]}
if a.Equal(b) || b.Equal(a) {
t.Errorf("Rules are not expected to be equal")
}
}

func TestRulePortRangeEqual(t *testing.T) {
cases := []RulePortRange{
{Start: 10, End: 10},
{Start: 10, End: 22},
{Start: 11, End: 22},
}
for i1 := range cases {
for i2 := range cases {
got := cases[i1].Equal(cases[i2])
expected := i1 == i2
if got != expected {
t.Errorf("Equal(%q,%q) == %s but expected %s",
cases[i1], cases[i2],
strconv.FormatBool(got),
strconv.FormatBool(expected))
}
}
}
}

func TestRuleUIDRangeEqual(t *testing.T) {
cases := []RuleUIDRange{
{Start: 10, End: 10},
{Start: 10, End: 22},
{Start: 11, End: 22},
}
for i1 := range cases {
for i2 := range cases {
got := cases[i1].Equal(cases[i2])
expected := i1 == i2
if got != expected {
t.Errorf("Equal(%q,%q) == %s but expected %s",
cases[i1], cases[i2],
strconv.FormatBool(got),
strconv.FormatBool(expected))
}
}
}
}
Loading