aspired_version_policy.h

/* Copyright 2016 Google Inc. All Rights Reserved.
 
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.
==============================================================================*/
 
#ifndef TENSORFLOW_SERVING_CORE_ASPIRED_VERSION_POLICY_H_
#define TENSORFLOW_SERVING_CORE_ASPIRED_VERSION_POLICY_H_
 
#include <string>
#include <vector>
 
#include "absl/types/optional.h"
#include "tensorflow/core/lib/strings/strcat.h"
#include "tensorflow/core/platform/types.h"
#include "tensorflow_serving/core/loader_harness.h"
#include "tensorflow_serving/core/servable_id.h"
namespace tensorflow {
namespace serving {
 
struct AspiredServableStateSnapshot final {
  ServableId id;
  LoaderHarness::State state;
  bool is_aspired;
};
 
class AspiredVersionPolicy {
 public:
  enum class Action : int {
    kLoad,
    kUnload,
  };
 
  virtual ~AspiredVersionPolicy() = default;
 
  struct ServableAction final {
    Action action;
    ServableId id;
 
    string DebugString() const {
      return strings::StrCat("{ action: ", static_cast<int>(action),
                             " id: ", id.DebugString(), " }");
    }
  };
 
  virtual absl::optional<ServableAction> GetNextAction(
      const std::vector<AspiredServableStateSnapshot>& all_versions) const = 0;
 
 protected:
  static absl::optional<ServableId> GetHighestAspiredNewServableId(
      const std::vector<AspiredServableStateSnapshot>& all_versions);
 
 private:
  friend class AspiredVersionPolicyTest;
};
 
inline bool operator==(const AspiredVersionPolicy::ServableAction& lhs,
                       const AspiredVersionPolicy::ServableAction& rhs) {
  return lhs.action == rhs.action && lhs.id == rhs.id;
}
 
}  // namespace serving
}  // namespace tensorflow
 
#endif  // TENSORFLOW_SERVING_CORE_ASPIRED_VERSION_POLICY_H_