forked from ceph/ceph
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathrgw_common.h
1588 lines (1373 loc) · 39.8 KB
/
rgw_common.h
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
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// -*- 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-2009 Sage Weil <[email protected]>
*
* 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_RGW_COMMON_H
#define CEPH_RGW_COMMON_H
#include "common/ceph_crypto.h"
#include "common/debug.h"
#include "common/perf_counters.h"
#include "acconfig.h"
#include <errno.h>
#include <string.h>
#include <string>
#include <map>
#include "include/types.h"
#include "include/utime.h"
#include "rgw_acl.h"
#include "rgw_cors.h"
#include "rgw_quota.h"
#include "rgw_string.h"
#include "cls/version/cls_version_types.h"
#include "cls/user/cls_user_types.h"
#include "cls/rgw/cls_rgw_types.h"
#include "include/rados/librados.hpp"
using namespace std;
namespace ceph {
class Formatter;
}
using ceph::crypto::MD5;
#define RGW_ATTR_PREFIX "user.rgw."
#define RGW_HTTP_RGWX_ATTR_PREFIX "RGWX_ATTR_"
#define RGW_HTTP_RGWX_ATTR_PREFIX_OUT "Rgwx-Attr-"
#define RGW_AMZ_META_PREFIX "x-amz-meta-"
#define RGW_SYS_PARAM_PREFIX "rgwx-"
#define RGW_ATTR_ACL RGW_ATTR_PREFIX "acl"
#define RGW_ATTR_CORS RGW_ATTR_PREFIX "cors"
#define RGW_ATTR_ETAG RGW_ATTR_PREFIX "etag"
#define RGW_ATTR_BUCKETS RGW_ATTR_PREFIX "buckets"
#define RGW_ATTR_META_PREFIX RGW_ATTR_PREFIX RGW_AMZ_META_PREFIX
#define RGW_ATTR_CONTENT_TYPE RGW_ATTR_PREFIX "content_type"
#define RGW_ATTR_CACHE_CONTROL RGW_ATTR_PREFIX "cache_control"
#define RGW_ATTR_CONTENT_DISP RGW_ATTR_PREFIX "content_disposition"
#define RGW_ATTR_CONTENT_ENC RGW_ATTR_PREFIX "content_encoding"
#define RGW_ATTR_CONTENT_LANG RGW_ATTR_PREFIX "content_language"
#define RGW_ATTR_EXPIRES RGW_ATTR_PREFIX "expires"
#define RGW_ATTR_ID_TAG RGW_ATTR_PREFIX "idtag"
#define RGW_ATTR_SHADOW_OBJ RGW_ATTR_PREFIX "shadow_name"
#define RGW_ATTR_MANIFEST RGW_ATTR_PREFIX "manifest"
#define RGW_ATTR_USER_MANIFEST RGW_ATTR_PREFIX "user_manifest"
#define RGW_ATTR_OLH_PREFIX RGW_ATTR_PREFIX "olh."
#define RGW_ATTR_OLH_INFO RGW_ATTR_OLH_PREFIX "info"
#define RGW_ATTR_OLH_VER RGW_ATTR_OLH_PREFIX "ver"
#define RGW_ATTR_OLH_ID_TAG RGW_ATTR_OLH_PREFIX "idtag"
#define RGW_ATTR_OLH_PENDING_PREFIX RGW_ATTR_OLH_PREFIX "pending."
#define RGW_BUCKETS_OBJ_SUFFIX ".buckets"
#define RGW_MAX_PENDING_CHUNKS 16
#define RGW_MAX_PUT_SIZE (5ULL*1024*1024*1024)
#define RGW_MIN_MULTIPART_SIZE (5ULL*1024*1024)
#define RGW_FORMAT_PLAIN 0
#define RGW_FORMAT_XML 1
#define RGW_FORMAT_JSON 2
#define RGW_CAP_READ 0x1
#define RGW_CAP_WRITE 0x2
#define RGW_CAP_ALL (RGW_CAP_READ | RGW_CAP_WRITE)
#define RGW_REST_SWIFT 0x1
#define RGW_REST_SWIFT_AUTH 0x2
#define RGW_SUSPENDED_USER_AUID (uint64_t)-2
#define RGW_OP_TYPE_READ 0x01
#define RGW_OP_TYPE_WRITE 0x02
#define RGW_OP_TYPE_DELETE 0x04
#define RGW_OP_TYPE_MODIFY (RGW_OP_TYPE_WRITE | RGW_OP_TYPE_DELETE)
#define RGW_OP_TYPE_ALL (RGW_OP_TYPE_READ | RGW_OP_TYPE_WRITE | RGW_OP_TYPE_DELETE)
#define RGW_DEFAULT_MAX_BUCKETS 1000
#define RGW_DEFER_TO_BUCKET_ACLS_RECURSE 1
#define RGW_DEFER_TO_BUCKET_ACLS_FULL_CONTROL 2
#define STATUS_CREATED 1900
#define STATUS_ACCEPTED 1901
#define STATUS_NO_CONTENT 1902
#define STATUS_PARTIAL_CONTENT 1903
#define STATUS_REDIRECT 1904
#define STATUS_NO_APPLY 1905
#define STATUS_APPLIED 1906
#define ERR_INVALID_BUCKET_NAME 2000
#define ERR_INVALID_OBJECT_NAME 2001
#define ERR_NO_SUCH_BUCKET 2002
#define ERR_METHOD_NOT_ALLOWED 2003
#define ERR_INVALID_DIGEST 2004
#define ERR_BAD_DIGEST 2005
#define ERR_UNRESOLVABLE_EMAIL 2006
#define ERR_INVALID_PART 2007
#define ERR_INVALID_PART_ORDER 2008
#define ERR_NO_SUCH_UPLOAD 2009
#define ERR_REQUEST_TIMEOUT 2010
#define ERR_LENGTH_REQUIRED 2011
#define ERR_REQUEST_TIME_SKEWED 2012
#define ERR_BUCKET_EXISTS 2013
#define ERR_BAD_URL 2014
#define ERR_PRECONDITION_FAILED 2015
#define ERR_NOT_MODIFIED 2016
#define ERR_INVALID_UTF8 2017
#define ERR_UNPROCESSABLE_ENTITY 2018
#define ERR_TOO_LARGE 2019
#define ERR_TOO_MANY_BUCKETS 2020
#define ERR_INVALID_REQUEST 2021
#define ERR_TOO_SMALL 2022
#define ERR_NOT_FOUND 2023
#define ERR_PERMANENT_REDIRECT 2024
#define ERR_LOCKED 2025
#define ERR_QUOTA_EXCEEDED 2026
#define ERR_SIGNATURE_NO_MATCH 2027
#define ERR_INVALID_ACCESS_KEY 2028
#define ERR_MALFORMED_XML 2029
#define ERR_USER_SUSPENDED 2100
#define ERR_INTERNAL_ERROR 2200
#ifndef UINT32_MAX
#define UINT32_MAX (0xffffffffu)
#endif
typedef void *RGWAccessHandle;
/* perf counter */
extern PerfCounters *perfcounter;
extern int rgw_perf_start(CephContext *cct);
extern void rgw_perf_stop(CephContext *cct);
enum {
l_rgw_first = 15000,
l_rgw_req,
l_rgw_failed_req,
l_rgw_get,
l_rgw_get_b,
l_rgw_get_lat,
l_rgw_put,
l_rgw_put_b,
l_rgw_put_lat,
l_rgw_qlen,
l_rgw_qactive,
l_rgw_cache_hit,
l_rgw_cache_miss,
l_rgw_keystone_token_cache_hit,
l_rgw_keystone_token_cache_miss,
l_rgw_last,
};
/* size should be the required string size + 1 */
extern int gen_rand_base64(CephContext *cct, char *dest, int size);
extern int gen_rand_alphanumeric(CephContext *cct, char *dest, int size);
extern int gen_rand_alphanumeric_lower(CephContext *cct, char *dest, int size);
extern int gen_rand_alphanumeric_upper(CephContext *cct, char *dest, int size);
extern int gen_rand_alphanumeric_no_underscore(CephContext *cct, char *dest, int size);
extern int gen_rand_alphanumeric_lower(CephContext *cct, string *str, int length);
enum RGWIntentEvent {
DEL_OBJ = 0,
DEL_DIR = 1,
};
enum RGWObjCategory {
RGW_OBJ_CATEGORY_NONE = 0,
RGW_OBJ_CATEGORY_MAIN = 1,
RGW_OBJ_CATEGORY_SHADOW = 2,
RGW_OBJ_CATEGORY_MULTIMETA = 3,
};
/** Store error returns for output at a different point in the program */
struct rgw_err {
rgw_err();
rgw_err(int http, const std::string &s3);
void clear();
bool is_clear() const;
bool is_err() const;
friend std::ostream& operator<<(std::ostream& oss, const rgw_err &err);
int http_ret;
int ret;
std::string s3_code;
std::string message;
};
/* Helper class used for RGWHTTPArgs parsing */
class NameVal
{
string str;
string name;
string val;
public:
NameVal(string nv) : str(nv) {}
int parse();
string& get_name() { return name; }
string& get_val() { return val; }
};
/** Stores the XML arguments associated with the HTTP request in req_state*/
class RGWHTTPArgs
{
string str, empty_str;
map<string, string> val_map;
map<string, string> sys_val_map;
map<string, string> sub_resources;
bool has_resp_modifier;
public:
RGWHTTPArgs() : has_resp_modifier(false) {}
/** Set the arguments; as received */
void set(string s) {
has_resp_modifier = false;
val_map.clear();
sub_resources.clear();
str = s;
}
/** parse the received arguments */
int parse();
/** Get the value for a specific argument parameter */
string& get(const string& name, bool *exists = NULL);
string& get(const char *name, bool *exists = NULL);
int get_bool(const string& name, bool *val, bool *exists);
int get_bool(const char *name, bool *val, bool *exists);
void get_bool(const char *name, bool *val, bool def_val);
/** see if a parameter is contained in this RGWHTTPArgs */
bool exists(const char *name) {
map<string, string>::iterator iter = val_map.find(name);
return (iter != val_map.end());
}
bool sub_resource_exists(const char *name) {
map<string, string>::iterator iter = sub_resources.find(name);
return (iter != sub_resources.end());
}
map<string, string>& get_params() {
return val_map;
}
map<string, string>& get_sub_resources() { return sub_resources; }
unsigned get_num_params() {
return val_map.size();
}
bool has_response_modifier() {
return has_resp_modifier;
}
void set_system() { /* make all system params visible */
map<string, string>::iterator iter;
for (iter = sys_val_map.begin(); iter != sys_val_map.end(); ++iter) {
val_map[iter->first] = iter->second;
}
}
};
class RGWConf;
class RGWEnv {
std::map<string, string, ltstr_nocase> env_map;
public:
RGWConf *conf;
RGWEnv();
~RGWEnv();
void init(CephContext *cct);
void init(CephContext *cct, char **envp);
void set(const char *name, const char *val);
const char *get(const char *name, const char *def_val = NULL);
int get_int(const char *name, int def_val = 0);
bool get_bool(const char *name, bool def_val = 0);
size_t get_size(const char *name, size_t def_val = 0);
bool exists(const char *name);
bool exists_prefix(const char *prefix);
void remove(const char *name);
std::map<string, string, ltstr_nocase>& get_map() { return env_map; }
};
class RGWConf {
friend class RGWEnv;
protected:
void init(CephContext *cct, RGWEnv * env);
public:
RGWConf() :
enable_ops_log(1), enable_usage_log(1), defer_to_bucket_acls(0) {}
int enable_ops_log;
int enable_usage_log;
uint8_t defer_to_bucket_acls;
};
enum http_op {
OP_GET,
OP_PUT,
OP_DELETE,
OP_HEAD,
OP_POST,
OP_COPY,
OP_OPTIONS,
OP_UNKNOWN,
};
class RGWAccessControlPolicy;
class JSONObj;
struct RGWAccessKey {
string id; // AccessKey
string key; // SecretKey
string subuser;
RGWAccessKey() {}
void encode(bufferlist& bl) const {
ENCODE_START(2, 2, bl);
::encode(id, bl);
::encode(key, bl);
::encode(subuser, bl);
ENCODE_FINISH(bl);
}
void decode(bufferlist::iterator& bl) {
DECODE_START_LEGACY_COMPAT_LEN_32(2, 2, 2, bl);
::decode(id, bl);
::decode(key, bl);
::decode(subuser, bl);
DECODE_FINISH(bl);
}
void dump(Formatter *f) const;
void dump_plain(Formatter *f) const;
void dump(Formatter *f, const string& user, bool swift) const;
static void generate_test_instances(list<RGWAccessKey*>& o);
void decode_json(JSONObj *obj);
void decode_json(JSONObj *obj, bool swift);
};
WRITE_CLASS_ENCODER(RGWAccessKey)
struct RGWSubUser {
string name;
uint32_t perm_mask;
RGWSubUser() : perm_mask(0) {}
void encode(bufferlist& bl) const {
ENCODE_START(2, 2, bl);
::encode(name, bl);
::encode(perm_mask, bl);
ENCODE_FINISH(bl);
}
void decode(bufferlist::iterator& bl) {
DECODE_START_LEGACY_COMPAT_LEN_32(2, 2, 2, bl);
::decode(name, bl);
::decode(perm_mask, bl);
DECODE_FINISH(bl);
}
void dump(Formatter *f) const;
void dump(Formatter *f, const string& user) const;
static void generate_test_instances(list<RGWSubUser*>& o);
void decode_json(JSONObj *obj);
};
WRITE_CLASS_ENCODER(RGWSubUser)
class RGWUserCaps
{
map<string, uint32_t> caps;
int get_cap(const string& cap, string& type, uint32_t *perm);
int add_cap(const string& cap);
int remove_cap(const string& cap);
public:
static int parse_cap_perm(const string& str, uint32_t *perm);
int add_from_string(const string& str);
int remove_from_string(const string& str);
void encode(bufferlist& bl) const {
ENCODE_START(1, 1, bl);
::encode(caps, bl);
ENCODE_FINISH(bl);
}
void decode(bufferlist::iterator& bl) {
DECODE_START(1, bl);
::decode(caps, bl);
DECODE_FINISH(bl);
}
int check_cap(const string& cap, uint32_t perm);
void dump(Formatter *f) const;
void dump(Formatter *f, const char *name) const;
void decode_json(JSONObj *obj);
};
WRITE_CLASS_ENCODER(RGWUserCaps)
void encode_json(const char *name, const obj_version& v, Formatter *f);
void encode_json(const char *name, const RGWUserCaps& val, Formatter *f);
void decode_json_obj(obj_version& v, JSONObj *obj);
struct RGWUserInfo
{
uint64_t auid;
string user_id;
string display_name;
string user_email;
map<string, RGWAccessKey> access_keys;
map<string, RGWAccessKey> swift_keys;
map<string, RGWSubUser> subusers;
__u8 suspended;
uint32_t max_buckets;
uint32_t op_mask;
RGWUserCaps caps;
__u8 system;
string default_placement;
list<string> placement_tags;
RGWQuotaInfo bucket_quota;
map<int, string> temp_url_keys;
RGWQuotaInfo user_quota;
RGWUserInfo() : auid(0), suspended(0), max_buckets(RGW_DEFAULT_MAX_BUCKETS), op_mask(RGW_OP_TYPE_ALL), system(0) {}
void encode(bufferlist& bl) const {
ENCODE_START(16, 9, bl);
::encode(auid, bl);
string access_key;
string secret_key;
if (!access_keys.empty()) {
map<string, RGWAccessKey>::const_iterator iter = access_keys.begin();
const RGWAccessKey& k = iter->second;
access_key = k.id;
secret_key = k.key;
}
::encode(access_key, bl);
::encode(secret_key, bl);
::encode(display_name, bl);
::encode(user_email, bl);
string swift_name;
string swift_key;
if (!swift_keys.empty()) {
map<string, RGWAccessKey>::const_iterator iter = swift_keys.begin();
const RGWAccessKey& k = iter->second;
swift_name = k.id;
swift_key = k.key;
}
::encode(swift_name, bl);
::encode(swift_key, bl);
::encode(user_id, bl);
::encode(access_keys, bl);
::encode(subusers, bl);
::encode(suspended, bl);
::encode(swift_keys, bl);
::encode(max_buckets, bl);
::encode(caps, bl);
::encode(op_mask, bl);
::encode(system, bl);
::encode(default_placement, bl);
::encode(placement_tags, bl);
::encode(bucket_quota, bl);
::encode(temp_url_keys, bl);
::encode(user_quota, bl);
ENCODE_FINISH(bl);
}
void decode(bufferlist::iterator& bl) {
DECODE_START_LEGACY_COMPAT_LEN_32(16, 9, 9, bl);
if (struct_v >= 2) ::decode(auid, bl);
else auid = CEPH_AUTH_UID_DEFAULT;
string access_key;
string secret_key;
::decode(access_key, bl);
::decode(secret_key, bl);
if (struct_v < 6) {
RGWAccessKey k;
k.id = access_key;
k.key = secret_key;
access_keys[access_key] = k;
}
::decode(display_name, bl);
::decode(user_email, bl);
string swift_name;
string swift_key;
if (struct_v >= 3) ::decode(swift_name, bl);
if (struct_v >= 4) ::decode(swift_key, bl);
if (struct_v >= 5)
::decode(user_id, bl);
else
user_id = access_key;
if (struct_v >= 6) {
::decode(access_keys, bl);
::decode(subusers, bl);
}
suspended = 0;
if (struct_v >= 7) {
::decode(suspended, bl);
}
if (struct_v >= 8) {
::decode(swift_keys, bl);
}
if (struct_v >= 10) {
::decode(max_buckets, bl);
} else {
max_buckets = RGW_DEFAULT_MAX_BUCKETS;
}
if (struct_v >= 11) {
::decode(caps, bl);
}
if (struct_v >= 12) {
::decode(op_mask, bl);
} else {
op_mask = RGW_OP_TYPE_ALL;
}
system = 0;
if (struct_v >= 13) {
::decode(system, bl);
::decode(default_placement, bl);
::decode(placement_tags, bl); /* tags of allowed placement rules */
}
if (struct_v >= 14) {
::decode(bucket_quota, bl);
}
if (struct_v >= 15) {
::decode(temp_url_keys, bl);
}
if (struct_v >= 16) {
::decode(user_quota, bl);
}
DECODE_FINISH(bl);
}
void dump(Formatter *f) const;
static void generate_test_instances(list<RGWUserInfo*>& o);
void decode_json(JSONObj *obj);
void clear() {
user_id.clear();
display_name.clear();
user_email.clear();
auid = CEPH_AUTH_UID_DEFAULT;
access_keys.clear();
suspended = 0;
}
};
WRITE_CLASS_ENCODER(RGWUserInfo)
struct rgw_bucket {
std::string name;
std::string data_pool;
std::string data_extra_pool; /* if not set, then we should use data_pool instead */
std::string index_pool;
std::string marker;
std::string bucket_id;
std::string oid; /*
* runtime in-memory only info. If not empty, points to the bucket instance object
*/
rgw_bucket() { }
rgw_bucket(const cls_user_bucket& b) {
name = b.name;
data_pool = b.data_pool;
data_extra_pool = b.data_extra_pool;
index_pool = b.index_pool;
marker = b.marker;
bucket_id = b.bucket_id;
}
rgw_bucket(const char *n) : name(n) {
assert(*n == '.'); // only rgw private buckets should be initialized without pool
data_pool = index_pool = n;
marker = "";
}
rgw_bucket(const char *n, const char *dp, const char *ip, const char *m, const char *id, const char *h) :
name(n), data_pool(dp), index_pool(ip), marker(m), bucket_id(id) {}
void convert(cls_user_bucket *b) {
b->name = name;
b->data_pool = data_pool;
b->data_extra_pool = data_extra_pool;
b->index_pool = index_pool;
b->marker = marker;
b->bucket_id = bucket_id;
}
void encode(bufferlist& bl) const {
ENCODE_START(7, 3, bl);
::encode(name, bl);
::encode(data_pool, bl);
::encode(marker, bl);
::encode(bucket_id, bl);
::encode(index_pool, bl);
::encode(data_extra_pool, bl);
ENCODE_FINISH(bl);
}
void decode(bufferlist::iterator& bl) {
DECODE_START_LEGACY_COMPAT_LEN(7, 3, 3, bl);
::decode(name, bl);
::decode(data_pool, bl);
if (struct_v >= 2) {
::decode(marker, bl);
if (struct_v <= 3) {
uint64_t id;
::decode(id, bl);
char buf[16];
snprintf(buf, sizeof(buf), "%llu", (long long)id);
bucket_id = buf;
} else {
::decode(bucket_id, bl);
}
}
if (struct_v >= 5) {
::decode(index_pool, bl);
} else {
index_pool = data_pool;
}
if (struct_v >= 7) {
::decode(data_extra_pool, bl);
}
DECODE_FINISH(bl);
}
const string& get_data_extra_pool() {
if (data_extra_pool.empty()) {
return data_pool;
}
return data_extra_pool;
}
void dump(Formatter *f) const;
void decode_json(JSONObj *obj);
static void generate_test_instances(list<rgw_bucket*>& o);
bool operator<(const rgw_bucket& b) const {
return name.compare(b.name) < 0;
}
};
WRITE_CLASS_ENCODER(rgw_bucket)
inline ostream& operator<<(ostream& out, const rgw_bucket &b) {
out << b.name;
if (b.name.compare(b.data_pool)) {
out << "(@";
string s;
if (!b.index_pool.empty() && b.data_pool.compare(b.index_pool))
s = "i=" + b.index_pool;
if (!b.data_extra_pool.empty() && b.data_pool.compare(b.data_extra_pool)) {
if (!s.empty()) {
s += ",";
}
s += "e=" + b.data_extra_pool;
}
if (!s.empty()) {
out << "{" << s << "}";
}
out << b.data_pool << "[" << b.marker << "])";
}
return out;
}
struct rgw_bucket_shard {
rgw_bucket bucket;
int shard_id;
rgw_bucket_shard() : shard_id(-1) {}
rgw_bucket_shard(rgw_bucket& _b, int _sid) : bucket(_b), shard_id(_sid) {}
bool operator<(const rgw_bucket_shard& b) const {
if (bucket < b.bucket) {
return true;
}
if (b.bucket < bucket) {
return false;
}
return shard_id < b.shard_id;
}
};
struct RGWObjVersionTracker {
obj_version read_version;
obj_version write_version;
obj_version *version_for_read() {
return &read_version;
}
obj_version *version_for_write() {
if (write_version.ver == 0)
return NULL;
return &write_version;
}
obj_version *version_for_check() {
if (read_version.ver == 0)
return NULL;
return &read_version;
}
void prepare_op_for_read(librados::ObjectReadOperation *op);
void prepare_op_for_write(librados::ObjectWriteOperation *op);
void apply_write() {
read_version = write_version;
write_version = obj_version();
}
void clear() {
read_version = obj_version();
write_version = obj_version();
}
void generate_new_write_ver(CephContext *cct);
};
enum RGWBucketFlags {
BUCKET_SUSPENDED = 0x1,
BUCKET_VERSIONED = 0x2,
BUCKET_VERSIONS_SUSPENDED = 0x4,
};
struct RGWBucketInfo
{
enum BIShardsHashType {
MOD = 0
};
rgw_bucket bucket;
string owner;
uint32_t flags;
string region;
time_t creation_time;
string placement_rule;
bool has_instance_obj;
RGWObjVersionTracker objv_tracker; /* we don't need to serialize this, for runtime tracking */
obj_version ep_objv; /* entry point object version, for runtime tracking only */
RGWQuotaInfo quota;
// Represents the number of bucket index object shards:
// - value of 0 indicates there is no sharding (this is by default before this
// feature is implemented).
// - value of UINT32_T::MAX indicates this is a blind bucket.
uint32_t num_shards;
// Represents the bucket index shard hash type.
uint8_t bucket_index_shard_hash_type;
// Represents the shard number for blind bucket.
const static uint32_t NUM_SHARDS_BLIND_BUCKET;
void encode(bufferlist& bl) const {
ENCODE_START(11, 4, bl);
::encode(bucket, bl);
::encode(owner, bl);
::encode(flags, bl);
::encode(region, bl);
uint64_t ct = (uint64_t)creation_time;
::encode(ct, bl);
::encode(placement_rule, bl);
::encode(has_instance_obj, bl);
::encode(quota, bl);
::encode(num_shards, bl);
::encode(bucket_index_shard_hash_type, bl);
ENCODE_FINISH(bl);
}
void decode(bufferlist::iterator& bl) {
DECODE_START_LEGACY_COMPAT_LEN_32(9, 4, 4, bl);
::decode(bucket, bl);
if (struct_v >= 2)
::decode(owner, bl);
if (struct_v >= 3)
::decode(flags, bl);
if (struct_v >= 5)
::decode(region, bl);
if (struct_v >= 6) {
uint64_t ct;
::decode(ct, bl);
creation_time = (time_t)ct;
}
if (struct_v >= 7)
::decode(placement_rule, bl);
if (struct_v >= 8)
::decode(has_instance_obj, bl);
if (struct_v >= 9)
::decode(quota, bl);
if (struct_v >= 10)
::decode(num_shards, bl);
if (struct_v >= 11)
::decode(bucket_index_shard_hash_type, bl);
DECODE_FINISH(bl);
}
void dump(Formatter *f) const;
static void generate_test_instances(list<RGWBucketInfo*>& o);
void decode_json(JSONObj *obj);
bool versioned() { return (flags & BUCKET_VERSIONED) != 0; }
int versioning_status() { return flags & (BUCKET_VERSIONED | BUCKET_VERSIONS_SUSPENDED); }
bool versioning_enabled() { return versioning_status() == BUCKET_VERSIONED; }
RGWBucketInfo() : flags(0), creation_time(0), has_instance_obj(false), num_shards(0), bucket_index_shard_hash_type(MOD) {}
};
WRITE_CLASS_ENCODER(RGWBucketInfo)
struct RGWBucketEntryPoint
{
rgw_bucket bucket;
string owner;
time_t creation_time;
bool linked;
bool has_bucket_info;
RGWBucketInfo old_bucket_info;
RGWBucketEntryPoint() : creation_time(0), linked(false), has_bucket_info(false) {}
void encode(bufferlist& bl) const {
ENCODE_START(8, 8, bl);
::encode(bucket, bl);
::encode(owner, bl);
::encode(linked, bl);
uint64_t ctime = (uint64_t)creation_time;
::encode(ctime, bl);
ENCODE_FINISH(bl);
}
void decode(bufferlist::iterator& bl) {
bufferlist::iterator orig_iter = bl;
DECODE_START_LEGACY_COMPAT_LEN_32(8, 4, 4, bl);
if (struct_v < 8) {
/* ouch, old entry, contains the bucket info itself */
old_bucket_info.decode(orig_iter);
has_bucket_info = true;
return;
}
has_bucket_info = false;
::decode(bucket, bl);
::decode(owner, bl);
::decode(linked, bl);
uint64_t ctime;
::decode(ctime, bl);
creation_time = (uint64_t)ctime;
DECODE_FINISH(bl);
}
void dump(Formatter *f) const;
void decode_json(JSONObj *obj);
};
WRITE_CLASS_ENCODER(RGWBucketEntryPoint)
struct RGWStorageStats
{
RGWObjCategory category;
uint64_t num_kb;
uint64_t num_kb_rounded;
uint64_t num_objects;
RGWStorageStats() : category(RGW_OBJ_CATEGORY_NONE), num_kb(0), num_kb_rounded(0), num_objects(0) {}
void dump(Formatter *f) const;
};
struct req_state;
class RGWEnv;
class RGWClientIO;
struct req_info {
RGWEnv *env;
RGWHTTPArgs args;
map<string, string> x_meta_map;
const char *host;
const char *method;
string script_uri;
string request_uri;
string effective_uri;
string request_params;
string domain;
req_info(CephContext *cct, RGWEnv *_env);
void rebuild_from(req_info& src);
void init_meta_info(bool *found_bad_meta);
};
struct rgw_obj_key {
string name;
string instance;
rgw_obj_key() {}
rgw_obj_key(const string& n) {
set(n);
}
rgw_obj_key(const string& n, const string& i) {
set(n, i);
}
void set(const cls_rgw_obj_key& k) {
name = k.name;
instance = k.instance;
}
void transform(cls_rgw_obj_key *k) {
k->name = name;
k->instance = instance;
}
void set(const string& n) {
name = n;
instance.clear();
}
void set(const string& n, const string& i) {
name = n;
instance = i;
}
bool empty() {
return name.empty();
}
bool operator==(const rgw_obj_key& k) const {
return (name.compare(k.name) == 0) &&
(instance.compare(k.instance) == 0);
}
bool operator<(const rgw_obj_key& k) const {
int r = name.compare(k.name);
if (r == 0) {
r = instance.compare(k.instance);
}
return (r < 0);
}
bool operator<=(const rgw_obj_key& k) const {
return !(k < *this);
}
void encode(bufferlist& bl) const {
ENCODE_START(1, 1, bl);
::encode(name, bl);
::encode(instance, bl);
ENCODE_FINISH(bl);
}
void decode(bufferlist::iterator& bl) {
DECODE_START(1, bl);
::decode(name, bl);
::decode(instance, bl);
DECODE_FINISH(bl);
}
void dump(Formatter *f) const;
};
WRITE_CLASS_ENCODER(rgw_obj_key)
inline ostream& operator<<(ostream& out, const rgw_obj_key &o) {
if (o.instance.empty()) {
return out << o.name;
} else {
return out << o.name << "[" << o.instance << "]";
}
}
/** Store all the state necessary to complete and respond to an HTTP request*/
struct req_state {
CephContext *cct;