]> git.apps.os.sepia.ceph.com Git - ceph-ci.git/commitdiff
common, osd: Remove unused implementation of mClockPriorityQueue
authorSridhar Seshasayee <sseshasa@redhat.com>
Mon, 9 Oct 2023 18:12:32 +0000 (23:42 +0530)
committerSridhar Seshasayee <sseshasa@redhat.com>
Mon, 13 Nov 2023 18:55:14 +0000 (00:25 +0530)
mClockPriorityQueue (mClockQueue class) is an older mClock implementation
of the OpQueue abstraction. This was replaced by a simpler implementation
of the OpScheduler abstraction as part of
https://github.com/ceph/ceph/pull/30650.

The simpler implementation of mClockScheduler is being currently used.
This commit removes the unused src/common/mClockPriorityQueue.h along
with the associated unit test file: test_mclock_priority_queue.cc.

Other miscellaneous changes,
 - Remove the cmake references to the unit test file
 - Remove the inclusion of the header file in mClockScheduler.h

Signed-off-by: Sridhar Seshasayee <sseshasa@redhat.com>
src/common/mClockPriorityQueue.h [deleted file]
src/osd/scheduler/mClockScheduler.h
src/test/common/CMakeLists.txt
src/test/common/test_mclock_priority_queue.cc [deleted file]

diff --git a/src/common/mClockPriorityQueue.h b/src/common/mClockPriorityQueue.h
deleted file mode 100644 (file)
index c1f9f3c..0000000
+++ /dev/null
@@ -1,369 +0,0 @@
-// -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
-// vim: ts=8 sw=2 smarttab
-/*
- * Ceph - scalable distributed file system
- *
- * Copyright (C) 2016 Red Hat Inc.
- *
- * This is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License version 2.1, as published by the Free Software
- * Foundation.  See file COPYING.
- *
- */
-
-#pragma once
-
-
-#include <functional>
-#include <map>
-#include <list>
-#include <cmath>
-
-#include "common/Formatter.h"
-#include "common/OpQueue.h"
-
-#include "dmclock/src/dmclock_server.h"
-
-// the following is done to unclobber _ASSERT_H so it returns to the
-// way ceph likes it
-#include "include/ceph_assert.h"
-
-
-namespace ceph {
-
-  namespace dmc = crimson::dmclock;
-
-  template <typename T, typename K>
-  class mClockQueue : public OpQueue <T, K> {
-
-    using priority_t = unsigned;
-    using cost_t = unsigned;
-
-    typedef std::list<std::pair<cost_t, T> > ListPairs;
-
-    static void filter_list_pairs(ListPairs *l,
-                                 std::function<bool (T&&)> f) {
-      for (typename ListPairs::iterator i = l->end();
-          i != l->begin();
-          /* no inc */
-       ) {
-       auto next = i;
-       --next;
-       if (f(std::move(next->second))) {
-         l->erase(next);
-       } else {
-         i = next;
-       }
-      }
-    }
-
-    struct SubQueue {
-    private:
-      typedef std::map<K, ListPairs> Classes;
-      // client-class to ordered queue
-      Classes q;
-
-      unsigned tokens, max_tokens;
-
-      typename Classes::iterator cur;
-
-    public:
-
-      SubQueue(const SubQueue &other)
-       : q(other.q),
-         tokens(other.tokens),
-         max_tokens(other.max_tokens),
-         cur(q.begin()) {}
-
-      SubQueue()
-       : tokens(0),
-         max_tokens(0),
-         cur(q.begin()) {}
-
-      void set_max_tokens(unsigned mt) {
-       max_tokens = mt;
-      }
-
-      unsigned get_max_tokens() const {
-       return max_tokens;
-      }
-
-      unsigned num_tokens() const {
-       return tokens;
-      }
-
-      void put_tokens(unsigned t) {
-       tokens += t;
-       if (tokens > max_tokens) {
-         tokens = max_tokens;
-       }
-      }
-
-      void take_tokens(unsigned t) {
-       if (tokens > t) {
-         tokens -= t;
-       } else {
-         tokens = 0;
-       }
-      }
-
-      void enqueue(K cl, cost_t cost, T&& item) {
-       q[cl].emplace_back(cost, std::move(item));
-       if (cur == q.end())
-         cur = q.begin();
-      }
-
-      void enqueue_front(K cl, cost_t cost, T&& item) {
-       q[cl].emplace_front(cost, std::move(item));
-       if (cur == q.end())
-         cur = q.begin();
-      }
-
-      const std::pair<cost_t, T>& front() const {
-       ceph_assert(!(q.empty()));
-       ceph_assert(cur != q.end());
-       return cur->second.front();
-      }
-
-      std::pair<cost_t, T>& front() {
-       ceph_assert(!(q.empty()));
-       ceph_assert(cur != q.end());
-       return cur->second.front();
-      }
-
-      void pop_front() {
-       ceph_assert(!(q.empty()));
-       ceph_assert(cur != q.end());
-       cur->second.pop_front();
-       if (cur->second.empty()) {
-         auto i = cur;
-         ++cur;
-         q.erase(i);
-       } else {
-         ++cur;
-       }
-       if (cur == q.end()) {
-         cur = q.begin();
-       }
-      }
-
-      unsigned get_size_slow() const {
-       unsigned count = 0;
-       for (const auto& cls : q) {
-         count += cls.second.size();
-       }
-       return count;
-      }
-
-      bool empty() const {
-       return q.empty();
-      }
-
-      void remove_by_filter(std::function<bool (T&&)> f) {
-       for (typename Classes::iterator i = q.begin();
-            i != q.end();
-            /* no-inc */) {
-         filter_list_pairs(&(i->second), f);
-         if (i->second.empty()) {
-           if (cur == i) {
-             ++cur;
-           }
-           i = q.erase(i);
-         } else {
-           ++i;
-         }
-       }
-       if (cur == q.end()) cur = q.begin();
-      }
-
-      void remove_by_class(K k, std::list<T> *out) {
-       typename Classes::iterator i = q.find(k);
-       if (i == q.end()) {
-         return;
-       }
-       if (i == cur) {
-         ++cur;
-       }
-       if (out) {
-         for (auto j = i->second.rbegin(); j != i->second.rend(); ++j) {
-           out->push_front(std::move(j->second));
-         }
-       }
-       q.erase(i);
-       if (cur == q.end()) cur = q.begin();
-      }
-
-      void dump(ceph::Formatter *f) const {
-       f->dump_int("size", get_size_slow());
-       f->dump_int("num_keys", q.size());
-      }
-    };
-
-    using SubQueues = std::map<priority_t, SubQueue>;
-
-    SubQueues high_queue;
-
-    using Queue = dmc::PullPriorityQueue<K,T,false>;
-    Queue queue;
-
-    // when enqueue_front is called, rather than try to re-calc tags
-    // to put in mClock priority queue, we'll just keep a separate
-    // list from which we dequeue items first, and only when it's
-    // empty do we use queue.
-    std::list<std::pair<K,T>> queue_front;
-
-  public:
-
-    mClockQueue(
-      const typename Queue::ClientInfoFunc& info_func,
-      double anticipation_timeout = 0.0) :
-      queue(info_func, dmc::AtLimit::Allow, anticipation_timeout)
-    {
-      // empty
-    }
-
-    unsigned get_size_slow() const {
-      unsigned total = 0;
-      total += queue_front.size();
-      total += queue.request_count();
-      for (auto i = high_queue.cbegin(); i != high_queue.cend(); ++i) {
-       ceph_assert(i->second.get_size_slow());
-       total += i->second.get_size_slow();
-      }
-      return total;
-    }
-
-    // be sure to do things in reverse priority order and push_front
-    // to the list so items end up on list in front-to-back priority
-    // order
-    void remove_by_filter(std::function<bool (T&&)> filter_accum) {
-      queue.remove_by_req_filter([&] (std::unique_ptr<T>&& r) {
-          return filter_accum(std::move(*r));
-        }, true);
-
-      for (auto i = queue_front.rbegin(); i != queue_front.rend(); /* no-inc */) {
-       if (filter_accum(std::move(i->second))) {
-         i = decltype(i){ queue_front.erase(std::next(i).base()) };
-       } else {
-         ++i;
-       }
-      }
-
-      for (typename SubQueues::iterator i = high_queue.begin();
-          i != high_queue.end();
-          /* no-inc */ ) {
-       i->second.remove_by_filter(filter_accum);
-       if (i->second.empty()) {
-         i = high_queue.erase(i);
-       } else {
-         ++i;
-       }
-      }
-    }
-
-    void remove_by_class(K k, std::list<T> *out = nullptr) override final {
-      if (out) {
-       queue.remove_by_client(k,
-                              true,
-                              [&out] (std::unique_ptr<T>&& t) {
-                                out->push_front(std::move(*t));
-                              });
-      } else {
-       queue.remove_by_client(k, true);
-      }
-
-      for (auto i = queue_front.rbegin(); i != queue_front.rend(); /* no-inc */) {
-       if (k == i->first) {
-         if (nullptr != out) out->push_front(std::move(i->second));
-         i = decltype(i){ queue_front.erase(std::next(i).base()) };
-       } else {
-         ++i;
-       }
-      }
-
-      for (auto i = high_queue.begin(); i != high_queue.end(); /* no-inc */) {
-       i->second.remove_by_class(k, out);
-       if (i->second.empty()) {
-         i = high_queue.erase(i);
-       } else {
-         ++i;
-       }
-      }
-    }
-
-    void enqueue_strict(K cl, unsigned priority, T&& item) override final {
-      high_queue[priority].enqueue(cl, 1, std::move(item));
-    }
-
-    void enqueue_strict_front(K cl, unsigned priority, T&& item) override final {
-      high_queue[priority].enqueue_front(cl, 1, std::move(item));
-    }
-
-    void enqueue(K cl, unsigned priority, unsigned cost, T&& item) override final {
-      // priority is ignored
-      queue.add_request(std::move(item), cl, cost);
-    }
-
-    void enqueue_front(K cl,
-                      unsigned priority,
-                      unsigned cost,
-                      T&& item) override final {
-      queue_front.emplace_front(std::pair<K,T>(cl, std::move(item)));
-    }
-
-    bool empty() const override final {
-      return queue.empty() && high_queue.empty() && queue_front.empty();
-    }
-
-    T dequeue() override final {
-      ceph_assert(!empty());
-
-      if (!high_queue.empty()) {
-       T ret = std::move(high_queue.rbegin()->second.front().second);
-       high_queue.rbegin()->second.pop_front();
-       if (high_queue.rbegin()->second.empty()) {
-         high_queue.erase(high_queue.rbegin()->first);
-       }
-       return ret;
-      }
-
-      if (!queue_front.empty()) {
-       T ret = std::move(queue_front.front().second);
-       queue_front.pop_front();
-       return ret;
-      }
-
-      auto pr = queue.pull_request();
-      ceph_assert(pr.is_retn());
-      auto& retn = pr.get_retn();
-      return std::move(*(retn.request));
-    }
-
-    void dump(ceph::Formatter *f) const override final {
-      f->open_array_section("high_queues");
-      for (typename SubQueues::const_iterator p = high_queue.begin();
-          p != high_queue.end();
-          ++p) {
-       f->open_object_section("subqueue");
-       f->dump_int("priority", p->first);
-       p->second.dump(f);
-       f->close_section();
-      }
-      f->close_section();
-
-      f->open_object_section("queue_front");
-      f->dump_int("size", queue_front.size());
-      f->close_section();
-
-      f->open_object_section("queue");
-      f->dump_int("size", queue.request_count());
-      f->close_section();
-    } // dump
-
-    void print(std::ostream &os) const final {
-      os << "mClockPriorityQueue";
-    }
-  };
-
-} // namespace ceph
index f708b1d7a1e38cdb487d0c723b97835000db866b..c1aca5da5d143ab5c124c858c246671b3bc380af 100644 (file)
@@ -27,7 +27,6 @@
 #include "osd/scheduler/OpScheduler.h"
 #include "common/config.h"
 #include "common/ceph_context.h"
-#include "common/mClockPriorityQueue.h"
 #include "osd/scheduler/OpSchedulerItem.h"
 
 
index c044daf662ab7f25341ddd1e060905d491f25ef4..450827116dca1a35b406cc7d663a4abe5b6aceb3 100644 (file)
@@ -75,17 +75,6 @@ add_executable(unittest_prioritized_queue
 target_link_libraries(unittest_prioritized_queue ceph-common)
 add_ceph_unittest(unittest_prioritized_queue)
 
-if(NOT WIN32)
-# unittest_mclock_priority_queue
-add_executable(unittest_mclock_priority_queue
-  test_mclock_priority_queue.cc
-  )
-add_ceph_unittest(unittest_mclock_priority_queue)
-target_link_libraries(unittest_mclock_priority_queue
-  ceph-common
-  dmclock::dmclock)
-endif(NOT WIN32)
-
 # unittest_str_map
 add_executable(unittest_str_map
   test_str_map.cc
diff --git a/src/test/common/test_mclock_priority_queue.cc b/src/test/common/test_mclock_priority_queue.cc
deleted file mode 100644 (file)
index 8e8bcdf..0000000
+++ /dev/null
@@ -1,320 +0,0 @@
-// -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
-// vim: ts=8 sw=2 smarttab
-/*
- * Ceph - scalable distributed file system
- *
- * Copyright (C) 2017 Red Hat Inc.
- *
- * This is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License version 2.1, as published by the Free Software
- * Foundation.  See file COPYING.
- *
- */
-
-#include <thread>
-#include <chrono>
-#include <iostream>
-#include "gtest/gtest.h"
-#include "common/mClockPriorityQueue.h"
-
-
-struct Request {
-  int value;
-  Request() :
-    value(0)
-  {}
-  Request(const Request& o) = default;
-  explicit Request(int value) :
-    value(value)
-  {}
-};
-
-
-struct Client {
-  int client_num;
-  Client() :
-    Client(-1)
-  {}
-  Client(int client_num) :
-    client_num(client_num)
-  {}
-  friend bool operator<(const Client& r1, const Client& r2) {
-    return r1.client_num < r2.client_num;
-  }
-  friend bool operator==(const Client& r1, const Client& r2) {
-    return r1.client_num == r2.client_num;
-  }
-};
-
-
-const crimson::dmclock::ClientInfo* client_info_func(const Client& c) {
-  static const crimson::dmclock::ClientInfo
-    the_info(10.0, 10.0, 10.0);
-  return &the_info;
-}
-
-
-TEST(mClockPriorityQueue, Create)
-{
-  ceph::mClockQueue<Request,Client> q(&client_info_func);
-}
-
-
-TEST(mClockPriorityQueue, Sizes)
-{
-  ceph::mClockQueue<Request,Client> q(&client_info_func);
-
-  ASSERT_TRUE(q.empty());
-  ASSERT_EQ(0u, q.get_size_slow());
-
-  Client c1(1);
-  Client c2(2);
-
-  q.enqueue_strict(c1, 1, Request(1));
-  q.enqueue_strict(c2, 2, Request(2));
-  q.enqueue_strict(c1, 2, Request(3));
-  q.enqueue(c2, 1, 1u, Request(4));
-  q.enqueue(c1, 2, 1u, Request(5));
-  q.enqueue_strict(c2, 1, Request(6));
-
-  ASSERT_FALSE(q.empty());
-  ASSERT_EQ(6u, q.get_size_slow());
-
-
-  for (int i = 0; i < 6; ++i) {
-    (void) q.dequeue();
-  }
-
-  ASSERT_TRUE(q.empty());
-  ASSERT_EQ(0u, q.get_size_slow());
-}
-
-
-TEST(mClockPriorityQueue, JustStrict)
-{
-  ceph::mClockQueue<Request,Client> q(&client_info_func);
-
-  Client c1(1);
-  Client c2(2);
-
-  q.enqueue_strict(c1, 1, Request(1));
-  q.enqueue_strict(c2, 2, Request(2));
-  q.enqueue_strict(c1, 2, Request(3));
-  q.enqueue_strict(c2, 1, Request(4));
-
-  Request r;
-
-  r = q.dequeue();
-  ASSERT_EQ(2, r.value);
-  r = q.dequeue();
-  ASSERT_EQ(3, r.value);
-  r = q.dequeue();
-  ASSERT_EQ(1, r.value);
-  r = q.dequeue();
-  ASSERT_EQ(4, r.value);
-}
-
-
-TEST(mClockPriorityQueue, StrictPriorities)
-{
-  ceph::mClockQueue<Request,Client> q(&client_info_func);
-
-  Client c1(1);
-  Client c2(2);
-
-  q.enqueue_strict(c1, 1, Request(1));
-  q.enqueue_strict(c2, 2, Request(2));
-  q.enqueue_strict(c1, 3, Request(3));
-  q.enqueue_strict(c2, 4, Request(4));
-
-  Request r;
-
-  r = q.dequeue();
-  ASSERT_EQ(4, r.value);
-  r = q.dequeue();
-  ASSERT_EQ(3, r.value);
-  r = q.dequeue();
-  ASSERT_EQ(2, r.value);
-  r = q.dequeue();
-  ASSERT_EQ(1, r.value);
-}
-
-
-TEST(mClockPriorityQueue, JustNotStrict)
-{
-  ceph::mClockQueue<Request,Client> q(&client_info_func);
-
-  Client c1(1);
-  Client c2(2);
-
-  // non-strict queue ignores priorites, but will divide between
-  // clients evenly and maintain orders between clients
-  q.enqueue(c1, 1, 1u, Request(1));
-  q.enqueue(c1, 2, 1u, Request(2));
-  q.enqueue(c2, 3, 1u, Request(3));
-  q.enqueue(c2, 4, 1u, Request(4));
-
-  Request r1, r2;
-
-  r1 = q.dequeue();
-  ASSERT_TRUE(1 == r1.value || 3 == r1.value);
-
-  r2 = q.dequeue();
-  ASSERT_TRUE(1 == r2.value || 3 == r2.value);
-
-  ASSERT_NE(r1.value, r2.value);
-
-  r1 = q.dequeue();
-  ASSERT_TRUE(2 == r1.value || 4 == r1.value);
-
-  r2 = q.dequeue();
-  ASSERT_TRUE(2 == r2.value || 4 == r2.value);
-
-  ASSERT_NE(r1.value, r2.value);
-}
-
-
-TEST(mClockPriorityQueue, EnqueuFront)
-{
-  ceph::mClockQueue<Request,Client> q(&client_info_func);
-
-  Client c1(1);
-  Client c2(2);
-
-  // non-strict queue ignores priorites, but will divide between
-  // clients evenly and maintain orders between clients
-  q.enqueue(c1, 1, 1u, Request(1));
-  q.enqueue(c1, 2, 1u, Request(2));
-  q.enqueue(c2, 3, 1u, Request(3));
-  q.enqueue(c2, 4, 1u, Request(4));
-  q.enqueue_strict(c2, 6, Request(6));
-  q.enqueue_strict(c1, 7, Request(7));
-
-  std::list<Request> reqs;
-
-  for (uint i = 0; i < 4; ++i) {
-    reqs.emplace_back(q.dequeue());
-  }
-
-  for (uint i = 0; i < 4; ++i) {
-    Request& r = reqs.front();
-    if (r.value > 5) {
-      q.enqueue_strict_front(r.value == 6 ? c2 : 1, r.value, std::move(r));
-    } else {
-      q.enqueue_front(r.value <= 2 ? c1 : c2, r.value, 0, std::move(r));
-    }
-    reqs.pop_front();
-  }
-
-  Request r;
-
-  r = q.dequeue();
-  ASSERT_EQ(7, r.value);
-
-  r = q.dequeue();
-  ASSERT_EQ(6, r.value);
-
-  r = q.dequeue();
-  ASSERT_TRUE(1 == r.value || 3 == r.value);
-
-  r = q.dequeue();
-  ASSERT_TRUE(1 == r.value || 3 == r.value);
-
-  r = q.dequeue();
-  ASSERT_TRUE(2 == r.value || 4 == r.value);
-
-  r = q.dequeue();
-  ASSERT_TRUE(2 == r.value || 4 == r.value);
-}
-
-
-TEST(mClockPriorityQueue, RemoveByClass)
-{
-  ceph::mClockQueue<Request,Client> q(&client_info_func);
-
-  Client c1(1);
-  Client c2(2);
-  Client c3(3);
-
-  q.enqueue(c1, 1, 1u, Request(1));
-  q.enqueue(c2, 1, 1u, Request(2));
-  q.enqueue(c3, 1, 1u, Request(4));
-  q.enqueue_strict(c1, 2, Request(8));
-  q.enqueue_strict(c2, 1, Request(16));
-  q.enqueue_strict(c3, 3, Request(32));
-  q.enqueue(c3, 1, 1u, Request(64));
-  q.enqueue(c2, 1, 1u, Request(128));
-  q.enqueue(c1, 1, 1u, Request(256));
-
-  int out_mask = 2 | 16 | 128;
-  int in_mask = 1 | 8 | 256;
-
-  std::list<Request> out;
-  q.remove_by_class(c2, &out);
-
-  ASSERT_EQ(3u, out.size());
-  while (!out.empty()) {
-    ASSERT_TRUE((out.front().value & out_mask) > 0) <<
-      "had value that was not expected after first removal";
-    out.pop_front();
-  }
-
-  ASSERT_EQ(6u, q.get_size_slow()) << "after removal of three from client c2";
-
-  q.remove_by_class(c3);
-
-  ASSERT_EQ(3u, q.get_size_slow()) << "after removal of three from client c3";
-  while (!q.empty()) {
-    Request r = q.dequeue();
-    ASSERT_TRUE((r.value & in_mask) > 0) <<
-      "had value that was not expected after two removals";
-  }
-}
-
-
-TEST(mClockPriorityQueue, RemoveByFilter)
-{
-  ceph::mClockQueue<Request,Client> q(&client_info_func);
-
-  Client c1(1);
-  Client c2(2);
-  Client c3(3);
-
-  q.enqueue(c1, 1, 1u, Request(1));
-  q.enqueue(c2, 1, 1u, Request(2));
-  q.enqueue(c3, 1, 1u, Request(3));
-  q.enqueue_strict(c1, 2, Request(4));
-  q.enqueue_strict(c2, 1, Request(5));
-  q.enqueue_strict(c3, 3, Request(6));
-  q.enqueue(c3, 1, 1u, Request(7));
-  q.enqueue(c2, 1, 1u, Request(8));
-  q.enqueue(c1, 1, 1u, Request(9));
-
-  std::list<Request> filtered;
-
-  q.remove_by_filter([&](const Request& r) -> bool {
-    if (r.value & 2) {
-      filtered.push_back(r);
-      return true;
-    } else {
-      return false;
-    }
-  });
-
-  ASSERT_EQ(4u, filtered.size()) <<
-    "filter should have removed four elements";
-  while (!filtered.empty()) {
-    ASSERT_TRUE((filtered.front().value & 2) > 0) <<
-      "expect this value to have been filtered out";
-    filtered.pop_front();
-  }
-
-  ASSERT_EQ(5u, q.get_size_slow()) <<
-    "filter should have left five remaining elements";
-  while (!q.empty()) {
-    Request r = q.dequeue();
-    ASSERT_TRUE((r.value & 2) == 0) <<
-      "expect this value to have been left in";
-   }
-}