-
Notifications
You must be signed in to change notification settings - Fork 1
/
CrushWrapper.h
1583 lines (1457 loc) · 47.9 KB
/
CrushWrapper.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
#ifndef CEPH_CRUSH_WRAPPER_H
#define CEPH_CRUSH_WRAPPER_H
#include <stdlib.h>
#include <map>
#include <set>
#include <string>
#include <iosfwd>
#include "include/types.h"
extern "C" {
#include "crush.h"
#include "hash.h"
#include "mapper.h"
#include "builder.h"
}
#include "include/ceph_assert.h"
#include "include/err.h"
#include "include/encoding.h"
#include "include/mempool.h"
namespace ceph {
class Formatter;
}
namespace CrushTreeDumper {
typedef mempool::osdmap::map<int64_t,std::string> name_map_t;
}
inline void encode(const crush_rule_step &s, ceph::buffer::list &bl)
{
using ceph::encode;
encode(s.op, bl);
encode(s.arg1, bl);
encode(s.arg2, bl);
}
inline void decode(crush_rule_step &s, ceph::buffer::list::const_iterator &p)
{
using ceph::decode;
decode(s.op, p);
decode(s.arg1, p);
decode(s.arg2, p);
}
class CrushWrapper {
public:
// magic value used by OSDMap for a "default" fallback choose_args, used if
// the choose_arg_map passed to do_rule does not exist. if this also
// doesn't exist, fall back to canonical weights.
enum {
DEFAULT_CHOOSE_ARGS = -1
};
std::map<int32_t, std::string> type_map; // item(bucket/device) type id ==> item type name
std::map<int32_t, std::string> name_map; // item id ==> item name
std::map<int32_t, std::string> rule_name_map;
std::map<int32_t, int32_t> class_map; /* item id -> class id */
std::map<int32_t, std::string> class_name; /* class id -> class name */
std::map<std::string, int32_t> class_rname; /* class name -> class id */
std::map<int32_t, std::map<int32_t, int32_t> > class_bucket; /* bucket[id][class] == id */
std::map<int64_t, crush_choose_arg_map> choose_args;
private:
struct crush_map *crush = nullptr;
/* reverse maps */
mutable bool have_rmaps = false;
mutable std::map<std::string, int> type_rmap, name_rmap, rule_name_rmap;
void build_rmaps() const {
if (have_rmaps) return;
build_rmap(type_map, type_rmap);
build_rmap(name_map, name_rmap);
build_rmap(rule_name_map, rule_name_rmap);
have_rmaps = true;
}
void build_rmap(const std::map<int, std::string> &f, std::map<std::string, int> &r) const {
r.clear();
for (auto p = f.begin(); p != f.end(); ++p)
r[p->second] = p->first;
}
public:
CrushWrapper(const CrushWrapper& other);
const CrushWrapper& operator=(const CrushWrapper& other);
CrushWrapper() {
create();
}
~CrushWrapper() {
if (crush)
crush_destroy(crush);
choose_args_clear();
}
crush_map *get_crush_map() { return crush; }
/* building */
void create() {
if (crush)
crush_destroy(crush);
crush = crush_create();
choose_args_clear();
ceph_assert(crush);
have_rmaps = false;
set_tunables_default();
}
/// true if any buckets that aren't straw2
bool has_non_straw2_buckets() const;
// tunables
void set_tunables_argonaut() {
crush->choose_local_tries = 2;
crush->choose_local_fallback_tries = 5;
crush->choose_total_tries = 19;
crush->chooseleaf_descend_once = 0;
crush->chooseleaf_vary_r = 0;
crush->chooseleaf_stable = 0;
crush->allowed_bucket_algs = CRUSH_LEGACY_ALLOWED_BUCKET_ALGS;
}
void set_tunables_bobtail() {
crush->choose_local_tries = 0;
crush->choose_local_fallback_tries = 0;
crush->choose_total_tries = 50;
crush->chooseleaf_descend_once = 1;
crush->chooseleaf_vary_r = 0;
crush->chooseleaf_stable = 0;
crush->allowed_bucket_algs = CRUSH_LEGACY_ALLOWED_BUCKET_ALGS;
}
void set_tunables_firefly() {
crush->choose_local_tries = 0;
crush->choose_local_fallback_tries = 0;
crush->choose_total_tries = 50;
crush->chooseleaf_descend_once = 1;
crush->chooseleaf_vary_r = 1;
crush->chooseleaf_stable = 0;
crush->allowed_bucket_algs = CRUSH_LEGACY_ALLOWED_BUCKET_ALGS;
}
void set_tunables_hammer() {
crush->choose_local_tries = 0;
crush->choose_local_fallback_tries = 0;
crush->choose_total_tries = 50;
crush->chooseleaf_descend_once = 1;
crush->chooseleaf_vary_r = 1;
crush->chooseleaf_stable = 0;
crush->allowed_bucket_algs =
(1 << CRUSH_BUCKET_UNIFORM) |
(1 << CRUSH_BUCKET_LIST) |
(1 << CRUSH_BUCKET_STRAW) |
(1 << CRUSH_BUCKET_STRAW2);
}
void set_tunables_jewel() {
crush->choose_local_tries = 0;
crush->choose_local_fallback_tries = 0;
crush->choose_total_tries = 50;
crush->chooseleaf_descend_once = 1;
crush->chooseleaf_vary_r = 1;
crush->chooseleaf_stable = 1;
crush->allowed_bucket_algs =
(1 << CRUSH_BUCKET_UNIFORM) |
(1 << CRUSH_BUCKET_LIST) |
(1 << CRUSH_BUCKET_STRAW) |
(1 << CRUSH_BUCKET_STRAW2);
}
void set_tunables_legacy() {
set_tunables_argonaut();
crush->straw_calc_version = 0;
}
void set_tunables_optimal() {
set_tunables_jewel();
crush->straw_calc_version = 1;
}
void set_tunables_default() {
set_tunables_jewel();
crush->straw_calc_version = 1;
}
int get_choose_local_tries() const {
return crush->choose_local_tries;
}
void set_choose_local_tries(int n) {
crush->choose_local_tries = n;
}
int get_choose_local_fallback_tries() const {
return crush->choose_local_fallback_tries;
}
void set_choose_local_fallback_tries(int n) {
crush->choose_local_fallback_tries = n;
}
int get_choose_total_tries() const {
return crush->choose_total_tries;
}
void set_choose_total_tries(int n) {
crush->choose_total_tries = n;
}
int get_chooseleaf_descend_once() const {
return crush->chooseleaf_descend_once;
}
void set_chooseleaf_descend_once(int n) {
crush->chooseleaf_descend_once = !!n;
}
int get_chooseleaf_vary_r() const {
return crush->chooseleaf_vary_r;
}
void set_chooseleaf_vary_r(int n) {
crush->chooseleaf_vary_r = n;
}
int get_chooseleaf_stable() const {
return crush->chooseleaf_stable;
}
void set_chooseleaf_stable(int n) {
crush->chooseleaf_stable = n;
}
int get_straw_calc_version() const {
return crush->straw_calc_version;
}
void set_straw_calc_version(int n) {
crush->straw_calc_version = n;
}
unsigned get_allowed_bucket_algs() const {
return crush->allowed_bucket_algs;
}
void set_allowed_bucket_algs(unsigned n) {
crush->allowed_bucket_algs = n;
}
bool has_argonaut_tunables() const {
return
crush->choose_local_tries == 2 &&
crush->choose_local_fallback_tries == 5 &&
crush->choose_total_tries == 19 &&
crush->chooseleaf_descend_once == 0 &&
crush->chooseleaf_vary_r == 0 &&
crush->chooseleaf_stable == 0 &&
crush->allowed_bucket_algs == CRUSH_LEGACY_ALLOWED_BUCKET_ALGS;
}
bool has_bobtail_tunables() const {
return
crush->choose_local_tries == 0 &&
crush->choose_local_fallback_tries == 0 &&
crush->choose_total_tries == 50 &&
crush->chooseleaf_descend_once == 1 &&
crush->chooseleaf_vary_r == 0 &&
crush->chooseleaf_stable == 0 &&
crush->allowed_bucket_algs == CRUSH_LEGACY_ALLOWED_BUCKET_ALGS;
}
bool has_firefly_tunables() const {
return
crush->choose_local_tries == 0 &&
crush->choose_local_fallback_tries == 0 &&
crush->choose_total_tries == 50 &&
crush->chooseleaf_descend_once == 1 &&
crush->chooseleaf_vary_r == 1 &&
crush->chooseleaf_stable == 0 &&
crush->allowed_bucket_algs == CRUSH_LEGACY_ALLOWED_BUCKET_ALGS;
}
bool has_hammer_tunables() const {
return
crush->choose_local_tries == 0 &&
crush->choose_local_fallback_tries == 0 &&
crush->choose_total_tries == 50 &&
crush->chooseleaf_descend_once == 1 &&
crush->chooseleaf_vary_r == 1 &&
crush->chooseleaf_stable == 0 &&
crush->allowed_bucket_algs == ((1 << CRUSH_BUCKET_UNIFORM) |
(1 << CRUSH_BUCKET_LIST) |
(1 << CRUSH_BUCKET_STRAW) |
(1 << CRUSH_BUCKET_STRAW2));
}
bool has_jewel_tunables() const {
return
crush->choose_local_tries == 0 &&
crush->choose_local_fallback_tries == 0 &&
crush->choose_total_tries == 50 &&
crush->chooseleaf_descend_once == 1 &&
crush->chooseleaf_vary_r == 1 &&
crush->chooseleaf_stable == 1 &&
crush->allowed_bucket_algs == ((1 << CRUSH_BUCKET_UNIFORM) |
(1 << CRUSH_BUCKET_LIST) |
(1 << CRUSH_BUCKET_STRAW) |
(1 << CRUSH_BUCKET_STRAW2));
}
bool has_optimal_tunables() const {
return has_jewel_tunables();
}
bool has_legacy_tunables() const {
return has_argonaut_tunables();
}
bool has_nondefault_tunables() const {
return
(crush->choose_local_tries != 2 ||
crush->choose_local_fallback_tries != 5 ||
crush->choose_total_tries != 19);
}
bool has_nondefault_tunables2() const {
return
crush->chooseleaf_descend_once != 0;
}
bool has_nondefault_tunables3() const {
return
crush->chooseleaf_vary_r != 0;
}
bool has_nondefault_tunables5() const {
return
crush->chooseleaf_stable != 0;
}
bool has_v2_rules() const;
bool has_v3_rules() const;
bool has_v4_buckets() const;
bool has_v5_rules() const;
bool has_choose_args() const; // any choose_args
bool has_incompat_choose_args() const; // choose_args that can't be made compat
bool is_v2_rule(unsigned ruleid) const;
bool is_v3_rule(unsigned ruleid) const;
bool is_v5_rule(unsigned ruleid) const;
std::string get_min_required_version() const {
if (has_v5_rules() || has_nondefault_tunables5())
return "jewel";
else if (has_v4_buckets())
return "hammer";
else if (has_nondefault_tunables3())
return "firefly";
else if (has_nondefault_tunables2() || has_nondefault_tunables())
return "bobtail";
else
return "argonaut";
}
// default bucket types
unsigned get_default_bucket_alg() const {
// in order of preference
if (crush->allowed_bucket_algs & (1 << CRUSH_BUCKET_STRAW2))
return CRUSH_BUCKET_STRAW2;
if (crush->allowed_bucket_algs & (1 << CRUSH_BUCKET_STRAW))
return CRUSH_BUCKET_STRAW;
if (crush->allowed_bucket_algs & (1 << CRUSH_BUCKET_TREE))
return CRUSH_BUCKET_TREE;
if (crush->allowed_bucket_algs & (1 << CRUSH_BUCKET_LIST))
return CRUSH_BUCKET_LIST;
if (crush->allowed_bucket_algs & (1 << CRUSH_BUCKET_UNIFORM))
return CRUSH_BUCKET_UNIFORM;
return 0;
}
// bucket types
int get_num_type_names() const {
return type_map.size();
}
int get_max_type_id() const {
if (type_map.empty())
return 0;
return type_map.rbegin()->first;
}
int get_type_id(const std::string& name) const {
build_rmaps();
auto found = type_rmap.find(name);
if (found != type_rmap.end()) {
return found->second;
} else {
return -1;
}
}
std::optional<int> get_validated_type_id(const std::string& name) const {
int retval = get_type_id(name);
if (retval == -1 && !type_rmap.count(name)) {
return {};
} else {
return retval;
}
}
const char *get_type_name(int t) const {
auto p = type_map.find(t);
if (p != type_map.end())
return p->second.c_str();
return 0;
}
void set_type_name(int i, const std::string& name) {
type_map[i] = name;
if (have_rmaps)
type_rmap[name] = i;
}
// item/bucket names
bool name_exists(const std::string& name) const {
build_rmaps();
return name_rmap.count(name);
}
bool item_exists(int i) const {
return name_map.count(i);
}
int get_item_id(const std::string& name) const {
build_rmaps();
if (name_rmap.count(name))
return name_rmap[name];
return 0; /* hrm */
}
const char *get_item_name(int t) const {
std::map<int,std::string>::const_iterator p = name_map.find(t);
if (p != name_map.end())
return p->second.c_str();
return 0;
}
int set_item_name(int i, const std::string& name) {
if (!is_valid_crush_name(name))
return -EINVAL;
name_map[i] = name;
if (have_rmaps)
name_rmap[name] = i;
return 0;
}
void swap_names(int a, int b) {
std::string an = name_map[a];
std::string bn = name_map[b];
name_map[a] = bn;
name_map[b] = an;
if (have_rmaps) {
name_rmap[an] = b;
name_rmap[bn] = a;
}
}
int split_id_class(int i, int *idout, int *classout) const;
bool class_exists(const std::string& name) const {
return class_rname.count(name);
}
const char *get_class_name(int i) const {
auto p = class_name.find(i);
if (p != class_name.end())
return p->second.c_str();
return 0;
}
int get_class_id(const std::string& name) const {
auto p = class_rname.find(name);
if (p != class_rname.end())
return p->second;
else
return -EINVAL;
}
int remove_class_name(const std::string& name) {
auto p = class_rname.find(name);
if (p == class_rname.end())
return -ENOENT;
int class_id = p->second;
auto q = class_name.find(class_id);
if (q == class_name.end())
return -ENOENT;
class_rname.erase(name);
class_name.erase(class_id);
return 0;
}
int32_t _alloc_class_id() const;
int get_or_create_class_id(const std::string& name) {
int c = get_class_id(name);
if (c < 0) {
int i = _alloc_class_id();
class_name[i] = name;
class_rname[name] = i;
return i;
} else {
return c;
}
}
const char *get_item_class(int t) const {
std::map<int,int>::const_iterator p = class_map.find(t);
if (p == class_map.end())
return 0;
return get_class_name(p->second);
}
int get_item_class_id(int t) const {
auto p = class_map.find(t);
if (p == class_map.end())
return -ENOENT;
return p->second;
}
int set_item_class(int i, const std::string& name) {
if (!is_valid_crush_name(name))
return -EINVAL;
class_map[i] = get_or_create_class_id(name);
return 0;
}
int set_item_class(int i, int c) {
class_map[i] = c;
return c;
}
void get_devices_by_class(const std::string &name,
std::set<int> *devices) const {
ceph_assert(devices);
devices->clear();
if (!class_exists(name)) {
return;
}
auto cid = get_class_id(name);
for (auto& p : class_map) {
if (p.first >= 0 && p.second == cid) {
devices->insert(p.first);
}
}
}
void class_remove_item(int i) {
auto it = class_map.find(i);
if (it == class_map.end()) {
return;
}
class_map.erase(it);
}
int can_rename_item(const std::string& srcname,
const std::string& dstname,
std::ostream *ss) const;
int rename_item(const std::string& srcname,
const std::string& dstname,
std::ostream *ss);
int can_rename_bucket(const std::string& srcname,
const std::string& dstname,
std::ostream *ss) const;
int rename_bucket(const std::string& srcname,
const std::string& dstname,
std::ostream *ss);
// rule names
int rename_rule(const std::string& srcname,
const std::string& dstname,
std::ostream *ss);
bool rule_exists(std::string name) const {
build_rmaps();
return rule_name_rmap.count(name);
}
int get_rule_id(std::string name) const {
build_rmaps();
if (rule_name_rmap.count(name))
return rule_name_rmap[name];
return -ENOENT;
}
const char *get_rule_name(int t) const {
auto p = rule_name_map.find(t);
if (p != rule_name_map.end())
return p->second.c_str();
return 0;
}
void set_rule_name(int i, const std::string& name) {
rule_name_map[i] = name;
if (have_rmaps)
rule_name_rmap[name] = i;
}
bool is_shadow_item(int id) const {
const char *name = get_item_name(id);
return name && !is_valid_crush_name(name);
}
/**
* find tree nodes referenced by rules by a 'take' command
*
* Note that these may not be parentless roots.
*/
void find_takes(std::set<int> *roots) const;
void find_takes_by_rule(int rule, std::set<int> *roots) const;
/**
* find tree roots
*
* These are parentless nodes in the map.
*/
void find_roots(std::set<int> *roots) const;
/**
* find tree roots that contain shadow (device class) items only
*/
void find_shadow_roots(std::set<int> *roots) const {
std::set<int> all;
find_roots(&all);
for (auto& p: all) {
if (is_shadow_item(p)) {
roots->insert(p);
}
}
}
/**
* find tree roots that are not shadow (device class) items
*
* These are parentless nodes in the map that are not shadow
* items for device classes.
*/
void find_nonshadow_roots(std::set<int> *roots) const {
std::set<int> all;
find_roots(&all);
for (auto& p: all) {
if (!is_shadow_item(p)) {
roots->insert(p);
}
}
}
/**
* see if an item is contained within a subtree
*
* @param root haystack
* @param item needle
* @return true if the item is located beneath the given node
*/
bool subtree_contains(int root, int item) const;
private:
/**
* search for an item in any bucket
*
* @param i item
* @return true if present
*/
bool _search_item_exists(int i) const;
bool is_parent_of(int child, int p) const;
public:
/**
* see if item is located where we think it is
*
* This verifies that the given item is located at a particular
* location in the hierarchy. However, that check is imprecise; we
* are actually verifying that the most specific location key/value
* is correct. For example, if loc specifies that rack=foo and
* host=bar, it will verify that host=bar is correct; any placement
* above that level in the hierarchy is ignored. This matches the
* semantics for insert_item().
*
* @param cct cct
* @param item item id
* @param loc location to check (map of type to bucket names)
* @param weight optional pointer to weight of item at that location
* @return true if item is at specified location
*/
bool check_item_loc(CephContext *cct, int item,
const std::map<std::string,std::string>& loc,
int *iweight);
bool check_item_loc(CephContext *cct, int item,
const std::map<std::string,std::string>& loc,
float *weight) {
int iweight;
bool ret = check_item_loc(cct, item, loc, &iweight);
if (weight)
*weight = (float)iweight / (float)0x10000;
return ret;
}
/**
* returns the (type, name) of the parent bucket of id
*
* FIXME: ambiguous for items that occur multiple times in the map
*/
std::pair<std::string,std::string> get_immediate_parent(int id, int *ret = NULL) const;
int get_immediate_parent_id(int id, int *parent) const;
/**
* return ancestor of the given type, or 0 if none
* can pass in a specific crush **rule** to return ancestor from that rule only
* (parent is always a bucket and thus <0)
*/
int get_parent_of_type(int id, int type, int rule = -1) const;
/**
* get the fully qualified location of a device by successively finding
* parents beginning at ID and ending at highest type number specified in
* the CRUSH map which assumes that if device foo is under device bar, the
* type_id of foo < bar where type_id is the integer specified in the CRUSH map
*
* returns the location in the form of (type=foo) where type is a type of bucket
* specified in the CRUSH map and foo is a name specified in the CRUSH map
*/
std::map<std::string, std::string> get_full_location(int id) const;
/**
* return location map for a item, by name
*/
int get_full_location(
const std::string& name,
std::map<std::string,std::string> *ploc);
/*
* identical to get_full_location(int id) although it returns the type/name
* pairs in the order they occur in the hierarchy.
*
* returns -ENOENT if id is not found.
*/
int get_full_location_ordered(
int id,
std::vector<std::pair<std::string, std::string> >& path) const;
/*
* identical to get_full_location_ordered(int id, vector<pair<string, string> >& path),
* although it returns a concatenated string with the type/name pairs in descending
* hierarchical order with format key1=val1,key2=val2.
*
* returns the location in descending hierarchy as a string.
*/
std::string get_full_location_ordered_string(int id) const;
/**
* returns (type_id, type) of all parent buckets between id and
* default, can be used to check for anomalous CRUSH maps
*/
std::map<int, std::string> get_parent_hierarchy(int id) const;
/**
* enumerate immediate children of given node
*
* @param id parent bucket or device id
* @return number of items, or error
*/
int get_children(int id, std::list<int> *children) const;
/**
* enumerate all children of given node
*
* @param id parent bucket or device id
* @return number of items, or error
*/
int get_all_children(int id, std::set<int> *children) const;
void get_children_of_type(int id,
int type,
std::vector<int> *children,
bool exclude_shadow = true) const;
/**
* enumerate all subtrees by type
*/
void get_subtree_of_type(int type, std::vector<int> *subtrees);
/**
* verify upmapping results.
* return 0 on success or a negative errno on error.
*/
int verify_upmap(CephContext *cct,
int rule_id,
int pool_size,
const std::vector<int>& up);
/**
* enumerate leaves(devices) of given node
*
* @param name parent bucket name
* @return 0 on success or a negative errno on error.
*/
int get_leaves(const std::string &name, std::set<int> *leaves) const;
private:
int _get_leaves(int id, std::list<int> *leaves) const; // worker
public:
/**
* insert an item into the map at a specific position
*
* Add an item at a specific location of the hierarchy.
* Specifically, we look for the most specific location constraint
* for which a bucket already exists, and then create intervening
* buckets beneath that in order to place the item.
*
* Note that any location specifiers *above* the most specific match
* are ignored. For example, if we specify that osd.12 goes in
* host=foo, rack=bar, and row=baz, and rack=bar is the most
* specific match, we will create host=foo beneath that point and
* put osd.12 inside it. However, we will not verify that rack=bar
* is beneath row=baz or move it.
*
* In short, we will build out a hierarchy, and move leaves around,
* but not adjust the hierarchy's internal structure. Yet.
*
* If the item is already present in the map, we will return EEXIST.
* If the location key/value pairs are nonsensical
* (rack=nameofdevice), or location specifies that do not attach us
* to any existing part of the hierarchy, we will return EINVAL.
*
* @param cct cct
* @param id item id
* @param weight item weight
* @param name item name
* @param loc location (map of type to bucket names)
* @param init_weight_sets initialize weight-set weights to weight (vs 0)
* @return 0 for success, negative on error
*/
int insert_item(CephContext *cct, int id, float weight, std::string name,
const std::map<std::string,std::string>& loc,
bool init_weight_sets=true);
/**
* move a bucket in the hierarchy to the given location
*
* This has the same location and ancestor creation behavior as
* insert_item(), but will relocate the specified existing bucket.
*
* @param cct cct
* @param id bucket id
* @param loc location (map of type to bucket names)
* @return 0 for success, negative on error
*/
int move_bucket(CephContext *cct, int id, const std::map<std::string,std::string>& loc);
/**
* swap bucket contents of two buckets without touching bucket ids
*
* @param cct cct
* @param src bucket a
* @param dst bucket b
* @return 0 for success, negative on error
*/
int swap_bucket(CephContext *cct, int src, int dst);
/**
* add a link to an existing bucket in the hierarchy to the new location
*
* This has the same location and ancestor creation behavior as
* insert_item(), but will add a new link to the specified existing
* bucket.
*
* @param cct cct
* @param id bucket id
* @param loc location (map of type to bucket names)
* @return 0 for success, negative on error
*/
int link_bucket(CephContext *cct, int id,
const std::map<std::string,std::string>& loc);
/**
* add or update an item's position in the map
*
* This is analogous to insert_item, except we will move an item if
* it is already present.
*
* @param cct cct
* @param id item id
* @param weight item weight
* @param name item name
* @param loc location (map of type to bucket names)
* @return 0 for no change, 1 for successful change, negative on error
*/
int update_item(CephContext *cct, int id, float weight, std::string name,
const std::map<std::string, std::string>& loc);
/**
* create or move an item, but do not adjust its weight if it already exists
*
* @param cct cct
* @param item item id
* @param weight initial item weight (if we need to create it)
* @param name item name
* @param loc location (map of type to bucket names)
* @param init_weight_sets initialize weight-set values to weight (vs 0)
* @return 0 for no change, 1 for successful change, negative on error
*/
int create_or_move_item(CephContext *cct, int item, float weight,
std::string name,
const std::map<std::string,std::string>& loc,
bool init_weight_sets=true);
/**
* remove all instances of an item from the map
*
* @param cct cct
* @param id item id to remove
* @param unlink_only unlink but do not remove bucket (useful if multiple links or not empty)
* @return 0 on success, negative on error
*/
int remove_item(CephContext *cct, int id, bool unlink_only);
/**
* recursively remove buckets starting at item and stop removing
* when a bucket is in use.
*
* @param item id to remove
* @return 0 on success, negative on error
*/
int remove_root(CephContext *cct, int item);
/**
* remove all instances of an item nested beneath a certain point from the map
*
* @param cct cct
* @param id item id to remove
* @param ancestor ancestor item id under which to search for id
* @param unlink_only unlink but do not remove bucket (useful if bucket has multiple links or is not empty)
* @return 0 on success, negative on error
*/
private:
bool _maybe_remove_last_instance(CephContext *cct, int id, bool unlink_only);
int _remove_item_under(CephContext *cct, int id, int ancestor, bool unlink_only);
bool _bucket_is_in_use(int id);
public:
int remove_item_under(CephContext *cct, int id, int ancestor, bool unlink_only);
/**
* calculate the locality/distance from a given id to a crush location map
*
* Specifically, we look for the lowest-valued type for which the
* location of id matches that described in loc.
*
* @param cct cct
* @param id the existing id in the map
* @param loc a set of key=value pairs describing a location in the hierarchy
*/
int get_common_ancestor_distance(CephContext *cct, int id,
const std::multimap<std::string,std::string>& loc) const;
/**
* parse a set of key/value pairs out of a string vector
*
* These are used to describe a location in the CRUSH hierarchy.
*
* @param args list of strings (each key= or key=value)
* @param ploc pointer to a resulting location map or multimap
*/
static int parse_loc_map(const std::vector<std::string>& args,
std::map<std::string,std::string> *ploc);
static int parse_loc_multimap(const std::vector<std::string>& args,
std::multimap<std::string,std::string> *ploc);
/**
* get an item's weight
*
* Will return the weight for the first instance it finds.
*
* @param id item id to check
* @return weight of item
*/
int get_item_weight(int id) const;
float get_item_weightf(int id) const {
return (float)get_item_weight(id) / (float)0x10000;
}
int get_item_weight_in_loc(int id,
const std::map<std::string, std::string> &loc);
float get_item_weightf_in_loc(int id,
const std::map<std::string, std::string> &loc) {
return (float)get_item_weight_in_loc(id, loc) / (float)0x10000;
}
int validate_weightf(float weight) {
uint64_t iweight = weight * 0x10000;
if (iweight > static_cast<uint64_t>(std::numeric_limits<int>::max())) {
return -EOVERFLOW;
}
return 0;
}
int adjust_item_weight(CephContext *cct, int id, int weight,
bool update_weight_sets=true);
int adjust_item_weightf(CephContext *cct, int id, float weight,
bool update_weight_sets=true) {
int r = validate_weightf(weight);
if (r < 0) {
return r;
}
return adjust_item_weight(cct, id, (int)(weight * (float)0x10000),
update_weight_sets);
}
int adjust_item_weight_in_bucket(CephContext *cct, int id, int weight,
int bucket_id,
bool update_weight_sets);
int adjust_item_weight_in_loc(CephContext *cct, int id, int weight,
const std::map<std::string,std::string>& loc,
bool update_weight_sets=true);
int adjust_item_weightf_in_loc(CephContext *cct, int id, float weight,
const std::map<std::string,std::string>& loc,
bool update_weight_sets=true) {
int r = validate_weightf(weight);
if (r < 0) {
return r;
}
return adjust_item_weight_in_loc(cct, id, (int)(weight * (float)0x10000),
loc, update_weight_sets);
}
void reweight(CephContext *cct);
void reweight_bucket(crush_bucket *b,
crush_choose_arg_map& arg_map,
std::vector<uint32_t> *weightv);
int adjust_subtree_weight(CephContext *cct, int id, int weight,
bool update_weight_sets=true);