k8s.io/kubernetes@v1.29.3/pkg/kubelet/cm/devicemanager/plugin/v1beta1/handler.go (about) 1 /* 2 Copyright 2022 The Kubernetes Authors. 3 4 Licensed under the Apache License, Version 2.0 (the "License"); 5 you may not use this file except in compliance with the License. 6 You may obtain a copy of the License at 7 8 http://www.apache.org/licenses/LICENSE-2.0 9 10 Unless required by applicable law or agreed to in writing, software 11 distributed under the License is distributed on an "AS IS" BASIS, 12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 See the License for the specific language governing permissions and 14 limitations under the License. 15 */ 16 17 package v1beta1 18 19 import ( 20 "fmt" 21 "os" 22 23 core "k8s.io/api/core/v1" 24 "k8s.io/klog/v2" 25 api "k8s.io/kubelet/pkg/apis/deviceplugin/v1beta1" 26 v1helper "k8s.io/kubernetes/pkg/apis/core/v1/helper" 27 "k8s.io/kubernetes/pkg/kubelet/pluginmanager/cache" 28 ) 29 30 func (s *server) GetPluginHandler() cache.PluginHandler { 31 if f, err := os.Create(s.socketDir + "DEPRECATION"); err != nil { 32 klog.ErrorS(err, "Failed to create deprecation file at socket dir", "path", s.socketDir) 33 } else { 34 f.Close() 35 klog.V(4).InfoS("Created deprecation file", "path", f.Name()) 36 } 37 return s 38 } 39 40 func (s *server) RegisterPlugin(pluginName string, endpoint string, versions []string) error { 41 klog.V(2).InfoS("Registering plugin at endpoint", "plugin", pluginName, "endpoint", endpoint) 42 return s.connectClient(pluginName, endpoint) 43 } 44 45 func (s *server) DeRegisterPlugin(pluginName string) { 46 klog.V(2).InfoS("Deregistering plugin", "plugin", pluginName) 47 client := s.getClient(pluginName) 48 if client != nil { 49 s.disconnectClient(pluginName, client) 50 } 51 } 52 53 func (s *server) ValidatePlugin(pluginName string, endpoint string, versions []string) error { 54 klog.V(2).InfoS("Got plugin at endpoint with versions", "plugin", pluginName, "endpoint", endpoint, "versions", versions) 55 56 if !s.isVersionCompatibleWithPlugin(versions...) { 57 return fmt.Errorf("manager version, %s, is not among plugin supported versions %v", api.Version, versions) 58 } 59 60 if !v1helper.IsExtendedResourceName(core.ResourceName(pluginName)) { 61 return fmt.Errorf("invalid name of device plugin socket: %s", fmt.Sprintf(errInvalidResourceName, pluginName)) 62 } 63 64 return nil 65 } 66 67 func (s *server) connectClient(name string, socketPath string) error { 68 c := NewPluginClient(name, socketPath, s.chandler) 69 70 s.registerClient(name, c) 71 if err := c.Connect(); err != nil { 72 s.deregisterClient(name) 73 klog.ErrorS(err, "Failed to connect to new client", "resource", name) 74 return err 75 } 76 77 go func() { 78 s.runClient(name, c) 79 }() 80 81 return nil 82 } 83 84 func (s *server) disconnectClient(name string, c Client) error { 85 s.deregisterClient(name) 86 return c.Disconnect() 87 } 88 89 func (s *server) registerClient(name string, c Client) { 90 s.mutex.Lock() 91 defer s.mutex.Unlock() 92 93 s.clients[name] = c 94 klog.V(2).InfoS("Registered client", "name", name) 95 } 96 97 func (s *server) deregisterClient(name string) { 98 s.mutex.Lock() 99 defer s.mutex.Unlock() 100 101 delete(s.clients, name) 102 klog.V(2).InfoS("Deregistered client", "name", name) 103 } 104 105 func (s *server) runClient(name string, c Client) { 106 c.Run() 107 108 c = s.getClient(name) 109 if c == nil { 110 return 111 } 112 113 if err := s.disconnectClient(name, c); err != nil { 114 klog.V(2).InfoS("Unable to disconnect client", "resource", name, "client", c, "err", err) 115 } 116 } 117 118 func (s *server) getClient(name string) Client { 119 s.mutex.Lock() 120 defer s.mutex.Unlock() 121 return s.clients[name] 122 }