craigcondit commented on code in PR #562: URL: https://github.com/apache/yunikorn-core/pull/562#discussion_r1240046436
########## pkg/events/event_ringbuffer.go: ########## @@ -0,0 +1,213 @@ +/* + 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 ( + "sync" + + "github.com/apache/yunikorn-scheduler-interface/lib/go/si" +) + +type resultState int + +const ( + resultOK resultState = iota + bufferEmpty + idNotFound +) + +type eventRange struct { + start uint64 + end uint64 +} + +// eventRingBuffer A specialized circular buffer to store event objects. +// +// Unlike to regular circular buffers, existing entries are never directly removed and new entries can be added if the buffer is full. +// In this case, the oldest entry is overwritten and can be collected by the GC. +// +// Retrieving the records can be achieved with GetEventsFromID and GetRecentEntries. +type eventRingBuffer struct { + events []*si.EventRecord + capacity uint64 + idx uint64 + full bool Review Comment: I'm not -1 on this, but it seems like `size int` might be cleaner than `full bool`. "Full" then becomes `size >= capacity`, for what it's worth. Calculation on Add() is simply `size++; if size > capacity size = capacity`. This avoids some special-case handling elsewhere. Thoughts? ########## pkg/events/event_ringbuffer.go: ########## @@ -0,0 +1,213 @@ +/* + 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 ( + "sync" + + "github.com/apache/yunikorn-scheduler-interface/lib/go/si" +) + +type resultState int + +const ( + resultOK resultState = iota + bufferEmpty + idNotFound +) + +type eventRange struct { + start uint64 + end uint64 +} + +// eventRingBuffer A specialized circular buffer to store event objects. +// +// Unlike to regular circular buffers, existing entries are never directly removed and new entries can be added if the buffer is full. +// In this case, the oldest entry is overwritten and can be collected by the GC. +// +// Retrieving the records can be achieved with GetEventsFromID and GetRecentEntries. +type eventRingBuffer struct { + events []*si.EventRecord + capacity uint64 + idx uint64 + full bool + + id uint64 // increasing unique id + startId uint64 // id of the message at index 0 + lowestId uint64 // the lowest available id in the buffer (pointed at by e.idx when full) + Review Comment: On Add, current count would be incremented, and reset to capacity if it exceeds it. Head pointer would be incremented and on overflow reset to zero. ID of element at head is ever-increasing. ########## pkg/events/event_ringbuffer.go: ########## @@ -0,0 +1,213 @@ +/* + 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 ( + "sync" + + "github.com/apache/yunikorn-scheduler-interface/lib/go/si" +) + +type resultState int + +const ( + resultOK resultState = iota + bufferEmpty + idNotFound +) + +type eventRange struct { + start uint64 + end uint64 +} + +// eventRingBuffer A specialized circular buffer to store event objects. +// +// Unlike to regular circular buffers, existing entries are never directly removed and new entries can be added if the buffer is full. +// In this case, the oldest entry is overwritten and can be collected by the GC. +// +// Retrieving the records can be achieved with GetEventsFromID and GetRecentEntries. +type eventRingBuffer struct { + events []*si.EventRecord + capacity uint64 + idx uint64 + full bool + + id uint64 // increasing unique id + startId uint64 // id of the message at index 0 + lowestId uint64 // the lowest available id in the buffer (pointed at by e.idx when full) + Review Comment: This seems overly complex. We only really need to know: - capacity of the buffer (i.e. len(events[]) - current count of events - head position of buffer - ID of element at head That's 3 variables. I count 5 plus a full pointer in the implementation. All others can be calculated trivially from these. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
