LXR linux/include/linux/linkage.h

   1/* SPDX-License-Identifier: GPL-2.0 */
   2#ifndef _LINUX_LINKAGE_H
   3#define _LINUX_LINKAGE_H
   4
   5#include <linux/compiler_types.h>
   6#include <linux/stringify.h>
   7#include <linux/export.h>
   8#include <asm/linkage.h>
   9
  10/* Some toolchains use other characters (e.g. '`') to mark new line in macro */
  11#ifndef ASM_NL
  12#define ASM_NL           ;
  13#endif
  14
  15#ifdef __cplusplus
  16#define CPP_ASMLINKAGE extern "C"
  17#else
  18#define CPP_ASMLINKAGE
  19#endif
  20
  21#ifndef asmlinkage
  22#define asmlinkage CPP_ASMLINKAGE
  23#endif
  24
  25#ifndef cond_syscall
  26#define cond_syscall(x) asm(                            \
  27        ".weak " __stringify(x) "\n\t"                  \
  28        ".set  " __stringify(x) ","                     \
  29                 __stringify(sys_ni_syscall))
  30#endif
  31
  32#ifndef SYSCALL_ALIAS
  33#define SYSCALL_ALIAS(alias, name) asm(                 \
  34        ".globl " __stringify(alias) "\n\t"             \
  35        ".set   " __stringify(alias) ","                \
  36                  __stringify(name))
  37#endif
  38
  39#define __page_aligned_data     __section(.data..page_aligned) __aligned(PAGE_SIZE)
  40#define __page_aligned_bss      __section(.bss..page_aligned) __aligned(PAGE_SIZE)
  41
  42/*
  43 * For assembly routines.
  44 *
  45 * Note when using these that you must specify the appropriate
  46 * alignment directives yourself
  47 */
  48#define __PAGE_ALIGNED_DATA     .section ".data..page_aligned", "aw"
  49#define __PAGE_ALIGNED_BSS      .section ".bss..page_aligned", "aw"
  50
  51/*
  52 * This is used by architectures to keep arguments on the stack
  53 * untouched by the compiler by keeping them live until the end.
  54 * The argument stack may be owned by the assembly-language
  55 * caller, not the callee, and gcc doesn't always understand
  56 * that.
  57 *
  58 * We have the return value, and a maximum of six arguments.
  59 *
  60 * This should always be followed by a "return ret" for the
  61 * protection to work (ie no more work that the compiler might
  62 * end up needing stack temporaries for).
  63 */
  64/* Assembly files may be compiled with -traditional .. */
  65#ifndef __ASSEMBLY__
  66#ifndef asmlinkage_protect
  67# define asmlinkage_protect(n, ret, args...)    do { } while (0)
  68#endif
  69#endif
  70
  71#ifndef __ALIGN
  72#define __ALIGN         .align 4,0x90
  73#define __ALIGN_STR     ".align 4,0x90"
  74#endif
  75
  76#ifdef __ASSEMBLY__
  77
  78/* SYM_T_FUNC -- type used by assembler to mark functions */
  79#ifndef SYM_T_FUNC
  80#define SYM_T_FUNC                              STT_FUNC
  81#endif
  82
  83/* SYM_T_OBJECT -- type used by assembler to mark data */
  84#ifndef SYM_T_OBJECT
  85#define SYM_T_OBJECT                            STT_OBJECT
  86#endif
  87
  88/* SYM_T_NONE -- type used by assembler to mark entries of unknown type */
  89#ifndef SYM_T_NONE
  90#define SYM_T_NONE                              STT_NOTYPE
  91#endif
  92
  93/* SYM_A_* -- align the symbol? */
  94#define SYM_A_ALIGN                             ALIGN
  95#define SYM_A_NONE                              /* nothing */
  96
  97/* SYM_L_* -- linkage of symbols */
  98#define SYM_L_GLOBAL(name)                      .globl name
  99#define SYM_L_WEAK(name)                        .weak name
 100#define SYM_L_LOCAL(name)                       /* nothing */
 101
 102#ifndef LINKER_SCRIPT
 103#define ALIGN __ALIGN
 104#define ALIGN_STR __ALIGN_STR
 105
 106/* === DEPRECATED annotations === */
 107
 108#ifndef CONFIG_ARCH_USE_SYM_ANNOTATIONS
 109#ifndef GLOBAL
 110/* deprecated, use SYM_DATA*, SYM_ENTRY, or similar */
 111#define GLOBAL(name) \
 112        .globl name ASM_NL \
 113        name:
 114#endif
 115
 116#ifndef ENTRY
 117/* deprecated, use SYM_FUNC_START */
 118#define ENTRY(name) \
 119        SYM_FUNC_START(name)
 120#endif
 121#endif /* CONFIG_ARCH_USE_SYM_ANNOTATIONS */
 122#endif /* LINKER_SCRIPT */
 123
 124#ifndef CONFIG_ARCH_USE_SYM_ANNOTATIONS
 125#ifndef WEAK
 126/* deprecated, use SYM_FUNC_START_WEAK* */
 127#define WEAK(name)         \
 128        SYM_FUNC_START_WEAK(name)
 129#endif
 130
 131#ifndef END
 132/* deprecated, use SYM_FUNC_END, SYM_DATA_END, or SYM_END */
 133#define END(name) \
 134        .size name, .-name
 135#endif
 136
 137/* If symbol 'name' is treated as a subroutine (gets called, and returns)
 138 * then please use ENDPROC to mark 'name' as STT_FUNC for the benefit of
 139 * static analysis tools such as stack depth analyzer.
 140 */
 141#ifndef ENDPROC
 142/* deprecated, use SYM_FUNC_END */
 143#define ENDPROC(name) \
 144        SYM_FUNC_END(name)
 145#endif
 146#endif /* CONFIG_ARCH_USE_SYM_ANNOTATIONS */
 147
 148/* === generic annotations === */
 149
 150/* SYM_ENTRY -- use only if you have to for non-paired symbols */
 151#ifndef SYM_ENTRY
 152#define SYM_ENTRY(name, linkage, align...)              \
 153        linkage(name) ASM_NL                            \
 154        align ASM_NL                                    \
 155        name:
 156#endif
 157
 158/* SYM_START -- use only if you have to */
 159#ifndef SYM_START
 160#define SYM_START(name, linkage, align...)              \
 161        SYM_ENTRY(name, linkage, align)
 162#endif
 163
 164/* SYM_END -- use only if you have to */
 165#ifndef SYM_END
 166#define SYM_END(name, sym_type)                         \
 167        .type name sym_type ASM_NL                      \
 168        .size name, .-name
 169#endif
 170
 171/* === code annotations === */
 172
 173/*
 174 * FUNC -- C-like functions (proper stack frame etc.)
 175 * CODE -- non-C code (e.g. irq handlers with different, special stack etc.)
 176 *
 177 * Objtool validates stack for FUNC, but not for CODE.
 178 * Objtool generates debug info for both FUNC & CODE, but needs special
 179 * annotations for each CODE's start (to describe the actual stack frame).
 180 *
 181 * ALIAS -- does not generate debug info -- the aliased function will
 182 */
 183
 184/* SYM_INNER_LABEL_ALIGN -- only for labels in the middle of code */
 185#ifndef SYM_INNER_LABEL_ALIGN
 186#define SYM_INNER_LABEL_ALIGN(name, linkage)    \
 187        .type name SYM_T_NONE ASM_NL                    \
 188        SYM_ENTRY(name, linkage, SYM_A_ALIGN)
 189#endif
 190
 191/* SYM_INNER_LABEL -- only for labels in the middle of code */
 192#ifndef SYM_INNER_LABEL
 193#define SYM_INNER_LABEL(name, linkage)          \
 194        .type name SYM_T_NONE ASM_NL                    \
 195        SYM_ENTRY(name, linkage, SYM_A_NONE)
 196#endif
 197
 198/*
 199 * SYM_FUNC_START_LOCAL_ALIAS -- use where there are two local names for one
 200 * function
 201 */
 202#ifndef SYM_FUNC_START_LOCAL_ALIAS
 203#define SYM_FUNC_START_LOCAL_ALIAS(name)                \
 204        SYM_START(name, SYM_L_LOCAL, SYM_A_ALIGN)
 205#endif
 206
 207/*
 208 * SYM_FUNC_START_ALIAS -- use where there are two global names for one
 209 * function
 210 */
 211#ifndef SYM_FUNC_START_ALIAS
 212#define SYM_FUNC_START_ALIAS(name)                      \
 213        SYM_START(name, SYM_L_GLOBAL, SYM_A_ALIGN)
 214#endif
 215
 216/* SYM_FUNC_START -- use for global functions */
 217#ifndef SYM_FUNC_START
 218/*
 219 * The same as SYM_FUNC_START_ALIAS, but we will need to distinguish these two
 220 * later.
 221 */
 222#define SYM_FUNC_START(name)                            \
 223        SYM_START(name, SYM_L_GLOBAL, SYM_A_ALIGN)
 224#endif
 225
 226/* SYM_FUNC_START_NOALIGN -- use for global functions, w/o alignment */
 227#ifndef SYM_FUNC_START_NOALIGN
 228#define SYM_FUNC_START_NOALIGN(name)                    \
 229        SYM_START(name, SYM_L_GLOBAL, SYM_A_NONE)
 230#endif
 231
 232/* SYM_FUNC_START_LOCAL -- use for local functions */
 233#ifndef SYM_FUNC_START_LOCAL
 234/* the same as SYM_FUNC_START_LOCAL_ALIAS, see comment near SYM_FUNC_START */
 235#define SYM_FUNC_START_LOCAL(name)                      \
 236        SYM_START(name, SYM_L_LOCAL, SYM_A_ALIGN)
 237#endif
 238
 239/* SYM_FUNC_START_LOCAL_NOALIGN -- use for local functions, w/o alignment */
 240#ifndef SYM_FUNC_START_LOCAL_NOALIGN
 241#define SYM_FUNC_START_LOCAL_NOALIGN(name)              \
 242        SYM_START(name, SYM_L_LOCAL, SYM_A_NONE)
 243#endif
 244
 245/* SYM_FUNC_START_WEAK -- use for weak functions */
 246#ifndef SYM_FUNC_START_WEAK
 247#define SYM_FUNC_START_WEAK(name)                       \
 248        SYM_START(name, SYM_L_WEAK, SYM_A_ALIGN)
 249#endif
 250
 251/* SYM_FUNC_START_WEAK_NOALIGN -- use for weak functions, w/o alignment */
 252#ifndef SYM_FUNC_START_WEAK_NOALIGN
 253#define SYM_FUNC_START_WEAK_NOALIGN(name)               \
 254        SYM_START(name, SYM_L_WEAK, SYM_A_NONE)
 255#endif
 256
 257/* SYM_FUNC_END_ALIAS -- the end of LOCAL_ALIASed or ALIASed function */
 258#ifndef SYM_FUNC_END_ALIAS
 259#define SYM_FUNC_END_ALIAS(name)                        \
 260        SYM_END(name, SYM_T_FUNC)
 261#endif
 262
 263/*
 264 * SYM_FUNC_END -- the end of SYM_FUNC_START_LOCAL, SYM_FUNC_START,
 265 * SYM_FUNC_START_WEAK, ...
 266 */
 267#ifndef SYM_FUNC_END
 268/* the same as SYM_FUNC_END_ALIAS, see comment near SYM_FUNC_START */
 269#define SYM_FUNC_END(name)                              \
 270        SYM_END(name, SYM_T_FUNC)
 271#endif
 272
 273/* SYM_CODE_START -- use for non-C (special) functions */
 274#ifndef SYM_CODE_START
 275#define SYM_CODE_START(name)                            \
 276        SYM_START(name, SYM_L_GLOBAL, SYM_A_ALIGN)
 277#endif
 278
 279/* SYM_CODE_START_NOALIGN -- use for non-C (special) functions, w/o alignment */
 280#ifndef SYM_CODE_START_NOALIGN
 281#define SYM_CODE_START_NOALIGN(name)                    \
 282        SYM_START(name, SYM_L_GLOBAL, SYM_A_NONE)
 283#endif
 284
 285/* SYM_CODE_START_LOCAL -- use for local non-C (special) functions */
 286#ifndef SYM_CODE_START_LOCAL
 287#define SYM_CODE_START_LOCAL(name)                      \
 288        SYM_START(name, SYM_L_LOCAL, SYM_A_ALIGN)
 289#endif
 290
 291/*
 292 * SYM_CODE_START_LOCAL_NOALIGN -- use for local non-C (special) functions,
 293 * w/o alignment
 294 */
 295#ifndef SYM_CODE_START_LOCAL_NOALIGN
 296#define SYM_CODE_START_LOCAL_NOALIGN(name)              \
 297        SYM_START(name, SYM_L_LOCAL, SYM_A_NONE)
 298#endif
 299
 300/* SYM_CODE_END -- the end of SYM_CODE_START_LOCAL, SYM_CODE_START, ... */
 301#ifndef SYM_CODE_END
 302#define SYM_CODE_END(name)                              \
 303        SYM_END(name, SYM_T_NONE)
 304#endif
 305
 306/* === data annotations === */
 307
 308/* SYM_DATA_START -- global data symbol */
 309#ifndef SYM_DATA_START
 310#define SYM_DATA_START(name)                            \
 311        SYM_START(name, SYM_L_GLOBAL, SYM_A_NONE)
 312#endif
 313
 314/* SYM_DATA_START -- local data symbol */
 315#ifndef SYM_DATA_START_LOCAL
 316#define SYM_DATA_START_LOCAL(name)                      \
 317        SYM_START(name, SYM_L_LOCAL, SYM_A_NONE)
 318#endif
 319
 320/* SYM_DATA_END -- the end of SYM_DATA_START symbol */
 321#ifndef SYM_DATA_END
 322#define SYM_DATA_END(name)                              \
 323        SYM_END(name, SYM_T_OBJECT)
 324#endif
 325
 326/* SYM_DATA_END_LABEL -- the labeled end of SYM_DATA_START symbol */
 327#ifndef SYM_DATA_END_LABEL
 328#define SYM_DATA_END_LABEL(name, linkage, label)        \
 329        linkage(label) ASM_NL                           \
 330        .type label SYM_T_OBJECT ASM_NL                 \
 331        label:                                          \
 332        SYM_END(name, SYM_T_OBJECT)
 333#endif
 334
 335/* SYM_DATA -- start+end wrapper around simple global data */
 336#ifndef SYM_DATA
 337#define SYM_DATA(name, data...)                         \
 338        SYM_DATA_START(name) ASM_NL                             \
 339        data ASM_NL                                             \
 340        SYM_DATA_END(name)
 341#endif
 342
 343/* SYM_DATA_LOCAL -- start+end wrapper around simple local data */
 344#ifndef SYM_DATA_LOCAL
 345#define SYM_DATA_LOCAL(name, data...)                   \
 346        SYM_DATA_START_LOCAL(name) ASM_NL                       \
 347        data ASM_NL                                             \
 348        SYM_DATA_END(name)
 349#endif
 350
 351#endif /* __ASSEMBLY__ */
 352
 353#endif /* _LINUX_LINKAGE_H */
 354