github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-26 21:17:23 +00:00
Code Issues Projects Releases Wiki Activity

Fix potential race in dispatching watch event

Browse Source
This commit is contained in:
Wojciech Tyczyński 2022-02-22 17:14:15 +01:00
parent 0cb3a02bbe
commit 779f157ecf
3 changed files with 17 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
staging/src/k8s.io/apiserver/pkg/storage/cacher/cacher.go
View File

@ -851,14 +851,14 @@ func (c *Cacher) dispatchEvent(event *watchCacheEvent) {
// from it justifies increased memory usage, so for now we drop the cached // from it justifies increased memory usage, so for now we drop the cached
// serializations after dispatching this event. // serializations after dispatching this event.
// //
// Given the deep-copies that are done to create cachingObjects, // Given that CachingObject is just wrapping the object and not perfoming
// we try to cache serializations only if there are at least 3 watchers. // deep-copying (until some field is explicitly being modified), we create
if len(c.watchersBuffer) >= 3 { // it unconditionally to ensure safety and reduce deep-copying.
// Make a shallow copy to allow overwriting Object and PrevObject. //
wcEvent := *event // Make a shallow copy to allow overwriting Object and PrevObject.
setCachingObjects(&wcEvent, c.versioner) wcEvent := *event
event = &wcEvent setCachingObjects(&wcEvent, c.versioner)
} event = &wcEvent
c.blockedWatchers = c.blockedWatchers[:0] c.blockedWatchers = c.blockedWatchers[:0]
for _, watcher := range c.watchersBuffer { for _, watcher := range c.watchersBuffer {
@ -1288,9 +1288,9 @@ func (c *cacheWatcher) convertToWatchEvent(event *watchCacheEvent) *watch.Event
switch { switch {
case curObjPasses && !oldObjPasses: case curObjPasses && !oldObjPasses:
return &watch.Event{Type: watch.Added, Object: event.Object} return &watch.Event{Type: watch.Added, Object: getMutableObject(event.Object)}
case curObjPasses && oldObjPasses: case curObjPasses && oldObjPasses:
return &watch.Event{Type: watch.Modified, Object: event.Object} return &watch.Event{Type: watch.Modified, Object: getMutableObject(event.Object)}
case !curObjPasses && oldObjPasses: case !curObjPasses && oldObjPasses:
// return a delete event with the previous object content, but with the event's resource version // return a delete event with the previous object content, but with the event's resource version
oldObj := getMutableObject(event.PrevObject) oldObj := getMutableObject(event.PrevObject)

13
staging/src/k8s.io/apiserver/pkg/storage/cacher/cacher_whitebox_test.go
View File

@ -1370,17 +1370,10 @@ func testCachingObjects(t *testing.T, watchersCount int) {
} }
var object runtime.Object var object runtime.Object
if watchersCount >= 3 { if _, ok := event.Object.(runtime.CacheableObject); !ok {
if _, ok := event.Object.(runtime.CacheableObject); !ok { t.Fatalf("Object in %s event should support caching: %#v", event.Type, event.Object)
t.Fatalf("Object in %s event should support caching: %#v", event.Type, event.Object)
}
object = event.Object.(runtime.CacheableObject).GetObject()
} else {
if _, ok := event.Object.(runtime.CacheableObject); ok {
t.Fatalf("Object in %s event should not support caching: %#v", event.Type, event.Object)
}
object = event.Object.DeepCopyObject()
} }
object = event.Object.(runtime.CacheableObject).GetObject()
if event.Type == watch.Deleted { if event.Type == watch.Deleted {
resourceVersion, err := cacher.versioner.ObjectResourceVersion(cacher.watchCache.cache[index].PrevObject) resourceVersion, err := cacher.versioner.ObjectResourceVersion(cacher.watchCache.cache[index].PrevObject)

4
staging/src/k8s.io/apiserver/pkg/storage/cacher/caching_object.go
View File

@ -137,6 +137,10 @@ func (o *cachingObject) CacheEncode(id runtime.Identifier, encode func(runtime.O
result := o.getSerializationResult(id) result := o.getSerializationResult(id)
result.once.Do(func() { result.once.Do(func() {
buffer := bytes.NewBuffer(nil) buffer := bytes.NewBuffer(nil)
// TODO(wojtek-t): This is currently making a copy to avoid races
// in cases where encoding is making subtle object modifications,
// e.g. #82497
// Figure out if we can somehow avoid this under some conditions.
result.err = encode(o.GetObject(), buffer) result.err = encode(o.GetObject(), buffer)
result.raw = buffer.Bytes() result.raw = buffer.Bytes()
}) })