summaryrefslogtreecommitdiffstats
path: root/src/cls/lock/cls_lock_types.h
blob: 13f3e147810845ff6522d687b6d91bd895806cd7 (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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
// -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
// vim: ts=8 sw=2 smarttab

#ifndef CEPH_CLS_LOCK_TYPES_H
#define CEPH_CLS_LOCK_TYPES_H

#include "include/encoding.h"
#include "include/types.h"
#include "include/utime.h"
#include "msg/msg_types.h"

/* lock flags */
#define LOCK_FLAG_MAY_RENEW 0x1    /* idempotent lock acquire */
#define LOCK_FLAG_MUST_RENEW 0x2   /* lock must already be acquired */

enum class ClsLockType {
  NONE                = 0,
  EXCLUSIVE           = 1,
  SHARED              = 2,
  EXCLUSIVE_EPHEMERAL = 3, /* lock object is removed @ unlock */
};

inline const char *cls_lock_type_str(ClsLockType type)
{
    switch (type) {
      case ClsLockType::NONE:
	return "none";
      case ClsLockType::EXCLUSIVE:
	return "exclusive";
      case ClsLockType::SHARED:
	return "shared";
      case ClsLockType::EXCLUSIVE_EPHEMERAL:
	return "exclusive-ephemeral";
      default:
	return "<unknown>";
    }
}

inline bool cls_lock_is_exclusive(ClsLockType type) {
  return ClsLockType::EXCLUSIVE == type || ClsLockType::EXCLUSIVE_EPHEMERAL == type;
}

inline bool cls_lock_is_ephemeral(ClsLockType type) {
  return ClsLockType::EXCLUSIVE_EPHEMERAL == type;
}

inline bool cls_lock_is_valid(ClsLockType type) {
  return ClsLockType::SHARED == type ||
    ClsLockType::EXCLUSIVE == type ||
    ClsLockType::EXCLUSIVE_EPHEMERAL == type;
}

namespace rados {
  namespace cls {
    namespace lock {

      /*
       * locker_id_t: the locker id, needs to be unique in a single lock
       */
      struct locker_id_t {
        entity_name_t locker;   // locker's client name
	std::string cookie;          // locker's cookie.

        locker_id_t() {}
        locker_id_t(entity_name_t& _n, const std::string& _c) : locker(_n), cookie(_c) {}

        void encode(ceph::buffer::list &bl) const {
          ENCODE_START(1, 1, bl);
          encode(locker, bl);
          encode(cookie, bl);
          ENCODE_FINISH(bl);
        }
        void decode(ceph::buffer::list::const_iterator &bl) {
          DECODE_START_LEGACY_COMPAT_LEN(1, 1, 1, bl);
          decode(locker, bl);
          decode(cookie, bl);
          DECODE_FINISH(bl);
        }

        bool operator<(const locker_id_t& rhs) const {
          if (locker == rhs.locker)
            return cookie.compare(rhs.cookie) < 0;
          if (locker < rhs.locker)
            return true;
          return false;
        }
        void dump(ceph::Formatter *f) const;
	friend std::ostream& operator<<(std::ostream& out,
					const locker_id_t& data) {
	  out << data.locker;
	  return out;
	}
        static void generate_test_instances(std::list<locker_id_t*>& o);
      };
      WRITE_CLASS_ENCODER(locker_id_t)

      struct locker_info_t
      {
        utime_t expiration;  // expiration: non-zero means epoch of locker expiration
        entity_addr_t addr;  // addr: locker address
	std::string description;  // description: locker description, may be empty

        locker_info_t() {}
        locker_info_t(const utime_t& _e, const entity_addr_t& _a,
                      const std::string& _d) :  expiration(_e), addr(_a), description(_d) {}

        void encode(ceph::buffer::list &bl, uint64_t features) const {
          ENCODE_START(1, 1, bl);
          encode(expiration, bl);
          encode(addr, bl, features);
          encode(description, bl);
          ENCODE_FINISH(bl);
        }
        void decode(ceph::buffer::list::const_iterator &bl) {
          DECODE_START_LEGACY_COMPAT_LEN(1, 1, 1, bl);
          decode(expiration, bl);
          decode(addr, bl);
          decode(description, bl);
          DECODE_FINISH(bl);
        }
        void dump(ceph::Formatter *f) const;
	friend std::ostream& operator<<(std::ostream& out,
					const locker_info_t& data) {
	  using ceph::operator <<;
	  out << "{addr:" << data.addr << ", exp:";

	  const auto& exp = data.expiration;
	  if (exp.is_zero()) {
	    out << "never}";
	  } else {
	    out << exp.to_real_time() << "}";
	  }

	  return out;
	}
        static void generate_test_instances(std::list<locker_info_t *>& o);
      };
      WRITE_CLASS_ENCODER_FEATURES(locker_info_t)

      struct lock_info_t {
	std::map<locker_id_t, locker_info_t> lockers; // map of lockers
        ClsLockType lock_type;                   // lock type (exclusive / shared)
	std::string tag;                              // tag: operations on lock can only succeed with this tag
                                                 //      as long as set of non expired lockers
                                                 //      is bigger than 0.

        void encode(ceph::buffer::list &bl, uint64_t features) const {
          ENCODE_START(1, 1, bl);
          encode(lockers, bl, features);
          uint8_t t = (uint8_t)lock_type;
          encode(t, bl);
          encode(tag, bl);
          ENCODE_FINISH(bl);
        }
        void decode(ceph::buffer::list::const_iterator &bl) {
          DECODE_START_LEGACY_COMPAT_LEN(1, 1, 1, bl);
          decode(lockers, bl);
          uint8_t t;
          decode(t, bl);
          lock_type = (ClsLockType)t;
          decode(tag, bl);
          DECODE_FINISH(bl);
        }

        lock_info_t() : lock_type(ClsLockType::NONE) {}
        void dump(ceph::Formatter *f) const;
        static void generate_test_instances(std::list<lock_info_t *>& o);
      };
      WRITE_CLASS_ENCODER_FEATURES(lock_info_t);
    }
  }
}

#endif