1 // Copyright (C) 2019 Google LLC 2 // 3 // Licensed under the Apache License, Version 2.0 (the "License"); 4 // you may not use this file except in compliance with the License. 5 // You may obtain a copy of the License at 6 // 7 // http://www.apache.org/licenses/LICENSE-2.0 8 // 9 // Unless required by applicable law or agreed to in writing, software 10 // distributed under the License is distributed on an "AS IS" BASIS, 11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 // See the License for the specific language governing permissions and 13 // limitations under the License. 14 15 #ifndef ICING_INDEX_MAIN_POSTING_LIST_UTILS_H_ 16 #define ICING_INDEX_MAIN_POSTING_LIST_UTILS_H_ 17 18 #include <cstdint> 19 20 #include "icing/index/hit/hit.h" 21 22 namespace icing { 23 namespace lib { 24 25 namespace posting_list_utils { 26 27 // Represents the byte length of the two special hits described 28 // in the private section of posting-list-used.h. 29 inline constexpr uint32_t kNumSpecialHits = 2; 30 inline constexpr uint32_t kSpecialHitsSize = sizeof(Hit) * kNumSpecialHits; 31 min_posting_list_size()32constexpr uint32_t min_posting_list_size() { return kSpecialHitsSize; } 33 34 // For a posting list size to be valid, it must: 35 // 1) be sizeof(Hit) aligned 36 // 2) be equal to or larger than min_posting_list_size 37 // 3) be small enough to be encoded within a single Hit (5 bytes) 38 bool IsValidPostingListSize(uint32_t size_in_bytes); 39 40 } // namespace posting_list_utils 41 42 } // namespace lib 43 } // namespace icing 44 45 #endif // ICING_INDEX_MAIN_POSTING_LIST_UTILS_H_ 46