k8s.io/kubernetes@v1.31.0-alpha.0.0.20240520171757-56147500dadc/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  	"time"
    23  
    24  	core "k8s.io/api/core/v1"
    25  	"k8s.io/klog/v2"
    26  	api "k8s.io/kubelet/pkg/apis/deviceplugin/v1beta1"
    27  	v1helper "k8s.io/kubernetes/pkg/apis/core/v1/helper"
    28  	"k8s.io/kubernetes/pkg/kubelet/pluginmanager/cache"
    29  )
    30  
    31  func (s *server) GetPluginHandler() cache.PluginHandler {
    32  	if f, err := os.Create(s.socketDir + "DEPRECATION"); err != nil {
    33  		klog.ErrorS(err, "Failed to create deprecation file at socket dir", "path", s.socketDir)
    34  	} else {
    35  		f.Close()
    36  		klog.V(4).InfoS("Created deprecation file", "path", f.Name())
    37  	}
    38  	return s
    39  }
    40  
    41  func (s *server) RegisterPlugin(pluginName string, endpoint string, versions []string, pluginClientTimeout *time.Duration) error {
    42  	klog.V(2).InfoS("Registering plugin at endpoint", "plugin", pluginName, "endpoint", endpoint)
    43  	return s.connectClient(pluginName, endpoint)
    44  }
    45  
    46  func (s *server) DeRegisterPlugin(pluginName string) {
    47  	klog.V(2).InfoS("Deregistering plugin", "plugin", pluginName)
    48  	client := s.getClient(pluginName)
    49  	if client != nil {
    50  		s.disconnectClient(pluginName, client)
    51  	}
    52  }
    53  
    54  func (s *server) ValidatePlugin(pluginName string, endpoint string, versions []string) error {
    55  	klog.V(2).InfoS("Got plugin at endpoint with versions", "plugin", pluginName, "endpoint", endpoint, "versions", versions)
    56  
    57  	if !s.isVersionCompatibleWithPlugin(versions...) {
    58  		return fmt.Errorf("manager version, %s, is not among plugin supported versions %v", api.Version, versions)
    59  	}
    60  
    61  	if !v1helper.IsExtendedResourceName(core.ResourceName(pluginName)) {
    62  		return fmt.Errorf("invalid name of device plugin socket: %s", fmt.Sprintf(errInvalidResourceName, pluginName))
    63  	}
    64  
    65  	return nil
    66  }
    67  
    68  func (s *server) connectClient(name string, socketPath string) error {
    69  	c := NewPluginClient(name, socketPath, s.chandler)
    70  
    71  	s.registerClient(name, c)
    72  	if err := c.Connect(); err != nil {
    73  		s.deregisterClient(name)
    74  		klog.ErrorS(err, "Failed to connect to new client", "resource", name)
    75  		return err
    76  	}
    77  
    78  	go func() {
    79  		s.runClient(name, c)
    80  	}()
    81  
    82  	return nil
    83  }
    84  
    85  func (s *server) disconnectClient(name string, c Client) error {
    86  	s.deregisterClient(name)
    87  	return c.Disconnect()
    88  }
    89  
    90  func (s *server) registerClient(name string, c Client) {
    91  	s.mutex.Lock()
    92  	defer s.mutex.Unlock()
    93  
    94  	s.clients[name] = c
    95  	klog.V(2).InfoS("Registered client", "name", name)
    96  }
    97  
    98  func (s *server) deregisterClient(name string) {
    99  	s.mutex.Lock()
   100  	defer s.mutex.Unlock()
   101  
   102  	delete(s.clients, name)
   103  	klog.V(2).InfoS("Deregistered client", "name", name)
   104  }
   105  
   106  func (s *server) runClient(name string, c Client) {
   107  	c.Run()
   108  
   109  	c = s.getClient(name)
   110  	if c == nil {
   111  		return
   112  	}
   113  
   114  	if err := s.disconnectClient(name, c); err != nil {
   115  		klog.V(2).InfoS("Unable to disconnect client", "resource", name, "client", c, "err", err)
   116  	}
   117  }
   118  
   119  func (s *server) getClient(name string) Client {
   120  	s.mutex.Lock()
   121  	defer s.mutex.Unlock()
   122  	return s.clients[name]
   123  }