]> git.proxmox.com Git - ceph.git/blame - ceph/src/rgw/rgw_file.h
update sources to v12.2.3
[ceph.git] / ceph / src / rgw / rgw_file.h
CommitLineData
7c673cae
FG
1// -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
2// vim: ts=8 sw=2 smarttab
3
4#ifndef RGW_FILE_H
5#define RGW_FILE_H
6
7#include "include/rados/rgw_file.h"
8
9/* internal header */
10#include <string.h>
11#include <sys/stat.h>
12#include <stdint.h>
13
14#include <atomic>
15#include <chrono>
16#include <thread>
17#include <mutex>
18#include <vector>
19#include <deque>
20#include <algorithm>
21#include <functional>
22#include <boost/intrusive_ptr.hpp>
23#include <boost/range/adaptor/reversed.hpp>
24#include <boost/container/flat_map.hpp>
25#include <boost/variant.hpp>
26#include <boost/utility/string_ref.hpp>
27#include <boost/optional.hpp>
28#include "xxhash.h"
29#include "include/buffer.h"
30#include "common/cohort_lru.h"
31#include "common/ceph_timer.h"
32#include "rgw_common.h"
33#include "rgw_user.h"
34#include "rgw_lib.h"
35#include "rgw_ldap.h"
36#include "rgw_token.h"
224ce89b 37#include "rgw_compression.h"
7c673cae
FG
38
39
40/* XXX
41 * ASSERT_H somehow not defined after all the above (which bring
42 * in common/debug.h [e.g., dout])
43 */
44#include "include/assert.h"
45
46
47#define RGW_RWXMODE (S_IRWXU | S_IRWXG | S_IRWXO)
48
49#define RGW_RWMODE (RGW_RWXMODE & \
50 ~(S_IXUSR | S_IXGRP | S_IXOTH))
51
52
53namespace rgw {
54
55 template <typename T>
56 static inline void ignore(T &&) {}
57
58
59 namespace bi = boost::intrusive;
60
61 class RGWLibFS;
62 class RGWFileHandle;
63 class RGWWriteRequest;
64
65 static inline bool operator <(const struct timespec& lhs,
66 const struct timespec& rhs) {
67 if (lhs.tv_sec == rhs.tv_sec)
68 return lhs.tv_nsec < rhs.tv_nsec;
69 else
70 return lhs.tv_sec < rhs.tv_sec;
71 }
72
73 static inline bool operator ==(const struct timespec& lhs,
74 const struct timespec& rhs) {
75 return ((lhs.tv_sec == rhs.tv_sec) &&
76 (lhs.tv_nsec == rhs.tv_nsec));
77 }
78
79 /*
80 * XXX
81 * The current 64-bit, non-cryptographic hash used here is intended
82 * for prototyping only.
83 *
84 * However, the invariant being prototyped is that objects be
85 * identifiable by their hash components alone. We believe this can
86 * be legitimately implemented using 128-hash values for bucket and
87 * object components, together with a cluster-resident cryptographic
88 * key. Since an MD5 or SHA-1 key is 128 bits and the (fast),
89 * non-cryptographic CityHash128 hash algorithm takes a 128-bit seed,
90 * speculatively we could use that for the final hash computations.
91 */
92 struct fh_key
93 {
94 rgw_fh_hk fh_hk;
224ce89b 95 uint32_t version;
7c673cae
FG
96
97 static constexpr uint64_t seed = 8675309;
98
224ce89b 99 fh_key() : version(0) {}
7c673cae
FG
100
101 fh_key(const rgw_fh_hk& _hk)
224ce89b 102 : fh_hk(_hk), version(0) {
7c673cae
FG
103 // nothing
104 }
105
224ce89b
WB
106 fh_key(const uint64_t bk, const uint64_t ok)
107 : version(0) {
7c673cae
FG
108 fh_hk.bucket = bk;
109 fh_hk.object = ok;
110 }
111
224ce89b
WB
112 fh_key(const uint64_t bk, const char *_o)
113 : version(0) {
7c673cae
FG
114 fh_hk.bucket = bk;
115 fh_hk.object = XXH64(_o, ::strlen(_o), seed);
116 }
117
224ce89b
WB
118 fh_key(const std::string& _b, const std::string& _o)
119 : version(0) {
7c673cae
FG
120 fh_hk.bucket = XXH64(_b.c_str(), _o.length(), seed);
121 fh_hk.object = XXH64(_o.c_str(), _o.length(), seed);
122 }
123
124 void encode(buffer::list& bl) const {
224ce89b 125 ENCODE_START(2, 1, bl);
7c673cae
FG
126 ::encode(fh_hk.bucket, bl);
127 ::encode(fh_hk.object, bl);
224ce89b 128 ::encode((uint32_t)2, bl);
7c673cae
FG
129 ENCODE_FINISH(bl);
130 }
131
132 void decode(bufferlist::iterator& bl) {
224ce89b 133 DECODE_START(2, bl);
7c673cae
FG
134 ::decode(fh_hk.bucket, bl);
135 ::decode(fh_hk.object, bl);
224ce89b
WB
136 if (struct_v >= 2) {
137 ::decode(version, bl);
138 }
7c673cae
FG
139 DECODE_FINISH(bl);
140 }
141 }; /* fh_key */
142
143 WRITE_CLASS_ENCODER(fh_key);
144
145 inline bool operator<(const fh_key& lhs, const fh_key& rhs)
146 {
147 return ((lhs.fh_hk.bucket < rhs.fh_hk.bucket) ||
148 ((lhs.fh_hk.bucket == rhs.fh_hk.bucket) &&
149 (lhs.fh_hk.object < rhs.fh_hk.object)));
150 }
151
152 inline bool operator>(const fh_key& lhs, const fh_key& rhs)
153 {
154 return (rhs < lhs);
155 }
156
157 inline bool operator==(const fh_key& lhs, const fh_key& rhs)
158 {
159 return ((lhs.fh_hk.bucket == rhs.fh_hk.bucket) &&
160 (lhs.fh_hk.object == rhs.fh_hk.object));
161 }
162
163 inline bool operator!=(const fh_key& lhs, const fh_key& rhs)
164 {
165 return !(lhs == rhs);
166 }
167
168 inline bool operator<=(const fh_key& lhs, const fh_key& rhs)
169 {
170 return (lhs < rhs) || (lhs == rhs);
171 }
172
173 using boost::variant;
174 using boost::container::flat_map;
175
3efd9988
FG
176 typedef std::tuple<bool, bool> DecodeAttrsResult;
177
7c673cae
FG
178 class RGWFileHandle : public cohort::lru::Object
179 {
180 struct rgw_file_handle fh;
181 std::mutex mtx;
182
183 RGWLibFS* fs;
184 RGWFileHandle* bucket;
185 RGWFileHandle* parent;
186 /* const */ std::string name; /* XXX file or bucket name */
187 /* const */ fh_key fhk;
188
189 using lock_guard = std::lock_guard<std::mutex>;
190 using unique_lock = std::unique_lock<std::mutex>;
191
192 /* TODO: keeping just the last marker is sufficient for
193 * nfs-ganesha 2.4.5; in the near future, nfs-ganesha will
194 * be able to hint the name of the next dirent required,
195 * from which we can directly synthesize a RADOS marker.
196 * using marker_cache_t = flat_map<uint64_t, rgw_obj_key>;
197 */
198
199 struct State {
200 uint64_t dev;
201 uint64_t size;
202 uint64_t nlink;
203 uint32_t owner_uid; /* XXX need Unix attr */
204 uint32_t owner_gid; /* XXX need Unix attr */
205 mode_t unix_mode;
206 struct timespec ctime;
207 struct timespec mtime;
208 struct timespec atime;
3efd9988 209 uint32_t version;
7c673cae 210 State() : dev(0), size(0), nlink(1), owner_uid(0), owner_gid(0),
3efd9988 211 ctime{0,0}, mtime{0,0}, atime{0,0}, version(0) {}
7c673cae
FG
212 } state;
213
214 struct file {
215 RGWWriteRequest* write_req;
216 file() : write_req(nullptr) {}
217 ~file();
218 };
219
220 struct directory {
221
222 static constexpr uint32_t FLAG_NONE = 0x0000;
223
224 uint32_t flags;
225 rgw_obj_key last_marker;
226 struct timespec last_readdir;
227
228 directory() : flags(FLAG_NONE), last_readdir{0,0} {}
229 };
230
231 void clear_state();
232
233 boost::variant<file, directory> variant_type;
234
235 uint16_t depth;
236 uint32_t flags;
237
238 public:
239 const static std::string root_name;
240
241 static constexpr uint16_t MAX_DEPTH = 256;
242
243 static constexpr uint32_t FLAG_NONE = 0x0000;
244 static constexpr uint32_t FLAG_OPEN = 0x0001;
245 static constexpr uint32_t FLAG_ROOT = 0x0002;
246 static constexpr uint32_t FLAG_CREATE = 0x0004;
247 static constexpr uint32_t FLAG_CREATING = 0x0008;
248 static constexpr uint32_t FLAG_DIRECTORY = 0x0010;
249 static constexpr uint32_t FLAG_BUCKET = 0x0020;
250 static constexpr uint32_t FLAG_LOCK = 0x0040;
251 static constexpr uint32_t FLAG_DELETED = 0x0080;
252 static constexpr uint32_t FLAG_UNLINK_THIS = 0x0100;
253 static constexpr uint32_t FLAG_LOCKED = 0x0200;
254 static constexpr uint32_t FLAG_STATELESS_OPEN = 0x0400;
255 static constexpr uint32_t FLAG_EXACT_MATCH = 0x0800;
3efd9988 256 static constexpr uint32_t FLAG_MOUNT = 0x1000;
7c673cae
FG
257
258#define CREATE_FLAGS(x) \
259 ((x) & ~(RGWFileHandle::FLAG_CREATE|RGWFileHandle::FLAG_LOCK))
260
261 friend class RGWLibFS;
262
263 private:
3efd9988 264 RGWFileHandle(RGWLibFS* _fs)
7c673cae 265 : fs(_fs), bucket(nullptr), parent(nullptr), variant_type{directory()},
3efd9988 266 depth(0), flags(FLAG_NONE)
7c673cae
FG
267 {
268 /* root */
269 fh.fh_type = RGW_FS_TYPE_DIRECTORY;
270 variant_type = directory();
271 /* stat */
7c673cae
FG
272 state.unix_mode = RGW_RWXMODE|S_IFDIR;
273 /* pointer to self */
274 fh.fh_private = this;
275 }
276
3efd9988
FG
277 uint64_t init_fsid(std::string& uid) {
278 return XXH64(uid.c_str(), uid.length(), fh_key::seed);
279 }
280
281 void init_rootfs(std::string& fsid, const std::string& object_name,
282 bool is_bucket) {
7c673cae
FG
283 /* fh_key */
284 fh.fh_hk.bucket = XXH64(fsid.c_str(), fsid.length(), fh_key::seed);
285 fh.fh_hk.object = XXH64(object_name.c_str(), object_name.length(),
286 fh_key::seed);
287 fhk = fh.fh_hk;
288 name = object_name;
3efd9988
FG
289
290 state.dev = init_fsid(fsid);
291
292 if (is_bucket) {
293 flags |= RGWFileHandle::FLAG_BUCKET | RGWFileHandle::FLAG_MOUNT;
294 bucket = this;
295 depth = 1;
296 } else {
297 flags |= RGWFileHandle::FLAG_ROOT | RGWFileHandle::FLAG_MOUNT;
298 }
7c673cae
FG
299 }
300
301 public:
3efd9988 302 RGWFileHandle(RGWLibFS* _fs, RGWFileHandle* _parent,
7c673cae 303 const fh_key& _fhk, std::string& _name, uint32_t _flags)
3efd9988 304 : fs(_fs), bucket(nullptr), parent(_parent), name(std::move(_name)),
7c673cae
FG
305 fhk(_fhk), flags(_flags) {
306
307 if (parent->is_root()) {
308 fh.fh_type = RGW_FS_TYPE_DIRECTORY;
309 variant_type = directory();
310 flags |= FLAG_BUCKET;
311 } else {
31f18b77 312 bucket = parent->is_bucket() ? parent
7c673cae
FG
313 : parent->bucket;
314 if (flags & FLAG_DIRECTORY) {
315 fh.fh_type = RGW_FS_TYPE_DIRECTORY;
316 variant_type = directory();
317 } else {
318 fh.fh_type = RGW_FS_TYPE_FILE;
319 variant_type = file();
320 }
321 }
322
323 depth = parent->depth + 1;
324
325 /* save constant fhk */
326 fh.fh_hk = fhk.fh_hk; /* XXX redundant in fh_hk */
327
3efd9988
FG
328 /* inherits parent's fsid */
329 state.dev = parent->state.dev;
7c673cae
FG
330
331 switch (fh.fh_type) {
332 case RGW_FS_TYPE_DIRECTORY:
333 state.unix_mode = RGW_RWXMODE|S_IFDIR;
334 break;
335 case RGW_FS_TYPE_FILE:
336 state.unix_mode = RGW_RWMODE|S_IFREG;
337 default:
338 break;
339 }
340
341 /* pointer to self */
342 fh.fh_private = this;
343 }
344
345 const fh_key& get_key() const {
346 return fhk;
347 }
348
349 directory* get_directory() {
350 return get<directory>(&variant_type);
351 }
352
353 size_t get_size() const { return state.size; }
354
355 const char* stype() {
356 return is_dir() ? "DIR" : "FILE";
357 }
358
359 uint16_t get_depth() const { return depth; }
360
361 struct rgw_file_handle* get_fh() { return &fh; }
362
363 RGWLibFS* get_fs() { return fs; }
364
365 RGWFileHandle* get_parent() { return parent; }
366
367 uint32_t get_owner_uid() const { return state.owner_uid; }
368 uint32_t get_owner_gid() const { return state.owner_gid; }
369
370 struct timespec get_ctime() const { return state.ctime; }
371 struct timespec get_mtime() const { return state.mtime; }
372
373 void create_stat(struct stat* st, uint32_t mask) {
374 if (mask & RGW_SETATTR_UID)
375 state.owner_uid = st->st_uid;
376
377 if (mask & RGW_SETATTR_GID)
378 state.owner_gid = st->st_gid;
379
380 if (mask & RGW_SETATTR_MODE) {
381 switch (fh.fh_type) {
382 case RGW_FS_TYPE_DIRECTORY:
383 state.unix_mode = st->st_mode|S_IFDIR;
384 break;
385 case RGW_FS_TYPE_FILE:
386 state.unix_mode = st->st_mode|S_IFREG;
387 default:
388 break;
389 }
390 }
391
392 if (mask & RGW_SETATTR_ATIME)
393 state.atime = st->st_atim;
394 if (mask & RGW_SETATTR_MTIME)
395 state.mtime = st->st_mtim;
396 if (mask & RGW_SETATTR_CTIME)
397 state.ctime = st->st_ctim;
398 }
399
400 int stat(struct stat* st) {
401 /* partial Unix attrs */
402 memset(st, 0, sizeof(struct stat));
403 st->st_dev = state.dev;
404 st->st_ino = fh.fh_hk.object; // XXX
405
406 st->st_uid = state.owner_uid;
407 st->st_gid = state.owner_gid;
408
409 st->st_mode = state.unix_mode;
410
411#ifdef HAVE_STAT_ST_MTIMESPEC_TV_NSEC
412 st->st_atimespec = state.atime;
413 st->st_mtimespec = state.mtime;
414 st->st_ctimespec = state.ctime;
415#else
416 st->st_atim = state.atime;
417 st->st_mtim = state.mtime;
418 st->st_ctim = state.ctime;
419#endif
420
421 switch (fh.fh_type) {
422 case RGW_FS_TYPE_DIRECTORY:
423 st->st_nlink = state.nlink;
424 break;
425 case RGW_FS_TYPE_FILE:
426 st->st_nlink = 1;
427 st->st_blksize = 4096;
428 st->st_size = state.size;
429 st->st_blocks = (state.size) / 512;
430 default:
431 break;
432 }
433
434 return 0;
435 }
436
437 const std::string& bucket_name() const {
438 if (is_root())
439 return root_name;
31f18b77 440 if (is_bucket())
7c673cae
FG
441 return name;
442 return bucket->object_name();
443 }
444
445 const std::string& object_name() const { return name; }
446
447 std::string full_object_name(bool omit_bucket = false) const {
448 std::string path;
449 std::vector<const std::string*> segments;
450 int reserve = 0;
451 const RGWFileHandle* tfh = this;
452 while (tfh && !tfh->is_root() && !(tfh->is_bucket() && omit_bucket)) {
453 segments.push_back(&tfh->object_name());
454 reserve += (1 + tfh->object_name().length());
455 tfh = tfh->parent;
456 }
457 bool first = true;
458 path.reserve(reserve);
459 for (auto& s : boost::adaptors::reverse(segments)) {
460 if (! first)
461 path += "/";
462 else {
463 if (!omit_bucket && (path.front() != '/')) // pretty-print
464 path += "/";
465 first = false;
466 }
467 path += *s;
468 }
469 return path;
470 }
471
472 inline std::string relative_object_name() const {
473 return full_object_name(true /* omit_bucket */);
474 }
475
31f18b77
FG
476 inline std::string format_child_name(const std::string& cbasename,
477 bool is_dir) const {
7c673cae
FG
478 std::string child_name{relative_object_name()};
479 if ((child_name.size() > 0) &&
480 (child_name.back() != '/'))
481 child_name += "/";
482 child_name += cbasename;
31f18b77
FG
483 if (is_dir)
484 child_name += "/";
7c673cae
FG
485 return child_name;
486 }
487
488 inline std::string make_key_name(const char *name) const {
489 std::string key_name{full_object_name()};
490 if (key_name.length() > 0)
491 key_name += "/";
492 key_name += name;
493 return key_name;
494 }
495
496 fh_key make_fhk(const std::string& name) const {
497 if (depth <= 1)
498 return fh_key(fhk.fh_hk.object, name.c_str());
499 else {
500 std::string key_name = make_key_name(name.c_str());
501 return fh_key(fhk.fh_hk.bucket, key_name.c_str());
502 }
503 }
504
505 void add_marker(uint64_t off, const rgw_obj_key& marker,
506 uint8_t obj_type) {
507 using std::get;
508 directory* d = get<directory>(&variant_type);
509 if (d) {
510 unique_lock guard(mtx);
511 d->last_marker = marker;
512 }
513 }
514
515 const rgw_obj_key* find_marker(uint64_t off) const {
516 using std::get;
517 if (off > 0) {
518 const directory* d = get<directory>(&variant_type);
519 if (d ) {
520 return &d->last_marker;
521 }
522 }
523 return nullptr;
524 }
525
c07f9fc5
FG
526 int offset_of(const std::string& name, int64_t *offset, uint32_t flags) {
527 if (unlikely(! is_dir())) {
528 return -EINVAL;
529 }
530 *offset = XXH64(name.c_str(), name.length(), fh_key::seed);
531 return 0;
532 }
533
7c673cae
FG
534 bool is_open() const { return flags & FLAG_OPEN; }
535 bool is_root() const { return flags & FLAG_ROOT; }
3efd9988 536 bool is_mount() const { return flags & FLAG_MOUNT; }
7c673cae
FG
537 bool is_bucket() const { return flags & FLAG_BUCKET; }
538 bool is_object() const { return !is_bucket(); }
539 bool is_file() const { return (fh.fh_type == RGW_FS_TYPE_FILE); }
540 bool is_dir() const { return (fh.fh_type == RGW_FS_TYPE_DIRECTORY); }
541 bool creating() const { return flags & FLAG_CREATING; }
542 bool deleted() const { return flags & FLAG_DELETED; }
543 bool stateless_open() const { return flags & FLAG_STATELESS_OPEN; }
544 bool has_children() const;
545
546 int open(uint32_t gsh_flags) {
547 lock_guard guard(mtx);
31f18b77 548 if (! is_open()) {
7c673cae
FG
549 if (gsh_flags & RGW_OPEN_FLAG_V3) {
550 flags |= FLAG_STATELESS_OPEN;
551 }
552 flags |= FLAG_OPEN;
553 return 0;
554 }
555 return -EPERM;
556 }
557
3efd9988
FG
558 typedef boost::variant<uint64_t*, const char*> readdir_offset;
559
560 int readdir(rgw_readdir_cb rcb, void *cb_arg, readdir_offset offset,
561 bool *eof, uint32_t flags);
562
7c673cae
FG
563 int write(uint64_t off, size_t len, size_t *nbytes, void *buffer);
564
565 int commit(uint64_t offset, uint64_t length, uint32_t flags) {
566 /* NFS3 and NFSv4 COMMIT implementation
567 * the current atomic update strategy doesn't actually permit
568 * clients to read-stable until either CLOSE (NFSv4+) or the
569 * expiration of the active write timer (NFS3). In the
570 * interim, the client may send an arbitrary number of COMMIT
571 * operations which must return a success result */
572 return 0;
573 }
574
575 int write_finish(uint32_t flags = FLAG_NONE);
576 int close();
577
578 void open_for_create() {
579 lock_guard guard(mtx);
580 flags |= FLAG_CREATING;
581 }
582
583 void clear_creating() {
584 lock_guard guard(mtx);
585 flags &= ~FLAG_CREATING;
586 }
587
588 void inc_nlink(const uint64_t n) {
589 state.nlink += n;
590 }
591
592 void set_nlink(const uint64_t n) {
593 state.nlink = n;
594 }
595
596 void set_size(const size_t size) {
597 state.size = size;
598 }
599
600 void set_times(real_time t) {
601 state.ctime = real_clock::to_timespec(t);
602 state.mtime = state.ctime;
603 state.atime = state.ctime;
604 }
605
606 void set_ctime(const struct timespec &ts) {
607 state.ctime = ts;
608 }
609
610 void set_mtime(const struct timespec &ts) {
611 state.mtime = ts;
612 }
613
614 void set_atime(const struct timespec &ts) {
615 state.atime = ts;
616 }
617
618 void encode(buffer::list& bl) const {
3efd9988 619 ENCODE_START(2, 1, bl);
7c673cae
FG
620 ::encode(uint32_t(fh.fh_type), bl);
621 ::encode(state.dev, bl);
622 ::encode(state.size, bl);
623 ::encode(state.nlink, bl);
624 ::encode(state.owner_uid, bl);
625 ::encode(state.owner_gid, bl);
626 ::encode(state.unix_mode, bl);
627 for (const auto& t : { state.ctime, state.mtime, state.atime }) {
628 ::encode(real_clock::from_timespec(t), bl);
629 }
3efd9988 630 ::encode((uint32_t)2, bl);
7c673cae
FG
631 ENCODE_FINISH(bl);
632 }
633
634 void decode(bufferlist::iterator& bl) {
3efd9988 635 DECODE_START(2, bl);
7c673cae
FG
636 uint32_t fh_type;
637 ::decode(fh_type, bl);
638 assert(fh.fh_type == fh_type);
639 ::decode(state.dev, bl);
640 ::decode(state.size, bl);
641 ::decode(state.nlink, bl);
642 ::decode(state.owner_uid, bl);
643 ::decode(state.owner_gid, bl);
644 ::decode(state.unix_mode, bl);
645 ceph::real_time enc_time;
646 for (auto t : { &(state.ctime), &(state.mtime), &(state.atime) }) {
647 ::decode(enc_time, bl);
648 *t = real_clock::to_timespec(enc_time);
649 }
3efd9988
FG
650 if (struct_v >= 2) {
651 ::decode(state.version, bl);
652 }
7c673cae
FG
653 DECODE_FINISH(bl);
654 }
655
656 void encode_attrs(ceph::buffer::list& ux_key1,
657 ceph::buffer::list& ux_attrs1);
658
3efd9988
FG
659 DecodeAttrsResult decode_attrs(const ceph::buffer::list* ux_key1,
660 const ceph::buffer::list* ux_attrs1);
7c673cae
FG
661
662 void invalidate();
663
664 bool reclaim() override;
665
666 typedef cohort::lru::LRU<std::mutex> FhLRU;
667
668 struct FhLT
669 {
670 // for internal ordering
671 bool operator()(const RGWFileHandle& lhs, const RGWFileHandle& rhs) const
672 { return (lhs.get_key() < rhs.get_key()); }
673
674 // for external search by fh_key
675 bool operator()(const fh_key& k, const RGWFileHandle& fh) const
676 { return k < fh.get_key(); }
677
678 bool operator()(const RGWFileHandle& fh, const fh_key& k) const
679 { return fh.get_key() < k; }
680 };
681
682 struct FhEQ
683 {
684 bool operator()(const RGWFileHandle& lhs, const RGWFileHandle& rhs) const
685 { return (lhs.get_key() == rhs.get_key()); }
686
687 bool operator()(const fh_key& k, const RGWFileHandle& fh) const
688 { return k == fh.get_key(); }
689
690 bool operator()(const RGWFileHandle& fh, const fh_key& k) const
691 { return fh.get_key() == k; }
692 };
693
694 typedef bi::link_mode<bi::safe_link> link_mode; /* XXX normal */
695#if defined(FHCACHE_AVL)
696 typedef bi::avl_set_member_hook<link_mode> tree_hook_type;
697#else
698 /* RBT */
699 typedef bi::set_member_hook<link_mode> tree_hook_type;
700#endif
701 tree_hook_type fh_hook;
702
703 typedef bi::member_hook<
704 RGWFileHandle, tree_hook_type, &RGWFileHandle::fh_hook> FhHook;
705
706#if defined(FHCACHE_AVL)
707 typedef bi::avltree<RGWFileHandle, bi::compare<FhLT>, FhHook> FHTree;
708#else
709 typedef bi::rbtree<RGWFileHandle, bi::compare<FhLT>, FhHook> FhTree;
710#endif
711 typedef cohort::lru::TreeX<RGWFileHandle, FhTree, FhLT, FhEQ, fh_key,
712 std::mutex> FHCache;
713
714 ~RGWFileHandle() override;
715
716 friend std::ostream& operator<<(std::ostream &os,
717 RGWFileHandle const &rgw_fh);
718
719 class Factory : public cohort::lru::ObjectFactory
720 {
721 public:
722 RGWLibFS* fs;
7c673cae
FG
723 RGWFileHandle* parent;
724 const fh_key& fhk;
725 std::string& name;
726 uint32_t flags;
727
728 Factory() = delete;
729
3efd9988
FG
730 Factory(RGWLibFS* _fs, RGWFileHandle* _parent,
731 const fh_key& _fhk, std::string& _name, uint32_t _flags)
732 : fs(_fs), parent(_parent), fhk(_fhk), name(_name),
733 flags(_flags) {}
7c673cae
FG
734
735 void recycle (cohort::lru::Object* o) override {
736 /* re-use an existing object */
737 o->~Object(); // call lru::Object virtual dtor
738 // placement new!
3efd9988 739 new (o) RGWFileHandle(fs, parent, fhk, name, flags);
7c673cae
FG
740 }
741
742 cohort::lru::Object* alloc() override {
3efd9988 743 return new RGWFileHandle(fs, parent, fhk, name, flags);
7c673cae
FG
744 }
745 }; /* Factory */
746
747 }; /* RGWFileHandle */
748
749 WRITE_CLASS_ENCODER(RGWFileHandle);
750
751 static inline RGWFileHandle* get_rgwfh(struct rgw_file_handle* fh) {
752 return static_cast<RGWFileHandle*>(fh->fh_private);
753 }
754
755 static inline enum rgw_fh_type fh_type_of(uint32_t flags) {
756 enum rgw_fh_type fh_type;
757 switch(flags & RGW_LOOKUP_TYPE_FLAGS)
758 {
759 case RGW_LOOKUP_FLAG_DIR:
760 fh_type = RGW_FS_TYPE_DIRECTORY;
761 break;
762 case RGW_LOOKUP_FLAG_FILE:
763 fh_type = RGW_FS_TYPE_FILE;
764 break;
765 default:
766 fh_type = RGW_FS_TYPE_NIL;
767 };
768 return fh_type;
769 }
770
771 typedef std::tuple<RGWFileHandle*, uint32_t> LookupFHResult;
772 typedef std::tuple<RGWFileHandle*, int> MkObjResult;
773
774 class RGWLibFS
775 {
776 CephContext* cct;
224ce89b 777 struct rgw_fs fs{};
7c673cae
FG
778 RGWFileHandle root_fh;
779 rgw_fh_callback_t invalidate_cb;
780 void *invalidate_arg;
781 bool shutdown;
782
783 mutable std::atomic<uint64_t> refcnt;
784
785 RGWFileHandle::FHCache fh_cache;
786 RGWFileHandle::FhLRU fh_lru;
787
788 std::string uid; // should match user.user_id, iiuc
789
790 RGWUserInfo user;
791 RGWAccessKey key; // XXXX acc_key
792
793 static std::atomic<uint32_t> fs_inst_counter;
794
795 static uint32_t write_completion_interval_s;
7c673cae
FG
796
797 using lock_guard = std::lock_guard<std::mutex>;
798 using unique_lock = std::unique_lock<std::mutex>;
799
800 struct event
801 {
802 enum class type : uint8_t { READDIR } ;
803 type t;
804 const fh_key fhk;
805 struct timespec ts;
806 event(type t, const fh_key& k, const struct timespec& ts)
807 : t(t), fhk(k), ts(ts) {}
808 };
809
810 friend std::ostream& operator<<(std::ostream &os,
811 RGWLibFS::event const &ev);
812
813 using event_vector = /* boost::small_vector<event, 16> */
814 std::vector<event>;
815
816 struct WriteCompletion
817 {
818 RGWFileHandle& rgw_fh;
819
820 WriteCompletion(RGWFileHandle& _fh) : rgw_fh(_fh) {
821 rgw_fh.get_fs()->ref(&rgw_fh);
822 }
823
824 void operator()() {
31f18b77 825 rgw_fh.close(); /* will finish in-progress write */
7c673cae
FG
826 rgw_fh.get_fs()->unref(&rgw_fh);
827 }
828 };
829
830 static ceph::timer<ceph::mono_clock> write_timer;
831
832 struct State {
833 std::mutex mtx;
834 std::atomic<uint32_t> flags;
835 std::deque<event> events;
836
837 State() : flags(0) {}
838
839 void push_event(const event& ev) {
840 events.push_back(ev);
841 }
842 } state;
843
844 uint32_t new_inst() {
845 return ++fs_inst_counter;
846 }
847
848 friend class RGWFileHandle;
849 friend class RGWLibProcess;
850
851 public:
852
853 static constexpr uint32_t FLAG_NONE = 0x0000;
854 static constexpr uint32_t FLAG_CLOSED = 0x0001;
855
31f18b77
FG
856 struct BucketStats {
857 size_t size;
858 size_t size_rounded;
859 real_time creation_time;
860 uint64_t num_entries;
861 };
862
7c673cae 863 RGWLibFS(CephContext* _cct, const char *_uid, const char *_user_id,
3efd9988
FG
864 const char* _key, const char *root)
865 : cct(_cct), root_fh(this), invalidate_cb(nullptr),
7c673cae
FG
866 invalidate_arg(nullptr), shutdown(false), refcnt(1),
867 fh_cache(cct->_conf->rgw_nfs_fhcache_partitions,
868 cct->_conf->rgw_nfs_fhcache_size),
869 fh_lru(cct->_conf->rgw_nfs_lru_lanes,
870 cct->_conf->rgw_nfs_lru_lane_hiwat),
871 uid(_uid), key(_user_id, _key) {
872
3efd9988
FG
873 if (!root || !strcmp(root, "/")) {
874 root_fh.init_rootfs(uid, RGWFileHandle::root_name, false);
875 } else {
876 root_fh.init_rootfs(uid, root, true);
877 }
7c673cae
FG
878
879 /* pointer to self */
880 fs.fs_private = this;
881
882 /* expose public root fh */
883 fs.root_fh = root_fh.get_fh();
3efd9988
FG
884
885 new_inst();
7c673cae
FG
886 }
887
888 friend void intrusive_ptr_add_ref(const RGWLibFS* fs) {
889 fs->refcnt.fetch_add(1, std::memory_order_relaxed);
890 }
891
892 friend void intrusive_ptr_release(const RGWLibFS* fs) {
893 if (fs->refcnt.fetch_sub(1, std::memory_order_release) == 0) {
894 std::atomic_thread_fence(std::memory_order_acquire);
895 delete fs;
896 }
897 }
898
899 RGWLibFS* ref() {
900 intrusive_ptr_add_ref(this);
901 return this;
902 }
903
904 inline void rele() {
905 intrusive_ptr_release(this);
906 }
907
908 void stop() { shutdown = true; }
909
910 void release_evict(RGWFileHandle* fh) {
911 /* remove from cache, releases sentinel ref */
912 fh_cache.remove(fh->fh.fh_hk.object, fh,
913 RGWFileHandle::FHCache::FLAG_LOCK);
914 /* release call-path ref */
915 (void) fh_lru.unref(fh, cohort::lru::FLAG_NONE);
916 }
917
918 int authorize(RGWRados* store) {
919 int ret = rgw_get_user_info_by_access_key(store, key.id, user);
920 if (ret == 0) {
921 RGWAccessKey* key0 = user.get_key0();
922 if (!key0 ||
923 (key0->key != key.key))
924 return -EINVAL;
925 if (user.suspended)
926 return -ERR_USER_SUSPENDED;
927 } else {
928 /* try external authenticators (ldap for now) */
929 rgw::LDAPHelper* ldh = rgwlib.get_ldh(); /* !nullptr */
930 RGWToken token;
931 /* boost filters and/or string_ref may throw on invalid input */
932 try {
933 token = rgw::from_base64(key.id);
934 } catch(...) {
935 token = std::string("");
936 }
937 if (token.valid() && (ldh->auth(token.id, token.key) == 0)) {
938 /* try to store user if it doesn't already exist */
939 if (rgw_get_user_info_by_uid(store, token.id, user) < 0) {
940 int ret = rgw_store_user_info(store, user, NULL, NULL, real_time(),
941 true);
942 if (ret < 0) {
943 lsubdout(get_context(), rgw, 10)
944 << "NOTICE: failed to store new user's info: ret=" << ret
945 << dendl;
946 }
947 }
948 } /* auth success */
949 }
950 return ret;
951 } /* authorize */
952
953 int register_invalidate(rgw_fh_callback_t cb, void *arg, uint32_t flags) {
954 invalidate_cb = cb;
955 invalidate_arg = arg;
956 return 0;
957 }
958
959 /* find RGWFileHandle by id */
960 LookupFHResult lookup_fh(const fh_key& fhk,
961 const uint32_t flags = RGWFileHandle::FLAG_NONE) {
962 using std::get;
963
964 // cast int32_t(RGWFileHandle::FLAG_NONE) due to strictness of Clang
965 // the cast transfers a lvalue into a rvalue in the ctor
966 // check the commit message for the full details
967 LookupFHResult fhr { nullptr, uint32_t(RGWFileHandle::FLAG_NONE) };
968
969 RGWFileHandle::FHCache::Latch lat;
31f18b77 970 bool fh_locked = flags & RGWFileHandle::FLAG_LOCKED;
7c673cae
FG
971
972 retry:
973 RGWFileHandle* fh =
974 fh_cache.find_latch(fhk.fh_hk.object /* partition selector*/,
975 fhk /* key */, lat /* serializer */,
976 RGWFileHandle::FHCache::FLAG_LOCK);
977 /* LATCHED */
978 if (fh) {
31f18b77
FG
979 if (likely(! fh_locked))
980 fh->mtx.lock(); // XXX !RAII because may-return-LOCKED
7c673cae
FG
981 /* need initial ref from LRU (fast path) */
982 if (! fh_lru.ref(fh, cohort::lru::FLAG_INITIAL)) {
983 lat.lock->unlock();
31f18b77
FG
984 if (likely(! fh_locked))
985 fh->mtx.unlock();
7c673cae
FG
986 goto retry; /* !LATCHED */
987 }
988 /* LATCHED, LOCKED */
989 if (! (flags & RGWFileHandle::FLAG_LOCK))
990 fh->mtx.unlock(); /* ! LOCKED */
991 }
992 lat.lock->unlock(); /* !LATCHED */
993 get<0>(fhr) = fh;
994 if (fh) {
995 lsubdout(get_context(), rgw, 17)
996 << __func__ << " 1 " << *fh
997 << dendl;
998 }
999 return fhr;
1000 } /* lookup_fh(const fh_key&) */
1001
1002 /* find or create an RGWFileHandle */
1003 LookupFHResult lookup_fh(RGWFileHandle* parent, const char *name,
1004 const uint32_t flags = RGWFileHandle::FLAG_NONE) {
1005 using std::get;
1006
1007 // cast int32_t(RGWFileHandle::FLAG_NONE) due to strictness of Clang
1008 // the cast transfers a lvalue into a rvalue in the ctor
1009 // check the commit message for the full details
1010 LookupFHResult fhr { nullptr, uint32_t(RGWFileHandle::FLAG_NONE) };
1011
1012 /* mount is stale? */
1013 if (state.flags & FLAG_CLOSED)
1014 return fhr;
1015
1016 RGWFileHandle::FHCache::Latch lat;
31f18b77 1017 bool fh_locked = flags & RGWFileHandle::FLAG_LOCKED;
7c673cae
FG
1018
1019 std::string obj_name{name};
1020 std::string key_name{parent->make_key_name(name)};
1021
1022 lsubdout(get_context(), rgw, 10)
1023 << __func__ << " lookup called on "
1024 << parent->object_name() << " for " << key_name
1025 << " (" << obj_name << ")"
1026 << dendl;
1027
224ce89b 1028 fh_key fhk = parent->make_fhk(obj_name);
7c673cae
FG
1029
1030 retry:
1031 RGWFileHandle* fh =
1032 fh_cache.find_latch(fhk.fh_hk.object /* partition selector*/,
1033 fhk /* key */, lat /* serializer */,
1034 RGWFileHandle::FHCache::FLAG_LOCK);
1035 /* LATCHED */
1036 if (fh) {
31f18b77
FG
1037 if (likely(! fh_locked))
1038 fh->mtx.lock(); // XXX !RAII because may-return-LOCKED
7c673cae
FG
1039 if (fh->flags & RGWFileHandle::FLAG_DELETED) {
1040 /* for now, delay briefly and retry */
1041 lat.lock->unlock();
31f18b77
FG
1042 if (likely(! fh_locked))
1043 fh->mtx.unlock();
7c673cae
FG
1044 std::this_thread::sleep_for(std::chrono::milliseconds(20));
1045 goto retry; /* !LATCHED */
1046 }
1047 /* need initial ref from LRU (fast path) */
1048 if (! fh_lru.ref(fh, cohort::lru::FLAG_INITIAL)) {
1049 lat.lock->unlock();
31f18b77
FG
1050 if (likely(! fh_locked))
1051 fh->mtx.unlock();
7c673cae
FG
1052 goto retry; /* !LATCHED */
1053 }
1054 /* LATCHED, LOCKED */
1055 if (! (flags & RGWFileHandle::FLAG_LOCK))
31f18b77
FG
1056 if (likely(! fh_locked))
1057 fh->mtx.unlock(); /* ! LOCKED */
7c673cae
FG
1058 } else {
1059 /* make or re-use handle */
3efd9988 1060 RGWFileHandle::Factory prototype(this, parent, fhk,
7c673cae 1061 obj_name, CREATE_FLAGS(flags));
b32b8144 1062 uint32_t iflags{cohort::lru::FLAG_INITIAL};
7c673cae
FG
1063 fh = static_cast<RGWFileHandle*>(
1064 fh_lru.insert(&prototype,
1065 cohort::lru::Edge::MRU,
b32b8144 1066 iflags));
7c673cae
FG
1067 if (fh) {
1068 /* lock fh (LATCHED) */
1069 if (flags & RGWFileHandle::FLAG_LOCK)
1070 fh->mtx.lock();
b32b8144
FG
1071 if (likely(! (iflags & cohort::lru::FLAG_RECYCLE))) {
1072 /* inserts at cached insert iterator, releasing latch */
1073 fh_cache.insert_latched(
1074 fh, lat, RGWFileHandle::FHCache::FLAG_UNLOCK);
1075 } else {
1076 /* recycle step invalidates Latch */
1077 fh_cache.insert(
1078 fhk.fh_hk.object, fh, RGWFileHandle::FHCache::FLAG_NONE);
1079 lat.lock->unlock(); /* !LATCHED */
1080 }
7c673cae
FG
1081 get<1>(fhr) |= RGWFileHandle::FLAG_CREATE;
1082 /* ref parent (non-initial ref cannot fail on valid object) */
3efd9988 1083 if (! parent->is_mount()) {
7c673cae
FG
1084 (void) fh_lru.ref(parent, cohort::lru::FLAG_NONE);
1085 }
1086 goto out; /* !LATCHED */
1087 } else {
1088 lat.lock->unlock();
1089 goto retry; /* !LATCHED */
1090 }
1091 }
1092 lat.lock->unlock(); /* !LATCHED */
1093 out:
1094 get<0>(fhr) = fh;
1095 if (fh) {
1096 lsubdout(get_context(), rgw, 17)
1097 << __func__ << " 2 " << *fh
1098 << dendl;
1099 }
1100 return fhr;
1101 } /* lookup_fh(RGWFileHandle*, const char *, const uint32_t) */
1102
1103 inline void unref(RGWFileHandle* fh) {
3efd9988 1104 if (likely(! fh->is_mount())) {
7c673cae
FG
1105 (void) fh_lru.unref(fh, cohort::lru::FLAG_NONE);
1106 }
1107 }
1108
1109 inline RGWFileHandle* ref(RGWFileHandle* fh) {
3efd9988 1110 if (likely(! fh->is_mount())) {
7c673cae
FG
1111 fh_lru.ref(fh, cohort::lru::FLAG_NONE);
1112 }
1113 return fh;
1114 }
1115
1116 int getattr(RGWFileHandle* rgw_fh, struct stat* st);
1117
1118 int setattr(RGWFileHandle* rgw_fh, struct stat* st, uint32_t mask,
1119 uint32_t flags);
1120
3efd9988 1121 void update_fh(RGWFileHandle *rgw_fh);
224ce89b 1122
31f18b77
FG
1123 LookupFHResult stat_bucket(RGWFileHandle* parent, const char *path,
1124 RGWLibFS::BucketStats& bs,
1125 uint32_t flags);
7c673cae
FG
1126
1127 LookupFHResult stat_leaf(RGWFileHandle* parent, const char *path,
1128 enum rgw_fh_type type = RGW_FS_TYPE_NIL,
1129 uint32_t flags = RGWFileHandle::FLAG_NONE);
1130
1131 int read(RGWFileHandle* rgw_fh, uint64_t offset, size_t length,
1132 size_t* bytes_read, void* buffer, uint32_t flags);
1133
1134 int rename(RGWFileHandle* old_fh, RGWFileHandle* new_fh,
1135 const char *old_name, const char *new_name);
1136
1137 MkObjResult create(RGWFileHandle* parent, const char *name, struct stat *st,
1138 uint32_t mask, uint32_t flags);
1139
1140 MkObjResult mkdir(RGWFileHandle* parent, const char *name, struct stat *st,
1141 uint32_t mask, uint32_t flags);
7c673cae
FG
1142
1143 int unlink(RGWFileHandle* rgw_fh, const char *name,
1144 uint32_t flags = FLAG_NONE);
1145
1146 /* find existing RGWFileHandle */
1147 RGWFileHandle* lookup_handle(struct rgw_fh_hk fh_hk) {
1148
1149 if (state.flags & FLAG_CLOSED)
1150 return nullptr;
1151
1152 RGWFileHandle::FHCache::Latch lat;
1153 fh_key fhk(fh_hk);
1154
1155 retry:
1156 RGWFileHandle* fh =
1157 fh_cache.find_latch(fhk.fh_hk.object /* partition selector*/,
1158 fhk /* key */, lat /* serializer */,
1159 RGWFileHandle::FHCache::FLAG_LOCK);
1160 /* LATCHED */
1161 if (! fh) {
1162 lsubdout(get_context(), rgw, 0)
1163 << __func__ << " handle lookup failed <"
1164 << fhk.fh_hk.bucket << "," << fhk.fh_hk.object << ">"
1165 << "(need persistent handles)"
1166 << dendl;
1167 goto out;
1168 }
1169 fh->mtx.lock();
1170 if (fh->flags & RGWFileHandle::FLAG_DELETED) {
1171 /* for now, delay briefly and retry */
1172 lat.lock->unlock();
1173 fh->mtx.unlock(); /* !LOCKED */
1174 std::this_thread::sleep_for(std::chrono::milliseconds(20));
1175 goto retry; /* !LATCHED */
1176 }
1177 if (! fh_lru.ref(fh, cohort::lru::FLAG_INITIAL)) {
1178 lat.lock->unlock();
1179 fh->mtx.unlock();
1180 goto retry; /* !LATCHED */
1181 }
1182 /* LATCHED */
1183 fh->mtx.unlock(); /* !LOCKED */
1184 out:
1185 lat.lock->unlock(); /* !LATCHED */
1186
1187 /* special case: lookup root_fh */
1188 if (! fh) {
1189 if (unlikely(fh_hk == root_fh.fh.fh_hk)) {
1190 fh = &root_fh;
7c673cae
FG
1191 }
1192 }
1193
1194 return fh;
1195 }
1196
1197 CephContext* get_context() {
1198 return cct;
1199 }
1200
1201 struct rgw_fs* get_fs() { return &fs; }
1202
3efd9988 1203 uint64_t get_fsid() { return root_fh.state.dev; }
7c673cae
FG
1204
1205 RGWUserInfo* get_user() { return &user; }
1206
1207 void close();
1208 void gc();
1209 }; /* RGWLibFS */
1210
1211static inline std::string make_uri(const std::string& bucket_name,
1212 const std::string& object_name) {
1213 std::string uri("/");
1214 uri.reserve(bucket_name.length() + object_name.length() + 2);
1215 uri += bucket_name;
1216 uri += "/";
1217 uri += object_name;
1218 return uri;
1219}
1220
1221/*
1222 read directory content (buckets)
1223*/
1224
1225class RGWListBucketsRequest : public RGWLibRequest,
1226 public RGWListBuckets /* RGWOp */
1227{
1228public:
1229 RGWFileHandle* rgw_fh;
3efd9988 1230 RGWFileHandle::readdir_offset offset;
7c673cae
FG
1231 void* cb_arg;
1232 rgw_readdir_cb rcb;
3efd9988 1233 uint64_t* ioff;
7c673cae
FG
1234 size_t ix;
1235 uint32_t d_count;
1236
1237 RGWListBucketsRequest(CephContext* _cct, RGWUserInfo *_user,
1238 RGWFileHandle* _rgw_fh, rgw_readdir_cb _rcb,
3efd9988 1239 void* _cb_arg, RGWFileHandle::readdir_offset& _offset)
7c673cae 1240 : RGWLibRequest(_cct, _user), rgw_fh(_rgw_fh), offset(_offset),
3efd9988
FG
1241 cb_arg(_cb_arg), rcb(_rcb), ioff(nullptr), ix(0), d_count(0) {
1242
1243 using boost::get;
1244
1245 if (unlikely(!! get<uint64_t*>(&offset))) {
1246 ioff = get<uint64_t*>(offset);
1247 const auto& mk = rgw_fh->find_marker(*ioff);
1248 if (mk) {
1249 marker = mk->name;
1250 }
1251 } else {
1252 const char* mk = get<const char*>(offset);
1253 if (mk) {
1254 marker = mk;
1255 }
7c673cae
FG
1256 }
1257 op = this;
1258 }
1259
1260 bool only_bucket() override { return false; }
1261
1262 int op_init() override {
1263 // assign store, s, and dialect_handler
1264 RGWObjectCtx* rados_ctx
1265 = static_cast<RGWObjectCtx*>(get_state()->obj_ctx);
1266 // framework promises to call op_init after parent init
1267 assert(rados_ctx);
1268 RGWOp::init(rados_ctx->store, get_state(), this);
1269 op = this; // assign self as op: REQUIRED
1270 return 0;
1271 }
1272
1273 int header_init() override {
1274 struct req_state* s = get_state();
1275 s->info.method = "GET";
1276 s->op = OP_GET;
1277
1278 /* XXX derp derp derp */
1279 s->relative_uri = "/";
1280 s->info.request_uri = "/"; // XXX
1281 s->info.effective_uri = "/";
1282 s->info.request_params = "";
1283 s->info.domain = ""; /* XXX ? */
1284
1285 // woo
1286 s->user = user;
1287
1288 return 0;
1289 }
1290
1291 int get_params() override {
1292 limit = -1; /* no limit */
1293 return 0;
1294 }
1295
1296 void send_response_begin(bool has_buckets) override {
1297 sent_data = true;
1298 }
1299
1300 void send_response_data(RGWUserBuckets& buckets) override {
1301 if (!sent_data)
1302 return;
1303 map<string, RGWBucketEnt>& m = buckets.get_buckets();
1304 for (const auto& iter : m) {
1305 boost::string_ref marker{iter.first};
1306 const RGWBucketEnt& ent = iter.second;
1307 if (! this->operator()(ent.bucket.name, marker)) {
1308 /* caller cannot accept more */
1309 lsubdout(cct, rgw, 5) << "ListBuckets rcb failed"
1310 << " dirent=" << ent.bucket.name
1311 << " call count=" << ix
1312 << dendl;
1313 return;
1314 }
1315 ++ix;
1316 }
1317 } /* send_response_data */
1318
1319 void send_response_end() override {
1320 // do nothing
1321 }
1322
1323 int operator()(const boost::string_ref& name,
1324 const boost::string_ref& marker) {
1325 uint64_t off = XXH64(name.data(), name.length(), fh_key::seed);
3efd9988
FG
1326 if (!! ioff) {
1327 *ioff = off;
1328 }
7c673cae
FG
1329 /* update traversal cache */
1330 rgw_fh->add_marker(off, rgw_obj_key{marker.data(), ""},
1331 RGW_FS_TYPE_DIRECTORY);
1332 ++d_count;
1333 return rcb(name.data(), cb_arg, off, RGW_LOOKUP_FLAG_DIR);
1334 }
1335
1336 bool eof() {
3efd9988 1337 lsubdout(cct, rgw, 15) << "READDIR offset: " << offset
7c673cae
FG
1338 << " is_truncated: " << is_truncated
1339 << dendl;
1340 return !is_truncated;
1341 }
1342
1343}; /* RGWListBucketsRequest */
1344
1345/*
1346 read directory content (bucket objects)
1347*/
1348
1349class RGWReaddirRequest : public RGWLibRequest,
1350 public RGWListBucket /* RGWOp */
1351{
1352public:
1353 RGWFileHandle* rgw_fh;
3efd9988 1354 RGWFileHandle::readdir_offset offset;
7c673cae
FG
1355 void* cb_arg;
1356 rgw_readdir_cb rcb;
3efd9988 1357 uint64_t* ioff;
7c673cae
FG
1358 size_t ix;
1359 uint32_t d_count;
1360
1361 RGWReaddirRequest(CephContext* _cct, RGWUserInfo *_user,
1362 RGWFileHandle* _rgw_fh, rgw_readdir_cb _rcb,
3efd9988 1363 void* _cb_arg, RGWFileHandle::readdir_offset& _offset)
7c673cae 1364 : RGWLibRequest(_cct, _user), rgw_fh(_rgw_fh), offset(_offset),
3efd9988
FG
1365 cb_arg(_cb_arg), rcb(_rcb), ioff(nullptr), ix(0), d_count(0) {
1366
1367 using boost::get;
1368
1369 if (unlikely(!! get<uint64_t*>(&offset))) {
1370 ioff = get<uint64_t*>(offset);
1371 const auto& mk = rgw_fh->find_marker(*ioff);
1372 if (mk) {
1373 marker = *mk;
1374 }
1375 } else {
1376 const char* mk = get<const char*>(offset);
1377 if (mk) {
1378 std::string tmark{rgw_fh->relative_object_name()};
1379 tmark += "/";
1380 tmark += mk;
1381 marker = rgw_obj_key{std::move(tmark), "", ""};
1382 }
7c673cae 1383 }
3efd9988 1384
7c673cae
FG
1385 default_max = 1000; // XXX was being omitted
1386 op = this;
1387 }
1388
224ce89b 1389 bool only_bucket() override { return true; }
7c673cae
FG
1390
1391 int op_init() override {
1392 // assign store, s, and dialect_handler
1393 RGWObjectCtx* rados_ctx
1394 = static_cast<RGWObjectCtx*>(get_state()->obj_ctx);
1395 // framework promises to call op_init after parent init
1396 assert(rados_ctx);
1397 RGWOp::init(rados_ctx->store, get_state(), this);
1398 op = this; // assign self as op: REQUIRED
1399 return 0;
1400 }
1401
1402 int header_init() override {
1403 struct req_state* s = get_state();
1404 s->info.method = "GET";
1405 s->op = OP_GET;
1406
1407 /* XXX derp derp derp */
1408 std::string uri = "/" + rgw_fh->bucket_name() + "/";
1409 s->relative_uri = uri;
1410 s->info.request_uri = uri; // XXX
1411 s->info.effective_uri = uri;
1412 s->info.request_params = "";
1413 s->info.domain = ""; /* XXX ? */
1414
1415 // woo
1416 s->user = user;
1417
1418 prefix = rgw_fh->relative_object_name();
1419 if (prefix.length() > 0)
1420 prefix += "/";
1421 delimiter = '/';
1422
1423 return 0;
1424 }
1425
1426 int operator()(const boost::string_ref name, const rgw_obj_key& marker,
1427 uint8_t type) {
1428
1429 assert(name.length() > 0); // XXX
1430
1431 /* hash offset of name in parent (short name) for NFS readdir cookie */
1432 uint64_t off = XXH64(name.data(), name.length(), fh_key::seed);
3efd9988
FG
1433 if (unlikely(!! ioff)) {
1434 *ioff = off;
1435 }
7c673cae
FG
1436 /* update traversal cache */
1437 rgw_fh->add_marker(off, marker, type);
1438 ++d_count;
1439 return rcb(name.data(), cb_arg, off,
1440 (type == RGW_FS_TYPE_DIRECTORY) ?
1441 RGW_LOOKUP_FLAG_DIR :
1442 RGW_LOOKUP_FLAG_FILE);
1443 }
1444
1445 int get_params() override {
1446 max = default_max;
1447 return 0;
1448 }
1449
1450 void send_response() override {
1451 struct req_state* s = get_state();
1452 for (const auto& iter : objs) {
1453
1454 boost::string_ref sref {iter.key.name};
1455
1456 lsubdout(cct, rgw, 15) << "readdir objects prefix: " << prefix
1457 << " obj: " << sref << dendl;
1458
1459 size_t last_del = sref.find_last_of('/');
1460 if (last_del != string::npos)
1461 sref.remove_prefix(last_del+1);
1462
1463 /* leaf directory? */
1464 if (sref.empty())
1465 continue;
1466
1467 lsubdout(cct, rgw, 15) << "RGWReaddirRequest "
1468 << __func__ << " "
1469 << "list uri=" << s->relative_uri << " "
1470 << " prefix=" << prefix << " "
1471 << " obj path=" << iter.key.name
1472 << " (" << sref << ")" << ""
1473 << dendl;
1474
1475 if(! this->operator()(sref, next_marker, RGW_FS_TYPE_FILE)) {
1476 /* caller cannot accept more */
1477 lsubdout(cct, rgw, 5) << "readdir rcb failed"
1478 << " dirent=" << sref.data()
1479 << " call count=" << ix
1480 << dendl;
1481 return;
1482 }
1483 ++ix;
1484 }
1485 for (auto& iter : common_prefixes) {
1486
1487 lsubdout(cct, rgw, 15) << "readdir common prefixes prefix: " << prefix
1488 << " iter first: " << iter.first
1489 << " iter second: " << iter.second
1490 << dendl;
1491
1492 /* XXX aieee--I have seen this case! */
1493 if (iter.first == "/")
1494 continue;
1495
1496 /* it's safest to modify the element in place--a suffix-modifying
1497 * string_ref operation is problematic since ULP rgw_file callers
1498 * will ultimately need a c-string */
1499 if (iter.first.back() == '/')
1500 const_cast<std::string&>(iter.first).pop_back();
1501
1502 boost::string_ref sref{iter.first};
1503
1504 size_t last_del = sref.find_last_of('/');
1505 if (last_del != string::npos)
1506 sref.remove_prefix(last_del+1);
1507
1508 lsubdout(cct, rgw, 15) << "RGWReaddirRequest "
1509 << __func__ << " "
1510 << "list uri=" << s->relative_uri << " "
1511 << " prefix=" << prefix << " "
1512 << " cpref=" << sref
1513 << dendl;
1514
1515 this->operator()(sref, next_marker, RGW_FS_TYPE_DIRECTORY);
1516 ++ix;
1517 }
1518 }
1519
1520 virtual void send_versioned_response() {
1521 send_response();
1522 }
1523
1524 bool eof() {
3efd9988 1525 lsubdout(cct, rgw, 15) << "READDIR offset: " << offset
7c673cae
FG
1526 << " next marker: " << next_marker
1527 << " is_truncated: " << is_truncated
1528 << dendl;
1529 return !is_truncated;
1530 }
1531
1532}; /* RGWReaddirRequest */
1533
1534/*
1535 dir has-children predicate (bucket objects)
1536*/
1537
1538class RGWRMdirCheck : public RGWLibRequest,
1539 public RGWListBucket /* RGWOp */
1540{
1541public:
1542 const RGWFileHandle* rgw_fh;
1543 bool valid;
1544 bool has_children;
1545
1546 RGWRMdirCheck (CephContext* _cct, RGWUserInfo *_user,
1547 const RGWFileHandle* _rgw_fh)
1548 : RGWLibRequest(_cct, _user), rgw_fh(_rgw_fh), valid(false),
1549 has_children(false) {
1550 default_max = 2;
1551 op = this;
1552 }
1553
224ce89b 1554 bool only_bucket() override { return true; }
7c673cae
FG
1555
1556 int op_init() override {
1557 // assign store, s, and dialect_handler
1558 RGWObjectCtx* rados_ctx
1559 = static_cast<RGWObjectCtx*>(get_state()->obj_ctx);
1560 // framework promises to call op_init after parent init
1561 assert(rados_ctx);
1562 RGWOp::init(rados_ctx->store, get_state(), this);
1563 op = this; // assign self as op: REQUIRED
1564 return 0;
1565 }
1566
1567 int header_init() override {
1568 struct req_state* s = get_state();
1569 s->info.method = "GET";
1570 s->op = OP_GET;
1571
1572 std::string uri = "/" + rgw_fh->bucket_name() + "/";
1573 s->relative_uri = uri;
1574 s->info.request_uri = uri;
1575 s->info.effective_uri = uri;
1576 s->info.request_params = "";
1577 s->info.domain = ""; /* XXX ? */
1578
1579 s->user = user;
1580
1581 prefix = rgw_fh->relative_object_name();
1582 if (prefix.length() > 0)
1583 prefix += "/";
1584 delimiter = '/';
1585
1586 return 0;
1587 }
1588
1589 int get_params() override {
1590 max = default_max;
1591 return 0;
1592 }
1593
1594 void send_response() override {
1595 valid = true;
1596 if ((objs.size() > 1) ||
1597 (! objs.empty() &&
1598 (objs.front().key.name != prefix))) {
1599 has_children = true;
1600 return;
1601 }
1602 for (auto& iter : common_prefixes) {
1603 /* readdir never produces a name for this case */
1604 if (iter.first == "/")
1605 continue;
1606 has_children = true;
1607 break;
1608 }
1609 }
1610
1611 virtual void send_versioned_response() {
1612 send_response();
1613 }
1614
1615}; /* RGWRMdirCheck */
1616
1617/*
1618 create bucket
1619*/
1620
1621class RGWCreateBucketRequest : public RGWLibRequest,
1622 public RGWCreateBucket /* RGWOp */
1623{
1624public:
31f18b77 1625 const std::string& bucket_name;
7c673cae
FG
1626
1627 RGWCreateBucketRequest(CephContext* _cct, RGWUserInfo *_user,
31f18b77
FG
1628 std::string& _bname)
1629 : RGWLibRequest(_cct, _user), bucket_name(_bname) {
7c673cae
FG
1630 op = this;
1631 }
1632
1633 bool only_bucket() override { return false; }
1634
1635 int read_permissions(RGWOp* op_obj) override {
1636 /* we ARE a 'create bucket' request (cf. rgw_rest.cc, ll. 1305-6) */
1637 return 0;
1638 }
1639
1640 int op_init() override {
1641 // assign store, s, and dialect_handler
1642 RGWObjectCtx* rados_ctx
1643 = static_cast<RGWObjectCtx*>(get_state()->obj_ctx);
1644 // framework promises to call op_init after parent init
1645 assert(rados_ctx);
1646 RGWOp::init(rados_ctx->store, get_state(), this);
1647 op = this; // assign self as op: REQUIRED
1648 return 0;
1649 }
1650
1651 int header_init() override {
1652
1653 struct req_state* s = get_state();
1654 s->info.method = "PUT";
1655 s->op = OP_PUT;
1656
31f18b77 1657 string uri = "/" + bucket_name;
7c673cae
FG
1658 /* XXX derp derp derp */
1659 s->relative_uri = uri;
1660 s->info.request_uri = uri; // XXX
1661 s->info.effective_uri = uri;
1662 s->info.request_params = "";
1663 s->info.domain = ""; /* XXX ? */
1664
1665 // woo
1666 s->user = user;
1667
1668 return 0;
1669 }
1670
1671 int get_params() override {
1672 struct req_state* s = get_state();
1673 RGWAccessControlPolicy_S3 s3policy(s->cct);
1674 /* we don't have (any) headers, so just create canned ACLs */
1675 int ret = s3policy.create_canned(s->owner, s->bucket_owner, s->canned_acl);
1676 policy = s3policy;
1677 return ret;
1678 }
1679
1680 void send_response() override {
1681 /* TODO: something (maybe) */
1682 }
1683}; /* RGWCreateBucketRequest */
1684
1685/*
1686 delete bucket
1687*/
1688
1689class RGWDeleteBucketRequest : public RGWLibRequest,
1690 public RGWDeleteBucket /* RGWOp */
1691{
1692public:
31f18b77 1693 const std::string& bucket_name;
7c673cae
FG
1694
1695 RGWDeleteBucketRequest(CephContext* _cct, RGWUserInfo *_user,
31f18b77
FG
1696 std::string& _bname)
1697 : RGWLibRequest(_cct, _user), bucket_name(_bname) {
7c673cae
FG
1698 op = this;
1699 }
1700
1701 bool only_bucket() override { return true; }
1702
1703 int op_init() override {
1704 // assign store, s, and dialect_handler
1705 RGWObjectCtx* rados_ctx
1706 = static_cast<RGWObjectCtx*>(get_state()->obj_ctx);
1707 // framework promises to call op_init after parent init
1708 assert(rados_ctx);
1709 RGWOp::init(rados_ctx->store, get_state(), this);
1710 op = this; // assign self as op: REQUIRED
1711 return 0;
1712 }
1713
1714 int header_init() override {
1715
1716 struct req_state* s = get_state();
1717 s->info.method = "DELETE";
1718 s->op = OP_DELETE;
1719
31f18b77 1720 string uri = "/" + bucket_name;
7c673cae
FG
1721 /* XXX derp derp derp */
1722 s->relative_uri = uri;
1723 s->info.request_uri = uri; // XXX
1724 s->info.effective_uri = uri;
1725 s->info.request_params = "";
1726 s->info.domain = ""; /* XXX ? */
1727
1728 // woo
1729 s->user = user;
1730
1731 return 0;
1732 }
1733
1734 void send_response() override {}
1735
1736}; /* RGWDeleteBucketRequest */
1737
1738/*
1739 put object
1740*/
1741class RGWPutObjRequest : public RGWLibRequest,
1742 public RGWPutObj /* RGWOp */
1743{
1744public:
1745 const std::string& bucket_name;
1746 const std::string& obj_name;
1747 buffer::list& bl; /* XXX */
1748 size_t bytes_written;
1749
1750 RGWPutObjRequest(CephContext* _cct, RGWUserInfo *_user,
1751 const std::string& _bname, const std::string& _oname,
1752 buffer::list& _bl)
1753 : RGWLibRequest(_cct, _user), bucket_name(_bname), obj_name(_oname),
1754 bl(_bl), bytes_written(0) {
1755 op = this;
1756 }
1757
1758 bool only_bucket() override { return true; }
1759
1760 int op_init() override {
1761 // assign store, s, and dialect_handler
1762 RGWObjectCtx* rados_ctx
1763 = static_cast<RGWObjectCtx*>(get_state()->obj_ctx);
1764 // framework promises to call op_init after parent init
1765 assert(rados_ctx);
1766 RGWOp::init(rados_ctx->store, get_state(), this);
1767 op = this; // assign self as op: REQUIRED
1768
1769 int rc = valid_s3_object_name(obj_name);
1770 if (rc != 0)
1771 return rc;
1772
1773 return 0;
1774 }
1775
1776 int header_init() override {
1777
1778 struct req_state* s = get_state();
1779 s->info.method = "PUT";
1780 s->op = OP_PUT;
1781
1782 /* XXX derp derp derp */
1783 std::string uri = make_uri(bucket_name, obj_name);
1784 s->relative_uri = uri;
1785 s->info.request_uri = uri; // XXX
1786 s->info.effective_uri = uri;
1787 s->info.request_params = "";
1788 s->info.domain = ""; /* XXX ? */
1789
1790 /* XXX required in RGWOp::execute() */
1791 s->content_length = bl.length();
1792
1793 // woo
1794 s->user = user;
1795
1796 return 0;
1797 }
1798
1799 int get_params() override {
1800 struct req_state* s = get_state();
1801 RGWAccessControlPolicy_S3 s3policy(s->cct);
1802 /* we don't have (any) headers, so just create canned ACLs */
1803 int ret = s3policy.create_canned(s->owner, s->bucket_owner, s->canned_acl);
1804 policy = s3policy;
1805 return ret;
1806 }
1807
1808 int get_data(buffer::list& _bl) override {
1809 /* XXX for now, use sharing semantics */
1810 _bl.claim(bl);
1811 uint32_t len = _bl.length();
1812 bytes_written += len;
1813 return len;
1814 }
1815
1816 void send_response() override {}
1817
1818 int verify_params() override {
1819 if (bl.length() > cct->_conf->rgw_max_put_size)
1820 return -ERR_TOO_LARGE;
1821 return 0;
1822 }
1823
1824}; /* RGWPutObjRequest */
1825
1826/*
1827 get object
1828*/
1829
1830class RGWReadRequest : public RGWLibRequest,
1831 public RGWGetObj /* RGWOp */
1832{
1833public:
1834 RGWFileHandle* rgw_fh;
1835 void *ulp_buffer;
1836 size_t nread;
1837 size_t read_resid; /* initialize to len, <= sizeof(ulp_buffer) */
1838 bool do_hexdump = false;
1839
1840 RGWReadRequest(CephContext* _cct, RGWUserInfo *_user,
1841 RGWFileHandle* _rgw_fh, uint64_t off, uint64_t len,
1842 void *_ulp_buffer)
1843 : RGWLibRequest(_cct, _user), rgw_fh(_rgw_fh), ulp_buffer(_ulp_buffer),
1844 nread(0), read_resid(len) {
1845 op = this;
1846
1847 /* fixup RGWGetObj (already know range parameters) */
1848 RGWGetObj::range_parsed = true;
1849 RGWGetObj::get_data = true; // XXX
1850 RGWGetObj::partial_content = true;
1851 RGWGetObj::ofs = off;
1852 RGWGetObj::end = off + len;
1853 }
1854
1855 bool only_bucket() override { return false; }
1856
1857 int op_init() override {
1858 // assign store, s, and dialect_handler
1859 RGWObjectCtx* rados_ctx
1860 = static_cast<RGWObjectCtx*>(get_state()->obj_ctx);
1861 // framework promises to call op_init after parent init
1862 assert(rados_ctx);
1863 RGWOp::init(rados_ctx->store, get_state(), this);
1864 op = this; // assign self as op: REQUIRED
1865 return 0;
1866 }
1867
1868 int header_init() override {
1869
1870 struct req_state* s = get_state();
1871 s->info.method = "GET";
1872 s->op = OP_GET;
1873
1874 /* XXX derp derp derp */
1875 s->relative_uri = make_uri(rgw_fh->bucket_name(),
1876 rgw_fh->relative_object_name());
1877 s->info.request_uri = s->relative_uri; // XXX
1878 s->info.effective_uri = s->relative_uri;
1879 s->info.request_params = "";
1880 s->info.domain = ""; /* XXX ? */
1881
1882 // woo
1883 s->user = user;
1884
1885 return 0;
1886 }
1887
1888 int get_params() override {
1889 return 0;
1890 }
1891
1892 int send_response_data(ceph::buffer::list& bl, off_t bl_off,
1893 off_t bl_len) override {
1894 size_t bytes;
1895 for (auto& bp : bl.buffers()) {
1896 /* if for some reason bl_off indicates the start-of-data is not at
1897 * the current buffer::ptr, skip it and account */
1898 if (bl_off > bp.length()) {
1899 bl_off -= bp.length();
1900 continue;
1901 }
1902 /* read no more than read_resid */
1903 bytes = std::min(read_resid, size_t(bp.length()-bl_off));
1904 memcpy(static_cast<char*>(ulp_buffer)+nread, bp.c_str()+bl_off, bytes);
1905 read_resid -= bytes; /* reduce read_resid by bytes read */
1906 nread += bytes;
1907 bl_off = 0;
1908 /* stop if we have no residual ulp_buffer */
1909 if (! read_resid)
1910 break;
1911 }
1912 return 0;
1913 }
1914
1915 int send_response_data_error() override {
1916 /* S3 implementation just sends nothing--there is no side effect
1917 * to simulate here */
1918 return 0;
1919 }
1920
1921}; /* RGWReadRequest */
1922
1923/*
1924 delete object
1925*/
1926
1927class RGWDeleteObjRequest : public RGWLibRequest,
1928 public RGWDeleteObj /* RGWOp */
1929{
1930public:
1931 const std::string& bucket_name;
1932 const std::string& obj_name;
1933
1934 RGWDeleteObjRequest(CephContext* _cct, RGWUserInfo *_user,
1935 const std::string& _bname, const std::string& _oname)
1936 : RGWLibRequest(_cct, _user), bucket_name(_bname), obj_name(_oname) {
1937 op = this;
1938 }
1939
1940 bool only_bucket() override { return true; }
1941
1942 int op_init() override {
1943 // assign store, s, and dialect_handler
1944 RGWObjectCtx* rados_ctx
1945 = static_cast<RGWObjectCtx*>(get_state()->obj_ctx);
1946 // framework promises to call op_init after parent init
1947 assert(rados_ctx);
1948 RGWOp::init(rados_ctx->store, get_state(), this);
1949 op = this; // assign self as op: REQUIRED
1950 return 0;
1951 }
1952
1953 int header_init() override {
1954
1955 struct req_state* s = get_state();
1956 s->info.method = "DELETE";
1957 s->op = OP_DELETE;
1958
1959 /* XXX derp derp derp */
1960 std::string uri = make_uri(bucket_name, obj_name);
1961 s->relative_uri = uri;
1962 s->info.request_uri = uri; // XXX
1963 s->info.effective_uri = uri;
1964 s->info.request_params = "";
1965 s->info.domain = ""; /* XXX ? */
1966
1967 // woo
1968 s->user = user;
1969
1970 return 0;
1971 }
1972
1973 void send_response() override {}
1974
1975}; /* RGWDeleteObjRequest */
1976
1977class RGWStatObjRequest : public RGWLibRequest,
1978 public RGWGetObj /* RGWOp */
1979{
1980public:
1981 const std::string& bucket_name;
1982 const std::string& obj_name;
1983 uint64_t _size;
1984 uint32_t flags;
1985
1986 static constexpr uint32_t FLAG_NONE = 0x000;
1987
1988 RGWStatObjRequest(CephContext* _cct, RGWUserInfo *_user,
1989 const std::string& _bname, const std::string& _oname,
1990 uint32_t _flags)
1991 : RGWLibRequest(_cct, _user), bucket_name(_bname), obj_name(_oname),
1992 _size(0), flags(_flags) {
1993 op = this;
1994
1995 /* fixup RGWGetObj (already know range parameters) */
1996 RGWGetObj::range_parsed = true;
1997 RGWGetObj::get_data = false; // XXX
1998 RGWGetObj::partial_content = true;
1999 RGWGetObj::ofs = 0;
2000 RGWGetObj::end = UINT64_MAX;
2001 }
2002
2003 const string name() override { return "stat_obj"; }
2004 RGWOpType get_type() override { return RGW_OP_STAT_OBJ; }
2005
2006 real_time get_mtime() const {
2007 return lastmod;
2008 }
2009
2010 /* attributes */
2011 uint64_t get_size() { return _size; }
2012 real_time ctime() { return mod_time; } // XXX
2013 real_time mtime() { return mod_time; }
2014 std::map<string, bufferlist>& get_attrs() { return attrs; }
2015
2016 buffer::list* get_attr(const std::string& k) {
2017 auto iter = attrs.find(k);
2018 return (iter != attrs.end()) ? &(iter->second) : nullptr;
2019 }
2020
2021 bool only_bucket() override { return false; }
2022
2023 int op_init() override {
2024 // assign store, s, and dialect_handler
2025 RGWObjectCtx* rados_ctx
2026 = static_cast<RGWObjectCtx*>(get_state()->obj_ctx);
2027 // framework promises to call op_init after parent init
2028 assert(rados_ctx);
2029 RGWOp::init(rados_ctx->store, get_state(), this);
2030 op = this; // assign self as op: REQUIRED
2031 return 0;
2032 }
2033
2034 int header_init() override {
2035
2036 struct req_state* s = get_state();
2037 s->info.method = "GET";
2038 s->op = OP_GET;
2039
2040 /* XXX derp derp derp */
2041 s->relative_uri = make_uri(bucket_name, obj_name);
2042 s->info.request_uri = s->relative_uri; // XXX
2043 s->info.effective_uri = s->relative_uri;
2044 s->info.request_params = "";
2045 s->info.domain = ""; /* XXX ? */
2046
2047 // woo
2048 s->user = user;
2049
2050 return 0;
2051 }
2052
2053 int get_params() override {
2054 return 0;
2055 }
2056
2057 int send_response_data(ceph::buffer::list& _bl, off_t s_off,
2058 off_t e_off) override {
2059 /* NOP */
2060 /* XXX save attrs? */
2061 return 0;
2062 }
2063
2064 int send_response_data_error() override {
2065 /* NOP */
2066 return 0;
2067 }
2068
2069 void execute() override {
2070 RGWGetObj::execute();
2071 _size = get_state()->obj_size;
2072 }
2073
2074}; /* RGWStatObjRequest */
2075
2076class RGWStatBucketRequest : public RGWLibRequest,
2077 public RGWStatBucket /* RGWOp */
2078{
2079public:
2080 std::string uri;
2081 std::map<std::string, buffer::list> attrs;
31f18b77 2082 RGWLibFS::BucketStats& bs;
7c673cae
FG
2083
2084 RGWStatBucketRequest(CephContext* _cct, RGWUserInfo *_user,
31f18b77
FG
2085 const std::string& _path,
2086 RGWLibFS::BucketStats& _stats)
2087 : RGWLibRequest(_cct, _user), bs(_stats) {
7c673cae
FG
2088 uri = "/" + _path;
2089 op = this;
2090 }
2091
2092 buffer::list* get_attr(const std::string& k) {
2093 auto iter = attrs.find(k);
2094 return (iter != attrs.end()) ? &(iter->second) : nullptr;
2095 }
2096
2097 real_time get_ctime() const {
2098 return bucket.creation_time;
2099 }
2100
2101 bool only_bucket() override { return false; }
2102
2103 int op_init() override {
2104 // assign store, s, and dialect_handler
2105 RGWObjectCtx* rados_ctx
2106 = static_cast<RGWObjectCtx*>(get_state()->obj_ctx);
2107 // framework promises to call op_init after parent init
2108 assert(rados_ctx);
2109 RGWOp::init(rados_ctx->store, get_state(), this);
2110 op = this; // assign self as op: REQUIRED
2111 return 0;
2112 }
2113
2114 int header_init() override {
2115
2116 struct req_state* s = get_state();
2117 s->info.method = "GET";
2118 s->op = OP_GET;
2119
2120 /* XXX derp derp derp */
2121 s->relative_uri = uri;
2122 s->info.request_uri = uri; // XXX
2123 s->info.effective_uri = uri;
2124 s->info.request_params = "";
2125 s->info.domain = ""; /* XXX ? */
2126
2127 // woo
2128 s->user = user;
2129
2130 return 0;
2131 }
2132
2133 virtual int get_params() {
2134 return 0;
2135 }
2136
2137 void send_response() override {
2138 bucket.creation_time = get_state()->bucket_info.creation_time;
31f18b77
FG
2139 bs.size = bucket.size;
2140 bs.size_rounded = bucket.size_rounded;
2141 bs.creation_time = bucket.creation_time;
2142 bs.num_entries = bucket.count;
7c673cae
FG
2143 std::swap(attrs, get_state()->bucket_attrs);
2144 }
2145
2146 bool matched() {
2147 return (bucket.bucket.name.length() > 0);
2148 }
2149
2150}; /* RGWStatBucketRequest */
2151
2152class RGWStatLeafRequest : public RGWLibRequest,
2153 public RGWListBucket /* RGWOp */
2154{
2155public:
2156 RGWFileHandle* rgw_fh;
2157 std::string path;
2158 bool matched;
2159 bool is_dir;
2160 bool exact_matched;
2161
2162 RGWStatLeafRequest(CephContext* _cct, RGWUserInfo *_user,
2163 RGWFileHandle* _rgw_fh, const std::string& _path)
2164 : RGWLibRequest(_cct, _user), rgw_fh(_rgw_fh), path(_path),
2165 matched(false), is_dir(false), exact_matched(false) {
2166 default_max = 1000; // logical max {"foo", "foo/"}
2167 op = this;
2168 }
2169
224ce89b 2170 bool only_bucket() override { return true; }
7c673cae
FG
2171
2172 int op_init() override {
2173 // assign store, s, and dialect_handler
2174 RGWObjectCtx* rados_ctx
2175 = static_cast<RGWObjectCtx*>(get_state()->obj_ctx);
2176 // framework promises to call op_init after parent init
2177 assert(rados_ctx);
2178 RGWOp::init(rados_ctx->store, get_state(), this);
2179 op = this; // assign self as op: REQUIRED
2180 return 0;
2181 }
2182
2183 int header_init() override {
2184
2185 struct req_state* s = get_state();
2186 s->info.method = "GET";
2187 s->op = OP_GET;
2188
2189 /* XXX derp derp derp */
2190 std::string uri = "/" + rgw_fh->bucket_name() + "/";
2191 s->relative_uri = uri;
2192 s->info.request_uri = uri; // XXX
2193 s->info.effective_uri = uri;
2194 s->info.request_params = "";
2195 s->info.domain = ""; /* XXX ? */
2196
2197 // woo
2198 s->user = user;
2199
2200 prefix = rgw_fh->relative_object_name();
2201 if (prefix.length() > 0)
2202 prefix += "/";
2203 prefix += path;
2204 delimiter = '/';
2205
2206 return 0;
2207 }
2208
2209 int get_params() override {
2210 max = default_max;
2211 return 0;
2212 }
2213
2214 void send_response() override {
2215 struct req_state* s = get_state();
2216 // try objects
2217 for (const auto& iter : objs) {
2218 auto& name = iter.key.name;
2219 lsubdout(cct, rgw, 15) << "RGWStatLeafRequest "
2220 << __func__ << " "
2221 << "list uri=" << s->relative_uri << " "
2222 << " prefix=" << prefix << " "
2223 << " obj path=" << name << ""
2224 << " target = " << path << ""
2225 << dendl;
2226 /* XXX is there a missing match-dir case (trailing '/')? */
2227 matched = true;
2228 if (name == path)
2229 exact_matched = true;
2230 return;
2231 }
2232 // try prefixes
2233 for (auto& iter : common_prefixes) {
2234 auto& name = iter.first;
2235 lsubdout(cct, rgw, 15) << "RGWStatLeafRequest "
2236 << __func__ << " "
2237 << "list uri=" << s->relative_uri << " "
2238 << " prefix=" << prefix << " "
2239 << " pref path=" << name << " (not chomped)"
2240 << " target = " << path << ""
2241 << dendl;
2242 matched = true;
2243 is_dir = true;
2244 break;
2245 }
2246 }
2247
2248 virtual void send_versioned_response() {
2249 send_response();
2250 }
2251}; /* RGWStatLeafRequest */
2252
2253/*
2254 put object
2255*/
2256
2257class RGWWriteRequest : public RGWLibContinuedReq,
2258 public RGWPutObj /* RGWOp */
2259{
2260public:
2261 const std::string& bucket_name;
2262 const std::string& obj_name;
2263 RGWFileHandle* rgw_fh;
224ce89b
WB
2264 RGWPutObjProcessor* processor;
2265 RGWPutObjDataProcessor* filter;
2266 boost::optional<RGWPutObj_Compress> compressor;
2267 CompressorRef plugin;
7c673cae
FG
2268 buffer::list data;
2269 uint64_t timer_id;
2270 MD5 hash;
2271 off_t real_ofs;
2272 size_t bytes_written;
2273 bool multipart;
2274 bool eio;
2275
2276 RGWWriteRequest(CephContext* _cct, RGWUserInfo *_user, RGWFileHandle* _fh,
2277 const std::string& _bname, const std::string& _oname)
2278 : RGWLibContinuedReq(_cct, _user), bucket_name(_bname), obj_name(_oname),
224ce89b
WB
2279 rgw_fh(_fh), processor(nullptr), filter(nullptr), real_ofs(0),
2280 bytes_written(0), multipart(false), eio(false) {
7c673cae
FG
2281
2282 int ret = header_init();
2283 if (ret == 0) {
2284 ret = init_from_header(get_state());
2285 }
2286 op = this;
2287 }
2288
2289 bool only_bucket() override { return true; }
2290
2291 int op_init() override {
2292 // assign store, s, and dialect_handler
2293 RGWObjectCtx* rados_ctx
2294 = static_cast<RGWObjectCtx*>(get_state()->obj_ctx);
2295 // framework promises to call op_init after parent init
2296 assert(rados_ctx);
2297 RGWOp::init(rados_ctx->store, get_state(), this);
2298 op = this; // assign self as op: REQUIRED
2299 return 0;
2300 }
2301
2302 int header_init() override {
2303
2304 struct req_state* s = get_state();
2305 s->info.method = "PUT";
2306 s->op = OP_PUT;
2307
2308 /* XXX derp derp derp */
2309 std::string uri = make_uri(bucket_name, obj_name);
2310 s->relative_uri = uri;
2311 s->info.request_uri = uri; // XXX
2312 s->info.effective_uri = uri;
2313 s->info.request_params = "";
2314 s->info.domain = ""; /* XXX ? */
2315
2316 // woo
2317 s->user = user;
2318
2319 return 0;
2320 }
2321
2322 RGWPutObjProcessor *select_processor(RGWObjectCtx& obj_ctx,
2323 bool *is_multipart) override {
2324 struct req_state* s = get_state();
2325 uint64_t part_size = s->cct->_conf->rgw_obj_stripe_size;
2326 RGWPutObjProcessor_Atomic *processor =
2327 new RGWPutObjProcessor_Atomic(obj_ctx, s->bucket_info, s->bucket,
2328 s->object.name, part_size, s->req_id,
2329 s->bucket_info.versioning_enabled());
2330 processor->set_olh_epoch(olh_epoch);
2331 processor->set_version_id(version_id);
2332 return processor;
2333 }
2334
2335 int get_params() override {
2336 struct req_state* s = get_state();
2337 RGWAccessControlPolicy_S3 s3policy(s->cct);
2338 /* we don't have (any) headers, so just create canned ACLs */
2339 int ret = s3policy.create_canned(s->owner, s->bucket_owner, s->canned_acl);
2340 policy = s3policy;
2341 return ret;
2342 }
2343
2344 int get_data(buffer::list& _bl) override {
2345 /* XXX for now, use sharing semantics */
2346 uint32_t len = data.length();
2347 _bl.claim(data);
2348 bytes_written += len;
2349 return len;
2350 }
2351
2352 void put_data(off_t off, buffer::list& _bl) {
2353 if (off != real_ofs) {
2354 eio = true;
2355 }
2356 data.claim(_bl);
2357 real_ofs += data.length();
2358 ofs = off; /* consumed in exec_continue() */
2359 }
2360
2361 int exec_start() override;
2362 int exec_continue() override;
2363 int exec_finish() override;
2364
2365 void send_response() override {}
2366
2367 int verify_params() override {
2368 return 0;
2369 }
2370}; /* RGWWriteRequest */
2371
2372/*
2373 copy object
2374*/
2375class RGWCopyObjRequest : public RGWLibRequest,
2376 public RGWCopyObj /* RGWOp */
2377{
2378public:
2379 RGWFileHandle* src_parent;
2380 RGWFileHandle* dst_parent;
2381 const std::string& src_name;
2382 const std::string& dst_name;
2383
2384 RGWCopyObjRequest(CephContext* _cct, RGWUserInfo *_user,
2385 RGWFileHandle* _src_parent, RGWFileHandle* _dst_parent,
2386 const std::string& _src_name, const std::string& _dst_name)
2387 : RGWLibRequest(_cct, _user), src_parent(_src_parent),
2388 dst_parent(_dst_parent), src_name(_src_name), dst_name(_dst_name) {
2389 /* all requests have this */
2390 op = this;
2391
2392 /* allow this request to replace selected attrs */
2393 attrs_mod = RGWRados::ATTRSMOD_MERGE;
2394 }
2395
2396 bool only_bucket() override { return true; }
2397
2398 int op_init() override {
2399 // assign store, s, and dialect_handler
2400 RGWObjectCtx* rados_ctx
2401 = static_cast<RGWObjectCtx*>(get_state()->obj_ctx);
2402 // framework promises to call op_init after parent init
2403 assert(rados_ctx);
2404 RGWOp::init(rados_ctx->store, get_state(), this);
2405 op = this; // assign self as op: REQUIRED
2406
2407 return 0;
2408 }
2409
2410 int header_init() override {
2411
2412 struct req_state* s = get_state();
2413 s->info.method = "PUT"; // XXX check
2414 s->op = OP_PUT;
2415
2416 src_bucket_name = src_parent->bucket_name();
2417 // need s->src_bucket_name?
31f18b77 2418 src_object.name = src_parent->format_child_name(src_name, false);
7c673cae
FG
2419 // need s->src_object?
2420
2421 dest_bucket_name = dst_parent->bucket_name();
2422 // need s->bucket.name?
31f18b77 2423 dest_object = dst_parent->format_child_name(dst_name, false);
7c673cae
FG
2424 // need s->object_name?
2425
2426 int rc = valid_s3_object_name(dest_object);
2427 if (rc != 0)
2428 return rc;
2429
2430 /* XXX and fixup key attr (could optimize w/string ref and
2431 * dest_object) */
2432 buffer::list ux_key;
224ce89b 2433 fh_key fhk = dst_parent->make_fhk(dst_name);
7c673cae
FG
2434 rgw::encode(fhk, ux_key);
2435 emplace_attr(RGW_ATTR_UNIX_KEY1, std::move(ux_key));
2436
2437#if 0 /* XXX needed? */
2438 s->relative_uri = uri;
2439 s->info.request_uri = uri; // XXX
2440 s->info.effective_uri = uri;
2441 s->info.request_params = "";
2442 s->info.domain = ""; /* XXX ? */
2443#endif
2444
2445 // woo
2446 s->user = user;
2447
2448 return 0;
2449 }
2450
2451 int get_params() override {
2452 struct req_state* s = get_state();
2453 RGWAccessControlPolicy_S3 s3policy(s->cct);
2454 /* we don't have (any) headers, so just create canned ACLs */
2455 int ret = s3policy.create_canned(s->owner, s->bucket_owner, s->canned_acl);
2456 dest_policy = s3policy;
2457 return ret;
2458 }
2459
2460 void send_response() override {}
2461 void send_partial_response(off_t ofs) override {}
2462
2463}; /* RGWCopyObjRequest */
2464
2465class RGWSetAttrsRequest : public RGWLibRequest,
2466 public RGWSetAttrs /* RGWOp */
2467{
2468public:
2469 const std::string& bucket_name;
2470 const std::string& obj_name;
2471
2472 RGWSetAttrsRequest(CephContext* _cct, RGWUserInfo *_user,
2473 const std::string& _bname, const std::string& _oname)
2474 : RGWLibRequest(_cct, _user), bucket_name(_bname), obj_name(_oname) {
2475 op = this;
2476 }
2477
2478 bool only_bucket() override { return false; }
2479
2480 int op_init() override {
2481 // assign store, s, and dialect_handler
2482 RGWObjectCtx* rados_ctx
2483 = static_cast<RGWObjectCtx*>(get_state()->obj_ctx);
2484 // framework promises to call op_init after parent init
2485 assert(rados_ctx);
2486 RGWOp::init(rados_ctx->store, get_state(), this);
2487 op = this; // assign self as op: REQUIRED
2488 return 0;
2489 }
2490
2491 int header_init() override {
2492
2493 struct req_state* s = get_state();
2494 s->info.method = "PUT";
2495 s->op = OP_PUT;
2496
2497 /* XXX derp derp derp */
2498 std::string uri = make_uri(bucket_name, obj_name);
2499 s->relative_uri = uri;
2500 s->info.request_uri = uri; // XXX
2501 s->info.effective_uri = uri;
2502 s->info.request_params = "";
2503 s->info.domain = ""; /* XXX ? */
2504
2505 // woo
2506 s->user = user;
2507
2508 return 0;
2509 }
2510
2511 int get_params() override {
2512 return 0;
2513 }
2514
2515 void send_response() override {}
2516
2517}; /* RGWSetAttrsRequest */
2518
2519} /* namespace rgw */
2520
2521#endif /* RGW_FILE_H */