sys/contrib/zstd/lib/dictBuilder/cover.c

   1 /*
   2  * Copyright (c) 2016-present, Yann Collet, Facebook, Inc.
   3  * All rights reserved.
   4  *
   5  * This source code is licensed under both the BSD-style license (found in the
   6  * LICENSE file in the root directory of this source tree) and the GPLv2 (found
   7  * in the COPYING file in the root directory of this source tree).
   8  * You may select, at your option, one of the above-listed licenses.
   9  */
  10
  11 /* *****************************************************************************
  12  * Constructs a dictionary using a heuristic based on the following paper:
  13  *
  14  * Liao, Petri, Moffat, Wirth
  15  * Effective Construction of Relative Lempel-Ziv Dictionaries
  16  * Published in WWW 2016.
  17  *
  18  * Adapted from code originally written by @ot (Giuseppe Ottaviano).
  19  ******************************************************************************/
  20
  21 /*-*************************************
  22 *  Dependencies
  23 ***************************************/
  24 #include <stdio.h>  /* fprintf */
  25 #include <stdlib.h> /* malloc, free, qsort */
  26 #include <string.h> /* memset */
  27 #include <time.h>   /* clock */
  28
  29 #include "mem.h" /* read */
  30 #include "pool.h"
  31 #include "threading.h"
  32 #include "cover.h"
  33 #include "zstd_internal.h" /* includes zstd.h */
  34 #ifndef ZDICT_STATIC_LINKING_ONLY
  35 #define ZDICT_STATIC_LINKING_ONLY
  36 #endif
  37 #include "zdict.h"
  38
  39 /*-*************************************
  40 *  Constants
  41 ***************************************/
  42 #define COVER_MAX_SAMPLES_SIZE (sizeof(size_t) == 8 ? ((unsigned)-1) : ((unsigned)1 GB))
  43 #define DEFAULT_SPLITPOINT 1.0
  44
  45 /*-*************************************
  46 *  Console display
  47 ***************************************/
  48 static int g_displayLevel = 2;
  49 #define DISPLAY(...)                                                           \
  50   {                                                                            \
  51     fprintf(stderr, __VA_ARGS__);                                              \
  52     fflush(stderr);                                                            \
  53   }
  54 #define LOCALDISPLAYLEVEL(displayLevel, l, ...)                                \
  55   if (displayLevel >= l) {                                                     \
  56     DISPLAY(__VA_ARGS__);                                                      \
  57   } /* 0 : no display;   1: errors;   2: default;  3: details;  4: debug */
  58 #define DISPLAYLEVEL(l, ...) LOCALDISPLAYLEVEL(g_displayLevel, l, __VA_ARGS__)
  59
  60 #define LOCALDISPLAYUPDATE(displayLevel, l, ...)                               \
  61   if (displayLevel >= l) {                                                     \
  62     if ((clock() - g_time > refreshRate) || (displayLevel >= 4)) {             \
  63       g_time = clock();                                                        \
  64       DISPLAY(__VA_ARGS__);                                                    \
  65     }                                                                          \
  66   }
  67 #define DISPLAYUPDATE(l, ...) LOCALDISPLAYUPDATE(g_displayLevel, l, __VA_ARGS__)
  68 static const clock_t refreshRate = CLOCKS_PER_SEC * 15 / 100;
  69 static clock_t g_time = 0;
  70
  71 /*-*************************************
  72 * Hash table
  73 ***************************************
  74 * A small specialized hash map for storing activeDmers.
  75 * The map does not resize, so if it becomes full it will loop forever.
  76 * Thus, the map must be large enough to store every value.
  77 * The map implements linear probing and keeps its load less than 0.5.
  78 */
  79
  80 #define MAP_EMPTY_VALUE ((U32)-1)
  81 typedef struct COVER_map_pair_t_s {
  82   U32 key;
  83   U32 value;
  84 } COVER_map_pair_t;
  85
  86 typedef struct COVER_map_s {
  87   COVER_map_pair_t *data;
  88   U32 sizeLog;
  89   U32 size;
  90   U32 sizeMask;
  91 } COVER_map_t;
  92
  93 /**
  94  * Clear the map.
  95  */
  96 static void COVER_map_clear(COVER_map_t *map) {
  97   memset(map->data, MAP_EMPTY_VALUE, map->size * sizeof(COVER_map_pair_t));
  98 }
  99
 100 /**
 101  * Initializes a map of the given size.
 102  * Returns 1 on success and 0 on failure.
 103  * The map must be destroyed with COVER_map_destroy().
 104  * The map is only guaranteed to be large enough to hold size elements.
 105  */
 106 static int COVER_map_init(COVER_map_t *map, U32 size) {
 107   map->sizeLog = ZSTD_highbit32(size) + 2;
 108   map->size = (U32)1 << map->sizeLog;
 109   map->sizeMask = map->size - 1;
 110   map->data = (COVER_map_pair_t *)malloc(map->size * sizeof(COVER_map_pair_t));
 111   if (!map->data) {
 112     map->sizeLog = 0;
 113     map->size = 0;
 114     return 0;
 115   }
 116   COVER_map_clear(map);
 117   return 1;
 118 }
 119
 120 /**
 121  * Internal hash function
 122  */
 123 static const U32 prime4bytes = 2654435761U;
 124 static U32 COVER_map_hash(COVER_map_t *map, U32 key) {
 125   return (key * prime4bytes) >> (32 - map->sizeLog);
 126 }
 127
 128 /**
 129  * Helper function that returns the index that a key should be placed into.
 130  */
 131 static U32 COVER_map_index(COVER_map_t *map, U32 key) {
 132   const U32 hash = COVER_map_hash(map, key);
 133   U32 i;
 134   for (i = hash;; i = (i + 1) & map->sizeMask) {
 135     COVER_map_pair_t *pos = &map->data[i];
 136     if (pos->value == MAP_EMPTY_VALUE) {
 137       return i;
 138     }
 139     if (pos->key == key) {
 140       return i;
 141     }
 142   }
 143 }
 144
 145 /**
 146  * Returns the pointer to the value for key.
 147  * If key is not in the map, it is inserted and the value is set to 0.
 148  * The map must not be full.
 149  */
 150 static U32 *COVER_map_at(COVER_map_t *map, U32 key) {
 151   COVER_map_pair_t *pos = &map->data[COVER_map_index(map, key)];
 152   if (pos->value == MAP_EMPTY_VALUE) {
 153     pos->key = key;
 154     pos->value = 0;
 155   }
 156   return &pos->value;
 157 }
 158
 159 /**
 160  * Deletes key from the map if present.
 161  */
 162 static void COVER_map_remove(COVER_map_t *map, U32 key) {
 163   U32 i = COVER_map_index(map, key);
 164   COVER_map_pair_t *del = &map->data[i];
 165   U32 shift = 1;
 166   if (del->value == MAP_EMPTY_VALUE) {
 167     return;
 168   }
 169   for (i = (i + 1) & map->sizeMask;; i = (i + 1) & map->sizeMask) {
 170     COVER_map_pair_t *const pos = &map->data[i];
 171     /* If the position is empty we are done */
 172     if (pos->value == MAP_EMPTY_VALUE) {
 173       del->value = MAP_EMPTY_VALUE;
 174       return;
 175     }
 176     /* If pos can be moved to del do so */
 177     if (((i - COVER_map_hash(map, pos->key)) & map->sizeMask) >= shift) {
 178       del->key = pos->key;
 179       del->value = pos->value;
 180       del = pos;
 181       shift = 1;
 182     } else {
 183       ++shift;
 184     }
 185   }
 186 }
 187
 188 /**
 189  * Destroys a map that is inited with COVER_map_init().
 190  */
 191 static void COVER_map_destroy(COVER_map_t *map) {
 192   if (map->data) {
 193     free(map->data);
 194   }
 195   map->data = NULL;
 196   map->size = 0;
 197 }
 198
 199 /*-*************************************
 200 * Context
 201 ***************************************/
 202
 203 typedef struct {
 204   const BYTE *samples;
 205   size_t *offsets;
 206   const size_t *samplesSizes;
 207   size_t nbSamples;
 208   size_t nbTrainSamples;
 209   size_t nbTestSamples;
 210   U32 *suffix;
 211   size_t suffixSize;
 212   U32 *freqs;
 213   U32 *dmerAt;
 214   unsigned d;
 215 } COVER_ctx_t;
 216
 217 /* We need a global context for qsort... */
 218 static COVER_ctx_t *g_ctx = NULL;
 219
 220 /*-*************************************
 221 *  Helper functions
 222 ***************************************/
 223
 224 /**
 225  * Returns the sum of the sample sizes.
 226  */
 227 size_t COVER_sum(const size_t *samplesSizes, unsigned nbSamples) {
 228   size_t sum = 0;
 229   unsigned i;
 230   for (i = 0; i < nbSamples; ++i) {
 231     sum += samplesSizes[i];
 232   }
 233   return sum;
 234 }
 235
 236 /**
 237  * Returns -1 if the dmer at lp is less than the dmer at rp.
 238  * Return 0 if the dmers at lp and rp are equal.
 239  * Returns 1 if the dmer at lp is greater than the dmer at rp.
 240  */
 241 static int COVER_cmp(COVER_ctx_t *ctx, const void *lp, const void *rp) {
 242   U32 const lhs = *(U32 const *)lp;
 243   U32 const rhs = *(U32 const *)rp;
 244   return memcmp(ctx->samples + lhs, ctx->samples + rhs, ctx->d);
 245 }
 246 /**
 247  * Faster version for d <= 8.
 248  */
 249 static int COVER_cmp8(COVER_ctx_t *ctx, const void *lp, const void *rp) {
 250   U64 const mask = (ctx->d == 8) ? (U64)-1 : (((U64)1 << (8 * ctx->d)) - 1);
 251   U64 const lhs = MEM_readLE64(ctx->samples + *(U32 const *)lp) & mask;
 252   U64 const rhs = MEM_readLE64(ctx->samples + *(U32 const *)rp) & mask;
 253   if (lhs < rhs) {
 254     return -1;
 255   }
 256   return (lhs > rhs);
 257 }
 258
 259 /**
 260  * Same as COVER_cmp() except ties are broken by pointer value
 261  * NOTE: g_ctx must be set to call this function.  A global is required because
 262  * qsort doesn't take an opaque pointer.
 263  */
 264 static int COVER_strict_cmp(const void *lp, const void *rp) {
 265   int result = COVER_cmp(g_ctx, lp, rp);
 266   if (result == 0) {
 267     result = lp < rp ? -1 : 1;
 268   }
 269   return result;
 270 }
 271 /**
 272  * Faster version for d <= 8.
 273  */
 274 static int COVER_strict_cmp8(const void *lp, const void *rp) {
 275   int result = COVER_cmp8(g_ctx, lp, rp);
 276   if (result == 0) {
 277     result = lp < rp ? -1 : 1;
 278   }
 279   return result;
 280 }
 281
 282 /**
 283  * Returns the first pointer in [first, last) whose element does not compare
 284  * less than value.  If no such element exists it returns last.
 285  */
 286 static const size_t *COVER_lower_bound(const size_t *first, const size_t *last,
 287                                        size_t value) {
 288   size_t count = last - first;
 289   while (count != 0) {
 290     size_t step = count / 2;
 291     const size_t *ptr = first;
 292     ptr += step;
 293     if (*ptr < value) {
 294       first = ++ptr;
 295       count -= step + 1;
 296     } else {
 297       count = step;
 298     }
 299   }
 300   return first;
 301 }
 302
 303 /**
 304  * Generic groupBy function.
 305  * Groups an array sorted by cmp into groups with equivalent values.
 306  * Calls grp for each group.
 307  */
 308 static void
 309 COVER_groupBy(const void *data, size_t count, size_t size, COVER_ctx_t *ctx,
 310               int (*cmp)(COVER_ctx_t *, const void *, const void *),
 311               void (*grp)(COVER_ctx_t *, const void *, const void *)) {
 312   const BYTE *ptr = (const BYTE *)data;
 313   size_t num = 0;
 314   while (num < count) {
 315     const BYTE *grpEnd = ptr + size;
 316     ++num;
 317     while (num < count && cmp(ctx, ptr, grpEnd) == 0) {
 318       grpEnd += size;
 319       ++num;
 320     }
 321     grp(ctx, ptr, grpEnd);
 322     ptr = grpEnd;
 323   }
 324 }
 325
 326 /*-*************************************
 327 *  Cover functions
 328 ***************************************/
 329
 330 /**
 331  * Called on each group of positions with the same dmer.
 332  * Counts the frequency of each dmer and saves it in the suffix array.
 333  * Fills `ctx->dmerAt`.
 334  */
 335 static void COVER_group(COVER_ctx_t *ctx, const void *group,
 336                         const void *groupEnd) {
 337   /* The group consists of all the positions with the same first d bytes. */
 338   const U32 *grpPtr = (const U32 *)group;
 339   const U32 *grpEnd = (const U32 *)groupEnd;
 340   /* The dmerId is how we will reference this dmer.
 341    * This allows us to map the whole dmer space to a much smaller space, the
 342    * size of the suffix array.
 343    */
 344   const U32 dmerId = (U32)(grpPtr - ctx->suffix);
 345   /* Count the number of samples this dmer shows up in */
 346   U32 freq = 0;
 347   /* Details */
 348   const size_t *curOffsetPtr = ctx->offsets;
 349   const size_t *offsetsEnd = ctx->offsets + ctx->nbSamples;
 350   /* Once *grpPtr >= curSampleEnd this occurrence of the dmer is in a
 351    * different sample than the last.
 352    */
 353   size_t curSampleEnd = ctx->offsets[0];
 354   for (; grpPtr != grpEnd; ++grpPtr) {
 355     /* Save the dmerId for this position so we can get back to it. */
 356     ctx->dmerAt[*grpPtr] = dmerId;
 357     /* Dictionaries only help for the first reference to the dmer.
 358      * After that zstd can reference the match from the previous reference.
 359      * So only count each dmer once for each sample it is in.
 360      */
 361     if (*grpPtr < curSampleEnd) {
 362       continue;
 363     }
 364     freq += 1;
 365     /* Binary search to find the end of the sample *grpPtr is in.
 366      * In the common case that grpPtr + 1 == grpEnd we can skip the binary
 367      * search because the loop is over.
 368      */
 369     if (grpPtr + 1 != grpEnd) {
 370       const size_t *sampleEndPtr =
 371           COVER_lower_bound(curOffsetPtr, offsetsEnd, *grpPtr);
 372       curSampleEnd = *sampleEndPtr;
 373       curOffsetPtr = sampleEndPtr + 1;
 374     }
 375   }
 376   /* At this point we are never going to look at this segment of the suffix
 377    * array again.  We take advantage of this fact to save memory.
 378    * We store the frequency of the dmer in the first position of the group,
 379    * which is dmerId.
 380    */
 381   ctx->suffix[dmerId] = freq;
 382 }
 383
 384
 385 /**
 386  * Selects the best segment in an epoch.
 387  * Segments of are scored according to the function:
 388  *
 389  * Let F(d) be the frequency of dmer d.
 390  * Let S_i be the dmer at position i of segment S which has length k.
 391  *
 392  *     Score(S) = F(S_1) + F(S_2) + ... + F(S_{k-d+1})
 393  *
 394  * Once the dmer d is in the dictionary we set F(d) = 0.
 395  */
 396 static COVER_segment_t COVER_selectSegment(const COVER_ctx_t *ctx, U32 *freqs,
 397                                            COVER_map_t *activeDmers, U32 begin,
 398                                            U32 end,
 399                                            ZDICT_cover_params_t parameters) {
 400   /* Constants */
 401   const U32 k = parameters.k;
 402   const U32 d = parameters.d;
 403   const U32 dmersInK = k - d + 1;
 404   /* Try each segment (activeSegment) and save the best (bestSegment) */
 405   COVER_segment_t bestSegment = {0, 0, 0};
 406   COVER_segment_t activeSegment;
 407   /* Reset the activeDmers in the segment */
 408   COVER_map_clear(activeDmers);
 409   /* The activeSegment starts at the beginning of the epoch. */
 410   activeSegment.begin = begin;
 411   activeSegment.end = begin;
 412   activeSegment.score = 0;
 413   /* Slide the activeSegment through the whole epoch.
 414    * Save the best segment in bestSegment.
 415    */
 416   while (activeSegment.end < end) {
 417     /* The dmerId for the dmer at the next position */
 418     U32 newDmer = ctx->dmerAt[activeSegment.end];
 419     /* The entry in activeDmers for this dmerId */
 420     U32 *newDmerOcc = COVER_map_at(activeDmers, newDmer);
 421     /* If the dmer isn't already present in the segment add its score. */
 422     if (*newDmerOcc == 0) {
 423       /* The paper suggest using the L-0.5 norm, but experiments show that it
 424        * doesn't help.
 425        */
 426       activeSegment.score += freqs[newDmer];
 427     }
 428     /* Add the dmer to the segment */
 429     activeSegment.end += 1;
 430     *newDmerOcc += 1;
 431
 432     /* If the window is now too large, drop the first position */
 433     if (activeSegment.end - activeSegment.begin == dmersInK + 1) {
 434       U32 delDmer = ctx->dmerAt[activeSegment.begin];
 435       U32 *delDmerOcc = COVER_map_at(activeDmers, delDmer);
 436       activeSegment.begin += 1;
 437       *delDmerOcc -= 1;
 438       /* If this is the last occurrence of the dmer, subtract its score */
 439       if (*delDmerOcc == 0) {
 440         COVER_map_remove(activeDmers, delDmer);
 441         activeSegment.score -= freqs[delDmer];
 442       }
 443     }
 444
 445     /* If this segment is the best so far save it */
 446     if (activeSegment.score > bestSegment.score) {
 447       bestSegment = activeSegment;
 448     }
 449   }
 450   {
 451     /* Trim off the zero frequency head and tail from the segment. */
 452     U32 newBegin = bestSegment.end;
 453     U32 newEnd = bestSegment.begin;
 454     U32 pos;
 455     for (pos = bestSegment.begin; pos != bestSegment.end; ++pos) {
 456       U32 freq = freqs[ctx->dmerAt[pos]];
 457       if (freq != 0) {
 458         newBegin = MIN(newBegin, pos);
 459         newEnd = pos + 1;
 460       }
 461     }
 462     bestSegment.begin = newBegin;
 463     bestSegment.end = newEnd;
 464   }
 465   {
 466     /* Zero out the frequency of each dmer covered by the chosen segment. */
 467     U32 pos;
 468     for (pos = bestSegment.begin; pos != bestSegment.end; ++pos) {
 469       freqs[ctx->dmerAt[pos]] = 0;
 470     }
 471   }
 472   return bestSegment;
 473 }
 474
 475 /**
 476  * Check the validity of the parameters.
 477  * Returns non-zero if the parameters are valid and 0 otherwise.
 478  */
 479 static int COVER_checkParameters(ZDICT_cover_params_t parameters,
 480                                  size_t maxDictSize) {
 481   /* k and d are required parameters */
 482   if (parameters.d == 0 || parameters.k == 0) {
 483     return 0;
 484   }
 485   /* k <= maxDictSize */
 486   if (parameters.k > maxDictSize) {
 487     return 0;
 488   }
 489   /* d <= k */
 490   if (parameters.d > parameters.k) {
 491     return 0;
 492   }
 493   /* 0 < splitPoint <= 1 */
 494   if (parameters.splitPoint <= 0 || parameters.splitPoint > 1){
 495     return 0;
 496   }
 497   return 1;
 498 }
 499
 500 /**
 501  * Clean up a context initialized with `COVER_ctx_init()`.
 502  */
 503 static void COVER_ctx_destroy(COVER_ctx_t *ctx) {
 504   if (!ctx) {
 505     return;
 506   }
 507   if (ctx->suffix) {
 508     free(ctx->suffix);
 509     ctx->suffix = NULL;
 510   }
 511   if (ctx->freqs) {
 512     free(ctx->freqs);
 513     ctx->freqs = NULL;
 514   }
 515   if (ctx->dmerAt) {
 516     free(ctx->dmerAt);
 517     ctx->dmerAt = NULL;
 518   }
 519   if (ctx->offsets) {
 520     free(ctx->offsets);
 521     ctx->offsets = NULL;
 522   }
 523 }
 524
 525 /**
 526  * Prepare a context for dictionary building.
 527  * The context is only dependent on the parameter `d` and can used multiple
 528  * times.
 529  * Returns 1 on success or zero on error.
 530  * The context must be destroyed with `COVER_ctx_destroy()`.
 531  */
 532 static int COVER_ctx_init(COVER_ctx_t *ctx, const void *samplesBuffer,
 533                           const size_t *samplesSizes, unsigned nbSamples,
 534                           unsigned d, double splitPoint) {
 535   const BYTE *const samples = (const BYTE *)samplesBuffer;
 536   const size_t totalSamplesSize = COVER_sum(samplesSizes, nbSamples);
 537   /* Split samples into testing and training sets */
 538   const unsigned nbTrainSamples = splitPoint < 1.0 ? (unsigned)((double)nbSamples * splitPoint) : nbSamples;
 539   const unsigned nbTestSamples = splitPoint < 1.0 ? nbSamples - nbTrainSamples : nbSamples;
 540   const size_t trainingSamplesSize = splitPoint < 1.0 ? COVER_sum(samplesSizes, nbTrainSamples) : totalSamplesSize;
 541   const size_t testSamplesSize = splitPoint < 1.0 ? COVER_sum(samplesSizes + nbTrainSamples, nbTestSamples) : totalSamplesSize;
 542   /* Checks */
 543   if (totalSamplesSize < MAX(d, sizeof(U64)) ||
 544       totalSamplesSize >= (size_t)COVER_MAX_SAMPLES_SIZE) {
 545     DISPLAYLEVEL(1, "Total samples size is too large (%u MB), maximum size is %u MB\n",
 546                  (unsigned)(totalSamplesSize>>20), (COVER_MAX_SAMPLES_SIZE >> 20));
 547     return 0;
 548   }
 549   /* Check if there are at least 5 training samples */
 550   if (nbTrainSamples < 5) {
 551     DISPLAYLEVEL(1, "Total number of training samples is %u and is invalid.", nbTrainSamples);
 552     return 0;
 553   }
 554   /* Check if there's testing sample */
 555   if (nbTestSamples < 1) {
 556     DISPLAYLEVEL(1, "Total number of testing samples is %u and is invalid.", nbTestSamples);
 557     return 0;
 558   }
 559   /* Zero the context */
 560   memset(ctx, 0, sizeof(*ctx));
 561   DISPLAYLEVEL(2, "Training on %u samples of total size %u\n", nbTrainSamples,
 562                (unsigned)trainingSamplesSize);
 563   DISPLAYLEVEL(2, "Testing on %u samples of total size %u\n", nbTestSamples,
 564                (unsigned)testSamplesSize);
 565   ctx->samples = samples;
 566   ctx->samplesSizes = samplesSizes;
 567   ctx->nbSamples = nbSamples;
 568   ctx->nbTrainSamples = nbTrainSamples;
 569   ctx->nbTestSamples = nbTestSamples;
 570   /* Partial suffix array */
 571   ctx->suffixSize = trainingSamplesSize - MAX(d, sizeof(U64)) + 1;
 572   ctx->suffix = (U32 *)malloc(ctx->suffixSize * sizeof(U32));
 573   /* Maps index to the dmerID */
 574   ctx->dmerAt = (U32 *)malloc(ctx->suffixSize * sizeof(U32));
 575   /* The offsets of each file */
 576   ctx->offsets = (size_t *)malloc((nbSamples + 1) * sizeof(size_t));
 577   if (!ctx->suffix || !ctx->dmerAt || !ctx->offsets) {
 578     DISPLAYLEVEL(1, "Failed to allocate scratch buffers\n");
 579     COVER_ctx_destroy(ctx);
 580     return 0;
 581   }
 582   ctx->freqs = NULL;
 583   ctx->d = d;
 584
 585   /* Fill offsets from the samplesSizes */
 586   {
 587     U32 i;
 588     ctx->offsets[0] = 0;
 589     for (i = 1; i <= nbSamples; ++i) {
 590       ctx->offsets[i] = ctx->offsets[i - 1] + samplesSizes[i - 1];
 591     }
 592   }
 593   DISPLAYLEVEL(2, "Constructing partial suffix array\n");
 594   {
 595     /* suffix is a partial suffix array.
 596      * It only sorts suffixes by their first parameters.d bytes.
 597      * The sort is stable, so each dmer group is sorted by position in input.
 598      */
 599     U32 i;
 600     for (i = 0; i < ctx->suffixSize; ++i) {
 601       ctx->suffix[i] = i;
 602     }
 603     /* qsort doesn't take an opaque pointer, so pass as a global.
 604      * On OpenBSD qsort() is not guaranteed to be stable, their mergesort() is.
 605      */
 606     g_ctx = ctx;
 607 #if defined(__OpenBSD__)
 608     mergesort(ctx->suffix, ctx->suffixSize, sizeof(U32),
 609           (ctx->d <= 8 ? &COVER_strict_cmp8 : &COVER_strict_cmp));
 610 #else
 611     qsort(ctx->suffix, ctx->suffixSize, sizeof(U32),
 612           (ctx->d <= 8 ? &COVER_strict_cmp8 : &COVER_strict_cmp));
 613 #endif
 614   }
 615   DISPLAYLEVEL(2, "Computing frequencies\n");
 616   /* For each dmer group (group of positions with the same first d bytes):
 617    * 1. For each position we set dmerAt[position] = dmerID.  The dmerID is
 618    *    (groupBeginPtr - suffix).  This allows us to go from position to
 619    *    dmerID so we can look up values in freq.
 620    * 2. We calculate how many samples the dmer occurs in and save it in
 621    *    freqs[dmerId].
 622    */
 623   COVER_groupBy(ctx->suffix, ctx->suffixSize, sizeof(U32), ctx,
 624                 (ctx->d <= 8 ? &COVER_cmp8 : &COVER_cmp), &COVER_group);
 625   ctx->freqs = ctx->suffix;
 626   ctx->suffix = NULL;
 627   return 1;
 628 }
 629
 630 void COVER_warnOnSmallCorpus(size_t maxDictSize, size_t nbDmers, int displayLevel)
 631 {
 632   const double ratio = (double)nbDmers / maxDictSize;
 633   if (ratio >= 10) {
 634       return;
 635   }
 636   LOCALDISPLAYLEVEL(displayLevel, 1,
 637                     "WARNING: The maximum dictionary size %u is too large "
 638                     "compared to the source size %u! "
 639                     "size(source)/size(dictionary) = %f, but it should be >= "
 640                     "10! This may lead to a subpar dictionary! We recommend "
 641                     "training on sources at least 10x, and up to 100x the "
 642                     "size of the dictionary!\n", (U32)maxDictSize,
 643                     (U32)nbDmers, ratio);
 644 }
 645
 646 COVER_epoch_info_t COVER_computeEpochs(U32 maxDictSize,
 647                                        U32 nbDmers, U32 k, U32 passes)
 648 {
 649   const U32 minEpochSize = k * 10;
 650   COVER_epoch_info_t epochs;
 651   epochs.num = MAX(1, maxDictSize / k / passes);
 652   epochs.size = nbDmers / epochs.num;
 653   if (epochs.size >= minEpochSize) {
 654       assert(epochs.size * epochs.num <= nbDmers);
 655       return epochs;
 656   }
 657   epochs.size = MIN(minEpochSize, nbDmers);
 658   epochs.num = nbDmers / epochs.size;
 659   assert(epochs.size * epochs.num <= nbDmers);
 660   return epochs;
 661 }
 662
 663 /**
 664  * Given the prepared context build the dictionary.
 665  */
 666 static size_t COVER_buildDictionary(const COVER_ctx_t *ctx, U32 *freqs,
 667                                     COVER_map_t *activeDmers, void *dictBuffer,
 668                                     size_t dictBufferCapacity,
 669                                     ZDICT_cover_params_t parameters) {
 670   BYTE *const dict = (BYTE *)dictBuffer;
 671   size_t tail = dictBufferCapacity;
 672   /* Divide the data into epochs. We will select one segment from each epoch. */
 673   const COVER_epoch_info_t epochs = COVER_computeEpochs(
 674       (U32)dictBufferCapacity, (U32)ctx->suffixSize, parameters.k, 4);
 675   const size_t maxZeroScoreRun = MAX(10, MIN(100, epochs.num >> 3));
 676   size_t zeroScoreRun = 0;
 677   size_t epoch;
 678   DISPLAYLEVEL(2, "Breaking content into %u epochs of size %u\n",
 679                 (U32)epochs.num, (U32)epochs.size);
 680   /* Loop through the epochs until there are no more segments or the dictionary
 681    * is full.
 682    */
 683   for (epoch = 0; tail > 0; epoch = (epoch + 1) % epochs.num) {
 684     const U32 epochBegin = (U32)(epoch * epochs.size);
 685     const U32 epochEnd = epochBegin + epochs.size;
 686     size_t segmentSize;
 687     /* Select a segment */
 688     COVER_segment_t segment = COVER_selectSegment(
 689         ctx, freqs, activeDmers, epochBegin, epochEnd, parameters);
 690     /* If the segment covers no dmers, then we are out of content.
 691      * There may be new content in other epochs, for continue for some time.
 692      */
 693     if (segment.score == 0) {
 694       if (++zeroScoreRun >= maxZeroScoreRun) {
 695           break;
 696       }
 697       continue;
 698     }
 699     zeroScoreRun = 0;
 700     /* Trim the segment if necessary and if it is too small then we are done */
 701     segmentSize = MIN(segment.end - segment.begin + parameters.d - 1, tail);
 702     if (segmentSize < parameters.d) {
 703       break;
 704     }
 705     /* We fill the dictionary from the back to allow the best segments to be
 706      * referenced with the smallest offsets.
 707      */
 708     tail -= segmentSize;
 709     memcpy(dict + tail, ctx->samples + segment.begin, segmentSize);
 710     DISPLAYUPDATE(
 711         2, "\r%u%%       ",
 712         (unsigned)(((dictBufferCapacity - tail) * 100) / dictBufferCapacity));
 713   }
 714   DISPLAYLEVEL(2, "\r%79s\r", "");
 715   return tail;
 716 }
 717
 718 ZDICTLIB_API size_t ZDICT_trainFromBuffer_cover(
 719     void *dictBuffer, size_t dictBufferCapacity,
 720     const void *samplesBuffer, const size_t *samplesSizes, unsigned nbSamples,
 721     ZDICT_cover_params_t parameters)
 722 {
 723   BYTE* const dict = (BYTE*)dictBuffer;
 724   COVER_ctx_t ctx;
 725   COVER_map_t activeDmers;
 726   parameters.splitPoint = 1.0;
 727   /* Initialize global data */
 728   g_displayLevel = parameters.zParams.notificationLevel;
 729   /* Checks */
 730   if (!COVER_checkParameters(parameters, dictBufferCapacity)) {
 731     DISPLAYLEVEL(1, "Cover parameters incorrect\n");
 732     return ERROR(GENERIC);
 733   }
 734   if (nbSamples == 0) {
 735     DISPLAYLEVEL(1, "Cover must have at least one input file\n");
 736     return ERROR(GENERIC);
 737   }
 738   if (dictBufferCapacity < ZDICT_DICTSIZE_MIN) {
 739     DISPLAYLEVEL(1, "dictBufferCapacity must be at least %u\n",
 740                  ZDICT_DICTSIZE_MIN);
 741     return ERROR(dstSize_tooSmall);
 742   }
 743   /* Initialize context and activeDmers */
 744   if (!COVER_ctx_init(&ctx, samplesBuffer, samplesSizes, nbSamples,
 745                       parameters.d, parameters.splitPoint)) {
 746     return ERROR(GENERIC);
 747   }
 748   COVER_warnOnSmallCorpus(dictBufferCapacity, ctx.suffixSize, g_displayLevel);
 749   if (!COVER_map_init(&activeDmers, parameters.k - parameters.d + 1)) {
 750     DISPLAYLEVEL(1, "Failed to allocate dmer map: out of memory\n");
 751     COVER_ctx_destroy(&ctx);
 752     return ERROR(GENERIC);
 753   }
 754
 755   DISPLAYLEVEL(2, "Building dictionary\n");
 756   {
 757     const size_t tail =
 758         COVER_buildDictionary(&ctx, ctx.freqs, &activeDmers, dictBuffer,
 759                               dictBufferCapacity, parameters);
 760     const size_t dictionarySize = ZDICT_finalizeDictionary(
 761         dict, dictBufferCapacity, dict + tail, dictBufferCapacity - tail,
 762         samplesBuffer, samplesSizes, nbSamples, parameters.zParams);
 763     if (!ZSTD_isError(dictionarySize)) {
 764       DISPLAYLEVEL(2, "Constructed dictionary of size %u\n",
 765                    (unsigned)dictionarySize);
 766     }
 767     COVER_ctx_destroy(&ctx);
 768     COVER_map_destroy(&activeDmers);
 769     return dictionarySize;
 770   }
 771 }
 772
 773
 774
 775 size_t COVER_checkTotalCompressedSize(const ZDICT_cover_params_t parameters,
 776                                     const size_t *samplesSizes, const BYTE *samples,
 777                                     size_t *offsets,
 778                                     size_t nbTrainSamples, size_t nbSamples,
 779                                     BYTE *const dict, size_t dictBufferCapacity) {
 780   size_t totalCompressedSize = ERROR(GENERIC);
 781   /* Pointers */
 782   ZSTD_CCtx *cctx;
 783   ZSTD_CDict *cdict;
 784   void *dst;
 785   /* Local variables */
 786   size_t dstCapacity;
 787   size_t i;
 788   /* Allocate dst with enough space to compress the maximum sized sample */
 789   {
 790     size_t maxSampleSize = 0;
 791     i = parameters.splitPoint < 1.0 ? nbTrainSamples : 0;
 792     for (; i < nbSamples; ++i) {
 793       maxSampleSize = MAX(samplesSizes[i], maxSampleSize);
 794     }
 795     dstCapacity = ZSTD_compressBound(maxSampleSize);
 796     dst = malloc(dstCapacity);
 797   }
 798   /* Create the cctx and cdict */
 799   cctx = ZSTD_createCCtx();
 800   cdict = ZSTD_createCDict(dict, dictBufferCapacity,
 801                            parameters.zParams.compressionLevel);
 802   if (!dst || !cctx || !cdict) {
 803     goto _compressCleanup;
 804   }
 805   /* Compress each sample and sum their sizes (or error) */
 806   totalCompressedSize = dictBufferCapacity;
 807   i = parameters.splitPoint < 1.0 ? nbTrainSamples : 0;
 808   for (; i < nbSamples; ++i) {
 809     const size_t size = ZSTD_compress_usingCDict(
 810         cctx, dst, dstCapacity, samples + offsets[i],
 811         samplesSizes[i], cdict);
 812     if (ZSTD_isError(size)) {
 813       totalCompressedSize = ERROR(GENERIC);
 814       goto _compressCleanup;
 815     }
 816     totalCompressedSize += size;
 817   }
 818 _compressCleanup:
 819   ZSTD_freeCCtx(cctx);
 820   ZSTD_freeCDict(cdict);
 821   if (dst) {
 822     free(dst);
 823   }
 824   return totalCompressedSize;
 825 }
 826
 827
 828 /**
 829  * Initialize the `COVER_best_t`.
 830  */
 831 void COVER_best_init(COVER_best_t *best) {
 832   if (best==NULL) return; /* compatible with init on NULL */
 833   (void)ZSTD_pthread_mutex_init(&best->mutex, NULL);
 834   (void)ZSTD_pthread_cond_init(&best->cond, NULL);
 835   best->liveJobs = 0;
 836   best->dict = NULL;
 837   best->dictSize = 0;
 838   best->compressedSize = (size_t)-1;
 839   memset(&best->parameters, 0, sizeof(best->parameters));
 840 }
 841
 842 /**
 843  * Wait until liveJobs == 0.
 844  */
 845 void COVER_best_wait(COVER_best_t *best) {
 846   if (!best) {
 847     return;
 848   }
 849   ZSTD_pthread_mutex_lock(&best->mutex);
 850   while (best->liveJobs != 0) {
 851     ZSTD_pthread_cond_wait(&best->cond, &best->mutex);
 852   }
 853   ZSTD_pthread_mutex_unlock(&best->mutex);
 854 }
 855
 856 /**
 857  * Call COVER_best_wait() and then destroy the COVER_best_t.
 858  */
 859 void COVER_best_destroy(COVER_best_t *best) {
 860   if (!best) {
 861     return;
 862   }
 863   COVER_best_wait(best);
 864   if (best->dict) {
 865     free(best->dict);
 866   }
 867   ZSTD_pthread_mutex_destroy(&best->mutex);
 868   ZSTD_pthread_cond_destroy(&best->cond);
 869 }
 870
 871 /**
 872  * Called when a thread is about to be launched.
 873  * Increments liveJobs.
 874  */
 875 void COVER_best_start(COVER_best_t *best) {
 876   if (!best) {
 877     return;
 878   }
 879   ZSTD_pthread_mutex_lock(&best->mutex);
 880   ++best->liveJobs;
 881   ZSTD_pthread_mutex_unlock(&best->mutex);
 882 }
 883
 884 /**
 885  * Called when a thread finishes executing, both on error or success.
 886  * Decrements liveJobs and signals any waiting threads if liveJobs == 0.
 887  * If this dictionary is the best so far save it and its parameters.
 888  */
 889 void COVER_best_finish(COVER_best_t *best, size_t compressedSize,
 890                               ZDICT_cover_params_t parameters, void *dict,
 891                               size_t dictSize) {
 892   if (!best) {
 893     return;
 894   }
 895   {
 896     size_t liveJobs;
 897     ZSTD_pthread_mutex_lock(&best->mutex);
 898     --best->liveJobs;
 899     liveJobs = best->liveJobs;
 900     /* If the new dictionary is better */
 901     if (compressedSize < best->compressedSize) {
 902       /* Allocate space if necessary */
 903       if (!best->dict || best->dictSize < dictSize) {
 904         if (best->dict) {
 905           free(best->dict);
 906         }
 907         best->dict = malloc(dictSize);
 908         if (!best->dict) {
 909           best->compressedSize = ERROR(GENERIC);
 910           best->dictSize = 0;
 911           ZSTD_pthread_cond_signal(&best->cond);
 912           ZSTD_pthread_mutex_unlock(&best->mutex);
 913           return;
 914         }
 915       }
 916       /* Save the dictionary, parameters, and size */
 917       memcpy(best->dict, dict, dictSize);
 918       best->dictSize = dictSize;
 919       best->parameters = parameters;
 920       best->compressedSize = compressedSize;
 921     }
 922     if (liveJobs == 0) {
 923       ZSTD_pthread_cond_broadcast(&best->cond);
 924     }
 925     ZSTD_pthread_mutex_unlock(&best->mutex);
 926   }
 927 }
 928
 929 /**
 930  * Parameters for COVER_tryParameters().
 931  */
 932 typedef struct COVER_tryParameters_data_s {
 933   const COVER_ctx_t *ctx;
 934   COVER_best_t *best;
 935   size_t dictBufferCapacity;
 936   ZDICT_cover_params_t parameters;
 937 } COVER_tryParameters_data_t;
 938
 939 /**
 940  * Tries a set of parameters and updates the COVER_best_t with the results.
 941  * This function is thread safe if zstd is compiled with multithreaded support.
 942  * It takes its parameters as an *OWNING* opaque pointer to support threading.
 943  */
 944 static void COVER_tryParameters(void *opaque) {
 945   /* Save parameters as local variables */
 946   COVER_tryParameters_data_t *const data = (COVER_tryParameters_data_t *)opaque;
 947   const COVER_ctx_t *const ctx = data->ctx;
 948   const ZDICT_cover_params_t parameters = data->parameters;
 949   size_t dictBufferCapacity = data->dictBufferCapacity;
 950   size_t totalCompressedSize = ERROR(GENERIC);
 951   /* Allocate space for hash table, dict, and freqs */
 952   COVER_map_t activeDmers;
 953   BYTE *const dict = (BYTE * const)malloc(dictBufferCapacity);
 954   U32 *freqs = (U32 *)malloc(ctx->suffixSize * sizeof(U32));
 955   if (!COVER_map_init(&activeDmers, parameters.k - parameters.d + 1)) {
 956     DISPLAYLEVEL(1, "Failed to allocate dmer map: out of memory\n");
 957     goto _cleanup;
 958   }
 959   if (!dict || !freqs) {
 960     DISPLAYLEVEL(1, "Failed to allocate buffers: out of memory\n");
 961     goto _cleanup;
 962   }
 963   /* Copy the frequencies because we need to modify them */
 964   memcpy(freqs, ctx->freqs, ctx->suffixSize * sizeof(U32));
 965   /* Build the dictionary */
 966   {
 967     const size_t tail = COVER_buildDictionary(ctx, freqs, &activeDmers, dict,
 968                                               dictBufferCapacity, parameters);
 969     dictBufferCapacity = ZDICT_finalizeDictionary(
 970         dict, dictBufferCapacity, dict + tail, dictBufferCapacity - tail,
 971         ctx->samples, ctx->samplesSizes, (unsigned)ctx->nbTrainSamples,
 972         parameters.zParams);
 973     if (ZDICT_isError(dictBufferCapacity)) {
 974       DISPLAYLEVEL(1, "Failed to finalize dictionary\n");
 975       goto _cleanup;
 976     }
 977   }
 978   /* Check total compressed size */
 979   totalCompressedSize = COVER_checkTotalCompressedSize(parameters, ctx->samplesSizes,
 980                                                        ctx->samples, ctx->offsets,
 981                                                        ctx->nbTrainSamples, ctx->nbSamples,
 982                                                        dict, dictBufferCapacity);
 983
 984 _cleanup:
 985   COVER_best_finish(data->best, totalCompressedSize, parameters, dict,
 986                     dictBufferCapacity);
 987   free(data);
 988   COVER_map_destroy(&activeDmers);
 989   if (dict) {
 990     free(dict);
 991   }
 992   if (freqs) {
 993     free(freqs);
 994   }
 995 }
 996
 997 ZDICTLIB_API size_t ZDICT_optimizeTrainFromBuffer_cover(
 998     void *dictBuffer, size_t dictBufferCapacity, const void *samplesBuffer,
 999     const size_t *samplesSizes, unsigned nbSamples,
1000     ZDICT_cover_params_t *parameters) {
1001   /* constants */
1002   const unsigned nbThreads = parameters->nbThreads;
1003   const double splitPoint =
1004       parameters->splitPoint <= 0.0 ? DEFAULT_SPLITPOINT : parameters->splitPoint;
1005   const unsigned kMinD = parameters->d == 0 ? 6 : parameters->d;
1006   const unsigned kMaxD = parameters->d == 0 ? 8 : parameters->d;
1007   const unsigned kMinK = parameters->k == 0 ? 50 : parameters->k;
1008   const unsigned kMaxK = parameters->k == 0 ? 2000 : parameters->k;
1009   const unsigned kSteps = parameters->steps == 0 ? 40 : parameters->steps;
1010   const unsigned kStepSize = MAX((kMaxK - kMinK) / kSteps, 1);
1011   const unsigned kIterations =
1012       (1 + (kMaxD - kMinD) / 2) * (1 + (kMaxK - kMinK) / kStepSize);
1013   /* Local variables */
1014   const int displayLevel = parameters->zParams.notificationLevel;
1015   unsigned iteration = 1;
1016   unsigned d;
1017   unsigned k;
1018   COVER_best_t best;
1019   POOL_ctx *pool = NULL;
1020   int warned = 0;
1021
1022   /* Checks */
1023   if (splitPoint <= 0 || splitPoint > 1) {
1024     LOCALDISPLAYLEVEL(displayLevel, 1, "Incorrect parameters\n");
1025     return ERROR(GENERIC);
1026   }
1027   if (kMinK < kMaxD || kMaxK < kMinK) {
1028     LOCALDISPLAYLEVEL(displayLevel, 1, "Incorrect parameters\n");
1029     return ERROR(GENERIC);
1030   }
1031   if (nbSamples == 0) {
1032     DISPLAYLEVEL(1, "Cover must have at least one input file\n");
1033     return ERROR(GENERIC);
1034   }
1035   if (dictBufferCapacity < ZDICT_DICTSIZE_MIN) {
1036     DISPLAYLEVEL(1, "dictBufferCapacity must be at least %u\n",
1037                  ZDICT_DICTSIZE_MIN);
1038     return ERROR(dstSize_tooSmall);
1039   }
1040   if (nbThreads > 1) {
1041     pool = POOL_create(nbThreads, 1);
1042     if (!pool) {
1043       return ERROR(memory_allocation);
1044     }
1045   }
1046   /* Initialization */
1047   COVER_best_init(&best);
1048   /* Turn down global display level to clean up display at level 2 and below */
1049   g_displayLevel = displayLevel == 0 ? 0 : displayLevel - 1;
1050   /* Loop through d first because each new value needs a new context */
1051   LOCALDISPLAYLEVEL(displayLevel, 2, "Trying %u different sets of parameters\n",
1052                     kIterations);
1053   for (d = kMinD; d <= kMaxD; d += 2) {
1054     /* Initialize the context for this value of d */
1055     COVER_ctx_t ctx;
1056     LOCALDISPLAYLEVEL(displayLevel, 3, "d=%u\n", d);
1057     if (!COVER_ctx_init(&ctx, samplesBuffer, samplesSizes, nbSamples, d, splitPoint)) {
1058       LOCALDISPLAYLEVEL(displayLevel, 1, "Failed to initialize context\n");
1059       COVER_best_destroy(&best);
1060       POOL_free(pool);
1061       return ERROR(GENERIC);
1062     }
1063     if (!warned) {
1064       COVER_warnOnSmallCorpus(dictBufferCapacity, ctx.suffixSize, displayLevel);
1065       warned = 1;
1066     }
1067     /* Loop through k reusing the same context */
1068     for (k = kMinK; k <= kMaxK; k += kStepSize) {
1069       /* Prepare the arguments */
1070       COVER_tryParameters_data_t *data = (COVER_tryParameters_data_t *)malloc(
1071           sizeof(COVER_tryParameters_data_t));
1072       LOCALDISPLAYLEVEL(displayLevel, 3, "k=%u\n", k);
1073       if (!data) {
1074         LOCALDISPLAYLEVEL(displayLevel, 1, "Failed to allocate parameters\n");
1075         COVER_best_destroy(&best);
1076         COVER_ctx_destroy(&ctx);
1077         POOL_free(pool);
1078         return ERROR(GENERIC);
1079       }
1080       data->ctx = &ctx;
1081       data->best = &best;
1082       data->dictBufferCapacity = dictBufferCapacity;
1083       data->parameters = *parameters;
1084       data->parameters.k = k;
1085       data->parameters.d = d;
1086       data->parameters.splitPoint = splitPoint;
1087       data->parameters.steps = kSteps;
1088       data->parameters.zParams.notificationLevel = g_displayLevel;
1089       /* Check the parameters */
1090       if (!COVER_checkParameters(data->parameters, dictBufferCapacity)) {
1091         DISPLAYLEVEL(1, "Cover parameters incorrect\n");
1092         free(data);
1093         continue;
1094       }
1095       /* Call the function and pass ownership of data to it */
1096       COVER_best_start(&best);
1097       if (pool) {
1098         POOL_add(pool, &COVER_tryParameters, data);
1099       } else {
1100         COVER_tryParameters(data);
1101       }
1102       /* Print status */
1103       LOCALDISPLAYUPDATE(displayLevel, 2, "\r%u%%       ",
1104                          (unsigned)((iteration * 100) / kIterations));
1105       ++iteration;
1106     }
1107     COVER_best_wait(&best);
1108     COVER_ctx_destroy(&ctx);
1109   }
1110   LOCALDISPLAYLEVEL(displayLevel, 2, "\r%79s\r", "");
1111   /* Fill the output buffer and parameters with output of the best parameters */
1112   {
1113     const size_t dictSize = best.dictSize;
1114     if (ZSTD_isError(best.compressedSize)) {
1115       const size_t compressedSize = best.compressedSize;
1116       COVER_best_destroy(&best);
1117       POOL_free(pool);
1118       return compressedSize;
1119     }
1120     *parameters = best.parameters;
1121     memcpy(dictBuffer, best.dict, dictSize);
1122     COVER_best_destroy(&best);
1123     POOL_free(pool);
1124     return dictSize;
1125   }
1126 }