-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Pull request 2221: AG-27492-client-persistent-runtime-storage
Squashed commit of the following: commit a2b1e82 Merge: 5fde76b 65b7d23 Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Tue Jun 25 16:12:17 2024 +0300 Merge branch 'master' into AG-27492-client-persistent-runtime-storage commit 5fde76b Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Fri Jun 21 16:58:17 2024 +0300 all: imp code commit eae49f9 Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Wed Jun 19 20:10:55 2024 +0300 all: use storage commit 2c7efa4 Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Tue Jun 18 20:14:34 2024 +0300 client: add tests commit d59bd7a Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Tue Jun 18 18:31:23 2024 +0300 client: add tests commit 045b838 Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Tue Jun 18 15:18:08 2024 +0300 client: add tests commit 702467f Merge: 4abc23b 1c82be2 Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Mon Jun 17 18:40:43 2024 +0300 Merge branch 'master' into AG-27492-client-persistent-runtime-storage commit 4abc23b Merge: e268abf bed86d5 Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Thu Jun 13 15:19:47 2024 +0300 Merge branch 'master' into AG-27492-client-persistent-runtime-storage commit e268abf Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Thu Jun 13 15:19:36 2024 +0300 client: add tests commit 5601cfc Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Mon May 27 14:27:53 2024 +0300 client: runtime index commit bde3baa Author: Stanislav Chzhen <s.chzhen@adguard.com> Date: Mon May 20 14:39:35 2024 +0300 all: persistent client storage
- Loading branch information
Showing
7 changed files
with
816 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,255 @@ | ||
| package client | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "net" | ||
| "net/netip" | ||
| "sync" | ||
|
|
||
| "github.com/AdguardTeam/golibs/container" | ||
| "github.com/AdguardTeam/golibs/errors" | ||
| "github.com/AdguardTeam/golibs/log" | ||
| ) | ||
|
|
||
| // Storage contains information about persistent and runtime clients. | ||
| type Storage struct { | ||
| // allowedTags is a set of all allowed tags. | ||
| allowedTags *container.MapSet[string] | ||
|
|
||
| // mu protects indexes of persistent and runtime clients. | ||
| mu *sync.Mutex | ||
|
|
||
| // index contains information about persistent clients. | ||
| index *Index | ||
|
|
||
| // runtimeIndex contains information about runtime clients. | ||
| runtimeIndex *RuntimeIndex | ||
| } | ||
|
|
||
| // NewStorage returns initialized client storage. | ||
| func NewStorage(allowedTags *container.MapSet[string]) (s *Storage) { | ||
| return &Storage{ | ||
| allowedTags: allowedTags, | ||
| mu: &sync.Mutex{}, | ||
| index: NewIndex(), | ||
| runtimeIndex: NewRuntimeIndex(), | ||
| } | ||
| } | ||
|
|
||
| // Add stores persistent client information or returns an error. | ||
| func (s *Storage) Add(p *Persistent) (err error) { | ||
| defer func() { err = errors.Annotate(err, "adding client: %w") }() | ||
|
|
||
| err = p.validate(s.allowedTags) | ||
| if err != nil { | ||
| // Don't wrap the error since there is already an annotation deferred. | ||
| return err | ||
| } | ||
|
|
||
| s.mu.Lock() | ||
| defer s.mu.Unlock() | ||
|
|
||
| err = s.index.ClashesUID(p) | ||
| if err != nil { | ||
| // Don't wrap the error since there is already an annotation deferred. | ||
| return err | ||
| } | ||
|
|
||
| err = s.index.Clashes(p) | ||
| if err != nil { | ||
| // Don't wrap the error since there is already an annotation deferred. | ||
| return err | ||
| } | ||
|
|
||
| s.index.Add(p) | ||
|
|
||
| log.Debug("client storage: added %q: IDs: %q [%d]", p.Name, p.IDs(), s.index.Size()) | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // FindByName finds persistent client by name. | ||
| func (s *Storage) FindByName(name string) (c *Persistent, found bool) { | ||
| s.mu.Lock() | ||
| defer s.mu.Unlock() | ||
|
|
||
| return s.index.FindByName(name) | ||
| } | ||
|
|
||
| // Find finds persistent client by string representation of the client ID, IP | ||
| // address, or MAC. And returns it shallow copy. | ||
| func (s *Storage) Find(id string) (p *Persistent, ok bool) { | ||
| s.mu.Lock() | ||
| defer s.mu.Unlock() | ||
|
|
||
| p, ok = s.index.Find(id) | ||
| if ok { | ||
| return p.ShallowClone(), ok | ||
| } | ||
|
|
||
| return nil, false | ||
| } | ||
|
|
||
| // FindLoose is like [Storage.Find] but it also tries to find a persistent | ||
| // client by IP address without zone. It strips the IPv6 zone index from the | ||
| // stored IP addresses before comparing, because querylog entries don't have it. | ||
| // See TODO on [querylog.logEntry.IP]. | ||
| // | ||
| // Note that multiple clients can have the same IP address with different zones. | ||
| // Therefore, the result of this method is indeterminate. | ||
| func (s *Storage) FindLoose(ip netip.Addr, id string) (p *Persistent, ok bool) { | ||
| s.mu.Lock() | ||
| defer s.mu.Unlock() | ||
|
|
||
| p, ok = s.index.Find(id) | ||
| if ok { | ||
| return p.ShallowClone(), ok | ||
| } | ||
|
|
||
| p = s.index.FindByIPWithoutZone(ip) | ||
| if p != nil { | ||
| return p.ShallowClone(), true | ||
| } | ||
|
|
||
| return nil, false | ||
| } | ||
|
|
||
| // FindByMAC finds persistent client by MAC. | ||
| func (s *Storage) FindByMAC(mac net.HardwareAddr) (c *Persistent, found bool) { | ||
| s.mu.Lock() | ||
| defer s.mu.Unlock() | ||
|
|
||
| return s.index.FindByMAC(mac) | ||
| } | ||
|
|
||
| // RemoveByName removes persistent client information. ok is false if no such | ||
| // client exists by that name. | ||
| func (s *Storage) RemoveByName(name string) (ok bool) { | ||
| s.mu.Lock() | ||
| defer s.mu.Unlock() | ||
|
|
||
| p, ok := s.index.FindByName(name) | ||
| if !ok { | ||
| return false | ||
| } | ||
|
|
||
| if err := p.CloseUpstreams(); err != nil { | ||
| log.Error("client storage: removing client %q: %s", p.Name, err) | ||
| } | ||
|
|
||
| s.index.Delete(p) | ||
|
|
||
| return true | ||
| } | ||
|
|
||
| // Update finds the stored persistent client by its name and updates its | ||
| // information from p. | ||
| func (s *Storage) Update(name string, p *Persistent) (err error) { | ||
| defer func() { err = errors.Annotate(err, "updating client: %w") }() | ||
|
|
||
| err = p.validate(s.allowedTags) | ||
| if err != nil { | ||
| // Don't wrap the error since there is already an annotation deferred. | ||
| return err | ||
| } | ||
|
|
||
| s.mu.Lock() | ||
| defer s.mu.Unlock() | ||
|
|
||
| stored, ok := s.index.FindByName(name) | ||
| if !ok { | ||
| return fmt.Errorf("client %q is not found", name) | ||
| } | ||
|
|
||
| // Client p has a newly generated UID, so replace it with the stored one. | ||
| // | ||
| // TODO(s.chzhen): Remove when frontend starts handling UIDs. | ||
| p.UID = stored.UID | ||
|
|
||
| err = s.index.Clashes(p) | ||
| if err != nil { | ||
| // Don't wrap the error since there is already an annotation deferred. | ||
| return err | ||
| } | ||
|
|
||
| s.index.Delete(stored) | ||
| s.index.Add(p) | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // RangeByName calls f for each persistent client sorted by name, unless cont is | ||
| // false. | ||
| func (s *Storage) RangeByName(f func(c *Persistent) (cont bool)) { | ||
| s.mu.Lock() | ||
| defer s.mu.Unlock() | ||
|
|
||
| s.index.RangeByName(f) | ||
| } | ||
|
|
||
| // Size returns the number of persistent clients. | ||
| func (s *Storage) Size() (n int) { | ||
| s.mu.Lock() | ||
| defer s.mu.Unlock() | ||
|
|
||
| return s.index.Size() | ||
| } | ||
|
|
||
| // CloseUpstreams closes upstream configurations of persistent clients. | ||
| func (s *Storage) CloseUpstreams() (err error) { | ||
| s.mu.Lock() | ||
| defer s.mu.Unlock() | ||
|
|
||
| return s.index.CloseUpstreams() | ||
| } | ||
|
|
||
| // ClientRuntime returns a copy of the saved runtime client by ip. If no such | ||
| // client exists, returns nil. | ||
| func (s *Storage) ClientRuntime(ip netip.Addr) (rc *Runtime) { | ||
| s.mu.Lock() | ||
| defer s.mu.Unlock() | ||
|
|
||
| return s.runtimeIndex.Client(ip) | ||
| } | ||
|
|
||
| // AddRuntime saves the runtime client information in the storage. IP address | ||
| // of a client must be unique. rc must not be nil. | ||
| func (s *Storage) AddRuntime(rc *Runtime) { | ||
| s.mu.Lock() | ||
| defer s.mu.Unlock() | ||
|
|
||
| s.runtimeIndex.Add(rc) | ||
| } | ||
|
|
||
| // SizeRuntime returns the number of the runtime clients. | ||
| func (s *Storage) SizeRuntime() (n int) { | ||
| s.mu.Lock() | ||
| defer s.mu.Unlock() | ||
|
|
||
| return s.runtimeIndex.Size() | ||
| } | ||
|
|
||
| // RangeRuntime calls f for each runtime client in an undefined order. | ||
| func (s *Storage) RangeRuntime(f func(rc *Runtime) (cont bool)) { | ||
| s.mu.Lock() | ||
| defer s.mu.Unlock() | ||
|
|
||
| s.runtimeIndex.Range(f) | ||
| } | ||
|
|
||
| // DeleteRuntime removes the runtime client by ip. | ||
| func (s *Storage) DeleteRuntime(ip netip.Addr) { | ||
| s.mu.Lock() | ||
| defer s.mu.Unlock() | ||
|
|
||
| s.runtimeIndex.Delete(ip) | ||
| } | ||
|
|
||
| // DeleteBySource removes all runtime clients that have information only from | ||
| // the specified source and returns the number of removed clients. | ||
| func (s *Storage) DeleteBySource(src Source) (n int) { | ||
| s.mu.Lock() | ||
| defer s.mu.Unlock() | ||
|
|
||
| return s.runtimeIndex.DeleteBySource(src) | ||
| } |
Oops, something went wrong.