BaseTools: resolve initialization order errors in VfrFormPkg.h

[mirror_edk2.git] / BaseTools / Source / C / BrotliCompress / enc / hash_longest_match_inc.h

/* NOLINT(build/header_guard) */\r
/* Copyright 2010 Google Inc. All Rights Reserved.\r
\r
   Distributed under MIT license.\r
   See file LICENSE for detail or copy at https://opensource.org/licenses/MIT\r
*/\r
\r
/* template parameters: FN, BUCKET_BITS, BLOCK_BITS,\r
                        NUM_LAST_DISTANCES_TO_CHECK */\r
\r
/* A (forgetful) hash table to the data seen by the compressor, to\r
   help create backward references to previous data.\r
\r
   This is a hash map of fixed size (BUCKET_SIZE) to a ring buffer of\r
   fixed size (BLOCK_SIZE). The ring buffer contains the last BLOCK_SIZE\r
   index positions of the given hash key in the compressed data. */\r
\r
#define HashLongestMatch HASHER()\r
\r
/* Number of hash buckets. */\r
#define BUCKET_SIZE (1 << BUCKET_BITS)\r
\r
/* Only BLOCK_SIZE newest backward references are kept,\r
   and the older are forgotten. */\r
#define BLOCK_SIZE (1u << BLOCK_BITS)\r
\r
/* Mask for accessing entries in a block (in a ringbuffer manner). */\r
#define BLOCK_MASK ((1 << BLOCK_BITS) - 1)\r
\r
#define HASH_MAP_SIZE (2 << BUCKET_BITS)\r
\r
static BROTLI_INLINE size_t FN(HashTypeLength)(void) { return 4; }\r
static BROTLI_INLINE size_t FN(StoreLookahead)(void) { return 4; }\r
\r
/* HashBytes is the function that chooses the bucket to place\r
   the address in. The HashLongestMatch and HashLongestMatchQuickly\r
   classes have separate, different implementations of hashing. */\r
static uint32_t FN(HashBytes)(const uint8_t *data) {\r
  uint32_t h = BROTLI_UNALIGNED_LOAD32(data) * kHashMul32;\r
  /* The higher bits contain more mixture from the multiplication,\r
     so we take our results from there. */\r
  return h >> (32 - BUCKET_BITS);\r
}\r
\r
typedef struct HashLongestMatch {\r
  /* Number of entries in a particular bucket. */\r
  uint16_t num_[BUCKET_SIZE];\r
\r
  /* Buckets containing BLOCK_SIZE of backward references. */\r
  uint32_t buckets_[BLOCK_SIZE << BUCKET_BITS];\r
\r
  /* True if num_ array needs to be initialized. */\r
  BROTLI_BOOL is_dirty_;\r
\r
  DictionarySearchStatictics dict_search_stats_;\r
} HashLongestMatch;\r
\r
static void FN(Reset)(HashLongestMatch* self) {\r
  self->is_dirty_ = BROTLI_TRUE;\r
  DictionarySearchStaticticsReset(&self->dict_search_stats_);\r
}\r
\r
static void FN(InitEmpty)(HashLongestMatch* self) {\r
  if (self->is_dirty_) {\r
    memset(self->num_, 0, sizeof(self->num_));\r
    self->is_dirty_ = BROTLI_FALSE;\r
  }\r
}\r
\r
static void FN(InitForData)(HashLongestMatch* self, const uint8_t* data,\r
    size_t num) {\r
  size_t i;\r
  for (i = 0; i < num; ++i) {\r
    const uint32_t key = FN(HashBytes)(&data[i]);\r
    self->num_[key] = 0;\r
  }\r
  if (num != 0) {\r
    self->is_dirty_ = BROTLI_FALSE;\r
  }\r
}\r
\r
static void FN(Init)(\r
    MemoryManager* m, HashLongestMatch* self, const uint8_t* data,\r
    const BrotliEncoderParams* params, size_t position, size_t bytes,\r
    BROTLI_BOOL is_last) {\r
  /* Choose which init method is faster.\r
     Init() is about 100 times faster than InitForData(). */\r
  const size_t kMaxBytesForPartialHashInit = HASH_MAP_SIZE >> 7;\r
  BROTLI_UNUSED(m);\r
  BROTLI_UNUSED(params);\r
  if (position == 0 && is_last && bytes <= kMaxBytesForPartialHashInit) {\r
    FN(InitForData)(self, data, bytes);\r
  } else {\r
    FN(InitEmpty)(self);\r
  }\r
}\r
\r
/* Look at 4 bytes at &data[ix & mask].\r
   Compute a hash from these, and store the value of ix at that position. */\r
static BROTLI_INLINE void FN(Store)(HashLongestMatch* self, const uint8_t *data,\r
    const size_t mask, const size_t ix) {\r
  const uint32_t key = FN(HashBytes)(&data[ix & mask]);\r
  const size_t minor_ix = self->num_[key] & BLOCK_MASK;\r
  self->buckets_[minor_ix + (key << BLOCK_BITS)] = (uint32_t)ix;\r
  ++self->num_[key];\r
}\r
\r
static BROTLI_INLINE void FN(StoreRange)(HashLongestMatch* self,\r
    const uint8_t *data, const size_t mask, const size_t ix_start,\r
    const size_t ix_end) {\r
  size_t i;\r
  for (i = ix_start; i < ix_end; ++i) {\r
    FN(Store)(self, data, mask, i);\r
  }\r
}\r
\r
static BROTLI_INLINE void FN(StitchToPreviousBlock)(HashLongestMatch* self,\r
    size_t num_bytes, size_t position, const uint8_t* ringbuffer,\r
    size_t ringbuffer_mask) {\r
  if (num_bytes >= FN(HashTypeLength)() - 1 && position >= 3) {\r
    /* Prepare the hashes for three last bytes of the last write.\r
       These could not be calculated before, since they require knowledge\r
       of both the previous and the current block. */\r
    FN(Store)(self, ringbuffer, ringbuffer_mask, position - 3);\r
    FN(Store)(self, ringbuffer, ringbuffer_mask, position - 2);\r
    FN(Store)(self, ringbuffer, ringbuffer_mask, position - 1);\r
  }\r
}\r
\r
/* Find a longest backward match of &data[cur_ix] up to the length of\r
   max_length and stores the position cur_ix in the hash table.\r
\r
   Does not look for matches longer than max_length.\r
   Does not look for matches further away than max_backward.\r
   Writes the best match into |out|.\r
   Returns true when match is found, otherwise false. */\r
static BROTLI_INLINE BROTLI_BOOL FN(FindLongestMatch)(HashLongestMatch* self,\r
    const uint8_t* BROTLI_RESTRICT data, const size_t ring_buffer_mask,\r
    const int* BROTLI_RESTRICT distance_cache, const size_t cur_ix,\r
    const size_t max_length, const size_t max_backward,\r
    HasherSearchResult* BROTLI_RESTRICT out) {\r
  const size_t cur_ix_masked = cur_ix & ring_buffer_mask;\r
  BROTLI_BOOL is_match_found = BROTLI_FALSE;\r
  /* Don't accept a short copy from far away. */\r
  score_t best_score = out->score;\r
  size_t best_len = out->len;\r
  size_t i;\r
  out->len = 0;\r
  out->len_x_code = 0;\r
  /* Try last distance first. */\r
  for (i = 0; i < NUM_LAST_DISTANCES_TO_CHECK; ++i) {\r
    const size_t idx = kDistanceCacheIndex[i];\r
    const size_t backward =\r
        (size_t)(distance_cache[idx] + kDistanceCacheOffset[i]);\r
    size_t prev_ix = (size_t)(cur_ix - backward);\r
    if (prev_ix >= cur_ix) {\r
      continue;\r
    }\r
    if (PREDICT_FALSE(backward > max_backward)) {\r
      continue;\r
    }\r
    prev_ix &= ring_buffer_mask;\r
\r
    if (cur_ix_masked + best_len > ring_buffer_mask ||\r
        prev_ix + best_len > ring_buffer_mask ||\r
        data[cur_ix_masked + best_len] != data[prev_ix + best_len]) {\r
      continue;\r
    }\r
    {\r
      const size_t len = FindMatchLengthWithLimit(&data[prev_ix],\r
                                                  &data[cur_ix_masked],\r
                                                  max_length);\r
      if (len >= 3 || (len == 2 && i < 2)) {\r
        /* Comparing for >= 2 does not change the semantics, but just saves for\r
           a few unnecessary binary logarithms in backward reference score,\r
           since we are not interested in such short matches. */\r
        score_t score = BackwardReferenceScoreUsingLastDistance(len, i);\r
        if (best_score < score) {\r
          best_score = score;\r
          best_len = len;\r
          out->len = best_len;\r
          out->distance = backward;\r
          out->score = best_score;\r
          is_match_found = BROTLI_TRUE;\r
        }\r
      }\r
    }\r
  }\r
  {\r
    const uint32_t key = FN(HashBytes)(&data[cur_ix_masked]);\r
    uint32_t* BROTLI_RESTRICT bucket = &self->buckets_[key << BLOCK_BITS];\r
    const size_t down =\r
        (self->num_[key] > BLOCK_SIZE) ? (self->num_[key] - BLOCK_SIZE) : 0u;\r
    for (i = self->num_[key]; i > down;) {\r
      size_t prev_ix = bucket[--i & BLOCK_MASK];\r
      const size_t backward = cur_ix - prev_ix;\r
      if (PREDICT_FALSE(backward > max_backward)) {\r
        break;\r
      }\r
      prev_ix &= ring_buffer_mask;\r
      if (cur_ix_masked + best_len > ring_buffer_mask ||\r
          prev_ix + best_len > ring_buffer_mask ||\r
          data[cur_ix_masked + best_len] != data[prev_ix + best_len]) {\r
        continue;\r
      }\r
      {\r
        const size_t len = FindMatchLengthWithLimit(&data[prev_ix],\r
                                                    &data[cur_ix_masked],\r
                                                    max_length);\r
        if (len >= 4) {\r
          /* Comparing for >= 3 does not change the semantics, but just saves\r
             for a few unnecessary binary logarithms in backward reference\r
             score, since we are not interested in such short matches. */\r
          score_t score = BackwardReferenceScore(len, backward);\r
          if (best_score < score) {\r
            best_score = score;\r
            best_len = len;\r
            out->len = best_len;\r
            out->distance = backward;\r
            out->score = best_score;\r
            is_match_found = BROTLI_TRUE;\r
          }\r
        }\r
      }\r
    }\r
    bucket[self->num_[key] & BLOCK_MASK] = (uint32_t)cur_ix;\r
    ++self->num_[key];\r
  }\r
  if (!is_match_found) {\r
    is_match_found = SearchInStaticDictionary(&self->dict_search_stats_,\r
        &data[cur_ix_masked], max_length, max_backward, out, BROTLI_FALSE);\r
  }\r
  return is_match_found;\r
}\r
\r
#undef HASH_MAP_SIZE\r
#undef BLOCK_MASK\r
#undef BLOCK_SIZE\r
#undef BUCKET_SIZE\r
\r
#undef HashLongestMatch\r