lib/librte_eal/common/include/rte_per_lcore.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_PER_LCORE_H_
  36 #define _RTE_PER_LCORE_H_
  37
  38 /**
  39  * @file
  40  *
  41  * Per-lcore variables in RTE
  42  *
  43  * This file defines an API for instantiating per-lcore "global
  44  * variables" that are environment-specific. Note that in all
  45  * environments, a "shared variable" is the default when you use a
  46  * global variable.
  47  *
  48  * Parts of this are execution environment specific.
  49  */
  50
  51 #ifdef __cplusplus
  52 extern "C" {
  53 #endif
  54
  55 #include <exec-env/rte_per_lcore.h>
  56
  57 #ifdef __DOXYGEN__
  58 /**
  59  * Macro to define a per lcore variable "var" of type "type", don't
  60  * use keywords like "static" or "volatile" in type, just prefix the
  61  * whole macro.
  62  */
  63 #define RTE_DEFINE_PER_LCORE(type, name)
  64
  65 /**
  66  * Macro to declare an extern per lcore variable "var" of type "type"
  67  */
  68 #define RTE_DECLARE_PER_LCORE(type, name)
  69
  70 /**
  71  * Read/write the per-lcore variable value
  72  */
  73 #define RTE_PER_LCORE(name)
  74 #endif
  75
  76 #ifdef __cplusplus
  77 }
  78 #endif
  79
  80 #endif /* _RTE_PER_LCORE_H_ */