summaryrefslogtreecommitdiffstats
path: root/src/librbd/object_map/Request.h
blob: 7e9bfb88dfde0dac69ace1f14bf1cb5439247b40 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
// -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
// vim: ts=8 sw=2 smarttab

#ifndef CEPH_LIBRBD_OBJECT_MAP_REQUEST_H
#define CEPH_LIBRBD_OBJECT_MAP_REQUEST_H

#include "include/int_types.h"
#include "librbd/AsyncRequest.h"

class Context;

namespace librbd {

class ImageCtx;

namespace object_map {

class Request : public AsyncRequest<> {
public:
  Request(ImageCtx &image_ctx, uint64_t snap_id, Context *on_finish)
    : AsyncRequest(image_ctx, on_finish), m_snap_id(snap_id),
      m_state(STATE_REQUEST)
  {
  }

  void send() override = 0;

protected:
  const uint64_t m_snap_id;

  bool should_complete(int r) override;
  int filter_return_code(int r) const override {
    if (m_state == STATE_REQUEST) {
      // never propagate an error back to the caller
      return 0;
    }
    return r;
  }
  virtual void finish_request() {
  }

private:
  /**
   *              STATE_TIMEOUT --------\
   *                   ^                |
   *                   |                v
   * <start> ---> STATE_REQUEST ---> <finish>
   *                   |                ^
   *                   v                |
   *            STATE_INVALIDATE -------/
   */
  enum State {
    STATE_REQUEST,
    STATE_TIMEOUT,
    STATE_INVALIDATE
  };

  State m_state;

  bool invalidate();
};

} // namespace object_map
} // namespace librbd

#endif // CEPH_LIBRBD_OBJECT_MAP_REQUEST_H