src/intel/genxml/gen_macros.h

   1 /*
   2  * Copyright © 2015 Intel Corporation
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  21  * IN THE SOFTWARE.
  22  */
  23
  24 #pragma once
  25
  26 /* Macros for handling per-gen compilation.
  27  *
  28  * The prefixing macros GENX() and genX() automatically prefix whatever you
  29  * give them by GENX_ or genX_  where X is the gen number.
  30  *
  31  * You can declare a function to be used on some range of gens like this:
  32  *
  33  * GENX_FUNC(GEN7, GEN75) void
  34  * genX(my_function_name)(args...)
  35  * {
  36  *    // Do stuff
  37  * }
  38  *
  39  * If the file is compiled for any set of gens containing gen7 and gen75,
  40  * the function will effectively only get compiled twice as
  41  * gen7_my_function_nmae and gen75_my_function_name.  The function has to
  42  * be compilable on all gens, but it will become a static inline that gets
  43  * discarded by the compiler on all gens not in range.
  44  *
  45  * You can do pseudo-runtime checks in your function such as
  46  *
  47  * if (GEN_GEN > 8 || GEN_IS_HASWELL) {
  48  *    // Do something
  49  * }
  50  *
  51  * The contents of the if statement must be valid regardless of gen, but
  52  * the if will get compiled away on everything except haswell.
  53  *
  54  * For places where you really do have a compile-time conflict, you can
  55  * use preprocessor logic:
  56  *
  57  * #if (GEN_GEN > 8 || GEN_IS_HASWELL)
  58  *    // Do something
  59  * #endif
  60  *
  61  * However, it is strongly recommended that the former be used whenever
  62  * possible.
  63  */
  64
  65 /* Base macro defined on the command line.  If we don't have this, we can't
  66  * do anything.
  67  */
  68 #ifndef GEN_VERSIONx10
  69 #  error "The GEN_VERSIONx10 macro must be defined"
  70 #endif
  71
  72 #define GEN_GEN ((GEN_VERSIONx10) / 10)
  73 #define GEN_IS_HASWELL ((GEN_VERSIONx10) == 75)
  74
  75 /* Prefixing macros */
  76 #if (GEN_VERSIONx10 == 70)
  77 #  define GENX(X) GEN7_##X
  78 #  define genX(x) gen7_##x
  79 #elif (GEN_VERSIONx10 == 75)
  80 #  define GENX(X) GEN75_##X
  81 #  define genX(x) gen75_##x
  82 #elif (GEN_VERSIONx10 == 80)
  83 #  define GENX(X) GEN8_##X
  84 #  define genX(x) gen8_##x
  85 #elif (GEN_VERSIONx10 == 90)
  86 #  define GENX(X) GEN9_##X
  87 #  define genX(x) gen9_##x
  88 #else
  89 #  error "Need to add prefixing macros for this gen"
  90 #endif