kernel/trace/tracing_map.c

   1 /*
   2  * tracing_map - lock-free map for tracing
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * Copyright (C) 2015 Tom Zanussi <tom.zanussi@linux.intel.com>
  15  *
  16  * tracing_map implementation inspired by lock-free map algorithms
  17  * originated by Dr. Cliff Click:
  18  *
  19  * http://www.azulsystems.com/blog/cliff/2007-03-26-non-blocking-hashtable
  20  * http://www.azulsystems.com/events/javaone_2007/2007_LockFreeHash.pdf
  21  */
  22
  23 #include <linux/vmalloc.h>
  24 #include <linux/jhash.h>
  25 #include <linux/slab.h>
  26 #include <linux/sort.h>
  27
  28 #include "tracing_map.h"
  29 #include "trace.h"
  30
  31 /*
  32  * NOTE: For a detailed description of the data structures used by
  33  * these functions (such as tracing_map_elt) please see the overview
  34  * of tracing_map data structures at the beginning of tracing_map.h.
  35  */
  36
  37 /**
  38  * tracing_map_update_sum - Add a value to a tracing_map_elt's sum field
  39  * @elt: The tracing_map_elt
  40  * @i: The index of the given sum associated with the tracing_map_elt
  41  * @n: The value to add to the sum
  42  *
  43  * Add n to sum i associated with the specified tracing_map_elt
  44  * instance.  The index i is the index returned by the call to
  45  * tracing_map_add_sum_field() when the tracing map was set up.
  46  */
  47 void tracing_map_update_sum(struct tracing_map_elt *elt, unsigned int i, u64 n)
  48 {
  49         atomic64_add(n, &elt->fields[i].sum);
  50 }
  51
  52 /**
  53  * tracing_map_read_sum - Return the value of a tracing_map_elt's sum field
  54  * @elt: The tracing_map_elt
  55  * @i: The index of the given sum associated with the tracing_map_elt
  56  *
  57  * Retrieve the value of the sum i associated with the specified
  58  * tracing_map_elt instance.  The index i is the index returned by the
  59  * call to tracing_map_add_sum_field() when the tracing map was set
  60  * up.
  61  *
  62  * Return: The sum associated with field i for elt.
  63  */
  64 u64 tracing_map_read_sum(struct tracing_map_elt *elt, unsigned int i)
  65 {
  66         return (u64)atomic64_read(&elt->fields[i].sum);
  67 }
  68
  69 int tracing_map_cmp_string(void *val_a, void *val_b)
  70 {
  71         char *a = val_a;
  72         char *b = val_b;
  73
  74         return strcmp(a, b);
  75 }
  76
  77 int tracing_map_cmp_none(void *val_a, void *val_b)
  78 {
  79         return 0;
  80 }
  81
  82 static int tracing_map_cmp_atomic64(void *val_a, void *val_b)
  83 {
  84         u64 a = atomic64_read((atomic64_t *)val_a);
  85         u64 b = atomic64_read((atomic64_t *)val_b);
  86
  87         return (a > b) ? 1 : ((a < b) ? -1 : 0);
  88 }
  89
  90 #define DEFINE_TRACING_MAP_CMP_FN(type)                                 \
  91 static int tracing_map_cmp_##type(void *val_a, void *val_b)             \
  92 {                                                                       \
  93         type a = (type)(*(u64 *)val_a);                                 \
  94         type b = (type)(*(u64 *)val_b);                                 \
  95                                                                         \
  96         return (a > b) ? 1 : ((a < b) ? -1 : 0);                        \
  97 }
  98
  99 DEFINE_TRACING_MAP_CMP_FN(s64);
 100 DEFINE_TRACING_MAP_CMP_FN(u64);
 101 DEFINE_TRACING_MAP_CMP_FN(s32);
 102 DEFINE_TRACING_MAP_CMP_FN(u32);
 103 DEFINE_TRACING_MAP_CMP_FN(s16);
 104 DEFINE_TRACING_MAP_CMP_FN(u16);
 105 DEFINE_TRACING_MAP_CMP_FN(s8);
 106 DEFINE_TRACING_MAP_CMP_FN(u8);
 107
 108 tracing_map_cmp_fn_t tracing_map_cmp_num(int field_size,
 109                                          int field_is_signed)
 110 {
 111         tracing_map_cmp_fn_t fn = tracing_map_cmp_none;
 112
 113         switch (field_size) {
 114         case 8:
 115                 if (field_is_signed)
 116                         fn = tracing_map_cmp_s64;
 117                 else
 118                         fn = tracing_map_cmp_u64;
 119                 break;
 120         case 4:
 121                 if (field_is_signed)
 122                         fn = tracing_map_cmp_s32;
 123                 else
 124                         fn = tracing_map_cmp_u32;
 125                 break;
 126         case 2:
 127                 if (field_is_signed)
 128                         fn = tracing_map_cmp_s16;
 129                 else
 130                         fn = tracing_map_cmp_u16;
 131                 break;
 132         case 1:
 133                 if (field_is_signed)
 134                         fn = tracing_map_cmp_s8;
 135                 else
 136                         fn = tracing_map_cmp_u8;
 137                 break;
 138         }
 139
 140         return fn;
 141 }
 142
 143 static int tracing_map_add_field(struct tracing_map *map,
 144                                  tracing_map_cmp_fn_t cmp_fn)
 145 {
 146         int ret = -EINVAL;
 147
 148         if (map->n_fields < TRACING_MAP_FIELDS_MAX) {
 149                 ret = map->n_fields;
 150                 map->fields[map->n_fields++].cmp_fn = cmp_fn;
 151         }
 152
 153         return ret;
 154 }
 155
 156 /**
 157  * tracing_map_add_sum_field - Add a field describing a tracing_map sum
 158  * @map: The tracing_map
 159  *
 160  * Add a sum field to the key and return the index identifying it in
 161  * the map and associated tracing_map_elts.  This is the index used
 162  * for instance to update a sum for a particular tracing_map_elt using
 163  * tracing_map_update_sum() or reading it via tracing_map_read_sum().
 164  *
 165  * Return: The index identifying the field in the map and associated
 166  * tracing_map_elts, or -EINVAL on error.
 167  */
 168 int tracing_map_add_sum_field(struct tracing_map *map)
 169 {
 170         return tracing_map_add_field(map, tracing_map_cmp_atomic64);
 171 }
 172
 173 /**
 174  * tracing_map_add_key_field - Add a field describing a tracing_map key
 175  * @map: The tracing_map
 176  * @offset: The offset within the key
 177  * @cmp_fn: The comparison function that will be used to sort on the key
 178  *
 179  * Let the map know there is a key and that if it's used as a sort key
 180  * to use cmp_fn.
 181  *
 182  * A key can be a subset of a compound key; for that purpose, the
 183  * offset param is used to describe where within the the compound key
 184  * the key referenced by this key field resides.
 185  *
 186  * Return: The index identifying the field in the map and associated
 187  * tracing_map_elts, or -EINVAL on error.
 188  */
 189 int tracing_map_add_key_field(struct tracing_map *map,
 190                               unsigned int offset,
 191                               tracing_map_cmp_fn_t cmp_fn)
 192
 193 {
 194         int idx = tracing_map_add_field(map, cmp_fn);
 195
 196         if (idx < 0)
 197                 return idx;
 198
 199         map->fields[idx].offset = offset;
 200
 201         map->key_idx[map->n_keys++] = idx;
 202
 203         return idx;
 204 }
 205
 206 void tracing_map_array_clear(struct tracing_map_array *a)
 207 {
 208         unsigned int i;
 209
 210         if (!a->pages)
 211                 return;
 212
 213         for (i = 0; i < a->n_pages; i++)
 214                 memset(a->pages[i], 0, PAGE_SIZE);
 215 }
 216
 217 void tracing_map_array_free(struct tracing_map_array *a)
 218 {
 219         unsigned int i;
 220
 221         if (!a)
 222                 return;
 223
 224         if (!a->pages)
 225                 goto free;
 226
 227         for (i = 0; i < a->n_pages; i++) {
 228                 if (!a->pages[i])
 229                         break;
 230                 free_page((unsigned long)a->pages[i]);
 231         }
 232
 233         kfree(a->pages);
 234
 235  free:
 236         kfree(a);
 237 }
 238
 239 struct tracing_map_array *tracing_map_array_alloc(unsigned int n_elts,
 240                                                   unsigned int entry_size)
 241 {
 242         struct tracing_map_array *a;
 243         unsigned int i;
 244
 245         a = kzalloc(sizeof(*a), GFP_KERNEL);
 246         if (!a)
 247                 return NULL;
 248
 249         a->entry_size_shift = fls(roundup_pow_of_two(entry_size) - 1);
 250         a->entries_per_page = PAGE_SIZE / (1 << a->entry_size_shift);
 251         a->n_pages = n_elts / a->entries_per_page;
 252         if (!a->n_pages)
 253                 a->n_pages = 1;
 254         a->entry_shift = fls(a->entries_per_page) - 1;
 255         a->entry_mask = (1 << a->entry_shift) - 1;
 256
 257         a->pages = kcalloc(a->n_pages, sizeof(void *), GFP_KERNEL);
 258         if (!a->pages)
 259                 goto free;
 260
 261         for (i = 0; i < a->n_pages; i++) {
 262                 a->pages[i] = (void *)get_zeroed_page(GFP_KERNEL);
 263                 if (!a->pages[i])
 264                         goto free;
 265         }
 266  out:
 267         return a;
 268  free:
 269         tracing_map_array_free(a);
 270         a = NULL;
 271
 272         goto out;
 273 }
 274
 275 static void tracing_map_elt_clear(struct tracing_map_elt *elt)
 276 {
 277         unsigned i;
 278
 279         for (i = 0; i < elt->map->n_fields; i++)
 280                 if (elt->fields[i].cmp_fn == tracing_map_cmp_atomic64)
 281                         atomic64_set(&elt->fields[i].sum, 0);
 282
 283         if (elt->map->ops && elt->map->ops->elt_clear)
 284                 elt->map->ops->elt_clear(elt);
 285 }
 286
 287 static void tracing_map_elt_init_fields(struct tracing_map_elt *elt)
 288 {
 289         unsigned int i;
 290
 291         tracing_map_elt_clear(elt);
 292
 293         for (i = 0; i < elt->map->n_fields; i++) {
 294                 elt->fields[i].cmp_fn = elt->map->fields[i].cmp_fn;
 295
 296                 if (elt->fields[i].cmp_fn != tracing_map_cmp_atomic64)
 297                         elt->fields[i].offset = elt->map->fields[i].offset;
 298         }
 299 }
 300
 301 static void tracing_map_elt_free(struct tracing_map_elt *elt)
 302 {
 303         if (!elt)
 304                 return;
 305
 306         if (elt->map->ops && elt->map->ops->elt_free)
 307                 elt->map->ops->elt_free(elt);
 308         kfree(elt->fields);
 309         kfree(elt->key);
 310         kfree(elt);
 311 }
 312
 313 static struct tracing_map_elt *tracing_map_elt_alloc(struct tracing_map *map)
 314 {
 315         struct tracing_map_elt *elt;
 316         int err = 0;
 317
 318         elt = kzalloc(sizeof(*elt), GFP_KERNEL);
 319         if (!elt)
 320                 return ERR_PTR(-ENOMEM);
 321
 322         elt->map = map;
 323
 324         elt->key = kzalloc(map->key_size, GFP_KERNEL);
 325         if (!elt->key) {
 326                 err = -ENOMEM;
 327                 goto free;
 328         }
 329
 330         elt->fields = kcalloc(map->n_fields, sizeof(*elt->fields), GFP_KERNEL);
 331         if (!elt->fields) {
 332                 err = -ENOMEM;
 333                 goto free;
 334         }
 335
 336         tracing_map_elt_init_fields(elt);
 337
 338         if (map->ops && map->ops->elt_alloc) {
 339                 err = map->ops->elt_alloc(elt);
 340                 if (err)
 341                         goto free;
 342         }
 343         return elt;
 344  free:
 345         tracing_map_elt_free(elt);
 346
 347         return ERR_PTR(err);
 348 }
 349
 350 static struct tracing_map_elt *get_free_elt(struct tracing_map *map)
 351 {
 352         struct tracing_map_elt *elt = NULL;
 353         int idx;
 354
 355         idx = atomic_inc_return(&map->next_elt);
 356         if (idx < map->max_elts) {
 357                 elt = *(TRACING_MAP_ELT(map->elts, idx));
 358                 if (map->ops && map->ops->elt_init)
 359                         map->ops->elt_init(elt);
 360         }
 361
 362         return elt;
 363 }
 364
 365 static void tracing_map_free_elts(struct tracing_map *map)
 366 {
 367         unsigned int i;
 368
 369         if (!map->elts)
 370                 return;
 371
 372         for (i = 0; i < map->max_elts; i++) {
 373                 tracing_map_elt_free(*(TRACING_MAP_ELT(map->elts, i)));
 374                 *(TRACING_MAP_ELT(map->elts, i)) = NULL;
 375         }
 376
 377         tracing_map_array_free(map->elts);
 378         map->elts = NULL;
 379 }
 380
 381 static int tracing_map_alloc_elts(struct tracing_map *map)
 382 {
 383         unsigned int i;
 384
 385         map->elts = tracing_map_array_alloc(map->max_elts,
 386                                             sizeof(struct tracing_map_elt *));
 387         if (!map->elts)
 388                 return -ENOMEM;
 389
 390         for (i = 0; i < map->max_elts; i++) {
 391                 *(TRACING_MAP_ELT(map->elts, i)) = tracing_map_elt_alloc(map);
 392                 if (IS_ERR(*(TRACING_MAP_ELT(map->elts, i)))) {
 393                         *(TRACING_MAP_ELT(map->elts, i)) = NULL;
 394                         tracing_map_free_elts(map);
 395
 396                         return -ENOMEM;
 397                 }
 398         }
 399
 400         return 0;
 401 }
 402
 403 static inline bool keys_match(void *key, void *test_key, unsigned key_size)
 404 {
 405         bool match = true;
 406
 407         if (memcmp(key, test_key, key_size))
 408                 match = false;
 409
 410         return match;
 411 }
 412
 413 static inline struct tracing_map_elt *
 414 __tracing_map_insert(struct tracing_map *map, void *key, bool lookup_only)
 415 {
 416         u32 idx, key_hash, test_key;
 417         struct tracing_map_entry *entry;
 418
 419         key_hash = jhash(key, map->key_size, 0);
 420         if (key_hash == 0)
 421                 key_hash = 1;
 422         idx = key_hash >> (32 - (map->map_bits + 1));
 423
 424         while (1) {
 425                 idx &= (map->map_size - 1);
 426                 entry = TRACING_MAP_ENTRY(map->map, idx);
 427                 test_key = entry->key;
 428
 429                 if (test_key && test_key == key_hash && entry->val &&
 430                     keys_match(key, entry->val->key, map->key_size)) {
 431                         atomic64_inc(&map->hits);
 432                         return entry->val;
 433                 }
 434
 435                 if (!test_key) {
 436                         if (lookup_only)
 437                                 break;
 438
 439                         if (!cmpxchg(&entry->key, 0, key_hash)) {
 440                                 struct tracing_map_elt *elt;
 441
 442                                 elt = get_free_elt(map);
 443                                 if (!elt) {
 444                                         atomic64_inc(&map->drops);
 445                                         entry->key = 0;
 446                                         break;
 447                                 }
 448
 449                                 memcpy(elt->key, key, map->key_size);
 450                                 entry->val = elt;
 451                                 atomic64_inc(&map->hits);
 452
 453                                 return entry->val;
 454                         }
 455                 }
 456
 457                 idx++;
 458         }
 459
 460         return NULL;
 461 }
 462
 463 /**
 464  * tracing_map_insert - Insert key and/or retrieve val from a tracing_map
 465  * @map: The tracing_map to insert into
 466  * @key: The key to insert
 467  *
 468  * Inserts a key into a tracing_map and creates and returns a new
 469  * tracing_map_elt for it, or if the key has already been inserted by
 470  * a previous call, returns the tracing_map_elt already associated
 471  * with it.  When the map was created, the number of elements to be
 472  * allocated for the map was specified (internally maintained as
 473  * 'max_elts' in struct tracing_map), and that number of
 474  * tracing_map_elts was created by tracing_map_init().  This is the
 475  * pre-allocated pool of tracing_map_elts that tracing_map_insert()
 476  * will allocate from when adding new keys.  Once that pool is
 477  * exhausted, tracing_map_insert() is useless and will return NULL to
 478  * signal that state.  There are two user-visible tracing_map
 479  * variables, 'hits' and 'drops', which are updated by this function.
 480  * Every time an element is either successfully inserted or retrieved,
 481  * the 'hits' value is incrememented.  Every time an element insertion
 482  * fails, the 'drops' value is incremented.
 483  *
 484  * This is a lock-free tracing map insertion function implementing a
 485  * modified form of Cliff Click's basic insertion algorithm.  It
 486  * requires the table size be a power of two.  To prevent any
 487  * possibility of an infinite loop we always make the internal table
 488  * size double the size of the requested table size (max_elts * 2).
 489  * Likewise, we never reuse a slot or resize or delete elements - when
 490  * we've reached max_elts entries, we simply return NULL once we've
 491  * run out of entries.  Readers can at any point in time traverse the
 492  * tracing map and safely access the key/val pairs.
 493  *
 494  * Return: the tracing_map_elt pointer val associated with the key.
 495  * If this was a newly inserted key, the val will be a newly allocated
 496  * and associated tracing_map_elt pointer val.  If the key wasn't
 497  * found and the pool of tracing_map_elts has been exhausted, NULL is
 498  * returned and no further insertions will succeed.
 499  */
 500 struct tracing_map_elt *tracing_map_insert(struct tracing_map *map, void *key)
 501 {
 502         return __tracing_map_insert(map, key, false);
 503 }
 504
 505 /**
 506  * tracing_map_lookup - Retrieve val from a tracing_map
 507  * @map: The tracing_map to perform the lookup on
 508  * @key: The key to look up
 509  *
 510  * Looks up key in tracing_map and if found returns the matching
 511  * tracing_map_elt.  This is a lock-free lookup; see
 512  * tracing_map_insert() for details on tracing_map and how it works.
 513  * Every time an element is retrieved, the 'hits' value is
 514  * incrememented.  There is one user-visible tracing_map variable,
 515  * 'hits', which is updated by this function.  Every time an element
 516  * is successfully retrieved, the 'hits' value is incrememented.  The
 517  * 'drops' value is never updated by this function.
 518  *
 519  * Return: the tracing_map_elt pointer val associated with the key.
 520  * If the key wasn't found, NULL is returned.
 521  */
 522 struct tracing_map_elt *tracing_map_lookup(struct tracing_map *map, void *key)
 523 {
 524         return __tracing_map_insert(map, key, true);
 525 }
 526
 527 /**
 528  * tracing_map_destroy - Destroy a tracing_map
 529  * @map: The tracing_map to destroy
 530  *
 531  * Frees a tracing_map along with its associated array of
 532  * tracing_map_elts.
 533  *
 534  * Callers should make sure there are no readers or writers actively
 535  * reading or inserting into the map before calling this.
 536  */
 537 void tracing_map_destroy(struct tracing_map *map)
 538 {
 539         if (!map)
 540                 return;
 541
 542         tracing_map_free_elts(map);
 543
 544         tracing_map_array_free(map->map);
 545         kfree(map);
 546 }
 547
 548 /**
 549  * tracing_map_clear - Clear a tracing_map
 550  * @map: The tracing_map to clear
 551  *
 552  * Resets the tracing map to a cleared or initial state.  The
 553  * tracing_map_elts are all cleared, and the array of struct
 554  * tracing_map_entry is reset to an initialized state.
 555  *
 556  * Callers should make sure there are no writers actively inserting
 557  * into the map before calling this.
 558  */
 559 void tracing_map_clear(struct tracing_map *map)
 560 {
 561         unsigned int i;
 562
 563         atomic_set(&map->next_elt, -1);
 564         atomic64_set(&map->hits, 0);
 565         atomic64_set(&map->drops, 0);
 566
 567         tracing_map_array_clear(map->map);
 568
 569         for (i = 0; i < map->max_elts; i++)
 570                 tracing_map_elt_clear(*(TRACING_MAP_ELT(map->elts, i)));
 571 }
 572
 573 static void set_sort_key(struct tracing_map *map,
 574                          struct tracing_map_sort_key *sort_key)
 575 {
 576         map->sort_key = *sort_key;
 577 }
 578
 579 /**
 580  * tracing_map_create - Create a lock-free map and element pool
 581  * @map_bits: The size of the map (2 ** map_bits)
 582  * @key_size: The size of the key for the map in bytes
 583  * @ops: Optional client-defined tracing_map_ops instance
 584  * @private_data: Client data associated with the map
 585  *
 586  * Creates and sets up a map to contain 2 ** map_bits number of
 587  * elements (internally maintained as 'max_elts' in struct
 588  * tracing_map).  Before using, map fields should be added to the map
 589  * with tracing_map_add_sum_field() and tracing_map_add_key_field().
 590  * tracing_map_init() should then be called to allocate the array of
 591  * tracing_map_elts, in order to avoid allocating anything in the map
 592  * insertion path.  The user-specified map size reflects the maximum
 593  * number of elements that can be contained in the table requested by
 594  * the user - internally we double that in order to keep the table
 595  * sparse and keep collisions manageable.
 596  *
 597  * A tracing_map is a special-purpose map designed to aggregate or
 598  * 'sum' one or more values associated with a specific object of type
 599  * tracing_map_elt, which is attached by the map to a given key.
 600  *
 601  * tracing_map_create() sets up the map itself, and provides
 602  * operations for inserting tracing_map_elts, but doesn't allocate the
 603  * tracing_map_elts themselves, or provide a means for describing the
 604  * keys or sums associated with the tracing_map_elts.  All
 605  * tracing_map_elts for a given map have the same set of sums and
 606  * keys, which are defined by the client using the functions
 607  * tracing_map_add_key_field() and tracing_map_add_sum_field().  Once
 608  * the fields are defined, the pool of elements allocated for the map
 609  * can be created, which occurs when the client code calls
 610  * tracing_map_init().
 611  *
 612  * When tracing_map_init() returns, tracing_map_elt elements can be
 613  * inserted into the map using tracing_map_insert().  When called,
 614  * tracing_map_insert() grabs a free tracing_map_elt from the pool, or
 615  * finds an existing match in the map and in either case returns it.
 616  * The client can then use tracing_map_update_sum() and
 617  * tracing_map_read_sum() to update or read a given sum field for the
 618  * tracing_map_elt.
 619  *
 620  * The client can at any point retrieve and traverse the current set
 621  * of inserted tracing_map_elts in a tracing_map, via
 622  * tracing_map_sort_entries().  Sorting can be done on any field,
 623  * including keys.
 624  *
 625  * See tracing_map.h for a description of tracing_map_ops.
 626  *
 627  * Return: the tracing_map pointer if successful, ERR_PTR if not.
 628  */
 629 struct tracing_map *tracing_map_create(unsigned int map_bits,
 630                                        unsigned int key_size,
 631                                        const struct tracing_map_ops *ops,
 632                                        void *private_data)
 633 {
 634         struct tracing_map *map;
 635         unsigned int i;
 636
 637         if (map_bits < TRACING_MAP_BITS_MIN ||
 638             map_bits > TRACING_MAP_BITS_MAX)
 639                 return ERR_PTR(-EINVAL);
 640
 641         map = kzalloc(sizeof(*map), GFP_KERNEL);
 642         if (!map)
 643                 return ERR_PTR(-ENOMEM);
 644
 645         map->map_bits = map_bits;
 646         map->max_elts = (1 << map_bits);
 647         atomic_set(&map->next_elt, -1);
 648
 649         map->map_size = (1 << (map_bits + 1));
 650         map->ops = ops;
 651
 652         map->private_data = private_data;
 653
 654         map->map = tracing_map_array_alloc(map->map_size,
 655                                            sizeof(struct tracing_map_entry));
 656         if (!map->map)
 657                 goto free;
 658
 659         map->key_size = key_size;
 660         for (i = 0; i < TRACING_MAP_KEYS_MAX; i++)
 661                 map->key_idx[i] = -1;
 662  out:
 663         return map;
 664  free:
 665         tracing_map_destroy(map);
 666         map = ERR_PTR(-ENOMEM);
 667
 668         goto out;
 669 }
 670
 671 /**
 672  * tracing_map_init - Allocate and clear a map's tracing_map_elts
 673  * @map: The tracing_map to initialize
 674  *
 675  * Allocates a clears a pool of tracing_map_elts equal to the
 676  * user-specified size of 2 ** map_bits (internally maintained as
 677  * 'max_elts' in struct tracing_map).  Before using, the map fields
 678  * should be added to the map with tracing_map_add_sum_field() and
 679  * tracing_map_add_key_field().  tracing_map_init() should then be
 680  * called to allocate the array of tracing_map_elts, in order to avoid
 681  * allocating anything in the map insertion path.  The user-specified
 682  * map size reflects the max number of elements requested by the user
 683  * - internally we double that in order to keep the table sparse and
 684  * keep collisions manageable.
 685  *
 686  * See tracing_map.h for a description of tracing_map_ops.
 687  *
 688  * Return: the tracing_map pointer if successful, ERR_PTR if not.
 689  */
 690 int tracing_map_init(struct tracing_map *map)
 691 {
 692         int err;
 693
 694         if (map->n_fields < 2)
 695                 return -EINVAL; /* need at least 1 key and 1 val */
 696
 697         err = tracing_map_alloc_elts(map);
 698         if (err)
 699                 return err;
 700
 701         tracing_map_clear(map);
 702
 703         return err;
 704 }
 705
 706 static int cmp_entries_dup(const void *A, const void *B)
 707 {
 708         const struct tracing_map_sort_entry *a, *b;
 709         int ret = 0;
 710
 711         a = *(const struct tracing_map_sort_entry **)A;
 712         b = *(const struct tracing_map_sort_entry **)B;
 713
 714         if (memcmp(a->key, b->key, a->elt->map->key_size))
 715                 ret = 1;
 716
 717         return ret;
 718 }
 719
 720 static int cmp_entries_sum(const void *A, const void *B)
 721 {
 722         const struct tracing_map_elt *elt_a, *elt_b;
 723         const struct tracing_map_sort_entry *a, *b;
 724         struct tracing_map_sort_key *sort_key;
 725         struct tracing_map_field *field;
 726         tracing_map_cmp_fn_t cmp_fn;
 727         void *val_a, *val_b;
 728         int ret = 0;
 729
 730         a = *(const struct tracing_map_sort_entry **)A;
 731         b = *(const struct tracing_map_sort_entry **)B;
 732
 733         elt_a = a->elt;
 734         elt_b = b->elt;
 735
 736         sort_key = &elt_a->map->sort_key;
 737
 738         field = &elt_a->fields[sort_key->field_idx];
 739         cmp_fn = field->cmp_fn;
 740
 741         val_a = &elt_a->fields[sort_key->field_idx].sum;
 742         val_b = &elt_b->fields[sort_key->field_idx].sum;
 743
 744         ret = cmp_fn(val_a, val_b);
 745         if (sort_key->descending)
 746                 ret = -ret;
 747
 748         return ret;
 749 }
 750
 751 static int cmp_entries_key(const void *A, const void *B)
 752 {
 753         const struct tracing_map_elt *elt_a, *elt_b;
 754         const struct tracing_map_sort_entry *a, *b;
 755         struct tracing_map_sort_key *sort_key;
 756         struct tracing_map_field *field;
 757         tracing_map_cmp_fn_t cmp_fn;
 758         void *val_a, *val_b;
 759         int ret = 0;
 760
 761         a = *(const struct tracing_map_sort_entry **)A;
 762         b = *(const struct tracing_map_sort_entry **)B;
 763
 764         elt_a = a->elt;
 765         elt_b = b->elt;
 766
 767         sort_key = &elt_a->map->sort_key;
 768
 769         field = &elt_a->fields[sort_key->field_idx];
 770
 771         cmp_fn = field->cmp_fn;
 772
 773         val_a = elt_a->key + field->offset;
 774         val_b = elt_b->key + field->offset;
 775
 776         ret = cmp_fn(val_a, val_b);
 777         if (sort_key->descending)
 778                 ret = -ret;
 779
 780         return ret;
 781 }
 782
 783 static void destroy_sort_entry(struct tracing_map_sort_entry *entry)
 784 {
 785         if (!entry)
 786                 return;
 787
 788         if (entry->elt_copied)
 789                 tracing_map_elt_free(entry->elt);
 790
 791         kfree(entry);
 792 }
 793
 794 /**
 795  * tracing_map_destroy_sort_entries - Destroy an array of sort entries
 796  * @entries: The entries to destroy
 797  * @n_entries: The number of entries in the array
 798  *
 799  * Destroy the elements returned by a tracing_map_sort_entries() call.
 800  */
 801 void tracing_map_destroy_sort_entries(struct tracing_map_sort_entry **entries,
 802                                       unsigned int n_entries)
 803 {
 804         unsigned int i;
 805
 806         for (i = 0; i < n_entries; i++)
 807                 destroy_sort_entry(entries[i]);
 808
 809         vfree(entries);
 810 }
 811
 812 static struct tracing_map_sort_entry *
 813 create_sort_entry(void *key, struct tracing_map_elt *elt)
 814 {
 815         struct tracing_map_sort_entry *sort_entry;
 816
 817         sort_entry = kzalloc(sizeof(*sort_entry), GFP_KERNEL);
 818         if (!sort_entry)
 819                 return NULL;
 820
 821         sort_entry->key = key;
 822         sort_entry->elt = elt;
 823
 824         return sort_entry;
 825 }
 826
 827 static struct tracing_map_elt *copy_elt(struct tracing_map_elt *elt)
 828 {
 829         struct tracing_map_elt *dup_elt;
 830         unsigned int i;
 831
 832         dup_elt = tracing_map_elt_alloc(elt->map);
 833         if (IS_ERR(dup_elt))
 834                 return NULL;
 835
 836         if (elt->map->ops && elt->map->ops->elt_copy)
 837                 elt->map->ops->elt_copy(dup_elt, elt);
 838
 839         dup_elt->private_data = elt->private_data;
 840         memcpy(dup_elt->key, elt->key, elt->map->key_size);
 841
 842         for (i = 0; i < elt->map->n_fields; i++) {
 843                 atomic64_set(&dup_elt->fields[i].sum,
 844                              atomic64_read(&elt->fields[i].sum));
 845                 dup_elt->fields[i].cmp_fn = elt->fields[i].cmp_fn;
 846         }
 847
 848         return dup_elt;
 849 }
 850
 851 static int merge_dup(struct tracing_map_sort_entry **sort_entries,
 852                      unsigned int target, unsigned int dup)
 853 {
 854         struct tracing_map_elt *target_elt, *elt;
 855         bool first_dup = (target - dup) == 1;
 856         int i;
 857
 858         if (first_dup) {
 859                 elt = sort_entries[target]->elt;
 860                 target_elt = copy_elt(elt);
 861                 if (!target_elt)
 862                         return -ENOMEM;
 863                 sort_entries[target]->elt = target_elt;
 864                 sort_entries[target]->elt_copied = true;
 865         } else
 866                 target_elt = sort_entries[target]->elt;
 867
 868         elt = sort_entries[dup]->elt;
 869
 870         for (i = 0; i < elt->map->n_fields; i++)
 871                 atomic64_add(atomic64_read(&elt->fields[i].sum),
 872                              &target_elt->fields[i].sum);
 873
 874         sort_entries[dup]->dup = true;
 875
 876         return 0;
 877 }
 878
 879 static int merge_dups(struct tracing_map_sort_entry **sort_entries,
 880                       int n_entries, unsigned int key_size)
 881 {
 882         unsigned int dups = 0, total_dups = 0;
 883         int err, i, j;
 884         void *key;
 885
 886         if (n_entries < 2)
 887                 return total_dups;
 888
 889         sort(sort_entries, n_entries, sizeof(struct tracing_map_sort_entry *),
 890              (int (*)(const void *, const void *))cmp_entries_dup, NULL);
 891
 892         key = sort_entries[0]->key;
 893         for (i = 1; i < n_entries; i++) {
 894                 if (!memcmp(sort_entries[i]->key, key, key_size)) {
 895                         dups++; total_dups++;
 896                         err = merge_dup(sort_entries, i - dups, i);
 897                         if (err)
 898                                 return err;
 899                         continue;
 900                 }
 901                 key = sort_entries[i]->key;
 902                 dups = 0;
 903         }
 904
 905         if (!total_dups)
 906                 return total_dups;
 907
 908         for (i = 0, j = 0; i < n_entries; i++) {
 909                 if (!sort_entries[i]->dup) {
 910                         sort_entries[j] = sort_entries[i];
 911                         if (j++ != i)
 912                                 sort_entries[i] = NULL;
 913                 } else {
 914                         destroy_sort_entry(sort_entries[i]);
 915                         sort_entries[i] = NULL;
 916                 }
 917         }
 918
 919         return total_dups;
 920 }
 921
 922 static bool is_key(struct tracing_map *map, unsigned int field_idx)
 923 {
 924         unsigned int i;
 925
 926         for (i = 0; i < map->n_keys; i++)
 927                 if (map->key_idx[i] == field_idx)
 928                         return true;
 929         return false;
 930 }
 931
 932 static void sort_secondary(struct tracing_map *map,
 933                            const struct tracing_map_sort_entry **entries,
 934                            unsigned int n_entries,
 935                            struct tracing_map_sort_key *primary_key,
 936                            struct tracing_map_sort_key *secondary_key)
 937 {
 938         int (*primary_fn)(const void *, const void *);
 939         int (*secondary_fn)(const void *, const void *);
 940         unsigned i, start = 0, n_sub = 1;
 941
 942         if (is_key(map, primary_key->field_idx))
 943                 primary_fn = cmp_entries_key;
 944         else
 945                 primary_fn = cmp_entries_sum;
 946
 947         if (is_key(map, secondary_key->field_idx))
 948                 secondary_fn = cmp_entries_key;
 949         else
 950                 secondary_fn = cmp_entries_sum;
 951
 952         for (i = 0; i < n_entries - 1; i++) {
 953                 const struct tracing_map_sort_entry **a = &entries[i];
 954                 const struct tracing_map_sort_entry **b = &entries[i + 1];
 955
 956                 if (primary_fn(a, b) == 0) {
 957                         n_sub++;
 958                         if (i < n_entries - 2)
 959                                 continue;
 960                 }
 961
 962                 if (n_sub < 2) {
 963                         start = i + 1;
 964                         n_sub = 1;
 965                         continue;
 966                 }
 967
 968                 set_sort_key(map, secondary_key);
 969                 sort(&entries[start], n_sub,
 970                      sizeof(struct tracing_map_sort_entry *),
 971                      (int (*)(const void *, const void *))secondary_fn, NULL);
 972                 set_sort_key(map, primary_key);
 973
 974                 start = i + 1;
 975                 n_sub = 1;
 976         }
 977 }
 978
 979 /**
 980  * tracing_map_sort_entries - Sort the current set of tracing_map_elts in a map
 981  * @map: The tracing_map
 982  * @sort_key: The sort key to use for sorting
 983  * @sort_entries: outval: pointer to allocated and sorted array of entries
 984  *
 985  * tracing_map_sort_entries() sorts the current set of entries in the
 986  * map and returns the list of tracing_map_sort_entries containing
 987  * them to the client in the sort_entries param.  The client can
 988  * access the struct tracing_map_elt element of interest directly as
 989  * the 'elt' field of a returned struct tracing_map_sort_entry object.
 990  *
 991  * The sort_key has only two fields: idx and descending.  'idx' refers
 992  * to the index of the field added via tracing_map_add_sum_field() or
 993  * tracing_map_add_key_field() when the tracing_map was initialized.
 994  * 'descending' is a flag that if set reverses the sort order, which
 995  * by default is ascending.
 996  *
 997  * The client should not hold on to the returned array but should use
 998  * it and call tracing_map_destroy_sort_entries() when done.
 999  *
1000  * Return: the number of sort_entries in the struct tracing_map_sort_entry
1001  * array, negative on error
1002  */
1003 int tracing_map_sort_entries(struct tracing_map *map,
1004                              struct tracing_map_sort_key *sort_keys,
1005                              unsigned int n_sort_keys,
1006                              struct tracing_map_sort_entry ***sort_entries)
1007 {
1008         int (*cmp_entries_fn)(const void *, const void *);
1009         struct tracing_map_sort_entry *sort_entry, **entries;
1010         int i, n_entries, ret;
1011
1012         entries = vmalloc(map->max_elts * sizeof(sort_entry));
1013         if (!entries)
1014                 return -ENOMEM;
1015
1016         for (i = 0, n_entries = 0; i < map->map_size; i++) {
1017                 struct tracing_map_entry *entry;
1018
1019                 entry = TRACING_MAP_ENTRY(map->map, i);
1020
1021                 if (!entry->key || !entry->val)
1022                         continue;
1023
1024                 entries[n_entries] = create_sort_entry(entry->val->key,
1025                                                        entry->val);
1026                 if (!entries[n_entries++]) {
1027                         ret = -ENOMEM;
1028                         goto free;
1029                 }
1030         }
1031
1032         if (n_entries == 0) {
1033                 ret = 0;
1034                 goto free;
1035         }
1036
1037         if (n_entries == 1) {
1038                 *sort_entries = entries;
1039                 return 1;
1040         }
1041
1042         ret = merge_dups(entries, n_entries, map->key_size);
1043         if (ret < 0)
1044                 goto free;
1045         n_entries -= ret;
1046
1047         if (is_key(map, sort_keys[0].field_idx))
1048                 cmp_entries_fn = cmp_entries_key;
1049         else
1050                 cmp_entries_fn = cmp_entries_sum;
1051
1052         set_sort_key(map, &sort_keys[0]);
1053
1054         sort(entries, n_entries, sizeof(struct tracing_map_sort_entry *),
1055              (int (*)(const void *, const void *))cmp_entries_fn, NULL);
1056
1057         if (n_sort_keys > 1)
1058                 sort_secondary(map,
1059                                (const struct tracing_map_sort_entry **)entries,
1060                                n_entries,
1061                                &sort_keys[0],
1062                                &sort_keys[1]);
1063
1064         *sort_entries = entries;
1065
1066         return n_entries;
1067  free:
1068         tracing_map_destroy_sort_entries(entries, n_entries);
1069
1070         return ret;
1071 }