/* Copyright 2016 The Fission Authors. Licensed 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 fscache import ( "fmt" "time" "github.com/pkg/errors" "go.uber.org/zap" apiv1 "k8s.io/api/core/v1" "k8s.io/apimachinery/pkg/api/resource" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" "k8s.io/apimachinery/pkg/types" fv1 "github.com/fission/fission/pkg/apis/core/v1" "github.com/fission/fission/pkg/cache" "github.com/fission/fission/pkg/crd" ferror "github.com/fission/fission/pkg/error" "github.com/fission/fission/pkg/poolcache" ) type fscRequestType int //type executorType int // FunctionServiceCache Request Types const ( TOUCH fscRequestType = iota LISTOLD LOG LISTOLDPOOL ) type ( // FuncSvc represents a function service FuncSvc struct { Name string // Name of object Function *metav1.ObjectMeta // function this pod/service is for Environment *fv1.Environment // function's environment Address string // Host:Port or IP:Port that the function's service can be reached at. KubernetesObjects []apiv1.ObjectReference // Kubernetes Objects (within the function namespace) Executor fv1.ExecutorType CPULimit resource.Quantity Ctime time.Time Atime time.Time } // FunctionServiceCache represents the function service cache FunctionServiceCache struct { logger *zap.Logger byFunction *cache.Cache // function-key -> funcSvc : map[string]*funcSvc byAddress *cache.Cache // address -> function : map[string]metav1.ObjectMeta byFunctionUID *cache.Cache // function uid -> function : map[string]metav1.ObjectMeta connFunctionCache *poolcache.Cache // function-key -> funcSvc : map[string]*funcSvc requestChannel chan *fscRequest } fscRequest struct { requestType fscRequestType address string age time.Duration responseChannel chan *fscResponse } fscResponse struct { objects []*FuncSvc error } ) // IsNotFoundError checks if err is ErrorNotFound. func IsNotFoundError(err error) bool { if fe, ok := err.(ferror.Error); ok { return fe.Code == ferror.ErrorNotFound } return false } // IsNameExistError checks if err is ErrorNameExists. func IsNameExistError(err error) bool { if fe, ok := err.(ferror.Error); ok { return fe.Code == ferror.ErrorNameExists } return false } // MakeFunctionServiceCache starts and returns an instance of FunctionServiceCache. func MakeFunctionServiceCache(logger *zap.Logger) *FunctionServiceCache { fsc := &FunctionServiceCache{ logger: logger.Named("function_service_cache"), byFunction: cache.MakeCache(0, 0), byAddress: cache.MakeCache(0, 0), byFunctionUID: cache.MakeCache(0, 0), connFunctionCache: poolcache.NewPoolCache(), requestChannel: make(chan *fscRequest), } go fsc.service() return fsc } func (fsc *FunctionServiceCache) service() { for { req := <-fsc.requestChannel resp := &fscResponse{} switch req.requestType { case TOUCH: // update atime for this function svc resp.error = fsc._touchByAddress(req.address) case LISTOLD: // get svcs idle for > req.age fscs := fsc.byFunction.Copy() funcObjects := make([]*FuncSvc, 0) for _, funcSvc := range fscs { fsvc := funcSvc.(*FuncSvc) if time.Since(fsvc.Atime) > req.age { funcObjects = append(funcObjects, fsvc) } } resp.objects = funcObjects case LOG: fsc.logger.Info("dumping function service cache") funcCopy := fsc.byFunction.Copy() info := []string{} for key, fsvcI := range funcCopy { fsvc := fsvcI.(*FuncSvc) for _, kubeObj := range fsvc.KubernetesObjects { info = append(info, fmt.Sprintf("%v\t%v\t%v", key, kubeObj.Kind, kubeObj.Name)) } } fsc.logger.Info("function service cache", zap.Int("item_count", len(funcCopy)), zap.Strings("cache", info)) case LISTOLDPOOL: fscs := fsc.connFunctionCache.ListAvailableValue() funcObjects := make([]*FuncSvc, 0) for _, funcSvc := range fscs { if fsvc, ok := funcSvc.(*FuncSvc); ok && time.Since(fsvc.Atime) > req.age { funcObjects = append(funcObjects, fsvc) } } resp.objects = funcObjects } req.responseChannel <- resp } } // GetByFunction gets a function service from cache using function key. func (fsc *FunctionServiceCache) GetByFunction(m *metav1.ObjectMeta) (*FuncSvc, error) { key := crd.CacheKey(m) fsvcI, err := fsc.byFunction.Get(key) if err != nil { return nil, err } // update atime fsvc := fsvcI.(*FuncSvc) fsvc.Atime = time.Now() fsvcCopy := *fsvc return &fsvcCopy, nil } // GetFuncSvc gets a function service from pool cache using function key and returns number of active instances of function pod func (fsc *FunctionServiceCache) GetFuncSvc(m *metav1.ObjectMeta, requestsPerPod int) (*FuncSvc, int, error) { key := crd.CacheKey(m) fsvcI, active, err := fsc.connFunctionCache.GetValue(key, requestsPerPod) if err != nil { fsc.logger.Info("Not found in Cache") return nil, active, err } // update atime fsvc := fsvcI.(*FuncSvc) fsvc.Atime = time.Now() fsvcCopy := *fsvc return &fsvcCopy, active, nil } // GetByFunctionUID gets a function service from cache using function UUID. func (fsc *FunctionServiceCache) GetByFunctionUID(uid types.UID) (*FuncSvc, error) { mI, err := fsc.byFunctionUID.Get(uid) if err != nil { return nil, err } m := mI.(metav1.ObjectMeta) fsvcI, err := fsc.byFunction.Get(crd.CacheKey(&m)) if err != nil { return nil, err } // update atime fsvc := fsvcI.(*FuncSvc) fsvc.Atime = time.Now() fsvcCopy := *fsvc return &fsvcCopy, nil } // AddFunc adds a function service to pool cache. func (fsc *FunctionServiceCache) AddFunc(fsvc FuncSvc) { fsc.connFunctionCache.SetValue(crd.CacheKey(fsvc.Function), fsvc.Address, &fsvc, fsvc.CPULimit) now := time.Now() fsvc.Ctime = now fsvc.Atime = now fsc.setFuncAlive(fsvc.Function.Name, string(fsvc.Function.UID), true) } // SetCPUUtilizaton updates/sets CPUutilization in the pool cache func (fsc *FunctionServiceCache) SetCPUUtilizaton(key string, svcHost string, cpuUsage resource.Quantity) { fsc.connFunctionCache.SetCPUUtilization(key, svcHost, cpuUsage) } // MarkAvailable marks the value at key [function][address] as available. func (fsc *FunctionServiceCache) MarkAvailable(key string, svcHost string) { fsc.connFunctionCache.MarkAvailable(key, svcHost) } // Add adds a function service to cache if it does not exist already. func (fsc *FunctionServiceCache) Add(fsvc FuncSvc) (*FuncSvc, error) { existing, err := fsc.byFunction.Set(crd.CacheKey(fsvc.Function), &fsvc) if err != nil { if IsNameExistError(err) { f := existing.(*FuncSvc) err2 := fsc.TouchByAddress(f.Address) if err2 != nil { return nil, err2 } fCopy := *f return &fCopy, nil } return nil, err } now := time.Now() fsvc.Ctime = now fsvc.Atime = now // Add to byAddress cache. Ignore NameExists errors // because of multiple-specialization. See issue #331. _, err = fsc.byAddress.Set(fsvc.Address, *fsvc.Function) if err != nil { if IsNameExistError(err) { err = nil } else { err = errors.Wrap(err, "error caching fsvc") } return nil, err } // Add to byFunctionUID cache. Ignore NameExists errors // because of multiple-specialization. See issue #331. _, err = fsc.byFunctionUID.Set(fsvc.Function.UID, *fsvc.Function) if err != nil { if IsNameExistError(err) { err = nil } else { err = errors.Wrap(err, "error caching fsvc by function uid") } return nil, err } fsc.setFuncAlive(fsvc.Function.Name, string(fsvc.Function.UID), true) return nil, nil } // TouchByAddress makes a TOUCH request to given address. func (fsc *FunctionServiceCache) TouchByAddress(address string) error { responseChannel := make(chan *fscResponse) fsc.requestChannel <- &fscRequest{ requestType: TOUCH, address: address, responseChannel: responseChannel, } resp := <-responseChannel return resp.error } func (fsc *FunctionServiceCache) _touchByAddress(address string) error { mI, err := fsc.byAddress.Get(address) if err != nil { return err } m := mI.(metav1.ObjectMeta) fsvcI, err := fsc.byFunction.Get(crd.CacheKey(&m)) if err != nil { return err } fsvc := fsvcI.(*FuncSvc) fsvc.Atime = time.Now() return nil } // DeleteEntry deletes a function service from cache. func (fsc *FunctionServiceCache) DeleteEntry(fsvc *FuncSvc) { msg := "error deleting function service" err := fsc.byFunction.Delete(crd.CacheKey(fsvc.Function)) if err != nil { fsc.logger.Error( msg, zap.String("function", fsvc.Function.Name), zap.Error(err), ) } err = fsc.byAddress.Delete(fsvc.Address) if err != nil { fsc.logger.Error( msg, zap.String("function", fsvc.Function.Name), zap.Error(err), ) } err = fsc.byFunctionUID.Delete(fsvc.Function.UID) if err != nil { fsc.logger.Error( msg, zap.String("function", fsvc.Function.Name), zap.Error(err), ) } fsc.observeFuncRunningTime(fsvc.Function.Name, string(fsvc.Function.UID), fsvc.Atime.Sub(fsvc.Ctime).Seconds()) fsc.observeFuncAliveTime(fsvc.Function.Name, string(fsvc.Function.UID), time.Since(fsvc.Ctime).Seconds()) fsc.setFuncAlive(fsvc.Function.Name, string(fsvc.Function.UID), false) } // DeleteFunctionSvc deletes a function service at key composed of [function][address]. func (fsc *FunctionServiceCache) DeleteFunctionSvc(fsvc *FuncSvc) { err := fsc.connFunctionCache.DeleteValue(crd.CacheKey(fsvc.Function), fsvc.Address) if err != nil { fsc.logger.Error( "error deleting function service", zap.Any("function", fsvc.Function.Name), zap.Any("address", fsvc.Address), zap.Error(err), ) } } func (fsc *FunctionServiceCache) SetCPUUtilization(key string, svcHost string, cpuUsage resource.Quantity) { fsc.connFunctionCache.SetCPUUtilization(key, svcHost, cpuUsage) } // DeleteOld deletes aged function service entries from cache. func (fsc *FunctionServiceCache) DeleteOld(fsvc *FuncSvc, minAge time.Duration) (bool, error) { if time.Since(fsvc.Atime) < minAge { return false, nil } fsc.DeleteEntry(fsvc) return true, nil } // DeleteOldPoolCache deletes aged function service entries from pool cache. func (fsc *FunctionServiceCache) DeleteOldPoolCache(fsvc *FuncSvc, minAge time.Duration) (bool, error) { if time.Since(fsvc.Atime) < minAge { return false, nil } fsc.DeleteFunctionSvc(fsvc) return true, nil } // ListOld returns a list of aged function services in cache. func (fsc *FunctionServiceCache) ListOld(age time.Duration) ([]*FuncSvc, error) { responseChannel := make(chan *fscResponse) fsc.requestChannel <- &fscRequest{ requestType: LISTOLD, age: age, responseChannel: responseChannel, } resp := <-responseChannel return resp.objects, resp.error } // ListOldForPool returns a list of aged function serices in cache for pooling. func (fsc *FunctionServiceCache) ListOldForPool(age time.Duration) ([]*FuncSvc, error) { responseChannel := make(chan *fscResponse) fsc.requestChannel <- &fscRequest{ requestType: LISTOLDPOOL, age: age, responseChannel: responseChannel, } resp := <-responseChannel return resp.objects, resp.error } // Log makes a LOG type cache request. func (fsc *FunctionServiceCache) Log() { fsc.logger.Info("--- FunctionService Cache Contents") responseChannel := make(chan *fscResponse) fsc.requestChannel <- &fscRequest{ requestType: LOG, responseChannel: responseChannel, } <-responseChannel fsc.logger.Info("--- FunctionService Cache Contents End") }