Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use [[likely]] and [[unlikely]] in c++20 mode #576

Merged
merged 1 commit into from
Feb 11, 2024
Merged

Use [[likely]] and [[unlikely]] in c++20 mode #576

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ set(CMAKE_CXX_EXTENSIONS OFF)

if(NOT CMAKE_CXX_STANDARD EQUAL 17)
add_compile_definitions(PISA_ENABLE_CONCEPTS=1)
add_compile_definitions(PISA_CXX20=1)
endif()
add_compile_definitions(BOOST_NO_CXX98_FUNCTION_BASE=1)

Expand Down
6 changes: 3 additions & 3 deletions include/pisa/block_posting_list.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ struct block_posting_list {

void PISA_ALWAYSINLINE next() {
++m_pos_in_block;
if (PISA_UNLIKELY(m_pos_in_block == m_cur_block_size)) {
if PISA_UNLIKELY (m_pos_in_block == m_cur_block_size) {
if (m_cur_block + 1 == m_blocks) {
m_cur_docid = m_universe;
return;
Expand All @@ -118,7 +118,7 @@ struct block_posting_list {
* to the current document ID, the position will not change.
*/
void PISA_ALWAYSINLINE next_geq(uint64_t lower_bound) {
if (PISA_UNLIKELY(lower_bound > m_cur_block_max)) {
if PISA_UNLIKELY (lower_bound > m_cur_block_max) {
// binary search seems to perform worse here
if (lower_bound > block_max(m_blocks - 1)) {
m_cur_docid = m_universe;
Expand All @@ -142,7 +142,7 @@ struct block_posting_list {
void PISA_ALWAYSINLINE move(uint64_t pos) {
assert(pos >= position());
uint64_t block = pos / BlockCodec::block_size;
if (PISA_UNLIKELY(block != m_cur_block)) {
if PISA_UNLIKELY (block != m_cur_block) {
decode_docs_block(block);
}
while (position() < pos) {
Expand Down
4 changes: 2 additions & 2 deletions include/pisa/codec/block_codecs.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ struct optpfor_block {
thread_local codec_type optpfor_codec; // pfor decoding is *not* thread-safe
assert(n <= block_size);

if (PISA_UNLIKELY(n < block_size)) {
if PISA_UNLIKELY (n < block_size) {
return interpolative_block::decode(in, out, sum_of_values, n);
}

Expand Down Expand Up @@ -306,7 +306,7 @@ struct varint_G8IU_block {
static codec_type varint_codec; // decodeBlock is thread-safe
assert(n <= block_size);

if (PISA_UNLIKELY(n < block_size)) {
if PISA_UNLIKELY (n < block_size) {
return interpolative_block::decode(in, out, sum_of_values, n);
}

Expand Down
18 changes: 9 additions & 9 deletions include/pisa/codec/compact_elias_fano.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,9 +164,9 @@ struct compact_elias_fano {

uint64_t skip = position - m_position;
// optimize small forward skips
if (PISA_LIKELY(position > m_position && skip <= linear_scan_threshold)) {
if PISA_LIKELY (position > m_position && skip <= linear_scan_threshold) {
m_position = position;
if (PISA_UNLIKELY(m_position == size())) {
if PISA_UNLIKELY (m_position == size()) {
m_value = m_of.universe;
} else {
bit_vector::unary_enumerator he = m_high_enumerator;
Expand All @@ -193,13 +193,13 @@ struct compact_elias_fano {
uint64_t cur_high = m_value >> m_of.lower_bits;
uint64_t high_diff = high_lower_bound - cur_high;

if (PISA_LIKELY(lower_bound > m_value && high_diff <= linear_scan_threshold)) {
if PISA_LIKELY (lower_bound > m_value && high_diff <= linear_scan_threshold) {
// optimize small skips
next_reader next_value(*this, m_position + 1);
uint64_t val;
do {
m_position += 1;
if (PISA_LIKELY(m_position < size())) {
if PISA_LIKELY (m_position < size()) {
val = next_value();
} else {
m_position = size();
Expand All @@ -220,7 +220,7 @@ struct compact_elias_fano {
m_position += 1;
assert(m_position <= size());

if (PISA_LIKELY(m_position < size())) {
if PISA_LIKELY (m_position < size()) {
m_value = read_next();
} else {
m_value = m_of.universe;
Expand All @@ -234,7 +234,7 @@ struct compact_elias_fano {
}

uint64_t prev_high = 0;
if (PISA_LIKELY(m_position < size())) {
if PISA_LIKELY (m_position < size()) {
prev_high = m_bv->predecessor1(m_high_enumerator.position() - 1);
} else {
prev_high = m_bv->predecessor1(m_of.lower_bits_offset - 1);
Expand All @@ -253,7 +253,7 @@ struct compact_elias_fano {

private:
value_type PISA_NOINLINE slow_move(uint64_t position) {
if (PISA_UNLIKELY(position == size())) {
if PISA_UNLIKELY (position == size()) {
m_position = position;
m_value = m_of.universe;
return value();
Expand All @@ -279,7 +279,7 @@ struct compact_elias_fano {
}

value_type PISA_NOINLINE slow_next_geq(uint64_t lower_bound) {
if (PISA_UNLIKELY(lower_bound >= m_of.universe)) {
if PISA_UNLIKELY (lower_bound >= m_of.universe) {
return move(size());
}

Expand Down Expand Up @@ -309,7 +309,7 @@ struct compact_elias_fano {

next_reader read_value(*this, m_position);
while (true) {
if (PISA_UNLIKELY(m_position == size())) {
if PISA_UNLIKELY (m_position == size()) {
m_value = m_of.universe;
return value();
}
Expand Down
16 changes: 8 additions & 8 deletions include/pisa/codec/compact_ranked_bitvector.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,9 +139,9 @@ struct compact_ranked_bitvector {

// optimize small forward skips
uint64_t skip = position - m_position;
if (PISA_LIKELY(position > m_position && skip <= linear_scan_threshold)) {
if PISA_LIKELY (position > m_position && skip <= linear_scan_threshold) {
m_position = position;
if (PISA_UNLIKELY(m_position == size())) {
if PISA_UNLIKELY (m_position == size()) {
m_value = m_of.universe;
} else {
bit_vector::unary_enumerator he = m_enumerator;
Expand All @@ -164,13 +164,13 @@ struct compact_ranked_bitvector {
}

uint64_t diff = lower_bound - m_value;
if (PISA_LIKELY(lower_bound > m_value && diff <= linear_scan_threshold)) {
if PISA_LIKELY (lower_bound > m_value && diff <= linear_scan_threshold) {
// optimize small skips
bit_vector::unary_enumerator he = m_enumerator;
uint64_t val;
do {
m_position += 1;
if (PISA_LIKELY(m_position < size())) {
if PISA_LIKELY (m_position < size()) {
val = he.next() - m_of.bits_offset;
} else {
m_position = size();
Expand All @@ -190,7 +190,7 @@ struct compact_ranked_bitvector {
m_position += 1;
assert(m_position <= size());

if (PISA_LIKELY(m_position < size())) {
if PISA_LIKELY (m_position < size()) {
m_value = read_next();
} else {
m_value = m_of.universe;
Expand All @@ -206,7 +206,7 @@ struct compact_ranked_bitvector {
}

uint64_t pos = 0;
if (PISA_LIKELY(m_position < size())) {
if PISA_LIKELY (m_position < size()) {
pos = m_bv->predecessor1(m_enumerator.position() - 1);
} else {
pos = m_bv->predecessor1(m_of.end - 1);
Expand All @@ -218,7 +218,7 @@ struct compact_ranked_bitvector {
private:
value_type PISA_NOINLINE slow_move(uint64_t position) {
uint64_t skip = position - m_position;
if (PISA_UNLIKELY(position == size())) {
if PISA_UNLIKELY (position == size()) {
m_position = position;
m_value = m_of.universe;
return value();
Expand All @@ -245,7 +245,7 @@ struct compact_ranked_bitvector {
value_type PISA_NOINLINE slow_next_geq(uint64_t lower_bound) {
using broadword::popcount;

if (PISA_UNLIKELY(lower_bound >= m_of.universe)) {
if PISA_UNLIKELY (lower_bound >= m_of.universe) {
return move(size());
}

Expand Down
2 changes: 1 addition & 1 deletion include/pisa/codec/maskedvbyte.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ struct maskedvbyte_block {
}
static uint8_t const* decode(uint8_t const* in, uint32_t* out, uint32_t sum_of_values, size_t n) {
assert(n <= block_size);
if (PISA_UNLIKELY(n < block_size)) {
if PISA_UNLIKELY (n < block_size) {
return interpolative_block::decode(in, out, sum_of_values, n);
}
auto read = masked_vbyte_decode(in, out, n);
Expand Down
2 changes: 1 addition & 1 deletion include/pisa/codec/qmx.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ struct qmx_block {
static uint8_t const* decode(uint8_t const* in, uint32_t* out, uint32_t sum_of_values, size_t n) {
static QMX::compress_integer_qmx_improved qmx_codec; // decodeBlock is thread-safe
assert(n <= block_size);
if (PISA_UNLIKELY(n < block_size)) {
if PISA_UNLIKELY (n < block_size) {
return interpolative_block::decode(in, out, sum_of_values, n);
}
uint32_t enc_len = 0;
Expand Down
2 changes: 1 addition & 1 deletion include/pisa/codec/simdbp.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ struct simdbp_block {
}
static uint8_t const* decode(uint8_t const* in, uint32_t* out, uint32_t sum_of_values, size_t n) {
assert(n <= block_size);
if (PISA_UNLIKELY(n < block_size)) {
if PISA_UNLIKELY (n < block_size) {
return interpolative_block::decode(in, out, sum_of_values, n);
}
uint32_t b = *in++;
Expand Down
2 changes: 1 addition & 1 deletion include/pisa/codec/varintgb.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ struct varintgb_block {
static uint8_t const* decode(uint8_t const* in, uint32_t* out, uint32_t sum_of_values, size_t n) {
thread_local VarIntGB<false> varintgb_codec;
assert(n <= block_size);
if (PISA_UNLIKELY(n < block_size)) {
if PISA_UNLIKELY (n < block_size) {
return interpolative_block::decode(in, out, sum_of_values, n);
}
auto read = varintgb_codec.decodeArray(in, n, out);
Expand Down
2 changes: 1 addition & 1 deletion include/pisa/query/algorithm/maxscore_query.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ struct maxscore_query {
while (current_docid < max_docid) {
auto status = DocumentStatus::Skip;
while (status == DocumentStatus::Skip) {
if (PISA_UNLIKELY(next_docid >= max_docid)) {
if PISA_UNLIKELY (next_docid >= max_docid) {
return;
}

Expand Down
6 changes: 3 additions & 3 deletions include/pisa/recursive_graph_bisection.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,15 +180,15 @@ void compute_move_gains_caching(
auto terms = range.terms(d);
for (const auto& t: terms) {
if constexpr (isLikelyCached) { // NOLINT(readability-braces-around-statements)
if (PISA_UNLIKELY(not gain_cache.has_value(t))) {
if PISA_UNLIKELY (not gain_cache.has_value(t)) {
const auto& from_deg = from_lex[t];
const auto& to_deg = to_lex[t];
const auto term_gain = bp::expb(logn1, logn2, from_deg, to_deg)
- bp::expb(logn1, logn2, from_deg - 1, to_deg + 1);
gain_cache.set(t, term_gain);
}
} else {
if (PISA_LIKELY(not gain_cache.has_value(t))) {
if PISA_LIKELY (not gain_cache.has_value(t)) {
const auto& from_deg = from_lex[t];
const auto& to_deg = to_lex[t];
const auto term_gain = bp::expb(logn1, logn2, from_deg, to_deg)
Expand Down Expand Up @@ -223,7 +223,7 @@ void swap(document_partition<Iterator>& partition, degree_map_pair& degrees) {
auto lit = left.begin();
auto rit = right.begin();
for (; lit != left.end() && rit != right.end(); ++lit, ++rit) {
if (PISA_UNLIKELY(left.gain(*lit) + right.gain(*rit) <= 0)) {
if PISA_UNLIKELY (left.gain(*lit) + right.gain(*rit) <= 0) {
break;
}
{
Expand Down
8 changes: 4 additions & 4 deletions include/pisa/sequence/partitioned_sequence.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ struct partitioned_sequence {
// note: this is instantiated oly if BaseSequence has next_geq
template <typename Q = base_sequence_enumerator, typename = if_has_next_geq<Q>>
value_type PISA_ALWAYSINLINE next_geq(uint64_t lower_bound) {
if (PISA_LIKELY(lower_bound >= m_cur_base && lower_bound <= m_cur_upper_bound)) {
if PISA_LIKELY (lower_bound >= m_cur_base && lower_bound <= m_cur_upper_bound) {
auto val = m_partition_enum.next_geq(lower_bound - m_cur_base);
m_position = m_cur_begin + val.first;
return value_type(m_position, m_cur_base + val.second);
Expand All @@ -197,7 +197,7 @@ struct partitioned_sequence {
value_type PISA_ALWAYSINLINE next() {
++m_position;

if (PISA_LIKELY(m_position < m_cur_end)) {
if PISA_LIKELY (m_position < m_cur_end) {
uint64_t val = m_cur_base + m_partition_enum.next().second;
return value_type(m_position, val);
}
Expand All @@ -207,7 +207,7 @@ struct partitioned_sequence {
uint64_t size() const { return m_size; }

uint64_t prev_value() const {
if (PISA_UNLIKELY(m_position == m_cur_begin)) {
if PISA_UNLIKELY (m_position == m_cur_begin) {
return m_cur_partition != 0U ? m_cur_base - 1 : 0;
}
return m_cur_base + m_partition_enum.prev_value();
Expand All @@ -224,7 +224,7 @@ struct partitioned_sequence {
// tight loops, on microbenchmarks this causes an improvement of
// about 3ns on my i7 3Ghz
value_type PISA_NOINLINE slow_next() {
if (PISA_UNLIKELY(m_position == m_size)) {
if PISA_UNLIKELY (m_position == m_size) {
assert(m_cur_partition == m_partitions - 1);
auto val = m_partition_enum.next();
assert(val.first == m_partition_enum.size());
Expand Down
2 changes: 1 addition & 1 deletion include/pisa/sequence/positive_sequence.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ struct positive_sequence {
// the most common cases
uint64_t prev = m_cur;
if (position != m_position + 1) {
if (PISA_UNLIKELY(position == 0)) {
if PISA_UNLIKELY (position == 0) {
// we need to special-case position 0
m_cur = m_base_enum.move(0).second;
m_position = 0;
Expand Down
8 changes: 4 additions & 4 deletions include/pisa/sequence/uniform_partitioned_sequence.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ struct uniform_partitioned_sequence {
// note: this is instantiated oly if BaseSequence has next_geq
template <typename Q = base_sequence_enumerator, typename = if_has_next_geq<Q>>
value_type PISA_ALWAYSINLINE next_geq(uint64_t lower_bound) {
if (PISA_LIKELY(lower_bound >= m_cur_base && lower_bound <= m_cur_upper_bound)) {
if PISA_LIKELY (lower_bound >= m_cur_base && lower_bound <= m_cur_upper_bound) {
auto val = m_partition_enum.next_geq(lower_bound - m_cur_base);
m_position = m_cur_begin + val.first;
return value_type(m_position, m_cur_base + val.second);
Expand All @@ -182,7 +182,7 @@ struct uniform_partitioned_sequence {
value_type PISA_ALWAYSINLINE next() {
++m_position;

if (PISA_LIKELY(m_position < m_cur_end)) {
if PISA_LIKELY (m_position < m_cur_end) {
uint64_t val = m_cur_base + m_partition_enum.next().second;
return value_type(m_position, val);
}
Expand All @@ -192,7 +192,7 @@ struct uniform_partitioned_sequence {
uint64_t size() const { return m_size; }

uint64_t prev_value() const {
if (PISA_UNLIKELY(m_position == m_cur_begin)) {
if PISA_UNLIKELY (m_position == m_cur_begin) {
return m_cur_partition != 0U ? m_cur_base - 1 : 0;
}
return m_cur_base + m_partition_enum.prev_value();
Expand All @@ -205,7 +205,7 @@ struct uniform_partitioned_sequence {
// tight loops, on microbenchmarks this causes an improvement of
// about 3ns on my i7 3Ghz
value_type PISA_NOINLINE slow_next() {
if (PISA_UNLIKELY(m_position == m_size)) {
if PISA_UNLIKELY (m_position == m_size) {
assert(m_cur_partition == m_partitions - 1);
auto val = m_partition_enum.next();
assert(val.first == m_partition_enum.size());
Expand Down
6 changes: 3 additions & 3 deletions include/pisa/topk_queue.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,13 @@ struct topk_queue {
/// If the heap is full, the entry with the lowest value will be removed, i.e.,
/// the heap will maintain its size.
auto insert(Score score, DocId docid = 0) -> bool {
if (PISA_UNLIKELY(not would_enter(score))) {
if PISA_UNLIKELY (not would_enter(score)) {
return false;
}
m_q.emplace_back(score, docid);
if (PISA_UNLIKELY(m_q.size() <= m_k)) {
if PISA_UNLIKELY (m_q.size() <= m_k) {
std::push_heap(m_q.begin(), m_q.end(), min_heap_order);
if (PISA_UNLIKELY(m_q.size() == m_k)) {
if PISA_UNLIKELY (m_q.size() == m_k) {
m_effective_threshold = m_q.front().first;
}
} else {
Expand Down
5 changes: 4 additions & 1 deletion include/pisa/util/likely.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
#pragma once

// Likeliness annotations
#if defined(__GNUC__)
#if defined(PISA_CXX20)
#define PISA_LIKELY(x) (x) [[likely]]
#define PISA_UNLIKELY(x) (x) [[unlikely]]
#elif defined(__GNUC__)
#define PISA_LIKELY(x) (__builtin_expect(!!(x), 1))
#define PISA_UNLIKELY(x) (__builtin_expect(!!(x), 0))
#else
Expand Down
Loading