lib/librte_eal/common/include/rte_per_lcore.h

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