Skip to content
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

Jump to bottom

fix: ring buffer deadlock #511

Merged
merged 3 commits into from
Oct 18, 2024
Merged

fix: ring buffer deadlock #511

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9cb6317
fix: ring buffer deadlock
IronCore864 Oct 15, 2024
c68f72c
fix: ring buffer deadlock
IronCore864 Oct 15, 2024
cffde67
chore: refactor after code review
IronCore864 Oct 17, 2024
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
2 changes: 2 additions & 0 deletions internals/servicelog/iterator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@ func (it *iterator) Close() error {
if it.rb == nil {
return nil
}
it.rb.iteratorMutex.Lock()
defer it.rb.iteratorMutex.Unlock()
it.rb.removeIterator(it)
close(it.nextChan)
it.rb = nil
Expand Down
28 changes: 19 additions & 9 deletions internals/servicelog/ringbuffer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ func NewRingBuffer(size int) *RingBuffer {
func (rb *RingBuffer) Close() error {
rb.rwlock.Lock()
defer rb.rwlock.Unlock()
rb.iteratorMutex.Lock()
defer rb.iteratorMutex.Unlock()
if rb.writeClosed {
return nil
}
Expand All @@ -73,6 +75,10 @@ func (rb *RingBuffer) Close() error {
func (rb *RingBuffer) Closed() bool {
rb.rwlock.RLock()
defer rb.rwlock.RUnlock()
return rb.closed()
}

func (rb *RingBuffer) closed() bool {
IronCore864 marked this conversation as resolved.
Show resolved Hide resolved
return rb.writeClosed
}

Expand All @@ -86,6 +92,8 @@ func (rb *RingBuffer) Write(p []byte) (written int, err error) {
}
defer func() {
if written > 0 {
rb.iteratorMutex.RLock()
defer rb.iteratorMutex.RUnlock()
rb.signalIterators()
}
}()
Expand Down Expand Up @@ -158,6 +166,10 @@ func (rb *RingBuffer) Size() int {
func (rb *RingBuffer) Positions() (start RingPos, end RingPos) {
rb.rwlock.RLock()
defer rb.rwlock.RUnlock()
return rb.positions()
}

func (rb *RingBuffer) positions() (start RingPos, end RingPos) {
IronCore864 marked this conversation as resolved.
Show resolved Hide resolved
return rb.readIndex, rb.writeIndex
}

Expand Down Expand Up @@ -237,16 +249,18 @@ func (rb *RingBuffer) WriteTo(writer io.Writer, start RingPos) (next RingPos, n

// TailIterator returns an iterator from the tail of the buffer.
func (rb *RingBuffer) TailIterator() Iterator {
rb.rwlock.RLock()
defer rb.rwlock.RUnlock()
rb.iteratorMutex.Lock()
defer rb.iteratorMutex.Unlock()
start, _ := rb.Positions()
start, _ := rb.positions()
iter := &iterator{
rb: rb,
index: start,
nextChan: make(chan bool, 1),
closeChan: make(chan struct{}),
}
if rb.Closed() {
if rb.closed() {
close(iter.closeChan)
}
rb.iteratorList = append(rb.iteratorList, iter)
Expand All @@ -258,6 +272,8 @@ func (rb *RingBuffer) TailIterator() Iterator {
// backwards from the head.
func (rb *RingBuffer) HeadIterator(lines int) Iterator {
firstLine := rb.reverseLinePosition(lines)
rb.rwlock.RLock()
defer rb.rwlock.RUnlock()
IronCore864 marked this conversation as resolved.
Show resolved Hide resolved
rb.iteratorMutex.Lock()
defer rb.iteratorMutex.Unlock()
iter := &iterator{
Expand All @@ -266,7 +282,7 @@ func (rb *RingBuffer) HeadIterator(lines int) Iterator {
nextChan: make(chan bool, 1),
closeChan: make(chan struct{}),
}
if rb.Closed() {
if rb.closed() {
close(iter.closeChan)
}
rb.iteratorList = append(rb.iteratorList, iter)
Expand Down Expand Up @@ -322,8 +338,6 @@ func (rb *RingBuffer) discard(n int) error {
}

func (rb *RingBuffer) signalIterators() {
rb.iteratorMutex.RLock()
defer rb.iteratorMutex.RUnlock()
for _, iter := range rb.iteratorList {
select {
case iter.nextChan <- true:
Expand All @@ -339,8 +353,6 @@ func (rb *RingBuffer) signalIterators() {
}

func (rb *RingBuffer) releaseIterators() {
rb.iteratorMutex.Lock()
defer rb.iteratorMutex.Unlock()
for _, iter := range rb.iteratorList {
// Close closeChan if not already closed
select {
Expand All @@ -353,8 +365,6 @@ func (rb *RingBuffer) releaseIterators() {
}

func (rb *RingBuffer) removeIterator(iter *iterator) {
rb.iteratorMutex.Lock()
defer rb.iteratorMutex.Unlock()
for i, storedIter := range rb.iteratorList {
if iter != storedIter {
continue
Expand Down
Loading