3 # include <linux/string.h>
4 # include <linux/slab.h>
5 # include <linux/bug.h>
6 # include <linux/kernel.h>
8 # define dprintk(args...)
15 # define BUG_ON(x) assert(!(x))
16 # define dprintk(args...) /* printf(args) */
17 # define kmalloc(x, f) malloc(x)
18 # define kfree(x) free(x)
21 #include <linux/crush/crush.h>
22 #include <linux/crush/hash.h>
23 #include <linux/crush/mapper.h>
26 * Implement the core CRUSH mapping algorithm.
30 * crush_find_rule - find a crush_rule id for a given ruleset, type, and size.
32 * @ruleset: the storage ruleset id (user defined)
33 * @type: storage ruleset type (user defined)
34 * @size: output set size
36 int crush_find_rule(const struct crush_map
*map
, int ruleset
, int type
, int size
)
40 for (i
= 0; i
< map
->max_rules
; i
++) {
42 map
->rules
[i
]->mask
.ruleset
== ruleset
&&
43 map
->rules
[i
]->mask
.type
== type
&&
44 map
->rules
[i
]->mask
.min_size
<= size
&&
45 map
->rules
[i
]->mask
.max_size
>= size
)
53 * bucket choose methods
55 * For each bucket algorithm, we have a "choose" method that, given a
56 * crush input @x and replica position (usually, position in output set) @r,
57 * will produce an item in the bucket.
61 * Choose based on a random permutation of the bucket.
63 * We used to use some prime number arithmetic to do this, but it
64 * wasn't very random, and had some other bad behaviors. Instead, we
65 * calculate an actual random permutation of the bucket members.
66 * Since this is expensive, we optimize for the r=0 case, which
67 * captures the vast majority of calls.
69 static int bucket_perm_choose(struct crush_bucket
*bucket
,
72 unsigned int pr
= r
% bucket
->size
;
75 /* start a new permutation if @x has changed */
76 if (bucket
->perm_x
!= (__u32
)x
|| bucket
->perm_n
== 0) {
77 dprintk("bucket %d new x=%d\n", bucket
->id
, x
);
80 /* optimize common r=0 case */
82 s
= crush_hash32_3(bucket
->hash
, x
, bucket
->id
, 0) %
85 bucket
->perm_n
= 0xffff; /* magic value, see below */
89 for (i
= 0; i
< bucket
->size
; i
++)
92 } else if (bucket
->perm_n
== 0xffff) {
93 /* clean up after the r=0 case above */
94 for (i
= 1; i
< bucket
->size
; i
++)
96 bucket
->perm
[bucket
->perm
[0]] = 0;
100 /* calculate permutation up to pr */
101 for (i
= 0; i
< bucket
->perm_n
; i
++)
102 dprintk(" perm_choose have %d: %d\n", i
, bucket
->perm
[i
]);
103 while (bucket
->perm_n
<= pr
) {
104 unsigned int p
= bucket
->perm_n
;
105 /* no point in swapping the final entry */
106 if (p
< bucket
->size
- 1) {
107 i
= crush_hash32_3(bucket
->hash
, x
, bucket
->id
, p
) %
110 unsigned int t
= bucket
->perm
[p
+ i
];
111 bucket
->perm
[p
+ i
] = bucket
->perm
[p
];
114 dprintk(" perm_choose swap %d with %d\n", p
, p
+i
);
118 for (i
= 0; i
< bucket
->size
; i
++)
119 dprintk(" perm_choose %d: %d\n", i
, bucket
->perm
[i
]);
121 s
= bucket
->perm
[pr
];
123 dprintk(" perm_choose %d sz=%d x=%d r=%d (%d) s=%d\n", bucket
->id
,
124 bucket
->size
, x
, r
, pr
, s
);
125 return bucket
->items
[s
];
129 static int bucket_uniform_choose(struct crush_bucket_uniform
*bucket
,
132 return bucket_perm_choose(&bucket
->h
, x
, r
);
136 static int bucket_list_choose(struct crush_bucket_list
*bucket
,
141 for (i
= bucket
->h
.size
-1; i
>= 0; i
--) {
142 __u64 w
= crush_hash32_4(bucket
->h
.hash
,x
, bucket
->h
.items
[i
],
145 dprintk("list_choose i=%d x=%d r=%d item %d weight %x "
147 i
, x
, r
, bucket
->h
.items
[i
], bucket
->item_weights
[i
],
148 bucket
->sum_weights
[i
], w
);
149 w
*= bucket
->sum_weights
[i
];
151 /*dprintk(" scaled %llx\n", w);*/
152 if (w
< bucket
->item_weights
[i
])
153 return bucket
->h
.items
[i
];
156 dprintk("bad list sums for bucket %d\n", bucket
->h
.id
);
157 return bucket
->h
.items
[0];
162 static int height(int n
)
165 while ((n
& 1) == 0) {
172 static int left(int x
)
175 return x
- (1 << (h
-1));
178 static int right(int x
)
181 return x
+ (1 << (h
-1));
184 static int terminal(int x
)
189 static int bucket_tree_choose(struct crush_bucket_tree
*bucket
,
197 n
= bucket
->num_nodes
>> 1;
199 while (!terminal(n
)) {
201 /* pick point in [0, w) */
202 w
= bucket
->node_weights
[n
];
203 t
= (__u64
)crush_hash32_4(bucket
->h
.hash
, x
, n
, r
,
204 bucket
->h
.id
) * (__u64
)w
;
207 /* descend to the left or right? */
209 if (t
< bucket
->node_weights
[l
])
215 return bucket
->h
.items
[n
>> 1];
221 static int bucket_straw_choose(struct crush_bucket_straw
*bucket
,
229 for (i
= 0; i
< bucket
->h
.size
; i
++) {
230 draw
= crush_hash32_3(bucket
->h
.hash
, x
, bucket
->h
.items
[i
], r
);
232 draw
*= bucket
->straws
[i
];
233 if (i
== 0 || draw
> high_draw
) {
238 return bucket
->h
.items
[high
];
241 static int crush_bucket_choose(struct crush_bucket
*in
, int x
, int r
)
243 dprintk(" crush_bucket_choose %d x=%d r=%d\n", in
->id
, x
, r
);
244 BUG_ON(in
->size
== 0);
246 case CRUSH_BUCKET_UNIFORM
:
247 return bucket_uniform_choose((struct crush_bucket_uniform
*)in
,
249 case CRUSH_BUCKET_LIST
:
250 return bucket_list_choose((struct crush_bucket_list
*)in
,
252 case CRUSH_BUCKET_TREE
:
253 return bucket_tree_choose((struct crush_bucket_tree
*)in
,
255 case CRUSH_BUCKET_STRAW
:
256 return bucket_straw_choose((struct crush_bucket_straw
*)in
,
259 dprintk("unknown bucket %d alg %d\n", in
->id
, in
->alg
);
265 * true if device is marked "out" (failed, fully offloaded)
268 static int is_out(const struct crush_map
*map
,
269 const __u32
*weight
, int weight_max
,
272 if (item
>= weight_max
)
274 if (weight
[item
] >= 0x10000)
276 if (weight
[item
] == 0)
278 if ((crush_hash32_2(CRUSH_HASH_RJENKINS1
, x
, item
) & 0xffff)
285 * crush_choose_firstn - choose numrep distinct items of given type
286 * @map: the crush_map
287 * @bucket: the bucket we are choose an item from
288 * @x: crush input value
289 * @numrep: the number of items to choose
290 * @type: the type of item to choose
291 * @out: pointer to output vector
292 * @outpos: our position in that vector
293 * @tries: number of attempts to make
294 * @recurse_tries: number of attempts to have recursive chooseleaf make
295 * @local_retries: localized retries
296 * @local_fallback_retries: localized fallback retries
297 * @recurse_to_leaf: true if we want one device under each item of given type (chooseleaf instead of choose)
298 * @vary_r: pass r to recursive calls
299 * @out2: second output vector for leaf items (if @recurse_to_leaf)
300 * @parent_r: r value passed from the parent
302 static int crush_choose_firstn(const struct crush_map
*map
,
303 struct crush_bucket
*bucket
,
304 const __u32
*weight
, int weight_max
,
305 int x
, int numrep
, int type
,
306 int *out
, int outpos
,
308 unsigned int recurse_tries
,
309 unsigned int local_retries
,
310 unsigned int local_fallback_retries
,
317 unsigned int ftotal
, flocal
;
318 int retry_descent
, retry_bucket
, skip_rep
;
319 struct crush_bucket
*in
= bucket
;
326 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\n",
327 recurse_to_leaf
? "_LEAF" : "",
328 bucket
->id
, x
, outpos
, numrep
,
329 tries
, recurse_tries
, local_retries
, local_fallback_retries
,
332 for (rep
= outpos
; rep
< numrep
; rep
++) {
333 /* keep trying until we get a non-out, non-colliding item */
338 in
= bucket
; /* initial bucket */
340 /* choose through intervening buckets */
346 /* r' = r + f_total */
354 if (local_fallback_retries
> 0 &&
355 flocal
>= (in
->size
>>1) &&
356 flocal
> local_fallback_retries
)
357 item
= bucket_perm_choose(in
, x
, r
);
359 item
= crush_bucket_choose(in
, x
, r
);
360 if (item
>= map
->max_devices
) {
361 dprintk(" bad item %d\n", item
);
368 itemtype
= map
->buckets
[-1-item
]->type
;
371 dprintk(" item %d type %d\n", item
, itemtype
);
374 if (itemtype
!= type
) {
376 (-1-item
) >= map
->max_buckets
) {
377 dprintk(" bad item type %d\n", type
);
381 in
= map
->buckets
[-1-item
];
387 for (i
= 0; i
< outpos
; i
++) {
388 if (out
[i
] == item
) {
395 if (!collide
&& recurse_to_leaf
) {
399 sub_r
= r
>> (vary_r
-1);
402 if (crush_choose_firstn(map
,
403 map
->buckets
[-1-item
],
409 local_fallback_retries
,
414 /* didn't get leaf */
417 /* we already have a leaf! */
425 reject
= is_out(map
, weight
,
433 if (reject
|| collide
) {
437 if (collide
&& flocal
<= local_retries
)
438 /* retry locally a few times */
440 else if (local_fallback_retries
> 0 &&
441 flocal
<= in
->size
+ local_fallback_retries
)
442 /* exhaustive bucket search */
444 else if (ftotal
< tries
)
445 /* then retry descent */
450 dprintk(" reject %d collide %d "
451 "ftotal %u flocal %u\n",
452 reject
, collide
, ftotal
,
455 } while (retry_bucket
);
456 } while (retry_descent
);
459 dprintk("skip rep\n");
463 dprintk("CHOOSE got %d\n", item
);
468 dprintk("CHOOSE returns %d\n", outpos
);
474 * crush_choose_indep: alternative breadth-first positionally stable mapping
477 static void crush_choose_indep(const struct crush_map
*map
,
478 struct crush_bucket
*bucket
,
479 const __u32
*weight
, int weight_max
,
480 int x
, int left
, int numrep
, int type
,
481 int *out
, int outpos
,
483 unsigned int recurse_tries
,
488 struct crush_bucket
*in
= bucket
;
489 int endpos
= outpos
+ left
;
498 dprintk("CHOOSE%s INDEP bucket %d x %d outpos %d numrep %d\n", recurse_to_leaf
? "_LEAF" : "",
499 bucket
->id
, x
, outpos
, numrep
);
501 /* initially my result is undefined */
502 for (rep
= outpos
; rep
< endpos
; rep
++) {
503 out
[rep
] = CRUSH_ITEM_UNDEF
;
505 out2
[rep
] = CRUSH_ITEM_UNDEF
;
508 for (ftotal
= 0; left
> 0 && ftotal
< tries
; ftotal
++) {
509 for (rep
= outpos
; rep
< endpos
; rep
++) {
510 if (out
[rep
] != CRUSH_ITEM_UNDEF
)
513 in
= bucket
; /* initial bucket */
515 /* choose through intervening buckets */
517 /* note: we base the choice on the position
518 * even in the nested call. that means that
519 * if the first layer chooses the same bucket
520 * in a different position, we will tend to
521 * choose a different item in that bucket.
522 * this will involve more devices in data
523 * movement and tend to distribute the load.
528 if (in
->alg
== CRUSH_BUCKET_UNIFORM
&&
529 in
->size
% numrep
== 0)
530 /* r'=r+(n+1)*f_total */
531 r
+= (numrep
+1) * ftotal
;
533 /* r' = r + n*f_total */
534 r
+= numrep
* ftotal
;
538 dprintk(" empty bucket\n");
542 item
= crush_bucket_choose(in
, x
, r
);
543 if (item
>= map
->max_devices
) {
544 dprintk(" bad item %d\n", item
);
545 out
[rep
] = CRUSH_ITEM_NONE
;
547 out2
[rep
] = CRUSH_ITEM_NONE
;
554 itemtype
= map
->buckets
[-1-item
]->type
;
557 dprintk(" item %d type %d\n", item
, itemtype
);
560 if (itemtype
!= type
) {
562 (-1-item
) >= map
->max_buckets
) {
563 dprintk(" bad item type %d\n", type
);
564 out
[rep
] = CRUSH_ITEM_NONE
;
571 in
= map
->buckets
[-1-item
];
577 for (i
= outpos
; i
< endpos
; i
++) {
578 if (out
[i
] == item
) {
586 if (recurse_to_leaf
) {
588 crush_choose_indep(map
,
589 map
->buckets
[-1-item
],
595 if (out2
[rep
] == CRUSH_ITEM_NONE
) {
596 /* placed nothing; no leaf */
600 /* we already have a leaf! */
607 is_out(map
, weight
, weight_max
, item
, x
))
617 for (rep
= outpos
; rep
< endpos
; rep
++) {
618 if (out
[rep
] == CRUSH_ITEM_UNDEF
) {
619 out
[rep
] = CRUSH_ITEM_NONE
;
621 if (out2
&& out2
[rep
] == CRUSH_ITEM_UNDEF
) {
622 out2
[rep
] = CRUSH_ITEM_NONE
;
628 * crush_do_rule - calculate a mapping with the given input and rule
629 * @map: the crush_map
630 * @ruleno: the rule id
632 * @result: pointer to result vector
633 * @result_max: maximum result size
634 * @weight: weight vector (for map leaves)
635 * @weight_max: size of weight vector
636 * @scratch: scratch vector for private use; must be >= 3 * result_max
638 int crush_do_rule(const struct crush_map
*map
,
639 int ruleno
, int x
, int *result
, int result_max
,
640 const __u32
*weight
, int weight_max
,
645 int *b
= scratch
+ result_max
;
646 int *c
= scratch
+ result_max
*2;
653 struct crush_rule
*rule
;
658 * the original choose_total_tries value was off by one (it
659 * counted "retries" and not "tries"). add one.
661 int choose_tries
= map
->choose_total_tries
+ 1;
662 int choose_leaf_tries
= 0;
664 * the local tries values were counted as "retries", though,
665 * and need no adjustment
667 int choose_local_retries
= map
->choose_local_tries
;
668 int choose_local_fallback_retries
= map
->choose_local_fallback_tries
;
670 int vary_r
= map
->chooseleaf_vary_r
;
672 if ((__u32
)ruleno
>= map
->max_rules
) {
673 dprintk(" bad ruleno %d\n", ruleno
);
677 rule
= map
->rules
[ruleno
];
682 for (step
= 0; step
< rule
->len
; step
++) {
684 struct crush_rule_step
*curstep
= &rule
->steps
[step
];
686 switch (curstep
->op
) {
687 case CRUSH_RULE_TAKE
:
688 w
[0] = curstep
->arg1
;
692 case CRUSH_RULE_SET_CHOOSE_TRIES
:
693 if (curstep
->arg1
> 0)
694 choose_tries
= curstep
->arg1
;
697 case CRUSH_RULE_SET_CHOOSELEAF_TRIES
:
698 if (curstep
->arg1
> 0)
699 choose_leaf_tries
= curstep
->arg1
;
702 case CRUSH_RULE_SET_CHOOSE_LOCAL_TRIES
:
703 if (curstep
->arg1
>= 0)
704 choose_local_retries
= curstep
->arg1
;
707 case CRUSH_RULE_SET_CHOOSE_LOCAL_FALLBACK_TRIES
:
708 if (curstep
->arg1
>= 0)
709 choose_local_fallback_retries
= curstep
->arg1
;
712 case CRUSH_RULE_SET_CHOOSELEAF_VARY_R
:
713 if (curstep
->arg1
>= 0)
714 vary_r
= curstep
->arg1
;
717 case CRUSH_RULE_CHOOSELEAF_FIRSTN
:
718 case CRUSH_RULE_CHOOSE_FIRSTN
:
721 case CRUSH_RULE_CHOOSELEAF_INDEP
:
722 case CRUSH_RULE_CHOOSE_INDEP
:
728 CRUSH_RULE_CHOOSELEAF_FIRSTN
||
730 CRUSH_RULE_CHOOSELEAF_INDEP
;
735 for (i
= 0; i
< wsize
; i
++) {
737 * see CRUSH_N, CRUSH_N_MINUS macros.
738 * basically, numrep <= 0 means relative to
739 * the provided result_max
741 numrep
= curstep
->arg1
;
743 numrep
+= result_max
;
750 if (choose_leaf_tries
)
753 else if (map
->chooseleaf_descend_once
)
756 recurse_tries
= choose_tries
;
757 osize
+= crush_choose_firstn(
759 map
->buckets
[-1-w
[i
]],
766 choose_local_retries
,
767 choose_local_fallback_retries
,
775 map
->buckets
[-1-w
[i
]],
782 choose_leaf_tries
: 1,
791 /* copy final _leaf_ values to output set */
792 memcpy(o
, c
, osize
*sizeof(*o
));
794 /* swap o and w arrays */
802 case CRUSH_RULE_EMIT
:
803 for (i
= 0; i
< wsize
&& result_len
< result_max
; i
++) {
804 result
[result_len
] = w
[i
];
811 dprintk(" unknown op %d at step %d\n",