1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
// Copyright (C) 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include "icing/index/numeric/posting-list-integer-index-data-accessor.h"
#include <cstdint>
#include <memory>
#include <vector>
#include "icing/text_classifier/lib3/utils/base/status.h"
#include "icing/text_classifier/lib3/utils/base/statusor.h"
#include "icing/absl_ports/canonical_errors.h"
#include "icing/file/posting_list/flash-index-storage.h"
#include "icing/file/posting_list/index-block.h"
#include "icing/file/posting_list/posting-list-identifier.h"
#include "icing/file/posting_list/posting-list-used.h"
#include "icing/index/numeric/integer-index-data.h"
#include "icing/index/numeric/posting-list-used-integer-index-data-serializer.h"
#include "icing/util/status-macros.h"
namespace icing {
namespace lib {
/* static */ libtextclassifier3::StatusOr<
std::unique_ptr<PostingListIntegerIndexDataAccessor>>
PostingListIntegerIndexDataAccessor::Create(
FlashIndexStorage* storage,
PostingListUsedIntegerIndexDataSerializer* serializer) {
uint32_t max_posting_list_bytes = IndexBlock::CalculateMaxPostingListBytes(
storage->block_size(), serializer->GetDataTypeBytes());
std::unique_ptr<uint8_t[]> posting_list_buffer_array =
std::make_unique<uint8_t[]>(max_posting_list_bytes);
ICING_ASSIGN_OR_RETURN(
PostingListUsed posting_list_buffer,
PostingListUsed::CreateFromUnitializedRegion(
serializer, posting_list_buffer_array.get(), max_posting_list_bytes));
return std::unique_ptr<PostingListIntegerIndexDataAccessor>(
new PostingListIntegerIndexDataAccessor(
storage, std::move(posting_list_buffer_array),
std::move(posting_list_buffer), serializer));
}
/* static */ libtextclassifier3::StatusOr<
std::unique_ptr<PostingListIntegerIndexDataAccessor>>
PostingListIntegerIndexDataAccessor::CreateFromExisting(
FlashIndexStorage* storage,
PostingListUsedIntegerIndexDataSerializer* serializer,
PostingListIdentifier existing_posting_list_id) {
ICING_ASSIGN_OR_RETURN(
std::unique_ptr<PostingListIntegerIndexDataAccessor> pl_accessor,
Create(storage, serializer));
ICING_ASSIGN_OR_RETURN(PostingListHolder holder,
storage->GetPostingList(existing_posting_list_id));
pl_accessor->preexisting_posting_list_ =
std::make_unique<PostingListHolder>(std::move(holder));
return pl_accessor;
}
// Returns the next batch of integer index data for the provided posting list.
libtextclassifier3::StatusOr<std::vector<IntegerIndexData>>
PostingListIntegerIndexDataAccessor::GetNextDataBatch() {
if (preexisting_posting_list_ == nullptr) {
if (has_reached_posting_list_chain_end_) {
return std::vector<IntegerIndexData>();
}
return absl_ports::FailedPreconditionError(
"Cannot retrieve data from a PostingListIntegerIndexDataAccessor that "
"was not created from a preexisting posting list.");
}
ICING_ASSIGN_OR_RETURN(
std::vector<IntegerIndexData> batch,
serializer_->GetData(&preexisting_posting_list_->posting_list));
uint32_t next_block_index;
// Posting lists will only be chained when they are max-sized, in which case
// block.next_block_index() will point to the next block for the next posting
// list. Otherwise, block.next_block_index() can be kInvalidBlockIndex or be
// used to point to the next free list block, which is not relevant here.
if (preexisting_posting_list_->block.max_num_posting_lists() == 1) {
next_block_index = preexisting_posting_list_->block.next_block_index();
} else {
next_block_index = kInvalidBlockIndex;
}
if (next_block_index != kInvalidBlockIndex) {
PostingListIdentifier next_posting_list_id(
next_block_index, /*posting_list_index=*/0,
preexisting_posting_list_->block.posting_list_index_bits());
ICING_ASSIGN_OR_RETURN(PostingListHolder holder,
storage_->GetPostingList(next_posting_list_id));
preexisting_posting_list_ =
std::make_unique<PostingListHolder>(std::move(holder));
} else {
has_reached_posting_list_chain_end_ = true;
preexisting_posting_list_.reset();
}
return batch;
}
libtextclassifier3::Status PostingListIntegerIndexDataAccessor::PrependData(
const IntegerIndexData& data) {
PostingListUsed& active_pl = (preexisting_posting_list_ != nullptr)
? preexisting_posting_list_->posting_list
: posting_list_buffer_;
libtextclassifier3::Status status =
serializer_->PrependData(&active_pl, data);
if (!absl_ports::IsResourceExhausted(status)) {
return status;
}
// There is no more room to add data to this current posting list! Therefore,
// we need to either move those data to a larger posting list or flush this
// posting list and create another max-sized posting list in the chain.
if (preexisting_posting_list_ != nullptr) {
FlushPreexistingPostingList();
} else {
ICING_RETURN_IF_ERROR(FlushInMemoryPostingList());
}
// Re-add data. Should always fit since we just cleared posting_list_buffer_.
// It's fine to explicitly reference posting_list_buffer_ here because there's
// no way of reaching this line while preexisting_posting_list_ is still in
// use.
return serializer_->PrependData(&posting_list_buffer_, data);
}
} // namespace lib
} // namespace icing
|
