crush: generalize descend_once
[platform/adaptation/renesas_rcar/renesas_kernel.git] / net / ceph / crush / mapper.c
1
2 #ifdef __KERNEL__
3 # include <linux/string.h>
4 # include <linux/slab.h>
5 # include <linux/bug.h>
6 # include <linux/kernel.h>
7 # ifndef dprintk
8 #  define dprintk(args...)
9 # endif
10 #else
11 # include <string.h>
12 # include <stdio.h>
13 # include <stdlib.h>
14 # include <assert.h>
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)
19 #endif
20
21 #include <linux/crush/crush.h>
22 #include <linux/crush/hash.h>
23 #include <linux/crush/mapper.h>
24
25 /*
26  * Implement the core CRUSH mapping algorithm.
27  */
28
29 /**
30  * crush_find_rule - find a crush_rule id for a given ruleset, type, and size.
31  * @map: the crush_map
32  * @ruleset: the storage ruleset id (user defined)
33  * @type: storage ruleset type (user defined)
34  * @size: output set size
35  */
36 int crush_find_rule(const struct crush_map *map, int ruleset, int type, int size)
37 {
38         __u32 i;
39
40         for (i = 0; i < map->max_rules; i++) {
41                 if (map->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)
46                         return i;
47         }
48         return -1;
49 }
50
51
52 /*
53  * bucket choose methods
54  *
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.
58  */
59
60 /*
61  * Choose based on a random permutation of the bucket.
62  *
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.
68  */
69 static int bucket_perm_choose(struct crush_bucket *bucket,
70                               int x, int r)
71 {
72         unsigned int pr = r % bucket->size;
73         unsigned int i, s;
74
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);
78                 bucket->perm_x = x;
79
80                 /* optimize common r=0 case */
81                 if (pr == 0) {
82                         s = crush_hash32_3(bucket->hash, x, bucket->id, 0) %
83                                 bucket->size;
84                         bucket->perm[0] = s;
85                         bucket->perm_n = 0xffff;   /* magic value, see below */
86                         goto out;
87                 }
88
89                 for (i = 0; i < bucket->size; i++)
90                         bucket->perm[i] = i;
91                 bucket->perm_n = 0;
92         } else if (bucket->perm_n == 0xffff) {
93                 /* clean up after the r=0 case above */
94                 for (i = 1; i < bucket->size; i++)
95                         bucket->perm[i] = i;
96                 bucket->perm[bucket->perm[0]] = 0;
97                 bucket->perm_n = 1;
98         }
99
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) %
108                                 (bucket->size - p);
109                         if (i) {
110                                 unsigned int t = bucket->perm[p + i];
111                                 bucket->perm[p + i] = bucket->perm[p];
112                                 bucket->perm[p] = t;
113                         }
114                         dprintk(" perm_choose swap %d with %d\n", p, p+i);
115                 }
116                 bucket->perm_n++;
117         }
118         for (i = 0; i < bucket->size; i++)
119                 dprintk(" perm_choose  %d: %d\n", i, bucket->perm[i]);
120
121         s = bucket->perm[pr];
122 out:
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];
126 }
127
128 /* uniform */
129 static int bucket_uniform_choose(struct crush_bucket_uniform *bucket,
130                                  int x, int r)
131 {
132         return bucket_perm_choose(&bucket->h, x, r);
133 }
134
135 /* list */
136 static int bucket_list_choose(struct crush_bucket_list *bucket,
137                               int x, int r)
138 {
139         int i;
140
141         for (i = bucket->h.size-1; i >= 0; i--) {
142                 __u64 w = crush_hash32_4(bucket->h.hash,x, bucket->h.items[i],
143                                          r, bucket->h.id);
144                 w &= 0xffff;
145                 dprintk("list_choose i=%d x=%d r=%d item %d weight %x "
146                         "sw %x rand %llx",
147                         i, x, r, bucket->h.items[i], bucket->item_weights[i],
148                         bucket->sum_weights[i], w);
149                 w *= bucket->sum_weights[i];
150                 w = w >> 16;
151                 /*dprintk(" scaled %llx\n", w);*/
152                 if (w < bucket->item_weights[i])
153                         return bucket->h.items[i];
154         }
155
156         dprintk("bad list sums for bucket %d\n", bucket->h.id);
157         return bucket->h.items[0];
158 }
159
160
161 /* (binary) tree */
162 static int height(int n)
163 {
164         int h = 0;
165         while ((n & 1) == 0) {
166                 h++;
167                 n = n >> 1;
168         }
169         return h;
170 }
171
172 static int left(int x)
173 {
174         int h = height(x);
175         return x - (1 << (h-1));
176 }
177
178 static int right(int x)
179 {
180         int h = height(x);
181         return x + (1 << (h-1));
182 }
183
184 static int terminal(int x)
185 {
186         return x & 1;
187 }
188
189 static int bucket_tree_choose(struct crush_bucket_tree *bucket,
190                               int x, int r)
191 {
192         int n;
193         __u32 w;
194         __u64 t;
195
196         /* start at root */
197         n = bucket->num_nodes >> 1;
198
199         while (!terminal(n)) {
200                 int l;
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;
205                 t = t >> 32;
206
207                 /* descend to the left or right? */
208                 l = left(n);
209                 if (t < bucket->node_weights[l])
210                         n = l;
211                 else
212                         n = right(n);
213         }
214
215         return bucket->h.items[n >> 1];
216 }
217
218
219 /* straw */
220
221 static int bucket_straw_choose(struct crush_bucket_straw *bucket,
222                                int x, int r)
223 {
224         __u32 i;
225         int high = 0;
226         __u64 high_draw = 0;
227         __u64 draw;
228
229         for (i = 0; i < bucket->h.size; i++) {
230                 draw = crush_hash32_3(bucket->h.hash, x, bucket->h.items[i], r);
231                 draw &= 0xffff;
232                 draw *= bucket->straws[i];
233                 if (i == 0 || draw > high_draw) {
234                         high = i;
235                         high_draw = draw;
236                 }
237         }
238         return bucket->h.items[high];
239 }
240
241 static int crush_bucket_choose(struct crush_bucket *in, int x, int r)
242 {
243         dprintk(" crush_bucket_choose %d x=%d r=%d\n", in->id, x, r);
244         BUG_ON(in->size == 0);
245         switch (in->alg) {
246         case CRUSH_BUCKET_UNIFORM:
247                 return bucket_uniform_choose((struct crush_bucket_uniform *)in,
248                                           x, r);
249         case CRUSH_BUCKET_LIST:
250                 return bucket_list_choose((struct crush_bucket_list *)in,
251                                           x, r);
252         case CRUSH_BUCKET_TREE:
253                 return bucket_tree_choose((struct crush_bucket_tree *)in,
254                                           x, r);
255         case CRUSH_BUCKET_STRAW:
256                 return bucket_straw_choose((struct crush_bucket_straw *)in,
257                                            x, r);
258         default:
259                 dprintk("unknown bucket %d alg %d\n", in->id, in->alg);
260                 return in->items[0];
261         }
262 }
263
264 /*
265  * true if device is marked "out" (failed, fully offloaded)
266  * of the cluster
267  */
268 static int is_out(const struct crush_map *map,
269                   const __u32 *weight, int weight_max,
270                   int item, int x)
271 {
272         if (item >= weight_max)
273                 return 1;
274         if (weight[item] >= 0x10000)
275                 return 0;
276         if (weight[item] == 0)
277                 return 1;
278         if ((crush_hash32_2(CRUSH_HASH_RJENKINS1, x, item) & 0xffff)
279             < weight[item])
280                 return 0;
281         return 1;
282 }
283
284 /**
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  * @recurse_to_leaf: true if we want one device under each item of given type
294  * @out2: second output vector for leaf items (if @recurse_to_leaf)
295  */
296 static int crush_choose_firstn(const struct crush_map *map,
297                                struct crush_bucket *bucket,
298                                const __u32 *weight, int weight_max,
299                                int x, int numrep, int type,
300                                int *out, int outpos,
301                                unsigned int attempts,
302                                unsigned int recurse_attempts,
303                                int recurse_to_leaf,
304                                int *out2)
305 {
306         int rep;
307         unsigned int ftotal, flocal;
308         int retry_descent, retry_bucket, skip_rep;
309         struct crush_bucket *in = bucket;
310         int r;
311         int i;
312         int item = 0;
313         int itemtype;
314         int collide, reject;
315
316         dprintk("CHOOSE%s bucket %d x %d outpos %d numrep %d\n", recurse_to_leaf ? "_LEAF" : "",
317                 bucket->id, x, outpos, numrep);
318
319         for (rep = outpos; rep < numrep; rep++) {
320                 /* keep trying until we get a non-out, non-colliding item */
321                 ftotal = 0;
322                 skip_rep = 0;
323                 do {
324                         retry_descent = 0;
325                         in = bucket;               /* initial bucket */
326
327                         /* choose through intervening buckets */
328                         flocal = 0;
329                         do {
330                                 collide = 0;
331                                 retry_bucket = 0;
332                                 r = rep;
333                                 /* r' = r + f_total */
334                                 r += ftotal;
335
336                                 /* bucket choose */
337                                 if (in->size == 0) {
338                                         reject = 1;
339                                         goto reject;
340                                 }
341                                 if (map->choose_local_fallback_tries > 0 &&
342                                     flocal >= (in->size>>1) &&
343                                     flocal > map->choose_local_fallback_tries)
344                                         item = bucket_perm_choose(in, x, r);
345                                 else
346                                         item = crush_bucket_choose(in, x, r);
347                                 if (item >= map->max_devices) {
348                                         dprintk("   bad item %d\n", item);
349                                         skip_rep = 1;
350                                         break;
351                                 }
352
353                                 /* desired type? */
354                                 if (item < 0)
355                                         itemtype = map->buckets[-1-item]->type;
356                                 else
357                                         itemtype = 0;
358                                 dprintk("  item %d type %d\n", item, itemtype);
359
360                                 /* keep going? */
361                                 if (itemtype != type) {
362                                         if (item >= 0 ||
363                                             (-1-item) >= map->max_buckets) {
364                                                 dprintk("   bad item type %d\n", type);
365                                                 skip_rep = 1;
366                                                 break;
367                                         }
368                                         in = map->buckets[-1-item];
369                                         retry_bucket = 1;
370                                         continue;
371                                 }
372
373                                 /* collision? */
374                                 for (i = 0; i < outpos; i++) {
375                                         if (out[i] == item) {
376                                                 collide = 1;
377                                                 break;
378                                         }
379                                 }
380
381                                 reject = 0;
382                                 if (!collide && recurse_to_leaf) {
383                                         if (item < 0) {
384                                                 if (crush_choose_firstn(map,
385                                                          map->buckets[-1-item],
386                                                          weight, weight_max,
387                                                          x, outpos+1, 0,
388                                                          out2, outpos,
389                                                          recurse_attempts, 0,
390                                                          0,
391                                                          NULL) <= outpos)
392                                                         /* didn't get leaf */
393                                                         reject = 1;
394                                         } else {
395                                                 /* we already have a leaf! */
396                                                 out2[outpos] = item;
397                                         }
398                                 }
399
400                                 if (!reject) {
401                                         /* out? */
402                                         if (itemtype == 0)
403                                                 reject = is_out(map, weight,
404                                                                 weight_max,
405                                                                 item, x);
406                                         else
407                                                 reject = 0;
408                                 }
409
410 reject:
411                                 if (reject || collide) {
412                                         ftotal++;
413                                         flocal++;
414
415                                         if (collide && flocal <= map->choose_local_tries)
416                                                 /* retry locally a few times */
417                                                 retry_bucket = 1;
418                                         else if (map->choose_local_fallback_tries > 0 &&
419                                                  flocal <= in->size + map->choose_local_fallback_tries)
420                                                 /* exhaustive bucket search */
421                                                 retry_bucket = 1;
422                                         else if (ftotal <= attempts)
423                                                 /* then retry descent */
424                                                 retry_descent = 1;
425                                         else
426                                                 /* else give up */
427                                                 skip_rep = 1;
428                                         dprintk("  reject %d  collide %d  "
429                                                 "ftotal %u  flocal %u\n",
430                                                 reject, collide, ftotal,
431                                                 flocal);
432                                 }
433                         } while (retry_bucket);
434                 } while (retry_descent);
435
436                 if (skip_rep) {
437                         dprintk("skip rep\n");
438                         continue;
439                 }
440
441                 dprintk("CHOOSE got %d\n", item);
442                 out[outpos] = item;
443                 outpos++;
444         }
445
446         dprintk("CHOOSE returns %d\n", outpos);
447         return outpos;
448 }
449
450
451 /**
452  * crush_choose_indep: alternative breadth-first positionally stable mapping
453  *
454  */
455 static void crush_choose_indep(const struct crush_map *map,
456                                struct crush_bucket *bucket,
457                                const __u32 *weight, int weight_max,
458                                int x, int left, int numrep, int type,
459                                int *out, int outpos,
460                                unsigned int attempts,
461                                unsigned int recurse_attempts,
462                                int recurse_to_leaf,
463                                int *out2,
464                                int parent_r)
465 {
466         struct crush_bucket *in = bucket;
467         int endpos = outpos + left;
468         int rep;
469         unsigned int ftotal;
470         int r;
471         int i;
472         int item = 0;
473         int itemtype;
474         int collide;
475
476         dprintk("CHOOSE%s INDEP bucket %d x %d outpos %d numrep %d\n", recurse_to_leaf ? "_LEAF" : "",
477                 bucket->id, x, outpos, numrep);
478
479         /* initially my result is undefined */
480         for (rep = outpos; rep < endpos; rep++) {
481                 out[rep] = CRUSH_ITEM_UNDEF;
482                 if (out2)
483                         out2[rep] = CRUSH_ITEM_UNDEF;
484         }
485
486         for (ftotal = 0; left > 0 && ftotal < attempts; ftotal++) {
487                 for (rep = outpos; rep < endpos; rep++) {
488                         if (out[rep] != CRUSH_ITEM_UNDEF)
489                                 continue;
490
491                         in = bucket;  /* initial bucket */
492
493                         /* choose through intervening buckets */
494                         for (;;) {
495                                 /* note: we base the choice on the position
496                                  * even in the nested call.  that means that
497                                  * if the first layer chooses the same bucket
498                                  * in a different position, we will tend to
499                                  * choose a different item in that bucket.
500                                  * this will involve more devices in data
501                                  * movement and tend to distribute the load.
502                                  */
503                                 r = rep + parent_r;
504
505                                 /* be careful */
506                                 if (in->alg == CRUSH_BUCKET_UNIFORM &&
507                                     in->size % numrep == 0)
508                                         /* r'=r+(n+1)*f_total */
509                                         r += (numrep+1) * ftotal;
510                                 else
511                                         /* r' = r + n*f_total */
512                                         r += numrep * ftotal;
513
514                                 /* bucket choose */
515                                 if (in->size == 0) {
516                                         dprintk("   empty bucket\n");
517                                         break;
518                                 }
519
520                                 item = crush_bucket_choose(in, x, r);
521                                 if (item >= map->max_devices) {
522                                         dprintk("   bad item %d\n", item);
523                                         out[rep] = CRUSH_ITEM_NONE;
524                                         if (out2)
525                                                 out2[rep] = CRUSH_ITEM_NONE;
526                                         left--;
527                                         break;
528                                 }
529
530                                 /* desired type? */
531                                 if (item < 0)
532                                         itemtype = map->buckets[-1-item]->type;
533                                 else
534                                         itemtype = 0;
535                                 dprintk("  item %d type %d\n", item, itemtype);
536
537                                 /* keep going? */
538                                 if (itemtype != type) {
539                                         if (item >= 0 ||
540                                             (-1-item) >= map->max_buckets) {
541                                                 dprintk("   bad item type %d\n", type);
542                                                 out[rep] = CRUSH_ITEM_NONE;
543                                                 if (out2)
544                                                         out2[rep] =
545                                                                 CRUSH_ITEM_NONE;
546                                                 left--;
547                                                 break;
548                                         }
549                                         in = map->buckets[-1-item];
550                                         continue;
551                                 }
552
553                                 /* collision? */
554                                 collide = 0;
555                                 for (i = outpos; i < endpos; i++) {
556                                         if (out[i] == item) {
557                                                 collide = 1;
558                                                 break;
559                                         }
560                                 }
561                                 if (collide)
562                                         break;
563
564                                 if (recurse_to_leaf) {
565                                         if (item < 0) {
566                                                 crush_choose_indep(map,
567                                                    map->buckets[-1-item],
568                                                    weight, weight_max,
569                                                    x, 1, numrep, 0,
570                                                    out2, rep,
571                                                    recurse_attempts, 0,
572                                                    0, NULL, r);
573                                                 if (out2[rep] == CRUSH_ITEM_NONE) {
574                                                         /* placed nothing; no leaf */
575                                                         break;
576                                                 }
577                                         } else {
578                                                 /* we already have a leaf! */
579                                                 out2[rep] = item;
580                                         }
581                                 }
582
583                                 /* out? */
584                                 if (itemtype == 0 &&
585                                     is_out(map, weight, weight_max, item, x))
586                                         break;
587
588                                 /* yay! */
589                                 out[rep] = item;
590                                 left--;
591                                 break;
592                         }
593                 }
594         }
595         for (rep = outpos; rep < endpos; rep++) {
596                 if (out[rep] == CRUSH_ITEM_UNDEF) {
597                         out[rep] = CRUSH_ITEM_NONE;
598                 }
599                 if (out2 && out2[rep] == CRUSH_ITEM_UNDEF) {
600                         out2[rep] = CRUSH_ITEM_NONE;
601                 }
602         }
603 }
604
605 /**
606  * crush_do_rule - calculate a mapping with the given input and rule
607  * @map: the crush_map
608  * @ruleno: the rule id
609  * @x: hash input
610  * @result: pointer to result vector
611  * @result_max: maximum result size
612  * @weight: weight vector (for map leaves)
613  * @weight_max: size of weight vector
614  * @scratch: scratch vector for private use; must be >= 3 * result_max
615  */
616 int crush_do_rule(const struct crush_map *map,
617                   int ruleno, int x, int *result, int result_max,
618                   const __u32 *weight, int weight_max,
619                   int *scratch)
620 {
621         int result_len;
622         int *a = scratch;
623         int *b = scratch + result_max;
624         int *c = scratch + result_max*2;
625         int recurse_to_leaf;
626         int *w;
627         int wsize = 0;
628         int *o;
629         int osize;
630         int *tmp;
631         struct crush_rule *rule;
632         __u32 step;
633         int i, j;
634         int numrep;
635         int choose_tries = map->choose_total_tries;
636         int choose_leaf_tries = 0;
637
638         if ((__u32)ruleno >= map->max_rules) {
639                 dprintk(" bad ruleno %d\n", ruleno);
640                 return 0;
641         }
642
643         rule = map->rules[ruleno];
644         result_len = 0;
645         w = a;
646         o = b;
647
648         for (step = 0; step < rule->len; step++) {
649                 int firstn = 0;
650                 struct crush_rule_step *curstep = &rule->steps[step];
651
652                 switch (curstep->op) {
653                 case CRUSH_RULE_TAKE:
654                         w[0] = curstep->arg1;
655                         wsize = 1;
656                         break;
657
658                 case CRUSH_RULE_SET_CHOOSE_TRIES:
659                         if (curstep->arg1 > 0)
660                                 choose_tries = curstep->arg1;
661                         break;
662
663                 case CRUSH_RULE_SET_CHOOSELEAF_TRIES:
664                         if (curstep->arg1 > 0)
665                                 choose_leaf_tries = curstep->arg1;
666                         break;
667
668                 case CRUSH_RULE_CHOOSELEAF_FIRSTN:
669                 case CRUSH_RULE_CHOOSE_FIRSTN:
670                         firstn = 1;
671                         /* fall through */
672                 case CRUSH_RULE_CHOOSELEAF_INDEP:
673                 case CRUSH_RULE_CHOOSE_INDEP:
674                         if (wsize == 0)
675                                 break;
676
677                         recurse_to_leaf =
678                                 curstep->op ==
679                                  CRUSH_RULE_CHOOSELEAF_FIRSTN ||
680                                 curstep->op ==
681                                 CRUSH_RULE_CHOOSELEAF_INDEP;
682
683                         /* reset output */
684                         osize = 0;
685
686                         for (i = 0; i < wsize; i++) {
687                                 /*
688                                  * see CRUSH_N, CRUSH_N_MINUS macros.
689                                  * basically, numrep <= 0 means relative to
690                                  * the provided result_max
691                                  */
692                                 numrep = curstep->arg1;
693                                 if (numrep <= 0) {
694                                         numrep += result_max;
695                                         if (numrep <= 0)
696                                                 continue;
697                                 }
698                                 j = 0;
699                                 if (firstn) {
700                                         int recurse_tries;
701                                         if (choose_leaf_tries)
702                                                 recurse_tries =
703                                                         choose_leaf_tries;
704                                         else if (map->chooseleaf_descend_once)
705                                                 recurse_tries = 1;
706                                         else
707                                                 recurse_tries = choose_tries;
708                                         osize += crush_choose_firstn(
709                                                 map,
710                                                 map->buckets[-1-w[i]],
711                                                 weight, weight_max,
712                                                 x, numrep,
713                                                 curstep->arg2,
714                                                 o+osize, j,
715                                                 choose_tries,
716                                                 recurse_tries,
717                                                 recurse_to_leaf,
718                                                 c+osize);
719                                 } else {
720                                         crush_choose_indep(
721                                                 map,
722                                                 map->buckets[-1-w[i]],
723                                                 weight, weight_max,
724                                                 x, numrep, numrep,
725                                                 curstep->arg2,
726                                                 o+osize, j,
727                                                 choose_tries,
728                                                 choose_leaf_tries ?
729                                                    choose_leaf_tries : 1,
730                                                 recurse_to_leaf,
731                                                 c+osize,
732                                                 0);
733                                         osize += numrep;
734                                 }
735                         }
736
737                         if (recurse_to_leaf)
738                                 /* copy final _leaf_ values to output set */
739                                 memcpy(o, c, osize*sizeof(*o));
740
741                         /* swap o and w arrays */
742                         tmp = o;
743                         o = w;
744                         w = tmp;
745                         wsize = osize;
746                         break;
747
748
749                 case CRUSH_RULE_EMIT:
750                         for (i = 0; i < wsize && result_len < result_max; i++) {
751                                 result[result_len] = w[i];
752                                 result_len++;
753                         }
754                         wsize = 0;
755                         break;
756
757                 default:
758                         dprintk(" unknown op %d at step %d\n",
759                                 curstep->op, step);
760                         break;
761                 }
762         }
763         return result_len;
764 }
765
766