lib/librte_eal/common/include/rte_prefetch.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2012 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  */
  34
  35 #ifndef _RTE_PREFETCH_H_
  36 #define _RTE_PREFETCH_H_
  37
  38 /**
  39  * @file
  40  *
  41  * Prefetch operations.
  42  *
  43  * This file defines an API for prefetch macros / inline-functions,
  44  * which are architecture-dependent. Prefetching occurs when a
  45  * processor requests an instruction or data from memory to cache
  46  * before it is actually needed, potentially speeding up the execution of the
  47  * program.
  48  */
  49
  50 #ifdef __cplusplus
  51 extern "C" {
  52 #endif
  53
  54 /**
  55  * Prefetch a cache line into all cache levels.
  56  * @param p
  57  *   Address to prefetch
  58  */
  59 static inline void rte_prefetch0(volatile void *p)
  60 {
  61         asm volatile ("prefetcht0 %[p]" : [p] "+m" (*(volatile char *)p));
  62 }
  63
  64 /**
  65  * Prefetch a cache line into all cache levels except the 0th cache level.
  66  * @param p
  67  *   Address to prefetch
  68  */
  69 static inline void rte_prefetch1(volatile void *p)
  70 {
  71         asm volatile ("prefetcht1 %[p]" : [p] "+m" (*(volatile char *)p));
  72 }
  73
  74 /**
  75  * Prefetch a cache line into all cache levels except the 0th and 1th cache
  76  * levels.
  77  * @param p
  78  *   Address to prefetch
  79  */
  80 static inline void rte_prefetch2(volatile void *p)
  81 {
  82         asm volatile ("prefetcht2 %[p]" : [p] "+m" (*(volatile char *)p));
  83 }
  84
  85 #ifdef __cplusplus
  86 }
  87 #endif
  88
  89 #endif /* _RTE_PREFETCH_H_ */