2 * Ceph - scalable distributed file system
4 * Copyright (C) 2015 Intel Corporation All Rights Reserved
6 * This is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License version 2.1, as published by the Free Software
9 * Foundation. See file COPYING.
14 # include <linux/string.h>
15 # include <linux/slab.h>
16 # include <linux/bug.h>
17 # include <linux/kernel.h>
18 # include <linux/crush/crush.h>
19 # include <linux/crush/hash.h>
21 # include "crush_compat.h"
25 #include "crush_ln_table.h"
27 #define dprintk(args...) /* printf(args) */
30 * Implement the core CRUSH mapping algorithm.
34 * crush_find_rule - find a crush_rule id for a given ruleset, type, and size.
36 * @ruleset: the storage ruleset id (user defined)
37 * @type: storage ruleset type (user defined)
38 * @size: output set size
40 int crush_find_rule(const struct crush_map
*map
, int ruleset
, int type
, int size
)
44 for (i
= 0; i
< map
->max_rules
; i
++) {
46 map
->rules
[i
]->mask
.ruleset
== ruleset
&&
47 map
->rules
[i
]->mask
.type
== type
&&
48 map
->rules
[i
]->mask
.min_size
<= size
&&
49 map
->rules
[i
]->mask
.max_size
>= size
)
57 * bucket choose methods
59 * For each bucket algorithm, we have a "choose" method that, given a
60 * crush input @x and replica position (usually, position in output set) @r,
61 * will produce an item in the bucket.
65 * Choose based on a random permutation of the bucket.
67 * We used to use some prime number arithmetic to do this, but it
68 * wasn't very random, and had some other bad behaviors. Instead, we
69 * calculate an actual random permutation of the bucket members.
70 * Since this is expensive, we optimize for the r=0 case, which
71 * captures the vast majority of calls.
73 static int bucket_perm_choose(struct crush_bucket
*bucket
,
76 unsigned int pr
= r
% bucket
->size
;
79 /* start a new permutation if @x has changed */
80 if (bucket
->perm_x
!= (__u32
)x
|| bucket
->perm_n
== 0) {
81 dprintk("bucket %d new x=%d\n", bucket
->id
, x
);
84 /* optimize common r=0 case */
86 s
= crush_hash32_3(bucket
->hash
, x
, bucket
->id
, 0) %
89 bucket
->perm_n
= 0xffff; /* magic value, see below */
93 for (i
= 0; i
< bucket
->size
; i
++)
96 } else if (bucket
->perm_n
== 0xffff) {
97 /* clean up after the r=0 case above */
98 for (i
= 1; i
< bucket
->size
; i
++)
100 bucket
->perm
[bucket
->perm
[0]] = 0;
104 /* calculate permutation up to pr */
105 for (i
= 0; i
< bucket
->perm_n
; i
++)
106 dprintk(" perm_choose have %d: %d\n", i
, bucket
->perm
[i
]);
107 while (bucket
->perm_n
<= pr
) {
108 unsigned int p
= bucket
->perm_n
;
109 /* no point in swapping the final entry */
110 if (p
< bucket
->size
- 1) {
111 i
= crush_hash32_3(bucket
->hash
, x
, bucket
->id
, p
) %
114 unsigned int t
= bucket
->perm
[p
+ i
];
115 bucket
->perm
[p
+ i
] = bucket
->perm
[p
];
118 dprintk(" perm_choose swap %d with %d\n", p
, p
+i
);
122 for (i
= 0; i
< bucket
->size
; i
++)
123 dprintk(" perm_choose %d: %d\n", i
, bucket
->perm
[i
]);
125 s
= bucket
->perm
[pr
];
127 dprintk(" perm_choose %d sz=%d x=%d r=%d (%d) s=%d\n", bucket
->id
,
128 bucket
->size
, x
, r
, pr
, s
);
129 return bucket
->items
[s
];
133 static int bucket_uniform_choose(struct crush_bucket_uniform
*bucket
,
136 return bucket_perm_choose(&bucket
->h
, x
, r
);
140 static int bucket_list_choose(struct crush_bucket_list
*bucket
,
145 for (i
= bucket
->h
.size
-1; i
>= 0; i
--) {
146 __u64 w
= crush_hash32_4(bucket
->h
.hash
, x
, bucket
->h
.items
[i
],
149 dprintk("list_choose i=%d x=%d r=%d item %d weight %x "
151 i
, x
, r
, bucket
->h
.items
[i
], bucket
->item_weights
[i
],
152 bucket
->sum_weights
[i
], w
);
153 w
*= bucket
->sum_weights
[i
];
155 /*dprintk(" scaled %llx\n", w);*/
156 if (w
< bucket
->item_weights
[i
])
157 return bucket
->h
.items
[i
];
160 dprintk("bad list sums for bucket %d\n", bucket
->h
.id
);
161 return bucket
->h
.items
[0];
166 static int height(int n
)
169 while ((n
& 1) == 0) {
176 static int left(int x
)
179 return x
- (1 << (h
-1));
182 static int right(int x
)
185 return x
+ (1 << (h
-1));
188 static int terminal(int x
)
193 static int bucket_tree_choose(struct crush_bucket_tree
*bucket
,
201 n
= bucket
->num_nodes
>> 1;
203 while (!terminal(n
)) {
205 /* pick point in [0, w) */
206 w
= bucket
->node_weights
[n
];
207 t
= (__u64
)crush_hash32_4(bucket
->h
.hash
, x
, n
, r
,
208 bucket
->h
.id
) * (__u64
)w
;
211 /* descend to the left or right? */
213 if (t
< bucket
->node_weights
[l
])
219 return bucket
->h
.items
[n
>> 1];
225 static int bucket_straw_choose(struct crush_bucket_straw
*bucket
,
233 for (i
= 0; i
< bucket
->h
.size
; i
++) {
234 draw
= crush_hash32_3(bucket
->h
.hash
, x
, bucket
->h
.items
[i
], r
);
236 draw
*= bucket
->straws
[i
];
237 if (i
== 0 || draw
> high_draw
) {
242 return bucket
->h
.items
[high
];
245 /* compute 2^44*log2(input+1) */
246 static __u64
crush_ln(unsigned int xin
)
248 unsigned int x
= xin
, x1
;
249 int iexpon
, index1
, index2
;
250 __u64 RH
, LH
, LL
, xl64
, result
;
254 /* normalize input */
256 while (!(x
& 0x18000)) {
261 index1
= (x
>> 8) << 1;
262 /* RH ~ 2^56/index1 */
263 RH
= __RH_LH_tbl
[index1
- 256];
264 /* LH ~ 2^48 * log2(index1/256) */
265 LH
= __RH_LH_tbl
[index1
+ 1 - 256];
267 /* RH*x ~ 2^48 * (2^15 + xf), xf<2^8 */
268 xl64
= (__s64
)x
* RH
;
273 result
<<= (12 + 32);
276 /* LL ~ 2^48*log2(1.0+index2/2^15) */
277 LL
= __LL_tbl
[index2
];
281 LH
>>= (48 - 12 - 32);
291 * for reference, see:
293 * http://en.wikipedia.org/wiki/Exponential_distribution#Distribution_of_the_minimum_of_exponential_random_variables
297 static int bucket_straw2_choose(struct crush_bucket_straw2
*bucket
,
300 unsigned int i
, high
= 0;
303 __s64 ln
, draw
, high_draw
= 0;
305 for (i
= 0; i
< bucket
->h
.size
; i
++) {
306 w
= bucket
->item_weights
[i
];
308 u
= crush_hash32_3(bucket
->h
.hash
, x
,
309 bucket
->h
.items
[i
], r
);
313 * for some reason slightly less than 0x10000 produces
314 * a slightly more accurate distribution... probably a
317 * the natural log lookup table maps [0,0xffff]
318 * (corresponding to real numbers [1/0x10000, 1] to
319 * [0, 0xffffffffffff] (corresponding to real numbers
322 ln
= crush_ln(u
) - 0x1000000000000ll
;
325 * divide by 16.16 fixed-point weight. note
326 * that the ln value is negative, so a larger
327 * weight means a larger (less negative) value
330 draw
= div64_s64(ln
, w
);
335 if (i
== 0 || draw
> high_draw
) {
340 return bucket
->h
.items
[high
];
344 static int crush_bucket_choose(struct crush_bucket
*in
, int x
, int r
)
346 dprintk(" crush_bucket_choose %d x=%d r=%d\n", in
->id
, x
, r
);
347 BUG_ON(in
->size
== 0);
349 case CRUSH_BUCKET_UNIFORM
:
350 return bucket_uniform_choose((struct crush_bucket_uniform
*)in
,
352 case CRUSH_BUCKET_LIST
:
353 return bucket_list_choose((struct crush_bucket_list
*)in
,
355 case CRUSH_BUCKET_TREE
:
356 return bucket_tree_choose((struct crush_bucket_tree
*)in
,
358 case CRUSH_BUCKET_STRAW
:
359 return bucket_straw_choose((struct crush_bucket_straw
*)in
,
361 case CRUSH_BUCKET_STRAW2
:
362 return bucket_straw2_choose((struct crush_bucket_straw2
*)in
,
365 dprintk("unknown bucket %d alg %d\n", in
->id
, in
->alg
);
372 * true if device is marked "out" (failed, fully offloaded)
375 static int is_out(const struct crush_map
*map
,
376 const __u32
*weight
, int weight_max
,
379 if (item
>= weight_max
)
381 if (weight
[item
] >= 0x10000)
383 if (weight
[item
] == 0)
385 if ((crush_hash32_2(CRUSH_HASH_RJENKINS1
, x
, item
) & 0xffff)
392 * crush_choose_firstn - choose numrep distinct items of given type
393 * @map: the crush_map
394 * @bucket: the bucket we are choose an item from
395 * @x: crush input value
396 * @numrep: the number of items to choose
397 * @type: the type of item to choose
398 * @out: pointer to output vector
399 * @outpos: our position in that vector
400 * @out_size: size of the out vector
401 * @tries: number of attempts to make
402 * @recurse_tries: number of attempts to have recursive chooseleaf make
403 * @local_retries: localized retries
404 * @local_fallback_retries: localized fallback retries
405 * @recurse_to_leaf: true if we want one device under each item of given type (chooseleaf instead of choose)
406 * @stable: stable mode starts rep=0 in the recursive call for all replicas
407 * @vary_r: pass r to recursive calls
408 * @out2: second output vector for leaf items (if @recurse_to_leaf)
409 * @parent_r: r value passed from the parent
411 static int crush_choose_firstn(const struct crush_map
*map
,
412 struct crush_bucket
*bucket
,
413 const __u32
*weight
, int weight_max
,
414 int x
, int numrep
, int type
,
415 int *out
, int outpos
,
418 unsigned int recurse_tries
,
419 unsigned int local_retries
,
420 unsigned int local_fallback_retries
,
428 unsigned int ftotal
, flocal
;
429 int retry_descent
, retry_bucket
, skip_rep
;
430 struct crush_bucket
*in
= bucket
;
436 int count
= out_size
;
438 dprintk("CHOOSE%s bucket %d x %d outpos %d numrep %d tries %d recurse_tries %d local_retries %d local_fallback_retries %d parent_r %d stable %d\n",
439 recurse_to_leaf
? "_LEAF" : "",
440 bucket
->id
, x
, outpos
, numrep
,
441 tries
, recurse_tries
, local_retries
, local_fallback_retries
,
444 for (rep
= stable
? 0 : outpos
; rep
< numrep
&& count
> 0 ; rep
++) {
445 /* keep trying until we get a non-out, non-colliding item */
450 in
= bucket
; /* initial bucket */
452 /* choose through intervening buckets */
458 /* r' = r + f_total */
466 if (local_fallback_retries
> 0 &&
467 flocal
>= (in
->size
>>1) &&
468 flocal
> local_fallback_retries
)
469 item
= bucket_perm_choose(in
, x
, r
);
471 item
= crush_bucket_choose(in
, x
, r
);
472 if (item
>= map
->max_devices
) {
473 dprintk(" bad item %d\n", item
);
480 itemtype
= map
->buckets
[-1-item
]->type
;
483 dprintk(" item %d type %d\n", item
, itemtype
);
486 if (itemtype
!= type
) {
488 (-1-item
) >= map
->max_buckets
) {
489 dprintk(" bad item type %d\n", type
);
493 in
= map
->buckets
[-1-item
];
499 for (i
= 0; i
< outpos
; i
++) {
500 if (out
[i
] == item
) {
507 if (!collide
&& recurse_to_leaf
) {
511 sub_r
= r
>> (vary_r
-1);
514 if (crush_choose_firstn(map
,
515 map
->buckets
[-1-item
],
517 x
, stable
? 1 : outpos
+1, 0,
521 local_fallback_retries
,
527 /* didn't get leaf */
530 /* we already have a leaf! */
538 reject
= is_out(map
, weight
,
546 if (reject
|| collide
) {
550 if (collide
&& flocal
<= local_retries
)
551 /* retry locally a few times */
553 else if (local_fallback_retries
> 0 &&
554 flocal
<= in
->size
+ local_fallback_retries
)
555 /* exhaustive bucket search */
557 else if (ftotal
< tries
)
558 /* then retry descent */
563 dprintk(" reject %d collide %d "
564 "ftotal %u flocal %u\n",
565 reject
, collide
, ftotal
,
568 } while (retry_bucket
);
569 } while (retry_descent
);
572 dprintk("skip rep\n");
576 dprintk("CHOOSE got %d\n", item
);
581 if (map
->choose_tries
&& ftotal
<= map
->choose_total_tries
)
582 map
->choose_tries
[ftotal
]++;
586 dprintk("CHOOSE returns %d\n", outpos
);
592 * crush_choose_indep: alternative breadth-first positionally stable mapping
595 static void crush_choose_indep(const struct crush_map
*map
,
596 struct crush_bucket
*bucket
,
597 const __u32
*weight
, int weight_max
,
598 int x
, int left
, int numrep
, int type
,
599 int *out
, int outpos
,
601 unsigned int recurse_tries
,
606 struct crush_bucket
*in
= bucket
;
607 int endpos
= outpos
+ left
;
616 dprintk("CHOOSE%s INDEP bucket %d x %d outpos %d numrep %d\n", recurse_to_leaf
? "_LEAF" : "",
617 bucket
->id
, x
, outpos
, numrep
);
619 /* initially my result is undefined */
620 for (rep
= outpos
; rep
< endpos
; rep
++) {
621 out
[rep
] = CRUSH_ITEM_UNDEF
;
623 out2
[rep
] = CRUSH_ITEM_UNDEF
;
626 for (ftotal
= 0; left
> 0 && ftotal
< tries
; ftotal
++) {
628 if (out2
&& ftotal
) {
629 dprintk("%u %d a: ", ftotal
, left
);
630 for (rep
= outpos
; rep
< endpos
; rep
++) {
631 dprintk(" %d", out
[rep
]);
634 dprintk("%u %d b: ", ftotal
, left
);
635 for (rep
= outpos
; rep
< endpos
; rep
++) {
636 dprintk(" %d", out2
[rep
]);
641 for (rep
= outpos
; rep
< endpos
; rep
++) {
642 if (out
[rep
] != CRUSH_ITEM_UNDEF
)
645 in
= bucket
; /* initial bucket */
647 /* choose through intervening buckets */
649 /* note: we base the choice on the position
650 * even in the nested call. that means that
651 * if the first layer chooses the same bucket
652 * in a different position, we will tend to
653 * choose a different item in that bucket.
654 * this will involve more devices in data
655 * movement and tend to distribute the load.
660 if (in
->alg
== CRUSH_BUCKET_UNIFORM
&&
661 in
->size
% numrep
== 0)
662 /* r'=r+(n+1)*f_total */
663 r
+= (numrep
+1) * ftotal
;
665 /* r' = r + n*f_total */
666 r
+= numrep
* ftotal
;
670 dprintk(" empty bucket\n");
674 item
= crush_bucket_choose(in
, x
, r
);
675 if (item
>= map
->max_devices
) {
676 dprintk(" bad item %d\n", item
);
677 out
[rep
] = CRUSH_ITEM_NONE
;
679 out2
[rep
] = CRUSH_ITEM_NONE
;
686 itemtype
= map
->buckets
[-1-item
]->type
;
689 dprintk(" item %d type %d\n", item
, itemtype
);
692 if (itemtype
!= type
) {
694 (-1-item
) >= map
->max_buckets
) {
695 dprintk(" bad item type %d\n", type
);
696 out
[rep
] = CRUSH_ITEM_NONE
;
703 in
= map
->buckets
[-1-item
];
709 for (i
= outpos
; i
< endpos
; i
++) {
710 if (out
[i
] == item
) {
718 if (recurse_to_leaf
) {
720 crush_choose_indep(map
,
721 map
->buckets
[-1-item
],
727 if (out2
[rep
] == CRUSH_ITEM_NONE
) {
728 /* placed nothing; no leaf */
732 /* we already have a leaf! */
739 is_out(map
, weight
, weight_max
, item
, x
))
749 for (rep
= outpos
; rep
< endpos
; rep
++) {
750 if (out
[rep
] == CRUSH_ITEM_UNDEF
) {
751 out
[rep
] = CRUSH_ITEM_NONE
;
753 if (out2
&& out2
[rep
] == CRUSH_ITEM_UNDEF
) {
754 out2
[rep
] = CRUSH_ITEM_NONE
;
758 if (map
->choose_tries
&& ftotal
<= map
->choose_total_tries
)
759 map
->choose_tries
[ftotal
]++;
763 dprintk("%u %d a: ", ftotal
, left
);
764 for (rep
= outpos
; rep
< endpos
; rep
++) {
765 dprintk(" %d", out
[rep
]);
768 dprintk("%u %d b: ", ftotal
, left
);
769 for (rep
= outpos
; rep
< endpos
; rep
++) {
770 dprintk(" %d", out2
[rep
]);
778 * crush_do_rule - calculate a mapping with the given input and rule
779 * @map: the crush_map
780 * @ruleno: the rule id
782 * @result: pointer to result vector
783 * @result_max: maximum result size
784 * @weight: weight vector (for map leaves)
785 * @weight_max: size of weight vector
786 * @scratch: scratch vector for private use; must be >= 3 * result_max
788 int crush_do_rule(const struct crush_map
*map
,
789 int ruleno
, int x
, int *result
, int result_max
,
790 const __u32
*weight
, int weight_max
,
795 int *b
= scratch
+ result_max
;
796 int *c
= scratch
+ result_max
*2;
803 struct crush_rule
*rule
;
809 * the original choose_total_tries value was off by one (it
810 * counted "retries" and not "tries"). add one.
812 int choose_tries
= map
->choose_total_tries
+ 1;
813 int choose_leaf_tries
= 0;
815 * the local tries values were counted as "retries", though,
816 * and need no adjustment
818 int choose_local_retries
= map
->choose_local_tries
;
819 int choose_local_fallback_retries
= map
->choose_local_fallback_tries
;
821 int vary_r
= map
->chooseleaf_vary_r
;
822 int stable
= map
->chooseleaf_stable
;
824 if ((__u32
)ruleno
>= map
->max_rules
) {
825 dprintk(" bad ruleno %d\n", ruleno
);
829 rule
= map
->rules
[ruleno
];
834 for (step
= 0; step
< rule
->len
; step
++) {
836 struct crush_rule_step
*curstep
= &rule
->steps
[step
];
838 switch (curstep
->op
) {
839 case CRUSH_RULE_TAKE
:
840 if ((curstep
->arg1
>= 0 &&
841 curstep
->arg1
< map
->max_devices
) ||
842 (-1-curstep
->arg1
>= 0 &&
843 -1-curstep
->arg1
< map
->max_buckets
&&
844 map
->buckets
[-1-curstep
->arg1
])) {
845 w
[0] = curstep
->arg1
;
848 dprintk(" bad take value %d\n", curstep
->arg1
);
852 case CRUSH_RULE_SET_CHOOSE_TRIES
:
853 if (curstep
->arg1
> 0)
854 choose_tries
= curstep
->arg1
;
857 case CRUSH_RULE_SET_CHOOSELEAF_TRIES
:
858 if (curstep
->arg1
> 0)
859 choose_leaf_tries
= curstep
->arg1
;
862 case CRUSH_RULE_SET_CHOOSE_LOCAL_TRIES
:
863 if (curstep
->arg1
>= 0)
864 choose_local_retries
= curstep
->arg1
;
867 case CRUSH_RULE_SET_CHOOSE_LOCAL_FALLBACK_TRIES
:
868 if (curstep
->arg1
>= 0)
869 choose_local_fallback_retries
= curstep
->arg1
;
872 case CRUSH_RULE_SET_CHOOSELEAF_VARY_R
:
873 if (curstep
->arg1
>= 0)
874 vary_r
= curstep
->arg1
;
877 case CRUSH_RULE_SET_CHOOSELEAF_STABLE
:
878 if (curstep
->arg1
>= 0)
879 stable
= curstep
->arg1
;
882 case CRUSH_RULE_CHOOSELEAF_FIRSTN
:
883 case CRUSH_RULE_CHOOSE_FIRSTN
:
886 case CRUSH_RULE_CHOOSELEAF_INDEP
:
887 case CRUSH_RULE_CHOOSE_INDEP
:
893 CRUSH_RULE_CHOOSELEAF_FIRSTN
||
895 CRUSH_RULE_CHOOSELEAF_INDEP
;
900 for (i
= 0; i
< wsize
; i
++) {
903 * see CRUSH_N, CRUSH_N_MINUS macros.
904 * basically, numrep <= 0 means relative to
905 * the provided result_max
907 numrep
= curstep
->arg1
;
909 numrep
+= result_max
;
914 /* make sure bucket id is valid */
916 if (bno
< 0 || bno
>= map
->max_buckets
) {
917 /* w[i] is probably CRUSH_ITEM_NONE */
918 dprintk(" bad w[i] %d\n", w
[i
]);
923 if (choose_leaf_tries
)
926 else if (map
->chooseleaf_descend_once
)
929 recurse_tries
= choose_tries
;
930 osize
+= crush_choose_firstn(
940 choose_local_retries
,
941 choose_local_fallback_retries
,
948 out_size
= ((numrep
< (result_max
-osize
)) ?
949 numrep
: (result_max
-osize
));
959 choose_leaf_tries
: 1,
968 /* copy final _leaf_ values to output set */
969 memcpy(o
, c
, osize
*sizeof(*o
));
971 /* swap o and w arrays */
979 case CRUSH_RULE_EMIT
:
980 for (i
= 0; i
< wsize
&& result_len
< result_max
; i
++) {
981 result
[result_len
] = w
[i
];
988 dprintk(" unknown op %d at step %d\n",