sys/sys/linker_set.h

   1 /*-
   2  * Copyright (c) 1999 John D. Polstra
   3  * Copyright (c) 1999,2001 Peter Wemm <peter@FreeBSD.org>
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  * $FreeBSD$
  28  */
  29
  30 #ifndef _SYS_LINKER_SET_H_
  31 #define _SYS_LINKER_SET_H_
  32
  33 /*
  34  * The following macros are used to declare global sets of objects, which
  35  * are collected by the linker into a `linker_set' as defined below.
  36  * For ELF, this is done by constructing a separate segment for each set.
  37  */
  38
  39 /*
  40  * Private macros, not to be used outside this header file.
  41  */
  42 #if defined(__GNUC__) || defined(__INTEL_COMPILER)
  43 #define __MAKE_SET(set, sym)                                            \
  44         static void const * const __set_##set##_sym_##sym               \
  45         __section("set_" #set) __used = &sym
  46 #else /* !(__GNUC__ || __INTEL_COMPILER) */
  47 #ifndef lint
  48 #error "This file needs to be compiled by GCC, an Intel compiler or lint"
  49 #endif /* lint */
  50 #define __MAKE_SET(set, sym)    extern void const * const (__set_##set##_sym_##sym)
  51 #endif /* __GNUC__ || __INTEL_COMPILER */
  52
  53 /*
  54  * Public macros.
  55  */
  56 #define TEXT_SET(set, sym)      __MAKE_SET(set, sym)
  57 #define DATA_SET(set, sym)      __MAKE_SET(set, sym)
  58 #define BSS_SET(set, sym)       __MAKE_SET(set, sym)
  59 #define ABS_SET(set, sym)       __MAKE_SET(set, sym)
  60 #define SET_ENTRY(set, sym)     __MAKE_SET(set, sym)
  61
  62 /*
  63  * Initialize before referring to a give linker set
  64  */
  65 #define SET_DECLARE(set, ptype)                                         \
  66         extern ptype *__CONCAT(__start_set_,set);                       \
  67         extern ptype *__CONCAT(__stop_set_,set)
  68
  69 #define SET_BEGIN(set)                                                  \
  70         (&__CONCAT(__start_set_,set))
  71 #define SET_LIMIT(set)                                                  \
  72         (&__CONCAT(__stop_set_,set))
  73
  74 /*
  75  * Iterate over all the elements of a set.
  76  *
  77  * Sets always contain addresses of things, and "pvar" points to words
  78  * containing those addresses.  Thus is must be declared as "type **pvar",
  79  * and the address of each set item is obtained inside the loop by "*pvar".
  80  */
  81 #define SET_FOREACH(pvar, set)                                          \
  82         for (pvar = SET_BEGIN(set); pvar < SET_LIMIT(set); pvar++)
  83
  84 #define SET_ITEM(set, i)                                                \
  85         ((SET_BEGIN(set))[i])
  86
  87 /*
  88  * Provide a count of the items in a set.
  89  */
  90 #define SET_COUNT(set)                                                  \
  91         (SET_LIMIT(set) - SET_BEGIN(set))
  92
  93 #endif  /* _SYS_LINKER_SET_H_ */