nsz Git - libfirm/blob - ir/adt/util.h

   1 /*
   2  * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @date   31.05.2005
  23  * @author Sebastian Hack
  24  * @brief  Some utility macros.
  25  */
  26 #ifndef FIRM_ADT_UTIL_H
  27 #define FIRM_ADT_UTIL_H
  28
  29 #include "firm_config.h"
  30
  31 /**
  32  * Get the offset of a member of a struct.
  33  * @param type   The type of the struct member is in.
  34  * @param member The name of the member.
  35  * @return       The offset of member in type in bytes.
  36  */
  37 #define offset_of(type, member) \
  38   ((char *) &(((type *) 0)->member) - (char *) 0)
  39
  40 /**
  41  * Make pointer to the struct from a pointer to a member of that struct.
  42  * @param ptr     The pointer to the member.
  43  * @param type    The type of the struct.
  44  * @param member  The name of the member.
  45  * @return        A pointer to the struct member is in.
  46  */
  47 #define container_of(ptr, type, member) \
  48         ((type *) ((char *) (ptr) - offset_of(type, member)))
  49
  50 /**
  51  * Get the number of elements of a static array.
  52  * @param arr The static array.
  53  * @return The number of elements in that array.
  54  */
  55 #define array_size(arr) \
  56   (sizeof(arr) / sizeof((arr)[0]))
  57
  58 /**
  59  * Asserts that the constant expression x is not zero at compiletime. name has
  60  * to be a unique identifier.
  61  *
  62  * @note This uses the fact, that double case labels are not allowed.
  63  */
  64 #define COMPILETIME_ASSERT(x, name) \
  65     static __attribute__((unused)) void compiletime_assert_##name (int h) { \
  66         switch(h) { case 0: case (x): ; } \
  67     }
  68
  69 #ifdef __GNUC__
  70 /**
  71  * Indicates to the compiler that the value of x is very likely 1
  72  * @note Only use this in speed critical code and when you are sure x is often 1
  73  */
  74 #define LIKELY(x)   __builtin_expect((x), 1)
  75
  76 /**
  77  * Indicates to the compiler that it's very likely that x is 0
  78  * @note Only use this in speed critical code and when you are sure x is often 0
  79  */
  80 #define UNLIKELY(x) __builtin_expect((x), 0)
  81 #else
  82 #define LIKELY(x)   x
  83 #define UNLIKELY(x) x
  84 #endif
  85
  86 #endif