[GitHub] [yunikorn-core] FrankYang0529 commented on a diff in pull request #562: [YUNIKORN-1799] Create basic ringbuffer implementation

["FrankYang0529 (via GitHub)" <gi...@apache.org>]

FrankYang0529 commented on code in PR #562:
URL: https://github.com/apache/yunikorn-core/pull/562#discussion_r1225830581


##########
pkg/events/event_ringbuffer.go:
##########
@@ -0,0 +1,173 @@
+/*
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements.  See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership.  The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+*/
+
+package events
+
+import (
+	"time"
+
+	"github.com/apache/yunikorn-scheduler-interface/lib/go/si"
+)
+
+const latestUnset int64 = -1 << 63
+
+var now = time.Now
+
+// EventRingBuffer A specialized circular buffer to store event objects.
+//
+// Unlike to regular circular buffers, new entries can be added if the buffer is full. In this case,
+// the oldest entry is overwritten. This is not a classic enqueue operation, so it's named differently.
+//
+// Retrieving the records can be achieved with GetLatestEntriesCount and GetLatestEntries. Since these do not
+// remove the elements, they are not regular dequeue operations either.
+//
+// Entries have a maximum lifespan defined in nanoseconds. Cleanup of expired objects occurs when a call to
+// RemoveExpiredEntries is made.
+type EventRingBuffer struct {
+	events        []*si.EventRecord
+	capacity      int
+	noElements    int
+	head          int
+	tail          int
+	latest        int64
+	lifetimeNanos int64
+}
+
+// Add adds an event to the ring buffer. If the buffer is full, the oldest element is overwritten.
+// This method never fails.
+func (e *EventRingBuffer) Add(event *si.EventRecord) {
+	full := false
+	if e.noElements == e.capacity {
+		full = true
+	}
+	e.events[e.tail] = event
+	e.tail = e.next(e.tail)
+	e.latest = event.TimestampNano
+
+	if full {
+		e.head = e.tail
+		return
+	}
+
+	e.noElements++
+}
+
+// GetLatestEntriesCount returns most recent items. The amount is defined by "count".
+func (e *EventRingBuffer) GetLatestEntriesCount(count int) []*si.EventRecord {
+	if e.noElements == 0 {
+		return nil
+	}
+
+	records := make([]*si.EventRecord, 0)
+	for i := e.prev(e.tail); ; {
+		records = append(records, e.events[i])
+		if len(records) == count || i == e.head {
+			reverse(records)
+			return records
+		}
+
+		i = e.prev(i)
+	}
+}
+
+// GetLatestEntries returns the most recent items whose age is younger than the current time minus interval.
+func (e *EventRingBuffer) GetLatestEntries(interval time.Duration) []*si.EventRecord {
+	unixNow := now().UnixNano()
+
+	if e.noElements == 0 || unixNow-int64(interval) > e.latest {
+		return nil
+	}
+
+	startTime := unixNow - int64(interval)
+	records := make([]*si.EventRecord, 0)
+
+	for i := e.head; ; {
+		if e.events[i].TimestampNano >= startTime {
+			records = append(records, e.events[i])
+		}
+
+		next := e.next(i)
+		if next == e.tail {
+			break
+		}
+		i = next
+	}
+
+	return records
+}
+
+// RemoveExpiredEntries discards expired entries from the buffer. Current age of an object depends on the
+// TimestampNano field.
+// This method is expected to be called in regular intervals, which usually runs on a separate goroutine.
+func (e *EventRingBuffer) RemoveExpiredEntries() int {
+	unixNow := now().UnixNano()
+	if e.noElements == 0 {
+		return 0
+	}
+
+	removed := 0
+	for i := e.head; ; {
+		ts := e.events[i].TimestampNano
+
+		if unixNow-ts < e.lifetimeNanos {
+			return removed // remaining events are newer
+		}
+
+		e.events[i] = nil
+		e.noElements--
+		removed++
+
+		next := e.next(i)
+		e.head = next
+		i = next
+
+		if next == e.tail {
+			// no more elements
+			e.latest = latestUnset
+			return removed
+		}
+	}
+}
+
+func (e *EventRingBuffer) prev(i int) int {
+	i--
+	if i == -1 {
+		i = e.capacity - 1
+	}
+
+	return i
+}
+
+func (e *EventRingBuffer) next(i int) int {
+	return (i + 1) % e.capacity
+}
+
+func reverse(r []*si.EventRecord) {
+	for i, j := 0, len(r)-1; i < j; i, j = i+1, j-1 {
+		r[i], r[j] = r[j], r[i]
+	}
+}
+
+func NewEventRingBuffer(capacity int, eventLifeTime time.Duration) *EventRingBuffer {
+	return &EventRingBuffer{
+		capacity:      capacity,
+		events:        make([]*si.EventRecord, capacity),
+		lifetimeNanos: int64(eventLifeTime),

Review Comment:
   We can use `eventLifeTime.Nanoseconds()`.
   
   Ref: https://pkg.go.dev/time#Duration.Nanoseconds



##########
pkg/events/event_ringbuffer.go:
##########
@@ -0,0 +1,173 @@
+/*
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements.  See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership.  The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+*/
+
+package events
+
+import (
+	"time"
+
+	"github.com/apache/yunikorn-scheduler-interface/lib/go/si"
+)
+
+const latestUnset int64 = -1 << 63
+
+var now = time.Now
+
+// EventRingBuffer A specialized circular buffer to store event objects.
+//
+// Unlike to regular circular buffers, new entries can be added if the buffer is full. In this case,
+// the oldest entry is overwritten. This is not a classic enqueue operation, so it's named differently.
+//
+// Retrieving the records can be achieved with GetLatestEntriesCount and GetLatestEntries. Since these do not
+// remove the elements, they are not regular dequeue operations either.
+//
+// Entries have a maximum lifespan defined in nanoseconds. Cleanup of expired objects occurs when a call to
+// RemoveExpiredEntries is made.
+type EventRingBuffer struct {
+	events        []*si.EventRecord
+	capacity      int
+	noElements    int
+	head          int
+	tail          int
+	latest        int64
+	lifetimeNanos int64
+}
+
+// Add adds an event to the ring buffer. If the buffer is full, the oldest element is overwritten.
+// This method never fails.
+func (e *EventRingBuffer) Add(event *si.EventRecord) {
+	full := false
+	if e.noElements == e.capacity {
+		full = true
+	}
+	e.events[e.tail] = event
+	e.tail = e.next(e.tail)
+	e.latest = event.TimestampNano
+
+	if full {
+		e.head = e.tail
+		return
+	}
+
+	e.noElements++
+}
+
+// GetLatestEntriesCount returns most recent items. The amount is defined by "count".
+func (e *EventRingBuffer) GetLatestEntriesCount(count int) []*si.EventRecord {
+	if e.noElements == 0 {
+		return nil
+	}
+
+	records := make([]*si.EventRecord, 0)
+	for i := e.prev(e.tail); ; {
+		records = append(records, e.events[i])
+		if len(records) == count || i == e.head {
+			reverse(records)
+			return records
+		}
+
+		i = e.prev(i)
+	}
+}
+
+// GetLatestEntries returns the most recent items whose age is younger than the current time minus interval.
+func (e *EventRingBuffer) GetLatestEntries(interval time.Duration) []*si.EventRecord {
+	unixNow := now().UnixNano()
+
+	if e.noElements == 0 || unixNow-int64(interval) > e.latest {
+		return nil
+	}
+
+	startTime := unixNow - int64(interval)
+	records := make([]*si.EventRecord, 0)
+
+	for i := e.head; ; {
+		if e.events[i].TimestampNano >= startTime {
+			records = append(records, e.events[i])
+		}
+
+		next := e.next(i)
+		if next == e.tail {
+			break
+		}
+		i = next
+	}
+
+	return records
+}
+
+// RemoveExpiredEntries discards expired entries from the buffer. Current age of an object depends on the
+// TimestampNano field.
+// This method is expected to be called in regular intervals, which usually runs on a separate goroutine.
+func (e *EventRingBuffer) RemoveExpiredEntries() int {
+	unixNow := now().UnixNano()
+	if e.noElements == 0 {
+		return 0
+	}
+
+	removed := 0
+	for i := e.head; ; {
+		ts := e.events[i].TimestampNano
+
+		if unixNow-ts < e.lifetimeNanos {
+			return removed // remaining events are newer
+		}
+
+		e.events[i] = nil
+		e.noElements--
+		removed++
+
+		next := e.next(i)
+		e.head = next
+		i = next
+
+		if next == e.tail {
+			// no more elements
+			e.latest = latestUnset
+			return removed
+		}
+	}
+}
+
+func (e *EventRingBuffer) prev(i int) int {
+	i--
+	if i == -1 {
+		i = e.capacity - 1
+	}
+
+	return i
+}
+
+func (e *EventRingBuffer) next(i int) int {
+	return (i + 1) % e.capacity
+}
+
+func reverse(r []*si.EventRecord) {
+	for i, j := 0, len(r)-1; i < j; i, j = i+1, j-1 {
+		r[i], r[j] = r[j], r[i]
+	}
+}
+
+func NewEventRingBuffer(capacity int, eventLifeTime time.Duration) *EventRingBuffer {
+	return &EventRingBuffer{
+		capacity:      capacity,

Review Comment:
   Do we want to check whether `capacity` is a positive integer?



##########
pkg/events/event_ringbuffer.go:
##########
@@ -0,0 +1,173 @@
+/*
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements.  See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership.  The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+*/
+
+package events
+
+import (
+	"time"
+
+	"github.com/apache/yunikorn-scheduler-interface/lib/go/si"
+)
+
+const latestUnset int64 = -1 << 63
+
+var now = time.Now
+
+// EventRingBuffer A specialized circular buffer to store event objects.
+//
+// Unlike to regular circular buffers, new entries can be added if the buffer is full. In this case,
+// the oldest entry is overwritten. This is not a classic enqueue operation, so it's named differently.
+//
+// Retrieving the records can be achieved with GetLatestEntriesCount and GetLatestEntries. Since these do not
+// remove the elements, they are not regular dequeue operations either.
+//
+// Entries have a maximum lifespan defined in nanoseconds. Cleanup of expired objects occurs when a call to
+// RemoveExpiredEntries is made.
+type EventRingBuffer struct {
+	events        []*si.EventRecord
+	capacity      int
+	noElements    int
+	head          int
+	tail          int
+	latest        int64
+	lifetimeNanos int64
+}
+
+// Add adds an event to the ring buffer. If the buffer is full, the oldest element is overwritten.
+// This method never fails.
+func (e *EventRingBuffer) Add(event *si.EventRecord) {
+	full := false
+	if e.noElements == e.capacity {
+		full = true
+	}
+	e.events[e.tail] = event
+	e.tail = e.next(e.tail)
+	e.latest = event.TimestampNano
+
+	if full {
+		e.head = e.tail
+		return
+	}
+
+	e.noElements++
+}
+
+// GetLatestEntriesCount returns most recent items. The amount is defined by "count".
+func (e *EventRingBuffer) GetLatestEntriesCount(count int) []*si.EventRecord {
+	if e.noElements == 0 {
+		return nil
+	}
+
+	records := make([]*si.EventRecord, 0)
+	for i := e.prev(e.tail); ; {
+		records = append(records, e.events[i])
+		if len(records) == count || i == e.head {
+			reverse(records)
+			return records
+		}
+
+		i = e.prev(i)
+	}
+}
+
+// GetLatestEntries returns the most recent items whose age is younger than the current time minus interval.
+func (e *EventRingBuffer) GetLatestEntries(interval time.Duration) []*si.EventRecord {
+	unixNow := now().UnixNano()
+
+	if e.noElements == 0 || unixNow-int64(interval) > e.latest {
+		return nil
+	}
+
+	startTime := unixNow - int64(interval)
+	records := make([]*si.EventRecord, 0)
+
+	for i := e.head; ; {
+		if e.events[i].TimestampNano >= startTime {
+			records = append(records, e.events[i])
+		}
+
+		next := e.next(i)
+		if next == e.tail {
+			break
+		}
+		i = next
+	}
+
+	return records
+}
+
+// RemoveExpiredEntries discards expired entries from the buffer. Current age of an object depends on the
+// TimestampNano field.
+// This method is expected to be called in regular intervals, which usually runs on a separate goroutine.

Review Comment:
   From this comment, it looks like we will use `EventRingBuffer` in more than one gorutines. Do we want to add a lock when we update elements?



##########
pkg/events/event_ringbuffer.go:
##########
@@ -0,0 +1,173 @@
+/*
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements.  See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership.  The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+*/
+
+package events
+
+import (
+	"time"
+
+	"github.com/apache/yunikorn-scheduler-interface/lib/go/si"
+)
+
+const latestUnset int64 = -1 << 63

Review Comment:
   Not sure whether using `const latestUnset int64 = math.MinInt64` is more clear?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@yunikorn.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org