sys/sys/linker_set.h

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