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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
|
// -*- 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) 2004-2006 Sage Weil <sage@newdream.net>
*
* 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.
*
*/
#ifndef CEPH_MOSDOP_H
#define CEPH_MOSDOP_H
#include <atomic>
#include "MOSDFastDispatchOp.h"
#include "include/ceph_features.h"
#include "common/hobject.h"
/*
* OSD op
*
* oid - object id
* op - OSD_OP_DELETE, etc.
*
*/
class MOSDOpReply;
namespace _mosdop {
template<typename V>
class MOSDOp final : public MOSDFastDispatchOp {
private:
static constexpr int HEAD_VERSION = 8;
static constexpr int COMPAT_VERSION = 3;
private:
uint32_t client_inc = 0;
__u32 osdmap_epoch = 0;
__u32 flags = 0;
utime_t mtime;
int32_t retry_attempt = -1; // 0 is first attempt. -1 if we don't know.
hobject_t hobj;
spg_t pgid;
ceph::buffer::list::const_iterator p;
// Decoding flags. Decoding is only needed for messages caught by pipe reader.
// Transition from true -> false without locks being held
// Can never see final_decode_needed == false and partial_decode_needed == true
std::atomic<bool> partial_decode_needed;
std::atomic<bool> final_decode_needed;
//
public:
V ops;
private:
snapid_t snap_seq;
std::vector<snapid_t> snaps;
uint64_t features;
bool bdata_encode;
osd_reqid_t reqid; // reqid explicitly set by sender
public:
friend MOSDOpReply;
ceph_tid_t get_client_tid() { return header.tid; }
void set_snapid(const snapid_t& s) {
hobj.snap = s;
}
void set_snaps(const std::vector<snapid_t>& i) {
snaps = i;
}
void set_snap_seq(const snapid_t& s) { snap_seq = s; }
void set_reqid(const osd_reqid_t rid) {
reqid = rid;
}
void set_spg(spg_t p) {
pgid = p;
}
// Fields decoded in partial decoding
pg_t get_pg() const {
ceph_assert(!partial_decode_needed);
return pgid.pgid;
}
spg_t get_spg() const override {
ceph_assert(!partial_decode_needed);
return pgid;
}
pg_t get_raw_pg() const {
ceph_assert(!partial_decode_needed);
return pg_t(hobj.get_hash(), pgid.pgid.pool());
}
epoch_t get_map_epoch() const override {
ceph_assert(!partial_decode_needed);
return osdmap_epoch;
}
int get_flags() const {
ceph_assert(!partial_decode_needed);
return flags;
}
osd_reqid_t get_reqid() const {
ceph_assert(!partial_decode_needed);
if (reqid.name != entity_name_t() || reqid.tid != 0) {
return reqid;
} else {
if (!final_decode_needed)
ceph_assert(reqid.inc == (int32_t)client_inc); // decode() should have done this
return osd_reqid_t(get_orig_source(),
reqid.inc,
header.tid);
}
}
// Fields decoded in final decoding
int get_client_inc() const {
ceph_assert(!final_decode_needed);
return client_inc;
}
utime_t get_mtime() const {
ceph_assert(!final_decode_needed);
return mtime;
}
object_locator_t get_object_locator() const {
ceph_assert(!final_decode_needed);
if (hobj.oid.name.empty())
return object_locator_t(hobj.pool, hobj.nspace, hobj.get_hash());
else
return object_locator_t(hobj);
}
const object_t& get_oid() const {
ceph_assert(!final_decode_needed);
return hobj.oid;
}
const hobject_t &get_hobj() const {
return hobj;
}
snapid_t get_snapid() const {
ceph_assert(!final_decode_needed);
return hobj.snap;
}
const snapid_t& get_snap_seq() const {
ceph_assert(!final_decode_needed);
return snap_seq;
}
const std::vector<snapid_t> &get_snaps() const {
ceph_assert(!final_decode_needed);
return snaps;
}
/**
* get retry attempt
*
* 0 is the first attempt.
*
* @return retry attempt, or -1 if we don't know
*/
int get_retry_attempt() const {
return retry_attempt;
}
uint64_t get_features() const {
if (features)
return features;
return get_connection()->get_features();
}
MOSDOp()
: MOSDFastDispatchOp(CEPH_MSG_OSD_OP, HEAD_VERSION, COMPAT_VERSION),
partial_decode_needed(true),
final_decode_needed(true),
bdata_encode(false) { }
MOSDOp(int inc, long tid, const hobject_t& ho, spg_t& _pgid,
epoch_t _osdmap_epoch,
int _flags, uint64_t feat)
: MOSDFastDispatchOp(CEPH_MSG_OSD_OP, HEAD_VERSION, COMPAT_VERSION),
client_inc(inc),
osdmap_epoch(_osdmap_epoch), flags(_flags), retry_attempt(-1),
hobj(ho),
pgid(_pgid),
partial_decode_needed(false),
final_decode_needed(false),
features(feat),
bdata_encode(false) {
set_tid(tid);
// also put the client_inc in reqid.inc, so that get_reqid() can
// be used before the full message is decoded.
reqid.inc = inc;
}
private:
~MOSDOp() final {}
public:
void set_mtime(utime_t mt) { mtime = mt; }
void set_mtime(ceph::real_time mt) {
mtime = ceph::real_clock::to_timespec(mt);
}
// ops
void add_simple_op(int o, uint64_t off, uint64_t len) {
OSDOp osd_op;
osd_op.op.op = o;
osd_op.op.extent.offset = off;
osd_op.op.extent.length = len;
ops.push_back(osd_op);
}
void write(uint64_t off, uint64_t len, ceph::buffer::list& bl) {
add_simple_op(CEPH_OSD_OP_WRITE, off, len);
data = std::move(bl);
header.data_off = off;
}
void writefull(ceph::buffer::list& bl) {
add_simple_op(CEPH_OSD_OP_WRITEFULL, 0, bl.length());
data = std::move(bl);
header.data_off = 0;
}
void zero(uint64_t off, uint64_t len) {
add_simple_op(CEPH_OSD_OP_ZERO, off, len);
}
void truncate(uint64_t off) {
add_simple_op(CEPH_OSD_OP_TRUNCATE, off, 0);
}
void remove() {
add_simple_op(CEPH_OSD_OP_DELETE, 0, 0);
}
void read(uint64_t off, uint64_t len) {
add_simple_op(CEPH_OSD_OP_READ, off, len);
}
void stat() {
add_simple_op(CEPH_OSD_OP_STAT, 0, 0);
}
bool has_flag(__u32 flag) const { return flags & flag; };
bool is_retry_attempt() const { return flags & CEPH_OSD_FLAG_RETRY; }
void set_retry_attempt(unsigned a) {
if (a)
flags |= CEPH_OSD_FLAG_RETRY;
else
flags &= ~CEPH_OSD_FLAG_RETRY;
retry_attempt = a;
}
// marshalling
void encode_payload(uint64_t features) override {
using ceph::encode;
if( false == bdata_encode ) {
OSDOp::merge_osd_op_vector_in_data(ops, data);
bdata_encode = true;
}
if ((features & CEPH_FEATURE_OBJECTLOCATOR) == 0) {
// here is the old structure we are encoding to: //
#if 0
struct ceph_osd_request_head {
ceph_le32 client_inc; /* client incarnation */
struct ceph_object_layout layout; /* pgid */
ceph_le32 osdmap_epoch; /* client's osdmap epoch */
ceph_le32 flags;
struct ceph_timespec mtime; /* for mutations only */
struct ceph_eversion reassert_version; /* if we are replaying op */
ceph_le32 object_len; /* length of object name */
ceph_le64 snapid; /* snapid to read */
ceph_le64 snap_seq; /* writer's snap context */
ceph_le32 num_snaps;
ceph_le16 num_ops;
struct ceph_osd_op ops[]; /* followed by ops[], obj, ticket, snaps */
} __attribute__ ((packed));
#endif
header.version = 1;
encode(client_inc, payload);
__u32 su = 0;
encode(get_raw_pg(), payload);
encode(su, payload);
encode(osdmap_epoch, payload);
encode(flags, payload);
encode(mtime, payload);
encode(eversion_t(), payload); // reassert_version
__u32 oid_len = hobj.oid.name.length();
encode(oid_len, payload);
encode(hobj.snap, payload);
encode(snap_seq, payload);
__u32 num_snaps = snaps.size();
encode(num_snaps, payload);
//::encode(ops, payload);
__u16 num_ops = ops.size();
encode(num_ops, payload);
for (unsigned i = 0; i < ops.size(); i++)
encode(ops[i].op, payload);
ceph::encode_nohead(hobj.oid.name, payload);
ceph::encode_nohead(snaps, payload);
} else if ((features & CEPH_FEATURE_NEW_OSDOP_ENCODING) == 0) {
header.version = 6;
encode(client_inc, payload);
encode(osdmap_epoch, payload);
encode(flags, payload);
encode(mtime, payload);
encode(eversion_t(), payload); // reassert_version
encode(get_object_locator(), payload);
encode(get_raw_pg(), payload);
encode(hobj.oid, payload);
__u16 num_ops = ops.size();
encode(num_ops, payload);
for (unsigned i = 0; i < ops.size(); i++)
encode(ops[i].op, payload);
encode(hobj.snap, payload);
encode(snap_seq, payload);
encode(snaps, payload);
encode(retry_attempt, payload);
encode(features, payload);
if (reqid.name != entity_name_t() || reqid.tid != 0) {
encode(reqid, payload);
} else {
// don't include client_inc in the reqid for the legacy v6
// encoding or else we'll confuse older peers.
encode(osd_reqid_t(), payload);
}
} else if (!HAVE_FEATURE(features, RESEND_ON_SPLIT)) {
// reordered, v7 message encoding
header.version = 7;
encode(get_raw_pg(), payload);
encode(osdmap_epoch, payload);
encode(flags, payload);
encode(eversion_t(), payload); // reassert_version
encode(reqid, payload);
encode(client_inc, payload);
encode(mtime, payload);
encode(get_object_locator(), payload);
encode(hobj.oid, payload);
__u16 num_ops = ops.size();
encode(num_ops, payload);
for (unsigned i = 0; i < ops.size(); i++)
encode(ops[i].op, payload);
encode(hobj.snap, payload);
encode(snap_seq, payload);
encode(snaps, payload);
encode(retry_attempt, payload);
encode(features, payload);
} else {
// latest v8 encoding with hobject_t hash separate from pgid, no
// reassert version
header.version = HEAD_VERSION;
encode(pgid, payload);
encode(hobj.get_hash(), payload);
encode(osdmap_epoch, payload);
encode(flags, payload);
encode(reqid, payload);
encode_trace(payload, features);
// -- above decoded up front; below decoded post-dispatch thread --
encode(client_inc, payload);
encode(mtime, payload);
encode(get_object_locator(), payload);
encode(hobj.oid, payload);
__u16 num_ops = ops.size();
encode(num_ops, payload);
for (unsigned i = 0; i < ops.size(); i++)
encode(ops[i].op, payload);
encode(hobj.snap, payload);
encode(snap_seq, payload);
encode(snaps, payload);
encode(retry_attempt, payload);
encode(features, payload);
}
}
void decode_payload() override {
using ceph::decode;
ceph_assert(partial_decode_needed && final_decode_needed);
p = std::cbegin(payload);
// Always keep here the newest version of decoding order/rule
if (header.version == HEAD_VERSION) {
decode(pgid, p); // actual pgid
uint32_t hash;
decode(hash, p); // raw hash value
hobj.set_hash(hash);
decode(osdmap_epoch, p);
decode(flags, p);
decode(reqid, p);
decode_trace(p);
} else if (header.version == 7) {
decode(pgid.pgid, p); // raw pgid
hobj.set_hash(pgid.pgid.ps());
decode(osdmap_epoch, p);
decode(flags, p);
eversion_t reassert_version;
decode(reassert_version, p);
decode(reqid, p);
} else if (header.version < 2) {
// old decode
decode(client_inc, p);
old_pg_t opgid;
ceph::decode_raw(opgid, p);
pgid.pgid = opgid;
__u32 su;
decode(su, p);
decode(osdmap_epoch, p);
decode(flags, p);
decode(mtime, p);
eversion_t reassert_version;
decode(reassert_version, p);
__u32 oid_len;
decode(oid_len, p);
decode(hobj.snap, p);
decode(snap_seq, p);
__u32 num_snaps;
decode(num_snaps, p);
//::decode(ops, p);
__u16 num_ops;
decode(num_ops, p);
ops.resize(num_ops);
for (unsigned i = 0; i < num_ops; i++)
decode(ops[i].op, p);
ceph::decode_nohead(oid_len, hobj.oid.name, p);
ceph::decode_nohead(num_snaps, snaps, p);
// recalculate pgid hash value
pgid.pgid.set_ps(ceph_str_hash(CEPH_STR_HASH_RJENKINS,
hobj.oid.name.c_str(),
hobj.oid.name.length()));
hobj.pool = pgid.pgid.pool();
hobj.set_hash(pgid.pgid.ps());
retry_attempt = -1;
features = 0;
OSDOp::split_osd_op_vector_in_data(ops, data);
// we did the full decode
final_decode_needed = false;
// put client_inc in reqid.inc for get_reqid()'s benefit
reqid = osd_reqid_t();
reqid.inc = client_inc;
} else if (header.version < 7) {
decode(client_inc, p);
decode(osdmap_epoch, p);
decode(flags, p);
decode(mtime, p);
eversion_t reassert_version;
decode(reassert_version, p);
object_locator_t oloc;
decode(oloc, p);
if (header.version < 3) {
old_pg_t opgid;
ceph::decode_raw(opgid, p);
pgid.pgid = opgid;
} else {
decode(pgid.pgid, p);
}
decode(hobj.oid, p);
//::decode(ops, p);
__u16 num_ops;
decode(num_ops, p);
ops.resize(num_ops);
for (unsigned i = 0; i < num_ops; i++)
decode(ops[i].op, p);
decode(hobj.snap, p);
decode(snap_seq, p);
decode(snaps, p);
if (header.version >= 4)
decode(retry_attempt, p);
else
retry_attempt = -1;
if (header.version >= 5)
decode(features, p);
else
features = 0;
if (header.version >= 6)
decode(reqid, p);
else
reqid = osd_reqid_t();
hobj.pool = pgid.pgid.pool();
hobj.set_key(oloc.key);
hobj.nspace = oloc.nspace;
hobj.set_hash(pgid.pgid.ps());
OSDOp::split_osd_op_vector_in_data(ops, data);
// we did the full decode
final_decode_needed = false;
// put client_inc in reqid.inc for get_reqid()'s benefit
if (reqid.name == entity_name_t() && reqid.tid == 0)
reqid.inc = client_inc;
}
partial_decode_needed = false;
}
bool finish_decode() {
using ceph::decode;
ceph_assert(!partial_decode_needed); // partial decoding required
if (!final_decode_needed)
return false; // Message is already final decoded
ceph_assert(header.version >= 7);
decode(client_inc, p);
decode(mtime, p);
object_locator_t oloc;
decode(oloc, p);
decode(hobj.oid, p);
__u16 num_ops;
decode(num_ops, p);
ops.resize(num_ops);
for (unsigned i = 0; i < num_ops; i++)
decode(ops[i].op, p);
decode(hobj.snap, p);
decode(snap_seq, p);
decode(snaps, p);
decode(retry_attempt, p);
decode(features, p);
hobj.pool = pgid.pgid.pool();
hobj.set_key(oloc.key);
hobj.nspace = oloc.nspace;
OSDOp::split_osd_op_vector_in_data(ops, data);
final_decode_needed = false;
return true;
}
void clear_buffers() override {
OSDOp::clear_data(ops);
bdata_encode = false;
}
std::string_view get_type_name() const override { return "osd_op"; }
void print(std::ostream& out) const override {
out << "osd_op(";
if (!partial_decode_needed) {
out << get_reqid() << ' ';
out << pgid;
if (!final_decode_needed) {
out << ' ';
out << hobj
<< " " << ops
<< " snapc " << get_snap_seq() << "=" << snaps;
if (is_retry_attempt())
out << " RETRY=" << get_retry_attempt();
} else {
out << " " << get_raw_pg() << " (undecoded)";
}
out << " " << ceph_osd_flag_string(get_flags());
out << " e" << osdmap_epoch;
}
out << ")";
}
private:
template<class T, typename... Args>
friend boost::intrusive_ptr<T> ceph::make_message(Args&&... args);
};
}
using MOSDOp = _mosdop::MOSDOp<std::vector<OSDOp>>;
#endif
|