1 // -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
2 // vim: ts=8 sw=2 smarttab
3 #ifndef CEPH_LIBRBD_IMAGECTX_H
4 #define CEPH_LIBRBD_IMAGECTX_H
6 #include "include/int_types.h"
13 #include "common/event_socket.h"
14 #include "common/Mutex.h"
15 #include "common/Readahead.h"
16 #include "common/RWLock.h"
17 #include "common/snap_types.h"
18 #include "common/zipkin_trace.h"
20 #include "include/buffer_fwd.h"
21 #include "include/rbd/librbd.hpp"
22 #include "include/rbd_types.h"
23 #include "include/types.h"
24 #include "include/xlist.h"
25 #include "osdc/ObjectCacher.h"
27 #include "cls/rbd/cls_rbd_types.h"
28 #include "cls/rbd/cls_rbd_client.h"
29 #include "librbd/AsyncRequest.h"
30 #include "librbd/Types.h"
41 template <typename
> class ExclusiveLock
;
42 template <typename
> class ImageState
;
43 template <typename
> class ImageWatcher
;
44 template <typename
> class Journal
;
45 class LibrbdAdminSocketHook
;
46 template <typename
> class ObjectMap
;
47 template <typename
> class Operations
;
48 class LibrbdWriteback
;
50 namespace cache
{ struct ImageCache
; }
51 namespace exclusive_lock
{ struct Policy
; }
58 namespace journal
{ struct Policy
; }
61 template <typename
> class ResizeRequest
;
66 PerfCounters
*perfcounter
;
67 struct rbd_obj_header_ondisk header
;
69 std::vector
<librados::snap_t
> snaps
; // this mirrors snapc.snaps, but is in
70 // a format librados can understand
71 std::map
<librados::snap_t
, SnapInfo
> snap_info
;
72 std::map
<std::pair
<cls::rbd::SnapshotNamespace
, std::string
>, librados::snap_t
> snap_ids
;
74 bool snap_exists
; // false if our snap_id was deleted
75 // whether the image was opened read-only. cannot be changed after opening
77 bool flush_encountered
;
79 std::map
<rados::cls::lock::locker_id_t
,
80 rados::cls::lock::locker_info_t
> lockers
;
81 bool exclusive_locked
;
85 cls::rbd::SnapshotNamespace snap_namespace
;
86 std::string snap_name
;
87 IoCtx data_ctx
, md_ctx
;
88 ImageWatcher
<ImageCtx
> *image_watcher
;
89 Journal
<ImageCtx
> *journal
;
94 * owner_lock, md_lock, cache_lock, snap_lock, parent_lock,
95 * object_map_lock, async_op_lock
97 RWLock owner_lock
; // protects exclusive lock leadership updates
98 RWLock md_lock
; // protects access to the mutable image metadata that
99 // isn't guarded by other locks below, and blocks writes
100 // when held exclusively, so snapshots can be consistent.
101 // Fields guarded include:
107 Mutex cache_lock
; // used as client_lock for the ObjectCacher
108 RWLock snap_lock
; // protects snapshot-related member variables,
109 // features (and associated helper classes), and flags
110 RWLock parent_lock
; // protects parent_md and parent
111 RWLock object_map_lock
; // protects object map updates and object_map itself
112 Mutex async_ops_lock
; // protects async_ops and async_requests
113 Mutex copyup_list_lock
; // protects copyup_waiting_list
114 Mutex completed_reqs_lock
; // protects completed_reqs
116 unsigned extra_read_flags
;
122 std::string object_prefix
;
124 std::string header_oid
;
125 std::string id
; // only used for new-format images
126 ParentInfo parent_md
;
128 cls::rbd::GroupSpec group_spec
;
129 uint64_t stripe_unit
, stripe_count
;
131 utime_t create_timestamp
;
133 file_layout_t layout
;
135 cache::ImageCache
*image_cache
= nullptr;
136 ObjectCacher
*object_cacher
;
137 LibrbdWriteback
*writeback_handler
;
138 ObjectCacher::ObjectSet
*object_set
;
141 uint64_t total_bytes_read
;
143 std::map
<uint64_t, io::CopyupRequest
*> copyup_list
;
145 xlist
<io::AsyncOperation
*> async_ops
;
146 xlist
<AsyncRequest
<>*> async_requests
;
147 std::list
<Context
*> async_requests_waiters
;
149 ImageState
<ImageCtx
> *state
;
150 Operations
<ImageCtx
> *operations
;
152 ExclusiveLock
<ImageCtx
> *exclusive_lock
;
153 ObjectMap
<ImageCtx
> *object_map
;
155 xlist
<operation::ResizeRequest
<ImageCtx
>*> resize_reqs
;
157 io::ImageRequestWQ
*io_work_queue
;
158 xlist
<io::AioCompletion
*> completed_reqs
;
159 EventSocket event_socket
;
161 ContextWQ
*op_work_queue
;
164 static const string METADATA_CONF_PREFIX
;
165 bool non_blocking_aio
;
167 bool cache_writethrough_until_flush
;
169 uint64_t cache_max_dirty
;
170 uint64_t cache_target_dirty
;
171 double cache_max_dirty_age
;
172 uint32_t cache_max_dirty_object
;
173 bool cache_block_writes_upfront
;
174 uint32_t concurrent_management_ops
;
175 bool balance_snap_reads
;
176 bool localize_snap_reads
;
177 bool balance_parent_reads
;
178 bool localize_parent_reads
;
179 uint32_t readahead_trigger_requests
;
180 uint64_t readahead_max_bytes
;
181 uint64_t readahead_disable_after_bytes
;
182 bool clone_copy_on_read
;
183 bool blacklist_on_break_lock
;
184 uint32_t blacklist_expire_seconds
;
185 uint32_t request_timed_out_seconds
;
186 bool enable_alloc_hint
;
187 uint8_t journal_order
;
188 uint8_t journal_splay_width
;
189 double journal_commit_age
;
190 int journal_object_flush_interval
;
191 uint64_t journal_object_flush_bytes
;
192 double journal_object_flush_age
;
193 std::string journal_pool
;
194 uint32_t journal_max_payload_bytes
;
195 int journal_max_concurrent_object_sets
;
196 bool mirroring_resync_after_disconnect
;
197 int mirroring_replay_delay
;
198 bool skip_partial_discard
;
200 LibrbdAdminSocketHook
*asok_hook
;
202 exclusive_lock::Policy
*exclusive_lock_policy
= nullptr;
203 journal::Policy
*journal_policy
= nullptr;
205 ZTracer::Endpoint trace_endpoint
;
207 static bool _filter_metadata_confs(const string
&prefix
, std::map
<string
, bool> &configs
,
208 const map
<string
, bufferlist
> &pairs
, map
<string
, bufferlist
> *res
);
210 // unit test mock helpers
211 static ImageCtx
* create(const std::string
&image_name
,
212 const std::string
&image_id
,
213 const char *snap
, IoCtx
& p
, bool read_only
) {
214 return new ImageCtx(image_name
, image_id
, snap
, p
, read_only
);
221 * Either image_name or image_id must be set.
222 * If id is not known, pass the empty std::string,
223 * and init() will look it up.
225 ImageCtx(const std::string
&image_name
, const std::string
&image_id
,
226 const char *snap
, IoCtx
& p
, bool read_only
);
231 void perf_start(std::string name
);
233 void set_read_flag(unsigned flag
);
234 int get_read_flags(librados::snap_t snap_id
);
235 int snap_set(cls::rbd::SnapshotNamespace in_snap_namespace
,
236 std::string in_snap_name
);
238 librados::snap_t
get_snap_id(cls::rbd::SnapshotNamespace in_snap_namespace
,
239 std::string in_snap_name
) const;
240 const SnapInfo
* get_snap_info(librados::snap_t in_snap_id
) const;
241 int get_snap_name(librados::snap_t in_snap_id
,
242 std::string
*out_snap_name
) const;
243 int get_snap_namespace(librados::snap_t in_snap_id
,
244 cls::rbd::SnapshotNamespace
*out_snap_namespace
) const;
245 int get_parent_spec(librados::snap_t in_snap_id
,
246 ParentSpec
*pspec
) const;
247 int is_snap_protected(librados::snap_t in_snap_id
,
248 bool *is_protected
) const;
249 int is_snap_unprotected(librados::snap_t in_snap_id
,
250 bool *is_unprotected
) const;
252 uint64_t get_current_size() const;
253 uint64_t get_object_size() const;
254 string
get_object_name(uint64_t num
) const;
255 uint64_t get_stripe_unit() const;
256 uint64_t get_stripe_count() const;
257 uint64_t get_stripe_period() const;
258 utime_t
get_create_timestamp() const;
260 void add_snap(cls::rbd::SnapshotNamespace in_snap_namespace
,
261 std::string in_snap_name
,
263 uint64_t in_size
, const ParentInfo
&parent
,
264 uint8_t protection_status
, uint64_t flags
, utime_t timestamp
);
265 void rm_snap(cls::rbd::SnapshotNamespace in_snap_namespace
,
266 std::string in_snap_name
,
267 librados::snap_t id
);
268 uint64_t get_image_size(librados::snap_t in_snap_id
) const;
269 uint64_t get_object_count(librados::snap_t in_snap_id
) const;
270 bool test_features(uint64_t test_features
) const;
271 bool test_features(uint64_t test_features
,
272 const RWLock
&in_snap_lock
) const;
273 int get_flags(librados::snap_t in_snap_id
, uint64_t *flags
) const;
274 int test_flags(uint64_t test_flags
, bool *flags_set
) const;
275 int test_flags(uint64_t test_flags
, const RWLock
&in_snap_lock
,
276 bool *flags_set
) const;
277 int update_flags(librados::snap_t in_snap_id
, uint64_t flag
, bool enabled
);
279 const ParentInfo
* get_parent_info(librados::snap_t in_snap_id
) const;
280 int64_t get_parent_pool_id(librados::snap_t in_snap_id
) const;
281 std::string
get_parent_image_id(librados::snap_t in_snap_id
) const;
282 uint64_t get_parent_snap_id(librados::snap_t in_snap_id
) const;
283 int get_parent_overlap(librados::snap_t in_snap_id
,
284 uint64_t *overlap
) const;
285 void aio_read_from_cache(object_t o
, uint64_t object_no
, bufferlist
*bl
,
286 size_t len
, uint64_t off
, Context
*onfinish
,
287 int fadvise_flags
, ZTracer::Trace
*trace
);
288 void write_to_cache(object_t o
, const bufferlist
& bl
, size_t len
,
289 uint64_t off
, Context
*onfinish
, int fadvise_flags
,
290 uint64_t journal_tid
, ZTracer::Trace
*trace
);
292 void flush_cache(Context
*onfinish
);
293 void shut_down_cache(Context
*on_finish
);
294 int invalidate_cache(bool purge_on_error
);
295 void invalidate_cache(bool purge_on_error
, Context
*on_finish
);
296 void clear_nonexistence_cache();
297 bool is_cache_empty();
298 void register_watch(Context
*on_finish
);
299 uint64_t prune_parent_extents(vector
<pair
<uint64_t,uint64_t> >& objectx
,
302 void flush_async_operations();
303 void flush_async_operations(Context
*on_finish
);
306 void flush(Context
*on_safe
);
308 void cancel_async_requests();
309 void cancel_async_requests(Context
*on_finish
);
311 void apply_metadata(const std::map
<std::string
, bufferlist
> &meta
);
313 ExclusiveLock
<ImageCtx
> *create_exclusive_lock();
314 ObjectMap
<ImageCtx
> *create_object_map(uint64_t snap_id
);
315 Journal
<ImageCtx
> *create_journal();
317 void clear_pending_completions();
319 void set_image_name(const std::string
&name
);
321 void notify_update();
322 void notify_update(Context
*on_finish
);
324 exclusive_lock::Policy
*get_exclusive_lock_policy() const;
325 void set_exclusive_lock_policy(exclusive_lock::Policy
*policy
);
327 journal::Policy
*get_journal_policy() const;
328 void set_journal_policy(journal::Policy
*policy
);
330 static void get_thread_pool_instance(CephContext
*cct
,
331 ThreadPool
**thread_pool
,
332 ContextWQ
**op_work_queue
);
333 static void get_timer_instance(CephContext
*cct
, SafeTimer
**timer
,