blob: 706a7090bea3650d0f7fe472d706248bb0a1d72c [file] [log] [blame]
// Copyright 2017 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef QUICHE_COMMON_PLATFORM_API_QUICHE_PREFETCH_H_
#define QUICHE_COMMON_PLATFORM_API_QUICHE_PREFETCH_H_
#include "quiche_platform_impl/quiche_prefetch_impl.h"
namespace quiche {
// Move data into the cache before it is read, or "prefetch" it.
//
// The value of `addr` is the address of the memory to prefetch. If
// the target and compiler support it, data prefetch instructions are
// generated. If the prefetch is done some time before the memory is
// read, it may be in the cache by the time the read occurs.
//
// The function names specify the temporal locality heuristic applied,
// using the names of Intel prefetch instructions:
//
// T0 - high degree of temporal locality; data should be left in as
// many levels of the cache possible
// T1 - moderate degree of temporal locality
// T2 - low degree of temporal locality
// Nta - no temporal locality, data need not be left in the cache
// after the read
//
// Incorrect or gratuitous use of these functions can degrade
// performance, so use them only when representative benchmarks show
// an improvement.
inline void QuichePrefetchT0(const void* addr) {
return QuichePrefetchT0Impl(addr);
}
} // namespace quiche
#endif // QUICHE_COMMON_PLATFORM_API_QUICHE_PREFETCH_H_